Control.Monad.Script.Http

A basic type and monad transformer transformer for describing HTTP interactions.

HttpT

type HttpT e r w s p = HttpTT e r w s p IdentityT

An HTTP session returning an a, writing to a log of type W e w, reading from an environment of type R e w r, with state of type S s, throwing errors of type E e, performing effectful computations described by P p a, with inner monad eff. HttpTT over IdentityT.

HttpT

data HttpTT e r w s p t eff a

An HTTP session returning an a, writing to a log of type W e w, reading from an environment of type R e w r, with state of type S s, throwing errors of type E e, performing effectful computations described by P p a, and with inner monad t eff.

Instances

(MonadTrans t, forall (m :: Type -> Type). Monad m => Monad (t m)) => MonadTrans (HttpTT e r w s p t)

Defined in Control.Monad.Script.Http

Methods

lift :: Monad m => m a -> HttpTT e r w s p t m a

(Monad eff, Monad (t eff), MonadTrans t) => Monad (HttpTT e r w s p t eff)

Defined in Control.Monad.Script.Http

Methods

(>>=) :: HttpTT e r w s p t eff a -> (a -> HttpTT e r w s p t eff b) -> HttpTT e r w s p t eff b

(>>) :: HttpTT e r w s p t eff a -> HttpTT e r w s p t eff b -> HttpTT e r w s p t eff b

return :: a -> HttpTT e r w s p t eff a

(Monad eff, Monad (t eff), MonadTrans t) => Functor (HttpTT e r w s p t eff)

Defined in Control.Monad.Script.Http

Methods

fmap :: (a -> b) -> HttpTT e r w s p t eff a -> HttpTT e r w s p t eff b

(<$) :: a -> HttpTT e r w s p t eff b -> HttpTT e r w s p t eff a

(Monad eff, Monad (t eff), MonadTrans t, MonadFail (t eff)) => MonadFail (HttpTT e r w s p t eff)

Defined in Control.Monad.Script.Http

Methods

fail :: String -> HttpTT e r w s p t eff a

(Monad eff, Monad (t eff), MonadTrans t) => Applicative (HttpTT e r w s p t eff)

Defined in Control.Monad.Script.Http

Methods

pure :: a -> HttpTT e r w s p t eff a

(<*>) :: HttpTT e r w s p t eff (a -> b) -> HttpTT e r w s p t eff a -> HttpTT e r w s p t eff b

liftA2 :: (a -> b -> c) -> HttpTT e r w s p t eff a -> HttpTT e r w s p t eff b -> HttpTT e r w s p t eff c

(*>) :: HttpTT e r w s p t eff a -> HttpTT e r w s p t eff b -> HttpTT e r w s p t eff b

(<*) :: HttpTT e r w s p t eff a -> HttpTT e r w s p t eff b -> HttpTT e r w s p t eff a

execHttpTT

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> S s

Initial state

-> R e w r

Environment

-> (forall u. P p u -> eff u)

Effect evaluator

-> HttpTT e r w s p t eff a

-> t eff (Either (E e) a, S s, W e w)

Execute an HttpTT session.

liftHttpTT :: (Monad eff, Monad (t eff), MonadTrans t) => t eff a -> HttpTT e r w s p t eff a

Lift a value from the inner transformer.

Error

throwError :: (Monad eff, Monad (t eff), MonadTrans t) => e -> HttpTT e r w s p t eff a

Also logs the exception.

throwJsonError :: (Monad eff, Monad (t eff), MonadTrans t) => JsonError -> HttpTT e r w s p t eff a

Also logs the exception.

throwHttpException :: (Monad eff, Monad (t eff), MonadTrans t) => HttpException -> HttpTT e r w s p t eff a

Also logs the exception.

throwIOException :: (Monad eff, Monad (t eff), MonadTrans t) => IOException -> HttpTT e r w s p t eff a

Also logs the exception.

catchError

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> HttpTT e r w s p t eff a

-> (e -> HttpTT e r w s p t eff a)

Handler

-> HttpTT e r w s p t eff a

Re-throws other error types.

catchJsonError

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> HttpTT e r w s p t eff a

-> (JsonError -> HttpTT e r w s p t eff a)

Handler

-> HttpTT e r w s p t eff a

Re-throws other error types.

