Network.Api.Support

Toolkit for building http client libraries over Network.Http.Conduit

Request runners

runRequest :: ManagerSettings -> StdMethod -> Text -> RequestTransformer -> Responder b -> IO b

Run a request using the specified settings, method, url and request transformer.

runRequest' :: ManagerSettings -> Text -> RequestTransformer -> Responder b -> IO b

Run a request using the specified settings, url and request transformer. The method | can be set using the setMethod transformer. This is only useful if you require a | custom http method. Prefer runRequest where possible.

runRequestWith :: Manager -> StdMethod -> Text -> RequestTransformer -> Responder b -> IO b

Run a request using the specified settings, method, url and request transformer.

Prefer this to runRequest as recreating the manager every time is very inefficient.

runRequestWith' :: Manager -> Text -> RequestTransformer -> Responder b -> IO b

Run a request using the specified manager, url and request transformer. The method can be set using the setMethod transformer. This is only useful if you require a custom http method. Prefer runRequest where possible.

Prefer this to runRequest' as recreating the manager every time is very inefficient.

Request transformers

type RequestTransformer = Endo Request

A RequestTransformer allows you to build up attributes on the request. | RequestTransformer is simply an Endo, and therefore has a Monoid, so | can be combined with <>.

setApiKey :: ByteString -> RequestTransformer

Set an api key for use with basic auth.

setUrlEncodedBody :: [(ByteString, ByteString)] -> RequestTransformer

Set URL encoded form params on the request body.

setQueryParams :: [(ByteString, Maybe ByteString)] -> RequestTransformer

Set request query parameters.

setHeaders :: [(CI ByteString, ByteString)] -> RequestTransformer

Set request headers.

setHeader :: (CI ByteString, ByteString) -> RequestTransformer

Set a request headers.

addHeader :: (CI ByteString, ByteString) -> RequestTransformer

Add a request headers.

stripHeader :: CI ByteString -> RequestTransformer

Set a request headers.

setCookieJar :: CookieJar -> UTCTime -> RequestTransformer

Register all cookies in cookie jar against request.

setMethod :: ByteString -> RequestTransformer

Set the request method to be the specified name.

setBody :: ByteString -> RequestTransformer

Set the request body from the specified byte string.

setBodyLazy :: ByteString -> RequestTransformer

Set the request body from the specified lazy byte string.

setJson :: ToJSON a => a -> RequestTransformer

Set the request body from the value which can be converted to JSON.

Responders

type Responder a = Request -> Response ByteString -> a

Response handler.

data JsonResult a

Wrap up json parse and decode errors.

Constructors

ParseError Text

DecodeError Text

JsonSuccess a

Instances

Monad JsonResult

Defined in Network.Api.Support.Response

Methods

(>>=) :: JsonResult a -> (a -> JsonResult b) -> JsonResult b

(>>) :: JsonResult a -> JsonResult b -> JsonResult b

return :: a -> JsonResult a

fail :: String -> JsonResult a

Functor JsonResult

Defined in Network.Api.Support.Response

Methods

fmap :: (a -> b) -> JsonResult a -> JsonResult b

(<$) :: a -> JsonResult b -> JsonResult a

Applicative JsonResult

Defined in Network.Api.Support.Response

Methods

pure :: a -> JsonResult a

(<*>) :: JsonResult (a -> b) -> JsonResult a -> JsonResult b

liftA2 :: (a -> b -> c) -> JsonResult a -> JsonResult b -> JsonResult c

(*>) :: JsonResult a -> JsonResult b -> JsonResult b

(<*) :: JsonResult a -> JsonResult b -> JsonResult a

Eq a => Eq (JsonResult a)

Defined in Network.Api.Support.Response

Methods

(==) :: JsonResult a -> JsonResult a -> Bool

(/=) :: JsonResult a -> JsonResult a -> Bool

Show a => Show (JsonResult a)

Defined in Network.Api.Support.Response

Methods

showsPrec :: Int -> JsonResult a -> ShowS

show :: JsonResult a -> String

showList :: [JsonResult a] -> ShowS

parseBody :: FromJSON a => ByteString -> JsonResult a

Parse and decode body.

parseBodyWith :: FromJSON a => ByteString -> (Text -> b) -> (Text -> b) -> (a -> b) -> b

Parse and decode body handling error cases and success case.

basicResponder :: (Int -> ByteString -> a) -> Responder a

Lift function handling status code and body into a responder.

Compatibility

(<>) :: Semigroup a => a -> a -> a infixr 6

An associative operation.