@@ -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–2017 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,177 +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
151+ header,
152+ attachHeader,
153+ headerRedacted,
154+
173155 -- *** Cookies
174156 -- $cookies
175− , cookieJar
157+ cookieJar,
158+
176159 -- *** Authentication
177160 -- $authentication
178− , basicAuth
179− , basicAuthUnsafe
180− , oAuth1
181− , oAuth2Bearer
182− , oAuth2Token
161+ basicAuth,
162+ basicAuthUnsafe,
163+ basicProxyAuth,
164+ oAuth1,
165+ oAuth2Bearer,
166+ oAuth2Token,
167+ customAuth,
168+
183169 -- *** Other
184− , port
185− , decompress
186− , responseTimeout
187− , httpVersion
170+ port,
171+ decompress,
172+ responseTimeout,
173+ httpVersion,
174+
188175 -- * Response
176+
189177 -- ** Response interpretations
190− , IgnoreResponse
191− , ignoreResponse
192− , JsonResponse
193− , jsonResponse
194− , BsResponse
195− , bsResponse
196− , LbsResponse
197− , lbsResponse
178+ IgnoreResponse,
179+ ignoreResponse,
180+ JsonResponse,
181+ jsonResponse,
182+ BsResponse,
183+ bsResponse,
184+ LbsResponse,
185+ lbsResponse,
186+
198187 -- ** Inspecting a response
199− , responseBody
200− , responseStatusCode
201− , responseStatusMessage
202− , responseHeader
203− , responseCookieJar
188+ responseBody,
189+ responseStatusCode,
190+ responseStatusMessage,
191+ responseHeader,
192+ responseCookieJar,
193+
204194 -- ** Defining your own interpretation
205195 -- $new-response-interpretation
206− , HttpResponse (..)
196+ HttpResponse (..),
197+
207198 -- * Other
208− , HttpException (..)
209− , CanHaveBody (..)
210− , Scheme (..) )
199+ HttpException (..),
200+ isStatusCodeException,
201+ CanHaveBody (..),
202+ Scheme (..),
203+ )
211204where
212205
206+import Blaze.ByteString.Builder qualified as BB
213207import Control.Applicative
214208import Control.Arrow (first, second)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
215211import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
216213import Control.Monad.IO.Class
217−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)
218218import 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
219231import Control.Retry
220−import Data.Aeson (ToJSON (..), FromJSON (..))
232+import Data.Aeson (FromJSON (..), ToJSON (..))
233+import Data.Aeson qualified as A
221234import 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
222238import Data.Data (Data)
223−import Data.Default.Class
239+import Data.Default.Class (def)
224240import Data.Function (on)
225241import Data.IORef
226−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
227244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
228246import Data.Maybe (fromMaybe)
229247import Data.Proxy
230−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
231250import Data.Text (Text)
232−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)
233254import GHC.Generics
234255import 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
235265import 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
236272import Web.HttpApiData (ToHttpApiData (..))
237−import qualified Blaze.ByteString.Builder as BB
238−import qualified Data.Aeson as A
239−import qualified Data.ByteString as B
240−import qualified Data.ByteString.Lazy as BL
241−import qualified Data.CaseInsensitive as CI
242−import qualified Data.List.NonEmpty as NE
243−import qualified Data.Text as T
244−import qualified Data.Text.Encoding as T
245−import qualified Data.Text.Read as TR
246−import qualified Network.Connection as NC
247−import qualified Network.HTTP.Client as L
248−import qualified Network.HTTP.Client.Internal as LI
249−import qualified Network.HTTP.Client.MultipartFormData as LM
250−import qualified Network.HTTP.Client.TLS as L
251−import qualified Network.HTTP.Types as Y
252−import qualified Web.Authenticate.OAuth as OAuth
253−
254−#if MIN_VERSION_base(4,9,0)
255−import Control.Exception hiding (TypeError)
256−import Data.Kind (Constraint)
257−#else
258−import Control.Exception
259−import GHC.Exts (Constraint)
260−#endif
261273
262274----------------------------------------------------------------------------
263275-- Making a request
@@ -281,7 +293,7 @@ import GHC.Exts (Constraint)
281293--
282294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
283295-- tutorial has a section about HTTP bodies, but usage is very
284−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
285297--
286298-- @response@ is a type hint how to make and interpret response of an HTTP
287299-- request. Out-of-the-box it can be the following:
@@ -307,12 +319,13 @@ import GHC.Exts (Constraint)
307319-- First, this is a piece of boilerplate that should be in place before you
308320-- try the examples:
309321--
322+-- > {-# LANGUAGE DeriveGeneric #-}
310323-- > {-# LANGUAGE OverloadedStrings #-}
311324-- >
312325-- > module Main (main) where
313326-- >
314−-- > import Control.Exception (throwIO)
315327-- > import Control.Monad
328+-- > import Control.Monad.IO.Class
316329-- > import Data.Aeson
317330-- > import Data.Maybe (fromJust)
318331-- > import Data.Monoid ((<>))
@@ -320,32 +333,30 @@ import GHC.Exts (Constraint)
320333-- > import GHC.Generics
321334-- > import Network.HTTP.Req
322335-- > import qualified Data.ByteString.Char8 as B
323−-- >
324−-- > instance MonadHttp IO where
325−-- > handleHttpException = throwIO
336+-- > import qualified Text.URI as URI
326337--
327338-- We will be making requests against the <https://httpbin.org> service.
328339--
329340-- Make a GET request, grab 5 random bytes:
330341--
331342-- > main :: IO ()
332−-- > main = do
343+-- > main = runReq defaultHttpConfig $ do
333344-- > let n :: Int
334345-- > n = 5
335346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
336−-- > B.putStrLn (responseBody bs)
347+-- > liftIO $ B.putStrLn (responseBody bs)
337348--
338349-- The same, but now we use a query parameter named @\"seed\"@ to control
339350-- seed of the generator:
340351--
341352-- > main :: IO ()
342−-- > main = do
353+-- > main = runReq defaultHttpConfig $ do
343354-- > let n, seed :: Int
344355-- > n = 5
345356-- > seed = 100
346357-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
347358-- > "seed" =: seed
348−-- > B.putStrLn (responseBody bs)
359+-- > liftIO $ B.putStrLn (responseBody bs)
349360--
350361-- POST JSON data and get some info about the POST request:
351362--
@@ -358,91 +369,170 @@ import GHC.Exts (Constraint)
358369-- > instance FromJSON MyData
359370-- >
360371-- > main :: IO ()
361−-- > main = do
372+-- > main = runReq defaultHttpConfig $ do
362373-- > let myData = MyData
363374-- > { size = 6
364375-- > , color = "Green" }
365376-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
366−-- > print (responseBody v :: Value)
377+-- > liftIO $ print (responseBody v :: Value)
367378--
368379-- Sending URL-encoded body:
369380--
370381-- > main :: IO ()
371−-- > main = do
382+-- > main = runReq defaultHttpConfig $ do
372383-- > let params =
373384-- > "foo" =: ("bar" :: Text) <>
374385-- > queryFlag "baz"
375386-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
376−-- > print (responseBody response :: Value)
387+-- > liftIO $ print (responseBody response :: Value)
377388--
378389-- Using various optional parameters and URL that is not known in advance:
379390--
380391-- > main :: IO ()
381−-- > main = do
392+-- > main = runReq defaultHttpConfig $ do
382393-- > -- This is an example of what to do when URL is given dynamically. Of
383394-- > -- course in a real application you may not want to use 'fromJust'.
384−-- > 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)
385397-- > response <- req GET url NoReqBody jsonResponse $
386398-- > "from" =: (15 :: Int) <>
387399-- > "to" =: (67 :: Int) <>
388400-- > basicAuth "username" "password" <>
389401-- > options <> -- contains the ?foo=bar part
390402-- > port 443 -- here you can put any port of course
391−-- > print (responseBody response :: Value)
392−
393−req
394− :: ( MonadHttp m
395− , HttpMethod method
396− , HttpBody body
397− , HttpResponse response
398− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
399− => method -- ^ HTTP method
400− -> Url scheme -- ^ 'Url'—location of resource
401− -> body -- ^ Body of the request
402− -> Proxy response -- ^ A hint how to interpret response
403− -> Option scheme -- ^ Collection of optional parameters
404− -> m response -- ^ Response
405−req method url body Proxy options =
406− reqBr method url body options getHttpResponse
403+-- > liftIO $ print (responseBody response :: Value)
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
407425
408426-- | A version of 'req' that does not use one of the predefined instances of
409427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
410428-- 'L.BodyReader'@ manually, in a custom way.
411429--
412430-- @since 1.0.0
413−
414−reqBr
415− :: ( MonadHttp m
416− , HttpMethod method
417− , HttpBody body
418− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
419− => method -- ^ HTTP method
420− -> Url scheme -- ^ 'Url'—location of resource
421− -> body -- ^ Body of the request
422− -> Option scheme -- ^ Collection of optional parameters
423− -> (L.Response L.BodyReader -> IO a) -- ^ How to consume response
424− -> m a -- ^ Result
425−reqBr method url body options consume = req' method url body options $ \request manager -> do
426− 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
427502 let wrapVanilla = handle (throwIO . VanillaHttpException)
428− wrapExc = handle (throwIO . LI.toHttpException request)
429− withRRef = bracket
430− (newIORef Nothing)
431− (readIORef >=> mapM_ L.responseClose)
432− (liftIO . try . wrapVanilla . wrapExc) (withRRef $ \rref -> do
433− let openResponse = mask_ $ do
434− r <- readIORef rref
435− mapM_ L.responseClose r
436− r' <- L.responseOpen request manager
437− writeIORef rref (Just r')
438− return r'
439− r <- retrying
440− httpConfigRetryPolicy
441− (\st r -> return $ httpConfigRetryJudge st r)
442− (const openResponse)
443− (preview, r') <- grabPreview bodyPreviewLength r
444− mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
445− 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+ )
446536 >>= either handleHttpException return
447537
448538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
@@ -453,51 +543,57 @@ reqBr method url body options consume = req' method url body options $ \request
453543-- 'L.Request' and allows you to use it.
454544--
455545-- @since 0.3.0
456−
457−req'
458− :: forall m method body scheme a.
459− ( MonadHttp m
460− , HttpMethod method
461− , HttpBody body
462− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
463− => method -- ^ HTTP method
464− -> Url scheme -- ^ 'Url'—location of resource
465− -> body -- ^ Body of the request
466− -> Option scheme -- ^ Collection of optional parameters
467− -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
468− -> 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
469565req' method url body options m = do
470− config@HttpConfig {..} <- getHttpConfig
566+ config <- getHttpConfig
471567 let -- NOTE First appearance of any given header wins. This allows to
472568 -- “overwrite” headers when we construct a request by cons-ing.
473569 nubHeaders = Endo $ \x ->
474− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
475− request' = flip appEndo L.defaultRequest $
476− -- NOTE The order of 'mappend's matters, here method is overwritten
477− -- first and 'options' take effect last. In particular, this means
478− -- that 'options' can overwrite things set by other request
479− -- components, which is useful for setting port number,
480− -- "Content-Type" header, etc.
481− nubHeaders <>
482− getRequestMod options <>
483− getRequestMod config <>
484− getRequestMod (Womb body :: Womb "body" body) <>
485− getRequestMod url <>
486− 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)
487584 request <- finalizeRequest options request'
488585 withReqManager (m request)
489586
490587-- | Perform an action using the global implicit 'L.Manager' that the rest
491−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
492589-- 'L.Manager' controls.
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
493592
494−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
495−withReqManager m = liftIO (readIORef globalManager) >>= m
496−
497−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
498−-- settings, so users don't need to deal with this manager stuff at all, but
499−-- when we create a request, instance 'HttpConfig' can affect the default
500−-- 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'.
501597--
502598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
503599-- The value of 'globalManager' is named and lives on top level. This means
@@ -505,17 +601,20 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
505601-- manager. From that moment on the 'IORef' will be just reused—exactly the
506602-- behavior we want here in order to maximize connection sharing. GHC could
507603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
508−
509−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
510605globalManager = unsafePerformIO $ do
511606 context <- NC.initConnectionContext
512− let settings = L.mkManagerSettingsContext (Just context) def Nothing
607+ let settings =
608+ L.mkManagerSettingsContext
609+ (Just context)
610+ def
611+ Nothing
513612 manager <- L.newManager settings
514− newIORef manager
613+ return manager
515614{-# NOINLINE globalManager #-}
516615
517616----------------------------------------------------------------------------
518−-- Embedding requests into your monad
617+-- Embedding requests in your monad
519618
520619-- $embedding-requests
521620--
@@ -524,56 +623,44 @@ globalManager = unsafePerformIO $ do
524623--
525624-- When writing a library, keep your API polymorphic in terms of
526625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
527−-- Another option is to use @newtype@ wrapped monad stack and define
528−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
529−-- 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).
530629
531630-- | A type class for monads that support performing HTTP requests.
532631-- Typically, you only need to define the 'handleHttpException' method
533632-- unless you want to tweak 'HttpConfig'.
534−
535−class MonadIO m => MonadHttp m where
536−
633+class (MonadIO m) => MonadHttp m where
537634 -- | This method describes how to deal with 'HttpException' that was
538635 -- caught by the library. One option is to re-throw it if you are OK with
539636 -- exceptions, but if you prefer working with something like
540637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
541638 -- 'Control.Monad.Except.throwError'.
542−
543639 handleHttpException :: HttpException -> m a
544640
545− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
546− -- implementation returns its 'def' value, which is described in the
547− -- documentation for the type. Common usage pattern with manually defined
548− -- '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
549645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
550646 -- approach to configuration is desirable.
551−
552647 getHttpConfig :: m HttpConfig
553− getHttpConfig = return def
554−
555−-- | 'HttpConfig' contains general and default settings to be used when
556−-- making HTTP requests.
648+ getHttpConfig = return defaultHttpConfig
557649
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
558651data HttpConfig = HttpConfig
559− { httpConfigProxy :: Maybe L.Proxy
560− -- ^ 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@
561653 -- environment variables are respected, this setting overwrites them.
562654 -- Default value: 'Nothing'.
563− , httpConfigRedirectCount :: Int
564− -- ^ 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
565657 -- value: 10.
566− , httpConfigAltManager :: Maybe L.Manager
567− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
658+ httpConfigRedirectCount :: Int,
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
568660 -- that the default implicit manager will be used (that's what you want
569661 -- in 99% of cases).
570− , httpConfigCheckResponse
571− :: forall b.
572− L.Request
573− -> L.Response b
574− -> ByteString
575− -> Maybe L.HttpExceptionContent
576− -- ^ Function to check the response immediately after receiving the
662+ httpConfigAltManager :: Maybe L.Manager,
663+ -- | Function to check the response immediately after receiving the
577664 -- status and headers, before streaming of response body. The third
578665 -- argument is the beginning of response body (typically first 1024
579666 -- bytes). This is used for throwing exceptions on non-success status
@@ -595,63 +682,106 @@ data HttpConfig = HttpConfig
595682 -- /1.0.0/.
596683 --
597684 -- @since 0.3.0
598− , httpConfigRetryPolicy :: RetryPolicy
599− -- ^ 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
600692 -- used (see 'RetryPolicyM').
601693 --
602− -- __Note__: signature of this function was changed in the version
603− -- /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/.
604696 --
605697 -- @since 0.3.0
606− , httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
607− -- ^ 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'
608700 -- means that the request should be retried.
609701 --
610702 -- __Note__: signature of this function was changed in the version
611703 -- /1.0.0/.
612704 --
613705 -- @since 0.3.0
614− } deriving Typeable
615−
616−instance Default HttpConfig where
617− def = HttpConfig
618− { httpConfigProxy = Nothing
619− , httpConfigRedirectCount = 10
620− , httpConfigAltManager = Nothing
621− , 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 ->
622730 let scode = statusCode response
623− in if 200 <= scode && scode < 300
624− then Nothing
625− else Just (L.StatusCodeException (void response) preview)
626− , httpConfigRetryPolicy = def
627− , httpConfigRetryJudge = \_ response ->
628− statusCode response `elem`
629− [ 408 -- Request timeout
630− , 504 -- Gateway timeout
631− , 524 -- A timeout occurred
632− , 598 -- (Informal convention) Network read timeout error
633− , 599 -- (Informal convention) Network connect timeout error
634− ]
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
635752 }
636− where
637− statusCode = Y.statusCode . L.responseStatus
753+ where
754+ statusCode = Y.statusCode . L.responseStatus
638755
639756instance RequestComponent HttpConfig where
640757 getRequestMod HttpConfig {..} = Endo $ \x ->
641− x { L.proxy = httpConfigProxy
642− , L.redirectCount = httpConfigRedirectCount
643− , LI.requestManagerOverride = httpConfigAltManager }
758+ x
759+ { L.proxy = httpConfigProxy,
760+ L.redirectCount = httpConfigRedirectCount,
761+ LI.requestManagerOverride = httpConfigAltManager
762+ }
644763
645−-- | 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
646765-- having to define new instances.
647766--
648767-- @since 0.4.0
649−
650768newtype Req a = Req (ReaderT HttpConfig IO a)
651− deriving ( Functor
652− , Applicative
653− , Monad
654− , 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
655785
656786instance MonadBase IO Req where
657787 liftBase = liftIO
@@ -660,22 +790,99 @@ instance MonadBaseControl IO Req where
660790 type StM Req a = a
661791 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
662792 {-# INLINEABLE liftBaseWith #-}
663− restoreM = Req . ReaderT . const . return
793+ restoreM = Req . ReaderT . const . return
664794 {-# INLINEABLE restoreM #-}
665795
666796instance MonadHttp Req where
667797 handleHttpException = Req . lift . throwIO
668− 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
669874
670875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
671−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
672877--
673878-- @since 0.4.0
674−
675−runReq :: MonadIO m
676− => HttpConfig -- ^ 'HttpConfig' to use
677− -> Req a -- ^ Computation to run
678− -> m a
879+runReq ::
880+ (MonadIO m) =>
881+ -- | 'HttpConfig' to use
882+ HttpConfig ->
883+ -- | Computation to run
884+ Req a ->
885+ m a
679886runReq config (Req m) = liftIO (runReaderT m config)
680887
681888----------------------------------------------------------------------------
@@ -691,7 +898,6 @@ runReq config (Req m) = liftIO (runReaderT m config)
691898-- define a new method that will works seamlessly, see 'HttpMethod'.
692899
693900-- | 'GET' method.
694−
695901data GET = GET
696902
697903instance HttpMethod GET where
@@ -699,7 +905,6 @@ instance HttpMethod GET where
699905 httpMethodName Proxy = Y.methodGet
700906
701907-- | 'POST' method.
702−
703908data POST = POST
704909
705910instance HttpMethod POST where
@@ -707,7 +912,6 @@ instance HttpMethod POST where
707912 httpMethodName Proxy = Y.methodPost
708913
709914-- | 'HEAD' method.
710−
711915data HEAD = HEAD
712916
713917instance HttpMethod HEAD where
@@ -715,26 +919,24 @@ instance HttpMethod HEAD where
715919 httpMethodName Proxy = Y.methodHead
716920
717921-- | 'PUT' method.
718−
719922data PUT = PUT
720923
721924instance HttpMethod PUT where
722925 type AllowsBody PUT = 'CanHaveBody
723926 httpMethodName Proxy = Y.methodPut
724927
725−-- | 'DELETE' method. This data type does not allow having request body with
726−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
727−-- requests to have bodies, in that case define your own variation of
728−-- 'DELETE' method and allow it to have a body.
729−
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.
730933data DELETE = DELETE
731934
732935instance HttpMethod DELETE where
733− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
734937 httpMethodName Proxy = Y.methodDelete
735938
736939-- | 'TRACE' method.
737−
738940data TRACE = TRACE
739941
740942instance HttpMethod TRACE where
@@ -742,7 +944,6 @@ instance HttpMethod TRACE where
742944 httpMethodName Proxy = Y.methodTrace
743945
744946-- | 'CONNECT' method.
745−
746947data CONNECT = CONNECT
747948
748949instance HttpMethod CONNECT where
@@ -750,7 +951,6 @@ instance HttpMethod CONNECT where
750951 httpMethodName Proxy = Y.methodConnect
751952
752953-- | 'OPTIONS' method.
753−
754954data OPTIONS = OPTIONS
755955
756956instance HttpMethod OPTIONS where
@@ -758,7 +958,6 @@ instance HttpMethod OPTIONS where
758958 httpMethodName Proxy = Y.methodOptions
759959
760960-- | 'PATCH' method.
761−
762961data PATCH = PATCH
763962
764963instance HttpMethod PATCH where
@@ -773,23 +972,19 @@ instance HttpMethod PATCH where
773972-- > instance HttpMethod COPY where
774973-- > type AllowsBody COPY = 'CanHaveBody
775974-- > httpMethodName Proxy = "COPY"
776−
777975class HttpMethod a where
778−
779976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
780− -- tells the rest of the library whether the method can have a body or
781− -- not. We use the special type 'CanHaveBody' lifted to the kind level
782− -- instead of 'Bool' to get more user-friendly compiler messages.
783−
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.
784980 type AllowsBody a :: CanHaveBody
785981
786982 -- | Return name of the method as a 'ByteString'.
787−
788983 httpMethodName :: Proxy a -> ByteString
789984
790−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
791986 getRequestMod _ = Endo $ \x ->
792− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
793988
794989----------------------------------------------------------------------------
795990-- Request—URL
@@ -797,7 +992,7 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
797992-- $url
798993--
799994-- We use 'Url's which are correct by construction, see 'Url'. To build a
800−-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
801996
802997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
803998-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -827,91 +1022,194 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8271022--
8281023-- > https "юникод.рф"
8291024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
830−
8311025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8321026 -- NOTE The second value is the path segments in reversed order.
833− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
8341028
835−-- | Given host name, produce a 'Url' which have “http” as its scheme and
836−-- empty path. This also sets port to @80@.
1029+type role Url nominal
8371030
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
1041+
1042+-- | Given host name, produce a 'Url' which has “http” as its scheme and
1043+-- empty path. This also sets port to @80@.
8381044http :: Text -> Url 'Http
8391045http = Url Http . pure
8401046
841−-- | 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
8421048-- empty path. This also sets port to @443@.
843−
8441049https :: Text -> Url 'Https
8451050https = Url Https . pure
8461051
847−-- | 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
8481053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
849−
8501054infixl 5 /~
851−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
852−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
8531055
854−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
855−-- 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)
8561058
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
8571061infixl 5 /:
1062+
8581063(/:) :: Url scheme -> Text -> Url scheme
8591064(/:) = (/~)
8601065
861−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
862−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
863−-- you are given a URL to query dynamically and don't know it beforehand.
864−-- The function parses 'ByteString' because it's the correct type to
865−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
866−-- range, thus we can consider every character a 'Data.Word.Word8' value.
867−--
868−-- This function only parses 'Url' (scheme, host, path) and optional query
869−-- parameters that are returned as 'Option'. It does not parse method name
870−-- or authentication info from given 'ByteString'.
871−
872−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
873−parseUrlHttp url' = do
874− url <- B.stripPrefix "http://" url'
875− (host :| path, option) <- parseUrlHelper url
876− return (foldl (/:) (http host) path, option)
877−
878−-- | Just like 'parseUrlHttp', but expects “https” scheme.
879−
880−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
881−parseUrlHttps url' = do
882− url <- B.stripPrefix "https://" url'
883− (host :| path, option) <- parseUrlHelper url
884− return (foldl (/:) (https host) path, option)
885−
886−-- | Get host\/collection of path pieces and possibly query parameters
887−-- already converted to 'Option'. This function is not public.
888−
889−parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
890−parseUrlHelper url = do
891− let (path', query') = B.break (== 0x3f) url
892− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
893− p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
894− (p, port') <-
895− case T.break (== ':') p' of
896− (x, "") -> return (x, mempty)
897− (x, prt) ->
898− case TR.decimal (T.drop 1 prt) of
899− Right (prt',"") -> return (x, port prt')
900− _ -> Nothing
901− 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'')
9021198
9031199instance RequestComponent (Url scheme) where
9041200 getRequestMod (Url scheme segments) = Endo $ \x ->
905− let (host :| path) = NE.reverse segments in
906− x { L.secure = case scheme of
907− Http -> False
908− Https -> True
909− , L.port = case scheme of
910− Http -> 80
911− Https -> 443
912− , L.host = Y.urlEncode False (T.encodeUtf8 host)
913− , L.path =
914− (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+ }
9151213
9161214----------------------------------------------------------------------------
9171215-- Request—Body
@@ -920,39 +1218,37 @@ instance RequestComponent (Url scheme) where
9201218--
9211219-- A number of options for request bodies are available. The @Content-Type@
9221220-- header is set for you automatically according to the body option you use
923−-- (it's always specified in documentation for a given body option). To add
924−-- 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'.
9251224
9261225-- | This data type represents empty body of an HTTP request. This is the
9271226-- data type to use with 'HttpMethod's that cannot have a body, as it's the
9281227-- only type for which 'ProvidesBody' returns 'NoBody'.
9291228--
9301229-- Using of this body option does not set the @Content-Type@ header.
931−
9321230data NoReqBody = NoReqBody
9331231
9341232instance HttpBody NoReqBody where
9351233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
9361234
937−-- | This body option allows to use a JSON object as request body—probably
938−-- the most popular format right now. Just wrap a data type that is an
939−-- instance of 'ToJSON' type class and you are done: it will be converted to
940−-- 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.
9411239--
9421240-- This body option sets the @Content-Type@ header to @\"application/json;
9431241-- charset=utf-8\"@ value.
944−
9451242newtype ReqBodyJson a = ReqBodyJson a
9461243
947−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
9481245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
9491246 getRequestContentType _ = pure "application/json; charset=utf-8"
9501247
9511248-- | This body option streams request body from a file. It is expected that
952−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
9531250--
9541251-- Using of this body option does not set the @Content-Type@ header.
955−
9561252newtype ReqBodyFile = ReqBodyFile FilePath
9571253
9581254instance HttpBody ReqBodyFile where
@@ -962,7 +1258,6 @@ instance HttpBody ReqBodyFile where
9621258-- | HTTP request body represented by a strict 'ByteString'.
9631259--
9641260-- Using of this body option does not set the @Content-Type@ header.
965−
9661261newtype ReqBodyBs = ReqBodyBs ByteString
9671262
9681263instance HttpBody ReqBodyBs where
@@ -971,22 +1266,19 @@ instance HttpBody ReqBodyBs where
9711266-- | HTTP request body represented by a lazy 'BL.ByteString'.
9721267--
9731268-- Using of this body option does not set the @Content-Type@ header.
974−
9751269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
9761270
9771271instance HttpBody ReqBodyLbs where
9781272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
9791273
980−-- | Form URL-encoded body. This can hold a collection of parameters which
981−-- are encoded similarly to query parameters at the end of query string,
982−-- with the only difference that they are stored in request body. The
983−-- similarity is reflected in the API as well, as you can use the same
984−-- combinators you would use to add query parameters: @('=:')@ and
985−-- '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'.
9861279--
9871280-- This body option sets the @Content-Type@ header to
9881281-- @\"application/x-www-form-urlencoded\"@ value.
989−
9901282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
9911283
9921284instance HttpBody ReqBodyUrlEnc where
@@ -996,13 +1288,19 @@ instance HttpBody ReqBodyUrlEnc where
9961288
9971289-- | An opaque monoidal value that allows to collect URL-encoded parameters
9981290-- to be wrapped in 'ReqBodyUrlEnc'.
999−
10001291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
10011292 deriving (Semigroup, Monoid)
10021293
10031294instance QueryParam FormUrlEncodedParam where
10041295 queryParam name mvalue =
10051296 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
10061304
10071305-- | Multipart form data. Please consult the
10081306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1012,17 +1310,15 @@ instance QueryParam FormUrlEncodedParam where
10121310--
10131311-- @since 0.2.0
10141312--
1015−-- ==== __Example__
1313+-- ==== __Examples__
10161314--
1017−-- > import Control.Exception (throwIO)
1018−-- > import qualified Network.HTTP.Client.MultipartFormData as LM
1315+-- > import Control.Monad.IO.Class
1316+-- > import Data.Default.Class
10191317-- > import Network.HTTP.Req
1020−-- >
1021−-- > instance MonadHttp IO where
1022−-- > handleHttpException = throwIO
1318+-- > import qualified Network.HTTP.Client.MultipartFormData as LM
10231319-- >
10241320-- > main :: IO ()
1025−-- > main = do
1321+-- > main = runReq def $ do
10261322-- > body <-
10271323-- > reqBodyMultipart
10281324-- > [ LM.partBS "title" "My Image"
@@ -1033,8 +1329,7 @@ instance QueryParam FormUrlEncodedParam where
10331329-- > body
10341330-- > bsResponse
10351331-- > mempty
1036−-- > print $ responseBody response
1037−
1332+-- > liftIO $ print (responseBody response)
10381333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
10391334
10401335instance HttpBody ReqBodyMultipart where
@@ -1045,70 +1340,64 @@ instance HttpBody ReqBodyMultipart where
10451340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
10461341--
10471342-- @since 0.2.0
1048−
1049−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
10501344reqBodyMultipart parts = liftIO $ do
10511345 boundary <- LM.webkitBoundary
1052− body <- LM.renderParts boundary parts
1346+ body <- LM.renderParts boundary parts
10531347 return (ReqBodyMultipart boundary body)
10541348
10551349-- | A type class for things that can be interpreted as an HTTP
10561350-- 'L.RequestBody'.
1057−
10581351class HttpBody body where
1059−
10601352 -- | How to get actual 'L.RequestBody'.
1061−
10621353 getRequestBody :: body -> L.RequestBody
10631354
1064− -- | This method allows to optionally specify value of @Content-Type@
1065− -- header that should be used with particular body option. By default it
1066− -- returns 'Nothing' and so @Content-Type@ is not set.
1067−
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.
10681358 getRequestContentType :: body -> Maybe ByteString
10691359 getRequestContentType = const Nothing
10701360
10711361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1072−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
1073−-- 'GET' method and other methods that should not send a body.
1074−
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1363+-- with 'GET' method and other methods that should not have body.
10751364type family ProvidesBody body :: CanHaveBody where
10761365 ProvidesBody NoReqBody = 'NoBody
1077− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
10781367
10791368-- | This type function allows any HTTP body if method says it
10801369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
10811370-- body option to use is 'NoReqBody'.
1082−--
1083−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1084−-- error message when method does not allow a body and body is provided.
1085−
1086−type family HttpBodyAllowed
1087− (allowsBody :: CanHaveBody)
1088− (providesBody :: CanHaveBody) :: Constraint where
1089− HttpBodyAllowed 'NoBody 'NoBody = ()
1090− HttpBodyAllowed 'CanHaveBody body = ()
1091−#if MIN_VERSION_base(4,9,0)
1092− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1093− ('Text "This HTTP method does not allow attaching a request body.")
1094−#endif
1095−
1096−instance HttpBody body => RequestComponent (Womb "body" body) where
1097− getRequestMod (Womb body) = Endo $ \x ->
1098− x { L.requestBody = getRequestBody body
1099− , L.requestHeaders =
1100− let old = L.requestHeaders x in
1101− case getRequestContentType body of
1102− Nothing -> old
1103− Just contentType ->
1104− (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+ }
11051394
11061395----------------------------------------------------------------------------
11071396-- Request—Optional parameters
11081397
11091398-- $optional-parameters
11101399--
1111−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
11121401-- headers, port number, etc. All optional parameters have the type
11131402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
11141403-- the last argument of 'req' to specify no optional parameters, or combine
@@ -1117,52 +1406,51 @@ instance HttpBody body => RequestComponent (Womb "body" body) where
11171406-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
11181407-- of optional parameters like query parameters and headers. See sections
11191408-- 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))
11201411
1121−data Option (scheme :: Scheme) =
1122− Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1123− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1124− -- Request to avoid appending to existing query string in request every
1125− -- time new parameter is added. Additional Maybe (L.Request -> IO
1126− -- L.Request) is a finalizer that will be applied after all other
1127− -- transformations. This is for authentication methods that sign requests
1128− -- 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.
11291418
11301419instance Semigroup (Option scheme) where
1131− Option er0 mr0 <> Option er1 mr1 = Option
1132− (er0 <> er1) (mr0 <|> mr1)
1420+ Option er0 mr0 <> Option er1 mr1 =
1421+ Option
1422+ (er0 <> er1)
1423+ (mr0 <|> mr1)
11331424
11341425instance Monoid (Option scheme) where
1135− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
11361427 mappend = (<>)
11371428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
11381435-- | A helper to create an 'Option' that modifies only collection of query
11391436-- parameters. This helper is not a part of the public API.
1140−
11411437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
11421438withQueryParams f = Option (Endo (first f)) Nothing
11431439
11441440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
11451441-- helper is not a part of public API.
1146−
11471442withRequest :: (L.Request -> L.Request) -> Option scheme
11481443withRequest f = Option (Endo (second f)) Nothing
11491444
1150−-- | A helper to create an 'Option' that adds a finalizer (an IO-enabled
1151−-- request transformation that is applied after all other modifications).
1152−
1153−asFinalizer :: (L.Request -> IO L.Request) -> Option scheme
1154−asFinalizer = Option mempty . pure
1155−
11561445instance RequestComponent (Option scheme) where
11571446 getRequestMod (Option f _) = Endo $ \x ->
11581447 let (qparams, x') = appEndo f ([], x)
1159− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1160− in x' { L.queryString = query }
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449+ in x' {L.queryString = query}
11611450
11621451-- | Finalize given 'L.Request' by applying a finalizer from the given
11631452-- 'Option' (if it has any).
1164−
1165−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
11661454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
11671455
11681456----------------------------------------------------------------------------
@@ -1181,12 +1469,12 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
11811469-- This operator is defined in terms of 'queryParam':
11821470--
11831471-- > name =: value = queryParam name (pure value)
1184−
11851472infix 7 =:
1473+
11861474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
11871475name =: value = queryParam name (pure value)
11881476
1189−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
11901478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
11911479-- with a value:
11921480--
@@ -1195,27 +1483,47 @@ name =: value = queryParam name (pure value)
11951483-- This operator is defined in terms of 'queryParam':
11961484--
11971485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1198−
1199−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
12001487queryFlag name = queryParam name (Nothing :: Maybe ())
12011488
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+
12021507-- | A type class for query-parameter-like things. The reason to have an
12031508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
12041509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
12051510-- Having the same syntax for these cases seems natural and user-friendly.
1206−
12071511class QueryParam param where
1208−
12091512 -- | Create a query parameter with given name and value. If value is
12101513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
12111514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
12121515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
12131517
1214− 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)]
12151522
12161523instance QueryParam (Option scheme) where
12171524 queryParam name mvalue =
12181525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
12191527
12201528----------------------------------------------------------------------------
12211529-- Request—Optional parameters—Headers
@@ -1224,19 +1532,28 @@ instance QueryParam (Option scheme) where
12241532-- headers with the same names the leftmost header will win. This means, in
12251533-- particular, that you cannot create a request with several headers of the
12261534-- same name.
1227−
1228−header
1229− :: ByteString -- ^ Header name
1230− -> ByteString -- ^ Header value
1231− -> Option scheme
1535+header ::
1536+ -- | Header name
1537+ ByteString ->
1538+ -- | Header value
1539+ ByteString ->
1540+ Option scheme
12321541header name value = withRequest (attachHeader name value)
12331542
1234−-- | A non-public helper that attaches a header with given name and content
1235−-- to a 'L.Request'.
1236−
1543+-- | Attach a header with given name and content to a 'L.Request'.
1544+--
1545+-- @since 1.1.0
12371546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
12381547attachHeader name value x =
1239− 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}
12401557
12411558----------------------------------------------------------------------------
12421559-- Request—Optional parameters—Cookies
@@ -1249,10 +1566,9 @@ attachHeader name value x =
12491566
12501567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
12511568-- 'L.Response' record.
1252−
12531569cookieJar :: L.CookieJar -> Option scheme
12541570cookieJar jar = withRequest $ \x ->
1255− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
12561572
12571573----------------------------------------------------------------------------
12581574-- Request—Optional parameters—Authentication
@@ -1270,42 +1586,66 @@ cookieJar jar = withRequest $ \x ->
12701586-- | The 'Option' adds basic authentication.
12711587--
12721588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1273−
1274−basicAuth
1275− :: ByteString -- ^ Username
1276− -> ByteString -- ^ Password
1277− -> Option 'Https -- ^ Auth 'Option'
1589+basicAuth ::
1590+ -- | Username
1591+ ByteString ->
1592+ -- | Password
1593+ ByteString ->
1594+ -- | Auth 'Option'
1595+ Option 'Https
12781596basicAuth = basicAuthUnsafe
12791597
12801598-- | An alternative to 'basicAuth' which works for any scheme. Note that
1281−-- using basic access authentication without SSL/TLS is vulnerable to
1599+-- using basic access authentication without SSL\/TLS is vulnerable to
12821600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
12831601--
12841602-- @since 0.3.1
1285−
1286−basicAuthUnsafe
1287− :: ByteString -- ^ Username
1288− -> ByteString -- ^ Password
1289− -> Option scheme -- ^ Auth 'Option'
1290−basicAuthUnsafe username password = asFinalizer
1291− (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)
1613+
1614+-- | The 'Option' set basic proxy authentication header.
1615+--
1616+-- @since 1.1.0
1617+basicProxyAuth ::
1618+ -- | Username
1619+ ByteString ->
1620+ -- | Password
1621+ ByteString ->
1622+ -- | Auth 'Option'
1623+ Option scheme
1624+basicProxyAuth username password =
1625+ withRequest (L.applyBasicProxyAuth username password)
12921626
12931627-- | The 'Option' adds OAuth1 authentication.
12941628--
12951629-- @since 0.2.0
1296−
1297−oAuth1
1298− :: ByteString -- ^ Consumer token
1299− -> ByteString -- ^ Consumer secret
1300− -> ByteString -- ^ OAuth token
1301− -> ByteString -- ^ OAuth token secret
1302− -> 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
13031641oAuth1 consumerToken consumerSecret token tokenSecret =
1304− asFinalizer (OAuth.signOAuth app creds)
1642+ customAuth (OAuth.signOAuth app creds)
13051643 where
1306− app = OAuth.newOAuth
1307− { OAuth.oauthConsumerKey = consumerToken
1308− , OAuth.oauthConsumerSecret = consumerSecret }
1644+ app =
1645+ OAuth.newOAuth
1646+ { OAuth.oauthConsumerKey = consumerToken,
1647+ OAuth.oauthConsumerSecret = consumerSecret
1648+ }
13091649 creds = OAuth.newCredential token tokenSecret
13101650
13111651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1316,12 +1656,14 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
13161656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
13171657--
13181658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1319−
1320−oAuth2Bearer
1321− :: ByteString -- ^ Token
1322− -> Option 'Https -- ^ Auth 'Option'
1323−oAuth2Bearer token = asFinalizer
1324− (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))
13251667
13261668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
13271669-- to be used only by GitHub). This will be treated by whatever services
@@ -1332,23 +1674,32 @@ oAuth2Bearer token = asFinalizer
13321674-- > oAuth2Token token = header "Authorization" ("token" <> token)
13331675--
13341676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1335−
1336−oAuth2Token
1337− :: ByteString -- ^ Token
1338− -> Option 'Https -- ^ Auth 'Option'
1339−oAuth2Token token = asFinalizer
1340− (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))
1685+
1686+-- | A helper to create custom authentication 'Option's. The given
1687+-- 'IO'-enabled request transformation is applied after all other
1688+-- modifications when constructing a request. Use wisely.
1689+--
1690+-- @since 1.1.0
1691+customAuth :: (L.Request -> IO L.Request) -> Option scheme
1692+customAuth = Option mempty . pure
13411693
13421694----------------------------------------------------------------------------
13431695-- Request—Optional parameters—Other
13441696
13451697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
13461698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1347−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1348−
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
13491700port :: Int -> Option scheme
13501701port n = withRequest $ \x ->
1351− x { L.port = n }
1702+ x {L.port = n}
13521703
13531704-- | This 'Option' controls whether gzipped data should be decompressed on
13541705-- the fly. By default everything except for @\"application\/x-tar\"@ is
@@ -1359,39 +1710,40 @@ port n = withRequest $ \x ->
13591710-- You can also choose to decompress everything like this:
13601711--
13611712-- > decompress (const True)
1362−
1363−decompress
1364− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1365− -- returns 'True' when content should be decompressed on the fly.
1366− -> 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
13671718decompress f = withRequest $ \x ->
1368− x { L.decompress = f }
1719+ x {L.decompress = f}
13691720
13701721-- | Specify the number of microseconds to wait for response. The default
13711722-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
13721723-- 'L.Manager').
1373−
1374−responseTimeout
1375− :: Int -- ^ Number of microseconds to wait
1376− -> Option scheme
1724+responseTimeout ::
1725+ -- | Number of microseconds to wait
1726+ Int ->
1727+ Option scheme
13771728responseTimeout n = withRequest $ \x ->
1378− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
13791730
13801731-- | HTTP version to send to the server, the default is HTTP 1.1.
1381−
1382−httpVersion
1383− :: Int -- ^ Major version number
1384− -> Int -- ^ Minor version number
1385− -> Option scheme
1732+httpVersion ::
1733+ -- | Major version number
1734+ Int ->
1735+ -- | Minor version number
1736+ Int ->
1737+ Option scheme
13861738httpVersion major minor = withRequest $ \x ->
1387− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
13881740
13891741----------------------------------------------------------------------------
13901742-- Response interpretations
13911743
13921744-- | Make a request and ignore the body of the response.
1393−
13941745newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
13951747
13961748instance HttpResponse IgnoreResponse where
13971749 type HttpResponseBody IgnoreResponse = ()
@@ -1400,7 +1752,6 @@ instance HttpResponse IgnoreResponse where
14001752
14011753-- | Use this as the fourth argument of 'req' to specify that you want it to
14021754-- ignore the response body.
1403−
14041755ignoreResponse :: Proxy IgnoreResponse
14051756ignoreResponse = Proxy
14061757
@@ -1408,28 +1759,28 @@ ignoreResponse = Proxy
14081759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
14091760-- monad in which you use 'req' will determine what to do in the case when
14101761-- parsing fails (the 'JsonHttpException' constructor will be used).
1411−
14121762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
14131764
1414−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
14151766 type HttpResponseBody (JsonResponse a) = a
14161767 toVanillaResponse (JsonResponse r) = r
14171768 getHttpResponse r = do
14181769 chunks <- L.brConsume (L.responseBody r)
14191770 case A.eitherDecode (BL.fromChunks chunks) of
1420− Left e -> throwIO (JsonHttpException e)
1771+ Left e -> throwIO (JsonHttpException e)
14211772 Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
14221774
14231775-- | Use this as the fourth argument of 'req' to specify that you want it to
14241776-- return the 'JsonResponse' interpretation.
1425−
14261777jsonResponse :: Proxy (JsonResponse a)
14271778jsonResponse = Proxy
14281779
14291780-- | Make a request and interpret the body of the response as a strict
14301781-- 'ByteString'.
1431−
14321782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
14331784
14341785instance HttpResponse BsResponse where
14351786 type HttpResponseBody BsResponse = ByteString
@@ -1440,14 +1791,13 @@ instance HttpResponse BsResponse where
14401791
14411792-- | Use this as the fourth argument of 'req' to specify that you want to
14421793-- interpret the response body as a strict 'ByteString'.
1443−
14441794bsResponse :: Proxy BsResponse
14451795bsResponse = Proxy
14461796
14471797-- | Make a request and interpret the body of the response as a lazy
14481798-- 'BL.ByteString'.
1449−
14501799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
14511801
14521802instance HttpResponse LbsResponse where
14531803 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1458,24 +1808,22 @@ instance HttpResponse LbsResponse where
14581808
14591809-- | Use this as the fourth argument of 'req' to specify that you want to
14601810-- interpret the response body as a lazy 'BL.ByteString'.
1461−
14621811lbsResponse :: Proxy LbsResponse
14631812lbsResponse = Proxy
14641813
14651814----------------------------------------------------------------------------
14661815-- Helpers for response interpretations
14671816
1468−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
14691818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
14701819-- such.
1471−
1472−grabPreview
1473− :: Int
1474− -- ^ How many bytes to fetch
1475− -> L.Response L.BodyReader
1476− -- ^ Response with body reader inside
1477− -> IO (ByteString, L.Response L.BodyReader)
1478− -- ^ 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)
14791827grabPreview nbytes r = do
14801828 let br = L.responseBody r
14811829 (target, leftover, done) <- brReadN br nbytes
@@ -1498,18 +1846,17 @@ grabPreview nbytes r = do
14981846 if done
14991847 then return B.empty
15001848 else br
1501− return (target, r { L.responseBody = br' })
1849+ return (target, r {L.responseBody = br'})
15021850
15031851-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
15041852-- leftover (may be empty), and whether we're done consuming the body.
1505−
1506−brReadN
1507− :: L.BodyReader
1508− -- ^ Body reader to stream from
1509− -> Int
1510− -- ^ How many bytes to consume
1511− -> IO (ByteString, ByteString, Bool)
1512− -- ^ 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)
15131860brReadN br n = go 0 id id
15141861 where
15151862 go !tlen t l = do
@@ -1518,9 +1865,9 @@ brReadN br n = go 0 id id
15181865 then return (r t, r l, True)
15191866 else do
15201867 let (target, leftover) = B.splitAt (n - tlen) chunk
1521− tlen' = B.length target
1522− t' = t . (target:)
1523− l' = l . (leftover:)
1868+ tlen' = B.length target
1869+ t' = t . (target :)
1870+ l' = l . (leftover :)
15241871 if tlen + tlen' < n
15251872 then go (tlen + tlen') t' l'
15261873 else return (r t', r l', False)
@@ -1530,47 +1877,45 @@ brReadN br n = go 0 id id
15301877-- Inspecting a response
15311878
15321879-- | Get the response body.
1533−
1534−responseBody
1535− :: HttpResponse response
1536− => response
1537− -> HttpResponseBody response
1880+responseBody ::
1881+ (HttpResponse response) =>
1882+ response ->
1883+ HttpResponseBody response
15381884responseBody = L.responseBody . toVanillaResponse
15391885
15401886-- | Get the response status code.
1541−
1542−responseStatusCode
1543− :: HttpResponse response
1544− => response
1545− -> Int
1887+responseStatusCode ::
1888+ (HttpResponse response) =>
1889+ response ->
1890+ Int
15461891responseStatusCode =
15471892 Y.statusCode . L.responseStatus . toVanillaResponse
15481893
15491894-- | Get the response status message.
1550−
1551−responseStatusMessage
1552− :: HttpResponse response
1553− => response
1554− -> ByteString
1895+responseStatusMessage ::
1896+ (HttpResponse response) =>
1897+ response ->
1898+ ByteString
15551899responseStatusMessage =
15561900 Y.statusMessage . L.responseStatus . toVanillaResponse
15571901
15581902-- | Lookup a particular header from a response.
1559−
1560−responseHeader
1561− :: HttpResponse response
1562− => response -- ^ Response interpretation
1563− -> ByteString -- ^ Header to lookup
1564− -> 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
15651911responseHeader r h =
15661912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
15671913
15681914-- | Get the response 'L.CookieJar'.
1569−
1570−responseCookieJar
1571− :: HttpResponse response
1572− => response
1573− -> L.CookieJar
1915+responseCookieJar ::
1916+ (HttpResponse response) =>
1917+ response ->
1918+ L.CookieJar
15741919responseCookieJar = L.responseCookieJar . toVanillaResponse
15751920
15761921----------------------------------------------------------------------------
@@ -1581,19 +1926,15 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
15811926-- To create a new response interpretation you just need to make your data
15821927-- type an instance of the 'HttpResponse' type class.
15831928
1584−-- | A type class for response interpretations. It allows to describe how to
1585−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1586−-- final result that is to be returned to the user.
1587−
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.
15881932class HttpResponse response where
1589−
15901933 -- | The associated type is the type of body that can be extracted from an
15911934 -- instance of 'HttpResponse'.
1592−
1593− type HttpResponseBody response :: *
1935+ type HttpResponseBody response :: Type
15941936
15951937 -- | The method describes how to get the underlying 'L.Response' record.
1596−
15971938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
15981939
15991940 -- | This method describes how to consume response body and, more
@@ -1609,12 +1950,32 @@ class HttpResponse response where
16091950 --
16101951 -- __Note__: signature of this function was changed in the version
16111952 -- /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
16121969
1613− getHttpResponse
1614− :: L.Response L.BodyReader
1615− -- ^ Response with body reader inside
1616− -> IO response
1617− -- ^ 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
16181979
16191980----------------------------------------------------------------------------
16201981-- Other
@@ -1626,15 +1987,12 @@ class HttpResponse response where
16261987-- request components easier using @('<>')@.
16271988--
16281989-- __Note__: this type class is not a part of the public API.
1629−
16301990class RequestComponent a where
1631−
16321991 -- | Get a function that takes a 'L.Request' and changes it somehow
16331992 -- returning another 'L.Request'. For example, the 'HttpMethod' instance
16341993 -- of 'RequestComponent' just overwrites method. The function is wrapped
16351994 -- in 'Endo' so it's easier to chain such “modifying applications”
16361995 -- together building bigger and bigger 'RequestComponent's.
1637−
16381996 getRequestMod :: a -> Endo L.Request
16391997
16401998-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -1644,44 +2002,50 @@ class RequestComponent a where
16442002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
16452003-- which instance to use (i.e. the constraints are taken into account later,
16462004-- when instance is already chosen).
1647−
1648−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
16492006
16502007-- | Exceptions that this library throws.
1651−
16522008data HttpException
1653− = VanillaHttpException L.HttpException
1654− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1655− | JsonHttpException String
1656− -- ^ 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
16572012 -- failed
1658− deriving (Show, Typeable, Generic)
2013+ JsonHttpException String
2014+ deriving (Show, Generic)
16592015
16602016instance Exception HttpException
16612017
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+
16622032-- | A simple type isomorphic to 'Bool' that we only have for better error
16632033-- messages. We use it as a kind and its data constructors as type-level
16642034-- tags.
16652035--
16662036-- See also: 'HttpMethod' and 'HttpBody'.
1667−
16682037data CanHaveBody
1669− = CanHaveBody -- ^ Indeed can have a body
1670− | NoBody -- ^ Should not have a body
2038+ = -- | Indeed can have a body
2039+ CanHaveBody
2040+ | -- | Should not have a body
2041+ NoBody
16712042
16722043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
16732044-- enabled). This is used to force TLS requirement for some authentication
16742045-- 'Option's.
1675−
16762046data Scheme
1677− = Http -- ^ HTTP
1678− | Https -- ^ HTTPS
1679− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1680−
1681−----------------------------------------------------------------------------
1682−-- Constants
1683−
1684−-- | Max length of preview fragment of response body.
1685−
1686−bodyPreviewLength :: Num a => a
1687−bodyPreviewLength = 1024
2047+ = -- | HTTP
2048+ Http
2049+ | -- | HTTPS
2050+ Https
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)