catchHttpException

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> HttpTT e r w s p t eff a

-> (HttpException -> HttpTT e r w s p t eff a)

Handler

-> HttpTT e r w s p t eff a

Re-throws other error types.

catchIOException

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> HttpTT e r w s p t eff a

-> (IOException -> HttpTT e r w s p t eff a)

Handler

-> HttpTT e r w s p t eff a

Re-throws other error types.

catchAnyError :: (Monad eff, Monad (t eff), MonadTrans t) => HttpTT e r w s p t eff a -> (e -> HttpTT e r w s p t eff a) -> (HttpException -> HttpTT e r w s p t eff a) -> (IOException -> HttpTT e r w s p t eff a) -> (JsonError -> HttpTT e r w s p t eff a) -> HttpTT e r w s p t eff a

Handle any thrown error. To handle only errors of a specific type, see catchError, catchJsonError, catchIOException, or catchHttpException.

printError :: (e -> Text) -> E e -> Text

Pretty printer for errors

data E e

Error type.

Constructors

E_Http HttpException

E_IO IOException

E_Json JsonError

E e

Client-supplied error type.

Instances

Show e => Show (E e)

Defined in Control.Monad.Script.Http

Methods

showsPrec :: Int -> E e -> ShowS

show :: E e -> String

showList :: [E e] -> ShowS

Reader

ask :: (Monad eff, Monad (t eff), MonadTrans t) => HttpTT e r w s p t eff (R e w r)

Retrieve the environment.

local :: (Monad eff, Monad (t eff), MonadTrans t) => (R e w r -> R e w r) -> HttpTT e r w s p t eff a -> HttpTT e r w s p t eff a

Run an action with a locally adjusted environment of the same type.

reader :: (Monad eff, Monad (t eff), MonadTrans t) => (R e w r -> a) -> HttpTT e r w s p t eff a

Retrieve the image of the environment under a given function.

data R e w r

Generic session environment.

Constructors

R

Fields

• _logOptions :: LogOptions e w
• _logEntryPrinter :: LogOptions e w -> LogEntry e w -> Maybe Text

  Printer for log entries.

• _logHandle :: Handle

  Handle for printing logs

• _logLock :: Maybe (MVar ())

  Lock used to prevent race conditions when writing to the log.

• _uid :: Text

  Identifier string for the session; used to help match log entries emitted by the same session.

• _httpErrorInject :: HttpException -> Maybe e

  Function for elevating HttpExceptions to a client-supplied error type.

• _env :: r

  Client-supplied environment type.

basicEnv

Arguments

:: (Show e, Show w)

=> r

Client-supplied environment value.

-> R e w r

Environment constructor

trivialEnv

Arguments

:: r

Client-supplied environment value.

-> R e w r

Environment constructor

data LogOptions e w

Options for tweaking the logs.

Constructors

LogOptions

Fields

• _logColor :: Bool

  Toggle color

• _logJson :: Bool

  Toggle JSON pretty printing

• _logSilent :: Bool

  Toggle to silence the logs

• _logMinSeverity :: LogSeverity

  Suppress log output below this severity

• _logHeaders :: Bool

  Toggle for printing HTTP headers

• _printUserError :: Bool -> e -> Text

  Printer for client-supplied error type. The boolean toggles JSON pretty printing.

• _printUserLog :: Bool -> w -> Text

  Printer for client-supplied log type. the boolean toggles JSON pretty printing.

basicLogOptions :: (Show e, Show w) => LogOptions e w

Noisy, in color, without parsing JSON responses, and using Show instances for user-supplied error and log types.

trivialLogOptions :: LogOptions e w

Noisy, in color, without parsing JSON responses, and using trivial printers for user-supplied error and log types. For testing.

Writer

logEntries :: W e w -> [w]

Extract the user-defined log entries.

data LogSeverity

Syslog style log severities.

Constructors

LogDebug

Debug-level messages

LogInfo

Informational messages

LogNotice

Normal but significant condition

LogWarning

Warning conditions

LogError

Error conditions

LogCritical

Critical conditions

LogAlert

Action must be taken immediately

LogEmergency

System is unusable

Instances

Eq LogSeverity

Defined in Data.LogSeverity

Methods

(==) :: LogSeverity -> LogSeverity -> Bool

