@@ -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 #-}
10+
111-- |
212-- Module : Network.HTTP.Req
3−-- Copyright : © 2016–2018 Mark Karpov
13+-- Copyright : © 2016–present Mark Karpov
414-- License : BSD 3 clause
515--
616-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
@@ -9,61 +19,40 @@
919--
1020-- The documentation below is structured in such a way that the most
1121-- 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
1323-- details about less-common things you may want to know about. The
1424-- documentation is written with sufficient coverage of details and
1525-- examples, and it's designed to be a complete tutorial on its own.
1626--
17−-- /(A modest intro goes here, click on 'req' to start making requests.)/
18−--
1927-- === About the library
2028--
21−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
22−-- library that just works without any fooling around.
23−--
24−-- What does the phrase “easy-to-use” mean? It means that the library is
25−-- designed to be beginner-friendly so it's simple to add to your monad
26−-- stack, intuitive to work with, well-documented, and does not get in your
27−-- way. Doing HTTP requests is a common task and Haskell library for this
28−-- should be very approachable and clear to beginners, thus certain
29−-- compromises were made. For example, one cannot currently modify
30−-- 'L.ManagerSettings' of the default manager because the library always
31−-- uses the same implicit global manager for simplicity and maximal
32−-- connection sharing. There is a way to use your own manager with different
33−-- settings, but it requires a bit more typing.
34−--
35−-- “Type-safe” means that the library is protective and eliminates certain
36−-- classes of errors. For example, we have correct-by-construction 'Url's,
37−-- it's guaranteed that the user does not send the request body when using
38−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
39−-- is minimized by making the user specify his\/her intentions in an
40−-- explicit form (for example, it's not possible to avoid specifying the
41−-- body or method of request). Authentication methods that assume HTTPS
42−-- force the user to use HTTPS at the type level. The library also carefully
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
46−-- run-time).
47−--
48−-- “Expandable” refers to the ability of the library to be expanded without
49−-- having to resort to ugly hacking. For example, it's possible to define
50−-- your own HTTP methods, create new ways to construct the body of a
51−-- request, create new authorization options, perform a request in a
52−-- different way, and create your own methods to parse and represent a
53−-- response. As the 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.
56−--
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 down boilerplate
65−-- considerably, and helps you write concise, easy to read, and maintainable
66−-- code.
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30+-- and expandable.
31+--
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
33+-- so it's simple to add to your monad stack, intuitive to work with,
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
35+-- common task and a Haskell library for this should be approachable and
36+-- clear to beginners, thus certain compromises were made. For example, one
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
39+-- simplicity and maximal connection sharing. There is a way to use your own
40+-- manager with different settings, but it requires more typing.
41+--
42+-- “Type-safe” means that the library tries to eliminate certain classes of
43+-- errors. For example, we have correct-by-construction URLs; it is
44+-- guaranteed that the user does not send the request body when using
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46+-- minimized by making the user specify their intentions in an explicit
47+-- form. For example, it's not possible to avoid specifying the body or the
48+-- method of a request. Authentication methods that assume HTTPS force the
49+-- user to use HTTPS at the type level.
50+--
51+-- “Expandable” refers to the ability to create new components without
52+-- having to resort to hacking. For example, it's possible to define your
53+-- own HTTP methods, create new ways to construct the body of a request,
54+-- create new authorization options, perform a request in a different way,
55+-- and create your own methods to parse a response.
6756--
6857-- === Using with other libraries
6958--
@@ -87,181 +76,200 @@
8776-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
8877-- machinery for performing requests is the same as with @http-conduit@ and
8978-- @wreq@. The only difference is the API.
90−
91−{-# LANGUAGE BangPatterns #-}
92−{-# LANGUAGE CPP #-}
93−{-# LANGUAGE DataKinds #-}
94−{-# LANGUAGE DeriveDataTypeable #-}
95−{-# LANGUAGE DeriveGeneric #-}
96−{-# LANGUAGE FlexibleInstances #-}
97−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
98−{-# LANGUAGE KindSignatures #-}
99−{-# LANGUAGE MultiParamTypeClasses #-}
100−{-# LANGUAGE OverloadedStrings #-}
101−{-# LANGUAGE RankNTypes #-}
102−{-# LANGUAGE RecordWildCards #-}
103−{-# LANGUAGE ScopedTypeVariables #-}
104−{-# LANGUAGE TypeFamilies #-}
105−
106−#if MIN_VERSION_base(4,9,0)
107−{-# LANGUAGE UndecidableInstances #-}
108−#endif
109−
110−#if __GLASGOW_HASKELL__ >= 800
111−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
112−#endif
113−
11479module Network.HTTP.Req
11580 ( -- * Making a request
11681 -- $making-a-request
117− req
118− , reqBr
119− , req'
120− , withReqManager
82+ req,
83+ reqBr,
84+ reqCb,
85+ req',
86+ withReqManager,
87+
12188 -- * Embedding requests in your monad
12289 -- $embedding-requests
123− , MonadHttp (..)
124− , HttpConfig (..)
125− , Req
126− , runReq
90+ MonadHttp (..),
91+ HttpConfig (..),
92+ defaultHttpConfig,
93+ Req,
94+ runReq,
95+
12796 -- * Request
97+
12898 -- ** Method
12999 -- $method
130− , GET (..)
131− , POST (..)
132− , HEAD (..)
133− , PUT (..)
134− , DELETE (..)
135− , TRACE (..)
136− , CONNECT (..)
137− , OPTIONS (..)
138− , PATCH (..)
139− , HttpMethod (..)
100+ GET (..),
101+ POST (..),
102+ HEAD (..),
103+ PUT (..),
104+ DELETE (..),
105+ TRACE (..),
106+ CONNECT (..),
107+ OPTIONS (..),
108+ PATCH (..),
109+ HttpMethod (..),
110+
140111 -- ** URL
141112 -- $url
142− , Url
143− , http
144− , https
145− , (/~)
146− , (/:)
147− , parseUrlHttp
148− , parseUrlHttps
149− , parseUrl
113+ Url,
114+ http,
115+ https,
116+ (/~),
117+ (/:),
118+ useHttpURI,
119+ useHttpsURI,
120+ useURI,
121+ urlQ,
122+ renderUrl,
123+
150124 -- ** Body
151125 -- $body
152− , NoReqBody (..)
153− , ReqBodyJson (..)
154− , ReqBodyFile (..)
155− , ReqBodyBs (..)
156− , ReqBodyLbs (..)
157− , ReqBodyUrlEnc (..)
158− , FormUrlEncodedParam
159− , ReqBodyMultipart
160− , reqBodyMultipart
161− , HttpBody (..)
162− , ProvidesBody
163− , HttpBodyAllowed
126+ NoReqBody (..),
127+ ReqBodyJson (..),
128+ ReqBodyFile (..),
129+ ReqBodyBs (..),
130+ ReqBodyLbs (..),
131+ ReqBodyUrlEnc (..),
132+ FormUrlEncodedParam,
133+ ReqBodyMultipart,
134+ reqBodyMultipart,
135+ HttpBody (..),
136+ ProvidesBody,
137+ HttpBodyAllowed,
138+
164139 -- ** Optional parameters
165140 -- $optional-parameters
166− , Option
141+ Option,
142+
167143 -- *** Query parameters
168144 -- $query-parameters
169− , (=:)
170− , queryFlag
171− , QueryParam (..)
145+ (=:),
146+ queryFlag,
147+ formToQuery,
148+ QueryParam (..),
149+
172150 -- *** Headers
173− , header
174− , attachHeader
151+ header,
152+ attachHeader,
153+ headerRedacted,
154+
175155 -- *** Cookies
176156 -- $cookies
177− , cookieJar
157+ cookieJar,
158+
178159 -- *** Authentication
179160 -- $authentication
180− , basicAuth
181− , basicAuthUnsafe
182− , basicProxyAuth
183− , oAuth1
184− , oAuth2Bearer
185− , oAuth2Token
186− , customAuth
161+ basicAuth,
162+ basicAuthUnsafe,
163+ basicProxyAuth,
164+ oAuth1,
165+ oAuth2Bearer,
166+ oAuth2Token,
167+ customAuth,
168+
187169 -- *** Other
188− , port
189− , decompress
190− , responseTimeout
191− , httpVersion
170+ port,
171+ decompress,
172+ responseTimeout,
173+ httpVersion,
174+
192175 -- * Response
176+
193177 -- ** Response interpretations
194− , IgnoreResponse
195− , ignoreResponse
196− , JsonResponse
197− , jsonResponse
198− , BsResponse
199− , bsResponse
200− , LbsResponse
201− , lbsResponse
178+ IgnoreResponse,
179+ ignoreResponse,
180+ JsonResponse,
181+ jsonResponse,
182+ BsResponse,
183+ bsResponse,
184+ LbsResponse,
185+ lbsResponse,
186+
202187 -- ** Inspecting a response
203− , responseBody
204− , responseStatusCode
205− , responseStatusMessage
206− , responseHeader
207− , responseCookieJar
188+ responseBody,
189+ responseStatusCode,
190+ responseStatusMessage,
191+ responseHeader,
192+ responseCookieJar,
193+
208194 -- ** Defining your own interpretation
209195 -- $new-response-interpretation
210− , HttpResponse (..)
196+ HttpResponse (..),
197+
211198 -- * Other
212− , HttpException (..)
213− , CanHaveBody (..)
214− , Scheme (..) )
199+ HttpException (..),
200+ isStatusCodeException,
201+ CanHaveBody (..),
202+ Scheme (..),
203+ )
215204where
216205
206+import Blaze.ByteString.Builder qualified as BB
217207import Control.Applicative
218208import Control.Arrow (first, second)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
219211import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
220213import 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)
222218import 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
223231import Control.Retry
224−import Data.Aeson (ToJSON (..), FromJSON (..))
232+import Data.Aeson (FromJSON (..), ToJSON (..))
233+import Data.Aeson qualified as A
225234import 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
226238import Data.Data (Data)
227−import Data.Default.Class
239+import Data.Default.Class (def)
228240import Data.Function (on)
229241import Data.IORef
230−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
231244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
232246import Data.Maybe (fromMaybe)
233247import Data.Proxy
234−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
235250import Data.Text (Text)
236−import Data.Typeable (Typeable)
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
253+import Data.Typeable (Typeable, cast)
237254import GHC.Generics
238255import 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
239265import 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
240272import 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
257−
258−#if MIN_VERSION_base(4,9,0)
259−import Control.Exception hiding (TypeError)
260−import Data.Kind (Constraint)
261−#else
262−import Control.Exception
263−import GHC.Exts (Constraint)
264−#endif
265273
266274----------------------------------------------------------------------------
267275-- Making a request
@@ -285,7 +293,7 @@ import GHC.Exts (Constraint)
285293--
286294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
287295-- tutorial has a section about HTTP bodies, but usage is very
288−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
289297--
290298-- @response@ is a type hint how to make and interpret response of an HTTP
291299-- request. Out-of-the-box it can be the following:
@@ -311,6 +319,7 @@ import GHC.Exts (Constraint)
311319-- First, this is a piece of boilerplate that should be in place before you
312320-- try the examples:
313321--
322+-- > {-# LANGUAGE DeriveGeneric #-}
314323-- > {-# LANGUAGE OverloadedStrings #-}
315324-- >
316325-- > module Main (main) where
@@ -318,20 +327,20 @@ import GHC.Exts (Constraint)
318327-- > import Control.Monad
319328-- > import Control.Monad.IO.Class
320329-- > import Data.Aeson
321−-- > import Data.Default.Class
322330-- > import Data.Maybe (fromJust)
323331-- > import Data.Monoid ((<>))
324332-- > import Data.Text (Text)
325333-- > import GHC.Generics
326334-- > import Network.HTTP.Req
327335-- > import qualified Data.ByteString.Char8 as B
336+-- > import qualified Text.URI as URI
328337--
329338-- We will be making requests against the <https://httpbin.org> service.
330339--
331340-- Make a GET request, grab 5 random bytes:
332341--
333342-- > main :: IO ()
334−-- > main = runReq def $ do
343+-- > main = runReq defaultHttpConfig $ do
335344-- > let n :: Int
336345-- > n = 5
337346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
@@ -341,7 +350,7 @@ import GHC.Exts (Constraint)
341350-- seed of the generator:
342351--
343352-- > main :: IO ()
344−-- > main = runReq def $ do
353+-- > main = runReq defaultHttpConfig $ do
345354-- > let n, seed :: Int
346355-- > n = 5
347356-- > seed = 100
@@ -360,7 +369,7 @@ import GHC.Exts (Constraint)
360369-- > instance FromJSON MyData
361370-- >
362371-- > main :: IO ()
363−-- > main = runReq def $ do
372+-- > main = runReq defaultHttpConfig $ do
364373-- > let myData = MyData
365374-- > { size = 6
366375-- > , color = "Green" }
@@ -370,7 +379,7 @@ import GHC.Exts (Constraint)
370379-- Sending URL-encoded body:
371380--
372381-- > main :: IO ()
373−-- > main = runReq def $ do
382+-- > main = runReq defaultHttpConfig $ do
374383-- > let params =
375384-- > "foo" =: ("bar" :: Text) <>
376385-- > queryFlag "baz"
@@ -380,10 +389,11 @@ import GHC.Exts (Constraint)
380389-- Using various optional parameters and URL that is not known in advance:
381390--
382391-- > main :: IO ()
383−-- > main = runReq def $ do
392+-- > main = runReq defaultHttpConfig $ do
384393-- > -- This is an example of what to do when URL is given dynamically. Of
385394-- > -- 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)
387397-- > response <- req GET url NoReqBody jsonResponse $
388398-- > "from" =: (15 :: Int) <>
389399-- > "to" =: (67 :: Int) <>
@@ -391,60 +401,138 @@ import GHC.Exts (Constraint)
391401-- > options <> -- contains the ?foo=bar part
392402-- > port 443 -- here you can put any port of course
393403-- > liftIO $ print (responseBody response :: Value)
394−
395−req
396− :: ( MonadHttp m
397− , HttpMethod method
398− , HttpBody body
399− , HttpResponse response
400− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
401− => method -- ^ HTTP method
402− -> Url scheme -- ^ 'Url'—location of resource
403− -> body -- ^ Body of the request
404− -> Proxy response -- ^ A hint how to interpret response
405− -> Option scheme -- ^ Collection of optional parameters
406− -> m response -- ^ Response
407−req method url body Proxy options =
408− reqBr method url body options getHttpResponse
404+req ::
405+ ( MonadHttp m,
406+ HttpMethod method,
407+ HttpBody body,
408+ HttpResponse response,
409+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
410+ ) =>
411+ -- | HTTP method
412+ method ->
413+ -- | 'Url'—location of resource
414+ Url scheme ->
415+ -- | Body of the request
416+ body ->
417+ -- | A hint how to interpret response
418+ Proxy response ->
419+ -- | Collection of optional parameters
420+ Option scheme ->
421+ -- | Response
422+ m response
423+req method url body responseProxy options =
424+ reqCb method url body responseProxy options pure
409425
410426-- | A version of 'req' that does not use one of the predefined instances of
411427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
412428-- 'L.BodyReader'@ manually, in a custom way.
413429--
414430-- @since 1.0.0
415−
416−reqBr
417− :: ( MonadHttp m
418− , HttpMethod method
419− , HttpBody body
420− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
421− => method -- ^ HTTP method
422− -> Url scheme -- ^ 'Url'—location of resource
423− -> body -- ^ Body of the request
424− -> Option scheme -- ^ Collection of optional parameters
425− -> (L.Response L.BodyReader -> IO a) -- ^ How to consume response
426− -> m a -- ^ Result
427−reqBr method url body options consume = req' method url body options $ \request manager -> do
428− HttpConfig {..} <- getHttpConfig
431+reqBr ::
432+ ( MonadHttp m,
433+ HttpMethod method,
434+ HttpBody body,
435+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
436+ ) =>
437+ -- | HTTP method
438+ method ->
439+ -- | 'Url'—location of resource
440+ Url scheme ->
441+ -- | Body of the request
442+ body ->
443+ -- | Collection of optional parameters
444+ Option scheme ->
445+ -- | How to consume response
446+ (L.Response L.BodyReader -> IO a) ->
447+ -- | Result
448+ m a
449+reqBr method url body options consume =
450+ req' method url body options (reqHandler consume)
451+
452+-- | A version of 'req' that takes a callback to modify the 'L.Request', but
453+-- otherwise performs the request identically.
454+--
455+-- @since 3.7.0
456+reqCb ::
457+ ( MonadHttp m,
458+ HttpMethod method,
459+ HttpBody body,
460+ HttpResponse response,
461+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
462+ ) =>
463+ -- | HTTP method
464+ method ->
465+ -- | 'Url'—location of resource
466+ Url scheme ->
467+ -- | Body of the request
468+ body ->
469+ -- | A hint how to interpret response
470+ Proxy response ->
471+ -- | Collection of optional parameters
472+ Option scheme ->
473+ -- | Callback to modify the request
474+ (L.Request -> m L.Request) ->
475+ -- | Response
476+ m response
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
481+ where
482+ extraOptions =
483+ case acceptHeader responseProxy of
484+ Nothing -> mempty
485+ Just accept -> header "Accept" accept
486+
487+-- | The default handler function that the higher-level request functions
488+-- pass to 'req''. Internal function.
489+--
490+-- @since 3.7.0
491+reqHandler ::
492+ (MonadHttp m) =>
493+ -- | How to get final result from a 'L.Response'
494+ (L.Response L.BodyReader -> IO b) ->
495+ -- | 'L.Request' to perform
496+ L.Request ->
497+ -- | 'L.Manager' to use
498+ L.Manager ->
499+ m b
500+reqHandler consume request manager = do
501+ HttpConfig {..} <- getHttpConfig
429502 let wrapVanilla = handle (throwIO . VanillaHttpException)
430− wrapExc = handle (throwIO . LI.toHttpException request)
431− withRRef = bracket
432− (newIORef Nothing)
433− (readIORef >=> mapM_ L.responseClose)
434− (liftIO . try . wrapVanilla . wrapExc) (withRRef $ \rref -> do
435− let openResponse = mask_ $ do
436− r <- readIORef rref
437− mapM_ L.responseClose r
438− r' <- L.responseOpen request manager
439− writeIORef rref (Just r')
440− return r'
441− r <- retrying
442− httpConfigRetryPolicy
443− (\st r -> return $ httpConfigRetryJudge st r)
444− (const openResponse)
445− (preview, r') <- grabPreview bodyPreviewLength r
446− mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
447− consume r')
503+ wrapExc = handle (throwIO . LI.toHttpException request)
504+ withRRef =
505+ bracket
506+ (newIORef Nothing)
507+ (readIORef >=> mapM_ L.responseClose)
508+ (liftIO . try . wrapVanilla . wrapExc)
509+ ( withRRef $ \rref -> do
510+ let openResponse = mask_ $ do
511+ r <- readIORef rref
512+ mapM_ L.responseClose r
513+ r' <- L.responseOpen request manager
514+ writeIORef rref (Just r')
515+ return r'
516+ exceptionRetryPolicies =
517+ skipAsyncExceptions
518+ ++ [ \retryStatus -> Handler $ \e ->
519+ return $ httpConfigRetryJudgeException retryStatus e
520+ ]
521+ r <-
522+ retrying
523+ httpConfigRetryPolicy
524+ (\retryStatus r -> return $ httpConfigRetryJudge retryStatus r)
525+ ( const
526+ ( recovering
527+ httpConfigRetryPolicy
528+ exceptionRetryPolicies
529+ (const openResponse)
530+ )
531+ )
532+ (preview, r') <- grabPreview httpConfigBodyPreviewLength r
533+ mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
534+ consume r'
535+ )
448536 >>= either handleHttpException return
449537
450538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
@@ -455,51 +543,57 @@ reqBr method url body options consume = req' method url body options $ \request
455543-- 'L.Request' and allows you to use it.
456544--
457545-- @since 0.3.0
458−
459−req'
460− :: forall m method body scheme a.
461− ( MonadHttp m
462− , HttpMethod method
463− , HttpBody body
464− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
465− => method -- ^ HTTP method
466− -> Url scheme -- ^ 'Url'—location of resource
467− -> body -- ^ Body of the request
468− -> Option scheme -- ^ Collection of optional parameters
469− -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
470− -> m a -- ^ Result
546+req' ::
547+ forall m method body scheme a.
548+ ( MonadHttp m,
549+ HttpMethod method,
550+ HttpBody body,
551+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
552+ ) =>
553+ -- | HTTP method
554+ method ->
555+ -- | 'Url'—location of resource
556+ Url scheme ->
557+ -- | Body of the request
558+ body ->
559+ -- | Collection of optional parameters
560+ Option scheme ->
561+ -- | How to perform request
562+ (L.Request -> L.Manager -> m a) ->
563+ -- | Result
564+ m a
471565req' method url body options m = do
472− config@HttpConfig {..} <- getHttpConfig
566+ config <- getHttpConfig
473567 let -- NOTE First appearance of any given header wins. This allows to
474568 -- “overwrite” headers when we construct a request by cons-ing.
475569 nubHeaders = Endo $ \x ->
476− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
477− request' = flip appEndo L.defaultRequest $
478− -- NOTE The order of 'mappend's matters, here method is overwritten
479− -- first and 'options' take effect last. In particular, this means
480− -- that 'options' can overwrite things set by other request
481− -- components, which is useful for setting port number,
482− -- "Content-Type" header, etc.
483− nubHeaders <>
484− getRequestMod options <>
485− getRequestMod config <>
486− getRequestMod (Womb body :: Womb "body" body) <>
487− getRequestMod url <>
488− getRequestMod (Womb method :: Womb "method" method)
570+ x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
571+ request' =
572+ flip appEndo L.defaultRequest $
573+ -- NOTE The order of 'mappend's matters, here method is overwritten
574+ -- first and 'options' take effect last. In particular, this means
575+ -- that 'options' can overwrite things set by other request
576+ -- components, which is useful for setting port number,
577+ -- "Content-Type" header, etc.
578+ nubHeaders
579+ <> getRequestMod options
580+ <> getRequestMod config
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
582+ <> getRequestMod url
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
489584 request <- finalizeRequest options request'
490585 withReqManager (m request)
491586
492587-- | Perform an action using the global implicit 'L.Manager' that the rest
493−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
494589-- 'L.Manager' controls.
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
495592
496−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
497−withReqManager m = liftIO (readIORef globalManager) >>= m
498−
499−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
500−-- settings, so users don't need to deal with this manager stuff at all, but
501−-- when we create a request, instance 'HttpConfig' can affect the default
502−-- settings via 'getHttpConfig'.
593+-- | The global 'L.Manager' that 'req' uses. Here we just go with the
594+-- default settings, so users don't need to deal with this manager stuff at
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
596+-- default settings via 'getHttpConfig'.
503597--
504598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
505599-- The value of 'globalManager' is named and lives on top level. This means
@@ -507,13 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
507601-- manager. From that moment on the 'IORef' will be just reused—exactly the
508602-- behavior we want here in order to maximize connection sharing. GHC could
509603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
510−
511−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
512605globalManager = unsafePerformIO $ do
513606 context <- NC.initConnectionContext
514− let settings = L.mkManagerSettingsContext (Just context) def Nothing
607+ let settings =
608+ L.mkManagerSettingsContext
609+ (Just context)
610+ def
611+ Nothing
515612 manager <- L.newManager settings
516− newIORef manager
613+ return manager
517614{-# NOINLINE globalManager #-}
518615
519616----------------------------------------------------------------------------
@@ -527,55 +624,43 @@ globalManager = unsafePerformIO $ do
527624-- When writing a library, keep your API polymorphic in terms of
528625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
529626-- Another option is to use a @newtype@-wrapped monad stack and define
530−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
531−-- this strategy is provided out-of-the-box (see below).
627+-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
628+-- follows this strategy is provided out-of-the-box (see below).
532629
533630-- | A type class for monads that support performing HTTP requests.
534631-- Typically, you only need to define the 'handleHttpException' method
535632-- unless you want to tweak 'HttpConfig'.
536−
537−class MonadIO m => MonadHttp m where
538−
633+class (MonadIO m) => MonadHttp m where
539634 -- | This method describes how to deal with 'HttpException' that was
540635 -- caught by the library. One option is to re-throw it if you are OK with
541636 -- exceptions, but if you prefer working with something like
542637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
543638 -- 'Control.Monad.Except.throwError'.
544−
545639 handleHttpException :: HttpException -> m a
546640
547− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
548− -- implementation returns its 'def' value, which is described in the
549− -- documentation for the type. Common usage pattern with manually defined
550− -- 'getHttpConfig' is to return some hard-coded value, or a value
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
642+ -- Default implementation returns its 'def' value, which is described in
643+ -- the documentation for the type. Common usage pattern with manually
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
551645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
552646 -- approach to configuration is desirable.
553−
554647 getHttpConfig :: m HttpConfig
555− getHttpConfig = return def
556−
557−-- | 'HttpConfig' contains general and default settings to be used when
558−-- making HTTP requests.
648+ getHttpConfig = return defaultHttpConfig
559649
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
560651data HttpConfig = HttpConfig
561− { httpConfigProxy :: Maybe L.Proxy
562− -- ^ 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@
563653 -- environment variables are respected, this setting overwrites them.
564654 -- Default value: 'Nothing'.
565− , httpConfigRedirectCount :: Int
566− -- ^ How many redirects to follow when getting a resource. Default
655+ httpConfigProxy :: Maybe L.Proxy,
656+ -- | How many redirects to follow when getting a resource. Default
567657 -- value: 10.
568− , httpConfigAltManager :: Maybe L.Manager
569− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
658+ httpConfigRedirectCount :: Int,
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
570660 -- that the default implicit manager will be used (that's what you want
571661 -- in 99% of cases).
572− , httpConfigCheckResponse
573− :: forall b.
574− L.Request
575− -> L.Response b
576− -> ByteString
577− -> Maybe L.HttpExceptionContent
578− -- ^ Function to check the response immediately after receiving the
662+ httpConfigAltManager :: Maybe L.Manager,
663+ -- | Function to check the response immediately after receiving the
579664 -- status and headers, before streaming of response body. The third
580665 -- argument is the beginning of response body (typically first 1024
581666 -- bytes). This is used for throwing exceptions on non-success status
@@ -597,63 +682,106 @@ data HttpConfig = HttpConfig
597682 -- /1.0.0/.
598683 --
599684 -- @since 0.3.0
600− , httpConfigRetryPolicy :: RetryPolicy
601− -- ^ The retry policy to use for request retrying. By default 'def' is
685+ httpConfigCheckResponse ::
686+ forall b.
687+ L.Request ->
688+ L.Response b ->
689+ ByteString ->
690+ Maybe L.HttpExceptionContent,
691+ -- | The retry policy to use for request retrying. By default 'def' is
602692 -- used (see 'RetryPolicyM').
603693 --
604− -- __Note__: signature of this function was changed in the version
605− -- /1.0.0/.
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/.
606696 --
607697 -- @since 0.3.0
608− , httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
609− -- ^ The function is used to decide whether to retry a request. 'True'
698+ httpConfigRetryPolicy :: RetryPolicyM IO,
699+ -- | The function is used to decide whether to retry a request. 'True'
610700 -- means that the request should be retried.
611701 --
612702 -- __Note__: signature of this function was changed in the version
613703 -- /1.0.0/.
614704 --
615705 -- @since 0.3.0
616− } deriving Typeable
617−
618−instance Default HttpConfig where
619− def = HttpConfig
620− { httpConfigProxy = Nothing
621− , httpConfigRedirectCount = 10
622− , httpConfigAltManager = Nothing
623− , httpConfigCheckResponse = \_ response preview ->
706+ httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
707+ -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
708+ -- retry requests that resulted in an exception. By default it retries
709+ -- on response timeout and connection timeout (changed in version
710+ -- /3.8.0/).
711+ --
712+ -- @since 3.4.0
713+ httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714+ -- | Max length of preview fragment of response body.
715+ --
716+ -- @since 3.6.0
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
718+ }
719+
720+-- | The default value of 'HttpConfig'.
721+--
722+-- @since 2.0.0
723+defaultHttpConfig :: HttpConfig
724+defaultHttpConfig =
725+ HttpConfig
726+ { httpConfigProxy = Nothing,
727+ httpConfigRedirectCount = 10,
728+ httpConfigAltManager = Nothing,
729+ httpConfigCheckResponse = \_ response preview ->
624730 let scode = statusCode response
625− in if 200 <= scode && scode < 300
626− then Nothing
627− else Just (L.StatusCodeException (void response) preview)
628− , httpConfigRetryPolicy = def
629− , httpConfigRetryJudge = \_ response ->
630− statusCode response `elem`
631− [ 408 -- Request timeout
632− , 504 -- Gateway timeout
633− , 524 -- A timeout occurred
634− , 598 -- (Informal convention) Network read timeout error
635− , 599 -- (Informal convention) Network connect timeout error
636− ]
731+ in if 200 <= scode && scode < 300
732+ then Nothing
733+ else Just (L.StatusCodeException (void response) preview),
734+ httpConfigRetryPolicy = retryPolicyDefault,
735+ httpConfigRetryJudge = \_ response ->
736+ statusCode response
737+ `elem` [ 408, -- Request timeout
738+ 504, -- Gateway timeout
739+ 524, -- A timeout occurred
740+ 598, -- (Informal convention) Network read timeout error
741+ 599 -- (Informal convention) Network connect timeout error
742+ ],
743+ httpConfigRetryJudgeException = \_ e ->
744+ case fromException e of
745+ Just (L.HttpExceptionRequest _ c) ->
746+ case c of
747+ L.ResponseTimeout -> True
748+ L.ConnectionTimeout -> True
749+ _ -> False
750+ _ -> False,
751+ httpConfigBodyPreviewLength = 1024
637752 }
638− where
639− statusCode = Y.statusCode . L.responseStatus
753+ where
754+ statusCode = Y.statusCode . L.responseStatus
640755
641756instance RequestComponent HttpConfig where
642757 getRequestMod HttpConfig {..} = Endo $ \x ->
643− x { L.proxy = httpConfigProxy
644− , L.redirectCount = httpConfigRedirectCount
645− , LI.requestManagerOverride = httpConfigAltManager }
758+ x
759+ { L.proxy = httpConfigProxy,
760+ L.redirectCount = httpConfigRedirectCount,
761+ LI.requestManagerOverride = httpConfigAltManager
762+ }
646763
647−-- | 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
648765-- having to define new instances.
649766--
650767-- @since 0.4.0
651−
652768newtype Req a = Req (ReaderT HttpConfig IO a)
653− deriving ( Functor
654− , Applicative
655− , Monad
656− , MonadIO )
769+ deriving
770+ ( Functor,
771+ Applicative,
772+ Monad,
773+ MonadIO,
774+ MonadUnliftIO
775+ )
776+
777+-- | @since 3.7.0
778+deriving instance MonadThrow Req
779+
780+-- | @since 3.7.0
781+deriving instance MonadCatch Req
782+
783+-- | @since 3.7.0
784+deriving instance MonadMask Req
657785
658786instance MonadBase IO Req where
659787 liftBase = liftIO
@@ -662,22 +790,99 @@ instance MonadBaseControl IO Req where
662790 type StM Req a = a
663791 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
664792 {-# INLINEABLE liftBaseWith #-}
665− restoreM = Req . ReaderT . const . return
793+ restoreM = Req . ReaderT . const . return
666794 {-# INLINEABLE restoreM #-}
667795
668796instance MonadHttp Req where
669797 handleHttpException = Req . lift . throwIO
670− getHttpConfig = Req ask
798+ getHttpConfig = Req ask
799+
800+-- | @since 3.10.0
801+instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802+ handleHttpException = lift . handleHttpException
803+ getHttpConfig = lift getHttpConfig
804+
805+-- | @since 3.10.0
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
807+ handleHttpException = lift . handleHttpException
808+ getHttpConfig = lift getHttpConfig
809+
810+-- | @since 3.10.0
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812+ handleHttpException = lift . handleHttpException
813+ getHttpConfig = lift getHttpConfig
814+
815+-- | @since 3.10.0
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
817+ handleHttpException = lift . handleHttpException
818+ getHttpConfig = lift getHttpConfig
819+
820+-- | @since 3.10.0
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
822+ handleHttpException = lift . handleHttpException
823+ getHttpConfig = lift getHttpConfig
824+
825+-- | @since 3.10.0
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827+ handleHttpException = lift . handleHttpException
828+ getHttpConfig = lift getHttpConfig
829+
830+-- | @since 3.10.0
831+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832+ handleHttpException = lift . handleHttpException
833+ getHttpConfig = lift getHttpConfig
834+
835+-- | @since 3.10.0
836+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837+ handleHttpException = lift . handleHttpException
838+ getHttpConfig = lift getHttpConfig
839+
840+-- | @since 3.10.0
841+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842+ handleHttpException = lift . handleHttpException
843+ getHttpConfig = lift getHttpConfig
844+
845+-- | @since 3.10.0
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
847+ handleHttpException = lift . handleHttpException
848+ getHttpConfig = lift getHttpConfig
849+
850+-- | @since 3.10.0
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852+ handleHttpException = lift . handleHttpException
853+ getHttpConfig = lift getHttpConfig
854+
855+-- | @since 3.10.0
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857+ handleHttpException = lift . handleHttpException
858+ getHttpConfig = lift getHttpConfig
859+
860+-- | @since 3.10.0
861+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862+ handleHttpException = lift . handleHttpException
863+ getHttpConfig = lift getHttpConfig
864+
865+-- | @since 3.10.0
866+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867+ handleHttpException = lift . handleHttpException
868+ getHttpConfig = lift getHttpConfig
869+
870+-- | @since 3.10.0
871+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872+ handleHttpException = lift . handleHttpException
873+ getHttpConfig = lift getHttpConfig
671874
672875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
673−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
674877--
675878-- @since 0.4.0
676−
677−runReq :: MonadIO m
678− => HttpConfig -- ^ 'HttpConfig' to use
679− -> Req a -- ^ Computation to run
680− -> m a
879+runReq ::
880+ (MonadIO m) =>
881+ -- | 'HttpConfig' to use
882+ HttpConfig ->
883+ -- | Computation to run
884+ Req a ->
885+ m a
681886runReq config (Req m) = liftIO (runReaderT m config)
682887
683888----------------------------------------------------------------------------
@@ -693,7 +898,6 @@ runReq config (Req m) = liftIO (runReaderT m config)
693898-- define a new method that will works seamlessly, see 'HttpMethod'.
694899
695900-- | 'GET' method.
696−
697901data GET = GET
698902
699903instance HttpMethod GET where
@@ -701,7 +905,6 @@ instance HttpMethod GET where
701905 httpMethodName Proxy = Y.methodGet
702906
703907-- | 'POST' method.
704−
705908data POST = POST
706909
707910instance HttpMethod POST where
@@ -709,7 +912,6 @@ instance HttpMethod POST where
709912 httpMethodName Proxy = Y.methodPost
710913
711914-- | 'HEAD' method.
712−
713915data HEAD = HEAD
714916
715917instance HttpMethod HEAD where
@@ -717,26 +919,24 @@ instance HttpMethod HEAD where
717919 httpMethodName Proxy = Y.methodHead
718920
719921-- | 'PUT' method.
720−
721922data PUT = PUT
722923
723924instance HttpMethod PUT where
724925 type AllowsBody PUT = 'CanHaveBody
725926 httpMethodName Proxy = Y.methodPut
726927
727−-- | 'DELETE' method. This data type does not allow having request body with
728−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
729−-- requests to have bodies, in that case define your own variation of
730−-- 'DELETE' method and allow it to have a body.
731−
928+-- | 'DELETE' method. RFC 7231 allows a payload in DELETE but without
929+-- semantics.
930+--
931+-- __Note__: before version /3.4.0/ this method did not allow request
932+-- bodies.
732933data DELETE = DELETE
733934
734935instance HttpMethod DELETE where
735− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
736937 httpMethodName Proxy = Y.methodDelete
737938
738939-- | 'TRACE' method.
739−
740940data TRACE = TRACE
741941
742942instance HttpMethod TRACE where
@@ -744,7 +944,6 @@ instance HttpMethod TRACE where
744944 httpMethodName Proxy = Y.methodTrace
745945
746946-- | 'CONNECT' method.
747−
748947data CONNECT = CONNECT
749948
750949instance HttpMethod CONNECT where
@@ -752,7 +951,6 @@ instance HttpMethod CONNECT where
752951 httpMethodName Proxy = Y.methodConnect
753952
754953-- | 'OPTIONS' method.
755−
756954data OPTIONS = OPTIONS
757955
758956instance HttpMethod OPTIONS where
@@ -760,7 +958,6 @@ instance HttpMethod OPTIONS where
760958 httpMethodName Proxy = Y.methodOptions
761959
762960-- | 'PATCH' method.
763−
764961data PATCH = PATCH
765962
766963instance HttpMethod PATCH where
@@ -775,23 +972,19 @@ instance HttpMethod PATCH where
775972-- > instance HttpMethod COPY where
776973-- > type AllowsBody COPY = 'CanHaveBody
777974-- > httpMethodName Proxy = "COPY"
778−
779975class HttpMethod a where
780−
781976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
782977 -- tells the rest of the library whether the method can have body or not.
783978 -- We use the special type 'CanHaveBody' lifted to the kind level instead
784979 -- of 'Bool' to get more user-friendly compiler messages.
785−
786980 type AllowsBody a :: CanHaveBody
787981
788982 -- | Return name of the method as a 'ByteString'.
789−
790983 httpMethodName :: Proxy a -> ByteString
791984
792−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
793986 getRequestMod _ = Endo $ \x ->
794− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
795988
796989----------------------------------------------------------------------------
797990-- Request—URL
@@ -799,8 +992,7 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
799992-- $url
800993--
801994-- We use 'Url's which are correct by construction, see 'Url'. To build a
802−-- 'Url' from a 'ByteString', use 'parseUrlHttp', 'parseUrlHttps', or
803−-- generic 'parseUrl'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
804996
805997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
806998-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -830,103 +1022,194 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8301022--
8311023-- > https "юникод.рф"
8321024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
833−
8341025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8351026 -- NOTE The second value is the path segments in reversed order.
836− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1028+
1029+type role Url nominal
1030+
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
1034+ lift url =
1035+ TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036+ Url Http _ -> [t|Url 'Http|]
1037+ Url Https _ -> [t|Url 'Https|]
1038+ where
1039+ liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
8371041
8381042-- | Given host name, produce a 'Url' which has “http” as its scheme and
8391043-- empty path. This also sets port to @80@.
840−
8411044http :: Text -> Url 'Http
8421045http = Url Http . pure
8431046
8441047-- | Given host name, produce a 'Url' which has “https” as its scheme and
8451048-- empty path. This also sets port to @443@.
846−
8471049https :: Text -> Url 'Https
8481050https = Url Https . pure
8491051
850−-- | 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
8511053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
852−
8531054infixl 5 /~
854−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
855−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
8561055
857−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
858−-- when next URL piece is a 'Text' literal.
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
1057+Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
8591058
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
8601061infixl 5 /:
1062+
8611063(/:) :: Url scheme -> Text -> Url scheme
8621064(/:) = (/~)
8631065
864−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
865−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
866−-- you are given a URL to query dynamically and don't know it beforehand.
867−-- The function parses 'ByteString' because it's the correct type to
868−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
869−-- range, thus we can consider every character a 'Data.Word.Word8' value.
870−--
871−-- This function only parses 'Url' (scheme, host, path) and optional query
872−-- parameters that are returned as 'Option'. It does not parse method name
873−-- or authentication info from given 'ByteString'.
874−--
875−-- This function expected scheme to be “http”.
876−
877−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
878−parseUrlHttp url' = do
879− url <- B.stripPrefix "http://" url'
880− (host :| path, option) <- parseUrlHelper url
881− return (foldl (/:) (http host) path, option)
882−
883−-- | Just like 'parseUrlHttp', but expects the “https” scheme.
884−
885−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
886−parseUrlHttps url' = do
887− url <- B.stripPrefix "https://" url'
888− (host :| path, option) <- parseUrlHelper url
889− return (foldl (/:) (https host) path, option)
890−
891−-- | A more general URI parsing function that can be used when scheme is not
892−-- known beforehand.
893−--
894−-- @since 1.2.1
895−
896−parseUrl
897− :: ByteString
898− -> Maybe (Either (Url 'Http, Option scheme0) (Url 'Https, Option scheme1))
899−parseUrl url = Left <$> parseUrlHttp url <|> Right <$> parseUrlHttps url
900−
901−-- | Get host\/collection of path pieces and possibly query parameters
902−-- already converted to 'Option'. This function is not public.
903−
904−parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
905−parseUrlHelper url = do
906− let (path', query') = B.break (== 0x3f) url
907− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
908− p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
909− (p, port') <-
910− case T.break (== ':') p' of
911− (x, "") -> return (x, mempty)
912− (x, prt) ->
913− case TR.decimal (T.drop 1 prt) of
914− Right (prt',"") -> return (x, port prt')
915− _ -> Nothing
916− return (p :| ps, query <> port')
1066+-- | Render a 'Url' as 'Text'.
1067+--
1068+-- @since 3.4.0
1069+renderUrl :: Url scheme -> Text
1070+renderUrl = \case
1071+ Url Https parts ->
1072+ "https://" <> renderParts parts
1073+ Url Http parts ->
1074+ "http://" <> renderParts parts
1075+ where
1076+ renderParts parts =
1077+ T.intercalate "/" (reverse $ NE.toList parts)
1078+
1079+-- | The 'useHttpURI' function provides an alternative method to get 'Url'
1080+-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
1081+-- given a URL to query dynamically and don't know it beforehand.
1082+--
1083+-- This function expects the scheme to be “http” and host to be present.
1084+--
1085+-- @since 3.0.0
1086+useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
1087+useHttpURI uri = do
1088+ guard (URI.uriScheme uri == Just [QQ.scheme|http|])
1089+ urlHead <- http <$> uriHost uri
1090+ let url = case URI.uriPath uri of
1091+ Nothing -> urlHead
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
1093+ return (url, uriOptions uri)
1094+
1095+-- | Just like 'useHttpURI', but expects the “https” scheme.
1096+--
1097+-- @since 3.0.0
1098+useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
1099+useHttpsURI uri = do
1100+ guard (URI.uriScheme uri == Just [QQ.scheme|https|])
1101+ urlHead <- https <$> uriHost uri
1102+ let url = case URI.uriPath uri of
1103+ Nothing -> urlHead
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
1105+ return (url, uriOptions uri)
1106+
1107+-- | Convert URI path to a 'Url'. Internal.
1108+--
1109+-- @since 3.9.0
1110+uriPathToUrl ::
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
1112+ Url scheme ->
1113+ Url scheme
1114+uriPathToUrl (trailingSlash, xs) urlHead =
1115+ if trailingSlash then path /: T.empty else path
1116+ where
1117+ path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1118+
1119+-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
1120+-- is not known in advance.
1121+--
1122+-- @since 3.0.0
1123+useURI ::
1124+ URI ->
1125+ Maybe
1126+ ( Either
1127+ (Url 'Http, Option scheme0)
1128+ (Url 'Https, Option scheme1)
1129+ )
1130+useURI uri =
1131+ (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
1132+
1133+-- | An internal helper function to extract host from a 'URI'.
1134+uriHost :: URI -> Maybe Text
1135+uriHost uri = case URI.uriAuthority uri of
1136+ Left _ -> Nothing
1137+ Right URI.Authority {..} ->
1138+ Just (URI.unRText authHost)
1139+
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.
1143+--
1144+-- @since 3.2.0
1145+urlQ :: TH.QuasiQuoter
1146+urlQ =
1147+ 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"
1153+ Just eurl ->
1154+ TH.tupE
1155+ [ either (TH.lift . fst) (TH.lift . fst) eurl,
1156+ [|uriOptions uri|]
1157+ ],
1158+ quotePat = error "This usage is not supported",
1159+ quoteType = error "This usage is not supported",
1160+ quoteDec = error "This usage is not supported"
1161+ }
1162+
1163+-- | An internal helper function to extract 'Option's from a 'URI'.
1164+uriOptions :: forall scheme. URI -> Option scheme
1165+uriOptions uri =
1166+ mconcat
1167+ [ auth,
1168+ query,
1169+ port'
1170+ -- , fragment'
1171+ ]
1172+ where
1173+ (auth, port') =
1174+ case URI.uriAuthority uri of
1175+ Left _ -> (mempty, mempty)
1176+ Right URI.Authority {..} ->
1177+ let auth0 = case authUserInfo of
1178+ Nothing -> mempty
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
1184+ Nothing -> mempty
1185+ Just port'' -> port (fromIntegral port'')
1186+ in (auth0, port0)
1187+ query =
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)
1192+
1193+-- TODO Blocked on upstream: https://github.com/snoyberg/http-client/issues/424
1194+-- fragment' =
1195+-- case URI.uriFragment uri of
1196+-- Nothing -> mempty
1197+-- Just fragment'' -> fragment (URI.unRText fragment'')
9171198
9181199instance RequestComponent (Url scheme) where
9191200 getRequestMod (Url scheme segments) = Endo $ \x ->
920− let (host :| path) = NE.reverse segments in
921− x { L.secure = case scheme of
922− Http -> False
923− Https -> True
924− , L.port = case scheme of
925− Http -> 80
926− Https -> 443
927− , L.host = Y.urlEncode False (T.encodeUtf8 host)
928− , L.path =
929− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1201+ let (host :| path) = NE.reverse segments
1202+ in x
1203+ { L.secure = case scheme of
1204+ Http -> False
1205+ Https -> True,
1206+ L.port = case scheme of
1207+ Http -> 80
1208+ Https -> 443,
1209+ L.host = Y.urlEncode False (T.encodeUtf8 host),
1210+ L.path =
1211+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
1212+ }
9301213
9311214----------------------------------------------------------------------------
9321215-- Request—Body
@@ -944,31 +1227,28 @@ instance RequestComponent (Url scheme) where
9441227-- only type for which 'ProvidesBody' returns 'NoBody'.
9451228--
9461229-- Using of this body option does not set the @Content-Type@ header.
947−
9481230data NoReqBody = NoReqBody
9491231
9501232instance HttpBody NoReqBody where
9511233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
9521234
953−-- | This body option allows to use a JSON object as request body—probably
954−-- the most popular format right now. Just wrap a data type that is an
955−-- instance of 'ToJSON' type class and you are done: it will be converted to
956−-- JSON and inserted as request body.
1235+-- | This body option allows us to use a JSON object as the request
1236+-- body—probably the most popular format right now. Just wrap a data type
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
1238+-- converted to JSON and inserted as request body.
9571239--
9581240-- This body option sets the @Content-Type@ header to @\"application/json;
9591241-- charset=utf-8\"@ value.
960−
9611242newtype ReqBodyJson a = ReqBodyJson a
9621243
963−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
9641245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
9651246 getRequestContentType _ = pure "application/json; charset=utf-8"
9661247
9671248-- | This body option streams request body from a file. It is expected that
968−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
9691250--
9701251-- Using of this body option does not set the @Content-Type@ header.
971−
9721252newtype ReqBodyFile = ReqBodyFile FilePath
9731253
9741254instance HttpBody ReqBodyFile where
@@ -978,7 +1258,6 @@ instance HttpBody ReqBodyFile where
9781258-- | HTTP request body represented by a strict 'ByteString'.
9791259--
9801260-- Using of this body option does not set the @Content-Type@ header.
981−
9821261newtype ReqBodyBs = ReqBodyBs ByteString
9831262
9841263instance HttpBody ReqBodyBs where
@@ -987,22 +1266,19 @@ instance HttpBody ReqBodyBs where
9871266-- | HTTP request body represented by a lazy 'BL.ByteString'.
9881267--
9891268-- Using of this body option does not set the @Content-Type@ header.
990−
9911269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
9921270
9931271instance HttpBody ReqBodyLbs where
9941272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
9951273
996−-- | Form URL-encoded body. This can hold a collection of parameters which
997−-- are encoded similarly to query parameters at the end of query string,
998−-- with the only difference that they are stored in request body. The
999−-- similarity is reflected in the API as well, as you can use the same
1000−-- combinators you would use to add query parameters: @('=:')@ and
1001−-- 'queryFlag'.
1274+-- | URL-encoded body. This can hold a collection of parameters which are
1275+-- encoded similarly to query parameters at the end of query string, with
1276+-- the only difference that they are stored in request body. The similarity
1277+-- is reflected in the API as well, as you can use the same combinators you
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
10021279--
10031280-- This body option sets the @Content-Type@ header to
10041281-- @\"application/x-www-form-urlencoded\"@ value.
1005−
10061282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
10071283
10081284instance HttpBody ReqBodyUrlEnc where
@@ -1012,13 +1288,19 @@ instance HttpBody ReqBodyUrlEnc where
10121288
10131289-- | An opaque monoidal value that allows to collect URL-encoded parameters
10141290-- to be wrapped in 'ReqBodyUrlEnc'.
1015−
10161291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
10171292 deriving (Semigroup, Monoid)
10181293
10191294instance QueryParam FormUrlEncodedParam where
10201295 queryParam name mvalue =
10211296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
1298+
1299+-- | Use 'formToQuery'.
1300+--
1301+-- @since 3.11.0
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
10221304
10231305-- | Multipart form data. Please consult the
10241306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1048,7 +1330,6 @@ instance QueryParam FormUrlEncodedParam where
10481330-- > bsResponse
10491331-- > mempty
10501332-- > liftIO $ print (responseBody response)
1051−
10521333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
10531334
10541335instance HttpBody ReqBodyMultipart where
@@ -1059,63 +1340,57 @@ instance HttpBody ReqBodyMultipart where
10591340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
10601341--
10611342-- @since 0.2.0
1062−
1063−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
10641344reqBodyMultipart parts = liftIO $ do
10651345 boundary <- LM.webkitBoundary
1066− body <- LM.renderParts boundary parts
1346+ body <- LM.renderParts boundary parts
10671347 return (ReqBodyMultipart boundary body)
10681348
10691349-- | A type class for things that can be interpreted as an HTTP
10701350-- 'L.RequestBody'.
1071−
10721351class HttpBody body where
1073−
10741352 -- | How to get actual 'L.RequestBody'.
1075−
10761353 getRequestBody :: body -> L.RequestBody
10771354
10781355 -- | This method allows us to optionally specify the value of
10791356 -- @Content-Type@ header that should be used with particular body option.
10801357 -- By default it returns 'Nothing' and so @Content-Type@ is not set.
1081−
10821358 getRequestContentType :: body -> Maybe ByteString
10831359 getRequestContentType = const Nothing
10841360
10851361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
10861362-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
10871363-- with 'GET' method and other methods that should not have body.
1088−
10891364type family ProvidesBody body :: CanHaveBody where
10901365 ProvidesBody NoReqBody = 'NoBody
1091− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
10921367
10931368-- | This type function allows any HTTP body if method says it
10941369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
10951370-- body option to use is 'NoReqBody'.
1096−--
1097−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1098−-- error message when method does not allow a body and body is provided.
1099−
1100−type family HttpBodyAllowed
1101− (allowsBody :: CanHaveBody)
1102− (providesBody :: CanHaveBody) :: Constraint where
1103− HttpBodyAllowed 'NoBody 'NoBody = ()
1104− HttpBodyAllowed 'CanHaveBody body = ()
1105−#if MIN_VERSION_base(4,9,0)
1106− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1107− ('Text "This HTTP method does not allow attaching a request body.")
1108−#endif
1109−
1110−instance HttpBody body => RequestComponent (Womb "body" body) where
1111− getRequestMod (Womb body) = Endo $ \x ->
1112− x { L.requestBody = getRequestBody body
1113− , L.requestHeaders =
1114− let old = L.requestHeaders x in
1115− case getRequestContentType body of
1116− Nothing -> old
1117− Just contentType ->
1118− (Y.hContentType, contentType) : old }
1371+type family
1372+ HttpBodyAllowed
1373+ (allowsBody :: CanHaveBody)
1374+ (providesBody :: CanHaveBody) ::
1375+ Constraint
1376+ where
1377+ HttpBodyAllowed 'NoBody 'NoBody = ()
1378+ HttpBodyAllowed 'CanHaveBody body = ()
1379+ HttpBodyAllowed 'NoBody 'CanHaveBody =
1380+ TypeError
1381+ ('Text "This HTTP method does not allow attaching a request body.")
1382+
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
1385+ x
1386+ { L.requestBody = getRequestBody body,
1387+ L.requestHeaders =
1388+ let old = L.requestHeaders x
1389+ in case getRequestContentType body of
1390+ Nothing -> old
1391+ Just contentType ->
1392+ (Y.hContentType, contentType) : old
1393+ }
11191394
11201395----------------------------------------------------------------------------
11211396-- Request—Optional parameters
@@ -1131,46 +1406,51 @@ instance HttpBody body => RequestComponent (Womb "body" body) where
11311406-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
11321407-- of optional parameters like query parameters and headers. See sections
11331408-- 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))
11341411
1135−data Option (scheme :: Scheme) =
1136− Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1137− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1138− -- Request to avoid appending to existing query string in request every
1139− -- time new parameter is added. Additional Maybe (L.Request -> IO
1140− -- L.Request) is a finalizer that will be applied after all other
1141− -- transformations. This is for authentication methods that sign requests
1142− -- based on data in Request.
1412+-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1413+-- Request to avoid appending to an existing query string in request every
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
1415+-- L.Request) is a finalizer that will be applied after all other
1416+-- transformations. This is for authentication methods that sign requests
1417+-- based on data in Request.
11431418
11441419instance Semigroup (Option scheme) where
1145− Option er0 mr0 <> Option er1 mr1 = Option
1146− (er0 <> er1) (mr0 <|> mr1)
1420+ Option er0 mr0 <> Option er1 mr1 =
1421+ Option
1422+ (er0 <> er1)
1423+ (mr0 <|> mr1)
11471424
11481425instance Monoid (Option scheme) where
1149− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
11501427 mappend = (<>)
11511428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
11521435-- | A helper to create an 'Option' that modifies only collection of query
11531436-- parameters. This helper is not a part of the public API.
1154−
11551437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
11561438withQueryParams f = Option (Endo (first f)) Nothing
11571439
11581440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
11591441-- helper is not a part of public API.
1160−
11611442withRequest :: (L.Request -> L.Request) -> Option scheme
11621443withRequest f = Option (Endo (second f)) Nothing
11631444
11641445instance RequestComponent (Option scheme) where
11651446 getRequestMod (Option f _) = Endo $ \x ->
11661447 let (qparams, x') = appEndo f ([], x)
1167− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1168− in x' { L.queryString = query }
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449+ in x' {L.queryString = query}
11691450
11701451-- | Finalize given 'L.Request' by applying a finalizer from the given
11711452-- 'Option' (if it has any).
1172−
1173−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
11741454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
11751455
11761456----------------------------------------------------------------------------
@@ -1189,12 +1469,12 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
11891469-- This operator is defined in terms of 'queryParam':
11901470--
11911471-- > name =: value = queryParam name (pure value)
1192−
11931472infix 7 =:
1473+
11941474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
11951475name =: value = queryParam name (pure value)
11961476
1197−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
11981478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
11991479-- with a value:
12001480--
@@ -1203,27 +1483,47 @@ name =: value = queryParam name (pure value)
12031483-- This operator is defined in terms of 'queryParam':
12041484--
12051485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1206−
1207−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
12081487queryFlag name = queryParam name (Nothing :: Maybe ())
12091488
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491+--
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@).
1496+--
1497+-- @since 3.11.0
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500+ where
1501+ toParam (key, val) =
1502+ queryParam key $
1503+ if val == ""
1504+ then Nothing
1505+ else Just val
1506+
12101507-- | A type class for query-parameter-like things. The reason to have an
12111508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
12121509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
12131510-- Having the same syntax for these cases seems natural and user-friendly.
1214−
12151511class QueryParam param where
1216−
12171512 -- | Create a query parameter with given name and value. If value is
12181513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
12191514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
12201515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
12211517
1222− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1519+ --
1520+ -- @since 3.11.0
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
12231522
12241523instance QueryParam (Option scheme) where
12251524 queryParam name mvalue =
12261525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
12271527
12281528----------------------------------------------------------------------------
12291529-- Request—Optional parameters—Headers
@@ -1232,20 +1532,28 @@ instance QueryParam (Option scheme) where
12321532-- headers with the same names the leftmost header will win. This means, in
12331533-- particular, that you cannot create a request with several headers of the
12341534-- same name.
1235−
1236−header
1237− :: ByteString -- ^ Header name
1238− -> ByteString -- ^ Header value
1239− -> Option scheme
1535+header ::
1536+ -- | Header name
1537+ ByteString ->
1538+ -- | Header value
1539+ ByteString ->
1540+ Option scheme
12401541header name value = withRequest (attachHeader name value)
12411542
12421543-- | Attach a header with given name and content to a 'L.Request'.
12431544--
12441545-- @since 1.1.0
1245−
12461546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
12471547attachHeader name value x =
1248− x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
1548+ x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1549+
1550+-- | Same as 'header', but with redacted values on print.
1551+--
1552+-- @since 3.13.0
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}
12491557
12501558----------------------------------------------------------------------------
12511559-- Request—Optional parameters—Cookies
@@ -1258,10 +1566,9 @@ attachHeader name value x =
12581566
12591567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
12601568-- 'L.Response' record.
1261−
12621569cookieJar :: L.CookieJar -> Option scheme
12631570cookieJar jar = withRequest $ \x ->
1264− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
12651572
12661573----------------------------------------------------------------------------
12671574-- Request—Optional parameters—Authentication
@@ -1279,11 +1586,13 @@ cookieJar jar = withRequest $ \x ->
12791586-- | The 'Option' adds basic authentication.
12801587--
12811588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1282−
1283−basicAuth
1284− :: ByteString -- ^ Username
1285− -> ByteString -- ^ Password
1286− -> Option 'Https -- ^ Auth 'Option'
1589+basicAuth ::
1590+ -- | Username
1591+ ByteString ->
1592+ -- | Password
1593+ ByteString ->
1594+ -- | Auth 'Option'
1595+ Option 'Https
12871596basicAuth = basicAuthUnsafe
12881597
12891598-- | An alternative to 'basicAuth' which works for any scheme. Note that
@@ -1291,41 +1600,52 @@ basicAuth = basicAuthUnsafe
12911600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
12921601--
12931602-- @since 0.3.1
1294−
1295−basicAuthUnsafe
1296− :: ByteString -- ^ Username
1297− -> ByteString -- ^ Password
1298− -> Option scheme -- ^ Auth 'Option'
1299−basicAuthUnsafe username password = customAuth
1300− (pure . L.applyBasicAuth username password)
1603+basicAuthUnsafe ::
1604+ -- | Username
1605+ ByteString ->
1606+ -- | Password
1607+ ByteString ->
1608+ -- | Auth 'Option'
1609+ Option scheme
1610+basicAuthUnsafe username password =
1611+ customAuth
1612+ (pure . L.applyBasicAuth username password)
13011613
13021614-- | The 'Option' set basic proxy authentication header.
13031615--
13041616-- @since 1.1.0
1305−
1306−basicProxyAuth
1307− :: ByteString -- ^ Username
1308− -> ByteString -- ^ Password
1309− -> Option scheme -- ^ Auth 'Option'
1617+basicProxyAuth ::
1618+ -- | Username
1619+ ByteString ->
1620+ -- | Password
1621+ ByteString ->
1622+ -- | Auth 'Option'
1623+ Option scheme
13101624basicProxyAuth username password =
13111625 withRequest (L.applyBasicProxyAuth username password)
13121626
13131627-- | The 'Option' adds OAuth1 authentication.
13141628--
13151629-- @since 0.2.0
1316−
1317−oAuth1
1318− :: ByteString -- ^ Consumer token
1319− -> ByteString -- ^ Consumer secret
1320− -> ByteString -- ^ OAuth token
1321− -> ByteString -- ^ OAuth token secret
1322− -> Option scheme -- ^ Auth 'Option'
1630+oAuth1 ::
1631+ -- | Consumer token
1632+ ByteString ->
1633+ -- | Consumer secret
1634+ ByteString ->
1635+ -- | OAuth token
1636+ ByteString ->
1637+ -- | OAuth token secret
1638+ ByteString ->
1639+ -- | Auth 'Option'
1640+ Option scheme
13231641oAuth1 consumerToken consumerSecret token tokenSecret =
13241642 customAuth (OAuth.signOAuth app creds)
13251643 where
1326− app = OAuth.newOAuth
1327− { OAuth.oauthConsumerKey = consumerToken
1328− , OAuth.oauthConsumerSecret = consumerSecret }
1644+ app =
1645+ OAuth.newOAuth
1646+ { OAuth.oauthConsumerKey = consumerToken,
1647+ OAuth.oauthConsumerSecret = consumerSecret
1648+ }
13291649 creds = OAuth.newCredential token tokenSecret
13301650
13311651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1336,12 +1656,14 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
13361656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
13371657--
13381658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1339−
1340−oAuth2Bearer
1341− :: ByteString -- ^ Token
1342− -> Option 'Https -- ^ Auth 'Option'
1343−oAuth2Bearer token = customAuth
1344− (pure . attachHeader "Authorization" ("Bearer " <> token))
1659+oAuth2Bearer ::
1660+ -- | Token
1661+ ByteString ->
1662+ -- | Auth 'Option'
1663+ Option 'Https
1664+oAuth2Bearer token =
1665+ customAuth
1666+ (pure . attachHeader "Authorization" ("Bearer " <> token))
13451667
13461668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
13471669-- to be used only by GitHub). This will be treated by whatever services
@@ -1352,19 +1674,20 @@ oAuth2Bearer token = customAuth
13521674-- > oAuth2Token token = header "Authorization" ("token" <> token)
13531675--
13541676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1355−
1356−oAuth2Token
1357− :: ByteString -- ^ Token
1358− -> Option 'Https -- ^ Auth 'Option'
1359−oAuth2Token token = customAuth
1360− (pure . attachHeader "Authorization" ("token " <> token))
1677+oAuth2Token ::
1678+ -- | Token
1679+ ByteString ->
1680+ -- | Auth 'Option'
1681+ Option 'Https
1682+oAuth2Token token =
1683+ customAuth
1684+ (pure . attachHeader "Authorization" ("token " <> token))
13611685
13621686-- | A helper to create custom authentication 'Option's. The given
13631687-- 'IO'-enabled request transformation is applied after all other
13641688-- modifications when constructing a request. Use wisely.
13651689--
13661690-- @since 1.1.0
1367−
13681691customAuth :: (L.Request -> IO L.Request) -> Option scheme
13691692customAuth = Option mempty . pure
13701693
@@ -1373,11 +1696,10 @@ customAuth = Option mempty . pure
13731696
13741697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
13751698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1376−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1377−
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
13781700port :: Int -> Option scheme
13791701port n = withRequest $ \x ->
1380− x { L.port = n }
1702+ x {L.port = n}
13811703
13821704-- | This 'Option' controls whether gzipped data should be decompressed on
13831705-- the fly. By default everything except for @\"application\/x-tar\"@ is
@@ -1388,39 +1710,40 @@ port n = withRequest $ \x ->
13881710-- You can also choose to decompress everything like this:
13891711--
13901712-- > decompress (const True)
1391−
1392−decompress
1393− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1394− -- returns 'True' when content should be decompressed on the fly.
1395− -> Option scheme
1713+decompress ::
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1715+ -- should be decompressed on the fly.
1716+ (ByteString -> Bool) ->
1717+ Option scheme
13961718decompress f = withRequest $ \x ->
1397− x { L.decompress = f }
1719+ x {L.decompress = f}
13981720
13991721-- | Specify the number of microseconds to wait for response. The default
14001722-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
14011723-- 'L.Manager').
1402−
1403−responseTimeout
1404− :: Int -- ^ Number of microseconds to wait
1405− -> Option scheme
1724+responseTimeout ::
1725+ -- | Number of microseconds to wait
1726+ Int ->
1727+ Option scheme
14061728responseTimeout n = withRequest $ \x ->
1407− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
14081730
14091731-- | HTTP version to send to the server, the default is HTTP 1.1.
1410−
1411−httpVersion
1412− :: Int -- ^ Major version number
1413− -> Int -- ^ Minor version number
1414− -> Option scheme
1732+httpVersion ::
1733+ -- | Major version number
1734+ Int ->
1735+ -- | Minor version number
1736+ Int ->
1737+ Option scheme
14151738httpVersion major minor = withRequest $ \x ->
1416− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
14171740
14181741----------------------------------------------------------------------------
14191742-- Response interpretations
14201743
14211744-- | Make a request and ignore the body of the response.
1422−
14231745newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
14241747
14251748instance HttpResponse IgnoreResponse where
14261749 type HttpResponseBody IgnoreResponse = ()
@@ -1429,7 +1752,6 @@ instance HttpResponse IgnoreResponse where
14291752
14301753-- | Use this as the fourth argument of 'req' to specify that you want it to
14311754-- ignore the response body.
1432−
14331755ignoreResponse :: Proxy IgnoreResponse
14341756ignoreResponse = Proxy
14351757
@@ -1437,28 +1759,28 @@ ignoreResponse = Proxy
14371759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
14381760-- monad in which you use 'req' will determine what to do in the case when
14391761-- parsing fails (the 'JsonHttpException' constructor will be used).
1440−
14411762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
14421764
1443−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
14441766 type HttpResponseBody (JsonResponse a) = a
14451767 toVanillaResponse (JsonResponse r) = r
14461768 getHttpResponse r = do
14471769 chunks <- L.brConsume (L.responseBody r)
14481770 case A.eitherDecode (BL.fromChunks chunks) of
1449− Left e -> throwIO (JsonHttpException e)
1771+ Left e -> throwIO (JsonHttpException e)
14501772 Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
14511774
14521775-- | Use this as the fourth argument of 'req' to specify that you want it to
14531776-- return the 'JsonResponse' interpretation.
1454−
14551777jsonResponse :: Proxy (JsonResponse a)
14561778jsonResponse = Proxy
14571779
14581780-- | Make a request and interpret the body of the response as a strict
14591781-- 'ByteString'.
1460−
14611782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
14621784
14631785instance HttpResponse BsResponse where
14641786 type HttpResponseBody BsResponse = ByteString
@@ -1469,14 +1791,13 @@ instance HttpResponse BsResponse where
14691791
14701792-- | Use this as the fourth argument of 'req' to specify that you want to
14711793-- interpret the response body as a strict 'ByteString'.
1472−
14731794bsResponse :: Proxy BsResponse
14741795bsResponse = Proxy
14751796
14761797-- | Make a request and interpret the body of the response as a lazy
14771798-- 'BL.ByteString'.
1478−
14791799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
14801801
14811802instance HttpResponse LbsResponse where
14821803 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1487,24 +1808,22 @@ instance HttpResponse LbsResponse where
14871808
14881809-- | Use this as the fourth argument of 'req' to specify that you want to
14891810-- interpret the response body as a lazy 'BL.ByteString'.
1490−
14911811lbsResponse :: Proxy LbsResponse
14921812lbsResponse = Proxy
14931813
14941814----------------------------------------------------------------------------
14951815-- Helpers for response interpretations
14961816
1497−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
14981818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
14991819-- such.
1500−
1501−grabPreview
1502− :: Int
1503− -- ^ How many bytes to fetch
1504− -> L.Response L.BodyReader
1505− -- ^ Response with body reader inside
1506− -> IO (ByteString, L.Response L.BodyReader)
1507− -- ^ Preview 'ByteString' and new response with body reader inside
1820+grabPreview ::
1821+ -- | How many bytes to fetch
1822+ Int ->
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)
15081827grabPreview nbytes r = do
15091828 let br = L.responseBody r
15101829 (target, leftover, done) <- brReadN br nbytes
@@ -1527,18 +1846,17 @@ grabPreview nbytes r = do
15271846 if done
15281847 then return B.empty
15291848 else br
1530− return (target, r { L.responseBody = br' })
1849+ return (target, r {L.responseBody = br'})
15311850
15321851-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
15331852-- leftover (may be empty), and whether we're done consuming the body.
1534−
1535−brReadN
1536− :: L.BodyReader
1537− -- ^ Body reader to stream from
1538− -> Int
1539− -- ^ How many bytes to consume
1540− -> IO (ByteString, ByteString, Bool)
1541− -- ^ Target chunk, the leftover, whether we're done
1853+brReadN ::
1854+ -- | Body reader to stream from
1855+ L.BodyReader ->
1856+ -- | How many bytes to consume
1857+ Int ->
1858+ -- | Target chunk, the leftover, whether we're done
1859+ IO (ByteString, ByteString, Bool)
15421860brReadN br n = go 0 id id
15431861 where
15441862 go !tlen t l = do
@@ -1547,9 +1865,9 @@ brReadN br n = go 0 id id
15471865 then return (r t, r l, True)
15481866 else do
15491867 let (target, leftover) = B.splitAt (n - tlen) chunk
1550− tlen' = B.length target
1551− t' = t . (target:)
1552− l' = l . (leftover:)
1868+ tlen' = B.length target
1869+ t' = t . (target :)
1870+ l' = l . (leftover :)
15531871 if tlen + tlen' < n
15541872 then go (tlen + tlen') t' l'
15551873 else return (r t', r l', False)
@@ -1559,47 +1877,45 @@ brReadN br n = go 0 id id
15591877-- Inspecting a response
15601878
15611879-- | Get the response body.
1562−
1563−responseBody
1564− :: HttpResponse response
1565− => response
1566− -> HttpResponseBody response
1880+responseBody ::
1881+ (HttpResponse response) =>
1882+ response ->
1883+ HttpResponseBody response
15671884responseBody = L.responseBody . toVanillaResponse
15681885
15691886-- | Get the response status code.
1570−
1571−responseStatusCode
1572− :: HttpResponse response
1573− => response
1574− -> Int
1887+responseStatusCode ::
1888+ (HttpResponse response) =>
1889+ response ->
1890+ Int
15751891responseStatusCode =
15761892 Y.statusCode . L.responseStatus . toVanillaResponse
15771893
15781894-- | Get the response status message.
1579−
1580−responseStatusMessage
1581− :: HttpResponse response
1582− => response
1583− -> ByteString
1895+responseStatusMessage ::
1896+ (HttpResponse response) =>
1897+ response ->
1898+ ByteString
15841899responseStatusMessage =
15851900 Y.statusMessage . L.responseStatus . toVanillaResponse
15861901
15871902-- | Lookup a particular header from a response.
1588−
1589−responseHeader
1590− :: HttpResponse response
1591− => response -- ^ Response interpretation
1592− -> ByteString -- ^ Header to lookup
1593− -> Maybe ByteString -- ^ Header value if found
1903+responseHeader ::
1904+ (HttpResponse response) =>
1905+ -- | Response interpretation
1906+ response ->
1907+ -- | Header to lookup
1908+ ByteString ->
1909+ -- | Header value if found
1910+ Maybe ByteString
15941911responseHeader r h =
15951912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
15961913
15971914-- | Get the response 'L.CookieJar'.
1598−
1599−responseCookieJar
1600− :: HttpResponse response
1601− => response
1602− -> L.CookieJar
1915+responseCookieJar ::
1916+ (HttpResponse response) =>
1917+ response ->
1918+ L.CookieJar
16031919responseCookieJar = L.responseCookieJar . toVanillaResponse
16041920
16051921----------------------------------------------------------------------------
@@ -1610,19 +1926,15 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
16101926-- To create a new response interpretation you just need to make your data
16111927-- type an instance of the 'HttpResponse' type class.
16121928
1613−-- | A type class for response interpretations. It allows to describe how to
1614−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1615−-- final result that is to be returned to the user.
1616−
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.
16171932class HttpResponse response where
1618−
16191933 -- | The associated type is the type of body that can be extracted from an
16201934 -- instance of 'HttpResponse'.
1621−
1622− type HttpResponseBody response :: *
1935+ type HttpResponseBody response :: Type
16231936
16241937 -- | The method describes how to get the underlying 'L.Response' record.
1625−
16261938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
16271939
16281940 -- | This method describes how to consume response body and, more
@@ -1638,12 +1950,32 @@ class HttpResponse response where
16381950 --
16391951 -- __Note__: signature of this function was changed in the version
16401952 -- /1.0.0/.
1953+ getHttpResponse ::
1954+ -- | Response with body reader inside
1955+ L.Response L.BodyReader ->
1956+ -- | The final result
1957+ IO response
1958+
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.
1962+ --
1963+ -- __Note__: manually specified 'Options' that set the @\"Accept\"@ header
1964+ -- will take precedence.
1965+ --
1966+ -- @since 2.1.0
1967+ acceptHeader :: Proxy response -> Maybe ByteString
1968+ acceptHeader Proxy = Nothing
16411969
1642− getHttpResponse
1643− :: L.Response L.BodyReader
1644− -- ^ Response with body reader inside
1645− -> IO response
1646− -- ^ The final result
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1972+-- etc.
1973+--
1974+-- @since 3.12.0
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
16471979
16481980----------------------------------------------------------------------------
16491981-- Other
@@ -1655,15 +1987,12 @@ class HttpResponse response where
16551987-- request components easier using @('<>')@.
16561988--
16571989-- __Note__: this type class is not a part of the public API.
1658−
16591990class RequestComponent a where
1660−
16611991 -- | Get a function that takes a 'L.Request' and changes it somehow
16621992 -- returning another 'L.Request'. For example, the 'HttpMethod' instance
16631993 -- of 'RequestComponent' just overwrites method. The function is wrapped
16641994 -- in 'Endo' so it's easier to chain such “modifying applications”
16651995 -- together building bigger and bigger 'RequestComponent's.
1666−
16671996 getRequestMod :: a -> Endo L.Request
16681997
16691998-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -1673,44 +2002,50 @@ class RequestComponent a where
16732002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
16742003-- which instance to use (i.e. the constraints are taken into account later,
16752004-- when instance is already chosen).
1676−
1677−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
16782006
16792007-- | Exceptions that this library throws.
1680−
16812008data HttpException
1682− = VanillaHttpException L.HttpException
1683− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1684− | JsonHttpException String
1685− -- ^ A wrapper with Aeson-produced 'String' describing why decoding
2009+ = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2010+ VanillaHttpException L.HttpException
2011+ | -- | A wrapper with Aeson-produced 'String' describing why decoding
16862012 -- failed
1687− deriving (Show, Typeable, Generic)
2013+ JsonHttpException String
2014+ deriving (Show, Generic)
16882015
16892016instance Exception HttpException
16902017
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2020+--
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2026+ _
2027+ (L.StatusCodeException r _)
2028+ )
2029+ ) = Just r
2030+isStatusCodeException _ = Nothing
2031+
16912032-- | A simple type isomorphic to 'Bool' that we only have for better error
16922033-- messages. We use it as a kind and its data constructors as type-level
16932034-- tags.
16942035--
16952036-- See also: 'HttpMethod' and 'HttpBody'.
1696−
16972037data CanHaveBody
1698− = CanHaveBody -- ^ Indeed can have a body
1699− | NoBody -- ^ Should not have a body
2038+ = -- | Indeed can have a body
2039+ CanHaveBody
2040+ | -- | Should not have a body
2041+ NoBody
17002042
17012043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
17022044-- enabled). This is used to force TLS requirement for some authentication
17032045-- 'Option's.
1704−
17052046data Scheme
1706− = Http -- ^ HTTP
1707− | Https -- ^ HTTPS
1708− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1709−
1710−----------------------------------------------------------------------------
1711−-- Constants
1712−
1713−-- | Max length of preview fragment of response body.
1714−
1715−bodyPreviewLength :: Num a => a
1716−bodyPreviewLength = 1024
2047+ = -- | HTTP
2048+ Http
2049+ | -- | HTTPS
2050+ Https
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)