Magicbane.HTTPClient

Provides an HTTP(S) client via http-client(-tls) in a Magicbane app context. Also provides a simple composable interface for making arbitrary requests, based on http-client-conduit. That lets you plug stream parsers (e.g. html-conduit: 'performWithFn ($$ sinkDoc)') directly into the reading of the response body.

Documentation

newtype ModHttpClient

Constructors

ModHttpClient Manager

newHttpClient :: IO ModHttpClient

type MonadHTTP ψ μ = (HasHttpManager ψ, MonadReader ψ μ, MonadIO μ, MonadBaseControl IO μ)

runHTTP :: EitherT ε μ α -> μ (Either ε α)

reqU :: MonadHTTP ψ μ => URI -> EitherT Text μ Request

Creates a request from a URI.

reqS :: (MonadHTTP ψ μ, ConvertibleStrings σ String) => σ -> EitherT Text μ Request

Creates a request from a string of any type, parsing it into a URI.

anyStatus :: MonadHTTP ψ μ => Request -> EitherT Text μ Request

Configures the request to not throw errors on error status codes.

postForm :: MonadHTTP ψ μ => [(Text, Text)] -> Request -> EitherT Text μ Request

Sets a x-www-form-urlencoded form as the request body (also sets the content-type).

performWithFn :: (MonadHTTP ψ μ, MonadCatch μ) => (ConduitM ι ByteString μ () -> μ ρ) -> Request -> EitherT Text μ (Response ρ)

Performs the request, using a given function to read the body. This is what all other performWith functions are based on.

performWithVoid :: (MonadHTTP ψ μ, MonadCatch μ) => Request -> EitherT Text μ (Response ())

Performs the request, ignoring the body.

performWithBytes :: (MonadHTTP ψ μ, MonadCatch μ) => Request -> EitherT Text μ (Response LByteString)

Performs the request, reading the body into a lazy ByteString.

Orphan instances

Has ModHttpClient α => HasHttpManager α

Methods

getHttpManager :: α -> Manager