@@ -1,16 +1,6 @@
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
13−-- Copyright : © 2016–present Mark Karpov
3+-- Copyright : © 2016–2019 Mark Karpov
144-- License : BSD 3 clause
155--
166-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
@@ -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,168 @@
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 MultiParamTypeClasses #-}
99+{-# LANGUAGE OverloadedStrings #-}
100+{-# LANGUAGE RankNTypes #-}
101+{-# LANGUAGE RecordWildCards #-}
102+{-# LANGUAGE ScopedTypeVariables #-}
103+{-# LANGUAGE TypeFamilies #-}
104+{-# LANGUAGE UndecidableInstances #-}
105+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
106+
79107module Network.HTTP.Req
80108 ( -- * Making a request
81109 -- $making-a-request
82− req,
83− reqBr,
84− reqCb,
85− req',
86− withReqManager,
87−
110+ req
111+ , reqBr
112+ , req'
113+ , withReqManager
88114 -- * Embedding requests in your monad
89115 -- $embedding-requests
90− MonadHttp (..),
91− HttpConfig (..),
92− defaultHttpConfig,
93− Req,
94− runReq,
95−
116+ , MonadHttp (..)
117+ , HttpConfig (..)
118+ , defaultHttpConfig
119+ , Req
120+ , runReq
96121 -- * Request
97−
98122 -- ** Method
99123 -- $method
100− GET (..),
101− POST (..),
102− HEAD (..),
103− PUT (..),
104− DELETE (..),
105− TRACE (..),
106− CONNECT (..),
107− OPTIONS (..),
108− PATCH (..),
109− HttpMethod (..),
110−
124+ , GET (..)
125+ , POST (..)
126+ , HEAD (..)
127+ , PUT (..)
128+ , DELETE (..)
129+ , TRACE (..)
130+ , CONNECT (..)
131+ , OPTIONS (..)
132+ , PATCH (..)
133+ , HttpMethod (..)
111134 -- ** URL
112135 -- $url
113− Url,
114− http,
115− https,
116− (/~),
117− (/:),
118− useHttpURI,
119− useHttpsURI,
120− useURI,
121− urlQ,
122− renderUrl,
123−
136+ , Url
137+ , http
138+ , https
139+ , (/~)
140+ , (/:)
141+ , parseUrlHttp
142+ , parseUrlHttps
143+ , parseUrl
124144 -- ** Body
125145 -- $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−
146+ , NoReqBody (..)
147+ , ReqBodyJson (..)
148+ , ReqBodyFile (..)
149+ , ReqBodyBs (..)
150+ , ReqBodyLbs (..)
151+ , ReqBodyUrlEnc (..)
152+ , FormUrlEncodedParam
153+ , ReqBodyMultipart
154+ , reqBodyMultipart
155+ , HttpBody (..)
156+ , ProvidesBody
157+ , HttpBodyAllowed
139158 -- ** Optional parameters
140159 -- $optional-parameters
141− Option,
142−
160+ , Option
143161 -- *** Query parameters
144162 -- $query-parameters
145− (=:),
146− queryFlag,
147− formToQuery,
148− QueryParam (..),
149−
163+ , (=:)
164+ , queryFlag
165+ , QueryParam (..)
150166 -- *** Headers
151− header,
152− attachHeader,
153− headerRedacted,
154−
167+ , header
168+ , attachHeader
155169 -- *** Cookies
156170 -- $cookies
157− cookieJar,
158−
171+ , cookieJar
159172 -- *** Authentication
160173 -- $authentication
161− basicAuth,
162− basicAuthUnsafe,
163− basicProxyAuth,
164− oAuth1,
165− oAuth2Bearer,
166− oAuth2Token,
167− customAuth,
168−
174+ , basicAuth
175+ , basicAuthUnsafe
176+ , basicProxyAuth
177+ , oAuth1
178+ , oAuth2Bearer
179+ , oAuth2Token
180+ , customAuth
169181 -- *** Other
170− port,
171− decompress,
172− responseTimeout,
173− httpVersion,
174−
182+ , port
183+ , decompress
184+ , responseTimeout
185+ , httpVersion
175186 -- * Response
176−
177187 -- ** Response interpretations
178− IgnoreResponse,
179− ignoreResponse,
180− JsonResponse,
181− jsonResponse,
182− BsResponse,
183− bsResponse,
184− LbsResponse,
185− lbsResponse,
186−
188+ , IgnoreResponse
189+ , ignoreResponse
190+ , JsonResponse
191+ , jsonResponse
192+ , BsResponse
193+ , bsResponse
194+ , LbsResponse
195+ , lbsResponse
187196 -- ** Inspecting a response
188− responseBody,
189− responseStatusCode,
190− responseStatusMessage,
191− responseHeader,
192− responseCookieJar,
193−
197+ , responseBody
198+ , responseStatusCode
199+ , responseStatusMessage
200+ , responseHeader
201+ , responseCookieJar
194202 -- ** Defining your own interpretation
195203 -- $new-response-interpretation
196− HttpResponse (..),
197−
204+ , HttpResponse (..)
198205 -- * Other
199− HttpException (..),
200− isStatusCodeException,
201− CanHaveBody (..),
202− Scheme (..),
203− )
206+ , HttpException (..)
207+ , CanHaveBody (..)
208+ , Scheme (..) )
204209where
205210
206−import Blaze.ByteString.Builder qualified as BB
207211import Control.Applicative
208212import Control.Arrow (first, second)
209−import Control.Exception hiding (Handler (..), TypeError)
210−import Control.Monad (guard, void, (>=>))
213+import Control.Exception hiding (TypeError)
211214import Control.Monad.Base
212−import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
213215import 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)
216+import Control.Monad.Reader
218217import 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
231218import Control.Retry
232−import Data.Aeson (FromJSON (..), ToJSON (..))
233−import Data.Aeson qualified as A
219+import Data.Aeson (ToJSON (..), FromJSON (..))
234220import 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
238221import Data.Data (Data)
239−import Data.Default.Class (def)
240222import Data.Function (on)
241223import Data.IORef
242−import Data.Kind (Constraint, Type)
243−import Data.List (foldl', nubBy)
224+import Data.Kind (Constraint)
225+import Data.List (nubBy)
244226import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
246227import Data.Maybe (fromMaybe)
247228import Data.Proxy
248−import Data.Semigroup (Endo (..))
249−import Data.Set qualified as S
229+import Data.Semigroup hiding (Option, option)
250230import Data.Text (Text)
251−import Data.Text qualified as T
252−import Data.Text.Encoding qualified as T
253−import Data.Typeable (Typeable, cast)
231+import Data.Typeable (Typeable)
254232import GHC.Generics
255233import 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
265234import System.IO.Unsafe (unsafePerformIO)
266−import Text.URI (URI)
267−import Text.URI qualified as URI
268−import Text.URI.QQ qualified as QQ
269−import Web.Authenticate.OAuth qualified as OAuth
270−import Web.FormUrlEncoded (FromForm (..), ToForm (..))
271−import Web.FormUrlEncoded qualified as Form
272235import Web.HttpApiData (ToHttpApiData (..))
236+import qualified Blaze.ByteString.Builder as BB
237+import qualified Data.Aeson as A
238+import qualified Data.ByteString as B
239+import qualified Data.ByteString.Lazy as BL
240+import qualified Data.CaseInsensitive as CI
241+import qualified Data.List.NonEmpty as NE
242+import qualified Data.Text as T
243+import qualified Data.Text.Encoding as T
244+import qualified Data.Text.Read as TR
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 Web.Authenticate.OAuth as OAuth
273252
274253----------------------------------------------------------------------------
275254-- Making a request
@@ -293,7 +272,7 @@ import Web.HttpApiData (ToHttpApiData (..))
293272--
294273-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
295274-- tutorial has a section about HTTP bodies, but usage is very
296−-- straightforward and should be clear from the examples.
275+-- straightforward and should be clear from the examples below.
297276--
298277-- @response@ is a type hint how to make and interpret response of an HTTP
299278-- request. Out-of-the-box it can be the following:
@@ -333,7 +312,6 @@ import Web.HttpApiData (ToHttpApiData (..))
333312-- > import GHC.Generics
334313-- > import Network.HTTP.Req
335314-- > import qualified Data.ByteString.Char8 as B
336−-- > import qualified Text.URI as URI
337315--
338316-- We will be making requests against the <https://httpbin.org> service.
339317--
@@ -392,8 +370,7 @@ import Web.HttpApiData (ToHttpApiData (..))
392370-- > main = runReq defaultHttpConfig $ do
393371-- > -- This is an example of what to do when URL is given dynamically. Of
394372-- > -- course in a real application you may not want to use 'fromJust'.
395−-- > uri <- URI.mkURI "https://httpbin.org/get?foo=bar"
396−-- > let (url, options) = fromJust (useHttpsURI uri)
373+-- > let (url, options) = fromJust (parseUrlHttps "https://httpbin.org/get?foo=bar")
397374-- > response <- req GET url NoReqBody jsonResponse $
398375-- > "from" =: (15 :: Int) <>
399376-- > "to" =: (67 :: Int) <>
@@ -401,138 +378,60 @@ import Web.HttpApiData (ToHttpApiData (..))
401378-- > options <> -- contains the ?foo=bar part
402379-- > port 443 -- here you can put any port of course
403380-- > liftIO $ print (responseBody response :: Value)
404−req ::
405− ( MonadHttp m,
406− HttpMethod method,
407− HttpBody body,
408− HttpResponse response,
409− HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
410− ) =>
411− -- | HTTP method
412− method ->
413− -- | 'Url'—location of resource
414− Url scheme ->
415− -- | Body of the request
416− body ->
417− -- | A hint how to interpret response
418− Proxy response ->
419− -- | Collection of optional parameters
420− Option scheme ->
421− -- | Response
422− m response
423−req method url body responseProxy options =
424− reqCb method url body responseProxy options pure
381+
382+req
383+ :: ( MonadHttp m
384+ , HttpMethod method
385+ , HttpBody body
386+ , HttpResponse response
387+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
388+ => method -- ^ HTTP method
389+ -> Url scheme -- ^ 'Url'—location of resource
390+ -> body -- ^ Body of the request
391+ -> Proxy response -- ^ A hint how to interpret response
392+ -> Option scheme -- ^ Collection of optional parameters
393+ -> m response -- ^ Response
394+req method url body Proxy options =
395+ reqBr method url body options getHttpResponse
425396
426397-- | A version of 'req' that does not use one of the predefined instances of
427398-- 'HttpResponse' but instead allows the user to consume @'L.Response'
428399-- 'L.BodyReader'@ manually, in a custom way.
429400--
430401-- @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
486−
487−-- | The default handler function that the higher-level request functions
488−-- pass to 'req''. Internal function.
489−--
490−-- @since 3.7.0
491−reqHandler ::
492− (MonadHttp m) =>
493− -- | How to get final result from a 'L.Response'
494− (L.Response L.BodyReader -> IO b) ->
495− -- | 'L.Request' to perform
496− L.Request ->
497− -- | 'L.Manager' to use
498− L.Manager ->
499− m b
500−reqHandler consume request manager = do
501− HttpConfig {..} <- getHttpConfig
402+
403+reqBr
404+ :: ( MonadHttp m
405+ , HttpMethod method
406+ , HttpBody body
407+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
408+ => method -- ^ HTTP method
409+ -> Url scheme -- ^ 'Url'—location of resource
410+ -> body -- ^ Body of the request
411+ -> Option scheme -- ^ Collection of optional parameters
412+ -> (L.Response L.BodyReader -> IO a) -- ^ How to consume response
413+ -> m a -- ^ Result
414+reqBr method url body options consume = req' method url body options $ \request manager -> do
415+ HttpConfig {..} <- getHttpConfig
502416 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− )
417+ wrapExc = handle (throwIO . LI.toHttpException request)
418+ withRRef = bracket
419+ (newIORef Nothing)
420+ (readIORef >=> mapM_ L.responseClose)
421+ (liftIO . try . wrapVanilla . wrapExc) (withRRef $ \rref -> do
422+ let openResponse = mask_ $ do
423+ r <- readIORef rref
424+ mapM_ L.responseClose r
425+ r' <- L.responseOpen request manager
426+ writeIORef rref (Just r')
427+ return r'
428+ r <- retrying
429+ httpConfigRetryPolicy
430+ (\st r -> return $ httpConfigRetryJudge st r)
431+ (const openResponse)
432+ (preview, r') <- grabPreview bodyPreviewLength r
433+ mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
434+ consume r')
536435 >>= either handleHttpException return
537436
538437-- | Mostly like 'req' with respect to its arguments, but accepts a callback
@@ -543,57 +442,51 @@ reqHandler consume request manager = do
543442-- 'L.Request' and allows you to use it.
544443--
545444-- @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
445+
446+req'
447+ :: forall m method body scheme a.
448+ ( MonadHttp m
449+ , HttpMethod method
450+ , HttpBody body
451+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
452+ => method -- ^ HTTP method
453+ -> Url scheme -- ^ 'Url'—location of resource
454+ -> body -- ^ Body of the request
455+ -> Option scheme -- ^ Collection of optional parameters
456+ -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
457+ -> m a -- ^ Result
565458req' method url body options m = do
566− config <- getHttpConfig
459+ config@HttpConfig {..} <- getHttpConfig
567460 let -- NOTE First appearance of any given header wins. This allows to
568461 -- “overwrite” headers when we construct a request by cons-ing.
569462 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)
463+ x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
464+ request' = flip appEndo L.defaultRequest $
465+ -- NOTE The order of 'mappend's matters, here method is overwritten
466+ -- first and 'options' take effect last. In particular, this means
467+ -- that 'options' can overwrite things set by other request
468+ -- components, which is useful for setting port number,
469+ -- "Content-Type" header, etc.
470+ nubHeaders <>
471+ getRequestMod options <>
472+ getRequestMod config <>
473+ getRequestMod (Womb body :: Womb "body" body) <>
474+ getRequestMod url <>
475+ getRequestMod (Womb method :: Womb "method" method)
584476 request <- finalizeRequest options request'
585477 withReqManager (m request)
586478
587479-- | 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
480+-- of the library uses. This allows to reuse connections that the
589481-- 'L.Manager' controls.
590−withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591−withReqManager m = m globalManager
592482
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'.
483+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
484+withReqManager m = liftIO (readIORef globalManager) >>= m
485+
486+-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
487+-- settings, so users don't need to deal with this manager stuff at all, but
488+-- when we create a request, instance 'HttpConfig' can affect the default
489+-- settings via 'getHttpConfig'.
597490--
598491-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
599492-- The value of 'globalManager' is named and lives on top level. This means
@@ -601,16 +494,16 @@ withReqManager m = m globalManager
601494-- manager. From that moment on the 'IORef' will be just reused—exactly the
602495-- behavior we want here in order to maximize connection sharing. GHC could
603496-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
497+
498+globalManager :: IORef L.Manager
605499globalManager = unsafePerformIO $ do
606500 context <- NC.initConnectionContext
607− let settings =
608− L.mkManagerSettingsContext
609− (Just context)
610− def
611− Nothing
501+ let settings = L.mkManagerSettingsContext
502+ (Just context)
503+ (NC.TLSSettingsSimple False False False)
504+ Nothing
612505 manager <- L.newManager settings
613− return manager
506+ newIORef manager
614507{-# NOINLINE globalManager #-}
615508
616509----------------------------------------------------------------------------
@@ -624,43 +517,55 @@ globalManager = unsafePerformIO $ do
624517-- When writing a library, keep your API polymorphic in terms of
625518-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
626519-- 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).
520+-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
521+-- this strategy is provided out-of-the-box (see below).
629522
630523-- | A type class for monads that support performing HTTP requests.
631524-- Typically, you only need to define the 'handleHttpException' method
632525-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
526+
527+class MonadIO m => MonadHttp m where
528+
634529 -- | This method describes how to deal with 'HttpException' that was
635530 -- caught by the library. One option is to re-throw it if you are OK with
636531 -- exceptions, but if you prefer working with something like
637532 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
638533 -- 'Control.Monad.Except.throwError'.
534+
639535 handleHttpException :: HttpException -> m a
640536
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
537+ -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
538+ -- implementation returns its 'def' value, which is described in the
539+ -- documentation for the type. Common usage pattern with manually defined
540+ -- 'getHttpConfig' is to return some hard-coded value, or a value
645541 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
646542 -- approach to configuration is desirable.
543+
647544 getHttpConfig :: m HttpConfig
648545 getHttpConfig = return defaultHttpConfig
649546
650−-- | 'HttpConfig' contains settings to be used when making HTTP requests.
547+-- | 'HttpConfig' contains general and default settings to be used when
548+-- making HTTP requests.
549+
651550data HttpConfig = HttpConfig
652− { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
551+ { httpConfigProxy :: Maybe L.Proxy
552+ -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
653553 -- environment variables are respected, this setting overwrites them.
654554 -- Default value: 'Nothing'.
655− httpConfigProxy :: Maybe L.Proxy,
656− -- | How many redirects to follow when getting a resource. Default
555+ , httpConfigRedirectCount :: Int
556+ -- ^ How many redirects to follow when getting a resource. Default
657557 -- value: 10.
658− httpConfigRedirectCount :: Int,
659− -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
558+ , httpConfigAltManager :: Maybe L.Manager
559+ -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
660560 -- that the default implicit manager will be used (that's what you want
661561 -- in 99% of cases).
662− httpConfigAltManager :: Maybe L.Manager,
663− -- | Function to check the response immediately after receiving the
562+ , httpConfigCheckResponse
563+ :: forall b.
564+ L.Request
565+ -> L.Response b
566+ -> ByteString
567+ -> Maybe L.HttpExceptionContent
568+ -- ^ Function to check the response immediately after receiving the
664569 -- status and headers, before streaming of response body. The third
665570 -- argument is the beginning of response body (typically first 1024
666571 -- bytes). This is used for throwing exceptions on non-success status
@@ -682,106 +587,67 @@ data HttpConfig = HttpConfig
682587 -- /1.0.0/.
683588 --
684589 -- @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
590+ , httpConfigRetryPolicy :: RetryPolicy
591+ -- ^ The retry policy to use for request retrying. By default 'def' is
692592 -- used (see 'RetryPolicyM').
693593 --
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/.
594+ -- __Note__: signature of this function was changed in the version
595+ -- /1.0.0/.
696596 --
697597 -- @since 0.3.0
698− httpConfigRetryPolicy :: RetryPolicyM IO,
699− -- | The function is used to decide whether to retry a request. 'True'
598+ , httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
599+ -- ^ The function is used to decide whether to retry a request. 'True'
700600 -- means that the request should be retried.
701601 --
702602 -- __Note__: signature of this function was changed in the version
703603 -- /1.0.0/.
704604 --
705605 -- @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− }
606+ } deriving Typeable
719607
720−-- | The default value of 'HttpConfig'.
608+-- | Default value of 'HttpConfig'.
721609--
722610-- @since 2.0.0
611+
723612defaultHttpConfig :: 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− }
613+defaultHttpConfig = HttpConfig
614+ { httpConfigProxy = Nothing
615+ , httpConfigRedirectCount = 10
616+ , httpConfigAltManager = Nothing
617+ , httpConfigCheckResponse = \_ response preview ->
618+ let scode = statusCode response
619+ in if 200 <= scode && scode < 300
620+ then Nothing
621+ else Just (L.StatusCodeException (void response) preview)
622+ , httpConfigRetryPolicy = retryPolicyDefault
623+ , httpConfigRetryJudge = \_ response ->
624+ statusCode response `elem`
625+ [ 408 -- Request timeout
626+ , 504 -- Gateway timeout
627+ , 524 -- A timeout occurred
628+ , 598 -- (Informal convention) Network read timeout error
629+ , 599 -- (Informal convention) Network connect timeout error
630+ ]
631+ }
753632 where
754633 statusCode = Y.statusCode . L.responseStatus
755634
756635instance RequestComponent HttpConfig where
757636 getRequestMod HttpConfig {..} = Endo $ \x ->
758− x
759− { L.proxy = httpConfigProxy,
760− L.redirectCount = httpConfigRedirectCount,
761− LI.requestManagerOverride = httpConfigAltManager
762− }
637+ x { L.proxy = httpConfigProxy
638+ , L.redirectCount = httpConfigRedirectCount
639+ , LI.requestManagerOverride = httpConfigAltManager }
763640
764−-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
641+-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
765642-- having to define new instances.
766643--
767644-- @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− )
776645
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
646+newtype Req a = Req (ReaderT HttpConfig IO a)
647+ deriving ( Functor
648+ , Applicative
649+ , Monad
650+ , MonadIO )
785651
786652instance MonadBase IO Req where
787653 liftBase = liftIO
@@ -790,99 +656,22 @@ instance MonadBaseControl IO Req where
790656 type StM Req a = a
791657 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
792658 {-# INLINEABLE liftBaseWith #-}
793− restoreM = Req . ReaderT . const . return
659+ restoreM = Req . ReaderT . const . return
794660 {-# INLINEABLE restoreM #-}
795661
796662instance MonadHttp Req where
797663 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
664+ getHttpConfig = Req ask
874665
875666-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
876−-- the case of an exceptional situation an 'HttpException' will be thrown.
667+-- case of exceptional situation an 'HttpException' will be thrown.
877668--
878669-- @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
670+
671+runReq :: MonadIO m
672+ => HttpConfig -- ^ 'HttpConfig' to use
673+ -> Req a -- ^ Computation to run
674+ -> m a
886675runReq config (Req m) = liftIO (runReaderT m config)
887676
888677----------------------------------------------------------------------------
@@ -898,6 +687,7 @@ runReq config (Req m) = liftIO (runReaderT m config)
898687-- define a new method that will works seamlessly, see 'HttpMethod'.
899688
900689-- | 'GET' method.
690+
901691data GET = GET
902692
903693instance HttpMethod GET where
@@ -905,6 +695,7 @@ instance HttpMethod GET where
905695 httpMethodName Proxy = Y.methodGet
906696
907697-- | 'POST' method.
698+
908699data POST = POST
909700
910701instance HttpMethod POST where
@@ -912,6 +703,7 @@ instance HttpMethod POST where
912703 httpMethodName Proxy = Y.methodPost
913704
914705-- | 'HEAD' method.
706+
915707data HEAD = HEAD
916708
917709instance HttpMethod HEAD where
@@ -919,24 +711,26 @@ instance HttpMethod HEAD where
919711 httpMethodName Proxy = Y.methodHead
920712
921713-- | 'PUT' method.
714+
922715data PUT = PUT
923716
924717instance HttpMethod PUT where
925718 type AllowsBody PUT = 'CanHaveBody
926719 httpMethodName Proxy = Y.methodPut
927720
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.
721+-- | 'DELETE' method. This data type does not allow having request body with
722+-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
723+-- requests to have bodies, in that case define your own variation of
724+-- 'DELETE' method and allow it to have a body.
725+
933726data DELETE = DELETE
934727
935728instance HttpMethod DELETE where
936− type AllowsBody DELETE = 'CanHaveBody
729+ type AllowsBody DELETE = 'NoBody
937730 httpMethodName Proxy = Y.methodDelete
938731
939732-- | 'TRACE' method.
733+
940734data TRACE = TRACE
941735
942736instance HttpMethod TRACE where
@@ -944,6 +738,7 @@ instance HttpMethod TRACE where
944738 httpMethodName Proxy = Y.methodTrace
945739
946740-- | 'CONNECT' method.
741+
947742data CONNECT = CONNECT
948743
949744instance HttpMethod CONNECT where
@@ -951,6 +746,7 @@ instance HttpMethod CONNECT where
951746 httpMethodName Proxy = Y.methodConnect
952747
953748-- | 'OPTIONS' method.
749+
954750data OPTIONS = OPTIONS
955751
956752instance HttpMethod OPTIONS where
@@ -958,6 +754,7 @@ instance HttpMethod OPTIONS where
958754 httpMethodName Proxy = Y.methodOptions
959755
960756-- | 'PATCH' method.
757+
961758data PATCH = PATCH
962759
963760instance HttpMethod PATCH where
@@ -972,19 +769,23 @@ instance HttpMethod PATCH where
972769-- > instance HttpMethod COPY where
973770-- > type AllowsBody COPY = 'CanHaveBody
974771-- > httpMethodName Proxy = "COPY"
772+
975773class HttpMethod a where
774+
976775 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
977776 -- tells the rest of the library whether the method can have body or not.
978777 -- We use the special type 'CanHaveBody' lifted to the kind level instead
979778 -- of 'Bool' to get more user-friendly compiler messages.
779+
980780 type AllowsBody a :: CanHaveBody
981781
982782 -- | Return name of the method as a 'ByteString'.
783+
983784 httpMethodName :: Proxy a -> ByteString
984785
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
786+instance HttpMethod method => RequestComponent (Womb "method" method) where
986787 getRequestMod _ = Endo $ \x ->
987− x {L.method = httpMethodName (Proxy :: Proxy method)}
788+ x { L.method = httpMethodName (Proxy :: Proxy method) }
988789
989790----------------------------------------------------------------------------
990791-- Request—URL
@@ -992,7 +793,8 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
992793-- $url
993794--
994795-- We use 'Url's which are correct by construction, see 'Url'. To build a
995−-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
796+-- 'Url' from a 'ByteString', use 'parseUrlHttp', 'parseUrlHttps', or
797+-- generic 'parseUrl'.
996798
997799-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
998800-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -1022,194 +824,103 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1022824--
1023825-- > https "юникод.рф"
1024826-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
827+
1025828data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026829 -- 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
830+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
1041831
1042832-- | Given host name, produce a 'Url' which has “http” as its scheme and
1043833-- empty path. This also sets port to @80@.
834+
1044835http :: Text -> Url 'Http
1045836http = Url Http . pure
1046837
1047838-- | Given host name, produce a 'Url' which has “https” as its scheme and
1048839-- empty path. This also sets port to @443@.
840+
1049841https :: Text -> Url 'Https
1050842https = Url Https . pure
1051843
1052−-- | Grow a given 'Url' appending a single path segment to it. Note that the
844+-- | Grow given 'Url' appending a single path segment to it. Note that the
1053845-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1054−infixl 5 /~
1055846
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
847+infixl 5 /~
848+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057849Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1058850
1059−-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060−-- when next URL piece is a 'Data.Text.Text' literal.
1061−infixl 5 /:
851+-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
852+-- when next URL piece is a 'Text' literal.
1062853
854+infixl 5 /:
1063855(/:) :: Url scheme -> Text -> Url scheme
1064856(/:) = (/~)
1065857
1066−-- | Render a 'Url' as 'Text'.
1067−--
1068−-- @since 3.4.0
1069−renderUrl :: Url scheme -> Text
1070−renderUrl = \case
1071− Url Https parts ->
1072− "https://" <> renderParts parts
1073− Url Http parts ->
1074− "http://" <> renderParts parts
1075− where
1076− renderParts parts =
1077− T.intercalate "/" (reverse $ NE.toList parts)
1078−
1079−-- | The 'useHttpURI' function provides an alternative method to get 'Url'
1080−-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
1081−-- given a URL to query dynamically and don't know it beforehand.
1082−--
1083−-- This function expects the scheme to be “http” and host to be present.
1084−--
1085−-- @since 3.0.0
1086−useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
1087−useHttpURI uri = do
1088− guard (URI.uriScheme uri == Just [QQ.scheme|http|])
1089− urlHead <- http <$> uriHost uri
1090− let url = case URI.uriPath uri of
1091− Nothing -> urlHead
1092− Just uriPath -> uriPathToUrl uriPath urlHead
1093− return (url, uriOptions uri)
1094−
1095−-- | Just like 'useHttpURI', but expects the “https” scheme.
1096−--
1097−-- @since 3.0.0
1098−useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
1099−useHttpsURI uri = do
1100− guard (URI.uriScheme uri == Just [QQ.scheme|https|])
1101− urlHead <- https <$> uriHost uri
1102− let url = case URI.uriPath uri of
1103− Nothing -> urlHead
1104− Just uriPath -> uriPathToUrl uriPath urlHead
1105− return (url, uriOptions uri)
1106−
1107−-- | Convert URI path to a 'Url'. Internal.
1108−--
1109−-- @since 3.9.0
1110−uriPathToUrl ::
1111− (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
1112− Url scheme ->
1113− Url scheme
1114−uriPathToUrl (trailingSlash, xs) urlHead =
1115− if trailingSlash then path /: T.empty else path
1116− where
1117− path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1118−
1119−-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
1120−-- is not known in advance.
1121−--
1122−-- @since 3.0.0
1123−useURI ::
1124− URI ->
1125− Maybe
1126− ( Either
1127− (Url 'Http, Option scheme0)
1128− (Url 'Https, Option scheme1)
1129− )
1130−useURI uri =
1131− (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
1132−
1133−-- | An internal helper function to extract host from a 'URI'.
1134−uriHost :: URI -> Maybe Text
1135−uriHost uri = case URI.uriAuthority uri of
1136− Left _ -> Nothing
1137− Right URI.Authority {..} ->
1138− Just (URI.unRText authHost)
1139−
1140−-- | A quasiquoter to build an 'Url' and 'Option' tuple. The type of the
1141−-- generated expression is @('Url' scheme0, 'Option' scheme1)@ with
1142−-- @scheme0@ being either 'Http' or 'Https' depending on the input.
1143−--
1144−-- @since 3.2.0
1145−urlQ :: TH.QuasiQuoter
1146−urlQ =
1147− TH.QuasiQuoter
1148− { quoteExp = \str ->
1149− case URI.mkURI (T.pack str) of
1150− Left err -> fail (displayException err)
1151− Right uri -> case useURI uri of
1152− Nothing -> fail "Not a HTTP or HTTPS URL"
1153− Just eurl ->
1154− TH.tupE
1155− [ either (TH.lift . fst) (TH.lift . fst) eurl,
1156− [|uriOptions uri|]
1157− ],
1158− quotePat = error "This usage is not supported",
1159− quoteType = error "This usage is not supported",
1160− quoteDec = error "This usage is not supported"
1161− }
1162−
1163−-- | An internal helper function to extract 'Option's from a 'URI'.
1164−uriOptions :: forall scheme. URI -> Option scheme
1165−uriOptions uri =
1166− mconcat
1167− [ auth,
1168− query,
1169− port'
1170− -- , fragment'
1171− ]
1172− where
1173− (auth, port') =
1174− case URI.uriAuthority uri of
1175− Left _ -> (mempty, mempty)
1176− Right URI.Authority {..} ->
1177− let auth0 = case authUserInfo of
1178− Nothing -> mempty
1179− Just URI.UserInfo {..} ->
1180− let username = T.encodeUtf8 (URI.unRText uiUsername)
1181− password = maybe "" (T.encodeUtf8 . URI.unRText) uiPassword
1182− in basicAuthUnsafe username password
1183− port0 = case authPort of
1184− Nothing -> mempty
1185− Just port'' -> port (fromIntegral port'')
1186− in (auth0, port0)
1187− query =
1188− let liftQueryParam = \case
1189− URI.QueryFlag t -> queryFlag (URI.unRText t)
1190− URI.QueryParam k v -> URI.unRText k =: URI.unRText v
1191− in mconcat (liftQueryParam <$> URI.uriQuery uri)
1192−
1193−-- TODO Blocked on upstream: https://github.com/snoyberg/http-client/issues/424
1194−-- fragment' =
1195−-- case URI.uriFragment uri of
1196−-- Nothing -> mempty
1197−-- Just fragment'' -> fragment (URI.unRText fragment'')
858+-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
859+-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
860+-- you are given a URL to query dynamically and don't know it beforehand.
861+-- The function parses 'ByteString' because it's the correct type to
862+-- represent a URL, as 'Url' cannot contain characters outside of ASCII
863+-- range, thus we can consider every character a 'Data.Word.Word8' value.
864+--
865+-- This function only parses 'Url' (scheme, host, path) and optional query
866+-- parameters that are returned as 'Option'. It does not parse method name
867+-- or authentication info from given 'ByteString'.
868+--
869+-- This function expected scheme to be “http”.
870+
871+parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
872+parseUrlHttp url' = do
873+ url <- B.stripPrefix "http://" url'
874+ (host :| path, option) <- parseUrlHelper url
875+ return (foldl (/:) (http host) path, option)
876+
877+-- | Just like 'parseUrlHttp', but expects the “https” scheme.
878+
879+parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
880+parseUrlHttps url' = do
881+ url <- B.stripPrefix "https://" url'
882+ (host :| path, option) <- parseUrlHelper url
883+ return (foldl (/:) (https host) path, option)
884+
885+-- | A more general URI parsing function that can be used when scheme is not
886+-- known beforehand.
887+--
888+-- @since 1.2.1
889+
890+parseUrl
891+ :: ByteString
892+ -> Maybe (Either (Url 'Http, Option scheme0) (Url 'Https, Option scheme1))
893+parseUrl url = Left <$> parseUrlHttp url <|> Right <$> parseUrlHttps url
894+
895+-- | Get host\/collection of path pieces and possibly query parameters
896+-- already converted to 'Option'. This function is not public.
897+
898+parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
899+parseUrlHelper url = do
900+ let (path', query') = B.break (== 0x3f) url
901+ query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
902+ p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
903+ (p, port') <-
904+ case T.break (== ':') p' of
905+ (x, "") -> return (x, mempty)
906+ (x, prt) ->
907+ case TR.decimal (T.drop 1 prt) of
908+ Right (prt',"") -> return (x, port prt')
909+ _ -> Nothing
910+ return (p :| ps, query <> port')
1198911
1199912instance RequestComponent (Url scheme) where
1200913 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− }
914+ let (host :| path) = NE.reverse segments in
915+ x { L.secure = case scheme of
916+ Http -> False
917+ Https -> True
918+ , L.port = case scheme of
919+ Http -> 80
920+ Https -> 443
921+ , L.host = Y.urlEncode False (T.encodeUtf8 host)
922+ , L.path =
923+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1213924
1214925----------------------------------------------------------------------------
1215926-- Request—Body
@@ -1227,28 +938,31 @@ instance RequestComponent (Url scheme) where
1227938-- only type for which 'ProvidesBody' returns 'NoBody'.
1228939--
1229940-- Using of this body option does not set the @Content-Type@ header.
941+
1230942data NoReqBody = NoReqBody
1231943
1232944instance HttpBody NoReqBody where
1233945 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1234946
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.
947+-- | This body option allows to use a JSON object as request body—probably
948+-- the most popular format right now. Just wrap a data type that is an
949+-- instance of 'ToJSON' type class and you are done: it will be converted to
950+-- JSON and inserted as request body.
1239951--
1240952-- This body option sets the @Content-Type@ header to @\"application/json;
1241953-- charset=utf-8\"@ value.
954+
1242955newtype ReqBodyJson a = ReqBodyJson a
1243956
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
957+instance ToJSON a => HttpBody (ReqBodyJson a) where
1245958 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1246959 getRequestContentType _ = pure "application/json; charset=utf-8"
1247960
1248961-- | This body option streams request body from a file. It is expected that
1249−-- the file size does not change during streaming.
962+-- the file size does not change during the streaming.
1250963--
1251964-- Using of this body option does not set the @Content-Type@ header.
965+
1252966newtype ReqBodyFile = ReqBodyFile FilePath
1253967
1254968instance HttpBody ReqBodyFile where
@@ -1258,6 +972,7 @@ instance HttpBody ReqBodyFile where
1258972-- | HTTP request body represented by a strict 'ByteString'.
1259973--
1260974-- Using of this body option does not set the @Content-Type@ header.
975+
1261976newtype ReqBodyBs = ReqBodyBs ByteString
1262977
1263978instance HttpBody ReqBodyBs where
@@ -1266,19 +981,22 @@ instance HttpBody ReqBodyBs where
1266981-- | HTTP request body represented by a lazy 'BL.ByteString'.
1267982--
1268983-- Using of this body option does not set the @Content-Type@ header.
984+
1269985newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1270986
1271987instance HttpBody ReqBodyLbs where
1272988 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1273989
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'.
990+-- | Form URL-encoded body. This can hold a collection of parameters which
991+-- are encoded similarly to query parameters at the end of query string,
992+-- with the only difference that they are stored in request body. The
993+-- similarity is reflected in the API as well, as you can use the same
994+-- combinators you would use to add query parameters: @('=:')@ and
995+-- 'queryFlag'.
1279996--
1280997-- This body option sets the @Content-Type@ header to
1281998-- @\"application/x-www-form-urlencoded\"@ value.
999+
12821000newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
12831001
12841002instance HttpBody ReqBodyUrlEnc where
@@ -1288,19 +1006,13 @@ instance HttpBody ReqBodyUrlEnc where
12881006
12891007-- | An opaque monoidal value that allows to collect URL-encoded parameters
12901008-- to be wrapped in 'ReqBodyUrlEnc'.
1009+
12911010newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
12921011 deriving (Semigroup, Monoid)
12931012
12941013instance QueryParam FormUrlEncodedParam where
12951014 queryParam name mvalue =
12961015 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
13041016
13051017-- | Multipart form data. Please consult the
13061018-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1330,6 +1042,7 @@ instance FromForm FormUrlEncodedParam where
13301042-- > bsResponse
13311043-- > mempty
13321044-- > liftIO $ print (responseBody response)
1045+
13331046data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
13341047
13351048instance HttpBody ReqBodyMultipart where
@@ -1340,57 +1053,61 @@ instance HttpBody ReqBodyMultipart where
13401053-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
13411054--
13421055-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
1056+
1057+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
13441058reqBodyMultipart parts = liftIO $ do
13451059 boundary <- LM.webkitBoundary
1346− body <- LM.renderParts boundary parts
1060+ body <- LM.renderParts boundary parts
13471061 return (ReqBodyMultipart boundary body)
13481062
13491063-- | A type class for things that can be interpreted as an HTTP
13501064-- 'L.RequestBody'.
1065+
13511066class HttpBody body where
1067+
13521068 -- | How to get actual 'L.RequestBody'.
1069+
13531070 getRequestBody :: body -> L.RequestBody
13541071
13551072 -- | This method allows us to optionally specify the value of
13561073 -- @Content-Type@ header that should be used with particular body option.
13571074 -- By default it returns 'Nothing' and so @Content-Type@ is not set.
1075+
13581076 getRequestContentType :: body -> Maybe ByteString
13591077 getRequestContentType = const Nothing
13601078
13611079-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
13621080-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
13631081-- with 'GET' method and other methods that should not have body.
1082+
13641083type family ProvidesBody body :: CanHaveBody where
13651084 ProvidesBody NoReqBody = 'NoBody
1366− ProvidesBody body = 'CanHaveBody
1085+ ProvidesBody body = 'CanHaveBody
13671086
13681087-- | This type function allows any HTTP body if method says it
13691088-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
13701089-- 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− }
1090+--
1091+-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1092+-- error message when method does not allow a body and body is provided.
1093+
1094+type family HttpBodyAllowed
1095+ (allowsBody :: CanHaveBody)
1096+ (providesBody :: CanHaveBody) :: Constraint where
1097+ HttpBodyAllowed 'NoBody 'NoBody = ()
1098+ HttpBodyAllowed 'CanHaveBody body = ()
1099+ HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1100+ ('Text "This HTTP method does not allow attaching a request body.")
1101+
1102+instance HttpBody body => RequestComponent (Womb "body" body) where
1103+ getRequestMod (Womb body) = Endo $ \x ->
1104+ x { L.requestBody = getRequestBody body
1105+ , L.requestHeaders =
1106+ let old = L.requestHeaders x in
1107+ case getRequestContentType body of
1108+ Nothing -> old
1109+ Just contentType ->
1110+ (Y.hContentType, contentType) : old }
13941111
13951112----------------------------------------------------------------------------
13961113-- Request—Optional parameters
@@ -1406,51 +1123,46 @@ instance (HttpBody body) => RequestComponent (Tagged "body" body) where
14061123-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
14071124-- of optional parameters like query parameters and headers. See sections
14081125-- 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))
14111126
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.
1127+data Option (scheme :: Scheme) =
1128+ Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1129+ -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1130+ -- Request to avoid appending to existing query string in request every
1131+ -- time new parameter is added. Additional Maybe (L.Request -> IO
1132+ -- L.Request) is a finalizer that will be applied after all other
1133+ -- transformations. This is for authentication methods that sign requests
1134+ -- based on data in Request.
14181135
14191136instance Semigroup (Option scheme) where
1420− Option er0 mr0 <> Option er1 mr1 =
1421− Option
1422− (er0 <> er1)
1423− (mr0 <|> mr1)
1137+ Option er0 mr0 <> Option er1 mr1 = Option
1138+ (er0 <> er1) (mr0 <|> mr1)
14241139
14251140instance Monoid (Option scheme) where
1426− mempty = Option mempty Nothing
1141+ mempty = Option mempty Nothing
14271142 mappend = (<>)
14281143
1429−-- | Use 'formToQuery'.
1430−--
1431−-- @since 3.11.0
1432−instance FromForm (Option scheme) where
1433− fromForm = Right . formToQuery
1434−
14351144-- | A helper to create an 'Option' that modifies only collection of query
14361145-- parameters. This helper is not a part of the public API.
1146+
14371147withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
14381148withQueryParams f = Option (Endo (first f)) Nothing
14391149
14401150-- | A helper to create an 'Option' that modifies only 'L.Request'. This
14411151-- helper is not a part of public API.
1152+
14421153withRequest :: (L.Request -> L.Request) -> Option scheme
14431154withRequest f = Option (Endo (second f)) Nothing
14441155
14451156instance RequestComponent (Option scheme) where
14461157 getRequestMod (Option f _) = Endo $ \x ->
14471158 let (qparams, x') = appEndo f ([], x)
1448− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449− in x' {L.queryString = query}
1159+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1160+ in x' { L.queryString = query }
14501161
14511162-- | Finalize given 'L.Request' by applying a finalizer from the given
14521163-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1164+
1165+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
14541166finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14551167
14561168----------------------------------------------------------------------------
@@ -1469,12 +1181,12 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14691181-- This operator is defined in terms of 'queryParam':
14701182--
14711183-- > name =: value = queryParam name (pure value)
1472−infix 7 =:
14731184
1185+infix 7 =:
14741186(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
14751187name =: value = queryParam name (pure value)
14761188
1477−-- | Construct a flag, that is, a valueless query parameter. For example, in
1189+-- | Construct a flag, that is, valueless query parameter. For example, in
14781190-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
14791191-- with a value:
14801192--
@@ -1483,47 +1195,27 @@ name =: value = queryParam name (pure value)
14831195-- This operator is defined in terms of 'queryParam':
14841196--
14851197-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486−queryFlag :: (QueryParam param) => Text -> param
1487−queryFlag name = queryParam name (Nothing :: Maybe ())
14881198
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
1199+queryFlag :: QueryParam param => Text -> param
1200+queryFlag name = queryParam name (Nothing :: Maybe ())
15061201
15071202-- | A type class for query-parameter-like things. The reason to have an
15081203-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
15091204-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
15101205-- Having the same syntax for these cases seems natural and user-friendly.
1206+
15111207class QueryParam param where
1208+
15121209 -- | Create a query parameter with given name and value. If value is
15131210 -- 'Nothing', it won't be included at all (i.e. you create a flag this
15141211 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
15151212 -- method, because they are easier to read.
1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
15171213
1518− -- | Get the query parameter names and values set by 'queryParam'.
1519− --
1520− -- @since 3.11.0
1521− queryParamToList :: param -> [(Text, Maybe Text)]
1214+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param
15221215
15231216instance QueryParam (Option scheme) where
15241217 queryParam name mvalue =
15251218 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
15271219
15281220----------------------------------------------------------------------------
15291221-- Request—Optional parameters—Headers
@@ -1532,28 +1224,20 @@ instance QueryParam (Option scheme) where
15321224-- headers with the same names the leftmost header will win. This means, in
15331225-- particular, that you cannot create a request with several headers of the
15341226-- same name.
1535−header ::
1536− -- | Header name
1537− ByteString ->
1538− -- | Header value
1539− ByteString ->
1540− Option scheme
1227+
1228+header
1229+ :: ByteString -- ^ Header name
1230+ -> ByteString -- ^ Header value
1231+ -> Option scheme
15411232header name value = withRequest (attachHeader name value)
15421233
15431234-- | Attach a header with given name and content to a 'L.Request'.
15441235--
15451236-- @since 1.1.0
1237+
15461238attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15471239attachHeader 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}
1240+ x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
15571241
15581242----------------------------------------------------------------------------
15591243-- Request—Optional parameters—Cookies
@@ -1566,9 +1250,10 @@ headerRedacted name value = withRequest $ \x ->
15661250
15671251-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
15681252-- 'L.Response' record.
1253+
15691254cookieJar :: L.CookieJar -> Option scheme
15701255cookieJar jar = withRequest $ \x ->
1571− x {L.cookieJar = Just jar}
1256+ x { L.cookieJar = Just jar }
15721257
15731258----------------------------------------------------------------------------
15741259-- Request—Optional parameters—Authentication
@@ -1586,13 +1271,11 @@ cookieJar jar = withRequest $ \x ->
15861271-- | The 'Option' adds basic authentication.
15871272--
15881273-- 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
1274+
1275+basicAuth
1276+ :: ByteString -- ^ Username
1277+ -> ByteString -- ^ Password
1278+ -> Option 'Https -- ^ Auth 'Option'
15961279basicAuth = basicAuthUnsafe
15971280
15981281-- | An alternative to 'basicAuth' which works for any scheme. Note that
@@ -1600,52 +1283,41 @@ basicAuth = basicAuthUnsafe
16001283-- attacks. Use 'basicAuth' instead unless you know what you are doing.
16011284--
16021285-- @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)
1286+
1287+basicAuthUnsafe
1288+ :: ByteString -- ^ Username
1289+ -> ByteString -- ^ Password
1290+ -> Option scheme -- ^ Auth 'Option'
1291+basicAuthUnsafe username password = customAuth
1292+ (pure . L.applyBasicAuth username password)
16131293
16141294-- | The 'Option' set basic proxy authentication header.
16151295--
16161296-- @since 1.1.0
1617−basicProxyAuth ::
1618− -- | Username
1619− ByteString ->
1620− -- | Password
1621− ByteString ->
1622− -- | Auth 'Option'
1623− Option scheme
1297+
1298+basicProxyAuth
1299+ :: ByteString -- ^ Username
1300+ -> ByteString -- ^ Password
1301+ -> Option scheme -- ^ Auth 'Option'
16241302basicProxyAuth username password =
16251303 withRequest (L.applyBasicProxyAuth username password)
16261304
16271305-- | The 'Option' adds OAuth1 authentication.
16281306--
16291307-- @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
1308+
1309+oAuth1
1310+ :: ByteString -- ^ Consumer token
1311+ -> ByteString -- ^ Consumer secret
1312+ -> ByteString -- ^ OAuth token
1313+ -> ByteString -- ^ OAuth token secret
1314+ -> Option scheme -- ^ Auth 'Option'
16411315oAuth1 consumerToken consumerSecret token tokenSecret =
16421316 customAuth (OAuth.signOAuth app creds)
16431317 where
1644− app =
1645− OAuth.newOAuth
1646− { OAuth.oauthConsumerKey = consumerToken,
1647− OAuth.oauthConsumerSecret = consumerSecret
1648− }
1318+ app = OAuth.newOAuth
1319+ { OAuth.oauthConsumerKey = consumerToken
1320+ , OAuth.oauthConsumerSecret = consumerSecret }
16491321 creds = OAuth.newCredential token tokenSecret
16501322
16511323-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1656,14 +1328,12 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
16561328-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
16571329--
16581330-- 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))
1331+
1332+oAuth2Bearer
1333+ :: ByteString -- ^ Token
1334+ -> Option 'Https -- ^ Auth 'Option'
1335+oAuth2Bearer token = customAuth
1336+ (pure . attachHeader "Authorization" ("Bearer " <> token))
16671337
16681338-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
16691339-- to be used only by GitHub). This will be treated by whatever services
@@ -1674,20 +1344,19 @@ oAuth2Bearer token =
16741344-- > oAuth2Token token = header "Authorization" ("token" <> token)
16751345--
16761346-- 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))
1347+
1348+oAuth2Token
1349+ :: ByteString -- ^ Token
1350+ -> Option 'Https -- ^ Auth 'Option'
1351+oAuth2Token token = customAuth
1352+ (pure . attachHeader "Authorization" ("token " <> token))
16851353
16861354-- | A helper to create custom authentication 'Option's. The given
16871355-- 'IO'-enabled request transformation is applied after all other
16881356-- modifications when constructing a request. Use wisely.
16891357--
16901358-- @since 1.1.0
1359+
16911360customAuth :: (L.Request -> IO L.Request) -> Option scheme
16921361customAuth = Option mempty . pure
16931362
@@ -1696,10 +1365,11 @@ customAuth = Option mempty . pure
16961365
16971366-- | Specify the port to connect to explicitly. Normally, 'Url' you use
16981367-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1699−-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1368+-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1369+
17001370port :: Int -> Option scheme
17011371port n = withRequest $ \x ->
1702− x {L.port = n}
1372+ x { L.port = n }
17031373
17041374-- | This 'Option' controls whether gzipped data should be decompressed on
17051375-- the fly. By default everything except for @\"application\/x-tar\"@ is
@@ -1710,40 +1380,39 @@ port n = withRequest $ \x ->
17101380-- You can also choose to decompress everything like this:
17111381--
17121382-- > 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
1383+
1384+decompress
1385+ :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1386+ -- returns 'True' when content should be decompressed on the fly.
1387+ -> Option scheme
17181388decompress f = withRequest $ \x ->
1719− x {L.decompress = f}
1389+ x { L.decompress = f }
17201390
17211391-- | Specify the number of microseconds to wait for response. The default
17221392-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
17231393-- 'L.Manager').
1724−responseTimeout ::
1725− -- | Number of microseconds to wait
1726− Int ->
1727− Option scheme
1394+
1395+responseTimeout
1396+ :: Int -- ^ Number of microseconds to wait
1397+ -> Option scheme
17281398responseTimeout n = withRequest $ \x ->
1729− x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1399+ x { L.responseTimeout = LI.ResponseTimeoutMicro n }
17301400
17311401-- | 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
1402+
1403+httpVersion
1404+ :: Int -- ^ Major version number
1405+ -> Int -- ^ Minor version number
1406+ -> Option scheme
17381407httpVersion major minor = withRequest $ \x ->
1739− x {L.requestVersion = Y.HttpVersion major minor}
1408+ x { L.requestVersion = Y.HttpVersion major minor }
17401409
17411410----------------------------------------------------------------------------
17421411-- Response interpretations
17431412
17441413-- | Make a request and ignore the body of the response.
1414+
17451415newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746− deriving (Show)
17471416
17481417instance HttpResponse IgnoreResponse where
17491418 type HttpResponseBody IgnoreResponse = ()
@@ -1752,6 +1421,7 @@ instance HttpResponse IgnoreResponse where
17521421
17531422-- | Use this as the fourth argument of 'req' to specify that you want it to
17541423-- ignore the response body.
1424+
17551425ignoreResponse :: Proxy IgnoreResponse
17561426ignoreResponse = Proxy
17571427
@@ -1759,28 +1429,28 @@ ignoreResponse = Proxy
17591429-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
17601430-- monad in which you use 'req' will determine what to do in the case when
17611431-- parsing fails (the 'JsonHttpException' constructor will be used).
1432+
17621433newtype JsonResponse a = JsonResponse (L.Response a)
1763− deriving (Show)
17641434
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1435+instance FromJSON a => HttpResponse (JsonResponse a) where
17661436 type HttpResponseBody (JsonResponse a) = a
17671437 toVanillaResponse (JsonResponse r) = r
17681438 getHttpResponse r = do
17691439 chunks <- L.brConsume (L.responseBody r)
17701440 case A.eitherDecode (BL.fromChunks chunks) of
1771− Left e -> throwIO (JsonHttpException e)
1441+ Left e -> throwIO (JsonHttpException e)
17721442 Right x -> return $ JsonResponse (x <$ r)
1773− acceptHeader Proxy = Just "application/json"
17741443
17751444-- | Use this as the fourth argument of 'req' to specify that you want it to
17761445-- return the 'JsonResponse' interpretation.
1446+
17771447jsonResponse :: Proxy (JsonResponse a)
17781448jsonResponse = Proxy
17791449
17801450-- | Make a request and interpret the body of the response as a strict
17811451-- 'ByteString'.
1452+
17821453newtype BsResponse = BsResponse (L.Response ByteString)
1783− deriving (Show)
17841454
17851455instance HttpResponse BsResponse where
17861456 type HttpResponseBody BsResponse = ByteString
@@ -1791,13 +1461,14 @@ instance HttpResponse BsResponse where
17911461
17921462-- | Use this as the fourth argument of 'req' to specify that you want to
17931463-- interpret the response body as a strict 'ByteString'.
1464+
17941465bsResponse :: Proxy BsResponse
17951466bsResponse = Proxy
17961467
17971468-- | Make a request and interpret the body of the response as a lazy
17981469-- 'BL.ByteString'.
1470+
17991471newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800− deriving (Show)
18011472
18021473instance HttpResponse LbsResponse where
18031474 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1808,22 +1479,24 @@ instance HttpResponse LbsResponse where
18081479
18091480-- | Use this as the fourth argument of 'req' to specify that you want to
18101481-- interpret the response body as a lazy 'BL.ByteString'.
1482+
18111483lbsResponse :: Proxy LbsResponse
18121484lbsResponse = Proxy
18131485
18141486----------------------------------------------------------------------------
18151487-- Helpers for response interpretations
18161488
1817−-- | Fetch beginning of the response and return it together with a new
1489+-- | Fetch beginning of response and return it together with new
18181490-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
18191491-- 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)
1492+
1493+grabPreview
1494+ :: Int
1495+ -- ^ How many bytes to fetch
1496+ -> L.Response L.BodyReader
1497+ -- ^ Response with body reader inside
1498+ -> IO (ByteString, L.Response L.BodyReader)
1499+ -- ^ Preview 'ByteString' and new response with body reader inside
18271500grabPreview nbytes r = do
18281501 let br = L.responseBody r
18291502 (target, leftover, done) <- brReadN br nbytes
@@ -1846,17 +1519,18 @@ grabPreview nbytes r = do
18461519 if done
18471520 then return B.empty
18481521 else br
1849− return (target, r {L.responseBody = br'})
1522+ return (target, r { L.responseBody = br' })
18501523
18511524-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
18521525-- 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)
1526+
1527+brReadN
1528+ :: L.BodyReader
1529+ -- ^ Body reader to stream from
1530+ -> Int
1531+ -- ^ How many bytes to consume
1532+ -> IO (ByteString, ByteString, Bool)
1533+ -- ^ Target chunk, the leftover, whether we're done
18601534brReadN br n = go 0 id id
18611535 where
18621536 go !tlen t l = do
@@ -1865,9 +1539,9 @@ brReadN br n = go 0 id id
18651539 then return (r t, r l, True)
18661540 else do
18671541 let (target, leftover) = B.splitAt (n - tlen) chunk
1868− tlen' = B.length target
1869− t' = t . (target :)
1870− l' = l . (leftover :)
1542+ tlen' = B.length target
1543+ t' = t . (target:)
1544+ l' = l . (leftover:)
18711545 if tlen + tlen' < n
18721546 then go (tlen + tlen') t' l'
18731547 else return (r t', r l', False)
@@ -1877,45 +1551,47 @@ brReadN br n = go 0 id id
18771551-- Inspecting a response
18781552
18791553-- | Get the response body.
1880−responseBody ::
1881− (HttpResponse response) =>
1882− response ->
1883− HttpResponseBody response
1554+
1555+responseBody
1556+ :: HttpResponse response
1557+ => response
1558+ -> HttpResponseBody response
18841559responseBody = L.responseBody . toVanillaResponse
18851560
18861561-- | Get the response status code.
1887−responseStatusCode ::
1888− (HttpResponse response) =>
1889− response ->
1890− Int
1562+
1563+responseStatusCode
1564+ :: HttpResponse response
1565+ => response
1566+ -> Int
18911567responseStatusCode =
18921568 Y.statusCode . L.responseStatus . toVanillaResponse
18931569
18941570-- | Get the response status message.
1895−responseStatusMessage ::
1896− (HttpResponse response) =>
1897− response ->
1898− ByteString
1571+
1572+responseStatusMessage
1573+ :: HttpResponse response
1574+ => response
1575+ -> ByteString
18991576responseStatusMessage =
19001577 Y.statusMessage . L.responseStatus . toVanillaResponse
19011578
19021579-- | 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
1580+
1581+responseHeader
1582+ :: HttpResponse response
1583+ => response -- ^ Response interpretation
1584+ -> ByteString -- ^ Header to lookup
1585+ -> Maybe ByteString -- ^ Header value if found
19111586responseHeader r h =
19121587 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
19131588
19141589-- | Get the response 'L.CookieJar'.
1915−responseCookieJar ::
1916− (HttpResponse response) =>
1917− response ->
1918− L.CookieJar
1590+
1591+responseCookieJar
1592+ :: HttpResponse response
1593+ => response
1594+ -> L.CookieJar
19191595responseCookieJar = L.responseCookieJar . toVanillaResponse
19201596
19211597----------------------------------------------------------------------------
@@ -1926,15 +1602,19 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
19261602-- To create a new response interpretation you just need to make your data
19271603-- type an instance of the 'HttpResponse' type class.
19281604
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.
1605+-- | A type class for response interpretations. It allows to describe how to
1606+-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1607+-- final result that is to be returned to the user.
1608+
19321609class HttpResponse response where
1610+
19331611 -- | The associated type is the type of body that can be extracted from an
19341612 -- instance of 'HttpResponse'.
1935− type HttpResponseBody response :: Type
1613+
1614+ type HttpResponseBody response :: *
19361615
19371616 -- | The method describes how to get the underlying 'L.Response' record.
1617+
19381618 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
19391619
19401620 -- | This method describes how to consume response body and, more
@@ -1950,32 +1630,12 @@ class HttpResponse response where
19501630 --
19511631 -- __Note__: signature of this function was changed in the version
19521632 -- /1.0.0/.
1953− getHttpResponse ::
1954− -- | Response with body reader inside
1955− L.Response L.BodyReader ->
1956− -- | The final result
1957− IO response
1958−
1959− -- | The value of @\"Accept\"@ header. This is useful, for example, if a
1960− -- website supports both @XML@ and @JSON@ responses, and decides what to
1961− -- reply with based on what @Accept@ headers you have sent.
1962− --
1963− -- __Note__: manually specified 'Options' that set the @\"Accept\"@ header
1964− -- will take precedence.
1965− --
1966− -- @since 2.1.0
1967− acceptHeader :: Proxy response -> Maybe ByteString
1968− acceptHeader Proxy = Nothing
19691633
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
1634+ getHttpResponse
1635+ :: L.Response L.BodyReader
1636+ -- ^ Response with body reader inside
1637+ -> IO response
1638+ -- ^ The final result
19791639
19801640----------------------------------------------------------------------------
19811641-- Other
@@ -1987,12 +1647,15 @@ instance HttpResponse (L.Response ()) where
19871647-- request components easier using @('<>')@.
19881648--
19891649-- __Note__: this type class is not a part of the public API.
1650+
19901651class RequestComponent a where
1652+
19911653 -- | Get a function that takes a 'L.Request' and changes it somehow
19921654 -- returning another 'L.Request'. For example, the 'HttpMethod' instance
19931655 -- of 'RequestComponent' just overwrites method. The function is wrapped
19941656 -- in 'Endo' so it's easier to chain such “modifying applications”
19951657 -- together building bigger and bigger 'RequestComponent's.
1658+
19961659 getRequestMod :: a -> Endo L.Request
19971660
19981661-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -2002,50 +1665,44 @@ class RequestComponent a where
20021665-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
20031666-- which instance to use (i.e. the constraints are taken into account later,
20041667-- when instance is already chosen).
2005−newtype Tagged (tag :: Symbol) a = Tagged a
1668+
1669+newtype Womb (tag :: Symbol) a = Womb a
20061670
20071671-- | Exceptions that this library throws.
1672+
20081673data 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
1674+ = VanillaHttpException L.HttpException
1675+ -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1676+ | JsonHttpException String
1677+ -- ^ A wrapper with Aeson-produced 'String' describing why decoding
20121678 -- failed
2013− JsonHttpException String
2014− deriving (Show, Generic)
1679+ deriving (Show, Typeable, Generic)
20151680
20161681instance Exception HttpException
20171682
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−
20321683-- | A simple type isomorphic to 'Bool' that we only have for better error
20331684-- messages. We use it as a kind and its data constructors as type-level
20341685-- tags.
20351686--
20361687-- See also: 'HttpMethod' and 'HttpBody'.
1688+
20371689data CanHaveBody
2038− = -- | Indeed can have a body
2039− CanHaveBody
2040− | -- | Should not have a body
2041− NoBody
1690+ = CanHaveBody -- ^ Indeed can have a body
1691+ | NoBody -- ^ Should not have a body
20421692
20431693-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
20441694-- enabled). This is used to force TLS requirement for some authentication
20451695-- 'Option's.
1696+
20461697data Scheme
2047− = -- | HTTP
2048− Http
2049− | -- | HTTPS
2050− Https
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1698+ = Http -- ^ HTTP
1699+ | Https -- ^ HTTPS
1700+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
1701+
1702+----------------------------------------------------------------------------
1703+-- Constants
1704+
1705+-- | Max length of preview fragment of response body.
1706+
1707+bodyPreviewLength :: Num a => a
1708+bodyPreviewLength = 1024