Test.Syd.Yesod.Client

Documentation

data YesodClient site

A client environment to call a Yesod app.

Constructors

YesodClient

Fields

• yesodClientSite :: !site

  The site itself

• yesodClientManager :: !Manager

  The Manager to make the requests

• yesodClientSitePort :: !PortNumber

  The port that the site is running on, using warp

Instances

Generic (YesodClient site)

Defined in Test.Syd.Yesod.Client

Associated Types

type Rep (YesodClient site) :: Type -> Type

Methods

from :: YesodClient site -> Rep (YesodClient site) x

to :: Rep (YesodClient site) x -> YesodClient site

MonadReader (YesodClient site) (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

ask :: YesodClientM site (YesodClient site)

local :: (YesodClient site -> YesodClient site) -> YesodClientM site a -> YesodClientM site a

reader :: (YesodClient site -> a) -> YesodClientM site a

MonadReader (YesodClient site) (RequestBuilder site)

Defined in Test.Syd.Yesod.Request

Methods

ask :: RequestBuilder site (YesodClient site)

local :: (YesodClient site -> YesodClient site) -> RequestBuilder site a -> RequestBuilder site a

reader :: (YesodClient site -> a) -> RequestBuilder site a

type Rep (YesodClient site)

Defined in Test.Syd.Yesod.Client

type Rep (YesodClient site) = D1 ('MetaData "YesodClient" "Test.Syd.Yesod.Client" "sydtest-yesod-0.1.0.0-3P6b60uhm9kKQoEkn8clml" 'False) (C1 ('MetaCons "YesodClient" 'PrefixI 'True) (S1 ('MetaSel ('Just "yesodClientSite") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 site) :*: (S1 ('MetaSel ('Just "yesodClientManager") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Manager) :*: S1 ('MetaSel ('Just "yesodClientSitePort") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PortNumber))))

data YesodClientState

The state that is maintained throughout a YesodClientM

Constructors

YesodClientState

Fields

• yesodClientStateLast :: !(Maybe (Request, Response ByteString))

  The last request and response pair

• yesodClientStateCookies :: !CookieJar

  The cookies to pass along

Instances

Generic YesodClientState

Defined in Test.Syd.Yesod.Client

Associated Types

type Rep YesodClientState :: Type -> Type

Methods

from :: YesodClientState -> Rep YesodClientState x

to :: Rep YesodClientState x -> YesodClientState

MonadState YesodClientState (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

get :: YesodClientM site YesodClientState

put :: YesodClientState -> YesodClientM site ()

state :: (YesodClientState -> (a, YesodClientState)) -> YesodClientM site a

type Rep YesodClientState

Defined in Test.Syd.Yesod.Client

type Rep YesodClientState = D1 ('MetaData "YesodClientState" "Test.Syd.Yesod.Client" "sydtest-yesod-0.1.0.0-3P6b60uhm9kKQoEkn8clml" 'False) (C1 ('MetaCons "YesodClientState" 'PrefixI 'True) (S1 ('MetaSel ('Just "yesodClientStateLast") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Request, Response ByteString))) :*: S1 ('MetaSel ('Just "yesodClientStateCookies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CookieJar)))

initYesodClientState :: YesodClientState

The starting point of the 'YesodClientState site' of a 'YesodClientM site'

newtype YesodClientM site a

A monad to call a Yesod app.

This has access to a 'YesodClient site'.

Constructors

YesodClientM

Fields

• unYesodClientM :: StateT YesodClientState (ReaderT (YesodClient site) IO) a

Instances

MonadState YesodClientState (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

get :: YesodClientM site YesodClientState

put :: YesodClientState -> YesodClientM site ()

state :: (YesodClientState -> (a, YesodClientState)) -> YesodClientM site a

Monad (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

(>>=) :: YesodClientM site a -> (a -> YesodClientM site b) -> YesodClientM site b

(>>) :: YesodClientM site a -> YesodClientM site b -> YesodClientM site b

return :: a -> YesodClientM site a

Functor (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

fmap :: (a -> b) -> YesodClientM site a -> YesodClientM site b

(<$) :: a -> YesodClientM site b -> YesodClientM site a

MonadFail (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

fail :: String -> YesodClientM site a

Applicative (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

pure :: a -> YesodClientM site a

(<*>) :: YesodClientM site (a -> b) -> YesodClientM site a -> YesodClientM site b

liftA2 :: (a -> b -> c) -> YesodClientM site a -> YesodClientM site b -> YesodClientM site c

(*>) :: YesodClientM site a -> YesodClientM site b -> YesodClientM site b

(<*) :: YesodClientM site a -> YesodClientM site b -> YesodClientM site a

MonadIO (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

liftIO :: IO a -> YesodClientM site a

MonadThrow (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

throwM :: Exception e => e -> YesodClientM site a

MonadReader (YesodClient site) (YesodClientM site)

Defined in Test.Syd.Yesod.Client

Methods

ask :: YesodClientM site (YesodClient site)

local :: (YesodClient site -> YesodClient site) -> YesodClientM site a -> YesodClientM site a

reader :: (YesodClient site -> a) -> YesodClientM site a

type YesodExample site a = YesodClientM site a

For backward compatibility

runYesodClientM :: YesodClient site -> YesodClientM site a -> IO a

Run a YesodClientM site using a YesodClient site

getRequest :: YesodClientM site (Maybe Request)

Get the most recently sent request.

getResponse :: YesodClientM site (Maybe (Response ByteString))

Get the most recently received response.

getLast :: YesodClientM site (Maybe (Request, Response ByteString))

Get the most recently sent request and the response to it.

getLocation :: ParseRoute site => YesodClientM site (Either Text (Route site))

Get the Location header of most recently received response.

withLastRequestContext :: YesodClientM site a -> YesodClientM site a

Annotate the given test code with the last request and its response, if one has been made already.