@@ -1,6 +1,16 @@
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE QuasiQuotes #-}
5+{-# LANGUAGE RecordWildCards #-}
6+{-# LANGUAGE RoleAnnotations #-}
7+{-# LANGUAGE TemplateHaskellQuotes #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
2-- Module : Network.HTTP.Req
12-- Module : Network.HTTP.Req
3−-- Copyright : © 2016–2017 Mark Karpov
13+-- Copyright : © 2016–present Mark Karpov
4-- License : BSD 3 clause
14-- License : BSD 3 clause
6-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
16-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
@@ -9,61 +19,40 @@
10-- The documentation below is structured in such a way that the most
20-- The documentation below is structured in such a way that the most
11-- important information is presented first: you learn how to do HTTP
21-- important information is presented first: you learn how to do HTTP
12−-- requests, how to embed them in any monad you have, and then it gives you
22+-- requests, how to embed them in the monad you have, and then it gives you
13-- details about less-common things you may want to know about. The
23-- details about less-common things you may want to know about. The
14-- documentation is written with sufficient coverage of details and
24-- documentation is written with sufficient coverage of details and
15-- examples, and it's designed to be a complete tutorial on its own.
25-- examples, and it's designed to be a complete tutorial on its own.
17−-- /(A modest intro goes here, click on 'req' to start making requests.)/
19-- === About the library
27-- === About the library
21−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP library
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
22−-- that just works without any fooling around.
30+-- and expandable.
24−-- What does the phrase “easy-to-use” mean? It means that the library is
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
25−-- designed to be beginner-friendly so it's simple to add to your monad
33+-- so it's simple to add to your monad stack, intuitive to work with,
26−-- stack, intuitive to work with, well-documented, and does not get in your
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
27−-- way. Doing HTTP requests is a common task and a Haskell library for this
35+-- common task and a Haskell library for this should be approachable and
28−-- should be very approachable and clear to beginners, thus certain
29−-- compromises were made. For example, one cannot currently modify
36+-- clear to beginners, thus certain compromises were made. For example, one
30−-- 'L.ManagerSettings' of the default manager because the library always
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
31−-- uses the same implicit global manager for simplicity and maximal
38+-- because the library always uses the same implicit global manager for
32−-- connection sharing. There is a way to use your own manager with different
39+-- simplicity and maximal connection sharing. There is a way to use your own
33−-- settings, but it requires a bit more typing.
40+-- manager with different settings, but it requires more typing.
35−-- “Type-safe” means that the library is protective and eliminates certain
42+-- “Type-safe” means that the library tries to eliminate certain classes of
36−-- classes of errors. For example, we have correct-by-construction 'Url's,
43+-- errors. For example, we have correct-by-construction URLs; it is
37−-- it's guaranteed that the user does not send the request body when using
44+-- guaranteed that the user does not send the request body when using
38−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
39−-- is minimized by making the user specify his\/her intentions in an
46+-- minimized by making the user specify their intentions in an explicit
40−-- explicit form (for example, it's not possible to avoid specifying the
47+-- form. For example, it's not possible to avoid specifying the body or the
41−-- body or method of a request). Authentication methods that assume HTTPS
48+-- method of a request. Authentication methods that assume HTTPS force the
42−-- force the user to use HTTPS at the type level. The library also carefully
49+-- user to use HTTPS at the type level.
43−-- hides underlying types from the lower-level @http-client@ package because
44−-- those types are not safe enough (for example 'L.Request' is an instance
45−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
48−-- “Expandable” refers to the ability of the library to be expanded without
51+-- “Expandable” refers to the ability to create new components without
49−-- having to resort to ugly hacking. For example, it's possible to define
52+-- having to resort to hacking. For example, it's possible to define your
50−-- your own HTTP methods, create new ways to construct the body of a
53+-- own HTTP methods, create new ways to construct the body of a request,
51−-- request, create new authorization options, perform a request in a
54+-- create new authorization options, perform a request in a different way,
52−-- different way, and create your own methods to parse and represent a
55+-- and create your own methods to parse a response.
53−-- response. As a user extends the library to satisfy his\/her special
54−-- needs, the new solutions will work just like the built-ins. However, all
55−-- of the common cases are also covered by the library out-of-the-box.
57−-- “High-level” means that there are less details to worry about. The
58−-- library is a result of my experiences as a Haskell consultant. Working
59−-- for several clients, who had very different projects, showed me that the
60−-- library should adapt easily to any particular style of writing Haskell
61−-- applications. For example, some people prefer throwing exceptions, while
62−-- others are concerned with purity. Just define 'handleHttpException'
63−-- accordingly when making your monad instance of 'MonadHttp' and it will
64−-- play together seamlessly. Finally, the library cuts boilerplate down
65−-- considerably, and helps you write concise, easy to read, and maintainable
68-- === Using with other libraries
57-- === Using with other libraries
@@ -87,186 +76,207 @@
87-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
76-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
88-- machinery for performing requests is the same as with @http-conduit@ and
77-- machinery for performing requests is the same as with @http-conduit@ and
89-- @wreq@. The only difference is the API.
78-- @wreq@. The only difference is the API.
92−{-# LANGUAGE DataKinds #-}
93−{-# LANGUAGE DeriveDataTypeable #-}
94−{-# LANGUAGE DeriveGeneric #-}
95−{-# LANGUAGE FlexibleInstances #-}
96−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
97−{-# LANGUAGE KindSignatures #-}
98−{-# LANGUAGE MultiParamTypeClasses #-}
99−{-# LANGUAGE OverloadedStrings #-}
100−{-# LANGUAGE RankNTypes #-}
101−{-# LANGUAGE RecordWildCards #-}
102−{-# LANGUAGE ScopedTypeVariables #-}
103−{-# LANGUAGE TypeFamilies #-}
105−#if MIN_VERSION_base(4,9,0)
106−{-# LANGUAGE UndecidableInstances #-}
109−#if __GLASGOW_HASKELL__ < 710
110−{-# LANGUAGE ConstraintKinds #-}
113−#if __GLASGOW_HASKELL__ >= 800
114−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
117module Network.HTTP.Req
79module Network.HTTP.Req
118 ( -- * Making a request
80 ( -- * Making a request
119 -- $making-a-request
81 -- $making-a-request
122− , withReqManager
86+ withReqManager,
123− -- * Embedding requests into your monad
88+ -- * Embedding requests in your monad
124 -- $embedding-requests
89 -- $embedding-requests
125− , MonadHttp (..)
90+ MonadHttp (..),
126− , HttpConfig (..)
91+ HttpConfig (..),
129 -- * Request
96 -- * Request
130 -- ** Method
98 -- ** Method
131 -- $method
99 -- $method
132− , GET (..)
100+ GET (..),
133− , POST (..)
101+ POST (..),
134− , HEAD (..)
102+ HEAD (..),
135− , PUT (..)
103+ PUT (..),
136− , DELETE (..)
104+ DELETE (..),
137− , TRACE (..)
105+ TRACE (..),
138− , CONNECT (..)
106+ CONNECT (..),
139− , OPTIONS (..)
107+ OPTIONS (..),
140− , PATCH (..)
108+ PATCH (..),
141− , HttpMethod (..)
109+ HttpMethod (..),
142 -- ** URL
111 -- ** URL
149− , parseUrlHttp
118+ useHttpURI,
150− , parseUrlHttps
119+ useHttpsURI,
151 -- ** Body
124 -- ** Body
153− , NoReqBody (..)
126+ NoReqBody (..),
154− , ReqBodyJson (..)
127+ ReqBodyJson (..),
155− , ReqBodyFile (..)
128+ ReqBodyFile (..),
156− , ReqBodyBs (..)
129+ ReqBodyBs (..),
157− , ReqBodyLbs (..)
130+ ReqBodyLbs (..),
158− , ReqBodyUrlEnc (..)
131+ ReqBodyUrlEnc (..),
159− , FormUrlEncodedParam
132+ FormUrlEncodedParam,
160− , ReqBodyMultipart
133+ ReqBodyMultipart,
161− , reqBodyMultipart
134+ reqBodyMultipart,
162− , HttpBody (..)
135+ HttpBody (..),
163− , ProvidesBody
136+ ProvidesBody,
164− , HttpBodyAllowed
137+ HttpBodyAllowed,
165 -- ** Optional parameters
139 -- ** Optional parameters
166 -- $optional-parameters
140 -- $optional-parameters
167− , Option
141+ Option,
168 -- *** Query parameters
143 -- *** Query parameters
169 -- $query-parameters
144 -- $query-parameters
171− , queryFlag
146+ queryFlag,
172− , QueryParam (..)
148+ QueryParam (..),
173 -- *** Headers
150 -- *** Headers
174− , header
151+ header,
175 -- *** Cookies
155 -- *** Cookies
176 -- $cookies
156 -- $cookies
177− , cookieJar
157+ cookieJar,
178 -- *** Authentication
159 -- *** Authentication
179 -- $authentication
160 -- $authentication
180− , basicAuth
161+ basicAuth,
181− , basicAuthUnsafe
162+ basicAuthUnsafe,
182− , oAuth1
164+ oAuth1,
183− , oAuth2Bearer
165+ oAuth2Bearer,
184− , oAuth2Token
166+ oAuth2Token,
185 -- *** Other
169 -- *** Other
187− , decompress
171+ decompress,
188− , responseTimeout
172+ responseTimeout,
189− , httpVersion
173+ httpVersion,
190 -- * Response
175 -- * Response
191 -- ** Response interpretations
177 -- ** Response interpretations
192− , IgnoreResponse
178+ IgnoreResponse,
193− , ignoreResponse
179+ ignoreResponse,
194− , JsonResponse
180+ JsonResponse,
195− , jsonResponse
181+ jsonResponse,
196− , BsResponse
182+ BsResponse,
197− , bsResponse
183+ bsResponse,
198− , LbsResponse
184+ LbsResponse,
199− , lbsResponse
185+ lbsResponse,
200 -- ** Inspecting a response
187 -- ** Inspecting a response
201− , responseBody
188+ responseBody,
202− , responseStatusCode
189+ responseStatusCode,
203− , responseStatusMessage
190+ responseStatusMessage,
204− , responseHeader
191+ responseHeader,
205− , responseCookieJar
192+ responseCookieJar,
206 -- ** Defining your own interpretation
194 -- ** Defining your own interpretation
207 -- $new-response-interpretation
195 -- $new-response-interpretation
208− , HttpResponse (..)
196+ HttpResponse (..),
209 -- * Other
198 -- * Other
210− , HttpException (..)
199+ HttpException (..),
200+ isStatusCodeException,
211− , CanHaveBody (..)
201+ CanHaveBody (..),
212− , Scheme (..) )
202+ Scheme (..),
206+import Blaze.ByteString.Builder qualified as BB
215import Control.Applicative
207import Control.Applicative
216import Control.Arrow (first, second)
208import Control.Arrow (first, second)
217−import Control.Exception (Exception, try, handle, throwIO)
209+import Control.Exception hiding (Handler (..), TypeError)
218−import Control.Monad
210+import Control.Monad (guard, void, (>=>))
219import Control.Monad.Base
211import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
220import Control.Monad.IO.Class
213import Control.Monad.IO.Class
221−import Control.Monad.Reader
214+import Control.Monad.IO.Unlift
215+import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216+import Control.Monad.Trans.Accum (AccumT)
217+import Control.Monad.Trans.Cont (ContT)
222import Control.Monad.Trans.Control
218import Control.Monad.Trans.Control
219+import Control.Monad.Trans.Except (ExceptT)
220+import Control.Monad.Trans.Identity (IdentityT)
221+import Control.Monad.Trans.Maybe (MaybeT)
222+import Control.Monad.Trans.RWS.CPS qualified as RWS.CPS
223+import Control.Monad.Trans.RWS.Lazy qualified as RWS.Lazy
224+import Control.Monad.Trans.RWS.Strict qualified as RWS.Strict
225+import Control.Monad.Trans.Select (SelectT)
226+import Control.Monad.Trans.State.Lazy qualified as State.Lazy
227+import Control.Monad.Trans.State.Strict qualified as State.Strict
228+import Control.Monad.Trans.Writer.CPS qualified as Writer.CPS
229+import Control.Monad.Trans.Writer.Lazy qualified as Writer.Lazy
230+import Control.Monad.Trans.Writer.Strict qualified as Writer.Strict
223import Control.Retry
231import Control.Retry
224−import Data.Aeson (ToJSON (..), FromJSON (..))
232+import Data.Aeson (FromJSON (..), ToJSON (..))
233+import Data.Aeson qualified as A
225import Data.ByteString (ByteString)
234import Data.ByteString (ByteString)
235+import Data.ByteString qualified as B
236+import Data.ByteString.Lazy qualified as BL
237+import Data.CaseInsensitive qualified as CI
226import Data.Data (Data)
238import Data.Data (Data)
227−import Data.Default.Class
239+import Data.Default.Class (def)
228import Data.Function (on)
240import Data.Function (on)
229import Data.IORef
241import Data.IORef
230−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
231import Data.List.NonEmpty (NonEmpty (..))
244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
232import Data.Maybe (fromMaybe)
246import Data.Maybe (fromMaybe)
233import Data.Proxy
247import Data.Proxy
234−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
235import Data.Text (Text)
250import Data.Text (Text)
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
236−import Data.Typeable (Typeable)
253+import Data.Typeable (Typeable, cast)
237import GHC.Generics
254import GHC.Generics
238import GHC.TypeLits
255import GHC.TypeLits
256+import Language.Haskell.TH qualified as TH
257+import Language.Haskell.TH.Quote qualified as TH
258+import Language.Haskell.TH.Syntax qualified as TH
259+import Network.Connection qualified as NC
260+import Network.HTTP.Client qualified as L
261+import Network.HTTP.Client.Internal qualified as LI
262+import Network.HTTP.Client.MultipartFormData qualified as LM
263+import Network.HTTP.Client.TLS qualified as L
264+import Network.HTTP.Types qualified as Y
239import System.IO.Unsafe (unsafePerformIO)
265import System.IO.Unsafe (unsafePerformIO)
266+import Text.URI (URI)
267+import Text.URI qualified as URI
268+import Text.URI.QQ qualified as QQ
269+import Web.Authenticate.OAuth qualified as OAuth
270+import Web.FormUrlEncoded (FromForm (..), ToForm (..))
271+import Web.FormUrlEncoded qualified as Form
240import Web.HttpApiData (ToHttpApiData (..))
272import Web.HttpApiData (ToHttpApiData (..))
241−import qualified Blaze.ByteString.Builder as BB
242−import qualified Data.Aeson as A
243−import qualified Data.ByteString as B
244−import qualified Data.ByteString.Lazy as BL
245−import qualified Data.CaseInsensitive as CI
246−import qualified Data.List.NonEmpty as NE
247−import qualified Data.Text as T
248−import qualified Data.Text.Encoding as T
249−import qualified Data.Text.Read as TR
250−import qualified Network.Connection as NC
251−import qualified Network.HTTP.Client as L
252−import qualified Network.HTTP.Client.Internal as LI
253−import qualified Network.HTTP.Client.MultipartFormData as LM
254−import qualified Network.HTTP.Client.TLS as L
255−import qualified Network.HTTP.Types as Y
256−import qualified Web.Authenticate.OAuth as OAuth
258−#if MIN_VERSION_base(4,9,0)
259−import Data.Kind (Constraint)
261−import GHC.Exts (Constraint)
264----------------------------------------------------------------------------
274----------------------------------------------------------------------------
265-- Making a request
275-- Making a request
267-- $making-a-request
277-- $making-a-request
269−-- To make an HTTP request you need only one function: 'req'.
279+-- To make an HTTP request you normally need only one function: 'req'.
271-- | Make an HTTP request. The function takes 5 arguments, 4 of which
281-- | Make an HTTP request. The function takes 5 arguments, 4 of which
272-- specify required parameters and the final 'Option' argument is a
282-- specify required parameters and the final 'Option' argument is a
@@ -283,7 +293,7 @@ import GHC.Exts (Constraint)
284-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
285-- tutorial has a section about HTTP bodies, but usage is very
295-- tutorial has a section about HTTP bodies, but usage is very
286−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
288-- @response@ is a type hint how to make and interpret response of an HTTP
298-- @response@ is a type hint how to make and interpret response of an HTTP
289-- request. Out-of-the-box it can be the following:
299-- request. Out-of-the-box it can be the following:
@@ -309,12 +319,13 @@ import GHC.Exts (Constraint)
309-- First, this is a piece of boilerplate that should be in place before you
319-- First, this is a piece of boilerplate that should be in place before you
310-- try the examples:
320-- try the examples:
322+-- > {-# LANGUAGE DeriveGeneric #-}
312-- > {-# LANGUAGE OverloadedStrings #-}
323-- > {-# LANGUAGE OverloadedStrings #-}
314-- > module Main (main) where
325-- > module Main (main) where
316−-- > import Control.Exception (throwIO)
317-- > import Control.Monad
327-- > import Control.Monad
328+-- > import Control.Monad.IO.Class
318-- > import Data.Aeson
329-- > import Data.Aeson
319-- > import Data.Maybe (fromJust)
330-- > import Data.Maybe (fromJust)
320-- > import Data.Monoid ((<>))
331-- > import Data.Monoid ((<>))
@@ -322,32 +333,30 @@ import GHC.Exts (Constraint)
322-- > import GHC.Generics
333-- > import GHC.Generics
323-- > import Network.HTTP.Req
334-- > import Network.HTTP.Req
324-- > import qualified Data.ByteString.Char8 as B
335-- > import qualified Data.ByteString.Char8 as B
325−-- >
336+-- > import qualified Text.URI as URI
326−-- > instance MonadHttp IO where
327−-- > handleHttpException = throwIO
329-- We will be making requests against the <https://httpbin.org> service.
338-- We will be making requests against the <https://httpbin.org> service.
331-- Make a GET request, grab 5 random bytes:
340-- Make a GET request, grab 5 random bytes:
333-- > main :: IO ()
342-- > main :: IO ()
334−-- > main = do
343+-- > main = runReq defaultHttpConfig $ do
335-- > let n :: Int
344-- > let n :: Int
336-- > n = 5
345-- > n = 5
337-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
338−-- > B.putStrLn (responseBody bs)
347+-- > liftIO $ B.putStrLn (responseBody bs)
340-- The same, but now we use a query parameter named @\"seed\"@ to control
349-- The same, but now we use a query parameter named @\"seed\"@ to control
341-- seed of the generator:
350-- seed of the generator:
343-- > main :: IO ()
352-- > main :: IO ()
344−-- > main = do
353+-- > main = runReq defaultHttpConfig $ do
345-- > let n, seed :: Int
354-- > let n, seed :: Int
346-- > n = 5
355-- > n = 5
347-- > seed = 100
356-- > seed = 100
348-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
357-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
349-- > "seed" =: seed
358-- > "seed" =: seed
350−-- > B.putStrLn (responseBody bs)
359+-- > liftIO $ B.putStrLn (responseBody bs)
352-- POST JSON data and get some info about the POST request:
361-- POST JSON data and get some info about the POST request:
@@ -360,108 +369,231 @@ import GHC.Exts (Constraint)
360-- > instance FromJSON MyData
369-- > instance FromJSON MyData
362-- > main :: IO ()
371-- > main :: IO ()
363−-- > main = do
372+-- > main = runReq defaultHttpConfig $ do
364-- > let myData = MyData
373-- > let myData = MyData
365-- > { size = 6
374-- > { size = 6
366-- > , color = "Green" }
375-- > , color = "Green" }
367-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
376-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
368−-- > print (responseBody v :: Value)
377+-- > liftIO $ print (responseBody v :: Value)
370-- Sending URL-encoded body:
379-- Sending URL-encoded body:
372-- > main :: IO ()
381-- > main :: IO ()
373−-- > main = do
382+-- > main = runReq defaultHttpConfig $ do
374-- > let params =
383-- > let params =
375-- > "foo" =: ("bar" :: Text) <>
384-- > "foo" =: ("bar" :: Text) <>
376-- > queryFlag "baz"
385-- > queryFlag "baz"
377-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
386-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
378−-- > print (responseBody response :: Value)
387+-- > liftIO $ print (responseBody response :: Value)
380-- Using various optional parameters and URL that is not known in advance:
389-- Using various optional parameters and URL that is not known in advance:
382-- > main :: IO ()
391-- > main :: IO ()
383−-- > main = do
392+-- > main = runReq defaultHttpConfig $ do
384-- > -- This is an example of what to do when URL is given dynamically. Of
393-- > -- This is an example of what to do when URL is given dynamically. Of
385-- > -- course in a real application you may not want to use 'fromJust'.
394-- > -- course in a real application you may not want to use 'fromJust'.
386−-- > let (url, options) = fromJust (parseUrlHttps "https://httpbin.org/get?foo=bar")
395+-- > uri <- URI.mkURI "https://httpbin.org/get?foo=bar"
396+-- > let (url, options) = fromJust (useHttpsURI uri)
387-- > response <- req GET url NoReqBody jsonResponse $
397-- > response <- req GET url NoReqBody jsonResponse $
388-- > "from" =: (15 :: Int) <>
398-- > "from" =: (15 :: Int) <>
389-- > "to" =: (67 :: Int) <>
399-- > "to" =: (67 :: Int) <>
390-- > basicAuth "username" "password" <>
400-- > basicAuth "username" "password" <>
391-- > options <> -- contains the ?foo=bar part
401-- > options <> -- contains the ?foo=bar part
392-- > port 443 -- here you can put any port of course
402-- > port 443 -- here you can put any port of course
393−-- > print (responseBody response :: Value)
403+-- > liftIO $ print (responseBody response :: Value)
396− :: ( MonadHttp m
405+ ( MonadHttp m,
397− , HttpMethod method
406+ HttpMethod method,
398− , HttpBody body
407+ HttpBody body,
399− , HttpResponse response
408+ HttpResponse response,
400− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
409+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
401− => method -- ^ HTTP method
411+ -- | HTTP method
402− -> Url scheme -- ^ 'Url'—location of resource
413+ -- | 'Url'—location of resource
403− -> body -- ^ Body of the request
415+ -- | Body of the request
404− -> Proxy response -- ^ A hint how to interpret response
417+ -- | A hint how to interpret response
405− -> Option scheme -- ^ Collection of optional parameters
419+ -- | Collection of optional parameters
406− -> m response -- ^ Response
421+ -- | Response
407−req method url body Proxy options = req' method url body options $ \request manager -> do
423+req method url body responseProxy options =
424+ reqCb method url body responseProxy options pure
426+-- | A version of 'req' that does not use one of the predefined instances of
427+-- 'HttpResponse' but instead allows the user to consume @'L.Response'
428+-- 'L.BodyReader'@ manually, in a custom way.
435+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
439+ -- | 'Url'—location of resource
441+ -- | Body of the request
443+ -- | Collection of optional parameters
445+ -- | How to consume response
446+ (L.Response L.BodyReader -> IO a) ->
449+reqBr method url body options consume =
450+ req' method url body options (reqHandler consume)
452+-- | A version of 'req' that takes a callback to modify the 'L.Request', but
453+-- otherwise performs the request identically.
460+ HttpResponse response,
461+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
465+ -- | 'Url'—location of resource
467+ -- | Body of the request
469+ -- | A hint how to interpret response
471+ -- | Collection of optional parameters
473+ -- | Callback to modify the request
474+ (L.Request -> m L.Request) ->
477+reqCb method url body responseProxy options adjustRequest =
478+ req' method url body (options <> extraOptions) $ \request manager -> do
479+ request' <- adjustRequest request
480+ reqHandler getHttpResponse request' manager
483+ case acceptHeader responseProxy of
485+ Just accept -> header "Accept" accept
487+-- | The default handler function that the higher-level request functions
488+-- pass to 'req''. Internal function.
493+ -- | How to get final result from a 'L.Response'
494+ (L.Response L.BodyReader -> IO b) ->
495+ -- | 'L.Request' to perform
497+ -- | 'L.Manager' to use
500+reqHandler consume request manager = do
408− HttpConfig {..} <- getHttpConfig
501+ HttpConfig {..} <- getHttpConfig
409− let wrappingVanilla = handle (throwIO . VanillaHttpException)
502+ let wrapVanilla = handle (throwIO . VanillaHttpException)
410− wrapExc = handle (throwIO . LI.toHttpException request)
503+ wrapExc = handle (throwIO . LI.toHttpException request)
507+ (readIORef >=> mapM_ L.responseClose)
411− (liftIO . try . wrappingVanilla . wrapExc) (do
508+ (liftIO . try . wrapVanilla . wrapExc)
412− response <- retrying httpConfigRetryPolicy httpConfigRetryJudge
509+ ( withRRef $ \rref -> do
413− (const $ getHttpResponse request manager)
510+ let openResponse = mask_ $ do
512+ mapM_ L.responseClose r
513+ r' <- L.responseOpen request manager
514+ writeIORef rref (Just r')
516+ exceptionRetryPolicies =
518+ ++ [ \retryStatus -> Handler $ \e ->
519+ return $ httpConfigRetryJudgeException retryStatus e
523+ httpConfigRetryPolicy
524+ (\retryStatus r -> return $ httpConfigRetryJudge retryStatus r)
527+ httpConfigRetryPolicy
528+ exceptionRetryPolicies
529+ (const openResponse)
532+ (preview, r') <- grabPreview httpConfigBodyPreviewLength r
414− httpConfigCheckResponse request response
533+ mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
415− return response)
534+ consume r'
416 >>= either handleHttpException return
536 >>= either handleHttpException return
418-- | Mostly like 'req' with respect to its arguments, but accepts a callback
538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
419-- that allows to perform a request in arbitrary fashion.
539-- that allows to perform a request in arbitrary fashion.
421-- This function /does not/ perform handling\/wrapping exceptions, checking
541-- This function /does not/ perform handling\/wrapping exceptions, checking
422−-- response, and retrying. It only prepares 'L.Request' and allows you to
542+-- response (with 'httpConfigCheckResponse'), and retrying. It only prepares
423−-- use it.
543+-- 'L.Request' and allows you to use it.
425-- @since 0.3.0
545-- @since 0.3.0
428− :: forall m method body scheme a.
547+ forall m method body scheme a.
429− ( MonadHttp m
548+ ( MonadHttp m,
430− , HttpMethod method
549+ HttpMethod method,
431− , HttpBody body
550+ HttpBody body,
432− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
551+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
433− => method -- ^ HTTP method
553+ -- | HTTP method
434− -> Url scheme -- ^ 'Url'—location of resource
555+ -- | 'Url'—location of resource
435− -> body -- ^ Body of the request
557+ -- | Body of the request
436− -> Option scheme -- ^ Collection of optional parameters
559+ -- | Collection of optional parameters
437− -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
561+ -- | How to perform request
562+ (L.Request -> L.Manager -> m a) ->
439req' method url body options m = do
565req' method url body options m = do
440− config@HttpConfig {..} <- getHttpConfig
566+ config <- getHttpConfig
441− manager <- liftIO (readIORef globalManager)
442 let -- NOTE First appearance of any given header wins. This allows to
567 let -- NOTE First appearance of any given header wins. This allows to
443 -- “overwrite” headers when we construct a request by cons-ing.
568 -- “overwrite” headers when we construct a request by cons-ing.
444 nubHeaders = Endo $ \x ->
569 nubHeaders = Endo $ \x ->
445− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
570+ x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
446− request' = flip appEndo L.defaultRequest $
572+ flip appEndo L.defaultRequest $
447− -- NOTE The order of 'mappend's matters, here method is overwritten
573+ -- NOTE The order of 'mappend's matters, here method is overwritten
448− -- first and 'options' take effect last. In particular, this means
574+ -- first and 'options' take effect last. In particular, this means
449− -- that 'options' can overwrite things set by other request
575+ -- that 'options' can overwrite things set by other request
450− -- components, which is useful for setting port number,
576+ -- components, which is useful for setting port number,
451− -- "Content-Type" header, etc.
577+ -- "Content-Type" header, etc.
452− nubHeaders <>
578+ nubHeaders
453− getRequestMod options <>
579+ <> getRequestMod options
454− getRequestMod config <>
580+ <> getRequestMod config
455− getRequestMod (Womb body :: Womb "body" body) <>
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
456− getRequestMod url <>
582+ <> getRequestMod url
457− getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
458 request <- finalizeRequest options request'
584 request <- finalizeRequest options request'
459− m request manager
585+ withReqManager (m request)
587+-- | Perform an action using the global implicit 'L.Manager' that the rest
588+-- of the library uses. This allows us to reuse connections that the
589+-- 'L.Manager' controls.
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
461−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
593+-- | The global 'L.Manager' that 'req' uses. Here we just go with the
462−-- settings, so users don't need to deal with this manager stuff at all, but
594+-- default settings, so users don't need to deal with this manager stuff at
463−-- when we create a request, instance 'HttpConfig' can affect the default
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
464−-- settings via 'getHttpConfig'.
596+-- default settings via 'getHttpConfig'.
466-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
467-- The value of 'globalManager' is named and lives on top level. This means
599-- The value of 'globalManager' is named and lives on top level. This means
@@ -469,24 +601,20 @@ req' method url body options m = do
469-- manager. From that moment on the 'IORef' will be just reused—exactly the
601-- manager. From that moment on the 'IORef' will be just reused—exactly the
470-- behavior we want here in order to maximize connection sharing. GHC could
602-- behavior we want here in order to maximize connection sharing. GHC could
471-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
473−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
474globalManager = unsafePerformIO $ do
605globalManager = unsafePerformIO $ do
475 context <- NC.initConnectionContext
606 context <- NC.initConnectionContext
476− let settings = L.mkManagerSettingsContext (Just context) def Nothing
608+ L.mkManagerSettingsContext
477 manager <- L.newManager settings
612 manager <- L.newManager settings
478− newIORef manager
613+ return manager
479{-# NOINLINE globalManager #-}
614{-# NOINLINE globalManager #-}
481−-- | Perform an action using global implicit 'L.Manager' that the rest of
482−-- the library uses. This allows to reuse connections that the 'L.Manager'
485−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
486−withReqManager m = liftIO (readIORef globalManager) >>= m
488----------------------------------------------------------------------------
616----------------------------------------------------------------------------
489−-- Embedding requests into your monad
617+-- Embedding requests in your monad
491-- $embedding-requests
619-- $embedding-requests
@@ -495,110 +623,165 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
496-- When writing a library, keep your API polymorphic in terms of
624-- When writing a library, keep your API polymorphic in terms of
497-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
498−-- Another option is to use @newtype@ wrapped monad stack and define
626+-- Another option is to use a @newtype@-wrapped monad stack and define
499−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad is provided
627+-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
500−-- for this out-of-the-box.
628+-- follows this strategy is provided out-of-the-box (see below).
502-- | A type class for monads that support performing HTTP requests.
630-- | A type class for monads that support performing HTTP requests.
503-- Typically, you only need to define the 'handleHttpException' method
631-- Typically, you only need to define the 'handleHttpException' method
504-- unless you want to tweak 'HttpConfig'.
632-- unless you want to tweak 'HttpConfig'.
506−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
508 -- | This method describes how to deal with 'HttpException' that was
634 -- | This method describes how to deal with 'HttpException' that was
509 -- caught by the library. One option is to re-throw it if you are OK with
635 -- caught by the library. One option is to re-throw it if you are OK with
510 -- exceptions, but if you prefer working with something like
636 -- exceptions, but if you prefer working with something like
511 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
512 -- 'Control.Monad.Except.throwError'.
638 -- 'Control.Monad.Except.throwError'.
514 handleHttpException :: HttpException -> m a
639 handleHttpException :: HttpException -> m a
516− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
517− -- implementation returns its 'def' value, which is described in the
642+ -- Default implementation returns its 'def' value, which is described in
518− -- documentation for the type. Common usage pattern with manually defined
643+ -- the documentation for the type. Common usage pattern with manually
519− -- 'getHttpConfig' is to return some hard-coded value, or value extracted
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
520− -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
645+ -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
521− -- configuration is desirable.
646+ -- approach to configuration is desirable.
523 getHttpConfig :: m HttpConfig
647 getHttpConfig :: m HttpConfig
524− getHttpConfig = return def
648+ getHttpConfig = return defaultHttpConfig
526−-- | 'HttpConfig' contains general and default settings to be used when
527−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
529data HttpConfig = HttpConfig
651data HttpConfig = HttpConfig
530− { httpConfigProxy :: Maybe L.Proxy
531− -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
652+ { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
532 -- environment variables are respected, this setting overwrites them.
653 -- environment variables are respected, this setting overwrites them.
533 -- Default value: 'Nothing'.
654 -- Default value: 'Nothing'.
534− , httpConfigRedirectCount :: Int
655+ httpConfigProxy :: Maybe L.Proxy,
535− -- ^ How many redirects to follow when getting a resource. Default
656+ -- | How many redirects to follow when getting a resource. Default
536 -- value: 10.
657 -- value: 10.
537− , httpConfigAltManager :: Maybe L.Manager
658+ httpConfigRedirectCount :: Int,
538− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
539− -- that default implicit manager will be used (that's what you want in
660+ -- that the default implicit manager will be used (that's what you want
540− -- 99% of cases).
661+ -- in 99% of cases).
541− , httpConfigCheckResponse :: forall r. HttpResponse r => L.Request -> r -> IO ()
662+ httpConfigAltManager :: Maybe L.Manager,
542− -- ^ Function to check the response immediately after receiving the
663+ -- | Function to check the response immediately after receiving the
664+ -- status and headers, before streaming of response body. The third
665+ -- argument is the beginning of response body (typically first 1024
543− -- status and headers. This is used for throwing exceptions on
666+ -- bytes). This is used for throwing exceptions on non-success status
544− -- non-success status codes by default (set to @\\_ _ -> return ()@ if
667+ -- codes by default (set to @\\_ _ _ -> Nothing@ if this behavior is not
545− -- this behavior is not desirable). Throwing is better then just
668+ -- desirable).
670+ -- When the value this function returns is 'Nothing', nothing will
671+ -- happen. When it there is 'L.HttpExceptionContent' inside 'Just', it
546− -- returning a request with non-2xx status code because in that case
674+ -- Throwing is better then just returning a request with non-2xx status
547− -- something is wrong and we need a way to short-cut execution. The
675+ -- code because in that case something is wrong and we need a way to
676+ -- short-cut execution (also remember that Req retries automatically on
677+ -- request timeouts and such, so when your request fails, it's certainly
548− -- thrown exception is caught by the library though and is available in
678+ -- something exceptional). The thrown exception is caught by the library
549− -- 'handleHttpException'.
679+ -- though and is available in 'handleHttpException'.
681+ -- __Note__: signature of this function was changed in the version
551 -- @since 0.3.0
684 -- @since 0.3.0
552− , httpConfigRetryPolicy :: RetryPolicyM IO
685+ httpConfigCheckResponse ::
690+ Maybe L.HttpExceptionContent,
553− -- ^ The retry policy to use for request retrying. By default 'def' is
691+ -- | The retry policy to use for request retrying. By default 'def' is
554 -- used (see 'RetryPolicyM').
692 -- used (see 'RetryPolicyM').
694+ -- __Note__: signature of this function was changed to disallow 'IO' in
695+ -- version /1.0.0/ and then changed back to its current form in /3.1.0/.
556 -- @since 0.3.0
697 -- @since 0.3.0
557− , httpConfigRetryJudge :: forall r. HttpResponse r => RetryStatus -> r -> IO Bool
698+ httpConfigRetryPolicy :: RetryPolicyM IO,
558− -- ^ The function is used to decide whether to retry a request. 'True'
699+ -- | The function is used to decide whether to retry a request. 'True'
559 -- means that the request should be retried.
700 -- means that the request should be retried.
702+ -- __Note__: signature of this function was changed in the version
561 -- @since 0.3.0
705 -- @since 0.3.0
562− } deriving Typeable
706+ httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
563−
707+ -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
564−instance Default HttpConfig where
708+ -- retry requests that resulted in an exception. By default it retries
709+ -- on response timeout and connection timeout (changed in version
713+ httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714+ -- | Max length of preview fragment of response body.
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
720+-- | The default value of 'HttpConfig'.
723+defaultHttpConfig :: HttpConfig
565− def = HttpConfig
725+ HttpConfig
566− { httpConfigProxy = Nothing
726+ { httpConfigProxy = Nothing,
567− , httpConfigRedirectCount = 10
727+ httpConfigRedirectCount = 10,
568− , httpConfigAltManager = Nothing
728+ httpConfigAltManager = Nothing,
569− , httpConfigCheckResponse = \_ response ->
729+ httpConfigCheckResponse = \_ response preview ->
570− let statusCode = responseStatusCode response in
730+ let scode = statusCode response
571− unless (200 <= statusCode && statusCode < 300) $
731+ in if 200 <= scode && scode < 300
572− let chunk = makeResponseBodyPreview response
732+ then Nothing
573− vresponse = toVanillaResponse response
574− in LI.throwHttp (L.StatusCodeException (void vresponse) chunk)
733+ else Just (L.StatusCodeException (void response) preview),
575− , httpConfigRetryPolicy = def
734+ httpConfigRetryPolicy = retryPolicyDefault,
576− , httpConfigRetryJudge = \_ r -> return $
735+ httpConfigRetryJudge = \_ response ->
577− responseStatusCode r `elem`
736+ statusCode response
578− [ 408 -- Request timeout
737+ `elem` [ 408, -- Request timeout
579− , 504 -- Gateway timeout
738+ 504, -- Gateway timeout
580− , 524 -- A timeout occurred
739+ 524, -- A timeout occurred
581− , 598 -- (Informal convention) Network read timeout error
740+ 598, -- (Informal convention) Network read timeout error
582− , 599 -- (Informal convention) Network connect timeout error
741+ 599 -- (Informal convention) Network connect timeout error
743+ httpConfigRetryJudgeException = \_ e ->
744+ case fromException e of
745+ Just (L.HttpExceptionRequest _ c) ->
747+ L.ResponseTimeout -> True
748+ L.ConnectionTimeout -> True
751+ httpConfigBodyPreviewLength = 1024
754+ statusCode = Y.statusCode . L.responseStatus
586instance RequestComponent HttpConfig where
756instance RequestComponent HttpConfig where
587 getRequestMod HttpConfig {..} = Endo $ \x ->
757 getRequestMod HttpConfig {..} = Endo $ \x ->
588− x { L.proxy = httpConfigProxy
759+ { L.proxy = httpConfigProxy,
589− , L.redirectCount = httpConfigRedirectCount
760+ L.redirectCount = httpConfigRedirectCount,
590− , LI.requestManagerOverride = httpConfigAltManager }
761+ LI.requestManagerOverride = httpConfigAltManager
592−-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
764+-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
593-- having to define new instances.
765-- having to define new instances.
595-- @since 0.4.0
767-- @since 0.4.0
597newtype Req a = Req (ReaderT HttpConfig IO a)
768newtype Req a = Req (ReaderT HttpConfig IO a)
598− deriving ( Functor
769+ deriving
599− , Applicative
771+ Applicative,
601− , MonadIO )
773+ MonadIO,
778+deriving instance MonadThrow Req
781+deriving instance MonadCatch Req
784+deriving instance MonadMask Req
603instance MonadBase IO Req where
786instance MonadBase IO Req where
604 liftBase = liftIO
787 liftBase = liftIO
@@ -607,22 +790,99 @@ instance MonadBaseControl IO Req where
607 type StM Req a = a
790 type StM Req a = a
608 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
791 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
609 {-# INLINEABLE liftBaseWith #-}
792 {-# INLINEABLE liftBaseWith #-}
610− restoreM = Req . ReaderT . const . return
793+ restoreM = Req . ReaderT . const . return
611 {-# INLINEABLE restoreM #-}
794 {-# INLINEABLE restoreM #-}
613instance MonadHttp Req where
796instance MonadHttp Req where
614 handleHttpException = Req . lift . throwIO
797 handleHttpException = Req . lift . throwIO
615− getHttpConfig = Req ask
798+ getHttpConfig = Req ask
801+instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802+ handleHttpException = lift . handleHttpException
803+ getHttpConfig = lift getHttpConfig
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
807+ handleHttpException = lift . handleHttpException
808+ getHttpConfig = lift getHttpConfig
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812+ handleHttpException = lift . handleHttpException
813+ getHttpConfig = lift getHttpConfig
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
817+ handleHttpException = lift . handleHttpException
818+ getHttpConfig = lift getHttpConfig
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
822+ handleHttpException = lift . handleHttpException
823+ getHttpConfig = lift getHttpConfig
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827+ handleHttpException = lift . handleHttpException
828+ getHttpConfig = lift getHttpConfig
831+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832+ handleHttpException = lift . handleHttpException
833+ getHttpConfig = lift getHttpConfig
836+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837+ handleHttpException = lift . handleHttpException
838+ getHttpConfig = lift getHttpConfig
841+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842+ handleHttpException = lift . handleHttpException
843+ getHttpConfig = lift getHttpConfig
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
847+ handleHttpException = lift . handleHttpException
848+ getHttpConfig = lift getHttpConfig
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852+ handleHttpException = lift . handleHttpException
853+ getHttpConfig = lift getHttpConfig
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857+ handleHttpException = lift . handleHttpException
858+ getHttpConfig = lift getHttpConfig
861+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862+ handleHttpException = lift . handleHttpException
863+ getHttpConfig = lift getHttpConfig
866+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867+ handleHttpException = lift . handleHttpException
868+ getHttpConfig = lift getHttpConfig
871+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872+ handleHttpException = lift . handleHttpException
873+ getHttpConfig = lift getHttpConfig
617-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
618−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
620-- @since 0.4.0
878-- @since 0.4.0
622−runReq :: MonadIO m
880+ (MonadIO m) =>
623− => HttpConfig -- ^ 'HttpConfig' to use
881+ -- | 'HttpConfig' to use
624− -> Req a -- ^ Computation to run
883+ -- | Computation to run
626runReq config (Req m) = liftIO (runReaderT m config)
886runReq config (Req m) = liftIO (runReaderT m config)
628----------------------------------------------------------------------------
888----------------------------------------------------------------------------
@@ -638,7 +898,6 @@ runReq config (Req m) = liftIO (runReaderT m config)
638-- define a new method that will works seamlessly, see 'HttpMethod'.
898-- define a new method that will works seamlessly, see 'HttpMethod'.
640-- | 'GET' method.
900-- | 'GET' method.
642data GET = GET
901data GET = GET
644instance HttpMethod GET where
903instance HttpMethod GET where
@@ -646,7 +905,6 @@ instance HttpMethod GET where
646 httpMethodName Proxy = Y.methodGet
905 httpMethodName Proxy = Y.methodGet
648-- | 'POST' method.
907-- | 'POST' method.
650data POST = POST
908data POST = POST
652instance HttpMethod POST where
910instance HttpMethod POST where
@@ -654,7 +912,6 @@ instance HttpMethod POST where
654 httpMethodName Proxy = Y.methodPost
912 httpMethodName Proxy = Y.methodPost
656-- | 'HEAD' method.
914-- | 'HEAD' method.
658data HEAD = HEAD
915data HEAD = HEAD
660instance HttpMethod HEAD where
917instance HttpMethod HEAD where
@@ -662,26 +919,24 @@ instance HttpMethod HEAD where
662 httpMethodName Proxy = Y.methodHead
919 httpMethodName Proxy = Y.methodHead
664-- | 'PUT' method.
921-- | 'PUT' method.
666data PUT = PUT
922data PUT = PUT
668instance HttpMethod PUT where
924instance HttpMethod PUT where
669 type AllowsBody PUT = 'CanHaveBody
925 type AllowsBody PUT = 'CanHaveBody
670 httpMethodName Proxy = Y.methodPut
926 httpMethodName Proxy = Y.methodPut
672−-- | 'DELETE' method. This data type does not allow having request body with
928+-- | 'DELETE' method. RFC 7231 allows a payload in DELETE but without
673−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
929+-- semantics.
674−-- requests to have bodies, in that case define your own variation of
930+--
675−-- 'DELETE' method and allow it to have a body.
931+-- __Note__: before version /3.4.0/ this method did not allow request
677data DELETE = DELETE
933data DELETE = DELETE
679instance HttpMethod DELETE where
935instance HttpMethod DELETE where
680− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
681 httpMethodName Proxy = Y.methodDelete
937 httpMethodName Proxy = Y.methodDelete
683-- | 'TRACE' method.
939-- | 'TRACE' method.
685data TRACE = TRACE
940data TRACE = TRACE
687instance HttpMethod TRACE where
942instance HttpMethod TRACE where
@@ -689,7 +944,6 @@ instance HttpMethod TRACE where
689 httpMethodName Proxy = Y.methodTrace
944 httpMethodName Proxy = Y.methodTrace
691-- | 'CONNECT' method.
946-- | 'CONNECT' method.
693data CONNECT = CONNECT
947data CONNECT = CONNECT
695instance HttpMethod CONNECT where
949instance HttpMethod CONNECT where
@@ -697,7 +951,6 @@ instance HttpMethod CONNECT where
697 httpMethodName Proxy = Y.methodConnect
951 httpMethodName Proxy = Y.methodConnect
699-- | 'OPTIONS' method.
953-- | 'OPTIONS' method.
701data OPTIONS = OPTIONS
954data OPTIONS = OPTIONS
703instance HttpMethod OPTIONS where
956instance HttpMethod OPTIONS where
@@ -705,7 +958,6 @@ instance HttpMethod OPTIONS where
705 httpMethodName Proxy = Y.methodOptions
958 httpMethodName Proxy = Y.methodOptions
707-- | 'PATCH' method.
960-- | 'PATCH' method.
709data PATCH = PATCH
961data PATCH = PATCH
711instance HttpMethod PATCH where
963instance HttpMethod PATCH where
@@ -713,30 +965,26 @@ instance HttpMethod PATCH where
713 httpMethodName Proxy = Y.methodPatch
965 httpMethodName Proxy = Y.methodPatch
715-- | A type class for types that can be used as an HTTP method. To define a
967-- | A type class for types that can be used as an HTTP method. To define a
716−-- non-standard method, follow this example that defines COPY:
968+-- non-standard method, follow this example that defines @COPY@:
718-- > data COPY = COPY
970-- > data COPY = COPY
720-- > instance HttpMethod COPY where
972-- > instance HttpMethod COPY where
721-- > type AllowsBody COPY = 'CanHaveBody
973-- > type AllowsBody COPY = 'CanHaveBody
722-- > httpMethodName Proxy = "COPY"
974-- > httpMethodName Proxy = "COPY"
724class HttpMethod a where
975class HttpMethod a where
726 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
727− -- tells the rest of the library whether the method can have a body or
977+ -- tells the rest of the library whether the method can have body or not.
728− -- not. We use the special type 'CanHaveBody' “lifted” to kind level
978+ -- We use the special type 'CanHaveBody' lifted to the kind level instead
729− -- instead of 'Bool' to get more user-friendly compiler messages.
979+ -- of 'Bool' to get more user-friendly compiler messages.
731 type AllowsBody a :: CanHaveBody
980 type AllowsBody a :: CanHaveBody
733 -- | Return name of the method as a 'ByteString'.
982 -- | Return name of the method as a 'ByteString'.
735 httpMethodName :: Proxy a -> ByteString
983 httpMethodName :: Proxy a -> ByteString
737−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
738 getRequestMod _ = Endo $ \x ->
986 getRequestMod _ = Endo $ \x ->
739− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
741----------------------------------------------------------------------------
989----------------------------------------------------------------------------
742-- Request—URL
990-- Request—URL
@@ -744,7 +992,7 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
746-- We use 'Url's which are correct by construction, see 'Url'. To build a
994-- We use 'Url's which are correct by construction, see 'Url'. To build a
747−-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
749-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
750-- specifying the scheme and host at the same time. Then use the @('/~')@
998-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -774,91 +1022,194 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
775-- > https "юникод.рф"
1023-- > https "юникод.рф"
776-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
778data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
779 -- NOTE The second value is the path segments in reversed order.
1026 -- NOTE The second value is the path segments in reversed order.
780− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1029+type role Url nominal
1031+-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1032+-- the derived lift forgets the type of the scheme.
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
1035+ TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036+ Url Http _ -> [t|Url 'Http|]
1037+ Url Https _ -> [t|Url 'Https|]
1039+ liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
782−-- | Given host name, produce a 'Url' which have “http” as its scheme and
1042+-- | Given host name, produce a 'Url' which has “http” as its scheme and
783-- empty path. This also sets port to @80@.
1043-- empty path. This also sets port to @80@.
785http :: Text -> Url 'Http
1044http :: Text -> Url 'Http
786http = Url Http . pure
1045http = Url Http . pure
788−-- | Given host name, produce a 'Url' which have “https” as its scheme and
1047+-- | Given host name, produce a 'Url' which has “https” as its scheme and
789-- empty path. This also sets port to @443@.
1048-- empty path. This also sets port to @443@.
791https :: Text -> Url 'Https
1049https :: Text -> Url 'Https
792https = Url Https . pure
1050https = Url Https . pure
794−-- | Grow given 'Url' appending a single path segment to it. Note that the
1052+-- | Grow a given 'Url' appending a single path segment to it. Note that the
795-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
797infixl 5 /~
1054infixl 5 /~
798−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
799−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
801−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
802−-- when next URL piece is a 'Text' literal.
1057+Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
804infixl 5 /:
1061infixl 5 /:
805(/:) :: Url scheme -> Text -> Url scheme
1063(/:) :: Url scheme -> Text -> Url scheme
806(/:) = (/~)
1064(/:) = (/~)
1066+-- | Render a 'Url' as 'Text'.
1069+renderUrl :: Url scheme -> Text
1072+ "https://" <> renderParts parts
1074+ "http://" <> renderParts parts
1076+ renderParts parts =
1077+ T.intercalate "/" (reverse $ NE.toList parts)
808−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
1079+-- | The 'useHttpURI' function provides an alternative method to get 'Url'
809−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
1080+-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
810−-- you are given a URL to query dynamically and don't know it beforehand.
1081+-- given a URL to query dynamically and don't know it beforehand.
811−-- The function parses 'ByteString' because it's the correct type to
1082+--
812−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
1083+-- This function expects the scheme to be “http” and host to be present.
813−-- range, thus we can consider every character a 'Data.Word.Word8' value.
1084+--
814−--
1085+-- @since 3.0.0
815−-- This function only parses 'Url' (scheme, host, path) and optional query
1086+useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
816−-- parameters that are returned as 'Option'. It does not parse method name
1087+useHttpURI uri = do
817−-- or authentication info from given 'ByteString'.
1088+ guard (URI.uriScheme uri == Just [QQ.scheme|http|])
818−
1089+ urlHead <- http <$> uriHost uri
819−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
1090+ let url = case URI.uriPath uri of
820−parseUrlHttp url' = do
1091+ Nothing -> urlHead
821− url <- B.stripPrefix "http://" url'
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
822− (host :| path, option) <- parseUrlHelper url
1093+ return (url, uriOptions uri)
823− return (foldl (/:) (http host) path, option)
1094+
825−-- | Just like 'parseUrlHttp', but expects “https” scheme.
1095+-- | Just like 'useHttpURI', but expects the “https” scheme.
827−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
1098+useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
828−parseUrlHttps url' = do
1099+useHttpsURI uri = do
829− url <- B.stripPrefix "https://" url'
1100+ guard (URI.uriScheme uri == Just [QQ.scheme|https|])
830− (host :| path, option) <- parseUrlHelper url
1101+ urlHead <- https <$> uriHost uri
831− return (foldl (/:) (https host) path, option)
1102+ let url = case URI.uriPath uri of
832−
1103+ Nothing -> urlHead
833−-- | Get host\/collection of path pieces and possibly query parameters
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
834−-- already converted to 'Option'. This function is not public.
1105+ return (url, uriOptions uri)
836−parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
1107+-- | Convert URI path to a 'Url'. Internal.
837−parseUrlHelper url = do
1108+--
838− let (path', query') = B.break (== 0x3f) url
1109+-- @since 3.9.0
839− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
1110+uriPathToUrl ::
840− p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
841− (p, port') <-
1112+ Url scheme ->
842− case T.break (== ':') p' of
1113+ Url scheme
843− (x, "") -> return (x, mempty)
1114+uriPathToUrl (trailingSlash, xs) urlHead =
844− (x, prt) ->
1115+ if trailingSlash then path /: T.empty else path
845− case TR.decimal (T.drop 1 prt) of
1116+ where
846− Right (prt',"") -> return (x, port prt')
1117+ path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
848− return (p :| ps, query <> port')
1119+-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
1120+-- is not known in advance.
1127+ (Url 'Http, Option scheme0)
1128+ (Url 'Https, Option scheme1)
1131+ (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
1133+-- | An internal helper function to extract host from a 'URI'.
1134+uriHost :: URI -> Maybe Text
1135+uriHost uri = case URI.uriAuthority uri of
1137+ Right URI.Authority {..} ->
1138+ Just (URI.unRText authHost)
1140+-- | A quasiquoter to build an 'Url' and 'Option' tuple. The type of the
1141+-- generated expression is @('Url' scheme0, 'Option' scheme1)@ with
1142+-- @scheme0@ being either 'Http' or 'Https' depending on the input.
1145+urlQ :: TH.QuasiQuoter
1148+ { quoteExp = \str ->
1149+ case URI.mkURI (T.pack str) of
1150+ Left err -> fail (displayException err)
1151+ Right uri -> case useURI uri of
1152+ Nothing -> fail "Not a HTTP or HTTPS URL"
1155+ [ either (TH.lift . fst) (TH.lift . fst) eurl,
1158+ quotePat = error "This usage is not supported",
1159+ quoteType = error "This usage is not supported",
1160+ quoteDec = error "This usage is not supported"
1163+-- | An internal helper function to extract 'Option's from a 'URI'.
1164+uriOptions :: forall scheme. URI -> Option scheme
1174+ case URI.uriAuthority uri of
1175+ Left _ -> (mempty, mempty)
1176+ Right URI.Authority {..} ->
1177+ let auth0 = case authUserInfo of
1179+ Just URI.UserInfo {..} ->
1180+ let username = T.encodeUtf8 (URI.unRText uiUsername)
1181+ password = maybe "" (T.encodeUtf8 . URI.unRText) uiPassword
1182+ in basicAuthUnsafe username password
1183+ port0 = case authPort of
1185+ Just port'' -> port (fromIntegral port'')
1188+ let liftQueryParam = \case
1189+ URI.QueryFlag t -> queryFlag (URI.unRText t)
1190+ URI.QueryParam k v -> URI.unRText k =: URI.unRText v
1191+ in mconcat (liftQueryParam <$> URI.uriQuery uri)
1193+-- TODO Blocked on upstream: https://github.com/snoyberg/http-client/issues/424
1195+-- case URI.uriFragment uri of
1196+-- Nothing -> mempty
1197+-- Just fragment'' -> fragment (URI.unRText fragment'')
850instance RequestComponent (Url scheme) where
1199instance RequestComponent (Url scheme) where
851 getRequestMod (Url scheme segments) = Endo $ \x ->
1200 getRequestMod (Url scheme segments) = Endo $ \x ->
852− let (host :| path) = NE.reverse segments in
1201+ let (host :| path) = NE.reverse segments
853− x { L.secure = case scheme of
1203+ { L.secure = case scheme of
854− Http -> False
1204+ Http -> False
855− Https -> True
1205+ Https -> True,
856− , L.port = case scheme of
1206+ L.port = case scheme of
857− Http -> 80
1207+ Http -> 80
858− Https -> 443
1208+ Https -> 443,
859− , L.host = Y.urlEncode False (T.encodeUtf8 host)
1209+ L.host = Y.urlEncode False (T.encodeUtf8 host),
860− , L.path =
1210+ L.path =
861− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1211+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
863----------------------------------------------------------------------------
1214----------------------------------------------------------------------------
864-- Request—Body
1215-- Request—Body
@@ -867,39 +1218,37 @@ instance RequestComponent (Url scheme) where
868-- A number of options for request bodies are available. The @Content-Type@
1219-- A number of options for request bodies are available. The @Content-Type@
869-- header is set for you automatically according to the body option you use
1220-- header is set for you automatically according to the body option you use
870−-- (it's always specified in documentation for a given body option). To add
1221+-- (it's always specified in the documentation for a given body option). To
871−-- your own way to represent request body, see 'HttpBody'.
1222+-- add your own way to represent request body, define an instance of
873-- | This data type represents empty body of an HTTP request. This is the
1225-- | This data type represents empty body of an HTTP request. This is the
874-- data type to use with 'HttpMethod's that cannot have a body, as it's the
1226-- data type to use with 'HttpMethod's that cannot have a body, as it's the
875-- only type for which 'ProvidesBody' returns 'NoBody'.
1227-- only type for which 'ProvidesBody' returns 'NoBody'.
877-- Using of this body option does not set the @Content-Type@ header.
1229-- Using of this body option does not set the @Content-Type@ header.
879data NoReqBody = NoReqBody
1230data NoReqBody = NoReqBody
881instance HttpBody NoReqBody where
1232instance HttpBody NoReqBody where
882 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
884−-- | This body option allows to use a JSON object as request body—probably
1235+-- | This body option allows us to use a JSON object as the request
885−-- the most popular format right now. Just wrap a data type that is an
1236+-- body—probably the most popular format right now. Just wrap a data type
886−-- instance of 'ToJSON' type class and you are done: it will be converted to
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
887−-- JSON and inserted as request body.
1238+-- converted to JSON and inserted as request body.
889-- This body option sets the @Content-Type@ header to @\"application/json;
1240-- This body option sets the @Content-Type@ header to @\"application/json;
890-- charset=utf-8\"@ value.
1241-- charset=utf-8\"@ value.
892newtype ReqBodyJson a = ReqBodyJson a
1242newtype ReqBodyJson a = ReqBodyJson a
894−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
895 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
896 getRequestContentType _ = pure "application/json; charset=utf-8"
1246 getRequestContentType _ = pure "application/json; charset=utf-8"
898-- | This body option streams request body from a file. It is expected that
1248-- | This body option streams request body from a file. It is expected that
899−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
901-- Using of this body option does not set the @Content-Type@ header.
1251-- Using of this body option does not set the @Content-Type@ header.
903newtype ReqBodyFile = ReqBodyFile FilePath
1252newtype ReqBodyFile = ReqBodyFile FilePath
905instance HttpBody ReqBodyFile where
1254instance HttpBody ReqBodyFile where
@@ -909,7 +1258,6 @@ instance HttpBody ReqBodyFile where
909-- | HTTP request body represented by a strict 'ByteString'.
1258-- | HTTP request body represented by a strict 'ByteString'.
911-- Using of this body option does not set the @Content-Type@ header.
1260-- Using of this body option does not set the @Content-Type@ header.
913newtype ReqBodyBs = ReqBodyBs ByteString
1261newtype ReqBodyBs = ReqBodyBs ByteString
915instance HttpBody ReqBodyBs where
1263instance HttpBody ReqBodyBs where
@@ -918,22 +1266,19 @@ instance HttpBody ReqBodyBs where
918-- | HTTP request body represented by a lazy 'BL.ByteString'.
1266-- | HTTP request body represented by a lazy 'BL.ByteString'.
920-- Using of this body option does not set the @Content-Type@ header.
1268-- Using of this body option does not set the @Content-Type@ header.
922newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
924instance HttpBody ReqBodyLbs where
1271instance HttpBody ReqBodyLbs where
925 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
927−-- | Form URL-encoded body. This can hold a collection of parameters which
1274+-- | URL-encoded body. This can hold a collection of parameters which are
928−-- are encoded similarly to query parameters at the end of query string,
1275+-- encoded similarly to query parameters at the end of query string, with
929−-- with the only difference that they are stored in request body. The
1276+-- the only difference that they are stored in request body. The similarity
930−-- similarity is reflected in the API as well, as you can use the same
1277+-- is reflected in the API as well, as you can use the same combinators you
931−-- combinators you would use to add query parameters: @('=:')@ and
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
934-- This body option sets the @Content-Type@ header to
1280-- This body option sets the @Content-Type@ header to
935−-- @\"application/x-www-from-urlencoded\"@ value.
1281+-- @\"application/x-www-form-urlencoded\"@ value.
937newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
1282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
939instance HttpBody ReqBodyUrlEnc where
1284instance HttpBody ReqBodyUrlEnc where
@@ -943,33 +1288,37 @@ instance HttpBody ReqBodyUrlEnc where
944-- | An opaque monoidal value that allows to collect URL-encoded parameters
1289-- | An opaque monoidal value that allows to collect URL-encoded parameters
945-- to be wrapped in 'ReqBodyUrlEnc'.
1290-- to be wrapped in 'ReqBodyUrlEnc'.
947newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
1291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
948 deriving (Semigroup, Monoid)
1292 deriving (Semigroup, Monoid)
950instance QueryParam FormUrlEncodedParam where
1294instance QueryParam FormUrlEncodedParam where
951 queryParam name mvalue =
1295 queryParam name mvalue =
952 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
1299+-- | Use 'formToQuery'.
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
954-- | Multipart form data. Please consult the
1305-- | Multipart form data. Please consult the
955-- "Network.HTTP.Client.MultipartFormData" module for how to construct
1306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
956-- parts, then use 'reqBodyMultipart' to create actual request body from the
1307-- parts, then use 'reqBodyMultipart' to create actual request body from the
957−-- parts. 'reqBodyMultipart' is the only way to get a value of type
1308+-- parts. 'reqBodyMultipart' is the only way to get a value of the type
958-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
1309-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
960-- @since 0.2.0
1311-- @since 0.2.0
962−-- ==== __Example__
1313+-- ==== __Examples__
964−-- > import Control.Exception (throwIO)
1315+-- > import Control.Monad.IO.Class
965−-- > import qualified Network.HTTP.Client.MultipartFormData as LM
1316+-- > import Data.Default.Class
966-- > import Network.HTTP.Req
1317-- > import Network.HTTP.Req
967−-- >
1318+-- > import qualified Network.HTTP.Client.MultipartFormData as LM
968−-- > instance MonadHttp IO where
969−-- > handleHttpException = throwIO
971-- > main :: IO ()
1320-- > main :: IO ()
972−-- > main = do
1321+-- > main = runReq def $ do
973-- > body <-
1322-- > body <-
974-- > reqBodyMultipart
1323-- > reqBodyMultipart
975-- > [ LM.partBS "title" "My Image"
1324-- > [ LM.partBS "title" "My Image"
@@ -980,8 +1329,7 @@ instance QueryParam FormUrlEncodedParam where
980-- > body
1329-- > body
981-- > bsResponse
1330-- > bsResponse
982-- > mempty
1331-- > mempty
983−-- > print $ responseBody response
1332+-- > liftIO $ print (responseBody response)
985data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
1333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
987instance HttpBody ReqBodyMultipart where
1335instance HttpBody ReqBodyMultipart where
@@ -992,126 +1340,117 @@ instance HttpBody ReqBodyMultipart where
992-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
994-- @since 0.2.0
1342-- @since 0.2.0
996−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
997reqBodyMultipart parts = liftIO $ do
1344reqBodyMultipart parts = liftIO $ do
998 boundary <- LM.webkitBoundary
1345 boundary <- LM.webkitBoundary
999− body <- LM.renderParts boundary parts
1346+ body <- LM.renderParts boundary parts
1000 return (ReqBodyMultipart boundary body)
1347 return (ReqBodyMultipart boundary body)
1002-- | A type class for things that can be interpreted as an HTTP
1349-- | A type class for things that can be interpreted as an HTTP
1003-- 'L.RequestBody'.
1350-- 'L.RequestBody'.
1005class HttpBody body where
1351class HttpBody body where
1007− {-# MINIMAL getRequestBody #-}
1009 -- | How to get actual 'L.RequestBody'.
1352 -- | How to get actual 'L.RequestBody'.
1011 getRequestBody :: body -> L.RequestBody
1353 getRequestBody :: body -> L.RequestBody
1013− -- | This method allows to optionally specify value of @Content-Type@
1355+ -- | This method allows us to optionally specify the value of
1014− -- header that should be used with particular body option. By default it
1356+ -- @Content-Type@ header that should be used with particular body option.
1015− -- returns 'Nothing' and so @Content-Type@ is not set.
1357+ -- By default it returns 'Nothing' and so @Content-Type@ is not set.
1017 getRequestContentType :: body -> Maybe ByteString
1358 getRequestContentType :: body -> Maybe ByteString
1018 getRequestContentType = const Nothing
1359 getRequestContentType = const Nothing
1020-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1021−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1022−-- 'GET' method and other methods that should not send a body.
1363+-- with 'GET' method and other methods that should not have body.
1024type family ProvidesBody body :: CanHaveBody where
1364type family ProvidesBody body :: CanHaveBody where
1025 ProvidesBody NoReqBody = 'NoBody
1365 ProvidesBody NoReqBody = 'NoBody
1026− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
1028-- | This type function allows any HTTP body if method says it
1368-- | This type function allows any HTTP body if method says it
1029-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
1369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
1030-- body option to use is 'NoReqBody'.
1370-- body option to use is 'NoReqBody'.
1032−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1033−-- error message when method does not allow a body and body is provided.
1035−type family HttpBodyAllowed
1371+type family
1036− (allowsBody :: CanHaveBody)
1373+ (allowsBody :: CanHaveBody)
1037− (providesBody :: CanHaveBody) :: Constraint where
1374+ (providesBody :: CanHaveBody) ::
1038− HttpBodyAllowed 'NoBody 'NoBody = ()
1377+ HttpBodyAllowed 'NoBody 'NoBody = ()
1039− HttpBodyAllowed 'CanHaveBody body = ()
1378+ HttpBodyAllowed 'CanHaveBody body = ()
1040−#if MIN_VERSION_base(4,9,0)
1041− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1379+ HttpBodyAllowed 'NoBody 'CanHaveBody =
1042− ('Text "This HTTP method does not allow attaching a request body.")
1381+ ('Text "This HTTP method does not allow attaching a request body.")
1045−instance HttpBody body => RequestComponent (Womb "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1046− getRequestMod (Womb body) = Endo $ \x ->
1384+ getRequestMod (Tagged body) = Endo $ \x ->
1047− x { L.requestBody = getRequestBody body
1386+ { L.requestBody = getRequestBody body,
1048− , L.requestHeaders =
1387+ L.requestHeaders =
1049− let old = L.requestHeaders x in
1388+ let old = L.requestHeaders x
1050− case getRequestContentType body of
1389+ in case getRequestContentType body of
1051− Nothing -> old
1390+ Nothing -> old
1052− Just contentType ->
1391+ Just contentType ->
1053− (Y.hContentType, contentType) : old }
1392+ (Y.hContentType, contentType) : old
1055----------------------------------------------------------------------------
1395----------------------------------------------------------------------------
1056-- Request—Optional parameters
1396-- Request—Optional parameters
1058-- $optional-parameters
1398-- $optional-parameters
1060−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
1061-- headers, port number, etc. All optional parameters have the type
1401-- headers, port number, etc. All optional parameters have the type
1062-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
1402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
1063-- the last argument of 'req' to specify no optional parameters, or combine
1403-- the last argument of 'req' to specify no optional parameters, or combine
1064−-- 'Option's using 'mappend' (or @('<>')@) to have several of them at once.
1404+-- 'Option's using 'mappend' or @('<>')@ to have several of them at once.
1066−-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
1406+-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
1067−-- optional parameters like query parameters and headers. See sections below
1407+-- of optional parameters like query parameters and headers. See sections
1068−-- to learn which 'Option' primitives are available.
1408+-- below to learn which 'Option' primitives are available.
1409+data Option (scheme :: Scheme)
1410+ = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1070−data Option (scheme :: Scheme) =
1071− Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1072− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1412+-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1073− -- Request to avoid appending to existing query string in request every
1413+-- Request to avoid appending to an existing query string in request every
1074− -- time new parameter is added. Additional Maybe (L.Request -> IO
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
1075− -- L.Request) is a finalizer that will be applied after all other
1415+-- L.Request) is a finalizer that will be applied after all other
1076− -- transformations. This is for authentication methods that sign requests
1416+-- transformations. This is for authentication methods that sign requests
1077− -- based on data in Request.
1417+-- based on data in Request.
1079instance Semigroup (Option scheme) where
1419instance Semigroup (Option scheme) where
1080− Option er0 mr0 <> Option er1 mr1 = Option
1420+ Option er0 mr0 <> Option er1 mr1 =
1081− (er0 <> er1) (mr0 <|> mr1)
1422+ (er0 <> er1)
1083instance Monoid (Option scheme) where
1425instance Monoid (Option scheme) where
1084− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
1085 mappend = (<>)
1427 mappend = (<>)
1429+-- | Use 'formToQuery'.
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1087-- | A helper to create an 'Option' that modifies only collection of query
1435-- | A helper to create an 'Option' that modifies only collection of query
1088-- parameters. This helper is not a part of the public API.
1436-- parameters. This helper is not a part of the public API.
1090withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1091withQueryParams f = Option (Endo (first f)) Nothing
1438withQueryParams f = Option (Endo (first f)) Nothing
1093-- | A helper to create an 'Option' that modifies only 'L.Request'. This
1440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
1094-- helper is not a part of public API.
1441-- helper is not a part of public API.
1096withRequest :: (L.Request -> L.Request) -> Option scheme
1442withRequest :: (L.Request -> L.Request) -> Option scheme
1097withRequest f = Option (Endo (second f)) Nothing
1443withRequest f = Option (Endo (second f)) Nothing
1099−-- | A helper to create an 'Option' that adds a finalizer (request
1100−-- transformation that is applied after all other modifications).
1102−asFinalizer :: (L.Request -> IO L.Request) -> Option scheme
1103−asFinalizer = Option mempty . pure
1105instance RequestComponent (Option scheme) where
1445instance RequestComponent (Option scheme) where
1106 getRequestMod (Option f _) = Endo $ \x ->
1446 getRequestMod (Option f _) = Endo $ \x ->
1107 let (qparams, x') = appEndo f ([], x)
1447 let (qparams, x') = appEndo f ([], x)
1108− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1109− in x' { L.queryString = query }
1449+ in x' {L.queryString = query}
1111-- | Finalize given 'L.Request' by applying a finalizer from the given
1451-- | Finalize given 'L.Request' by applying a finalizer from the given
1112-- 'Option' (if it has any).
1452-- 'Option' (if it has any).
1114−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1115finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1117----------------------------------------------------------------------------
1456----------------------------------------------------------------------------
@@ -1124,47 +1463,67 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1124-- bodies (of the type 'FormUrlEncodedParam').
1463-- bodies (of the type 'FormUrlEncodedParam').
1126-- | This operator builds a query parameter that will be included in URL of
1465-- | This operator builds a query parameter that will be included in URL of
1127−-- your request after question sign @?@. This is the same syntax you use
1466+-- your request after the question sign @?@. This is the same syntax you use
1128-- with form URL encoded request bodies.
1467-- with form URL encoded request bodies.
1130-- This operator is defined in terms of 'queryParam':
1469-- This operator is defined in terms of 'queryParam':
1132-- > name =: value = queryParam name (pure value)
1471-- > name =: value = queryParam name (pure value)
1134infix 7 =:
1472infix 7 =:
1135(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
1474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
1136name =: value = queryParam name (pure value)
1475name =: value = queryParam name (pure value)
1138−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
1139−-- the following URL @a@ is a flag, while @b@ is a query parameter with a
1478+-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
1140−-- value:
1479+-- with a value:
1142-- > https://httpbin.org/foo/bar?a&b=10
1481-- > https://httpbin.org/foo/bar?a&b=10
1144-- This operator is defined in terms of 'queryParam':
1483-- This operator is defined in terms of 'queryParam':
1146-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1148−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
1149queryFlag name = queryParam name (Nothing :: Maybe ())
1487queryFlag name = queryParam name (Nothing :: Maybe ())
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1492+-- Note that 'Form.Form' doesn't have the concept of parameters with the
1493+-- empty value (i.e. what you can get by @key =: ""@). If the value is
1494+-- empty, it will be encoded as a valueless parameter (i.e. what you can get
1495+-- by @queryFlag key@).
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1501+ toParam (key, val) =
1151-- | A type class for query-parameter-like things. The reason to have an
1507-- | A type class for query-parameter-like things. The reason to have an
1152-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1153-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1154-- Having the same syntax for these cases seems natural and user-friendly.
1510-- Having the same syntax for these cases seems natural and user-friendly.
1156class QueryParam param where
1511class QueryParam param where
1158 -- | Create a query parameter with given name and value. If value is
1512 -- | Create a query parameter with given name and value. If value is
1159 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1160 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1161 -- method, because they are easier to read.
1515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1163− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
1165instance QueryParam (Option scheme) where
1523instance QueryParam (Option scheme) where
1166 queryParam name mvalue =
1524 queryParam name mvalue =
1167 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
1169----------------------------------------------------------------------------
1528----------------------------------------------------------------------------
1170-- Request—Optional parameters—Headers
1529-- Request—Optional parameters—Headers
@@ -1173,19 +1532,28 @@ instance QueryParam (Option scheme) where
1173-- headers with the same names the leftmost header will win. This means, in
1532-- headers with the same names the leftmost header will win. This means, in
1174-- particular, that you cannot create a request with several headers of the
1533-- particular, that you cannot create a request with several headers of the
1175-- same name.
1534-- same name.
1177−header
1535+header ::
1178− :: ByteString -- ^ Header name
1536+ -- | Header name
1179− -> ByteString -- ^ Header value
1538+ -- | Header value
1180− -> Option scheme
1540+ Option scheme
1181header name value = withRequest (attachHeader name value)
1541header name value = withRequest (attachHeader name value)
1183−-- | A non-public helper that attaches a header with given name and content
1543+-- | Attach a header with given name and content to a 'L.Request'.
1184−-- to a 'L.Request'.
1544+--
1185−
1545+-- @since 1.1.0
1186attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1187attachHeader name value x =
1547attachHeader name value x =
1188− x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
1548+ x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1550+-- | Same as 'header', but with redacted values on print.
1553+headerRedacted :: ByteString -> ByteString -> Option scheme
1554+headerRedacted name value = withRequest $ \x ->
1555+ let y = attachHeader name value x
1556+ in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
1190----------------------------------------------------------------------------
1558----------------------------------------------------------------------------
1191-- Request—Optional parameters—Cookies
1559-- Request—Optional parameters—Cookies
@@ -1198,10 +1566,9 @@ attachHeader name value x =
1199-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
1567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
1200-- 'L.Response' record.
1568-- 'L.Response' record.
1202cookieJar :: L.CookieJar -> Option scheme
1569cookieJar :: L.CookieJar -> Option scheme
1203cookieJar jar = withRequest $ \x ->
1570cookieJar jar = withRequest $ \x ->
1204− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
1206----------------------------------------------------------------------------
1573----------------------------------------------------------------------------
1207-- Request—Optional parameters—Authentication
1574-- Request—Optional parameters—Authentication
@@ -1219,42 +1586,66 @@ cookieJar jar = withRequest $ \x ->
1219-- | The 'Option' adds basic authentication.
1586-- | The 'Option' adds basic authentication.
1221-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1223−basicAuth
1589+basicAuth ::
1224− :: ByteString -- ^ Username
1590+ -- | Username
1225− -> ByteString -- ^ Password
1591+ ByteString ->
1226− -> Option 'Https -- ^ Auth 'Option'
1594+ -- | Auth 'Option'
1227basicAuth = basicAuthUnsafe
1596basicAuth = basicAuthUnsafe
1229-- | An alternative to 'basicAuth' which works for any scheme. Note that
1598-- | An alternative to 'basicAuth' which works for any scheme. Note that
1230−-- using basic access authentication without SSL/TLS is vulnerable to
1599+-- using basic access authentication without SSL\/TLS is vulnerable to
1231-- attacks. Use 'basicAuth' instead unless you know what you are doing.
1600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
1233-- @since 0.3.1
1602-- @since 0.3.1
1235−basicAuthUnsafe
1603+basicAuthUnsafe ::
1236− :: ByteString -- ^ Username
1604+ -- | Username
1237− -> ByteString -- ^ Password
1606+ -- | Password
1238− -> Option scheme -- ^ Auth 'Option'
1608+ -- | Auth 'Option'
1239−basicAuthUnsafe username password = asFinalizer
1610+basicAuthUnsafe username password =
1240− (pure . L.applyBasicAuth username password)
1612+ (pure . L.applyBasicAuth username password)
1614+-- | The 'Option' set basic proxy authentication header.
1624+basicProxyAuth username password =
1625+ withRequest (L.applyBasicProxyAuth username password)
1242-- | The 'Option' adds OAuth1 authentication.
1627-- | The 'Option' adds OAuth1 authentication.
1244-- @since 0.2.0
1629-- @since 0.2.0
1246−oAuth1
1630+oAuth1 ::
1247− :: ByteString -- ^ Consumer token
1631+ -- | Consumer token
1248− -> ByteString -- ^ Consumer secret
1633+ -- | Consumer secret
1249− -> ByteString -- ^ OAuth token
1634+ ByteString ->
1250− -> ByteString -- ^ OAuth token secret
1637+ -- | OAuth token secret
1251− -> Option scheme -- ^ Auth 'Option'
1639+ -- | Auth 'Option'
1252oAuth1 consumerToken consumerSecret token tokenSecret =
1641oAuth1 consumerToken consumerSecret token tokenSecret =
1253− asFinalizer (OAuth.signOAuth app creds)
1642+ customAuth (OAuth.signOAuth app creds)
1255− app = OAuth.newOAuth
1645+ OAuth.newOAuth
1256− { OAuth.oauthConsumerKey = consumerToken
1646+ { OAuth.oauthConsumerKey = consumerToken,
1257− , OAuth.oauthConsumerSecret = consumerSecret }
1647+ OAuth.oauthConsumerSecret = consumerSecret
1258 creds = OAuth.newCredential token tokenSecret
1649 creds = OAuth.newCredential token tokenSecret
1260-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
1651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1265,12 +1656,14 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
1265-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1267-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1269−oAuth2Bearer
1659+oAuth2Bearer ::
1270− :: ByteString -- ^ Token
1660+ -- | Token
1271− -> Option 'Https -- ^ Auth 'Option'
1662+ -- | Auth 'Option'
1272−oAuth2Bearer token = asFinalizer
1664+oAuth2Bearer token =
1273− (pure . attachHeader "Authorization" ("Bearer " <> token))
1666+ (pure . attachHeader "Authorization" ("Bearer " <> token))
1275-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
1668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
1276-- to be used only by GitHub). This will be treated by whatever services
1669-- to be used only by GitHub). This will be treated by whatever services
@@ -1281,26 +1674,35 @@ oAuth2Bearer token = asFinalizer
1281-- > oAuth2Token token = header "Authorization" ("token" <> token)
1674-- > oAuth2Token token = header "Authorization" ("token" <> token)
1283-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1285−oAuth2Token
1677+oAuth2Token ::
1286− :: ByteString -- ^ Token
1678+ -- | Token
1287− -> Option 'Https -- ^ Auth 'Option'
1680+ -- | Auth 'Option'
1288−oAuth2Token token = asFinalizer
1682+oAuth2Token token =
1289− (pure . attachHeader "Authorization" ("token " <> token))
1684+ (pure . attachHeader "Authorization" ("token " <> token))
1686+-- | A helper to create custom authentication 'Option's. The given
1687+-- 'IO'-enabled request transformation is applied after all other
1688+-- modifications when constructing a request. Use wisely.
1691+customAuth :: (L.Request -> IO L.Request) -> Option scheme
1692+customAuth = Option mempty . pure
1291----------------------------------------------------------------------------
1694----------------------------------------------------------------------------
1292-- Request—Optional parameters—Other
1695-- Request—Optional parameters—Other
1294-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1295-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1296−-- 'Option' allows to choose arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1298port :: Int -> Option scheme
1700port :: Int -> Option scheme
1299port n = withRequest $ \x ->
1701port n = withRequest $ \x ->
1300− x { L.port = n }
1702+ x {L.port = n}
1302-- | This 'Option' controls whether gzipped data should be decompressed on
1704-- | This 'Option' controls whether gzipped data should be decompressed on
1303−-- the fly. By default everything except for @application\/x-tar@ is
1705+-- the fly. By default everything except for @\"application\/x-tar\"@ is
1304-- decompressed, i.e. we have:
1706-- decompressed, i.e. we have:
1306-- > decompress (/= "application/x-tar")
1708-- > decompress (/= "application/x-tar")
@@ -1308,163 +1710,212 @@ port n = withRequest $ \x ->
1308-- You can also choose to decompress everything like this:
1710-- You can also choose to decompress everything like this:
1310-- > decompress (const True)
1712-- > decompress (const True)
1312−decompress
1713+decompress ::
1313− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1314− -- returns 'True' when content should be decompressed on the fly.
1715+ -- should be decompressed on the fly.
1716+ (ByteString -> Bool) ->
1315− -> Option scheme
1717+ Option scheme
1316decompress f = withRequest $ \x ->
1718decompress f = withRequest $ \x ->
1317− x { L.decompress = f }
1719+ x {L.decompress = f}
1319-- | Specify the number of microseconds to wait for response. The default
1721-- | Specify the number of microseconds to wait for response. The default
1320−-- value is 30 seconds.
1722+-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
1321−
1723+-- 'L.Manager').
1322−responseTimeout
1724+responseTimeout ::
1323− :: Int -- ^ Number of microseconds to wait
1725+ -- | Number of microseconds to wait
1324− -> Option scheme
1727+ Option scheme
1325responseTimeout n = withRequest $ \x ->
1728responseTimeout n = withRequest $ \x ->
1326− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1328-- | HTTP version to send to the server, the default is HTTP 1.1.
1731-- | HTTP version to send to the server, the default is HTTP 1.1.
1330−httpVersion
1732+httpVersion ::
1331− :: Int -- ^ Major version number
1733+ -- | Major version number
1332− -> Int -- ^ Minor version number
1735+ -- | Minor version number
1333− -> Option scheme
1737+ Option scheme
1334httpVersion major minor = withRequest $ \x ->
1738httpVersion major minor = withRequest $ \x ->
1335− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
1337----------------------------------------------------------------------------
1741----------------------------------------------------------------------------
1338-- Response interpretations
1742-- Response interpretations
1340−-- | Make a request and ignore body of response.
1744+-- | Make a request and ignore the body of the response.
1342−data IgnoreResponse = IgnoreResponse (L.Response ())
1745+newtype IgnoreResponse = IgnoreResponse (L.Response ())
1344instance HttpResponse IgnoreResponse where
1748instance HttpResponse IgnoreResponse where
1345 type HttpResponseBody IgnoreResponse = ()
1749 type HttpResponseBody IgnoreResponse = ()
1346− toVanillaResponse (IgnoreResponse response) = response
1750+ toVanillaResponse (IgnoreResponse r) = r
1347− getHttpResponse request manager =
1751+ getHttpResponse r = return $ IgnoreResponse (void r)
1348− IgnoreResponse <$> liftIO (L.httpNoBody request manager)
1349− makeResponseBodyPreview _ = "<ignored response>"
1351-- | Use this as the fourth argument of 'req' to specify that you want it to
1753-- | Use this as the fourth argument of 'req' to specify that you want it to
1352−-- return the 'IgnoreResponse' interpretation.
1754+-- ignore the response body.
1354ignoreResponse :: Proxy IgnoreResponse
1755ignoreResponse :: Proxy IgnoreResponse
1355ignoreResponse = Proxy
1756ignoreResponse = Proxy
1357−-- | Make a request and interpret body of response as JSON. The
1758+-- | Make a request and interpret the body of the response as JSON. The
1358-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1359-- monad in which you use 'req' will determine what to do in the case when
1760-- monad in which you use 'req' will determine what to do in the case when
1360-- parsing fails (the 'JsonHttpException' constructor will be used).
1761-- parsing fails (the 'JsonHttpException' constructor will be used).
1762+newtype JsonResponse a = JsonResponse (L.Response a)
1362−data JsonResponse a = JsonResponse (L.Response a) ByteString
1364−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
1365 type HttpResponseBody (JsonResponse a) = a
1766 type HttpResponseBody (JsonResponse a) = a
1366− toVanillaResponse (JsonResponse response _) = response
1767+ toVanillaResponse (JsonResponse r) = r
1367− getHttpResponse request manager = do
1768+ getHttpResponse r = do
1368− response <- L.httpLbs request manager
1769+ chunks <- L.brConsume (L.responseBody r)
1369− case A.eitherDecode (L.responseBody response) of
1770+ case A.eitherDecode (BL.fromChunks chunks) of
1370 Left e -> throwIO (JsonHttpException e)
1771 Left e -> throwIO (JsonHttpException e)
1374− . BL.take bodyPreviewLength
1377− return $ JsonResponse response { L.responseBody = x } preview
1772+ Right x -> return $ JsonResponse (x <$ r)
1378− makeResponseBodyPreview (JsonResponse _ preview) = preview
1773+ acceptHeader Proxy = Just "application/json"
1380−-- | Use this as the forth argument of 'req' to specify that you want it to
1381−-- return the 'JsonResponse' interpretation.
1775+-- | Use this as the fourth argument of 'req' to specify that you want it to
1776+-- return the 'JsonResponse' interpretation.
1383jsonResponse :: Proxy (JsonResponse a)
1777jsonResponse :: Proxy (JsonResponse a)
1384jsonResponse = Proxy
1778jsonResponse = Proxy
1386−-- | Make a request and interpret body of response as a strict 'ByteString'.
1780+-- | Make a request and interpret the body of the response as a strict
1387−
1781+-- 'ByteString'.
1388newtype BsResponse = BsResponse (L.Response ByteString)
1782newtype BsResponse = BsResponse (L.Response ByteString)
1390instance HttpResponse BsResponse where
1785instance HttpResponse BsResponse where
1391 type HttpResponseBody BsResponse = ByteString
1786 type HttpResponseBody BsResponse = ByteString
1392− toVanillaResponse (BsResponse response) = response
1787+ toVanillaResponse (BsResponse r) = r
1393− getHttpResponse request manager =
1788+ getHttpResponse r = do
1394− L.withResponse request manager $ \response -> do
1395− chunks <- L.brConsume (L.responseBody response)
1789+ chunks <- L.brConsume (L.responseBody r)
1396− return $ BsResponse response { L.responseBody = B.concat chunks }
1790+ return $ BsResponse (B.concat chunks <$ r)
1397− makeResponseBodyPreview = B.take bodyPreviewLength . responseBody
1399−-- | Use this as the forth argument of 'req' to specify that you want to
1400−-- interpret response body as a strict 'ByteString'.
1792+-- | Use this as the fourth argument of 'req' to specify that you want to
1793+-- interpret the response body as a strict 'ByteString'.
1402bsResponse :: Proxy BsResponse
1794bsResponse :: Proxy BsResponse
1403bsResponse = Proxy
1795bsResponse = Proxy
1405−-- | Make a request and interpret body of response as a lazy
1797+-- | Make a request and interpret the body of the response as a lazy
1406-- 'BL.ByteString'.
1798-- 'BL.ByteString'.
1408newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1410instance HttpResponse LbsResponse where
1802instance HttpResponse LbsResponse where
1411 type HttpResponseBody LbsResponse = BL.ByteString
1803 type HttpResponseBody LbsResponse = BL.ByteString
1412− toVanillaResponse (LbsResponse response) = response
1804+ toVanillaResponse (LbsResponse r) = r
1413− getHttpResponse request manager =
1805+ getHttpResponse r = do
1414− LbsResponse <$> L.httpLbs request manager
1806+ chunks <- L.brConsume (L.responseBody r)
1415− makeResponseBodyPreview = BL.toStrict . BL.take 1027 . responseBody
1807+ return $ LbsResponse (BL.fromChunks chunks <$ r)
1417−-- | Use this as the forth argument of 'req' to specify that you want to
1418−-- interpret response body as a lazy 'BL.ByteString'.
1809+-- | Use this as the fourth argument of 'req' to specify that you want to
1810+-- interpret the response body as a lazy 'BL.ByteString'.
1420lbsResponse :: Proxy LbsResponse
1811lbsResponse :: Proxy LbsResponse
1421lbsResponse = Proxy
1812lbsResponse = Proxy
1814+----------------------------------------------------------------------------
1815+-- Helpers for response interpretations
1817+-- | Fetch beginning of the response and return it together with a new
1818+-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
1821+ -- | How many bytes to fetch
1823+ -- | Response with body reader inside
1824+ L.Response L.BodyReader ->
1825+ -- | Preview 'ByteString' and new response with body reader inside
1826+ IO (ByteString, L.Response L.BodyReader)
1827+grabPreview nbytes r = do
1828+ let br = L.responseBody r
1829+ (target, leftover, done) <- brReadN br nbytes
1830+ nref <- newIORef (0 :: Int)
1832+ n <- readIORef nref
1833+ let incn = modifyIORef' nref (+ 1)
1844+ else return leftover
1847+ then return B.empty
1849+ return (target, r {L.responseBody = br'})
1851+-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
1852+-- leftover (may be empty), and whether we're done consuming the body.
1854+ -- | Body reader to stream from
1856+ -- | How many bytes to consume
1858+ -- | Target chunk, the leftover, whether we're done
1859+ IO (ByteString, ByteString, Bool)
1860+brReadN br n = go 0 id id
1865+ then return (r t, r l, True)
1867+ let (target, leftover) = B.splitAt (n - tlen) chunk
1868+ tlen' = B.length target
1869+ t' = t . (target :)
1870+ l' = l . (leftover :)
1871+ if tlen + tlen' < n
1872+ then go (tlen + tlen') t' l'
1873+ else return (r t', r l', False)
1874+ r f = B.concat (f [])
1423----------------------------------------------------------------------------
1876----------------------------------------------------------------------------
1424-- Inspecting a response
1877-- Inspecting a response
1426-- | Get the response body.
1879-- | Get the response body.
1428−responseBody
1880+responseBody ::
1429− :: HttpResponse response
1881+ (HttpResponse response) =>
1430− => response
1882+ response ->
1431− -> HttpResponseBody response
1883+ HttpResponseBody response
1432responseBody = L.responseBody . toVanillaResponse
1884responseBody = L.responseBody . toVanillaResponse
1434-- | Get the response status code.
1886-- | Get the response status code.
1436−responseStatusCode
1887+responseStatusCode ::
1437− :: HttpResponse response
1888+ (HttpResponse response) =>
1438− => response
1889+ response ->
1440responseStatusCode =
1891responseStatusCode =
1441 Y.statusCode . L.responseStatus . toVanillaResponse
1892 Y.statusCode . L.responseStatus . toVanillaResponse
1443-- | Get the response status message.
1894-- | Get the response status message.
1445−responseStatusMessage
1895+responseStatusMessage ::
1446− :: HttpResponse response
1896+ (HttpResponse response) =>
1447− => response
1897+ response ->
1448− -> ByteString
1898+ ByteString
1449responseStatusMessage =
1899responseStatusMessage =
1450 Y.statusMessage . L.responseStatus . toVanillaResponse
1900 Y.statusMessage . L.responseStatus . toVanillaResponse
1452-- | Lookup a particular header from a response.
1902-- | Lookup a particular header from a response.
1454−responseHeader
1903+responseHeader ::
1455− :: HttpResponse response
1904+ (HttpResponse response) =>
1456− => response -- ^ Response interpretation
1905+ -- | Response interpretation
1457− -> ByteString -- ^ Header to lookup
1907+ -- | Header to lookup
1458− -> Maybe ByteString -- ^ Header value if found
1909+ -- | Header value if found
1459responseHeader r h =
1911responseHeader r h =
1460 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1462-- | Get the response 'L.CookieJar'.
1914-- | Get the response 'L.CookieJar'.
1464−responseCookieJar
1915+responseCookieJar ::
1465− :: HttpResponse response
1916+ (HttpResponse response) =>
1466− => response
1917+ response ->
1467− -> L.CookieJar
1918+ L.CookieJar
1468responseCookieJar = L.responseCookieJar . toVanillaResponse
1919responseCookieJar = L.responseCookieJar . toVanillaResponse
1470----------------------------------------------------------------------------
1921----------------------------------------------------------------------------
@@ -1473,37 +1924,58 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
1473-- $new-response-interpretation
1924-- $new-response-interpretation
1475-- To create a new response interpretation you just need to make your data
1926-- To create a new response interpretation you just need to make your data
1476−-- type an instance of 'HttpResponse' type class.
1927+-- type an instance of the 'HttpResponse' type class.
1478−-- | A type class for response interpretations. It allows to fully control
1479−-- how request is made and how its body is parsed.
1929+-- | A type class for response interpretations. It allows us to describe how
1930+-- to consume the response from a @'L.Response' 'L.BodyReader'@ and produce
1931+-- the final result that is to be returned to the user.
1481class HttpResponse response where
1932class HttpResponse response where
1483 -- | The associated type is the type of body that can be extracted from an
1933 -- | The associated type is the type of body that can be extracted from an
1484 -- instance of 'HttpResponse'.
1934 -- instance of 'HttpResponse'.
1486− type HttpResponseBody response :: *
1935+ type HttpResponseBody response :: Type
1488 -- | The method describes how to get the underlying 'L.Response' record.
1937 -- | The method describes how to get the underlying 'L.Response' record.
1490 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1492− -- | This method describes how to make an HTTP request given 'L.Request'
1940+ -- | This method describes how to consume response body and, more
1493− -- (prepared by the library) and 'L.Manager'.
1941+ -- generally, obtain @response@ value from @'L.Response' 'L.BodyReader'@.
1943+ -- __Note__: 'L.BodyReader' is nothing but @'IO' 'ByteString'@. You should
1944+ -- call this action repeatedly until it yields the empty 'ByteString'. In
1945+ -- that case streaming of response is finished (which apparently leads to
1946+ -- closing of the connection, so don't call the reader after it has
1947+ -- returned the empty 'ByteString' once) and you can concatenate the
1948+ -- chunks to obtain the final result. (Of course you could as well stream
1949+ -- the contents to a file or do whatever you want.)
1951+ -- __Note__: signature of this function was changed in the version
1495− getHttpResponse :: L.Request -> L.Manager -> IO response
1953+ getHttpResponse ::
1496−
1954+ -- | Response with body reader inside
1497− -- | Construct a “preview” of response body. It is recommend to limit the
1955+ L.Response L.BodyReader ->
1498− -- length to 1024 bytes. This is mainly useful for inclusion of response
1956+ -- | The final result
1499− -- body fragments in exceptions.
1957+ IO response
1959+ -- | The value of @\"Accept\"@ header. This is useful, for example, if a
1960+ -- website supports both @XML@ and @JSON@ responses, and decides what to
1961+ -- reply with based on what @Accept@ headers you have sent.
1501− -- __Note__: in versions 0.3.0–0.4.0 this function returned @'IO'
1963+ -- __Note__: manually specified 'Options' that set the @\"Accept\"@ header
1502− -- 'ByteString'@.
1964+ -- will take precedence.
1504− -- @since 0.5.0
1966+ -- @since 2.1.0
1967+ acceptHeader :: Proxy response -> Maybe ByteString
1968+ acceptHeader Proxy = Nothing
1506− makeResponseBodyPreview :: response -> ByteString
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
1508----------------------------------------------------------------------------
1980----------------------------------------------------------------------------
@@ -1513,15 +1985,14 @@ class HttpResponse response where
1513-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1985-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1514-- monoid of endomorphisms under composition, it's used to chain different
1986-- monoid of endomorphisms under composition, it's used to chain different
1515-- request components easier using @('<>')@.
1987-- request components easier using @('<>')@.
1989+-- __Note__: this type class is not a part of the public API.
1517class RequestComponent a where
1990class RequestComponent a where
1519 -- | Get a function that takes a 'L.Request' and changes it somehow
1991 -- | Get a function that takes a 'L.Request' and changes it somehow
1520− -- returning another 'L.Request'. For example HTTP method instance of
1992+ -- returning another 'L.Request'. For example, the 'HttpMethod' instance
1521− -- 'RequestComponent' just overwrites method. The function is wrapped in
1993+ -- of 'RequestComponent' just overwrites method. The function is wrapped
1522− -- 'Endo' so it's easier to chain such “modifying applications” together
1994+ -- in 'Endo' so it's easier to chain such “modifying applications”
1523− -- building bigger and bigger 'RequestComponent's.
1995+ -- together building bigger and bigger 'RequestComponent's.
1525 getRequestMod :: a -> Endo L.Request
1996 getRequestMod :: a -> Endo L.Request
1527-- | This wrapper is only used to attach a type-level tag to a given type.
1998-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -1531,42 +2002,50 @@ class RequestComponent a where
1531-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
2002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
1532-- which instance to use (i.e. the constraints are taken into account later,
2003-- which instance to use (i.e. the constraints are taken into account later,
1533-- when instance is already chosen).
2004-- when instance is already chosen).
1535−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
1537-- | Exceptions that this library throws.
2007-- | Exceptions that this library throws.
1539data HttpException
2008data HttpException
1540− = VanillaHttpException L.HttpException
1541− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2009+ = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1542− | JsonHttpException String
2010+ VanillaHttpException L.HttpException
1543− -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
2011+ | -- | A wrapper with Aeson-produced 'String' describing why decoding
2013+ JsonHttpException String
1544− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
1546instance Exception HttpException
2016instance Exception HttpException
1548−-- | A simple 'Bool'-like type we only have for better error messages. We
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
1549−-- use it as a kind and its data constructors as type-level tags.
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
1551−-- See also: 'HttpMethod' and 'HttpBody'.
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2027+ (L.StatusCodeException r _)
2030+isStatusCodeException _ = Nothing
2032+-- | A simple type isomorphic to 'Bool' that we only have for better error
2033+-- messages. We use it as a kind and its data constructors as type-level
2036+-- See also: 'HttpMethod' and 'HttpBody'.
1553data CanHaveBody
2037data CanHaveBody
1554− = CanHaveBody -- ^ Indeed can have a body
2038+ = -- | Indeed can have a body
1555− | NoBody -- ^ Should not have a body
2040+ | -- | Should not have a body
1557-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
2043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
1558-- enabled). This is used to force TLS requirement for some authentication
2044-- enabled). This is used to force TLS requirement for some authentication
1559-- 'Option's.
2045-- 'Option's.
1561data Scheme
2046data Scheme
1562− = Http -- ^ HTTP
2048+ Http
1563− | Https -- ^ HTTPS
2050+ Https
1564− deriving (Eq, Ord, Show, Data, Typeable, Generic)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1566−----------------------------------------------------------------------------
1569−-- | Max length of preview fragment of response body.
1571−bodyPreviewLength :: Num a => a
1572−bodyPreviewLength = 1024