Copyright	(c) 2016 Owain Lewis
License	BSD-style
Maintainer	owain@owainlewis.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Network.HTTP.Dispatch.Request

Description

HTTP request generation DSL

Synopsis

Documentation

data HTTPRequest Source #

Constructors

HTTPRequest
Fields reqMethod :: HTTPRequestMethod reqUrl :: String reqHeaders :: [Header] reqBody :: Maybe ByteString

Instances

Eq HTTPRequest Source #
Methods (==) :: HTTPRequest -> HTTPRequest -> Bool # (/=) :: HTTPRequest -> HTTPRequest -> Bool #
Show HTTPRequest Source #
Methods showsPrec :: Int -> HTTPRequest -> ShowS # show :: HTTPRequest -> String # showList :: [HTTPRequest] -> ShowS #
Runnable HTTPRequest Source #
Methods runRequest :: HTTPRequest -> IO HTTPResponse Source # runRequestWithSettings :: HTTPRequest -> ManagerSettings -> IO HTTPResponse

data HTTPResponse Source #

Constructors

HTTPResponse
Fields respStatus :: Int respHeaders :: [Header] respBody :: ByteString

Instances

Eq HTTPResponse Source #
Methods (==) :: HTTPResponse -> HTTPResponse -> Bool # (/=) :: HTTPResponse -> HTTPResponse -> Bool #
Show HTTPResponse Source #
Methods showsPrec :: Int -> HTTPResponse -> ShowS # show :: HTTPResponse -> String # showList :: [HTTPResponse] -> ShowS #

data HTTPRequestMethod Source #

Constructors

HEAD
GET
POST
PUT
PATCH
DELETE
TRACE
OPTIONS
CONNECT

Instances

Eq HTTPRequestMethod Source #
Methods (==) :: HTTPRequestMethod -> HTTPRequestMethod -> Bool # (/=) :: HTTPRequestMethod -> HTTPRequestMethod -> Bool #
Show HTTPRequestMethod Source #
Methods showsPrec :: Int -> HTTPRequestMethod -> ShowS # show :: HTTPRequestMethod -> String # showList :: [HTTPRequestMethod] -> ShowS #

runRequest :: Runnable a => a -> IO HTTPResponse Source #

rawRequest :: HTTPRequestMethod -> String -> [Header] -> Maybe ByteString -> HTTPRequest Source #

Make a raw HTTP request

  raw GET "http://google.com" [header Content-Type "application/json"] Nothing

  HTTPRequest { reqMethod = GET
              , reqUrl = "http://google.com"
              , reqHeaders = [(Content-Type,"application/json")]
              , reqBody = Nothing
              }

getRequest :: String -> [Header] -> HTTPRequest Source #

Make a simple HTTP GET request with headers

  getRequest "http://google.com" [header Content-Type "application/json"]

  HTTPRequest { reqMethod = GET
              , reqUrl = "http://google.com"
              , reqHeaders = [(Content-Type,"application/json")]
              , reqBody = Nothing
              }

postRequest :: Url -> Headers -> Maybe ByteString -> HTTPRequest Source #

Make a HTTP POST request with headers

putRequest :: Url -> Headers -> Maybe ByteString -> HTTPRequest Source #

Make a HTTP PUT request with headers

patchRequest :: Url -> Headers -> Maybe ByteString -> HTTPRequest Source #

Make a HTTP PATCH request with headers

deleteRequest :: Url -> Headers -> HTTPRequest Source #

Make a HTTP DELETE request with headers

headRequest :: Url -> [Header] -> HTTPRequest Source #

Make a HTTP HEAD request

optionsRequest :: Url -> [Header] -> HTTPRequest Source #

Make a HTTP OPTIONS request

withQueryParams :: HTTPRequest -> [(String, String)] -> HTTPRequest Source #

Add query params to a request URL

  withQueryParams (get "http://google.com") [("foo", "bar")]

  HTTPRequest { reqMethod = GET
              , reqUrl = "http://google.com?foo=bar"
              , reqHeaders = []
              , reqBody = Nothing
              }