@@ -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 a 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 a 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 a user extends the library to satisfy his\/her special
54−-- needs, the new solutions will work just like the built-ins. However, all
55−-- of the common cases are also covered by the library out-of-the-box.
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 boilerplate down
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,180 +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
121− -- * Embedding requests into your monad
82+ req,
83+ reqBr,
84+ reqCb,
85+ req',
86+ withReqManager,
87+
88+ -- * 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
113+ Url,
114+ http,
115+ https,
116+ (/~),
117+ (/:),
118+ useHttpURI,
119+ useHttpsURI,
120+ useURI,
121+ urlQ,
122+ renderUrl,
123+
149124 -- ** Body
150125 -- $body
151− , NoReqBody (..)
152− , ReqBodyJson (..)
153− , ReqBodyFile (..)
154− , ReqBodyBs (..)
155− , ReqBodyLbs (..)
156− , ReqBodyUrlEnc (..)
157− , FormUrlEncodedParam
158− , ReqBodyMultipart
159− , reqBodyMultipart
160− , HttpBody (..)
161− , ProvidesBody
162− , 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+
163139 -- ** Optional parameters
164140 -- $optional-parameters
165− , Option
141+ Option,
142+
166143 -- *** Query parameters
167144 -- $query-parameters
168− , (=:)
169− , queryFlag
170− , QueryParam (..)
145+ (=:),
146+ queryFlag,
147+ formToQuery,
148+ QueryParam (..),
149+
171150 -- *** Headers
172− , header
173− , attachHeader
151+ header,
152+ attachHeader,
153+ headerRedacted,
154+
174155 -- *** Cookies
175156 -- $cookies
176− , cookieJar
157+ cookieJar,
158+
177159 -- *** Authentication
178160 -- $authentication
179− , basicAuth
180− , basicAuthUnsafe
181− , basicProxyAuth
182− , oAuth1
183− , oAuth2Bearer
184− , oAuth2Token
185− , customAuth
161+ basicAuth,
162+ basicAuthUnsafe,
163+ basicProxyAuth,
164+ oAuth1,
165+ oAuth2Bearer,
166+ oAuth2Token,
167+ customAuth,
168+
186169 -- *** Other
187− , port
188− , decompress
189− , responseTimeout
190− , httpVersion
170+ port,
171+ decompress,
172+ responseTimeout,
173+ httpVersion,
174+
191175 -- * Response
176+
192177 -- ** Response interpretations
193− , IgnoreResponse
194− , ignoreResponse
195− , JsonResponse
196− , jsonResponse
197− , BsResponse
198− , bsResponse
199− , LbsResponse
200− , lbsResponse
178+ IgnoreResponse,
179+ ignoreResponse,
180+ JsonResponse,
181+ jsonResponse,
182+ BsResponse,
183+ bsResponse,
184+ LbsResponse,
185+ lbsResponse,
186+
201187 -- ** Inspecting a response
202− , responseBody
203− , responseStatusCode
204− , responseStatusMessage
205− , responseHeader
206− , responseCookieJar
188+ responseBody,
189+ responseStatusCode,
190+ responseStatusMessage,
191+ responseHeader,
192+ responseCookieJar,
193+
207194 -- ** Defining your own interpretation
208195 -- $new-response-interpretation
209− , HttpResponse (..)
196+ HttpResponse (..),
197+
210198 -- * Other
211− , HttpException (..)
212− , CanHaveBody (..)
213− , Scheme (..) )
199+ HttpException (..),
200+ isStatusCodeException,
201+ CanHaveBody (..),
202+ Scheme (..),
203+ )
214204where
215205
206+import Blaze.ByteString.Builder qualified as BB
216207import Control.Applicative
217208import Control.Arrow (first, second)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
218211import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
219213import Control.Monad.IO.Class
220−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)
221218import 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
222231import Control.Retry
223−import Data.Aeson (ToJSON (..), FromJSON (..))
232+import Data.Aeson (FromJSON (..), ToJSON (..))
233+import Data.Aeson qualified as A
224234import 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
225238import Data.Data (Data)
226−import Data.Default.Class
239+import Data.Default.Class (def)
227240import Data.Function (on)
228241import Data.IORef
229−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
230244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
231246import Data.Maybe (fromMaybe)
232247import Data.Proxy
233−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
234250import Data.Text (Text)
235−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)
236254import GHC.Generics
237255import 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
238265import 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
239272import Web.HttpApiData (ToHttpApiData (..))
240−import qualified Blaze.ByteString.Builder as BB
241−import qualified Data.Aeson as A
242−import qualified Data.ByteString as B
243−import qualified Data.ByteString.Lazy as BL
244−import qualified Data.CaseInsensitive as CI
245−import qualified Data.List.NonEmpty as NE
246−import qualified Data.Text as T
247−import qualified Data.Text.Encoding as T
248−import qualified Data.Text.Read as TR
249−import qualified Network.Connection as NC
250−import qualified Network.HTTP.Client as L
251−import qualified Network.HTTP.Client.Internal as LI
252−import qualified Network.HTTP.Client.MultipartFormData as LM
253−import qualified Network.HTTP.Client.TLS as L
254−import qualified Network.HTTP.Types as Y
255−import qualified Web.Authenticate.OAuth as OAuth
256−
257−#if MIN_VERSION_base(4,9,0)
258−import Control.Exception hiding (TypeError)
259−import Data.Kind (Constraint)
260−#else
261−import Control.Exception
262−import GHC.Exts (Constraint)
263−#endif
264273
265274----------------------------------------------------------------------------
266275-- Making a request
@@ -284,7 +293,7 @@ import GHC.Exts (Constraint)
284293--
285294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
286295-- tutorial has a section about HTTP bodies, but usage is very
287−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
288297--
289298-- @response@ is a type hint how to make and interpret response of an HTTP
290299-- request. Out-of-the-box it can be the following:
@@ -310,6 +319,7 @@ import GHC.Exts (Constraint)
310319-- First, this is a piece of boilerplate that should be in place before you
311320-- try the examples:
312321--
322+-- > {-# LANGUAGE DeriveGeneric #-}
313323-- > {-# LANGUAGE OverloadedStrings #-}
314324-- >
315325-- > module Main (main) where
@@ -317,20 +327,20 @@ import GHC.Exts (Constraint)
317327-- > import Control.Monad
318328-- > import Control.Monad.IO.Class
319329-- > import Data.Aeson
320−-- > import Data.Default.Class
321330-- > import Data.Maybe (fromJust)
322331-- > import Data.Monoid ((<>))
323332-- > import Data.Text (Text)
324333-- > import GHC.Generics
325334-- > import Network.HTTP.Req
326335-- > import qualified Data.ByteString.Char8 as B
336+-- > import qualified Text.URI as URI
327337--
328338-- We will be making requests against the <https://httpbin.org> service.
329339--
330340-- Make a GET request, grab 5 random bytes:
331341--
332342-- > main :: IO ()
333−-- > main = runReq def $ do
343+-- > main = runReq defaultHttpConfig $ do
334344-- > let n :: Int
335345-- > n = 5
336346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
@@ -340,7 +350,7 @@ import GHC.Exts (Constraint)
340350-- seed of the generator:
341351--
342352-- > main :: IO ()
343−-- > main = runReq def $ do
353+-- > main = runReq defaultHttpConfig $ do
344354-- > let n, seed :: Int
345355-- > n = 5
346356-- > seed = 100
@@ -359,7 +369,7 @@ import GHC.Exts (Constraint)
359369-- > instance FromJSON MyData
360370-- >
361371-- > main :: IO ()
362−-- > main = runReq def $ do
372+-- > main = runReq defaultHttpConfig $ do
363373-- > let myData = MyData
364374-- > { size = 6
365375-- > , color = "Green" }
@@ -369,7 +379,7 @@ import GHC.Exts (Constraint)
369379-- Sending URL-encoded body:
370380--
371381-- > main :: IO ()
372−-- > main = runReq def $ do
382+-- > main = runReq defaultHttpConfig $ do
373383-- > let params =
374384-- > "foo" =: ("bar" :: Text) <>
375385-- > queryFlag "baz"
@@ -379,10 +389,11 @@ import GHC.Exts (Constraint)
379389-- Using various optional parameters and URL that is not known in advance:
380390--
381391-- > main :: IO ()
382−-- > main = runReq def $ do
392+-- > main = runReq defaultHttpConfig $ do
383393-- > -- This is an example of what to do when URL is given dynamically. Of
384394-- > -- course in a real application you may not want to use 'fromJust'.
385−-- > 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)
386397-- > response <- req GET url NoReqBody jsonResponse $
387398-- > "from" =: (15 :: Int) <>
388399-- > "to" =: (67 :: Int) <>
@@ -390,60 +401,138 @@ import GHC.Exts (Constraint)
390401-- > options <> -- contains the ?foo=bar part
391402-- > port 443 -- here you can put any port of course
392403-- > liftIO $ print (responseBody response :: Value)
393−
394−req
395− :: ( MonadHttp m
396− , HttpMethod method
397− , HttpBody body
398− , HttpResponse response
399− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
400− => method -- ^ HTTP method
401− -> Url scheme -- ^ 'Url'—location of resource
402− -> body -- ^ Body of the request
403− -> Proxy response -- ^ A hint how to interpret response
404− -> Option scheme -- ^ Collection of optional parameters
405− -> m response -- ^ Response
406−req method url body Proxy options =
407− 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
408425
409426-- | A version of 'req' that does not use one of the predefined instances of
410427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
411428-- 'L.BodyReader'@ manually, in a custom way.
412429--
413430-- @since 1.0.0
414−
415−reqBr
416− :: ( MonadHttp m
417− , HttpMethod method
418− , HttpBody body
419− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
420− => method -- ^ HTTP method
421− -> Url scheme -- ^ 'Url'—location of resource
422− -> body -- ^ Body of the request
423− -> Option scheme -- ^ Collection of optional parameters
424− -> (L.Response L.BodyReader -> IO a) -- ^ How to consume response
425− -> m a -- ^ Result
426−reqBr method url body options consume = req' method url body options $ \request manager -> do
427− 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
428502 let wrapVanilla = handle (throwIO . VanillaHttpException)
429− wrapExc = handle (throwIO . LI.toHttpException request)
430− withRRef = bracket
431− (newIORef Nothing)
432− (readIORef >=> mapM_ L.responseClose)
433− (liftIO . try . wrapVanilla . wrapExc) (withRRef $ \rref -> do
434− let openResponse = mask_ $ do
435− r <- readIORef rref
436− mapM_ L.responseClose r
437− r' <- L.responseOpen request manager
438− writeIORef rref (Just r')
439− return r'
440− r <- retrying
441− httpConfigRetryPolicy
442− (\st r -> return $ httpConfigRetryJudge st r)
443− (const openResponse)
444− (preview, r') <- grabPreview bodyPreviewLength r
445− mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
446− 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+ )
447536 >>= either handleHttpException return
448537
449538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
@@ -454,51 +543,57 @@ reqBr method url body options consume = req' method url body options $ \request
454543-- 'L.Request' and allows you to use it.
455544--
456545-- @since 0.3.0
457−
458−req'
459− :: forall m method body scheme a.
460− ( MonadHttp m
461− , HttpMethod method
462− , HttpBody body
463− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
464− => method -- ^ HTTP method
465− -> Url scheme -- ^ 'Url'—location of resource
466− -> body -- ^ Body of the request
467− -> Option scheme -- ^ Collection of optional parameters
468− -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
469− -> 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
470565req' method url body options m = do
471− config@HttpConfig {..} <- getHttpConfig
566+ config <- getHttpConfig
472567 let -- NOTE First appearance of any given header wins. This allows to
473568 -- “overwrite” headers when we construct a request by cons-ing.
474569 nubHeaders = Endo $ \x ->
475− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
476− request' = flip appEndo L.defaultRequest $
477− -- NOTE The order of 'mappend's matters, here method is overwritten
478− -- first and 'options' take effect last. In particular, this means
479− -- that 'options' can overwrite things set by other request
480− -- components, which is useful for setting port number,
481− -- "Content-Type" header, etc.
482− nubHeaders <>
483− getRequestMod options <>
484− getRequestMod config <>
485− getRequestMod (Womb body :: Womb "body" body) <>
486− getRequestMod url <>
487− 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)
488584 request <- finalizeRequest options request'
489585 withReqManager (m request)
490586
491587-- | Perform an action using the global implicit 'L.Manager' that the rest
492−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
493589-- 'L.Manager' controls.
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
494592
495−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
496−withReqManager m = liftIO (readIORef globalManager) >>= m
497−
498−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
499−-- settings, so users don't need to deal with this manager stuff at all, but
500−-- when we create a request, instance 'HttpConfig' can affect the default
501−-- 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'.
502597--
503598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
504599-- The value of 'globalManager' is named and lives on top level. This means
@@ -506,17 +601,20 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
506601-- manager. From that moment on the 'IORef' will be just reused—exactly the
507602-- behavior we want here in order to maximize connection sharing. GHC could
508603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
509−
510−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
511605globalManager = unsafePerformIO $ do
512606 context <- NC.initConnectionContext
513− let settings = L.mkManagerSettingsContext (Just context) def Nothing
607+ let settings =
608+ L.mkManagerSettingsContext
609+ (Just context)
610+ def
611+ Nothing
514612 manager <- L.newManager settings
515− newIORef manager
613+ return manager
516614{-# NOINLINE globalManager #-}
517615
518616----------------------------------------------------------------------------
519−-- Embedding requests into your monad
617+-- Embedding requests in your monad
520618
521619-- $embedding-requests
522620--
@@ -525,56 +623,44 @@ globalManager = unsafePerformIO $ do
525623--
526624-- When writing a library, keep your API polymorphic in terms of
527625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
528−-- Another option is to use @newtype@ wrapped monad stack and define
529−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
530−-- this strategy is provided out-of-the-box (see below).
626+-- Another option is to use a @newtype@-wrapped monad stack and define
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).
531629
532630-- | A type class for monads that support performing HTTP requests.
533631-- Typically, you only need to define the 'handleHttpException' method
534632-- unless you want to tweak 'HttpConfig'.
535−
536−class MonadIO m => MonadHttp m where
537−
633+class (MonadIO m) => MonadHttp m where
538634 -- | This method describes how to deal with 'HttpException' that was
539635 -- caught by the library. One option is to re-throw it if you are OK with
540636 -- exceptions, but if you prefer working with something like
541637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
542638 -- 'Control.Monad.Except.throwError'.
543−
544639 handleHttpException :: HttpException -> m a
545640
546− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
547− -- implementation returns its 'def' value, which is described in the
548− -- documentation for the type. Common usage pattern with manually defined
549− -- '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
550645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
551646 -- approach to configuration is desirable.
552−
553647 getHttpConfig :: m HttpConfig
554− getHttpConfig = return def
555−
556−-- | 'HttpConfig' contains general and default settings to be used when
557−-- making HTTP requests.
648+ getHttpConfig = return defaultHttpConfig
558649
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
559651data HttpConfig = HttpConfig
560− { httpConfigProxy :: Maybe L.Proxy
561− -- ^ 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@
562653 -- environment variables are respected, this setting overwrites them.
563654 -- Default value: 'Nothing'.
564− , httpConfigRedirectCount :: Int
565− -- ^ 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
566657 -- value: 10.
567− , httpConfigAltManager :: Maybe L.Manager
568− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
658+ httpConfigRedirectCount :: Int,
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
569660 -- that the default implicit manager will be used (that's what you want
570661 -- in 99% of cases).
571− , httpConfigCheckResponse
572− :: forall b.
573− L.Request
574− -> L.Response b
575− -> ByteString
576− -> Maybe L.HttpExceptionContent
577− -- ^ Function to check the response immediately after receiving the
662+ httpConfigAltManager :: Maybe L.Manager,
663+ -- | Function to check the response immediately after receiving the
578664 -- status and headers, before streaming of response body. The third
579665 -- argument is the beginning of response body (typically first 1024
580666 -- bytes). This is used for throwing exceptions on non-success status
@@ -596,63 +682,106 @@ data HttpConfig = HttpConfig
596682 -- /1.0.0/.
597683 --
598684 -- @since 0.3.0
599− , httpConfigRetryPolicy :: RetryPolicy
600− -- ^ 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
601692 -- used (see 'RetryPolicyM').
602693 --
603− -- __Note__: signature of this function was changed in the version
604− -- /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/.
605696 --
606697 -- @since 0.3.0
607− , httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
608− -- ^ 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'
609700 -- means that the request should be retried.
610701 --
611702 -- __Note__: signature of this function was changed in the version
612703 -- /1.0.0/.
613704 --
614705 -- @since 0.3.0
615− } deriving Typeable
616−
617−instance Default HttpConfig where
618− def = HttpConfig
619− { httpConfigProxy = Nothing
620− , httpConfigRedirectCount = 10
621− , httpConfigAltManager = Nothing
622− , 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 ->
623730 let scode = statusCode response
624− in if 200 <= scode && scode < 300
625− then Nothing
626− else Just (L.StatusCodeException (void response) preview)
627− , httpConfigRetryPolicy = def
628− , httpConfigRetryJudge = \_ response ->
629− statusCode response `elem`
630− [ 408 -- Request timeout
631− , 504 -- Gateway timeout
632− , 524 -- A timeout occurred
633− , 598 -- (Informal convention) Network read timeout error
634− , 599 -- (Informal convention) Network connect timeout error
635− ]
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
636752 }
637− where
638− statusCode = Y.statusCode . L.responseStatus
753+ where
754+ statusCode = Y.statusCode . L.responseStatus
639755
640756instance RequestComponent HttpConfig where
641757 getRequestMod HttpConfig {..} = Endo $ \x ->
642− x { L.proxy = httpConfigProxy
643− , L.redirectCount = httpConfigRedirectCount
644− , LI.requestManagerOverride = httpConfigAltManager }
758+ x
759+ { L.proxy = httpConfigProxy,
760+ L.redirectCount = httpConfigRedirectCount,
761+ LI.requestManagerOverride = httpConfigAltManager
762+ }
645763
646−-- | 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
647765-- having to define new instances.
648766--
649767-- @since 0.4.0
650−
651768newtype Req a = Req (ReaderT HttpConfig IO a)
652− deriving ( Functor
653− , Applicative
654− , Monad
655− , 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
656785
657786instance MonadBase IO Req where
658787 liftBase = liftIO
@@ -661,22 +790,99 @@ instance MonadBaseControl IO Req where
661790 type StM Req a = a
662791 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
663792 {-# INLINEABLE liftBaseWith #-}
664− restoreM = Req . ReaderT . const . return
793+ restoreM = Req . ReaderT . const . return
665794 {-# INLINEABLE restoreM #-}
666795
667796instance MonadHttp Req where
668797 handleHttpException = Req . lift . throwIO
669− 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
670874
671875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
672−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
673877--
674878-- @since 0.4.0
675−
676−runReq :: MonadIO m
677− => HttpConfig -- ^ 'HttpConfig' to use
678− -> Req a -- ^ Computation to run
679− -> m a
879+runReq ::
880+ (MonadIO m) =>
881+ -- | 'HttpConfig' to use
882+ HttpConfig ->
883+ -- | Computation to run
884+ Req a ->
885+ m a
680886runReq config (Req m) = liftIO (runReaderT m config)
681887
682888----------------------------------------------------------------------------
@@ -692,7 +898,6 @@ runReq config (Req m) = liftIO (runReaderT m config)
692898-- define a new method that will works seamlessly, see 'HttpMethod'.
693899
694900-- | 'GET' method.
695−
696901data GET = GET
697902
698903instance HttpMethod GET where
@@ -700,7 +905,6 @@ instance HttpMethod GET where
700905 httpMethodName Proxy = Y.methodGet
701906
702907-- | 'POST' method.
703−
704908data POST = POST
705909
706910instance HttpMethod POST where
@@ -708,7 +912,6 @@ instance HttpMethod POST where
708912 httpMethodName Proxy = Y.methodPost
709913
710914-- | 'HEAD' method.
711−
712915data HEAD = HEAD
713916
714917instance HttpMethod HEAD where
@@ -716,26 +919,24 @@ instance HttpMethod HEAD where
716919 httpMethodName Proxy = Y.methodHead
717920
718921-- | 'PUT' method.
719−
720922data PUT = PUT
721923
722924instance HttpMethod PUT where
723925 type AllowsBody PUT = 'CanHaveBody
724926 httpMethodName Proxy = Y.methodPut
725927
726−-- | 'DELETE' method. This data type does not allow having request body with
727−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
728−-- requests to have bodies, in that case define your own variation of
729−-- 'DELETE' method and allow it to have a body.
730−
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.
731933data DELETE = DELETE
732934
733935instance HttpMethod DELETE where
734− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
735937 httpMethodName Proxy = Y.methodDelete
736938
737939-- | 'TRACE' method.
738−
739940data TRACE = TRACE
740941
741942instance HttpMethod TRACE where
@@ -743,7 +944,6 @@ instance HttpMethod TRACE where
743944 httpMethodName Proxy = Y.methodTrace
744945
745946-- | 'CONNECT' method.
746−
747947data CONNECT = CONNECT
748948
749949instance HttpMethod CONNECT where
@@ -751,7 +951,6 @@ instance HttpMethod CONNECT where
751951 httpMethodName Proxy = Y.methodConnect
752952
753953-- | 'OPTIONS' method.
754−
755954data OPTIONS = OPTIONS
756955
757956instance HttpMethod OPTIONS where
@@ -759,7 +958,6 @@ instance HttpMethod OPTIONS where
759958 httpMethodName Proxy = Y.methodOptions
760959
761960-- | 'PATCH' method.
762−
763961data PATCH = PATCH
764962
765963instance HttpMethod PATCH where
@@ -774,23 +972,19 @@ instance HttpMethod PATCH where
774972-- > instance HttpMethod COPY where
775973-- > type AllowsBody COPY = 'CanHaveBody
776974-- > httpMethodName Proxy = "COPY"
777−
778975class HttpMethod a where
779−
780976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
781− -- tells the rest of the library whether the method can have a body or
782− -- not. We use the special type 'CanHaveBody' lifted to the kind level
783− -- instead of 'Bool' to get more user-friendly compiler messages.
784−
977+ -- tells the rest of the library whether the method can have body or not.
978+ -- We use the special type 'CanHaveBody' lifted to the kind level instead
979+ -- of 'Bool' to get more user-friendly compiler messages.
785980 type AllowsBody a :: CanHaveBody
786981
787982 -- | Return name of the method as a 'ByteString'.
788−
789983 httpMethodName :: Proxy a -> ByteString
790984
791−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
792986 getRequestMod _ = Endo $ \x ->
793− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
794988
795989----------------------------------------------------------------------------
796990-- Request—URL
@@ -798,7 +992,7 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
798992-- $url
799993--
800994-- We use 'Url's which are correct by construction, see 'Url'. To build a
801−-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
802996
803997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
804998-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -828,91 +1022,194 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8281022--
8291023-- > https "юникод.рф"
8301024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
831−
8321025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8331026 -- NOTE The second value is the path segments in reversed order.
834− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
8351028
836−-- | Given host name, produce a 'Url' which have “http” as its scheme and
837−-- empty path. This also sets port to @80@.
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
8381041
1042+-- | Given host name, produce a 'Url' which has “http” as its scheme and
1043+-- empty path. This also sets port to @80@.
8391044http :: Text -> Url 'Http
8401045http = Url Http . pure
8411046
842−-- | Given host name, produce a 'Url' which have “https” as its scheme and
1047+-- | Given host name, produce a 'Url' which has “https” as its scheme and
8431048-- empty path. This also sets port to @443@.
844−
8451049https :: Text -> Url 'Https
8461050https = Url Https . pure
8471051
848−-- | 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
8491053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
850−
8511054infixl 5 /~
852−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
853−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
8541055
855−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
856−-- 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)
8571058
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
8581061infixl 5 /:
1062+
8591063(/:) :: Url scheme -> Text -> Url scheme
8601064(/:) = (/~)
8611065
862−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
863−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
864−-- you are given a URL to query dynamically and don't know it beforehand.
865−-- The function parses 'ByteString' because it's the correct type to
866−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
867−-- range, thus we can consider every character a 'Data.Word.Word8' value.
868−--
869−-- This function only parses 'Url' (scheme, host, path) and optional query
870−-- parameters that are returned as 'Option'. It does not parse method name
871−-- or authentication info from given 'ByteString'.
872−
873−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
874−parseUrlHttp url' = do
875− url <- B.stripPrefix "http://" url'
876− (host :| path, option) <- parseUrlHelper url
877− return (foldl (/:) (http host) path, option)
878−
879−-- | Just like 'parseUrlHttp', but expects “https” scheme.
880−
881−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
882−parseUrlHttps url' = do
883− url <- B.stripPrefix "https://" url'
884− (host :| path, option) <- parseUrlHelper url
885− return (foldl (/:) (https host) path, option)
886−
887−-- | Get host\/collection of path pieces and possibly query parameters
888−-- already converted to 'Option'. This function is not public.
889−
890−parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
891−parseUrlHelper url = do
892− let (path', query') = B.break (== 0x3f) url
893− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
894− p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
895− (p, port') <-
896− case T.break (== ':') p' of
897− (x, "") -> return (x, mempty)
898− (x, prt) ->
899− case TR.decimal (T.drop 1 prt) of
900− Right (prt',"") -> return (x, port prt')
901− _ -> Nothing
902− 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'')
9031198
9041199instance RequestComponent (Url scheme) where
9051200 getRequestMod (Url scheme segments) = Endo $ \x ->
906− let (host :| path) = NE.reverse segments in
907− x { L.secure = case scheme of
908− Http -> False
909− Https -> True
910− , L.port = case scheme of
911− Http -> 80
912− Https -> 443
913− , L.host = Y.urlEncode False (T.encodeUtf8 host)
914− , L.path =
915− (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+ }
9161213
9171214----------------------------------------------------------------------------
9181215-- Request—Body
@@ -921,39 +1218,37 @@ instance RequestComponent (Url scheme) where
9211218--
9221219-- A number of options for request bodies are available. The @Content-Type@
9231220-- header is set for you automatically according to the body option you use
924−-- (it's always specified in documentation for a given body option). To add
925−-- your own way to represent request body, define an instance of 'HttpBody'.
1221+-- (it's always specified in the documentation for a given body option). To
1222+-- add your own way to represent request body, define an instance of
1223+-- 'HttpBody'.
9261224
9271225-- | This data type represents empty body of an HTTP request. This is the
9281226-- data type to use with 'HttpMethod's that cannot have a body, as it's the
9291227-- only type for which 'ProvidesBody' returns 'NoBody'.
9301228--
9311229-- Using of this body option does not set the @Content-Type@ header.
932−
9331230data NoReqBody = NoReqBody
9341231
9351232instance HttpBody NoReqBody where
9361233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
9371234
938−-- | This body option allows to use a JSON object as request body—probably
939−-- the most popular format right now. Just wrap a data type that is an
940−-- instance of 'ToJSON' type class and you are done: it will be converted to
941−-- 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.
9421239--
9431240-- This body option sets the @Content-Type@ header to @\"application/json;
9441241-- charset=utf-8\"@ value.
945−
9461242newtype ReqBodyJson a = ReqBodyJson a
9471243
948−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
9491245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
9501246 getRequestContentType _ = pure "application/json; charset=utf-8"
9511247
9521248-- | This body option streams request body from a file. It is expected that
953−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
9541250--
9551251-- Using of this body option does not set the @Content-Type@ header.
956−
9571252newtype ReqBodyFile = ReqBodyFile FilePath
9581253
9591254instance HttpBody ReqBodyFile where
@@ -963,7 +1258,6 @@ instance HttpBody ReqBodyFile where
9631258-- | HTTP request body represented by a strict 'ByteString'.
9641259--
9651260-- Using of this body option does not set the @Content-Type@ header.
966−
9671261newtype ReqBodyBs = ReqBodyBs ByteString
9681262
9691263instance HttpBody ReqBodyBs where
@@ -972,22 +1266,19 @@ instance HttpBody ReqBodyBs where
9721266-- | HTTP request body represented by a lazy 'BL.ByteString'.
9731267--
9741268-- Using of this body option does not set the @Content-Type@ header.
975−
9761269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
9771270
9781271instance HttpBody ReqBodyLbs where
9791272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
9801273
981−-- | Form URL-encoded body. This can hold a collection of parameters which
982−-- are encoded similarly to query parameters at the end of query string,
983−-- with the only difference that they are stored in request body. The
984−-- similarity is reflected in the API as well, as you can use the same
985−-- combinators you would use to add query parameters: @('=:')@ and
986−-- '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'.
9871279--
9881280-- This body option sets the @Content-Type@ header to
9891281-- @\"application/x-www-form-urlencoded\"@ value.
990−
9911282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
9921283
9931284instance HttpBody ReqBodyUrlEnc where
@@ -997,13 +1288,19 @@ instance HttpBody ReqBodyUrlEnc where
9971288
9981289-- | An opaque monoidal value that allows to collect URL-encoded parameters
9991290-- to be wrapped in 'ReqBodyUrlEnc'.
1000−
10011291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
10021292 deriving (Semigroup, Monoid)
10031293
10041294instance QueryParam FormUrlEncodedParam where
10051295 queryParam name mvalue =
10061296 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
10071304
10081305-- | Multipart form data. Please consult the
10091306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1033,7 +1330,6 @@ instance QueryParam FormUrlEncodedParam where
10331330-- > bsResponse
10341331-- > mempty
10351332-- > liftIO $ print (responseBody response)
1036−
10371333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
10381334
10391335instance HttpBody ReqBodyMultipart where
@@ -1044,70 +1340,64 @@ instance HttpBody ReqBodyMultipart where
10441340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
10451341--
10461342-- @since 0.2.0
1047−
1048−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
10491344reqBodyMultipart parts = liftIO $ do
10501345 boundary <- LM.webkitBoundary
1051− body <- LM.renderParts boundary parts
1346+ body <- LM.renderParts boundary parts
10521347 return (ReqBodyMultipart boundary body)
10531348
10541349-- | A type class for things that can be interpreted as an HTTP
10551350-- 'L.RequestBody'.
1056−
10571351class HttpBody body where
1058−
10591352 -- | How to get actual 'L.RequestBody'.
1060−
10611353 getRequestBody :: body -> L.RequestBody
10621354
1063− -- | This method allows to optionally specify value of @Content-Type@
1064− -- header that should be used with particular body option. By default it
1065− -- returns 'Nothing' and so @Content-Type@ is not set.
1066−
1355+ -- | This method allows us to optionally specify the value of
1356+ -- @Content-Type@ header that should be used with particular body option.
1357+ -- By default it returns 'Nothing' and so @Content-Type@ is not set.
10671358 getRequestContentType :: body -> Maybe ByteString
10681359 getRequestContentType = const Nothing
10691360
10701361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1071−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
1072−-- 'GET' method and other methods that should not send a body.
1073−
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1363+-- with 'GET' method and other methods that should not have body.
10741364type family ProvidesBody body :: CanHaveBody where
10751365 ProvidesBody NoReqBody = 'NoBody
1076− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
10771367
10781368-- | This type function allows any HTTP body if method says it
10791369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
10801370-- body option to use is 'NoReqBody'.
1081−--
1082−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1083−-- error message when method does not allow a body and body is provided.
1084−
1085−type family HttpBodyAllowed
1086− (allowsBody :: CanHaveBody)
1087− (providesBody :: CanHaveBody) :: Constraint where
1088− HttpBodyAllowed 'NoBody 'NoBody = ()
1089− HttpBodyAllowed 'CanHaveBody body = ()
1090−#if MIN_VERSION_base(4,9,0)
1091− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1092− ('Text "This HTTP method does not allow attaching a request body.")
1093−#endif
1094−
1095−instance HttpBody body => RequestComponent (Womb "body" body) where
1096− getRequestMod (Womb body) = Endo $ \x ->
1097− x { L.requestBody = getRequestBody body
1098− , L.requestHeaders =
1099− let old = L.requestHeaders x in
1100− case getRequestContentType body of
1101− Nothing -> old
1102− Just contentType ->
1103− (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+ }
11041394
11051395----------------------------------------------------------------------------
11061396-- Request—Optional parameters
11071397
11081398-- $optional-parameters
11091399--
1110−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
11111401-- headers, port number, etc. All optional parameters have the type
11121402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
11131403-- the last argument of 'req' to specify no optional parameters, or combine
@@ -1116,46 +1406,51 @@ instance HttpBody body => RequestComponent (Womb "body" body) where
11161406-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
11171407-- of optional parameters like query parameters and headers. See sections
11181408-- 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))
11191411
1120−data Option (scheme :: Scheme) =
1121− Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1122− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1123− -- Request to avoid appending to existing query string in request every
1124− -- time new parameter is added. Additional Maybe (L.Request -> IO
1125− -- L.Request) is a finalizer that will be applied after all other
1126− -- transformations. This is for authentication methods that sign requests
1127− -- 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.
11281418
11291419instance Semigroup (Option scheme) where
1130− Option er0 mr0 <> Option er1 mr1 = Option
1131− (er0 <> er1) (mr0 <|> mr1)
1420+ Option er0 mr0 <> Option er1 mr1 =
1421+ Option
1422+ (er0 <> er1)
1423+ (mr0 <|> mr1)
11321424
11331425instance Monoid (Option scheme) where
1134− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
11351427 mappend = (<>)
11361428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
11371435-- | A helper to create an 'Option' that modifies only collection of query
11381436-- parameters. This helper is not a part of the public API.
1139−
11401437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
11411438withQueryParams f = Option (Endo (first f)) Nothing
11421439
11431440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
11441441-- helper is not a part of public API.
1145−
11461442withRequest :: (L.Request -> L.Request) -> Option scheme
11471443withRequest f = Option (Endo (second f)) Nothing
11481444
11491445instance RequestComponent (Option scheme) where
11501446 getRequestMod (Option f _) = Endo $ \x ->
11511447 let (qparams, x') = appEndo f ([], x)
1152− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1153− in x' { L.queryString = query }
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449+ in x' {L.queryString = query}
11541450
11551451-- | Finalize given 'L.Request' by applying a finalizer from the given
11561452-- 'Option' (if it has any).
1157−
1158−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
11591454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
11601455
11611456----------------------------------------------------------------------------
@@ -1174,12 +1469,12 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
11741469-- This operator is defined in terms of 'queryParam':
11751470--
11761471-- > name =: value = queryParam name (pure value)
1177−
11781472infix 7 =:
1473+
11791474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
11801475name =: value = queryParam name (pure value)
11811476
1182−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
11831478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
11841479-- with a value:
11851480--
@@ -1188,27 +1483,47 @@ name =: value = queryParam name (pure value)
11881483-- This operator is defined in terms of 'queryParam':
11891484--
11901485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1191−
1192−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
11931487queryFlag name = queryParam name (Nothing :: Maybe ())
11941488
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+
11951507-- | A type class for query-parameter-like things. The reason to have an
11961508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
11971509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
11981510-- Having the same syntax for these cases seems natural and user-friendly.
1199−
12001511class QueryParam param where
1201−
12021512 -- | Create a query parameter with given name and value. If value is
12031513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
12041514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
12051515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
12061517
1207− 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)]
12081522
12091523instance QueryParam (Option scheme) where
12101524 queryParam name mvalue =
12111525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
12121527
12131528----------------------------------------------------------------------------
12141529-- Request—Optional parameters—Headers
@@ -1217,21 +1532,28 @@ instance QueryParam (Option scheme) where
12171532-- headers with the same names the leftmost header will win. This means, in
12181533-- particular, that you cannot create a request with several headers of the
12191534-- same name.
1220−
1221−header
1222− :: ByteString -- ^ Header name
1223− -> ByteString -- ^ Header value
1224− -> Option scheme
1535+header ::
1536+ -- | Header name
1537+ ByteString ->
1538+ -- | Header value
1539+ ByteString ->
1540+ Option scheme
12251541header name value = withRequest (attachHeader name value)
12261542
1227−-- | A non-public helper that attaches a header with given name and content
1228−-- to a 'L.Request'.
1543+-- | Attach a header with given name and content to a 'L.Request'.
12291544--
12301545-- @since 1.1.0
1231−
12321546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
12331547attachHeader name value x =
1234− 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}
12351557
12361558----------------------------------------------------------------------------
12371559-- Request—Optional parameters—Cookies
@@ -1244,10 +1566,9 @@ attachHeader name value x =
12441566
12451567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
12461568-- 'L.Response' record.
1247−
12481569cookieJar :: L.CookieJar -> Option scheme
12491570cookieJar jar = withRequest $ \x ->
1250− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
12511572
12521573----------------------------------------------------------------------------
12531574-- Request—Optional parameters—Authentication
@@ -1265,53 +1586,66 @@ cookieJar jar = withRequest $ \x ->
12651586-- | The 'Option' adds basic authentication.
12661587--
12671588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1268−
1269−basicAuth
1270− :: ByteString -- ^ Username
1271− -> ByteString -- ^ Password
1272− -> Option 'Https -- ^ Auth 'Option'
1589+basicAuth ::
1590+ -- | Username
1591+ ByteString ->
1592+ -- | Password
1593+ ByteString ->
1594+ -- | Auth 'Option'
1595+ Option 'Https
12731596basicAuth = basicAuthUnsafe
12741597
12751598-- | An alternative to 'basicAuth' which works for any scheme. Note that
1276−-- using basic access authentication without SSL/TLS is vulnerable to
1599+-- using basic access authentication without SSL\/TLS is vulnerable to
12771600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
12781601--
12791602-- @since 0.3.1
1280−
1281−basicAuthUnsafe
1282− :: ByteString -- ^ Username
1283− -> ByteString -- ^ Password
1284− -> Option scheme -- ^ Auth 'Option'
1285−basicAuthUnsafe username password = customAuth
1286− (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)
12871613
12881614-- | The 'Option' set basic proxy authentication header.
12891615--
12901616-- @since 1.1.0
1291−
1292−basicProxyAuth
1293− :: ByteString -- ^ Username
1294− -> ByteString -- ^ Password
1295− -> Option scheme -- ^ Auth 'Option'
1617+basicProxyAuth ::
1618+ -- | Username
1619+ ByteString ->
1620+ -- | Password
1621+ ByteString ->
1622+ -- | Auth 'Option'
1623+ Option scheme
12961624basicProxyAuth username password =
12971625 withRequest (L.applyBasicProxyAuth username password)
12981626
12991627-- | The 'Option' adds OAuth1 authentication.
13001628--
13011629-- @since 0.2.0
1302−
1303−oAuth1
1304− :: ByteString -- ^ Consumer token
1305− -> ByteString -- ^ Consumer secret
1306− -> ByteString -- ^ OAuth token
1307− -> ByteString -- ^ OAuth token secret
1308− -> 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
13091641oAuth1 consumerToken consumerSecret token tokenSecret =
13101642 customAuth (OAuth.signOAuth app creds)
13111643 where
1312− app = OAuth.newOAuth
1313− { OAuth.oauthConsumerKey = consumerToken
1314− , OAuth.oauthConsumerSecret = consumerSecret }
1644+ app =
1645+ OAuth.newOAuth
1646+ { OAuth.oauthConsumerKey = consumerToken,
1647+ OAuth.oauthConsumerSecret = consumerSecret
1648+ }
13151649 creds = OAuth.newCredential token tokenSecret
13161650
13171651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1322,12 +1656,14 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
13221656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
13231657--
13241658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1325−
1326−oAuth2Bearer
1327− :: ByteString -- ^ Token
1328− -> Option 'Https -- ^ Auth 'Option'
1329−oAuth2Bearer token = customAuth
1330− (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))
13311667
13321668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
13331669-- to be used only by GitHub). This will be treated by whatever services
@@ -1338,19 +1674,20 @@ oAuth2Bearer token = customAuth
13381674-- > oAuth2Token token = header "Authorization" ("token" <> token)
13391675--
13401676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1341−
1342−oAuth2Token
1343− :: ByteString -- ^ Token
1344− -> Option 'Https -- ^ Auth 'Option'
1345−oAuth2Token token = customAuth
1346− (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))
13471685
13481686-- | A helper to create custom authentication 'Option's. The given
13491687-- 'IO'-enabled request transformation is applied after all other
13501688-- modifications when constructing a request. Use wisely.
13511689--
13521690-- @since 1.1.0
1353−
13541691customAuth :: (L.Request -> IO L.Request) -> Option scheme
13551692customAuth = Option mempty . pure
13561693
@@ -1359,11 +1696,10 @@ customAuth = Option mempty . pure
13591696
13601697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
13611698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1362−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1363−
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
13641700port :: Int -> Option scheme
13651701port n = withRequest $ \x ->
1366− x { L.port = n }
1702+ x {L.port = n}
13671703
13681704-- | This 'Option' controls whether gzipped data should be decompressed on
13691705-- the fly. By default everything except for @\"application\/x-tar\"@ is
@@ -1374,39 +1710,40 @@ port n = withRequest $ \x ->
13741710-- You can also choose to decompress everything like this:
13751711--
13761712-- > decompress (const True)
1377−
1378−decompress
1379− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1380− -- returns 'True' when content should be decompressed on the fly.
1381− -> 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
13821718decompress f = withRequest $ \x ->
1383− x { L.decompress = f }
1719+ x {L.decompress = f}
13841720
13851721-- | Specify the number of microseconds to wait for response. The default
13861722-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
13871723-- 'L.Manager').
1388−
1389−responseTimeout
1390− :: Int -- ^ Number of microseconds to wait
1391− -> Option scheme
1724+responseTimeout ::
1725+ -- | Number of microseconds to wait
1726+ Int ->
1727+ Option scheme
13921728responseTimeout n = withRequest $ \x ->
1393− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
13941730
13951731-- | HTTP version to send to the server, the default is HTTP 1.1.
1396−
1397−httpVersion
1398− :: Int -- ^ Major version number
1399− -> Int -- ^ Minor version number
1400− -> Option scheme
1732+httpVersion ::
1733+ -- | Major version number
1734+ Int ->
1735+ -- | Minor version number
1736+ Int ->
1737+ Option scheme
14011738httpVersion major minor = withRequest $ \x ->
1402− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
14031740
14041741----------------------------------------------------------------------------
14051742-- Response interpretations
14061743
14071744-- | Make a request and ignore the body of the response.
1408−
14091745newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
14101747
14111748instance HttpResponse IgnoreResponse where
14121749 type HttpResponseBody IgnoreResponse = ()
@@ -1415,7 +1752,6 @@ instance HttpResponse IgnoreResponse where
14151752
14161753-- | Use this as the fourth argument of 'req' to specify that you want it to
14171754-- ignore the response body.
1418−
14191755ignoreResponse :: Proxy IgnoreResponse
14201756ignoreResponse = Proxy
14211757
@@ -1423,28 +1759,28 @@ ignoreResponse = Proxy
14231759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
14241760-- monad in which you use 'req' will determine what to do in the case when
14251761-- parsing fails (the 'JsonHttpException' constructor will be used).
1426−
14271762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
14281764
1429−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
14301766 type HttpResponseBody (JsonResponse a) = a
14311767 toVanillaResponse (JsonResponse r) = r
14321768 getHttpResponse r = do
14331769 chunks <- L.brConsume (L.responseBody r)
14341770 case A.eitherDecode (BL.fromChunks chunks) of
1435− Left e -> throwIO (JsonHttpException e)
1771+ Left e -> throwIO (JsonHttpException e)
14361772 Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
14371774
14381775-- | Use this as the fourth argument of 'req' to specify that you want it to
14391776-- return the 'JsonResponse' interpretation.
1440−
14411777jsonResponse :: Proxy (JsonResponse a)
14421778jsonResponse = Proxy
14431779
14441780-- | Make a request and interpret the body of the response as a strict
14451781-- 'ByteString'.
1446−
14471782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
14481784
14491785instance HttpResponse BsResponse where
14501786 type HttpResponseBody BsResponse = ByteString
@@ -1455,14 +1791,13 @@ instance HttpResponse BsResponse where
14551791
14561792-- | Use this as the fourth argument of 'req' to specify that you want to
14571793-- interpret the response body as a strict 'ByteString'.
1458−
14591794bsResponse :: Proxy BsResponse
14601795bsResponse = Proxy
14611796
14621797-- | Make a request and interpret the body of the response as a lazy
14631798-- 'BL.ByteString'.
1464−
14651799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
14661801
14671802instance HttpResponse LbsResponse where
14681803 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1473,24 +1808,22 @@ instance HttpResponse LbsResponse where
14731808
14741809-- | Use this as the fourth argument of 'req' to specify that you want to
14751810-- interpret the response body as a lazy 'BL.ByteString'.
1476−
14771811lbsResponse :: Proxy LbsResponse
14781812lbsResponse = Proxy
14791813
14801814----------------------------------------------------------------------------
14811815-- Helpers for response interpretations
14821816
1483−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
14841818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
14851819-- such.
1486−
1487−grabPreview
1488− :: Int
1489− -- ^ How many bytes to fetch
1490− -> L.Response L.BodyReader
1491− -- ^ Response with body reader inside
1492− -> IO (ByteString, L.Response L.BodyReader)
1493− -- ^ 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)
14941827grabPreview nbytes r = do
14951828 let br = L.responseBody r
14961829 (target, leftover, done) <- brReadN br nbytes
@@ -1513,18 +1846,17 @@ grabPreview nbytes r = do
15131846 if done
15141847 then return B.empty
15151848 else br
1516− return (target, r { L.responseBody = br' })
1849+ return (target, r {L.responseBody = br'})
15171850
15181851-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
15191852-- leftover (may be empty), and whether we're done consuming the body.
1520−
1521−brReadN
1522− :: L.BodyReader
1523− -- ^ Body reader to stream from
1524− -> Int
1525− -- ^ How many bytes to consume
1526− -> IO (ByteString, ByteString, Bool)
1527− -- ^ 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)
15281860brReadN br n = go 0 id id
15291861 where
15301862 go !tlen t l = do
@@ -1533,9 +1865,9 @@ brReadN br n = go 0 id id
15331865 then return (r t, r l, True)
15341866 else do
15351867 let (target, leftover) = B.splitAt (n - tlen) chunk
1536− tlen' = B.length target
1537− t' = t . (target:)
1538− l' = l . (leftover:)
1868+ tlen' = B.length target
1869+ t' = t . (target :)
1870+ l' = l . (leftover :)
15391871 if tlen + tlen' < n
15401872 then go (tlen + tlen') t' l'
15411873 else return (r t', r l', False)
@@ -1545,47 +1877,45 @@ brReadN br n = go 0 id id
15451877-- Inspecting a response
15461878
15471879-- | Get the response body.
1548−
1549−responseBody
1550− :: HttpResponse response
1551− => response
1552− -> HttpResponseBody response
1880+responseBody ::
1881+ (HttpResponse response) =>
1882+ response ->
1883+ HttpResponseBody response
15531884responseBody = L.responseBody . toVanillaResponse
15541885
15551886-- | Get the response status code.
1556−
1557−responseStatusCode
1558− :: HttpResponse response
1559− => response
1560− -> Int
1887+responseStatusCode ::
1888+ (HttpResponse response) =>
1889+ response ->
1890+ Int
15611891responseStatusCode =
15621892 Y.statusCode . L.responseStatus . toVanillaResponse
15631893
15641894-- | Get the response status message.
1565−
1566−responseStatusMessage
1567− :: HttpResponse response
1568− => response
1569− -> ByteString
1895+responseStatusMessage ::
1896+ (HttpResponse response) =>
1897+ response ->
1898+ ByteString
15701899responseStatusMessage =
15711900 Y.statusMessage . L.responseStatus . toVanillaResponse
15721901
15731902-- | Lookup a particular header from a response.
1574−
1575−responseHeader
1576− :: HttpResponse response
1577− => response -- ^ Response interpretation
1578− -> ByteString -- ^ Header to lookup
1579− -> 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
15801911responseHeader r h =
15811912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
15821913
15831914-- | Get the response 'L.CookieJar'.
1584−
1585−responseCookieJar
1586− :: HttpResponse response
1587− => response
1588− -> L.CookieJar
1915+responseCookieJar ::
1916+ (HttpResponse response) =>
1917+ response ->
1918+ L.CookieJar
15891919responseCookieJar = L.responseCookieJar . toVanillaResponse
15901920
15911921----------------------------------------------------------------------------
@@ -1596,19 +1926,15 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
15961926-- To create a new response interpretation you just need to make your data
15971927-- type an instance of the 'HttpResponse' type class.
15981928
1599−-- | A type class for response interpretations. It allows to describe how to
1600−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1601−-- final result that is to be returned to the user.
1602−
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.
16031932class HttpResponse response where
1604−
16051933 -- | The associated type is the type of body that can be extracted from an
16061934 -- instance of 'HttpResponse'.
1607−
1608− type HttpResponseBody response :: *
1935+ type HttpResponseBody response :: Type
16091936
16101937 -- | The method describes how to get the underlying 'L.Response' record.
1611−
16121938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
16131939
16141940 -- | This method describes how to consume response body and, more
@@ -1624,12 +1950,32 @@ class HttpResponse response where
16241950 --
16251951 -- __Note__: signature of this function was changed in the version
16261952 -- /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
16271969
1628− getHttpResponse
1629− :: L.Response L.BodyReader
1630− -- ^ Response with body reader inside
1631− -> IO response
1632− -- ^ 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
16331979
16341980----------------------------------------------------------------------------
16351981-- Other
@@ -1641,15 +1987,12 @@ class HttpResponse response where
16411987-- request components easier using @('<>')@.
16421988--
16431989-- __Note__: this type class is not a part of the public API.
1644−
16451990class RequestComponent a where
1646−
16471991 -- | Get a function that takes a 'L.Request' and changes it somehow
16481992 -- returning another 'L.Request'. For example, the 'HttpMethod' instance
16491993 -- of 'RequestComponent' just overwrites method. The function is wrapped
16501994 -- in 'Endo' so it's easier to chain such “modifying applications”
16511995 -- together building bigger and bigger 'RequestComponent's.
1652−
16531996 getRequestMod :: a -> Endo L.Request
16541997
16551998-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -1659,44 +2002,50 @@ class RequestComponent a where
16592002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
16602003-- which instance to use (i.e. the constraints are taken into account later,
16612004-- when instance is already chosen).
1662−
1663−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
16642006
16652007-- | Exceptions that this library throws.
1666−
16672008data HttpException
1668− = VanillaHttpException L.HttpException
1669− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1670− | JsonHttpException String
1671− -- ^ 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
16722012 -- failed
1673− deriving (Show, Typeable, Generic)
2013+ JsonHttpException String
2014+ deriving (Show, Generic)
16742015
16752016instance Exception HttpException
16762017
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+
16772032-- | A simple type isomorphic to 'Bool' that we only have for better error
16782033-- messages. We use it as a kind and its data constructors as type-level
16792034-- tags.
16802035--
16812036-- See also: 'HttpMethod' and 'HttpBody'.
1682−
16832037data CanHaveBody
1684− = CanHaveBody -- ^ Indeed can have a body
1685− | NoBody -- ^ Should not have a body
2038+ = -- | Indeed can have a body
2039+ CanHaveBody
2040+ | -- | Should not have a body
2041+ NoBody
16862042
16872043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
16882044-- enabled). This is used to force TLS requirement for some authentication
16892045-- 'Option's.
1690−
16912046data Scheme
1692− = Http -- ^ HTTP
1693− | Https -- ^ HTTPS
1694− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1695−
1696−----------------------------------------------------------------------------
1697−-- Constants
1698−
1699−-- | Max length of preview fragment of response body.
1700−
1701−bodyPreviewLength :: Num a => a
1702−bodyPreviewLength = 1024
2047+ = -- | HTTP
2048+ Http
2049+ | -- | HTTPS
2050+ Https
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)