@@ -1,3 +1,13 @@
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
313-- Copyright : © 2016–present Mark Karpov
@@ -9,61 +19,40 @@
919--
1020-- The documentation below is structured in such a way that the most
1121-- important information is presented first: you learn how to do HTTP
12−-- requests, how to embed them in any monad you have, and then it gives you
22+-- requests, how to embed them in the monad you have, and then it gives you
1323-- details about less-common things you may want to know about. The
1424-- documentation is written with sufficient coverage of details and
1525-- examples, and it's designed to be a complete tutorial on its own.
1626--
17−-- /(A modest intro goes here, click on 'req' to start making requests.)/
18−--
1927-- === About the library
2028--
21−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
22−-- library that just works without any fooling around.
23−--
24−-- What does the phrase “easy-to-use” mean? It means that the library is
25−-- designed to be beginner-friendly so it's simple to add to your monad
26−-- stack, intuitive to work with, well-documented, and does not get in your
27−-- way. Doing HTTP requests is a common task and Haskell library for this
28−-- should be very approachable and clear to beginners, thus certain
29−-- compromises were made. For example, one cannot currently modify
30−-- 'L.ManagerSettings' of the default manager because the library always
31−-- uses the same implicit global manager for simplicity and maximal
32−-- connection sharing. There is a way to use your own manager with different
33−-- settings, but it requires a bit more typing.
34−--
35−-- “Type-safe” means that the library is protective and eliminates certain
36−-- classes of errors. For example, we have correct-by-construction 'Url's,
37−-- it's guaranteed that the user does not send the request body when using
38−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
39−-- is minimized by making the user specify his\/her intentions in an
40−-- explicit form (for example, it's not possible to avoid specifying the
41−-- body or method of request). Authentication methods that assume HTTPS
42−-- force the user to use HTTPS at the type level. The library also carefully
43−-- hides underlying types from the lower-level @http-client@ package because
44−-- those types are not safe enough (for example 'L.Request' is an instance
45−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
46−-- run-time).
47−--
48−-- “Expandable” refers to the ability of the library to be expanded without
49−-- having to resort to ugly hacking. For example, it's possible to define
50−-- your own HTTP methods, create new ways to construct the body of a
51−-- request, create new authorization options, perform a request in a
52−-- different way, and create your own methods to parse and represent a
53−-- response. As the user extends the library to satisfy his\/her special
54−-- needs, the new solutions will work just like the built-ins. However, all
55−-- of the common cases are also covered by the library out-of-the-box.
56−--
57−-- “High-level” means that there are less details to worry about. The
58−-- library is a result of my experiences as a Haskell consultant. Working
59−-- for several clients, who had very different projects, showed me that the
60−-- library should adapt easily to any particular style of writing Haskell
61−-- applications. For example, some people prefer throwing exceptions, while
62−-- others are concerned with purity. Just define 'handleHttpException'
63−-- accordingly when making your monad instance of 'MonadHttp' and it will
64−-- play together seamlessly. Finally, the library cuts down boilerplate
65−-- considerably, and helps you write concise, easy to read, and maintainable
66−-- code.
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30+-- and expandable.
31+--
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
33+-- so it's simple to add to your monad stack, intuitive to work with,
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
35+-- common task and a Haskell library for this should be approachable and
36+-- clear to beginners, thus certain compromises were made. For example, one
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
39+-- simplicity and maximal connection sharing. There is a way to use your own
40+-- manager with different settings, but it requires more typing.
41+--
42+-- “Type-safe” means that the library tries to eliminate certain classes of
43+-- errors. For example, we have correct-by-construction URLs; it is
44+-- guaranteed that the user does not send the request body when using
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46+-- minimized by making the user specify their intentions in an explicit
47+-- form. For example, it's not possible to avoid specifying the body or the
48+-- method of a request. Authentication methods that assume HTTPS force the
49+-- user to use HTTPS at the type level.
50+--
51+-- “Expandable” refers to the ability to create new components without
52+-- having to resort to hacking. For example, it's possible to define your
53+-- own HTTP methods, create new ways to construct the body of a request,
54+-- create new authorization options, perform a request in a different way,
55+-- and create your own methods to parse a response.
6756--
6857-- === Using with other libraries
6958--
@@ -87,170 +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 DataKinds #-}
93−{-# LANGUAGE DeriveDataTypeable #-}
94−{-# LANGUAGE DeriveGeneric #-}
95−{-# LANGUAGE FlexibleInstances #-}
96−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
97−{-# LANGUAGE KindSignatures #-}
98−{-# LANGUAGE LambdaCase #-}
99−{-# LANGUAGE MultiParamTypeClasses #-}
100−{-# LANGUAGE OverloadedStrings #-}
101−{-# LANGUAGE QuasiQuotes #-}
102−{-# LANGUAGE RankNTypes #-}
103−{-# LANGUAGE RecordWildCards #-}
104−{-# LANGUAGE ScopedTypeVariables #-}
105−{-# LANGUAGE TypeFamilies #-}
106−{-# LANGUAGE UndecidableInstances #-}
107−
10879module Network.HTTP.Req
10980 ( -- * Making a request
11081 -- $making-a-request
111− req
112− , reqBr
113− , req'
114− , withReqManager
82+ req,
83+ reqBr,
84+ reqCb,
85+ req',
86+ withReqManager,
87+
11588 -- * Embedding requests in your monad
11689 -- $embedding-requests
117− , MonadHttp (..)
118− , HttpConfig (..)
119− , defaultHttpConfig
120− , Req
121− , runReq
90+ MonadHttp (..),
91+ HttpConfig (..),
92+ defaultHttpConfig,
93+ Req,
94+ runReq,
95+
12296 -- * Request
97+
12398 -- ** Method
12499 -- $method
125− , GET (..)
126− , POST (..)
127− , HEAD (..)
128− , PUT (..)
129− , DELETE (..)
130− , TRACE (..)
131− , CONNECT (..)
132− , OPTIONS (..)
133− , PATCH (..)
134− , HttpMethod (..)
100+ GET (..),
101+ POST (..),
102+ HEAD (..),
103+ PUT (..),
104+ DELETE (..),
105+ TRACE (..),
106+ CONNECT (..),
107+ OPTIONS (..),
108+ PATCH (..),
109+ HttpMethod (..),
110+
135111 -- ** URL
136112 -- $url
137− , Url
138− , http
139− , https
140− , (/~)
141− , (/:)
142− , useHttpURI
143− , useHttpsURI
144− , useURI
113+ Url,
114+ http,
115+ https,
116+ (/~),
117+ (/:),
118+ useHttpURI,
119+ useHttpsURI,
120+ useURI,
121+ urlQ,
122+ renderUrl,
123+
145124 -- ** Body
146125 -- $body
147− , NoReqBody (..)
148− , ReqBodyJson (..)
149− , ReqBodyFile (..)
150− , ReqBodyBs (..)
151− , ReqBodyLbs (..)
152− , ReqBodyUrlEnc (..)
153− , FormUrlEncodedParam
154− , ReqBodyMultipart
155− , reqBodyMultipart
156− , HttpBody (..)
157− , ProvidesBody
158− , 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+
159139 -- ** Optional parameters
160140 -- $optional-parameters
161− , Option
141+ Option,
142+
162143 -- *** Query parameters
163144 -- $query-parameters
164− , (=:)
165− , queryFlag
166− , QueryParam (..)
145+ (=:),
146+ queryFlag,
147+ formToQuery,
148+ QueryParam (..),
149+
167150 -- *** Headers
168− , header
169− , attachHeader
151+ header,
152+ attachHeader,
153+ headerRedacted,
154+
170155 -- *** Cookies
171156 -- $cookies
172− , cookieJar
157+ cookieJar,
158+
173159 -- *** Authentication
174160 -- $authentication
175− , basicAuth
176− , basicAuthUnsafe
177− , basicProxyAuth
178− , oAuth1
179− , oAuth2Bearer
180− , oAuth2Token
181− , customAuth
161+ basicAuth,
162+ basicAuthUnsafe,
163+ basicProxyAuth,
164+ oAuth1,
165+ oAuth2Bearer,
166+ oAuth2Token,
167+ customAuth,
168+
182169 -- *** Other
183− , port
184− , decompress
185− , responseTimeout
186− , httpVersion
170+ port,
171+ decompress,
172+ responseTimeout,
173+ httpVersion,
174+
187175 -- * Response
176+
188177 -- ** Response interpretations
189− , IgnoreResponse
190− , ignoreResponse
191− , JsonResponse
192− , jsonResponse
193− , BsResponse
194− , bsResponse
195− , LbsResponse
196− , lbsResponse
178+ IgnoreResponse,
179+ ignoreResponse,
180+ JsonResponse,
181+ jsonResponse,
182+ BsResponse,
183+ bsResponse,
184+ LbsResponse,
185+ lbsResponse,
186+
197187 -- ** Inspecting a response
198− , responseBody
199− , responseStatusCode
200− , responseStatusMessage
201− , responseHeader
202− , responseCookieJar
188+ responseBody,
189+ responseStatusCode,
190+ responseStatusMessage,
191+ responseHeader,
192+ responseCookieJar,
193+
203194 -- ** Defining your own interpretation
204195 -- $new-response-interpretation
205− , HttpResponse (..)
196+ HttpResponse (..),
197+
206198 -- * Other
207− , HttpException (..)
208− , CanHaveBody (..)
209− , Scheme (..) )
199+ HttpException (..),
200+ isStatusCodeException,
201+ CanHaveBody (..),
202+ Scheme (..),
203+ )
210204where
211205
206+import Blaze.ByteString.Builder qualified as BB
212207import Control.Applicative
213208import Control.Arrow (first, second)
214−import Control.Exception hiding (TypeError)
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)
239+import Data.Default.Class (def)
223240import Data.Function (on)
224241import Data.IORef
225242import Data.Kind (Constraint, Type)
226−import Data.List (nubBy, foldl')
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)
236266import 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
237272import Web.HttpApiData (ToHttpApiData (..))
238−import qualified Blaze.ByteString.Builder as BB
239−import qualified Data.Aeson as A
240−import qualified Data.ByteString as B
241−import qualified Data.ByteString.Lazy as BL
242−import qualified Data.CaseInsensitive as CI
243−import qualified Data.List.NonEmpty as NE
244−import qualified Data.Text.Encoding as T
245−import qualified Network.Connection as NC
246−import qualified Network.HTTP.Client as L
247−import qualified Network.HTTP.Client.Internal as LI
248−import qualified Network.HTTP.Client.MultipartFormData as LM
249−import qualified Network.HTTP.Client.TLS as L
250−import qualified Network.HTTP.Types as Y
251−import qualified Text.URI as URI
252−import qualified Text.URI.QQ as QQ
253−import qualified Web.Authenticate.OAuth as OAuth
254273
255274----------------------------------------------------------------------------
256275-- Making a request
@@ -274,7 +293,7 @@ import qualified Web.Authenticate.OAuth as OAuth
274293--
275294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
276295-- tutorial has a section about HTTP bodies, but usage is very
277−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
278297--
279298-- @response@ is a type hint how to make and interpret response of an HTTP
280299-- request. Out-of-the-box it can be the following:
@@ -382,65 +401,138 @@ import qualified Web.Authenticate.OAuth as OAuth
382401-- > options <> -- contains the ?foo=bar part
383402-- > port 443 -- here you can put any port of course
384403-- > liftIO $ print (responseBody response :: Value)
385−
386−req
387− :: ( MonadHttp m
388− , HttpMethod method
389− , HttpBody body
390− , HttpResponse response
391− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
392− => method -- ^ HTTP method
393− -> Url scheme -- ^ 'Url'—location of resource
394− -> body -- ^ Body of the request
395− -> Proxy response -- ^ A hint how to interpret response
396− -> Option scheme -- ^ Collection of optional parameters
397− -> m response -- ^ Response
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
398423req method url body responseProxy options =
399− reqBr method url body (options <> extraOptions) getHttpResponse
400− where
401− extraOptions =
402− case acceptHeader responseProxy of
403− Nothing -> mempty
404− Just accept -> header "Accept" accept
424+ reqCb method url body responseProxy options pure
405425
406426-- | A version of 'req' that does not use one of the predefined instances of
407427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
408428-- 'L.BodyReader'@ manually, in a custom way.
409429--
410430-- @since 1.0.0
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
411486
412−reqBr
413− :: ( MonadHttp m
414− , HttpMethod method
415− , HttpBody body
416− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
417− => method -- ^ HTTP method
418− -> Url scheme -- ^ 'Url'—location of resource
419− -> body -- ^ Body of the request
420− -> Option scheme -- ^ Collection of optional parameters
421− -> (L.Response L.BodyReader -> IO a) -- ^ How to consume response
422− -> m a -- ^ Result
423−reqBr method url body options consume = req' method url body options $ \request manager -> do
424− HttpConfig {..} <- getHttpConfig
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
425502 let wrapVanilla = handle (throwIO . VanillaHttpException)
426− wrapExc = handle (throwIO . LI.toHttpException request)
427− withRRef = bracket
428− (newIORef Nothing)
429− (readIORef >=> mapM_ L.responseClose)
430− (liftIO . try . wrapVanilla . wrapExc) (withRRef $ \rref -> do
431− let openResponse = mask_ $ do
432− r <- readIORef rref
433− mapM_ L.responseClose r
434− r' <- L.responseOpen request manager
435− writeIORef rref (Just r')
436− return r'
437− r <- retrying
438− httpConfigRetryPolicy
439− (\st r -> return $ httpConfigRetryJudge st r)
440− (const openResponse)
441− (preview, r') <- grabPreview bodyPreviewLength r
442− mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
443− 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+ )
444536 >>= either handleHttpException return
445537
446538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
@@ -451,51 +543,57 @@ reqBr method url body options consume = req' method url body options $ \request
451543-- 'L.Request' and allows you to use it.
452544--
453545-- @since 0.3.0
454−
455−req'
456− :: forall m method body scheme a.
457− ( MonadHttp m
458− , HttpMethod method
459− , HttpBody body
460− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
461− => method -- ^ HTTP method
462− -> Url scheme -- ^ 'Url'—location of resource
463− -> body -- ^ Body of the request
464− -> Option scheme -- ^ Collection of optional parameters
465− -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
466− -> 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
467565req' method url body options m = do
468− config@HttpConfig {..} <- getHttpConfig
566+ config <- getHttpConfig
469567 let -- NOTE First appearance of any given header wins. This allows to
470568 -- “overwrite” headers when we construct a request by cons-ing.
471569 nubHeaders = Endo $ \x ->
472− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
473− request' = flip appEndo L.defaultRequest $
474− -- NOTE The order of 'mappend's matters, here method is overwritten
475− -- first and 'options' take effect last. In particular, this means
476− -- that 'options' can overwrite things set by other request
477− -- components, which is useful for setting port number,
478− -- "Content-Type" header, etc.
479− nubHeaders <>
480− getRequestMod options <>
481− getRequestMod config <>
482− getRequestMod (Womb body :: Womb "body" body) <>
483− getRequestMod url <>
484− 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)
485584 request <- finalizeRequest options request'
486585 withReqManager (m request)
487586
488587-- | Perform an action using the global implicit 'L.Manager' that the rest
489−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
490589-- 'L.Manager' controls.
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
491592
492−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
493−withReqManager m = liftIO (readIORef globalManager) >>= m
494−
495−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
496−-- settings, so users don't need to deal with this manager stuff at all, but
497−-- when we create a request, instance 'HttpConfig' can affect the default
498−-- 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'.
499597--
500598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
501599-- The value of 'globalManager' is named and lives on top level. This means
@@ -503,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
503601-- manager. From that moment on the 'IORef' will be just reused—exactly the
504602-- behavior we want here in order to maximize connection sharing. GHC could
505603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
506−
507−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
508605globalManager = unsafePerformIO $ do
509606 context <- NC.initConnectionContext
510− let settings = L.mkManagerSettingsContext
511− (Just context)
512− (NC.TLSSettingsSimple False False False)
513− Nothing
607+ let settings =
608+ L.mkManagerSettingsContext
609+ (Just context)
610+ def
611+ Nothing
514612 manager <- L.newManager settings
515− newIORef manager
613+ return manager
516614{-# NOINLINE globalManager #-}
517615
518616----------------------------------------------------------------------------
@@ -526,55 +624,43 @@ globalManager = unsafePerformIO $ do
526624-- When writing a library, keep your API polymorphic in terms of
527625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
528626-- Another option is to use a @newtype@-wrapped monad stack and define
529−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
530−-- this strategy is provided out-of-the-box (see below).
627+-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
628+-- follows this strategy is provided out-of-the-box (see below).
531629
532630-- | A type class for monads that support performing HTTP requests.
533631-- Typically, you only need to define the 'handleHttpException' method
534632-- unless you want to tweak 'HttpConfig'.
535−
536−class MonadIO m => MonadHttp m where
537−
633+class (MonadIO m) => MonadHttp m where
538634 -- | This method describes how to deal with 'HttpException' that was
539635 -- caught by the library. One option is to re-throw it if you are OK with
540636 -- exceptions, but if you prefer working with something like
541637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
542638 -- 'Control.Monad.Except.throwError'.
543−
544639 handleHttpException :: HttpException -> m a
545640
546− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
547− -- implementation returns its 'def' value, which is described in the
548− -- documentation for the type. Common usage pattern with manually defined
549− -- 'getHttpConfig' is to return some hard-coded value, or a value
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
642+ -- Default implementation returns its 'def' value, which is described in
643+ -- the documentation for the type. Common usage pattern with manually
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
550645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
551646 -- approach to configuration is desirable.
552−
553647 getHttpConfig :: m HttpConfig
554648 getHttpConfig = return defaultHttpConfig
555649
556−-- | 'HttpConfig' contains general and default settings to be used when
557−-- making HTTP requests.
558−
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
559651data HttpConfig = HttpConfig
560− { httpConfigProxy :: Maybe L.Proxy
561− -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
652+ { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
562653 -- environment variables are respected, this setting overwrites them.
563654 -- Default value: 'Nothing'.
564− , httpConfigRedirectCount :: Int
565− -- ^ How many redirects to follow when getting a resource. Default
655+ httpConfigProxy :: Maybe L.Proxy,
656+ -- | How many redirects to follow when getting a resource. Default
566657 -- value: 10.
567− , httpConfigAltManager :: Maybe L.Manager
568− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
658+ httpConfigRedirectCount :: Int,
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
569660 -- that the default implicit manager will be used (that's what you want
570661 -- in 99% of cases).
571− , httpConfigCheckResponse
572− :: forall b.
573− L.Request
574− -> L.Response b
575− -> ByteString
576− -> Maybe L.HttpExceptionContent
577− -- ^ Function to check the response immediately after receiving the
662+ httpConfigAltManager :: Maybe L.Manager,
663+ -- | Function to check the response immediately after receiving the
578664 -- status and headers, before streaming of response body. The third
579665 -- argument is the beginning of response body (typically first 1024
580666 -- bytes). This is used for throwing exceptions on non-success status
@@ -596,67 +682,106 @@ data HttpConfig = HttpConfig
596682 -- /1.0.0/.
597683 --
598684 -- @since 0.3.0
599− , httpConfigRetryPolicy :: RetryPolicy
600− -- ^ The retry policy to use for request retrying. By default 'def' is
685+ httpConfigCheckResponse ::
686+ forall b.
687+ L.Request ->
688+ L.Response b ->
689+ ByteString ->
690+ Maybe L.HttpExceptionContent,
691+ -- | The retry policy to use for request retrying. By default 'def' is
601692 -- used (see 'RetryPolicyM').
602693 --
603− -- __Note__: signature of this function was changed in the version
604− -- /1.0.0/.
694+ -- __Note__: signature of this function was changed to disallow 'IO' in
695+ -- version /1.0.0/ and then changed back to its current form in /3.1.0/.
605696 --
606697 -- @since 0.3.0
607− , httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
608− -- ^ The function is used to decide whether to retry a request. 'True'
698+ httpConfigRetryPolicy :: RetryPolicyM IO,
699+ -- | The function is used to decide whether to retry a request. 'True'
609700 -- means that the request should be retried.
610701 --
611702 -- __Note__: signature of this function was changed in the version
612703 -- /1.0.0/.
613704 --
614705 -- @since 0.3.0
615− } deriving Typeable
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+ }
616719
617−-- | Default value of 'HttpConfig'.
720+-- | The default value of 'HttpConfig'.
618721--
619722-- @since 2.0.0
620−
621723defaultHttpConfig :: HttpConfig
622−defaultHttpConfig = HttpConfig
623− { httpConfigProxy = Nothing
624− , httpConfigRedirectCount = 10
625− , httpConfigAltManager = Nothing
626− , httpConfigCheckResponse = \_ response preview ->
627− let scode = statusCode response
628− in if 200 <= scode && scode < 300
629− then Nothing
630− else Just (L.StatusCodeException (void response) preview)
631− , httpConfigRetryPolicy = retryPolicyDefault
632− , httpConfigRetryJudge = \_ response ->
633− statusCode response `elem`
634− [ 408 -- Request timeout
635− , 504 -- Gateway timeout
636− , 524 -- A timeout occurred
637− , 598 -- (Informal convention) Network read timeout error
638− , 599 -- (Informal convention) Network connect timeout error
639− ]
640− }
724+defaultHttpConfig =
725+ HttpConfig
726+ { httpConfigProxy = Nothing,
727+ httpConfigRedirectCount = 10,
728+ httpConfigAltManager = Nothing,
729+ httpConfigCheckResponse = \_ response preview ->
730+ let scode = statusCode response
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
752+ }
641753 where
642754 statusCode = Y.statusCode . L.responseStatus
643755
644756instance RequestComponent HttpConfig where
645757 getRequestMod HttpConfig {..} = Endo $ \x ->
646− x { L.proxy = httpConfigProxy
647− , L.redirectCount = httpConfigRedirectCount
648− , LI.requestManagerOverride = httpConfigAltManager }
758+ x
759+ { L.proxy = httpConfigProxy,
760+ L.redirectCount = httpConfigRedirectCount,
761+ LI.requestManagerOverride = httpConfigAltManager
762+ }
649763
650−-- | 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
651765-- having to define new instances.
652766--
653767-- @since 0.4.0
654−
655768newtype Req a = Req (ReaderT HttpConfig IO a)
656− deriving ( Functor
657− , Applicative
658− , Monad
659− , 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
660785
661786instance MonadBase IO Req where
662787 liftBase = liftIO
@@ -665,22 +790,99 @@ instance MonadBaseControl IO Req where
665790 type StM Req a = a
666791 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
667792 {-# INLINEABLE liftBaseWith #-}
668− restoreM = Req . ReaderT . const . return
793+ restoreM = Req . ReaderT . const . return
669794 {-# INLINEABLE restoreM #-}
670795
671796instance MonadHttp Req where
672797 handleHttpException = Req . lift . throwIO
673− 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
674874
675875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
676−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
677877--
678878-- @since 0.4.0
679−
680−runReq :: MonadIO m
681− => HttpConfig -- ^ 'HttpConfig' to use
682− -> Req a -- ^ Computation to run
683− -> m a
879+runReq ::
880+ (MonadIO m) =>
881+ -- | 'HttpConfig' to use
882+ HttpConfig ->
883+ -- | Computation to run
884+ Req a ->
885+ m a
684886runReq config (Req m) = liftIO (runReaderT m config)
685887
686888----------------------------------------------------------------------------
@@ -696,7 +898,6 @@ runReq config (Req m) = liftIO (runReaderT m config)
696898-- define a new method that will works seamlessly, see 'HttpMethod'.
697899
698900-- | 'GET' method.
699−
700901data GET = GET
701902
702903instance HttpMethod GET where
@@ -704,7 +905,6 @@ instance HttpMethod GET where
704905 httpMethodName Proxy = Y.methodGet
705906
706907-- | 'POST' method.
707−
708908data POST = POST
709909
710910instance HttpMethod POST where
@@ -712,7 +912,6 @@ instance HttpMethod POST where
712912 httpMethodName Proxy = Y.methodPost
713913
714914-- | 'HEAD' method.
715−
716915data HEAD = HEAD
717916
718917instance HttpMethod HEAD where
@@ -720,26 +919,24 @@ instance HttpMethod HEAD where
720919 httpMethodName Proxy = Y.methodHead
721920
722921-- | 'PUT' method.
723−
724922data PUT = PUT
725923
726924instance HttpMethod PUT where
727925 type AllowsBody PUT = 'CanHaveBody
728926 httpMethodName Proxy = Y.methodPut
729927
730−-- | 'DELETE' method. This data type does not allow having request body with
731−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
732−-- requests to have bodies, in that case define your own variation of
733−-- 'DELETE' method and allow it to have a body.
734−
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.
735933data DELETE = DELETE
736934
737935instance HttpMethod DELETE where
738− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
739937 httpMethodName Proxy = Y.methodDelete
740938
741939-- | 'TRACE' method.
742−
743940data TRACE = TRACE
744941
745942instance HttpMethod TRACE where
@@ -747,7 +944,6 @@ instance HttpMethod TRACE where
747944 httpMethodName Proxy = Y.methodTrace
748945
749946-- | 'CONNECT' method.
750−
751947data CONNECT = CONNECT
752948
753949instance HttpMethod CONNECT where
@@ -755,7 +951,6 @@ instance HttpMethod CONNECT where
755951 httpMethodName Proxy = Y.methodConnect
756952
757953-- | 'OPTIONS' method.
758−
759954data OPTIONS = OPTIONS
760955
761956instance HttpMethod OPTIONS where
@@ -763,7 +958,6 @@ instance HttpMethod OPTIONS where
763958 httpMethodName Proxy = Y.methodOptions
764959
765960-- | 'PATCH' method.
766−
767961data PATCH = PATCH
768962
769963instance HttpMethod PATCH where
@@ -778,23 +972,19 @@ instance HttpMethod PATCH where
778972-- > instance HttpMethod COPY where
779973-- > type AllowsBody COPY = 'CanHaveBody
780974-- > httpMethodName Proxy = "COPY"
781−
782975class HttpMethod a where
783−
784976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
785977 -- tells the rest of the library whether the method can have body or not.
786978 -- We use the special type 'CanHaveBody' lifted to the kind level instead
787979 -- of 'Bool' to get more user-friendly compiler messages.
788−
789980 type AllowsBody a :: CanHaveBody
790981
791982 -- | Return name of the method as a 'ByteString'.
792−
793983 httpMethodName :: Proxy a -> ByteString
794984
795−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
796986 getRequestMod _ = Endo $ \x ->
797− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
798988
799989----------------------------------------------------------------------------
800990-- Request—URL
@@ -832,37 +1022,60 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8321022--
8331023-- > https "юникод.рф"
8341024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
835−
8361025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8371026 -- NOTE The second value is the path segments in reversed order.
838− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1028+
1029+type role Url nominal
1030+
1031+-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1032+-- the derived lift forgets the type of the scheme.
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
1034+ lift url =
1035+ TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036+ Url Http _ -> [t|Url 'Http|]
1037+ Url Https _ -> [t|Url 'Https|]
1038+ where
1039+ liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
8391041
8401042-- | Given host name, produce a 'Url' which has “http” as its scheme and
8411043-- empty path. This also sets port to @80@.
842−
8431044http :: Text -> Url 'Http
8441045http = Url Http . pure
8451046
8461047-- | Given host name, produce a 'Url' which has “https” as its scheme and
8471048-- empty path. This also sets port to @443@.
848−
8491049https :: Text -> Url 'Https
8501050https = Url Https . pure
8511051
852−-- | 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
8531053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
854−
8551054infixl 5 /~
856−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1055+
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
8571057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
8581058
859−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
8601060-- when next URL piece is a 'Data.Text.Text' literal.
861−
8621061infixl 5 /:
1062+
8631063(/:) :: Url scheme -> Text -> Url scheme
8641064(/:) = (/~)
8651065
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+
8661079-- | The 'useHttpURI' function provides an alternative method to get 'Url'
8671080-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
8681081-- given a URL to query dynamically and don't know it beforehand.
@@ -870,60 +1083,92 @@ infixl 5 /:
8701083-- This function expects the scheme to be “http” and host to be present.
8711084--
8721085-- @since 3.0.0
873−
8741086useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
8751087useHttpURI uri = do
8761088 guard (URI.uriScheme uri == Just [QQ.scheme|http|])
8771089 urlHead <- http <$> uriHost uri
8781090 let url = case URI.uriPath uri of
8791091 Nothing -> urlHead
880− Just (_, xs) ->
881− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
8821093 return (url, uriOptions uri)
8831094
8841095-- | Just like 'useHttpURI', but expects the “https” scheme.
8851096--
8861097-- @since 3.0.0
887−
8881098useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
8891099useHttpsURI uri = do
8901100 guard (URI.uriScheme uri == Just [QQ.scheme|https|])
8911101 urlHead <- https <$> uriHost uri
8921102 let url = case URI.uriPath uri of
8931103 Nothing -> urlHead
894− Just (_, xs) ->
895− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
8961105 return (url, uriOptions uri)
8971106
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+
8981119-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
8991120-- is not known in advance.
9001121--
9011122-- @since 3.0.0
902−
903−useURI
904− :: URI
905− -> Maybe (Either (Url 'Http, Option scheme0)
906− (Url 'Https, Option scheme1))
1123+useURI ::
1124+ URI ->
1125+ Maybe
1126+ ( Either
1127+ (Url 'Http, Option scheme0)
1128+ (Url 'Https, Option scheme1)
1129+ )
9071130useURI uri =
9081131 (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
9091132
9101133-- | An internal helper function to extract host from a 'URI'.
911−
9121134uriHost :: URI -> Maybe Text
9131135uriHost uri = case URI.uriAuthority uri of
9141136 Left _ -> Nothing
9151137 Right URI.Authority {..} ->
9161138 Just (URI.unRText authHost)
9171139
918−-- | An internal helper function to extract 'Option's from a 'URI'.
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+ }
9191162
1163+-- | An internal helper function to extract 'Option's from a 'URI'.
9201164uriOptions :: forall scheme. URI -> Option scheme
921−uriOptions uri = mconcat
922− [ auth
923− , query
924− , port'
925− -- , fragment'
926− ]
1165+uriOptions uri =
1166+ mconcat
1167+ [ auth,
1168+ query,
1169+ port'
1170+ -- , fragment'
1171+ ]
9271172 where
9281173 (auth, port') =
9291174 case URI.uriAuthority uri of
@@ -934,34 +1179,37 @@ uriOptions uri = mconcat
9341179 Just URI.UserInfo {..} ->
9351180 let username = T.encodeUtf8 (URI.unRText uiUsername)
9361181 password = maybe "" (T.encodeUtf8 . URI.unRText) uiPassword
937− in basicAuthUnsafe username password
1182+ in basicAuthUnsafe username password
9381183 port0 = case authPort of
9391184 Nothing -> mempty
9401185 Just port'' -> port (fromIntegral port'')
941− in (auth0, port0)
1186+ in (auth0, port0)
9421187 query =
9431188 let liftQueryParam = \case
9441189 URI.QueryFlag t -> queryFlag (URI.unRText t)
9451190 URI.QueryParam k v -> URI.unRText k =: URI.unRText v
946− in mconcat (liftQueryParam <$> URI.uriQuery uri)
947− -- TODO Blocked on upstream: https://github.com/snoyberg/http-client/issues/424
948− -- fragment' =
949− -- case URI.uriFragment uri of
950− -- Nothing -> mempty
951− -- Just fragment'' -> fragment (URI.unRText fragment'')
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'')
9521198
9531199instance RequestComponent (Url scheme) where
9541200 getRequestMod (Url scheme segments) = Endo $ \x ->
955− let (host :| path) = NE.reverse segments in
956− x { L.secure = case scheme of
957− Http -> False
958− Https -> True
959− , L.port = case scheme of
960− Http -> 80
961− Https -> 443
962− , L.host = Y.urlEncode False (T.encodeUtf8 host)
963− , L.path =
964− (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+ }
9651213
9661214----------------------------------------------------------------------------
9671215-- Request—Body
@@ -979,31 +1227,28 @@ instance RequestComponent (Url scheme) where
9791227-- only type for which 'ProvidesBody' returns 'NoBody'.
9801228--
9811229-- Using of this body option does not set the @Content-Type@ header.
982−
9831230data NoReqBody = NoReqBody
9841231
9851232instance HttpBody NoReqBody where
9861233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
9871234
988−-- | This body option allows to use a JSON object as request body—probably
989−-- the most popular format right now. Just wrap a data type that is an
990−-- instance of 'ToJSON' type class and you are done: it will be converted to
991−-- 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.
9921239--
9931240-- This body option sets the @Content-Type@ header to @\"application/json;
9941241-- charset=utf-8\"@ value.
995−
9961242newtype ReqBodyJson a = ReqBodyJson a
9971243
998−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
9991245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
10001246 getRequestContentType _ = pure "application/json; charset=utf-8"
10011247
10021248-- | This body option streams request body from a file. It is expected that
1003−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
10041250--
10051251-- Using of this body option does not set the @Content-Type@ header.
1006−
10071252newtype ReqBodyFile = ReqBodyFile FilePath
10081253
10091254instance HttpBody ReqBodyFile where
@@ -1013,7 +1258,6 @@ instance HttpBody ReqBodyFile where
10131258-- | HTTP request body represented by a strict 'ByteString'.
10141259--
10151260-- Using of this body option does not set the @Content-Type@ header.
1016−
10171261newtype ReqBodyBs = ReqBodyBs ByteString
10181262
10191263instance HttpBody ReqBodyBs where
@@ -1022,22 +1266,19 @@ instance HttpBody ReqBodyBs where
10221266-- | HTTP request body represented by a lazy 'BL.ByteString'.
10231267--
10241268-- Using of this body option does not set the @Content-Type@ header.
1025−
10261269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
10271270
10281271instance HttpBody ReqBodyLbs where
10291272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
10301273
1031−-- | Form URL-encoded body. This can hold a collection of parameters which
1032−-- are encoded similarly to query parameters at the end of query string,
1033−-- with the only difference that they are stored in request body. The
1034−-- similarity is reflected in the API as well, as you can use the same
1035−-- combinators you would use to add query parameters: @('=:')@ and
1036−-- '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'.
10371279--
10381280-- This body option sets the @Content-Type@ header to
10391281-- @\"application/x-www-form-urlencoded\"@ value.
1040−
10411282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
10421283
10431284instance HttpBody ReqBodyUrlEnc where
@@ -1047,13 +1288,19 @@ instance HttpBody ReqBodyUrlEnc where
10471288
10481289-- | An opaque monoidal value that allows to collect URL-encoded parameters
10491290-- to be wrapped in 'ReqBodyUrlEnc'.
1050−
10511291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
10521292 deriving (Semigroup, Monoid)
10531293
10541294instance QueryParam FormUrlEncodedParam where
10551295 queryParam name mvalue =
10561296 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
10571304
10581305-- | Multipart form data. Please consult the
10591306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1083,7 +1330,6 @@ instance QueryParam FormUrlEncodedParam where
10831330-- > bsResponse
10841331-- > mempty
10851332-- > liftIO $ print (responseBody response)
1086−
10871333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
10881334
10891335instance HttpBody ReqBodyMultipart where
@@ -1094,61 +1340,57 @@ instance HttpBody ReqBodyMultipart where
10941340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
10951341--
10961342-- @since 0.2.0
1097−
1098−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
10991344reqBodyMultipart parts = liftIO $ do
11001345 boundary <- LM.webkitBoundary
1101− body <- LM.renderParts boundary parts
1346+ body <- LM.renderParts boundary parts
11021347 return (ReqBodyMultipart boundary body)
11031348
11041349-- | A type class for things that can be interpreted as an HTTP
11051350-- 'L.RequestBody'.
1106−
11071351class HttpBody body where
1108−
11091352 -- | How to get actual 'L.RequestBody'.
1110−
11111353 getRequestBody :: body -> L.RequestBody
11121354
11131355 -- | This method allows us to optionally specify the value of
11141356 -- @Content-Type@ header that should be used with particular body option.
11151357 -- By default it returns 'Nothing' and so @Content-Type@ is not set.
1116−
11171358 getRequestContentType :: body -> Maybe ByteString
11181359 getRequestContentType = const Nothing
11191360
11201361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
11211362-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
11221363-- with 'GET' method and other methods that should not have body.
1123−
11241364type family ProvidesBody body :: CanHaveBody where
11251365 ProvidesBody NoReqBody = 'NoBody
1126− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
11271367
11281368-- | This type function allows any HTTP body if method says it
11291369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
11301370-- body option to use is 'NoReqBody'.
1131−--
1132−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1133−-- error message when method does not allow a body and body is provided.
1134−
1135−type family HttpBodyAllowed
1136− (allowsBody :: CanHaveBody)
1137− (providesBody :: CanHaveBody) :: Constraint where
1138− HttpBodyAllowed 'NoBody 'NoBody = ()
1139− HttpBodyAllowed 'CanHaveBody body = ()
1140− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1141− ('Text "This HTTP method does not allow attaching a request body.")
1142−
1143−instance HttpBody body => RequestComponent (Womb "body" body) where
1144− getRequestMod (Womb body) = Endo $ \x ->
1145− x { L.requestBody = getRequestBody body
1146− , L.requestHeaders =
1147− let old = L.requestHeaders x in
1148− case getRequestContentType body of
1149− Nothing -> old
1150− Just contentType ->
1151− (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+ }
11521394
11531395----------------------------------------------------------------------------
11541396-- Request—Optional parameters
@@ -1164,46 +1406,51 @@ instance HttpBody body => RequestComponent (Womb "body" body) where
11641406-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
11651407-- of optional parameters like query parameters and headers. See sections
11661408-- 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))
11671411
1168−data Option (scheme :: Scheme) =
1169− Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1170− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1171− -- Request to avoid appending to existing query string in request every
1172− -- time new parameter is added. Additional Maybe (L.Request -> IO
1173− -- L.Request) is a finalizer that will be applied after all other
1174− -- transformations. This is for authentication methods that sign requests
1175− -- 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.
11761418
11771419instance Semigroup (Option scheme) where
1178− Option er0 mr0 <> Option er1 mr1 = Option
1179− (er0 <> er1) (mr0 <|> mr1)
1420+ Option er0 mr0 <> Option er1 mr1 =
1421+ Option
1422+ (er0 <> er1)
1423+ (mr0 <|> mr1)
11801424
11811425instance Monoid (Option scheme) where
1182− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
11831427 mappend = (<>)
11841428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
11851435-- | A helper to create an 'Option' that modifies only collection of query
11861436-- parameters. This helper is not a part of the public API.
1187−
11881437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
11891438withQueryParams f = Option (Endo (first f)) Nothing
11901439
11911440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
11921441-- helper is not a part of public API.
1193−
11941442withRequest :: (L.Request -> L.Request) -> Option scheme
11951443withRequest f = Option (Endo (second f)) Nothing
11961444
11971445instance RequestComponent (Option scheme) where
11981446 getRequestMod (Option f _) = Endo $ \x ->
11991447 let (qparams, x') = appEndo f ([], x)
1200− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1201− in x' { L.queryString = query }
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449+ in x' {L.queryString = query}
12021450
12031451-- | Finalize given 'L.Request' by applying a finalizer from the given
12041452-- 'Option' (if it has any).
1205−
1206−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
12071454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
12081455
12091456----------------------------------------------------------------------------
@@ -1222,12 +1469,12 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
12221469-- This operator is defined in terms of 'queryParam':
12231470--
12241471-- > name =: value = queryParam name (pure value)
1225−
12261472infix 7 =:
1473+
12271474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
12281475name =: value = queryParam name (pure value)
12291476
1230−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
12311478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
12321479-- with a value:
12331480--
@@ -1236,27 +1483,47 @@ name =: value = queryParam name (pure value)
12361483-- This operator is defined in terms of 'queryParam':
12371484--
12381485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1239−
1240−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
12411487queryFlag name = queryParam name (Nothing :: Maybe ())
12421488
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+
12431507-- | A type class for query-parameter-like things. The reason to have an
12441508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
12451509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
12461510-- Having the same syntax for these cases seems natural and user-friendly.
1247−
12481511class QueryParam param where
1249−
12501512 -- | Create a query parameter with given name and value. If value is
12511513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
12521514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
12531515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
12541517
1255− 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)]
12561522
12571523instance QueryParam (Option scheme) where
12581524 queryParam name mvalue =
12591525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
12601527
12611528----------------------------------------------------------------------------
12621529-- Request—Optional parameters—Headers
@@ -1265,20 +1532,28 @@ instance QueryParam (Option scheme) where
12651532-- headers with the same names the leftmost header will win. This means, in
12661533-- particular, that you cannot create a request with several headers of the
12671534-- same name.
1268−
1269−header
1270− :: ByteString -- ^ Header name
1271− -> ByteString -- ^ Header value
1272− -> Option scheme
1535+header ::
1536+ -- | Header name
1537+ ByteString ->
1538+ -- | Header value
1539+ ByteString ->
1540+ Option scheme
12731541header name value = withRequest (attachHeader name value)
12741542
12751543-- | Attach a header with given name and content to a 'L.Request'.
12761544--
12771545-- @since 1.1.0
1278−
12791546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
12801547attachHeader name value x =
1281− 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}
12821557
12831558----------------------------------------------------------------------------
12841559-- Request—Optional parameters—Cookies
@@ -1291,10 +1566,9 @@ attachHeader name value x =
12911566
12921567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
12931568-- 'L.Response' record.
1294−
12951569cookieJar :: L.CookieJar -> Option scheme
12961570cookieJar jar = withRequest $ \x ->
1297− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
12981572
12991573----------------------------------------------------------------------------
13001574-- Request—Optional parameters—Authentication
@@ -1312,11 +1586,13 @@ cookieJar jar = withRequest $ \x ->
13121586-- | The 'Option' adds basic authentication.
13131587--
13141588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1315−
1316−basicAuth
1317− :: ByteString -- ^ Username
1318− -> ByteString -- ^ Password
1319− -> Option 'Https -- ^ Auth 'Option'
1589+basicAuth ::
1590+ -- | Username
1591+ ByteString ->
1592+ -- | Password
1593+ ByteString ->
1594+ -- | Auth 'Option'
1595+ Option 'Https
13201596basicAuth = basicAuthUnsafe
13211597
13221598-- | An alternative to 'basicAuth' which works for any scheme. Note that
@@ -1324,41 +1600,52 @@ basicAuth = basicAuthUnsafe
13241600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
13251601--
13261602-- @since 0.3.1
1327−
1328−basicAuthUnsafe
1329− :: ByteString -- ^ Username
1330− -> ByteString -- ^ Password
1331− -> Option scheme -- ^ Auth 'Option'
1332−basicAuthUnsafe username password = customAuth
1333− (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)
13341613
13351614-- | The 'Option' set basic proxy authentication header.
13361615--
13371616-- @since 1.1.0
1338−
1339−basicProxyAuth
1340− :: ByteString -- ^ Username
1341− -> ByteString -- ^ Password
1342− -> Option scheme -- ^ Auth 'Option'
1617+basicProxyAuth ::
1618+ -- | Username
1619+ ByteString ->
1620+ -- | Password
1621+ ByteString ->
1622+ -- | Auth 'Option'
1623+ Option scheme
13431624basicProxyAuth username password =
13441625 withRequest (L.applyBasicProxyAuth username password)
13451626
13461627-- | The 'Option' adds OAuth1 authentication.
13471628--
13481629-- @since 0.2.0
1349−
1350−oAuth1
1351− :: ByteString -- ^ Consumer token
1352− -> ByteString -- ^ Consumer secret
1353− -> ByteString -- ^ OAuth token
1354− -> ByteString -- ^ OAuth token secret
1355− -> 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
13561641oAuth1 consumerToken consumerSecret token tokenSecret =
13571642 customAuth (OAuth.signOAuth app creds)
13581643 where
1359− app = OAuth.newOAuth
1360− { OAuth.oauthConsumerKey = consumerToken
1361− , OAuth.oauthConsumerSecret = consumerSecret }
1644+ app =
1645+ OAuth.newOAuth
1646+ { OAuth.oauthConsumerKey = consumerToken,
1647+ OAuth.oauthConsumerSecret = consumerSecret
1648+ }
13621649 creds = OAuth.newCredential token tokenSecret
13631650
13641651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1369,12 +1656,14 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
13691656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
13701657--
13711658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1372−
1373−oAuth2Bearer
1374− :: ByteString -- ^ Token
1375− -> Option 'Https -- ^ Auth 'Option'
1376−oAuth2Bearer token = customAuth
1377− (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))
13781667
13791668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
13801669-- to be used only by GitHub). This will be treated by whatever services
@@ -1385,19 +1674,20 @@ oAuth2Bearer token = customAuth
13851674-- > oAuth2Token token = header "Authorization" ("token" <> token)
13861675--
13871676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1388−
1389−oAuth2Token
1390− :: ByteString -- ^ Token
1391− -> Option 'Https -- ^ Auth 'Option'
1392−oAuth2Token token = customAuth
1393− (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))
13941685
13951686-- | A helper to create custom authentication 'Option's. The given
13961687-- 'IO'-enabled request transformation is applied after all other
13971688-- modifications when constructing a request. Use wisely.
13981689--
13991690-- @since 1.1.0
1400−
14011691customAuth :: (L.Request -> IO L.Request) -> Option scheme
14021692customAuth = Option mempty . pure
14031693
@@ -1406,11 +1696,10 @@ customAuth = Option mempty . pure
14061696
14071697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
14081698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1409−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1410−
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
14111700port :: Int -> Option scheme
14121701port n = withRequest $ \x ->
1413− x { L.port = n }
1702+ x {L.port = n}
14141703
14151704-- | This 'Option' controls whether gzipped data should be decompressed on
14161705-- the fly. By default everything except for @\"application\/x-tar\"@ is
@@ -1421,39 +1710,40 @@ port n = withRequest $ \x ->
14211710-- You can also choose to decompress everything like this:
14221711--
14231712-- > decompress (const True)
1424−
1425−decompress
1426− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1427− -- returns 'True' when content should be decompressed on the fly.
1428− -> 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
14291718decompress f = withRequest $ \x ->
1430− x { L.decompress = f }
1719+ x {L.decompress = f}
14311720
14321721-- | Specify the number of microseconds to wait for response. The default
14331722-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
14341723-- 'L.Manager').
1435−
1436−responseTimeout
1437− :: Int -- ^ Number of microseconds to wait
1438− -> Option scheme
1724+responseTimeout ::
1725+ -- | Number of microseconds to wait
1726+ Int ->
1727+ Option scheme
14391728responseTimeout n = withRequest $ \x ->
1440− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
14411730
14421731-- | HTTP version to send to the server, the default is HTTP 1.1.
1443−
1444−httpVersion
1445− :: Int -- ^ Major version number
1446− -> Int -- ^ Minor version number
1447− -> Option scheme
1732+httpVersion ::
1733+ -- | Major version number
1734+ Int ->
1735+ -- | Minor version number
1736+ Int ->
1737+ Option scheme
14481738httpVersion major minor = withRequest $ \x ->
1449− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
14501740
14511741----------------------------------------------------------------------------
14521742-- Response interpretations
14531743
14541744-- | Make a request and ignore the body of the response.
1455−
14561745newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
14571747
14581748instance HttpResponse IgnoreResponse where
14591749 type HttpResponseBody IgnoreResponse = ()
@@ -1462,7 +1752,6 @@ instance HttpResponse IgnoreResponse where
14621752
14631753-- | Use this as the fourth argument of 'req' to specify that you want it to
14641754-- ignore the response body.
1465−
14661755ignoreResponse :: Proxy IgnoreResponse
14671756ignoreResponse = Proxy
14681757
@@ -1470,29 +1759,28 @@ ignoreResponse = Proxy
14701759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
14711760-- monad in which you use 'req' will determine what to do in the case when
14721761-- parsing fails (the 'JsonHttpException' constructor will be used).
1473−
14741762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
14751764
1476−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
14771766 type HttpResponseBody (JsonResponse a) = a
14781767 toVanillaResponse (JsonResponse r) = r
14791768 getHttpResponse r = do
14801769 chunks <- L.brConsume (L.responseBody r)
14811770 case A.eitherDecode (BL.fromChunks chunks) of
1482− Left e -> throwIO (JsonHttpException e)
1771+ Left e -> throwIO (JsonHttpException e)
14831772 Right x -> return $ JsonResponse (x <$ r)
14841773 acceptHeader Proxy = Just "application/json"
14851774
14861775-- | Use this as the fourth argument of 'req' to specify that you want it to
14871776-- return the 'JsonResponse' interpretation.
1488−
14891777jsonResponse :: Proxy (JsonResponse a)
14901778jsonResponse = Proxy
14911779
14921780-- | Make a request and interpret the body of the response as a strict
14931781-- 'ByteString'.
1494−
14951782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
14961784
14971785instance HttpResponse BsResponse where
14981786 type HttpResponseBody BsResponse = ByteString
@@ -1503,14 +1791,13 @@ instance HttpResponse BsResponse where
15031791
15041792-- | Use this as the fourth argument of 'req' to specify that you want to
15051793-- interpret the response body as a strict 'ByteString'.
1506−
15071794bsResponse :: Proxy BsResponse
15081795bsResponse = Proxy
15091796
15101797-- | Make a request and interpret the body of the response as a lazy
15111798-- 'BL.ByteString'.
1512−
15131799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
15141801
15151802instance HttpResponse LbsResponse where
15161803 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1521,24 +1808,22 @@ instance HttpResponse LbsResponse where
15211808
15221809-- | Use this as the fourth argument of 'req' to specify that you want to
15231810-- interpret the response body as a lazy 'BL.ByteString'.
1524−
15251811lbsResponse :: Proxy LbsResponse
15261812lbsResponse = Proxy
15271813
15281814----------------------------------------------------------------------------
15291815-- Helpers for response interpretations
15301816
1531−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
15321818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
15331819-- such.
1534−
1535−grabPreview
1536− :: Int
1537− -- ^ How many bytes to fetch
1538− -> L.Response L.BodyReader
1539− -- ^ Response with body reader inside
1540− -> IO (ByteString, L.Response L.BodyReader)
1541− -- ^ 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)
15421827grabPreview nbytes r = do
15431828 let br = L.responseBody r
15441829 (target, leftover, done) <- brReadN br nbytes
@@ -1561,18 +1846,17 @@ grabPreview nbytes r = do
15611846 if done
15621847 then return B.empty
15631848 else br
1564− return (target, r { L.responseBody = br' })
1849+ return (target, r {L.responseBody = br'})
15651850
15661851-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
15671852-- leftover (may be empty), and whether we're done consuming the body.
1568−
1569−brReadN
1570− :: L.BodyReader
1571− -- ^ Body reader to stream from
1572− -> Int
1573− -- ^ How many bytes to consume
1574− -> IO (ByteString, ByteString, Bool)
1575− -- ^ 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)
15761860brReadN br n = go 0 id id
15771861 where
15781862 go !tlen t l = do
@@ -1581,9 +1865,9 @@ brReadN br n = go 0 id id
15811865 then return (r t, r l, True)
15821866 else do
15831867 let (target, leftover) = B.splitAt (n - tlen) chunk
1584− tlen' = B.length target
1585− t' = t . (target:)
1586− l' = l . (leftover:)
1868+ tlen' = B.length target
1869+ t' = t . (target :)
1870+ l' = l . (leftover :)
15871871 if tlen + tlen' < n
15881872 then go (tlen + tlen') t' l'
15891873 else return (r t', r l', False)
@@ -1593,47 +1877,45 @@ brReadN br n = go 0 id id
15931877-- Inspecting a response
15941878
15951879-- | Get the response body.
1596−
1597−responseBody
1598− :: HttpResponse response
1599− => response
1600− -> HttpResponseBody response
1880+responseBody ::
1881+ (HttpResponse response) =>
1882+ response ->
1883+ HttpResponseBody response
16011884responseBody = L.responseBody . toVanillaResponse
16021885
16031886-- | Get the response status code.
1604−
1605−responseStatusCode
1606− :: HttpResponse response
1607− => response
1608− -> Int
1887+responseStatusCode ::
1888+ (HttpResponse response) =>
1889+ response ->
1890+ Int
16091891responseStatusCode =
16101892 Y.statusCode . L.responseStatus . toVanillaResponse
16111893
16121894-- | Get the response status message.
1613−
1614−responseStatusMessage
1615− :: HttpResponse response
1616− => response
1617− -> ByteString
1895+responseStatusMessage ::
1896+ (HttpResponse response) =>
1897+ response ->
1898+ ByteString
16181899responseStatusMessage =
16191900 Y.statusMessage . L.responseStatus . toVanillaResponse
16201901
16211902-- | Lookup a particular header from a response.
1622−
1623−responseHeader
1624− :: HttpResponse response
1625− => response -- ^ Response interpretation
1626− -> ByteString -- ^ Header to lookup
1627− -> 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
16281911responseHeader r h =
16291912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
16301913
16311914-- | Get the response 'L.CookieJar'.
1632−
1633−responseCookieJar
1634− :: HttpResponse response
1635− => response
1636− -> L.CookieJar
1915+responseCookieJar ::
1916+ (HttpResponse response) =>
1917+ response ->
1918+ L.CookieJar
16371919responseCookieJar = L.responseCookieJar . toVanillaResponse
16381920
16391921----------------------------------------------------------------------------
@@ -1644,19 +1926,15 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
16441926-- To create a new response interpretation you just need to make your data
16451927-- type an instance of the 'HttpResponse' type class.
16461928
1647−-- | A type class for response interpretations. It allows to describe how to
1648−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1649−-- final result that is to be returned to the user.
1650−
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.
16511932class HttpResponse response where
1652−
16531933 -- | The associated type is the type of body that can be extracted from an
16541934 -- instance of 'HttpResponse'.
1655−
16561935 type HttpResponseBody response :: Type
16571936
16581937 -- | The method describes how to get the underlying 'L.Response' record.
1659−
16601938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
16611939
16621940 -- | This method describes how to consume response body and, more
@@ -1672,12 +1950,11 @@ class HttpResponse response where
16721950 --
16731951 -- __Note__: signature of this function was changed in the version
16741952 -- /1.0.0/.
1675−
1676− getHttpResponse
1677− :: L.Response L.BodyReader
1678− -- ^ Response with body reader inside
1679− -> IO response
1680− -- ^ The final result
1953+ getHttpResponse ::
1954+ -- | Response with body reader inside
1955+ L.Response L.BodyReader ->
1956+ -- | The final result
1957+ IO response
16811958
16821959 -- | The value of @\"Accept\"@ header. This is useful, for example, if a
16831960 -- website supports both @XML@ and @JSON@ responses, and decides what to
@@ -1687,10 +1964,19 @@ class HttpResponse response where
16871964 -- will take precedence.
16881965 --
16891966 -- @since 2.1.0
1690−
16911967 acceptHeader :: Proxy response -> Maybe ByteString
16921968 acceptHeader Proxy = Nothing
16931969
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
1979+
16941980----------------------------------------------------------------------------
16951981-- Other
16961982
@@ -1701,15 +1987,12 @@ class HttpResponse response where
17011987-- request components easier using @('<>')@.
17021988--
17031989-- __Note__: this type class is not a part of the public API.
1704−
17051990class RequestComponent a where
1706−
17071991 -- | Get a function that takes a 'L.Request' and changes it somehow
17081992 -- returning another 'L.Request'. For example, the 'HttpMethod' instance
17091993 -- of 'RequestComponent' just overwrites method. The function is wrapped
17101994 -- in 'Endo' so it's easier to chain such “modifying applications”
17111995 -- together building bigger and bigger 'RequestComponent's.
1712−
17131996 getRequestMod :: a -> Endo L.Request
17141997
17151998-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -1719,44 +2002,50 @@ class RequestComponent a where
17192002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
17202003-- which instance to use (i.e. the constraints are taken into account later,
17212004-- when instance is already chosen).
1722−
1723−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
17242006
17252007-- | Exceptions that this library throws.
1726−
17272008data HttpException
1728− = VanillaHttpException L.HttpException
1729− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1730− | JsonHttpException String
1731− -- ^ 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
17322012 -- failed
1733− deriving (Show, Typeable, Generic)
2013+ JsonHttpException String
2014+ deriving (Show, Generic)
17342015
17352016instance Exception HttpException
17362017
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+
17372032-- | A simple type isomorphic to 'Bool' that we only have for better error
17382033-- messages. We use it as a kind and its data constructors as type-level
17392034-- tags.
17402035--
17412036-- See also: 'HttpMethod' and 'HttpBody'.
1742−
17432037data CanHaveBody
1744− = CanHaveBody -- ^ Indeed can have a body
1745− | NoBody -- ^ Should not have a body
2038+ = -- | Indeed can have a body
2039+ CanHaveBody
2040+ | -- | Should not have a body
2041+ NoBody
17462042
17472043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
17482044-- enabled). This is used to force TLS requirement for some authentication
17492045-- 'Option's.
1750−
17512046data Scheme
1752− = Http -- ^ HTTP
1753− | Https -- ^ HTTPS
1754− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1755−
1756−----------------------------------------------------------------------------
1757−-- Constants
1758−
1759−-- | Max length of preview fragment of response body.
1760−
1761−bodyPreviewLength :: Num a => a
1762−bodyPreviewLength = 1024
2047+ = -- | HTTP
2048+ Http
2049+ | -- | HTTPS
2050+ Https
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)