(/=) :: LogSeverity -> LogSeverity -> Bool

Ord LogSeverity

Defined in Data.LogSeverity

Methods

compare :: LogSeverity -> LogSeverity -> Ordering

(<) :: LogSeverity -> LogSeverity -> Bool

(<=) :: LogSeverity -> LogSeverity -> Bool

(>) :: LogSeverity -> LogSeverity -> Bool

(>=) :: LogSeverity -> LogSeverity -> Bool

max :: LogSeverity -> LogSeverity -> LogSeverity

min :: LogSeverity -> LogSeverity -> LogSeverity

Show LogSeverity

Defined in Data.LogSeverity

Methods

showsPrec :: Int -> LogSeverity -> ShowS

show :: LogSeverity -> String

showList :: [LogSeverity] -> ShowS

setLogSeverity :: (Monad eff, Monad (t eff), MonadTrans t) => LogSeverity -> HttpTT e r w s p t eff a -> HttpTT e r w s p t eff a

Set the severity level of all log actions in a session.

data W e w

Log type

Instances

(Show e, Show w) => Show (W e w)

Defined in Control.Monad.Script.Http

Methods

showsPrec :: Int -> W e w -> ShowS

show :: W e w -> String

showList :: [W e w] -> ShowS

Semigroup (W e w)

Defined in Control.Monad.Script.Http

Methods

(<>) :: W e w -> W e w -> W e w

sconcat :: NonEmpty (W e w) -> W e w

stimes :: Integral b => b -> W e w -> W e w

Monoid (W e w)

Defined in Control.Monad.Script.Http

Methods

mempty :: W e w

mappend :: W e w -> W e w -> W e w

mconcat :: [W e w] -> W e w

printHttpLogs :: Handle -> Maybe (MVar ()) -> LogOptions e w -> (LogOptions e w -> LogEntry e w -> Maybe Text) -> W e w -> IO ()

All log statements should go through logNow.

basicLogEntryPrinter :: LogOptions e w -> LogEntry e w -> Maybe Text

Simple default pretty printer for LogEntrys.

State

gets :: (Monad eff, Monad (t eff), MonadTrans t) => (S s -> a) -> HttpTT e r w s p t eff a

Retrieve the image of the current state under a given function.

modify :: (Monad eff, Monad (t eff), MonadTrans t) => (S s -> S s) -> HttpTT e r w s p t eff ()

Modify the current state strictly.

data S s

State type

Constructors

S

Fields

• _httpOptions :: Options
• _httpSession :: Maybe Session
• _userState :: s

Instances

Show s => Show (S s)

Defined in Control.Monad.Script.Http

Methods

showsPrec :: Int -> S s -> ShowS

show :: S s -> String

showList :: [S s] -> ShowS

basicState :: s -> S s

State constructor

Prompt

prompt :: (Monad eff, Monad (t eff), MonadTrans t) => P p a -> HttpTT e r w s p t eff a

Inject an atomic effect.

data P p a where

Atomic effects

Constructors

HPutStrLn :: Handle -> Text -> P p (Either IOException ())

HPutStrLnBlocking :: MVar () -> Handle -> Text -> P p (Either IOException ())

GetSystemTime :: P p UTCTime

ThreadDelay :: Int -> P p ()

HttpGet :: Options -> Maybe Session -> Url -> P p (Either HttpException HttpResponse)

HttpPost :: Options -> Maybe Session -> Url -> ByteString -> P p (Either HttpException HttpResponse)

HttpDelete :: Options -> Maybe Session -> Url -> P p (Either HttpException HttpResponse)

P :: p a -> P p a

evalIO

Arguments

:: (p a -> IO a)

Evaluator for user effects

-> P p a

-> IO a

Basic evaluator for interpreting atomic Http effects in IO.

evalMockIO :: (p a -> MockIO s a) -> P p a -> MockIO s a

Basic evaluator for interpreting atomic Http effects in MockIO.

API

comment :: (Monad eff, Monad (t eff), MonadTrans t) => Text -> HttpTT e r w s p t eff ()

Write a comment to the log

wait

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Int

milliseconds

-> HttpTT e r w s p t eff ()

Pause the thread

logDebug :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

For debug level messages

logInfo :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

For informational messages

logNotice :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

