@@ -1,13 +1,3 @@
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-- |
122-- Module : Network.HTTP.Req
133-- Copyright : © 2016–present Mark Karpov
@@ -19,40 +9,61 @@
199--
2010-- The documentation below is structured in such a way that the most
2111-- important information is presented first: you learn how to do HTTP
22−-- requests, how to embed them in the monad you have, and then it gives you
12+-- requests, how to embed them in any monad you have, and then it gives you
2313-- details about less-common things you may want to know about. The
2414-- documentation is written with sufficient coverage of details and
2515-- examples, and it's designed to be a complete tutorial on its own.
2616--
17+-- /(A modest intro goes here, click on 'req' to start making requests.)/
18+--
2719-- === About the library
2820--
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.
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.
5667--
5768-- === Using with other libraries
5869--
@@ -76,200 +87,170 @@
7687-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
7788-- machinery for performing requests is the same as with @http-conduit@ and
7889-- @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+
79108module Network.HTTP.Req
80109 ( -- * Making a request
81110 -- $making-a-request
82− req,
83− reqBr,
84− reqCb,
85− req',
86− withReqManager,
87−
111+ req
112+ , reqBr
113+ , req'
114+ , withReqManager
88115 -- * Embedding requests in your monad
89116 -- $embedding-requests
90− MonadHttp (..),
91− HttpConfig (..),
92− defaultHttpConfig,
93− Req,
94− runReq,
95−
117+ , MonadHttp (..)
118+ , HttpConfig (..)
119+ , defaultHttpConfig
120+ , Req
121+ , runReq
96122 -- * Request
97−
98123 -- ** Method
99124 -- $method
100− GET (..),
101− POST (..),
102− HEAD (..),
103− PUT (..),
104− DELETE (..),
105− TRACE (..),
106− CONNECT (..),
107− OPTIONS (..),
108− PATCH (..),
109− HttpMethod (..),
110−
125+ , GET (..)
126+ , POST (..)
127+ , HEAD (..)
128+ , PUT (..)
129+ , DELETE (..)
130+ , TRACE (..)
131+ , CONNECT (..)
132+ , OPTIONS (..)
133+ , PATCH (..)
134+ , HttpMethod (..)
111135 -- ** URL
112136 -- $url
113− Url,
114− http,
115− https,
116− (/~),
117− (/:),
118− useHttpURI,
119− useHttpsURI,
120− useURI,
121− urlQ,
122− renderUrl,
123−
137+ , Url
138+ , http
139+ , https
140+ , (/~)
141+ , (/:)
142+ , useHttpURI
143+ , useHttpsURI
144+ , useURI
124145 -- ** Body
125146 -- $body
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−
147+ , NoReqBody (..)
148+ , ReqBodyJson (..)
149+ , ReqBodyFile (..)
150+ , ReqBodyBs (..)
151+ , ReqBodyLbs (..)
152+ , ReqBodyUrlEnc (..)
153+ , FormUrlEncodedParam
154+ , ReqBodyMultipart
155+ , reqBodyMultipart
156+ , HttpBody (..)
157+ , ProvidesBody
158+ , HttpBodyAllowed
139159 -- ** Optional parameters
140160 -- $optional-parameters
141− Option,
142−
161+ , Option
143162 -- *** Query parameters
144163 -- $query-parameters
145− (=:),
146− queryFlag,
147− formToQuery,
148− QueryParam (..),
149−
164+ , (=:)
165+ , queryFlag
166+ , QueryParam (..)
150167 -- *** Headers
151− header,
152− attachHeader,
153− headerRedacted,
154−
168+ , header
169+ , attachHeader
155170 -- *** Cookies
156171 -- $cookies
157− cookieJar,
158−
172+ , cookieJar
159173 -- *** Authentication
160174 -- $authentication
161− basicAuth,
162− basicAuthUnsafe,
163− basicProxyAuth,
164− oAuth1,
165− oAuth2Bearer,
166− oAuth2Token,
167− customAuth,
168−
175+ , basicAuth
176+ , basicAuthUnsafe
177+ , basicProxyAuth
178+ , oAuth1
179+ , oAuth2Bearer
180+ , oAuth2Token
181+ , customAuth
169182 -- *** Other
170− port,
171− decompress,
172− responseTimeout,
173− httpVersion,
174−
183+ , port
184+ , decompress
185+ , responseTimeout
186+ , httpVersion
175187 -- * Response
176−
177188 -- ** Response interpretations
178− IgnoreResponse,
179− ignoreResponse,
180− JsonResponse,
181− jsonResponse,
182− BsResponse,
183− bsResponse,
184− LbsResponse,
185− lbsResponse,
186−
189+ , IgnoreResponse
190+ , ignoreResponse
191+ , JsonResponse
192+ , jsonResponse
193+ , BsResponse
194+ , bsResponse
195+ , LbsResponse
196+ , lbsResponse
187197 -- ** Inspecting a response
188− responseBody,
189− responseStatusCode,
190− responseStatusMessage,
191− responseHeader,
192− responseCookieJar,
193−
198+ , responseBody
199+ , responseStatusCode
200+ , responseStatusMessage
201+ , responseHeader
202+ , responseCookieJar
194203 -- ** Defining your own interpretation
195204 -- $new-response-interpretation
196− HttpResponse (..),
197−
205+ , HttpResponse (..)
198206 -- * Other
199− HttpException (..),
200− isStatusCodeException,
201− CanHaveBody (..),
202− Scheme (..),
203− )
207+ , HttpException (..)
208+ , CanHaveBody (..)
209+ , Scheme (..) )
204210where
205211
206−import Blaze.ByteString.Builder qualified as BB
207212import Control.Applicative
208213import Control.Arrow (first, second)
209−import Control.Exception hiding (Handler (..), TypeError)
210−import Control.Monad (guard, void, (>=>))
214+import Control.Exception hiding (TypeError)
211215import Control.Monad.Base
212−import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
213216import Control.Monad.IO.Class
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)
217+import Control.Monad.Reader
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
231219import Control.Retry
232−import Data.Aeson (FromJSON (..), ToJSON (..))
233−import Data.Aeson qualified as A
220+import Data.Aeson (ToJSON (..), FromJSON (..))
234221import 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
238222import Data.Data (Data)
239−import Data.Default.Class (def)
240223import Data.Function (on)
241224import Data.IORef
242225import Data.Kind (Constraint, Type)
243−import Data.List (foldl', nubBy)
226+import Data.List (nubBy, foldl')
244227import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
246228import Data.Maybe (fromMaybe)
247229import Data.Proxy
248−import Data.Semigroup (Endo (..))
249−import Data.Set qualified as S
230+import Data.Semigroup hiding (Option, option)
250231import Data.Text (Text)
251−import Data.Text qualified as T
252−import Data.Text.Encoding qualified as T
253−import Data.Typeable (Typeable, cast)
232+import Data.Typeable (Typeable)
254233import GHC.Generics
255234import 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
265235import System.IO.Unsafe (unsafePerformIO)
266236import 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
272237import 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
273254
274255----------------------------------------------------------------------------
275256-- Making a request
@@ -293,7 +274,7 @@ import Web.HttpApiData (ToHttpApiData (..))
293274--
294275-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
295276-- tutorial has a section about HTTP bodies, but usage is very
296−-- straightforward and should be clear from the examples.
277+-- straightforward and should be clear from the examples below.
297278--
298279-- @response@ is a type hint how to make and interpret response of an HTTP
299280-- request. Out-of-the-box it can be the following:
@@ -401,138 +382,65 @@ import Web.HttpApiData (ToHttpApiData (..))
401382-- > options <> -- contains the ?foo=bar part
402383-- > port 443 -- here you can put any port of course
403384-- > 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
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
423398req method url body responseProxy options =
424− reqCb method url body responseProxy options pure
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
425405
426406-- | A version of 'req' that does not use one of the predefined instances of
427407-- 'HttpResponse' but instead allows the user to consume @'L.Response'
428408-- 'L.BodyReader'@ manually, in a custom way.
429409--
430410-- @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
486411
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
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
502425 let wrapVanilla = handle (throwIO . VanillaHttpException)
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− )
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')
536444 >>= either handleHttpException return
537445
538446-- | Mostly like 'req' with respect to its arguments, but accepts a callback
@@ -543,57 +451,51 @@ reqHandler consume request manager = do
543451-- 'L.Request' and allows you to use it.
544452--
545453-- @since 0.3.0
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
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
565467req' method url body options m = do
566− config <- getHttpConfig
468+ config@HttpConfig {..} <- getHttpConfig
567469 let -- NOTE First appearance of any given header wins. This allows to
568470 -- “overwrite” headers when we construct a request by cons-ing.
569471 nubHeaders = Endo $ \x ->
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)
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)
584485 request <- finalizeRequest options request'
585486 withReqManager (m request)
586487
587488-- | Perform an action using the global implicit 'L.Manager' that the rest
588−-- of the library uses. This allows us to reuse connections that the
489+-- of the library uses. This allows to reuse connections that the
589490-- 'L.Manager' controls.
590−withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591−withReqManager m = m globalManager
592491
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'.
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'.
597499--
598500-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
599501-- The value of 'globalManager' is named and lives on top level. This means
@@ -601,16 +503,16 @@ withReqManager m = m globalManager
601503-- manager. From that moment on the 'IORef' will be just reused—exactly the
602504-- behavior we want here in order to maximize connection sharing. GHC could
603505-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
506+
507+globalManager :: IORef L.Manager
605508globalManager = unsafePerformIO $ do
606509 context <- NC.initConnectionContext
607− let settings =
608− L.mkManagerSettingsContext
609− (Just context)
610− def
611− Nothing
510+ let settings = L.mkManagerSettingsContext
511+ (Just context)
512+ (NC.TLSSettingsSimple False False False)
513+ Nothing
612514 manager <- L.newManager settings
613− return manager
515+ newIORef manager
614516{-# NOINLINE globalManager #-}
615517
616518----------------------------------------------------------------------------
@@ -624,43 +526,55 @@ globalManager = unsafePerformIO $ do
624526-- When writing a library, keep your API polymorphic in terms of
625527-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
626528-- 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).
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).
629531
630532-- | A type class for monads that support performing HTTP requests.
631533-- Typically, you only need to define the 'handleHttpException' method
632534-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
535+
536+class MonadIO m => MonadHttp m where
537+
634538 -- | This method describes how to deal with 'HttpException' that was
635539 -- caught by the library. One option is to re-throw it if you are OK with
636540 -- exceptions, but if you prefer working with something like
637541 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
638542 -- 'Control.Monad.Except.throwError'.
543+
639544 handleHttpException :: HttpException -> m a
640545
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
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
645550 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
646551 -- approach to configuration is desirable.
552+
647553 getHttpConfig :: m HttpConfig
648554 getHttpConfig = return defaultHttpConfig
649555
650−-- | 'HttpConfig' contains settings to be used when making HTTP requests.
556+-- | 'HttpConfig' contains general and default settings to be used when
557+-- making HTTP requests.
558+
651559data HttpConfig = HttpConfig
652− { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
560+ { httpConfigProxy :: Maybe L.Proxy
561+ -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
653562 -- environment variables are respected, this setting overwrites them.
654563 -- Default value: 'Nothing'.
655− httpConfigProxy :: Maybe L.Proxy,
656− -- | How many redirects to follow when getting a resource. Default
564+ , httpConfigRedirectCount :: Int
565+ -- ^ How many redirects to follow when getting a resource. Default
657566 -- value: 10.
658− httpConfigRedirectCount :: Int,
659− -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
567+ , httpConfigAltManager :: Maybe L.Manager
568+ -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
660569 -- that the default implicit manager will be used (that's what you want
661570 -- in 99% of cases).
662− httpConfigAltManager :: Maybe L.Manager,
663− -- | Function to check the response immediately after receiving the
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
664578 -- status and headers, before streaming of response body. The third
665579 -- argument is the beginning of response body (typically first 1024
666580 -- bytes). This is used for throwing exceptions on non-success status
@@ -682,106 +596,67 @@ data HttpConfig = HttpConfig
682596 -- /1.0.0/.
683597 --
684598 -- @since 0.3.0
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
599+ , httpConfigRetryPolicy :: RetryPolicyM IO
600+ -- ^ The retry policy to use for request retrying. By default 'def' is
692601 -- used (see 'RetryPolicyM').
693602 --
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/.
603+ -- __Note__: signature of this function was changed in the version
604+ -- /1.0.0/.
696605 --
697606 -- @since 0.3.0
698− httpConfigRetryPolicy :: RetryPolicyM IO,
699− -- | The function is used to decide whether to retry a request. 'True'
607+ , httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
608+ -- ^ The function is used to decide whether to retry a request. 'True'
700609 -- means that the request should be retried.
701610 --
702611 -- __Note__: signature of this function was changed in the version
703612 -- /1.0.0/.
704613 --
705614 -- @since 0.3.0
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− }
615+ } deriving Typeable
719616
720−-- | The default value of 'HttpConfig'.
617+-- | Default value of 'HttpConfig'.
721618--
722619-- @since 2.0.0
620+
723621defaultHttpConfig :: HttpConfig
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− }
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+ }
753641 where
754642 statusCode = Y.statusCode . L.responseStatus
755643
756644instance RequestComponent HttpConfig where
757645 getRequestMod HttpConfig {..} = Endo $ \x ->
758− x
759− { L.proxy = httpConfigProxy,
760− L.redirectCount = httpConfigRedirectCount,
761− LI.requestManagerOverride = httpConfigAltManager
762− }
646+ x { L.proxy = httpConfigProxy
647+ , L.redirectCount = httpConfigRedirectCount
648+ , LI.requestManagerOverride = httpConfigAltManager }
763649
764−-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
650+-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
765651-- having to define new instances.
766652--
767653-- @since 0.4.0
768−newtype Req a = Req (ReaderT HttpConfig IO a)
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
782654
783−-- | @since 3.7.0
784−deriving instance MonadMask Req
655+newtype Req a = Req (ReaderT HttpConfig IO a)
656+ deriving ( Functor
657+ , Applicative
658+ , Monad
659+ , MonadIO )
785660
786661instance MonadBase IO Req where
787662 liftBase = liftIO
@@ -790,99 +665,22 @@ instance MonadBaseControl IO Req where
790665 type StM Req a = a
791666 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
792667 {-# INLINEABLE liftBaseWith #-}
793− restoreM = Req . ReaderT . const . return
668+ restoreM = Req . ReaderT . const . return
794669 {-# INLINEABLE restoreM #-}
795670
796671instance MonadHttp Req where
797672 handleHttpException = Req . lift . throwIO
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
673+ getHttpConfig = Req ask
874674
875675-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
876−-- the case of an exceptional situation an 'HttpException' will be thrown.
676+-- case of exceptional situation an 'HttpException' will be thrown.
877677--
878678-- @since 0.4.0
879−runReq ::
880− (MonadIO m) =>
881− -- | 'HttpConfig' to use
882− HttpConfig ->
883− -- | Computation to run
884− Req a ->
885− m a
679+
680+runReq :: MonadIO m
681+ => HttpConfig -- ^ 'HttpConfig' to use
682+ -> Req a -- ^ Computation to run
683+ -> m a
886684runReq config (Req m) = liftIO (runReaderT m config)
887685
888686----------------------------------------------------------------------------
@@ -898,6 +696,7 @@ runReq config (Req m) = liftIO (runReaderT m config)
898696-- define a new method that will works seamlessly, see 'HttpMethod'.
899697
900698-- | 'GET' method.
699+
901700data GET = GET
902701
903702instance HttpMethod GET where
@@ -905,6 +704,7 @@ instance HttpMethod GET where
905704 httpMethodName Proxy = Y.methodGet
906705
907706-- | 'POST' method.
707+
908708data POST = POST
909709
910710instance HttpMethod POST where
@@ -912,6 +712,7 @@ instance HttpMethod POST where
912712 httpMethodName Proxy = Y.methodPost
913713
914714-- | 'HEAD' method.
715+
915716data HEAD = HEAD
916717
917718instance HttpMethod HEAD where
@@ -919,24 +720,26 @@ instance HttpMethod HEAD where
919720 httpMethodName Proxy = Y.methodHead
920721
921722-- | 'PUT' method.
723+
922724data PUT = PUT
923725
924726instance HttpMethod PUT where
925727 type AllowsBody PUT = 'CanHaveBody
926728 httpMethodName Proxy = Y.methodPut
927729
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.
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+
933735data DELETE = DELETE
934736
935737instance HttpMethod DELETE where
936− type AllowsBody DELETE = 'CanHaveBody
738+ type AllowsBody DELETE = 'NoBody
937739 httpMethodName Proxy = Y.methodDelete
938740
939741-- | 'TRACE' method.
742+
940743data TRACE = TRACE
941744
942745instance HttpMethod TRACE where
@@ -944,6 +747,7 @@ instance HttpMethod TRACE where
944747 httpMethodName Proxy = Y.methodTrace
945748
946749-- | 'CONNECT' method.
750+
947751data CONNECT = CONNECT
948752
949753instance HttpMethod CONNECT where
@@ -951,6 +755,7 @@ instance HttpMethod CONNECT where
951755 httpMethodName Proxy = Y.methodConnect
952756
953757-- | 'OPTIONS' method.
758+
954759data OPTIONS = OPTIONS
955760
956761instance HttpMethod OPTIONS where
@@ -958,6 +763,7 @@ instance HttpMethod OPTIONS where
958763 httpMethodName Proxy = Y.methodOptions
959764
960765-- | 'PATCH' method.
766+
961767data PATCH = PATCH
962768
963769instance HttpMethod PATCH where
@@ -972,19 +778,23 @@ instance HttpMethod PATCH where
972778-- > instance HttpMethod COPY where
973779-- > type AllowsBody COPY = 'CanHaveBody
974780-- > httpMethodName Proxy = "COPY"
781+
975782class HttpMethod a where
783+
976784 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
977785 -- tells the rest of the library whether the method can have body or not.
978786 -- We use the special type 'CanHaveBody' lifted to the kind level instead
979787 -- of 'Bool' to get more user-friendly compiler messages.
788+
980789 type AllowsBody a :: CanHaveBody
981790
982791 -- | Return name of the method as a 'ByteString'.
792+
983793 httpMethodName :: Proxy a -> ByteString
984794
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
795+instance HttpMethod method => RequestComponent (Womb "method" method) where
986796 getRequestMod _ = Endo $ \x ->
987− x {L.method = httpMethodName (Proxy :: Proxy method)}
797+ x { L.method = httpMethodName (Proxy :: Proxy method) }
988798
989799----------------------------------------------------------------------------
990800-- Request—URL
@@ -1022,60 +832,37 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1022832--
1023833-- > https "юникод.рф"
1024834-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
835+
1025836data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026837 -- NOTE The second value is the path segments in reversed order.
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
838+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
1041839
1042840-- | Given host name, produce a 'Url' which has “http” as its scheme and
1043841-- empty path. This also sets port to @80@.
842+
1044843http :: Text -> Url 'Http
1045844http = Url Http . pure
1046845
1047846-- | Given host name, produce a 'Url' which has “https” as its scheme and
1048847-- empty path. This also sets port to @443@.
848+
1049849https :: Text -> Url 'Https
1050850https = Url Https . pure
1051851
1052−-- | Grow a given 'Url' appending a single path segment to it. Note that the
852+-- | Grow given 'Url' appending a single path segment to it. Note that the
1053853-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1054−infixl 5 /~
1055854
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
855+infixl 5 /~
856+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057857Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1058858
1059−-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
859+-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1060860-- when next URL piece is a 'Data.Text.Text' literal.
1061−infixl 5 /:
1062861
862+infixl 5 /:
1063863(/:) :: Url scheme -> Text -> Url scheme
1064864(/:) = (/~)
1065865
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−
1079866-- | The 'useHttpURI' function provides an alternative method to get 'Url'
1080867-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
1081868-- given a URL to query dynamically and don't know it beforehand.
@@ -1083,92 +870,60 @@ renderUrl = \case
1083870-- This function expects the scheme to be “http” and host to be present.
1084871--
1085872-- @since 3.0.0
873+
1086874useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
1087875useHttpURI uri = do
1088876 guard (URI.uriScheme uri == Just [QQ.scheme|http|])
1089877 urlHead <- http <$> uriHost uri
1090878 let url = case URI.uriPath uri of
1091879 Nothing -> urlHead
1092− Just uriPath -> uriPathToUrl uriPath urlHead
880+ Just (_, xs) ->
881+ foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1093882 return (url, uriOptions uri)
1094883
1095884-- | Just like 'useHttpURI', but expects the “https” scheme.
1096885--
1097886-- @since 3.0.0
887+
1098888useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
1099889useHttpsURI uri = do
1100890 guard (URI.uriScheme uri == Just [QQ.scheme|https|])
1101891 urlHead <- https <$> uriHost uri
1102892 let url = case URI.uriPath uri of
1103893 Nothing -> urlHead
1104− Just uriPath -> uriPathToUrl uriPath urlHead
894+ Just (_, xs) ->
895+ foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1105896 return (url, uriOptions uri)
1106897
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−
1119898-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
1120899-- is not known in advance.
1121900--
1122901-- @since 3.0.0
1123−useURI ::
1124− URI ->
1125− Maybe
1126− ( Either
1127− (Url 'Http, Option scheme0)
1128− (Url 'Https, Option scheme1)
1129− )
902+
903+useURI
904+ :: URI
905+ -> Maybe (Either (Url 'Http, Option scheme0)
906+ (Url 'Https, Option scheme1))
1130907useURI uri =
1131908 (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
1132909
1133910-- | An internal helper function to extract host from a 'URI'.
911+
1134912uriHost :: URI -> Maybe Text
1135913uriHost uri = case URI.uriAuthority uri of
1136914 Left _ -> Nothing
1137915 Right URI.Authority {..} ->
1138916 Just (URI.unRText authHost)
1139917
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−
1163918-- | An internal helper function to extract 'Option's from a 'URI'.
919+
1164920uriOptions :: forall scheme. URI -> Option scheme
1165−uriOptions uri =
1166− mconcat
1167− [ auth,
1168− query,
1169− port'
1170− -- , fragment'
1171− ]
921+uriOptions uri = mconcat
922+ [ auth
923+ , query
924+ , port'
925+ -- , fragment'
926+ ]
1172927 where
1173928 (auth, port') =
1174929 case URI.uriAuthority uri of
@@ -1179,37 +934,34 @@ uriOptions uri =
1179934 Just URI.UserInfo {..} ->
1180935 let username = T.encodeUtf8 (URI.unRText uiUsername)
1181936 password = maybe "" (T.encodeUtf8 . URI.unRText) uiPassword
1182− in basicAuthUnsafe username password
937+ in basicAuthUnsafe username password
1183938 port0 = case authPort of
1184939 Nothing -> mempty
1185940 Just port'' -> port (fromIntegral port'')
1186− in (auth0, port0)
941+ in (auth0, port0)
1187942 query =
1188943 let liftQueryParam = \case
1189944 URI.QueryFlag t -> queryFlag (URI.unRText t)
1190945 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'')
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'')
1198952
1199953instance RequestComponent (Url scheme) where
1200954 getRequestMod (Url scheme segments) = Endo $ \x ->
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− }
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 }
1213965
1214966----------------------------------------------------------------------------
1215967-- Request—Body
@@ -1227,28 +979,31 @@ instance RequestComponent (Url scheme) where
1227979-- only type for which 'ProvidesBody' returns 'NoBody'.
1228980--
1229981-- Using of this body option does not set the @Content-Type@ header.
982+
1230983data NoReqBody = NoReqBody
1231984
1232985instance HttpBody NoReqBody where
1233986 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1234987
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.
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.
1239992--
1240993-- This body option sets the @Content-Type@ header to @\"application/json;
1241994-- charset=utf-8\"@ value.
995+
1242996newtype ReqBodyJson a = ReqBodyJson a
1243997
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
998+instance ToJSON a => HttpBody (ReqBodyJson a) where
1245999 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
12461000 getRequestContentType _ = pure "application/json; charset=utf-8"
12471001
12481002-- | This body option streams request body from a file. It is expected that
1249−-- the file size does not change during streaming.
1003+-- the file size does not change during the streaming.
12501004--
12511005-- Using of this body option does not set the @Content-Type@ header.
1006+
12521007newtype ReqBodyFile = ReqBodyFile FilePath
12531008
12541009instance HttpBody ReqBodyFile where
@@ -1258,6 +1013,7 @@ instance HttpBody ReqBodyFile where
12581013-- | HTTP request body represented by a strict 'ByteString'.
12591014--
12601015-- Using of this body option does not set the @Content-Type@ header.
1016+
12611017newtype ReqBodyBs = ReqBodyBs ByteString
12621018
12631019instance HttpBody ReqBodyBs where
@@ -1266,19 +1022,22 @@ instance HttpBody ReqBodyBs where
12661022-- | HTTP request body represented by a lazy 'BL.ByteString'.
12671023--
12681024-- Using of this body option does not set the @Content-Type@ header.
1025+
12691026newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
12701027
12711028instance HttpBody ReqBodyLbs where
12721029 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
12731030
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'.
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'.
12791037--
12801038-- This body option sets the @Content-Type@ header to
12811039-- @\"application/x-www-form-urlencoded\"@ value.
1040+
12821041newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
12831042
12841043instance HttpBody ReqBodyUrlEnc where
@@ -1288,19 +1047,13 @@ instance HttpBody ReqBodyUrlEnc where
12881047
12891048-- | An opaque monoidal value that allows to collect URL-encoded parameters
12901049-- to be wrapped in 'ReqBodyUrlEnc'.
1050+
12911051newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
12921052 deriving (Semigroup, Monoid)
12931053
12941054instance QueryParam FormUrlEncodedParam where
12951055 queryParam name mvalue =
12961056 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
13041057
13051058-- | Multipart form data. Please consult the
13061059-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1330,6 +1083,7 @@ instance FromForm FormUrlEncodedParam where
13301083-- > bsResponse
13311084-- > mempty
13321085-- > liftIO $ print (responseBody response)
1086+
13331087data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
13341088
13351089instance HttpBody ReqBodyMultipart where
@@ -1340,57 +1094,61 @@ instance HttpBody ReqBodyMultipart where
13401094-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
13411095--
13421096-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
1097+
1098+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
13441099reqBodyMultipart parts = liftIO $ do
13451100 boundary <- LM.webkitBoundary
1346− body <- LM.renderParts boundary parts
1101+ body <- LM.renderParts boundary parts
13471102 return (ReqBodyMultipart boundary body)
13481103
13491104-- | A type class for things that can be interpreted as an HTTP
13501105-- 'L.RequestBody'.
1106+
13511107class HttpBody body where
1108+
13521109 -- | How to get actual 'L.RequestBody'.
1110+
13531111 getRequestBody :: body -> L.RequestBody
13541112
13551113 -- | This method allows us to optionally specify the value of
13561114 -- @Content-Type@ header that should be used with particular body option.
13571115 -- By default it returns 'Nothing' and so @Content-Type@ is not set.
1116+
13581117 getRequestContentType :: body -> Maybe ByteString
13591118 getRequestContentType = const Nothing
13601119
13611120-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
13621121-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
13631122-- with 'GET' method and other methods that should not have body.
1123+
13641124type family ProvidesBody body :: CanHaveBody where
13651125 ProvidesBody NoReqBody = 'NoBody
1366− ProvidesBody body = 'CanHaveBody
1126+ ProvidesBody body = 'CanHaveBody
13671127
13681128-- | This type function allows any HTTP body if method says it
13691129-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
13701130-- body option to use is 'NoReqBody'.
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− }
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 }
13941152
13951153----------------------------------------------------------------------------
13961154-- Request—Optional parameters
@@ -1406,51 +1164,46 @@ instance (HttpBody body) => RequestComponent (Tagged "body" body) where
14061164-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
14071165-- of optional parameters like query parameters and headers. See sections
14081166-- 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))
14111167
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.
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.
14181176
14191177instance Semigroup (Option scheme) where
1420− Option er0 mr0 <> Option er1 mr1 =
1421− Option
1422− (er0 <> er1)
1423− (mr0 <|> mr1)
1178+ Option er0 mr0 <> Option er1 mr1 = Option
1179+ (er0 <> er1) (mr0 <|> mr1)
14241180
14251181instance Monoid (Option scheme) where
1426− mempty = Option mempty Nothing
1182+ mempty = Option mempty Nothing
14271183 mappend = (<>)
14281184
1429−-- | Use 'formToQuery'.
1430−--
1431−-- @since 3.11.0
1432−instance FromForm (Option scheme) where
1433− fromForm = Right . formToQuery
1434−
14351185-- | A helper to create an 'Option' that modifies only collection of query
14361186-- parameters. This helper is not a part of the public API.
1187+
14371188withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
14381189withQueryParams f = Option (Endo (first f)) Nothing
14391190
14401191-- | A helper to create an 'Option' that modifies only 'L.Request'. This
14411192-- helper is not a part of public API.
1193+
14421194withRequest :: (L.Request -> L.Request) -> Option scheme
14431195withRequest f = Option (Endo (second f)) Nothing
14441196
14451197instance RequestComponent (Option scheme) where
14461198 getRequestMod (Option f _) = Endo $ \x ->
14471199 let (qparams, x') = appEndo f ([], x)
1448− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449− in x' {L.queryString = query}
1200+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1201+ in x' { L.queryString = query }
14501202
14511203-- | Finalize given 'L.Request' by applying a finalizer from the given
14521204-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1205+
1206+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
14541207finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14551208
14561209----------------------------------------------------------------------------
@@ -1469,12 +1222,12 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14691222-- This operator is defined in terms of 'queryParam':
14701223--
14711224-- > name =: value = queryParam name (pure value)
1472−infix 7 =:
14731225
1226+infix 7 =:
14741227(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
14751228name =: value = queryParam name (pure value)
14761229
1477−-- | Construct a flag, that is, a valueless query parameter. For example, in
1230+-- | Construct a flag, that is, valueless query parameter. For example, in
14781231-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
14791232-- with a value:
14801233--
@@ -1483,47 +1236,27 @@ name =: value = queryParam name (pure value)
14831236-- This operator is defined in terms of 'queryParam':
14841237--
14851238-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486−queryFlag :: (QueryParam param) => Text -> param
1487−queryFlag name = queryParam name (Nothing :: Maybe ())
14881239
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
1240+queryFlag :: QueryParam param => Text -> param
1241+queryFlag name = queryParam name (Nothing :: Maybe ())
15061242
15071243-- | A type class for query-parameter-like things. The reason to have an
15081244-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
15091245-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
15101246-- Having the same syntax for these cases seems natural and user-friendly.
1247+
15111248class QueryParam param where
1249+
15121250 -- | Create a query parameter with given name and value. If value is
15131251 -- 'Nothing', it won't be included at all (i.e. you create a flag this
15141252 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
15151253 -- method, because they are easier to read.
1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
15171254
1518− -- | Get the query parameter names and values set by 'queryParam'.
1519− --
1520− -- @since 3.11.0
1521− queryParamToList :: param -> [(Text, Maybe Text)]
1255+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param
15221256
15231257instance QueryParam (Option scheme) where
15241258 queryParam name mvalue =
15251259 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
15271260
15281261----------------------------------------------------------------------------
15291262-- Request—Optional parameters—Headers
@@ -1532,28 +1265,20 @@ instance QueryParam (Option scheme) where
15321265-- headers with the same names the leftmost header will win. This means, in
15331266-- particular, that you cannot create a request with several headers of the
15341267-- same name.
1535−header ::
1536− -- | Header name
1537− ByteString ->
1538− -- | Header value
1539− ByteString ->
1540− Option scheme
1268+
1269+header
1270+ :: ByteString -- ^ Header name
1271+ -> ByteString -- ^ Header value
1272+ -> Option scheme
15411273header name value = withRequest (attachHeader name value)
15421274
15431275-- | Attach a header with given name and content to a 'L.Request'.
15441276--
15451277-- @since 1.1.0
1278+
15461279attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15471280attachHeader name value 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}
1281+ x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
15571282
15581283----------------------------------------------------------------------------
15591284-- Request—Optional parameters—Cookies
@@ -1566,9 +1291,10 @@ headerRedacted name value = withRequest $ \x ->
15661291
15671292-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
15681293-- 'L.Response' record.
1294+
15691295cookieJar :: L.CookieJar -> Option scheme
15701296cookieJar jar = withRequest $ \x ->
1571− x {L.cookieJar = Just jar}
1297+ x { L.cookieJar = Just jar }
15721298
15731299----------------------------------------------------------------------------
15741300-- Request—Optional parameters—Authentication
@@ -1586,13 +1312,11 @@ cookieJar jar = withRequest $ \x ->
15861312-- | The 'Option' adds basic authentication.
15871313--
15881314-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1589−basicAuth ::
1590− -- | Username
1591− ByteString ->
1592− -- | Password
1593− ByteString ->
1594− -- | Auth 'Option'
1595− Option 'Https
1315+
1316+basicAuth
1317+ :: ByteString -- ^ Username
1318+ -> ByteString -- ^ Password
1319+ -> Option 'Https -- ^ Auth 'Option'
15961320basicAuth = basicAuthUnsafe
15971321
15981322-- | An alternative to 'basicAuth' which works for any scheme. Note that
@@ -1600,52 +1324,41 @@ basicAuth = basicAuthUnsafe
16001324-- attacks. Use 'basicAuth' instead unless you know what you are doing.
16011325--
16021326-- @since 0.3.1
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)
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)
16131334
16141335-- | The 'Option' set basic proxy authentication header.
16151336--
16161337-- @since 1.1.0
1617−basicProxyAuth ::
1618− -- | Username
1619− ByteString ->
1620− -- | Password
1621− ByteString ->
1622− -- | Auth 'Option'
1623− Option scheme
1338+
1339+basicProxyAuth
1340+ :: ByteString -- ^ Username
1341+ -> ByteString -- ^ Password
1342+ -> Option scheme -- ^ Auth 'Option'
16241343basicProxyAuth username password =
16251344 withRequest (L.applyBasicProxyAuth username password)
16261345
16271346-- | The 'Option' adds OAuth1 authentication.
16281347--
16291348-- @since 0.2.0
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
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'
16411356oAuth1 consumerToken consumerSecret token tokenSecret =
16421357 customAuth (OAuth.signOAuth app creds)
16431358 where
1644− app =
1645− OAuth.newOAuth
1646− { OAuth.oauthConsumerKey = consumerToken,
1647− OAuth.oauthConsumerSecret = consumerSecret
1648− }
1359+ app = OAuth.newOAuth
1360+ { OAuth.oauthConsumerKey = consumerToken
1361+ , OAuth.oauthConsumerSecret = consumerSecret }
16491362 creds = OAuth.newCredential token tokenSecret
16501363
16511364-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1656,14 +1369,12 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
16561369-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
16571370--
16581371-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1659−oAuth2Bearer ::
1660− -- | Token
1661− ByteString ->
1662− -- | Auth 'Option'
1663− Option 'Https
1664−oAuth2Bearer token =
1665− customAuth
1666− (pure . attachHeader "Authorization" ("Bearer " <> token))
1372+
1373+oAuth2Bearer
1374+ :: ByteString -- ^ Token
1375+ -> Option 'Https -- ^ Auth 'Option'
1376+oAuth2Bearer token = customAuth
1377+ (pure . attachHeader "Authorization" ("Bearer " <> token))
16671378
16681379-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
16691380-- to be used only by GitHub). This will be treated by whatever services
@@ -1674,20 +1385,19 @@ oAuth2Bearer token =
16741385-- > oAuth2Token token = header "Authorization" ("token" <> token)
16751386--
16761387-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1677−oAuth2Token ::
1678− -- | Token
1679− ByteString ->
1680− -- | Auth 'Option'
1681− Option 'Https
1682−oAuth2Token token =
1683− customAuth
1684− (pure . attachHeader "Authorization" ("token " <> token))
1388+
1389+oAuth2Token
1390+ :: ByteString -- ^ Token
1391+ -> Option 'Https -- ^ Auth 'Option'
1392+oAuth2Token token = customAuth
1393+ (pure . attachHeader "Authorization" ("token " <> token))
16851394
16861395-- | A helper to create custom authentication 'Option's. The given
16871396-- 'IO'-enabled request transformation is applied after all other
16881397-- modifications when constructing a request. Use wisely.
16891398--
16901399-- @since 1.1.0
1400+
16911401customAuth :: (L.Request -> IO L.Request) -> Option scheme
16921402customAuth = Option mempty . pure
16931403
@@ -1696,10 +1406,11 @@ customAuth = Option mempty . pure
16961406
16971407-- | Specify the port to connect to explicitly. Normally, 'Url' you use
16981408-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1699−-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1409+-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1410+
17001411port :: Int -> Option scheme
17011412port n = withRequest $ \x ->
1702− x {L.port = n}
1413+ x { L.port = n }
17031414
17041415-- | This 'Option' controls whether gzipped data should be decompressed on
17051416-- the fly. By default everything except for @\"application\/x-tar\"@ is
@@ -1710,40 +1421,39 @@ port n = withRequest $ \x ->
17101421-- You can also choose to decompress everything like this:
17111422--
17121423-- > decompress (const True)
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
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
17181429decompress f = withRequest $ \x ->
1719− x {L.decompress = f}
1430+ x { L.decompress = f }
17201431
17211432-- | Specify the number of microseconds to wait for response. The default
17221433-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
17231434-- 'L.Manager').
1724−responseTimeout ::
1725− -- | Number of microseconds to wait
1726− Int ->
1727− Option scheme
1435+
1436+responseTimeout
1437+ :: Int -- ^ Number of microseconds to wait
1438+ -> Option scheme
17281439responseTimeout n = withRequest $ \x ->
1729− x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1440+ x { L.responseTimeout = LI.ResponseTimeoutMicro n }
17301441
17311442-- | HTTP version to send to the server, the default is HTTP 1.1.
1732−httpVersion ::
1733− -- | Major version number
1734− Int ->
1735− -- | Minor version number
1736− Int ->
1737− Option scheme
1443+
1444+httpVersion
1445+ :: Int -- ^ Major version number
1446+ -> Int -- ^ Minor version number
1447+ -> Option scheme
17381448httpVersion major minor = withRequest $ \x ->
1739− x {L.requestVersion = Y.HttpVersion major minor}
1449+ x { L.requestVersion = Y.HttpVersion major minor }
17401450
17411451----------------------------------------------------------------------------
17421452-- Response interpretations
17431453
17441454-- | Make a request and ignore the body of the response.
1455+
17451456newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746− deriving (Show)
17471457
17481458instance HttpResponse IgnoreResponse where
17491459 type HttpResponseBody IgnoreResponse = ()
@@ -1752,6 +1462,7 @@ instance HttpResponse IgnoreResponse where
17521462
17531463-- | Use this as the fourth argument of 'req' to specify that you want it to
17541464-- ignore the response body.
1465+
17551466ignoreResponse :: Proxy IgnoreResponse
17561467ignoreResponse = Proxy
17571468
@@ -1759,28 +1470,29 @@ ignoreResponse = Proxy
17591470-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
17601471-- monad in which you use 'req' will determine what to do in the case when
17611472-- parsing fails (the 'JsonHttpException' constructor will be used).
1473+
17621474newtype JsonResponse a = JsonResponse (L.Response a)
1763− deriving (Show)
17641475
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1476+instance FromJSON a => HttpResponse (JsonResponse a) where
17661477 type HttpResponseBody (JsonResponse a) = a
17671478 toVanillaResponse (JsonResponse r) = r
17681479 getHttpResponse r = do
17691480 chunks <- L.brConsume (L.responseBody r)
17701481 case A.eitherDecode (BL.fromChunks chunks) of
1771− Left e -> throwIO (JsonHttpException e)
1482+ Left e -> throwIO (JsonHttpException e)
17721483 Right x -> return $ JsonResponse (x <$ r)
17731484 acceptHeader Proxy = Just "application/json"
17741485
17751486-- | Use this as the fourth argument of 'req' to specify that you want it to
17761487-- return the 'JsonResponse' interpretation.
1488+
17771489jsonResponse :: Proxy (JsonResponse a)
17781490jsonResponse = Proxy
17791491
17801492-- | Make a request and interpret the body of the response as a strict
17811493-- 'ByteString'.
1494+
17821495newtype BsResponse = BsResponse (L.Response ByteString)
1783− deriving (Show)
17841496
17851497instance HttpResponse BsResponse where
17861498 type HttpResponseBody BsResponse = ByteString
@@ -1791,13 +1503,14 @@ instance HttpResponse BsResponse where
17911503
17921504-- | Use this as the fourth argument of 'req' to specify that you want to
17931505-- interpret the response body as a strict 'ByteString'.
1506+
17941507bsResponse :: Proxy BsResponse
17951508bsResponse = Proxy
17961509
17971510-- | Make a request and interpret the body of the response as a lazy
17981511-- 'BL.ByteString'.
1512+
17991513newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800− deriving (Show)
18011514
18021515instance HttpResponse LbsResponse where
18031516 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1808,22 +1521,24 @@ instance HttpResponse LbsResponse where
18081521
18091522-- | Use this as the fourth argument of 'req' to specify that you want to
18101523-- interpret the response body as a lazy 'BL.ByteString'.
1524+
18111525lbsResponse :: Proxy LbsResponse
18121526lbsResponse = Proxy
18131527
18141528----------------------------------------------------------------------------
18151529-- Helpers for response interpretations
18161530
1817−-- | Fetch beginning of the response and return it together with a new
1531+-- | Fetch beginning of response and return it together with new
18181532-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
18191533-- such.
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)
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
18271542grabPreview nbytes r = do
18281543 let br = L.responseBody r
18291544 (target, leftover, done) <- brReadN br nbytes
@@ -1846,17 +1561,18 @@ grabPreview nbytes r = do
18461561 if done
18471562 then return B.empty
18481563 else br
1849− return (target, r {L.responseBody = br'})
1564+ return (target, r { L.responseBody = br' })
18501565
18511566-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
18521567-- leftover (may be empty), and whether we're done consuming the body.
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)
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
18601576brReadN br n = go 0 id id
18611577 where
18621578 go !tlen t l = do
@@ -1865,9 +1581,9 @@ brReadN br n = go 0 id id
18651581 then return (r t, r l, True)
18661582 else do
18671583 let (target, leftover) = B.splitAt (n - tlen) chunk
1868− tlen' = B.length target
1869− t' = t . (target :)
1870− l' = l . (leftover :)
1584+ tlen' = B.length target
1585+ t' = t . (target:)
1586+ l' = l . (leftover:)
18711587 if tlen + tlen' < n
18721588 then go (tlen + tlen') t' l'
18731589 else return (r t', r l', False)
@@ -1877,45 +1593,47 @@ brReadN br n = go 0 id id
18771593-- Inspecting a response
18781594
18791595-- | Get the response body.
1880−responseBody ::
1881− (HttpResponse response) =>
1882− response ->
1883− HttpResponseBody response
1596+
1597+responseBody
1598+ :: HttpResponse response
1599+ => response
1600+ -> HttpResponseBody response
18841601responseBody = L.responseBody . toVanillaResponse
18851602
18861603-- | Get the response status code.
1887−responseStatusCode ::
1888− (HttpResponse response) =>
1889− response ->
1890− Int
1604+
1605+responseStatusCode
1606+ :: HttpResponse response
1607+ => response
1608+ -> Int
18911609responseStatusCode =
18921610 Y.statusCode . L.responseStatus . toVanillaResponse
18931611
18941612-- | Get the response status message.
1895−responseStatusMessage ::
1896− (HttpResponse response) =>
1897− response ->
1898− ByteString
1613+
1614+responseStatusMessage
1615+ :: HttpResponse response
1616+ => response
1617+ -> ByteString
18991618responseStatusMessage =
19001619 Y.statusMessage . L.responseStatus . toVanillaResponse
19011620
19021621-- | Lookup a particular header from a response.
1903−responseHeader ::
1904− (HttpResponse response) =>
1905− -- | Response interpretation
1906− response ->
1907− -- | Header to lookup
1908− ByteString ->
1909− -- | Header value if found
1910− Maybe ByteString
1622+
1623+responseHeader
1624+ :: HttpResponse response
1625+ => response -- ^ Response interpretation
1626+ -> ByteString -- ^ Header to lookup
1627+ -> Maybe ByteString -- ^ Header value if found
19111628responseHeader r h =
19121629 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
19131630
19141631-- | Get the response 'L.CookieJar'.
1915−responseCookieJar ::
1916− (HttpResponse response) =>
1917− response ->
1918− L.CookieJar
1632+
1633+responseCookieJar
1634+ :: HttpResponse response
1635+ => response
1636+ -> L.CookieJar
19191637responseCookieJar = L.responseCookieJar . toVanillaResponse
19201638
19211639----------------------------------------------------------------------------
@@ -1926,15 +1644,19 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
19261644-- To create a new response interpretation you just need to make your data
19271645-- type an instance of the 'HttpResponse' type class.
19281646
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.
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+
19321651class HttpResponse response where
1652+
19331653 -- | The associated type is the type of body that can be extracted from an
19341654 -- instance of 'HttpResponse'.
1655+
19351656 type HttpResponseBody response :: Type
19361657
19371658 -- | The method describes how to get the underlying 'L.Response' record.
1659+
19381660 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
19391661
19401662 -- | This method describes how to consume response body and, more
@@ -1950,11 +1672,12 @@ class HttpResponse response where
19501672 --
19511673 -- __Note__: signature of this function was changed in the version
19521674 -- /1.0.0/.
1953− getHttpResponse ::
1954− -- | Response with body reader inside
1955− L.Response L.BodyReader ->
1956− -- | The final result
1957− IO response
1675+
1676+ getHttpResponse
1677+ :: L.Response L.BodyReader
1678+ -- ^ Response with body reader inside
1679+ -> IO response
1680+ -- ^ The final result
19581681
19591682 -- | The value of @\"Accept\"@ header. This is useful, for example, if a
19601683 -- website supports both @XML@ and @JSON@ responses, and decides what to
@@ -1964,19 +1687,10 @@ class HttpResponse response where
19641687 -- will take precedence.
19651688 --
19661689 -- @since 2.1.0
1690+
19671691 acceptHeader :: Proxy response -> Maybe ByteString
19681692 acceptHeader Proxy = Nothing
19691693
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−
19801694----------------------------------------------------------------------------
19811695-- Other
19821696
@@ -1987,12 +1701,15 @@ instance HttpResponse (L.Response ()) where
19871701-- request components easier using @('<>')@.
19881702--
19891703-- __Note__: this type class is not a part of the public API.
1704+
19901705class RequestComponent a where
1706+
19911707 -- | Get a function that takes a 'L.Request' and changes it somehow
19921708 -- returning another 'L.Request'. For example, the 'HttpMethod' instance
19931709 -- of 'RequestComponent' just overwrites method. The function is wrapped
19941710 -- in 'Endo' so it's easier to chain such “modifying applications”
19951711 -- together building bigger and bigger 'RequestComponent's.
1712+
19961713 getRequestMod :: a -> Endo L.Request
19971714
19981715-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -2002,50 +1719,44 @@ class RequestComponent a where
20021719-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
20031720-- which instance to use (i.e. the constraints are taken into account later,
20041721-- when instance is already chosen).
2005−newtype Tagged (tag :: Symbol) a = Tagged a
1722+
1723+newtype Womb (tag :: Symbol) a = Womb a
20061724
20071725-- | Exceptions that this library throws.
1726+
20081727data HttpException
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
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
20121732 -- failed
2013− JsonHttpException String
2014− deriving (Show, Generic)
1733+ deriving (Show, Typeable, Generic)
20151734
20161735instance Exception HttpException
20171736
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−
20321737-- | A simple type isomorphic to 'Bool' that we only have for better error
20331738-- messages. We use it as a kind and its data constructors as type-level
20341739-- tags.
20351740--
20361741-- See also: 'HttpMethod' and 'HttpBody'.
1742+
20371743data CanHaveBody
2038− = -- | Indeed can have a body
2039− CanHaveBody
2040− | -- | Should not have a body
2041− NoBody
1744+ = CanHaveBody -- ^ Indeed can have a body
1745+ | NoBody -- ^ Should not have a body
20421746
20431747-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
20441748-- enabled). This is used to force TLS requirement for some authentication
20451749-- 'Option's.
1750+
20461751data Scheme
2047− = -- | HTTP
2048− Http
2049− | -- | HTTPS
2050− Https
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
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