For normal but significant conditions

logWarning :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

For warning conditions

logError :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

For error conditions

logCritical :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

For critical conditions

logAlert :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

Action must be taken immediately

logEmergency :: (Monad eff, Monad (t eff), MonadTrans t) => w -> HttpTT e r w s p t eff ()

System is unusable

IO

hPutStrLn :: (Monad eff, Monad (t eff), MonadTrans t) => Handle -> Text -> HttpTT e r w s p t eff ()

Write a line to a handle

hPutStrLnBlocking :: (Monad eff, Monad (t eff), MonadTrans t) => MVar () -> Handle -> Text -> HttpTT e r w s p t eff ()

Write a line to a handle, using the given MVar as a lock

HTTP calls

httpGet :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> HttpTT e r w s p t eff HttpResponse

Run a GET request

httpSilentGet :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> HttpTT e r w s p t eff HttpResponse

Run a GET request, but do not write the request or response to the logs.

httpPost

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Url

-> ByteString

Payload

-> HttpTT e r w s p t eff HttpResponse

Run a POST request

httpSilentPost

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Url

-> ByteString

Payload

-> HttpTT e r w s p t eff HttpResponse

Run a POST request, but do not write the request or response to the logs.

httpDelete :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> HttpTT e r w s p t eff HttpResponse

Run a DELETE request

httpSilentDelete :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> HttpTT e r w s p t eff HttpResponse

Run a DELETE request, but do not write the request or response to the logs.

JSON

parseJson :: (Monad eff, Monad (t eff), MonadTrans t) => ByteString -> HttpTT e r w s p t eff Value

Parse a ByteString to a JSON Value.

lookupKeyJson

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Text

Key name

-> Value

JSON object

-> HttpTT e r w s p t eff Value

Object member lookup.

constructFromJson :: (Monad eff, Monad (t eff), MonadTrans t, FromJSON a) => Value -> HttpTT e r w s p t eff a

Decode a Value to some other type.

Types

type Url = Text

To make type signatures nicer

data JsonError

Represents the kinds of errors that can occur when parsing and decoding JSON.

Constructors

JsonError Text

A generic JSON error; try not to use this.

JsonParseError ByteString

A failed parse.

JsonKeyDoesNotExist Text Value

An attempt to look up the value of a key that does not exist on an object.

JsonKeyLookupOffObject Text Value

An attempt to look up the value of a key on something other than an object.

JsonConstructError String

A failed attempt to convert a Value to some other type.

Instances

Eq JsonError

Defined in Data.Aeson.Extras

Methods

(==) :: JsonError -> JsonError -> Bool

(/=) :: JsonError -> JsonError -> Bool

Show JsonError

Defined in Data.Aeson.Extras

Methods

showsPrec :: Int -> JsonError -> ShowS

show :: JsonError -> String

showList :: [JsonError] -> ShowS

Arbitrary JsonError

Defined in Data.Aeson.Extras

Methods

arbitrary :: Gen JsonError

shrink :: JsonError -> [JsonError]

data HttpResponse

Non-opaque HTTP response type.

Constructors

HttpResponse

Fields

• _responseStatus :: Status
• _responseVersion :: HttpVersion
• _responseHeaders :: ResponseHeaders
• _responseBody :: ByteString
• _responseCookieJar :: CookieJar

Instances

Eq HttpResponse

Defined in Network.HTTP.Client.Extras

Methods

(==) :: HttpResponse -> HttpResponse -> Bool

(/=) :: HttpResponse -> HttpResponse -> Bool

Show HttpResponse

Defined in Network.HTTP.Client.Extras

Methods

showsPrec :: Int -> HttpResponse -> ShowS

show :: HttpResponse -> String

showList :: [HttpResponse] -> ShowS

Testing

checkHttpTT

Arguments

:: forall eff t q e r w s p a prop. (Monad eff, Monad (t eff), MonadTrans t, Show q, Testable prop)

=> S s

Initial state

-> R e w r

Environment

-> (forall u. P p u -> eff u)

Effect evaluator

-> (t eff (Either (E e) a, S s, W e w) -> IO q)

Condense to IO

-> (q -> prop)

Result check

-> HttpTT e r w s p t eff a

-> Property

Turn an HttpTT into a property; for testing with QuickCheck.