@@ -1,6 +1,16 @@
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE QuasiQuotes #-}
5+{-# LANGUAGE RecordWildCards #-}
6+{-# LANGUAGE RoleAnnotations #-}
7+{-# LANGUAGE TemplateHaskellQuotes #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+
111-- |
212-- Module : Network.HTTP.Req
3−-- Copyright : © 2016–2017 Mark Karpov
13+-- Copyright : © 2016–present Mark Karpov
414-- License : BSD 3 clause
515--
616-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
@@ -9,61 +19,40 @@
919--
1020-- The documentation below is structured in such a way that the most
1121-- important information is presented first: you learn how to do HTTP
12−-- requests, how to embed them in any monad you have, and then it gives you
22+-- requests, how to embed them in the monad you have, and then it gives you
1323-- details about less-common things you may want to know about. The
1424-- documentation is written with sufficient coverage of details and
1525-- examples, and it's designed to be a complete tutorial on its own.
1626--
17−-- /(A modest intro goes here, click on 'req' to start making requests.)/
18−--
1927-- === About the library
2028--
21−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP library
22−-- that just works without any fooling around.
23−--
24−-- What does the phrase “easy-to-use” mean? It means that the library is
25−-- designed to be beginner-friendly so it's simple to add to your monad
26−-- stack, intuitive to work with, well-documented, and does not get in your
27−-- way. Doing HTTP requests is a common task and a Haskell library for this
28−-- should be very approachable and clear to beginners, thus certain
29−-- compromises were made. For example, one cannot currently modify
30−-- 'L.ManagerSettings' of the default manager because the library always
31−-- uses the same implicit global manager for simplicity and maximal
32−-- connection sharing. There is a way to use your own manager with different
33−-- settings, but it requires a bit more typing.
34−--
35−-- “Type-safe” means that the library is protective and eliminates certain
36−-- classes of errors. For example, we have correct-by-construction 'Url's,
37−-- it's guaranteed that the user does not send the request body when using
38−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
39−-- is minimized by making the user specify his\/her intentions in an
40−-- explicit form (for example, it's not possible to avoid specifying the
41−-- body or method of a request). Authentication methods that assume HTTPS
42−-- force the user to use HTTPS at the type level. The library also carefully
43−-- hides underlying types from the lower-level @http-client@ package because
44−-- those types are not safe enough (for example 'L.Request' is an instance
45−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
46−-- run-time).
47−--
48−-- “Expandable” refers to the ability of the library to be expanded without
49−-- having to resort to ugly hacking. For example, it's possible to define
50−-- your own HTTP methods, create new ways to construct the body of a
51−-- request, create new authorization options, perform a request in a
52−-- different way, and create your own methods to parse and represent a
53−-- response. As a user extends the library to satisfy his\/her special
54−-- needs, the new solutions will work just like the built-ins. However, all
55−-- of the common cases are also covered by the library out-of-the-box.
56−--
57−-- “High-level” means that there are less details to worry about. The
58−-- library is a result of my experiences as a Haskell consultant. Working
59−-- for several clients, who had very different projects, showed me that the
60−-- library should adapt easily to any particular style of writing Haskell
61−-- applications. For example, some people prefer throwing exceptions, while
62−-- others are concerned with purity. Just define 'handleHttpException'
63−-- accordingly when making your monad instance of 'MonadHttp' and it will
64−-- play together seamlessly. Finally, the library cuts boilerplate down
65−-- considerably, and helps you write concise, easy to read, and maintainable
66−-- code.
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30+-- and expandable.
31+--
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
33+-- so it's simple to add to your monad stack, intuitive to work with,
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
35+-- common task and a Haskell library for this should be approachable and
36+-- clear to beginners, thus certain compromises were made. For example, one
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
39+-- simplicity and maximal connection sharing. There is a way to use your own
40+-- manager with different settings, but it requires more typing.
41+--
42+-- “Type-safe” means that the library tries to eliminate certain classes of
43+-- errors. For example, we have correct-by-construction URLs; it is
44+-- guaranteed that the user does not send the request body when using
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46+-- minimized by making the user specify their intentions in an explicit
47+-- form. For example, it's not possible to avoid specifying the body or the
48+-- method of a request. Authentication methods that assume HTTPS force the
49+-- user to use HTTPS at the type level.
50+--
51+-- “Expandable” refers to the ability to create new components without
52+-- having to resort to hacking. For example, it's possible to define your
53+-- own HTTP methods, create new ways to construct the body of a request,
54+-- create new authorization options, perform a request in a different way,
55+-- and create your own methods to parse a response.
6756--
6857-- === Using with other libraries
6958--
@@ -87,180 +76,207 @@
8776-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
8877-- machinery for performing requests is the same as with @http-conduit@ and
8978-- @wreq@. The only difference is the API.
90−
91−{-# LANGUAGE CPP #-}
92−{-# LANGUAGE DataKinds #-}
93−{-# LANGUAGE DeriveDataTypeable #-}
94−{-# LANGUAGE DeriveGeneric #-}
95−{-# LANGUAGE FlexibleInstances #-}
96−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
97−{-# LANGUAGE KindSignatures #-}
98−{-# LANGUAGE OverloadedStrings #-}
99−{-# LANGUAGE RankNTypes #-}
100−{-# LANGUAGE RecordWildCards #-}
101−{-# LANGUAGE ScopedTypeVariables #-}
102−{-# LANGUAGE TypeFamilies #-}
103−
104−#if MIN_VERSION_base(4,9,0)
105−{-# LANGUAGE UndecidableInstances #-}
106−#endif
107−
108−#if __GLASGOW_HASKELL__ < 710
109−{-# LANGUAGE ConstraintKinds #-}
110−#endif
111−
112−#if __GLASGOW_HASKELL__ >= 800
113−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
114−#endif
115−
11679module Network.HTTP.Req
11780 ( -- * Making a request
11881 -- $making-a-request
119− req
120− , req'
121− , withReqManager
122− -- * Embedding requests into your monad
82+ req,
83+ reqBr,
84+ reqCb,
85+ req',
86+ withReqManager,
87+
88+ -- * Embedding requests in your monad
12389 -- $embedding-requests
124− , MonadHttp (..)
125− , HttpConfig (..)
90+ MonadHttp (..),
91+ HttpConfig (..),
92+ defaultHttpConfig,
93+ Req,
94+ runReq,
95+
12696 -- * Request
97+
12798 -- ** Method
12899 -- $method
129− , GET (..)
130− , POST (..)
131− , HEAD (..)
132− , PUT (..)
133− , DELETE (..)
134− , TRACE (..)
135− , CONNECT (..)
136− , OPTIONS (..)
137− , PATCH (..)
138− , HttpMethod (..)
100+ GET (..),
101+ POST (..),
102+ HEAD (..),
103+ PUT (..),
104+ DELETE (..),
105+ TRACE (..),
106+ CONNECT (..),
107+ OPTIONS (..),
108+ PATCH (..),
109+ HttpMethod (..),
110+
139111 -- ** URL
140112 -- $url
141− , Url
142− , http
143− , https
144− , (/~)
145− , (/:)
146− , parseUrlHttp
147− , parseUrlHttps
113+ Url,
114+ http,
115+ https,
116+ (/~),
117+ (/:),
118+ useHttpURI,
119+ useHttpsURI,
120+ useURI,
121+ urlQ,
122+ renderUrl,
123+
148124 -- ** Body
149125 -- $body
150− , NoReqBody (..)
151− , ReqBodyJson (..)
152− , ReqBodyFile (..)
153− , ReqBodyBs (..)
154− , ReqBodyLbs (..)
155− , ReqBodyUrlEnc (..)
156− , FormUrlEncodedParam
157− , ReqBodyMultipart
158− , reqBodyMultipart
159− , HttpBody (..)
160− , ProvidesBody
161− , HttpBodyAllowed
126+ NoReqBody (..),
127+ ReqBodyJson (..),
128+ ReqBodyFile (..),
129+ ReqBodyBs (..),
130+ ReqBodyLbs (..),
131+ ReqBodyUrlEnc (..),
132+ FormUrlEncodedParam,
133+ ReqBodyMultipart,
134+ reqBodyMultipart,
135+ HttpBody (..),
136+ ProvidesBody,
137+ HttpBodyAllowed,
138+
162139 -- ** Optional parameters
163140 -- $optional-parameters
164− , Option
141+ Option,
142+
165143 -- *** Query parameters
166144 -- $query-parameters
167− , (=:)
168− , queryFlag
169− , QueryParam (..)
145+ (=:),
146+ queryFlag,
147+ formToQuery,
148+ QueryParam (..),
149+
170150 -- *** Headers
171− , header
151+ header,
152+ attachHeader,
153+ headerRedacted,
154+
172155 -- *** Cookies
173156 -- $cookies
174− , cookieJar
157+ cookieJar,
158+
175159 -- *** Authentication
176160 -- $authentication
177− , basicAuth
178− , basicAuthUnsafe
179− , oAuth1
180− , oAuth2Bearer
181− , oAuth2Token
161+ basicAuth,
162+ basicAuthUnsafe,
163+ basicProxyAuth,
164+ oAuth1,
165+ oAuth2Bearer,
166+ oAuth2Token,
167+ customAuth,
168+
182169 -- *** Other
183− , port
184− , decompress
185− , responseTimeout
186− , httpVersion
170+ port,
171+ decompress,
172+ responseTimeout,
173+ httpVersion,
174+
187175 -- * Response
176+
188177 -- ** Response interpretations
189− , IgnoreResponse
190− , ignoreResponse
191− , JsonResponse
192− , jsonResponse
193− , BsResponse
194− , bsResponse
195− , LbsResponse
196− , lbsResponse
178+ IgnoreResponse,
179+ ignoreResponse,
180+ JsonResponse,
181+ jsonResponse,
182+ BsResponse,
183+ bsResponse,
184+ LbsResponse,
185+ lbsResponse,
186+
197187 -- ** Inspecting a response
198− , responseBody
199− , responseStatusCode
200− , responseStatusMessage
201− , responseHeader
202− , responseCookieJar
188+ responseBody,
189+ responseStatusCode,
190+ responseStatusMessage,
191+ responseHeader,
192+ responseCookieJar,
193+
203194 -- ** Defining your own interpretation
204195 -- $new-response-interpretation
205− , HttpResponse (..)
196+ HttpResponse (..),
197+
206198 -- * Other
207− , HttpException (..)
208− , CanHaveBody (..)
209− , Scheme (..) )
199+ HttpException (..),
200+ isStatusCodeException,
201+ CanHaveBody (..),
202+ Scheme (..),
203+ )
210204where
211205
206+import Blaze.ByteString.Builder qualified as BB
212207import Control.Applicative
213208import Control.Arrow (first, second)
214−import Control.Exception (Exception, try, handle, throwIO)
215−import Control.Monad
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
211+import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
216213import 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)
218+import 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
217231import Control.Retry
218−import Data.Aeson (ToJSON (..), FromJSON (..))
232+import Data.Aeson (FromJSON (..), ToJSON (..))
233+import Data.Aeson qualified as A
219234import 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
220238import Data.Data (Data)
221−import Data.Default.Class
239+import Data.Default.Class (def)
222240import Data.Function (on)
223241import Data.IORef
224−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
225244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
226246import Data.Maybe (fromMaybe)
227247import Data.Proxy
228−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
229250import Data.Text (Text)
230−import Data.Typeable (Typeable)
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
253+import Data.Typeable (Typeable, cast)
231254import GHC.Generics
232255import 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
233265import 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
234272import Web.HttpApiData (ToHttpApiData (..))
235−import qualified Blaze.ByteString.Builder as BB
236−import qualified Data.Aeson as A
237−import qualified Data.ByteString as B
238−import qualified Data.ByteString.Lazy as BL
239−import qualified Data.CaseInsensitive as CI
240−import qualified Data.List.NonEmpty as NE
241−import qualified Data.Text as T
242−import qualified Data.Text.Encoding as T
243−import qualified Data.Text.Read as TR
244−import qualified Network.Connection as NC
245−import qualified Network.HTTP.Client as L
246−import qualified Network.HTTP.Client.Internal as LI
247−import qualified Network.HTTP.Client.MultipartFormData as LM
248−import qualified Network.HTTP.Client.TLS as L
249−import qualified Network.HTTP.Types as Y
250−import qualified Web.Authenticate.OAuth as OAuth
251−
252−#if MIN_VERSION_base(4,9,0)
253−import Data.Kind (Constraint)
254−#else
255−import GHC.Exts (Constraint)
256−#endif
257273
258274----------------------------------------------------------------------------
259275-- Making a request
260276
261277-- $making-a-request
262278--
263−-- To make an HTTP request you need only one function: 'req'.
279+-- To make an HTTP request you normally need only one function: 'req'.
264280
265281-- | Make an HTTP request. The function takes 5 arguments, 4 of which
266282-- specify required parameters and the final 'Option' argument is a
@@ -277,7 +293,7 @@ import GHC.Exts (Constraint)
277293--
278294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
279295-- tutorial has a section about HTTP bodies, but usage is very
280−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
281297--
282298-- @response@ is a type hint how to make and interpret response of an HTTP
283299-- request. Out-of-the-box it can be the following:
@@ -303,12 +319,13 @@ import GHC.Exts (Constraint)
303319-- First, this is a piece of boilerplate that should be in place before you
304320-- try the examples:
305321--
322+-- > {-# LANGUAGE DeriveGeneric #-}
306323-- > {-# LANGUAGE OverloadedStrings #-}
307324-- >
308325-- > module Main (main) where
309326-- >
310−-- > import Control.Exception (throwIO)
311327-- > import Control.Monad
328+-- > import Control.Monad.IO.Class
312329-- > import Data.Aeson
313330-- > import Data.Maybe (fromJust)
314331-- > import Data.Monoid ((<>))
@@ -316,32 +333,30 @@ import GHC.Exts (Constraint)
316333-- > import GHC.Generics
317334-- > import Network.HTTP.Req
318335-- > import qualified Data.ByteString.Char8 as B
319−-- >
320−-- > instance MonadHttp IO where
321−-- > handleHttpException = throwIO
336+-- > import qualified Text.URI as URI
322337--
323338-- We will be making requests against the <https://httpbin.org> service.
324339--
325340-- Make a GET request, grab 5 random bytes:
326341--
327342-- > main :: IO ()
328−-- > main = do
343+-- > main = runReq defaultHttpConfig $ do
329344-- > let n :: Int
330345-- > n = 5
331346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
332−-- > B.putStrLn (responseBody bs)
347+-- > liftIO $ B.putStrLn (responseBody bs)
333348--
334349-- The same, but now we use a query parameter named @\"seed\"@ to control
335350-- seed of the generator:
336351--
337352-- > main :: IO ()
338−-- > main = do
353+-- > main = runReq defaultHttpConfig $ do
339354-- > let n, seed :: Int
340355-- > n = 5
341356-- > seed = 100
342357-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
343358-- > "seed" =: seed
344−-- > B.putStrLn (responseBody bs)
359+-- > liftIO $ B.putStrLn (responseBody bs)
345360--
346361-- POST JSON data and get some info about the POST request:
347362--
@@ -354,108 +369,231 @@ import GHC.Exts (Constraint)
354369-- > instance FromJSON MyData
355370-- >
356371-- > main :: IO ()
357−-- > main = do
372+-- > main = runReq defaultHttpConfig $ do
358373-- > let myData = MyData
359374-- > { size = 6
360375-- > , color = "Green" }
361376-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
362−-- > print (responseBody v :: Value)
377+-- > liftIO $ print (responseBody v :: Value)
363378--
364379-- Sending URL-encoded body:
365380--
366381-- > main :: IO ()
367−-- > main = do
382+-- > main = runReq defaultHttpConfig $ do
368383-- > let params =
369384-- > "foo" =: ("bar" :: Text) <>
370385-- > queryFlag "baz"
371386-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
372−-- > print (responseBody response :: Value)
387+-- > liftIO $ print (responseBody response :: Value)
373388--
374389-- Using various optional parameters and URL that is not known in advance:
375390--
376391-- > main :: IO ()
377−-- > main = do
392+-- > main = runReq defaultHttpConfig $ do
378393-- > -- This is an example of what to do when URL is given dynamically. Of
379394-- > -- course in a real application you may not want to use 'fromJust'.
380−-- > let (url, options) = fromJust (parseUrlHttps "https://httpbin.org/get?foo=bar")
395+-- > uri <- URI.mkURI "https://httpbin.org/get?foo=bar"
396+-- > let (url, options) = fromJust (useHttpsURI uri)
381397-- > response <- req GET url NoReqBody jsonResponse $
382398-- > "from" =: (15 :: Int) <>
383399-- > "to" =: (67 :: Int) <>
384400-- > basicAuth "username" "password" <>
385401-- > options <> -- contains the ?foo=bar part
386402-- > port 443 -- here you can put any port of course
387−-- > print (responseBody response :: Value)
388−
389−req
390− :: ( MonadHttp m
391− , HttpMethod method
392− , HttpBody body
393− , HttpResponse response
394− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
395− => method -- ^ HTTP method
396− -> Url scheme -- ^ 'Url'—location of resource
397− -> body -- ^ Body of the request
398− -> Proxy response -- ^ A hint how to interpret response
399− -> Option scheme -- ^ Collection of optional parameters
400− -> m response -- ^ Response
401−req method url body Proxy options = req' method url body options $ \request manager -> do
402− HttpConfig {..} <- getHttpConfig
403− let wrappingVanilla = handle (throwIO . VanillaHttpException)
404− wrapExc = handle (throwIO . LI.toHttpException request)
405− (liftIO . try . wrappingVanilla . wrapExc) (do
406− response <- retrying httpConfigRetryPolicy httpConfigRetryJudge
407− (const $ getHttpResponse request manager)
408− httpConfigCheckResponse request response
409− return response)
403+-- > liftIO $ print (responseBody response :: Value)
404+req ::
405+ ( MonadHttp m,
406+ HttpMethod method,
407+ HttpBody body,
408+ HttpResponse response,
409+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
410+ ) =>
411+ -- | HTTP method
412+ method ->
413+ -- | 'Url'—location of resource
414+ Url scheme ->
415+ -- | Body of the request
416+ body ->
417+ -- | A hint how to interpret response
418+ Proxy response ->
419+ -- | Collection of optional parameters
420+ Option scheme ->
421+ -- | Response
422+ m response
423+req method url body responseProxy options =
424+ reqCb method url body responseProxy options pure
425+
426+-- | A version of 'req' that does not use one of the predefined instances of
427+-- 'HttpResponse' but instead allows the user to consume @'L.Response'
428+-- 'L.BodyReader'@ manually, in a custom way.
429+--
430+-- @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
502+ 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+ )
410536 >>= either handleHttpException return
411537
412538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
413539-- that allows to perform a request in arbitrary fashion.
414540--
415541-- This function /does not/ perform handling\/wrapping exceptions, checking
416−-- response, and retrying. It only prepares 'L.Request' and allows you to
417−-- use it.
542+-- response (with 'httpConfigCheckResponse'), and retrying. It only prepares
543+-- 'L.Request' and allows you to use it.
418544--
419545-- @since 0.3.0
420−
421−req'
422− :: forall m method body scheme a.
423− ( MonadHttp m
424− , HttpMethod method
425− , HttpBody body
426− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
427− => method -- ^ HTTP method
428− -> Url scheme -- ^ 'Url'—location of resource
429− -> body -- ^ Body of the request
430− -> Option scheme -- ^ Collection of optional parameters
431− -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
432− -> m a
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
433565req' method url body options m = do
434− config@HttpConfig {..} <- getHttpConfig
435− manager <- liftIO (readIORef globalManager)
566+ config <- getHttpConfig
436567 let -- NOTE First appearance of any given header wins. This allows to
437568 -- “overwrite” headers when we construct a request by cons-ing.
438569 nubHeaders = Endo $ \x ->
439− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
440− request' = flip appEndo L.defaultRequest $
441− -- NOTE The order of 'mappend's matters, here method is overwritten
442− -- first and 'options' take effect last. In particular, this means
443− -- that 'options' can overwrite things set by other request
444− -- components, which is useful for setting port number,
445− -- "Content-Type" header, etc.
446− nubHeaders <>
447− getRequestMod options <>
448− getRequestMod config <>
449− getRequestMod (Womb body :: Womb "body" body) <>
450− getRequestMod url <>
451− getRequestMod (Womb method :: Womb "method" method)
570+ x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
571+ request' =
572+ flip appEndo L.defaultRequest $
573+ -- NOTE The order of 'mappend's matters, here method is overwritten
574+ -- first and 'options' take effect last. In particular, this means
575+ -- that 'options' can overwrite things set by other request
576+ -- components, which is useful for setting port number,
577+ -- "Content-Type" header, etc.
578+ nubHeaders
579+ <> getRequestMod options
580+ <> getRequestMod config
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
582+ <> getRequestMod url
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
452584 request <- finalizeRequest options request'
453− m request manager
585+ withReqManager (m request)
586+
587+-- | 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
589+-- 'L.Manager' controls.
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
454592
455−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
456−-- settings, so users don't need to deal with this manager stuff at all, but
457−-- when we create a request, instance 'HttpConfig' can affect the default
458−-- settings via 'getHttpConfig'.
593+-- | The global 'L.Manager' that 'req' uses. Here we just go with the
594+-- default settings, so users don't need to deal with this manager stuff at
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
596+-- default settings via 'getHttpConfig'.
459597--
460598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
461599-- The value of 'globalManager' is named and lives on top level. This means
@@ -463,24 +601,20 @@ req' method url body options m = do
463601-- manager. From that moment on the 'IORef' will be just reused—exactly the
464602-- behavior we want here in order to maximize connection sharing. GHC could
465603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
466−
467−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
468605globalManager = unsafePerformIO $ do
469606 context <- NC.initConnectionContext
470− let settings = L.mkManagerSettingsContext (Just context) def Nothing
607+ let settings =
608+ L.mkManagerSettingsContext
609+ (Just context)
610+ def
611+ Nothing
471612 manager <- L.newManager settings
472− newIORef manager
613+ return manager
473614{-# NOINLINE globalManager #-}
474615
475−-- | Perform an action using global implicit 'L.Manager' that the rest of
476−-- the library uses. This allows to reuse connections that the 'L.Manager'
477−-- controls.
478−
479−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
480−withReqManager m = liftIO (readIORef globalManager) >>= m
481−
482616----------------------------------------------------------------------------
483−-- Embedding requests into your monad
617+-- Embedding requests in your monad
484618
485619-- $embedding-requests
486620--
@@ -489,98 +623,267 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
489623--
490624-- When writing a library, keep your API polymorphic in terms of
491625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
492−-- Another option is to use @newtype@ wrapped monad stack and define
493−-- 'MonadHttp' for it.
626+-- Another option is to use a @newtype@-wrapped monad stack and define
627+-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
628+-- follows this strategy is provided out-of-the-box (see below).
494629
495630-- | A type class for monads that support performing HTTP requests.
496631-- Typically, you only need to define the 'handleHttpException' method
497632-- unless you want to tweak 'HttpConfig'.
498−
499−class MonadIO m => MonadHttp m where
500−
633+class (MonadIO m) => MonadHttp m where
501634 -- | This method describes how to deal with 'HttpException' that was
502635 -- caught by the library. One option is to re-throw it if you are OK with
503636 -- exceptions, but if you prefer working with something like
504637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
505638 -- 'Control.Monad.Except.throwError'.
506−
507639 handleHttpException :: HttpException -> m a
508640
509− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
510− -- implementation returns its 'def' value, which is described in the
511− -- documentation for the type. Common usage pattern with manually defined
512− -- 'getHttpConfig' is to return some hard-coded value, or value extracted
513− -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
514− -- configuration is desirable.
515−
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
645+ -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
646+ -- approach to configuration is desirable.
516647 getHttpConfig :: m HttpConfig
517− getHttpConfig = return def
518−
519−-- | 'HttpConfig' contains general and default settings to be used when
520−-- making HTTP requests.
648+ getHttpConfig = return defaultHttpConfig
521649
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
522651data HttpConfig = HttpConfig
523− { httpConfigProxy :: Maybe L.Proxy
524− -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
652+ { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
525653 -- environment variables are respected, this setting overwrites them.
526654 -- Default value: 'Nothing'.
527− , httpConfigRedirectCount :: Int
528− -- ^ How many redirects to follow when getting a resource. Default
655+ httpConfigProxy :: Maybe L.Proxy,
656+ -- | How many redirects to follow when getting a resource. Default
529657 -- value: 10.
530− , httpConfigAltManager :: Maybe L.Manager
531− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
532− -- that default implicit manager will be used (that's what you want in
533− -- 99% of cases).
534− , httpConfigCheckResponse :: forall r. HttpResponse r => L.Request -> r -> IO ()
535− -- ^ Function to check the response immediately after receiving the
536− -- status and headers. This is used for throwing exceptions on
537− -- non-success status codes by default (set to @\\_ _ -> return ()@ if
538− -- this behavior is not desirable). Throwing is better then just
539− -- returning a request with non-2xx status code because in that case
540− -- something is wrong and we need a way to short-cut execution. The
541− -- thrown exception is caught by the library though and is available in
542− -- 'handleHttpException'.
658+ httpConfigRedirectCount :: Int,
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
660+ -- that the default implicit manager will be used (that's what you want
661+ -- in 99% of cases).
662+ httpConfigAltManager :: Maybe L.Manager,
663+ -- | Function to check the response immediately after receiving the
664+ -- status and headers, before streaming of response body. The third
665+ -- argument is the beginning of response body (typically first 1024
666+ -- bytes). This is used for throwing exceptions on non-success status
667+ -- codes by default (set to @\\_ _ _ -> Nothing@ if this behavior is not
668+ -- desirable).
669+ --
670+ -- When the value this function returns is 'Nothing', nothing will
671+ -- happen. When it there is 'L.HttpExceptionContent' inside 'Just', it
672+ -- will be thrown.
673+ --
674+ -- Throwing is better then just returning a request with non-2xx status
675+ -- code because in that case something is wrong and we need a way to
676+ -- short-cut execution (also remember that Req retries automatically on
677+ -- request timeouts and such, so when your request fails, it's certainly
678+ -- something exceptional). The thrown exception is caught by the library
679+ -- though and is available in 'handleHttpException'.
680+ --
681+ -- __Note__: signature of this function was changed in the version
682+ -- /1.0.0/.
543683 --
544684 -- @since 0.3.0
545− , httpConfigRetryPolicy :: RetryPolicyM IO
546− -- ^ The retry policy to use for request retrying. By default 'def' is
685+ httpConfigCheckResponse ::
686+ forall b.
687+ L.Request ->
688+ L.Response b ->
689+ ByteString ->
690+ Maybe L.HttpExceptionContent,
691+ -- | The retry policy to use for request retrying. By default 'def' is
547692 -- used (see 'RetryPolicyM').
548693 --
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/.
696+ --
549697 -- @since 0.3.0
550− , httpConfigRetryJudge :: forall r. HttpResponse r => RetryStatus -> r -> IO Bool
551− -- ^ The function is used to decide whether to retry a request. 'True'
698+ httpConfigRetryPolicy :: RetryPolicyM IO,
699+ -- | The function is used to decide whether to retry a request. 'True'
552700 -- means that the request should be retried.
553701 --
702+ -- __Note__: signature of this function was changed in the version
703+ -- /1.0.0/.
704+ --
554705 -- @since 0.3.0
555− } deriving Typeable
556−
557−instance Default HttpConfig where
558− def = HttpConfig
559− { httpConfigProxy = Nothing
560− , httpConfigRedirectCount = 10
561− , httpConfigAltManager = Nothing
562− , httpConfigCheckResponse = \_ response ->
563− let statusCode = responseStatusCode response in
564− unless (200 <= statusCode && statusCode < 300) $ do
565− chunk <- makeResponseBodyPreview response
566− let vresponse = toVanillaResponse response
567− LI.throwHttp (L.StatusCodeException (void vresponse) chunk)
568− , httpConfigRetryPolicy = def
569− , httpConfigRetryJudge = \_ r -> return $
570− responseStatusCode r `elem`
571− [ 408 -- Request timeout
572− , 504 -- Gateway timeout
573− , 524 -- A timeout occurred
574− , 598 -- (Informal convention) Network read timeout error
575− , 599 -- (Informal convention) Network connect timeout error
576− ]
706+ httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
707+ -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
708+ -- retry requests that resulted in an exception. By default it retries
709+ -- on response timeout and connection timeout (changed in version
710+ -- /3.8.0/).
711+ --
712+ -- @since 3.4.0
713+ httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714+ -- | Max length of preview fragment of response body.
715+ --
716+ -- @since 3.6.0
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
718+ }
719+
720+-- | The default value of 'HttpConfig'.
721+--
722+-- @since 2.0.0
723+defaultHttpConfig :: HttpConfig
724+defaultHttpConfig =
725+ HttpConfig
726+ { httpConfigProxy = Nothing,
727+ httpConfigRedirectCount = 10,
728+ httpConfigAltManager = Nothing,
729+ httpConfigCheckResponse = \_ response preview ->
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
577752 }
753+ where
754+ statusCode = Y.statusCode . L.responseStatus
578755
579756instance RequestComponent HttpConfig where
580757 getRequestMod HttpConfig {..} = Endo $ \x ->
581− x { L.proxy = httpConfigProxy
582− , L.redirectCount = httpConfigRedirectCount
583− , LI.requestManagerOverride = httpConfigAltManager }
758+ x
759+ { L.proxy = httpConfigProxy,
760+ L.redirectCount = httpConfigRedirectCount,
761+ LI.requestManagerOverride = httpConfigAltManager
762+ }
763+
764+-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
765+-- having to define new instances.
766+--
767+-- @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
782+
783+-- | @since 3.7.0
784+deriving instance MonadMask Req
785+
786+instance MonadBase IO Req where
787+ liftBase = liftIO
788+
789+instance MonadBaseControl IO Req where
790+ type StM Req a = a
791+ liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
792+ {-# INLINEABLE liftBaseWith #-}
793+ restoreM = Req . ReaderT . const . return
794+ {-# INLINEABLE restoreM #-}
795+
796+instance MonadHttp Req where
797+ 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
874+
875+-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
877+--
878+-- @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
886+runReq config (Req m) = liftIO (runReaderT m config)
584887
585888----------------------------------------------------------------------------
586889-- Request—Method
@@ -595,7 +898,6 @@ instance RequestComponent HttpConfig where
595898-- define a new method that will works seamlessly, see 'HttpMethod'.
596899
597900-- | 'GET' method.
598−
599901data GET = GET
600902
601903instance HttpMethod GET where
@@ -603,7 +905,6 @@ instance HttpMethod GET where
603905 httpMethodName Proxy = Y.methodGet
604906
605907-- | 'POST' method.
606−
607908data POST = POST
608909
609910instance HttpMethod POST where
@@ -611,7 +912,6 @@ instance HttpMethod POST where
611912 httpMethodName Proxy = Y.methodPost
612913
613914-- | 'HEAD' method.
614−
615915data HEAD = HEAD
616916
617917instance HttpMethod HEAD where
@@ -619,26 +919,24 @@ instance HttpMethod HEAD where
619919 httpMethodName Proxy = Y.methodHead
620920
621921-- | 'PUT' method.
622−
623922data PUT = PUT
624923
625924instance HttpMethod PUT where
626925 type AllowsBody PUT = 'CanHaveBody
627926 httpMethodName Proxy = Y.methodPut
628927
629−-- | 'DELETE' method. This data type does not allow having request body with
630−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
631−-- requests to have bodies, in that case define your own variation of
632−-- 'DELETE' method and allow it to have a body.
633−
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.
634933data DELETE = DELETE
635934
636935instance HttpMethod DELETE where
637− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
638937 httpMethodName Proxy = Y.methodDelete
639938
640939-- | 'TRACE' method.
641−
642940data TRACE = TRACE
643941
644942instance HttpMethod TRACE where
@@ -646,7 +944,6 @@ instance HttpMethod TRACE where
646944 httpMethodName Proxy = Y.methodTrace
647945
648946-- | 'CONNECT' method.
649−
650947data CONNECT = CONNECT
651948
652949instance HttpMethod CONNECT where
@@ -654,7 +951,6 @@ instance HttpMethod CONNECT where
654951 httpMethodName Proxy = Y.methodConnect
655952
656953-- | 'OPTIONS' method.
657−
658954data OPTIONS = OPTIONS
659955
660956instance HttpMethod OPTIONS where
@@ -662,7 +958,6 @@ instance HttpMethod OPTIONS where
662958 httpMethodName Proxy = Y.methodOptions
663959
664960-- | 'PATCH' method.
665−
666961data PATCH = PATCH
667962
668963instance HttpMethod PATCH where
@@ -670,30 +965,26 @@ instance HttpMethod PATCH where
670965 httpMethodName Proxy = Y.methodPatch
671966
672967-- | A type class for types that can be used as an HTTP method. To define a
673−-- non-standard method, follow this example that defines COPY:
968+-- non-standard method, follow this example that defines @COPY@:
674969--
675970-- > data COPY = COPY
676971-- >
677972-- > instance HttpMethod COPY where
678973-- > type AllowsBody COPY = 'CanHaveBody
679974-- > httpMethodName Proxy = "COPY"
680−
681975class HttpMethod a where
682−
683976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
684− -- tells the rest of the library whether the method can have a body or
685− -- not. We use the special type 'CanHaveBody' “lifted” to kind level
686− -- instead of 'Bool' to get more user-friendly compiler messages.
687−
977+ -- tells the rest of the library whether the method can have body or not.
978+ -- We use the special type 'CanHaveBody' lifted to the kind level instead
979+ -- of 'Bool' to get more user-friendly compiler messages.
688980 type AllowsBody a :: CanHaveBody
689981
690982 -- | Return name of the method as a 'ByteString'.
691−
692983 httpMethodName :: Proxy a -> ByteString
693984
694−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
695986 getRequestMod _ = Endo $ \x ->
696− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
697988
698989----------------------------------------------------------------------------
699990-- Request—URL
@@ -701,7 +992,7 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
701992-- $url
702993--
703994-- We use 'Url's which are correct by construction, see 'Url'. To build a
704−-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
705996
706997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
707998-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -731,91 +1022,194 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
7311022--
7321023-- > https "юникод.рф"
7331024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
734−
7351025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
7361026 -- NOTE The second value is the path segments in reversed order.
737− deriving (Eq, Ord, Show, Data, Typeable, Generic)
738−
739−-- | Given host name, produce a 'Url' which have “http” as its scheme and
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
1041+
1042+-- | Given host name, produce a 'Url' which has “http” as its scheme and
7401043-- empty path. This also sets port to @80@.
741−
7421044http :: Text -> Url 'Http
7431045http = Url Http . pure
7441046
745−-- | Given host name, produce a 'Url' which have “https” as its scheme and
1047+-- | Given host name, produce a 'Url' which has “https” as its scheme and
7461048-- empty path. This also sets port to @443@.
747−
7481049https :: Text -> Url 'Https
7491050https = Url Https . pure
7501051
751−-- | Grow given 'Url' appending a single path segment to it. Note that the
1052+-- | Grow a given 'Url' appending a single path segment to it. Note that the
7521053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
753−
7541054infixl 5 /~
755−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
756−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
7571055
758−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
759−-- when next URL piece is a 'Text' literal.
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
1057+Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
7601058
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
7611061infixl 5 /:
1062+
7621063(/:) :: Url scheme -> Text -> Url scheme
7631064(/:) = (/~)
7641065
765−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
766−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
767−-- you are given a URL to query dynamically and don't know it beforehand.
768−-- The function parses 'ByteString' because it's the correct type to
769−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
770−-- range, thus we can consider every character a 'Data.Word.Word8' value.
771−--
772−-- This function only parses 'Url' (scheme, host, path) and optional query
773−-- parameters that are returned as 'Option'. It does not parse method name
774−-- or authentication info from given 'ByteString'.
775−
776−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
777−parseUrlHttp url' = do
778− url <- B.stripPrefix "http://" url'
779− (host :| path, option) <- parseUrlHelper url
780− return (foldl (/:) (http host) path, option)
781−
782−-- | Just like 'parseUrlHttp', but expects “https” scheme.
783−
784−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
785−parseUrlHttps url' = do
786− url <- B.stripPrefix "https://" url'
787− (host :| path, option) <- parseUrlHelper url
788− return (foldl (/:) (https host) path, option)
789−
790−-- | Get host\/collection of path pieces and possibly query parameters
791−-- already converted to 'Option'. This function is not public.
792−
793−parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
794−parseUrlHelper url = do
795− let (path', query') = B.break (== 0x3f) url
796− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
797− p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
798− (p, port') <-
799− case T.break (== ':') p' of
800− (x, "") -> return (x, mempty)
801− (x, prt) ->
802− case TR.decimal (T.drop 1 prt) of
803− Right (prt',"") -> return (x, port prt')
804− _ -> Nothing
805− return (p :| ps, query <> port')
1066+-- | Render a 'Url' as 'Text'.
1067+--
1068+-- @since 3.4.0
1069+renderUrl :: Url scheme -> Text
1070+renderUrl = \case
1071+ Url Https parts ->
1072+ "https://" <> renderParts parts
1073+ Url Http parts ->
1074+ "http://" <> renderParts parts
1075+ where
1076+ renderParts parts =
1077+ T.intercalate "/" (reverse $ NE.toList parts)
1078+
1079+-- | The 'useHttpURI' function provides an alternative method to get 'Url'
1080+-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
1081+-- given a URL to query dynamically and don't know it beforehand.
1082+--
1083+-- This function expects the scheme to be “http” and host to be present.
1084+--
1085+-- @since 3.0.0
1086+useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
1087+useHttpURI uri = do
1088+ guard (URI.uriScheme uri == Just [QQ.scheme|http|])
1089+ urlHead <- http <$> uriHost uri
1090+ let url = case URI.uriPath uri of
1091+ Nothing -> urlHead
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
1093+ return (url, uriOptions uri)
1094+
1095+-- | Just like 'useHttpURI', but expects the “https” scheme.
1096+--
1097+-- @since 3.0.0
1098+useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
1099+useHttpsURI uri = do
1100+ guard (URI.uriScheme uri == Just [QQ.scheme|https|])
1101+ urlHead <- https <$> uriHost uri
1102+ let url = case URI.uriPath uri of
1103+ Nothing -> urlHead
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
1105+ return (url, uriOptions uri)
1106+
1107+-- | Convert URI path to a 'Url'. Internal.
1108+--
1109+-- @since 3.9.0
1110+uriPathToUrl ::
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
1112+ Url scheme ->
1113+ Url scheme
1114+uriPathToUrl (trailingSlash, xs) urlHead =
1115+ if trailingSlash then path /: T.empty else path
1116+ where
1117+ path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1118+
1119+-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
1120+-- is not known in advance.
1121+--
1122+-- @since 3.0.0
1123+useURI ::
1124+ URI ->
1125+ Maybe
1126+ ( Either
1127+ (Url 'Http, Option scheme0)
1128+ (Url 'Https, Option scheme1)
1129+ )
1130+useURI uri =
1131+ (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
1132+
1133+-- | An internal helper function to extract host from a 'URI'.
1134+uriHost :: URI -> Maybe Text
1135+uriHost uri = case URI.uriAuthority uri of
1136+ Left _ -> Nothing
1137+ Right URI.Authority {..} ->
1138+ Just (URI.unRText authHost)
1139+
1140+-- | A quasiquoter to build an 'Url' and 'Option' tuple. The type of the
1141+-- generated expression is @('Url' scheme0, 'Option' scheme1)@ with
1142+-- @scheme0@ being either 'Http' or 'Https' depending on the input.
1143+--
1144+-- @since 3.2.0
1145+urlQ :: TH.QuasiQuoter
1146+urlQ =
1147+ TH.QuasiQuoter
1148+ { quoteExp = \str ->
1149+ case URI.mkURI (T.pack str) of
1150+ Left err -> fail (displayException err)
1151+ Right uri -> case useURI uri of
1152+ Nothing -> fail "Not a HTTP or HTTPS URL"
1153+ Just eurl ->
1154+ TH.tupE
1155+ [ either (TH.lift . fst) (TH.lift . fst) eurl,
1156+ [|uriOptions uri|]
1157+ ],
1158+ quotePat = error "This usage is not supported",
1159+ quoteType = error "This usage is not supported",
1160+ quoteDec = error "This usage is not supported"
1161+ }
1162+
1163+-- | An internal helper function to extract 'Option's from a 'URI'.
1164+uriOptions :: forall scheme. URI -> Option scheme
1165+uriOptions uri =
1166+ mconcat
1167+ [ auth,
1168+ query,
1169+ port'
1170+ -- , fragment'
1171+ ]
1172+ where
1173+ (auth, port') =
1174+ case URI.uriAuthority uri of
1175+ Left _ -> (mempty, mempty)
1176+ Right URI.Authority {..} ->
1177+ let auth0 = case authUserInfo of
1178+ Nothing -> mempty
1179+ Just URI.UserInfo {..} ->
1180+ let username = T.encodeUtf8 (URI.unRText uiUsername)
1181+ password = maybe "" (T.encodeUtf8 . URI.unRText) uiPassword
1182+ in basicAuthUnsafe username password
1183+ port0 = case authPort of
1184+ Nothing -> mempty
1185+ Just port'' -> port (fromIntegral port'')
1186+ in (auth0, port0)
1187+ query =
1188+ let liftQueryParam = \case
1189+ URI.QueryFlag t -> queryFlag (URI.unRText t)
1190+ URI.QueryParam k v -> URI.unRText k =: URI.unRText v
1191+ in mconcat (liftQueryParam <$> URI.uriQuery uri)
1192+
1193+-- TODO Blocked on upstream: https://github.com/snoyberg/http-client/issues/424
1194+-- fragment' =
1195+-- case URI.uriFragment uri of
1196+-- Nothing -> mempty
1197+-- Just fragment'' -> fragment (URI.unRText fragment'')
8061198
8071199instance RequestComponent (Url scheme) where
8081200 getRequestMod (Url scheme segments) = Endo $ \x ->
809− let (host :| path) = NE.reverse segments in
810− x { L.secure = case scheme of
811− Http -> False
812− Https -> True
813− , L.port = case scheme of
814− Http -> 80
815− Https -> 443
816− , L.host = Y.urlEncode False (T.encodeUtf8 host)
817− , L.path =
818− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1201+ let (host :| path) = NE.reverse segments
1202+ in x
1203+ { L.secure = case scheme of
1204+ Http -> False
1205+ Https -> True,
1206+ L.port = case scheme of
1207+ Http -> 80
1208+ Https -> 443,
1209+ L.host = Y.urlEncode False (T.encodeUtf8 host),
1210+ L.path =
1211+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
1212+ }
8191213
8201214----------------------------------------------------------------------------
8211215-- Request—Body
@@ -824,39 +1218,37 @@ instance RequestComponent (Url scheme) where
8241218--
8251219-- A number of options for request bodies are available. The @Content-Type@
8261220-- header is set for you automatically according to the body option you use
827−-- (it's always specified in documentation for a given body option). To add
828−-- your own way to represent request body, see 'HttpBody'.
1221+-- (it's always specified in the documentation for a given body option). To
1222+-- add your own way to represent request body, define an instance of
1223+-- 'HttpBody'.
8291224
8301225-- | This data type represents empty body of an HTTP request. This is the
8311226-- data type to use with 'HttpMethod's that cannot have a body, as it's the
8321227-- only type for which 'ProvidesBody' returns 'NoBody'.
8331228--
8341229-- Using of this body option does not set the @Content-Type@ header.
835−
8361230data NoReqBody = NoReqBody
8371231
8381232instance HttpBody NoReqBody where
8391233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
8401234
841−-- | This body option allows to use a JSON object as request body—probably
842−-- the most popular format right now. Just wrap a data type that is an
843−-- instance of 'ToJSON' type class and you are done: it will be converted to
844−-- JSON and inserted as request body.
1235+-- | This body option allows us to use a JSON object as the request
1236+-- body—probably the most popular format right now. Just wrap a data type
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
1238+-- converted to JSON and inserted as request body.
8451239--
8461240-- This body option sets the @Content-Type@ header to @\"application/json;
8471241-- charset=utf-8\"@ value.
848−
8491242newtype ReqBodyJson a = ReqBodyJson a
8501243
851−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
8521245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
8531246 getRequestContentType _ = pure "application/json; charset=utf-8"
8541247
8551248-- | This body option streams request body from a file. It is expected that
856−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
8571250--
8581251-- Using of this body option does not set the @Content-Type@ header.
859−
8601252newtype ReqBodyFile = ReqBodyFile FilePath
8611253
8621254instance HttpBody ReqBodyFile where
@@ -866,7 +1258,6 @@ instance HttpBody ReqBodyFile where
8661258-- | HTTP request body represented by a strict 'ByteString'.
8671259--
8681260-- Using of this body option does not set the @Content-Type@ header.
869−
8701261newtype ReqBodyBs = ReqBodyBs ByteString
8711262
8721263instance HttpBody ReqBodyBs where
@@ -875,22 +1266,19 @@ instance HttpBody ReqBodyBs where
8751266-- | HTTP request body represented by a lazy 'BL.ByteString'.
8761267--
8771268-- Using of this body option does not set the @Content-Type@ header.
878−
8791269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
8801270
8811271instance HttpBody ReqBodyLbs where
8821272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
8831273
884−-- | Form URL-encoded body. This can hold a collection of parameters which
885−-- are encoded similarly to query parameters at the end of query string,
886−-- with the only difference that they are stored in request body. The
887−-- similarity is reflected in the API as well, as you can use the same
888−-- combinators you would use to add query parameters: @('=:')@ and
889−-- 'queryFlag'.
1274+-- | URL-encoded body. This can hold a collection of parameters which are
1275+-- encoded similarly to query parameters at the end of query string, with
1276+-- the only difference that they are stored in request body. The similarity
1277+-- is reflected in the API as well, as you can use the same combinators you
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
8901279--
8911280-- This body option sets the @Content-Type@ header to
892−-- @\"application/x-www-from-urlencoded\"@ value.
893−
1281+-- @\"application/x-www-form-urlencoded\"@ value.
8941282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
8951283
8961284instance HttpBody ReqBodyUrlEnc where
@@ -900,33 +1288,37 @@ instance HttpBody ReqBodyUrlEnc where
9001288
9011289-- | An opaque monoidal value that allows to collect URL-encoded parameters
9021290-- to be wrapped in 'ReqBodyUrlEnc'.
903−
9041291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
9051292 deriving (Semigroup, Monoid)
9061293
9071294instance QueryParam FormUrlEncodedParam where
9081295 queryParam name mvalue =
9091296 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
9101304
9111305-- | Multipart form data. Please consult the
9121306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
9131307-- parts, then use 'reqBodyMultipart' to create actual request body from the
914−-- parts. 'reqBodyMultipart' is the only way to get a value of type
1308+-- parts. 'reqBodyMultipart' is the only way to get a value of the type
9151309-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
9161310--
9171311-- @since 0.2.0
9181312--
919−-- ==== __Example__
1313+-- ==== __Examples__
9201314--
921−-- > import Control.Exception (throwIO)
922−-- > import qualified Network.HTTP.Client.MultipartFormData as LM
1315+-- > import Control.Monad.IO.Class
1316+-- > import Data.Default.Class
9231317-- > import Network.HTTP.Req
924−-- >
925−-- > instance MonadHttp IO where
926−-- > handleHttpException = throwIO
1318+-- > import qualified Network.HTTP.Client.MultipartFormData as LM
9271319-- >
9281320-- > main :: IO ()
929−-- > main = do
1321+-- > main = runReq def $ do
9301322-- > body <-
9311323-- > reqBodyMultipart
9321324-- > [ LM.partBS "title" "My Image"
@@ -937,8 +1329,7 @@ instance QueryParam FormUrlEncodedParam where
9371329-- > body
9381330-- > bsResponse
9391331-- > mempty
940−-- > print $ responseBody response
941−
1332+-- > liftIO $ print (responseBody response)
9421333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
9431334
9441335instance HttpBody ReqBodyMultipart where
@@ -949,126 +1340,117 @@ instance HttpBody ReqBodyMultipart where
9491340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
9501341--
9511342-- @since 0.2.0
952−
953−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
9541344reqBodyMultipart parts = liftIO $ do
9551345 boundary <- LM.webkitBoundary
956− body <- LM.renderParts boundary parts
1346+ body <- LM.renderParts boundary parts
9571347 return (ReqBodyMultipart boundary body)
9581348
9591349-- | A type class for things that can be interpreted as an HTTP
9601350-- 'L.RequestBody'.
961−
9621351class HttpBody body where
963−
964− {-# MINIMAL getRequestBody #-}
965−
9661352 -- | How to get actual 'L.RequestBody'.
967−
9681353 getRequestBody :: body -> L.RequestBody
9691354
970− -- | This method allows to optionally specify value of @Content-Type@
971− -- header that should be used with particular body option. By default it
972− -- returns 'Nothing' and so @Content-Type@ is not set.
973−
1355+ -- | This method allows us to optionally specify the value of
1356+ -- @Content-Type@ header that should be used with particular body option.
1357+ -- By default it returns 'Nothing' and so @Content-Type@ is not set.
9741358 getRequestContentType :: body -> Maybe ByteString
9751359 getRequestContentType = const Nothing
9761360
9771361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
978−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
979−-- 'GET' method and other methods that should not send a body.
980−
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1363+-- with 'GET' method and other methods that should not have body.
9811364type family ProvidesBody body :: CanHaveBody where
9821365 ProvidesBody NoReqBody = 'NoBody
983− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
9841367
9851368-- | This type function allows any HTTP body if method says it
9861369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
9871370-- body option to use is 'NoReqBody'.
988−--
989−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
990−-- error message when method does not allow a body and body is provided.
991−
992−type family HttpBodyAllowed
993− (allowsBody :: CanHaveBody)
994− (providesBody :: CanHaveBody) :: Constraint where
995− HttpBodyAllowed 'NoBody 'NoBody = ()
996− HttpBodyAllowed 'CanHaveBody body = ()
997−#if MIN_VERSION_base(4,9,0)
998− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
999− ('Text "This HTTP method does not allow attaching a request body.")
1000−#endif
1001−
1002−instance HttpBody body => RequestComponent (Womb "body" body) where
1003− getRequestMod (Womb body) = Endo $ \x ->
1004− x { L.requestBody = getRequestBody body
1005− , L.requestHeaders =
1006− let old = L.requestHeaders x in
1007− case getRequestContentType body of
1008− Nothing -> old
1009− Just contentType ->
1010− (Y.hContentType, contentType) : old }
1371+type family
1372+ HttpBodyAllowed
1373+ (allowsBody :: CanHaveBody)
1374+ (providesBody :: CanHaveBody) ::
1375+ Constraint
1376+ where
1377+ HttpBodyAllowed 'NoBody 'NoBody = ()
1378+ HttpBodyAllowed 'CanHaveBody body = ()
1379+ HttpBodyAllowed 'NoBody 'CanHaveBody =
1380+ TypeError
1381+ ('Text "This HTTP method does not allow attaching a request body.")
1382+
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
1385+ x
1386+ { L.requestBody = getRequestBody body,
1387+ L.requestHeaders =
1388+ let old = L.requestHeaders x
1389+ in case getRequestContentType body of
1390+ Nothing -> old
1391+ Just contentType ->
1392+ (Y.hContentType, contentType) : old
1393+ }
10111394
10121395----------------------------------------------------------------------------
10131396-- Request—Optional parameters
10141397
10151398-- $optional-parameters
10161399--
1017−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
10181401-- headers, port number, etc. All optional parameters have the type
10191402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
10201403-- the last argument of 'req' to specify no optional parameters, or combine
1021−-- 'Option's using 'mappend' (or @('<>')@) to have several of them at once.
1404+-- 'Option's using 'mappend' or @('<>')@ to have several of them at once.
10221405
1023−-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
1024−-- optional parameters like query parameters and headers. See sections below
1025−-- to learn which 'Option' primitives are available.
1406+-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
1407+-- of optional parameters like query parameters and headers. See sections
1408+-- 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))
10261411
1027−data Option (scheme :: Scheme) =
1028− Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
1029− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1030− -- Request to avoid appending to existing query string in request every
1031− -- time new parameter is added. Additional Maybe (L.Request -> IO
1032− -- L.Request) is a finalizer that will be applied after all other
1033− -- transformations. This is for authentication methods that sign requests
1034− -- based on data in Request.
1412+-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1413+-- Request to avoid appending to an existing query string in request every
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
1415+-- L.Request) is a finalizer that will be applied after all other
1416+-- transformations. This is for authentication methods that sign requests
1417+-- based on data in Request.
10351418
10361419instance Semigroup (Option scheme) where
1037− Option er0 mr0 <> Option er1 mr1 = Option
1038− (er0 <> er1) (mr0 <|> mr1)
1420+ Option er0 mr0 <> Option er1 mr1 =
1421+ Option
1422+ (er0 <> er1)
1423+ (mr0 <|> mr1)
10391424
10401425instance Monoid (Option scheme) where
1041− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
10421427 mappend = (<>)
10431428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
10441435-- | A helper to create an 'Option' that modifies only collection of query
10451436-- parameters. This helper is not a part of the public API.
1046−
10471437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
10481438withQueryParams f = Option (Endo (first f)) Nothing
10491439
10501440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
10511441-- helper is not a part of public API.
1052−
10531442withRequest :: (L.Request -> L.Request) -> Option scheme
10541443withRequest f = Option (Endo (second f)) Nothing
10551444
1056−-- | A helper to create an 'Option' that adds a finalizer (request
1057−-- transformation that is applied after all other modifications).
1058−
1059−asFinalizer :: (L.Request -> IO L.Request) -> Option scheme
1060−asFinalizer = Option mempty . pure
1061−
10621445instance RequestComponent (Option scheme) where
10631446 getRequestMod (Option f _) = Endo $ \x ->
10641447 let (qparams, x') = appEndo f ([], x)
1065− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1066− in x' { L.queryString = query }
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449+ in x' {L.queryString = query}
10671450
10681451-- | Finalize given 'L.Request' by applying a finalizer from the given
10691452-- 'Option' (if it has any).
1070−
1071−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
10721454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
10731455
10741456----------------------------------------------------------------------------
@@ -1081,47 +1463,67 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
10811463-- bodies (of the type 'FormUrlEncodedParam').
10821464
10831465-- | This operator builds a query parameter that will be included in URL of
1084−-- your request after question sign @?@. This is the same syntax you use
1466+-- your request after the question sign @?@. This is the same syntax you use
10851467-- with form URL encoded request bodies.
10861468--
10871469-- This operator is defined in terms of 'queryParam':
10881470--
10891471-- > name =: value = queryParam name (pure value)
1090−
10911472infix 7 =:
1473+
10921474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
10931475name =: value = queryParam name (pure value)
10941476
1095−-- | Construct a flag, that is, valueless query parameter. For example, in
1096−-- the following URL @a@ is a flag, while @b@ is a query parameter with a
1097−-- value:
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
1478+-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
1479+-- with a value:
10981480--
10991481-- > https://httpbin.org/foo/bar?a&b=10
11001482--
11011483-- This operator is defined in terms of 'queryParam':
11021484--
11031485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1104−
1105−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
11061487queryFlag name = queryParam name (Nothing :: Maybe ())
11071488
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491+--
1492+-- Note that 'Form.Form' doesn't have the concept of parameters with the
1493+-- empty value (i.e. what you can get by @key =: ""@). If the value is
1494+-- empty, it will be encoded as a valueless parameter (i.e. what you can get
1495+-- by @queryFlag key@).
1496+--
1497+-- @since 3.11.0
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500+ where
1501+ toParam (key, val) =
1502+ queryParam key $
1503+ if val == ""
1504+ then Nothing
1505+ else Just val
1506+
11081507-- | A type class for query-parameter-like things. The reason to have an
11091508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
11101509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
11111510-- Having the same syntax for these cases seems natural and user-friendly.
1112−
11131511class QueryParam param where
1114−
11151512 -- | Create a query parameter with given name and value. If value is
11161513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
11171514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
11181515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
11191517
1120− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1519+ --
1520+ -- @since 3.11.0
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
11211522
11221523instance QueryParam (Option scheme) where
11231524 queryParam name mvalue =
11241525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
11251527
11261528----------------------------------------------------------------------------
11271529-- Request—Optional parameters—Headers
@@ -1130,19 +1532,28 @@ instance QueryParam (Option scheme) where
11301532-- headers with the same names the leftmost header will win. This means, in
11311533-- particular, that you cannot create a request with several headers of the
11321534-- same name.
1133−
1134−header
1135− :: ByteString -- ^ Header name
1136− -> ByteString -- ^ Header value
1137− -> Option scheme
1535+header ::
1536+ -- | Header name
1537+ ByteString ->
1538+ -- | Header value
1539+ ByteString ->
1540+ Option scheme
11381541header name value = withRequest (attachHeader name value)
11391542
1140−-- | A non-public helper that attaches a header with given name and content
1141−-- to a 'L.Request'.
1142−
1543+-- | Attach a header with given name and content to a 'L.Request'.
1544+--
1545+-- @since 1.1.0
11431546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
11441547attachHeader name value x =
1145− x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
1548+ x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1549+
1550+-- | Same as 'header', but with redacted values on print.
1551+--
1552+-- @since 3.13.0
1553+headerRedacted :: ByteString -> ByteString -> Option scheme
1554+headerRedacted name value = withRequest $ \x ->
1555+ let y = attachHeader name value x
1556+ in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
11461557
11471558----------------------------------------------------------------------------
11481559-- Request—Optional parameters—Cookies
@@ -1155,10 +1566,9 @@ attachHeader name value x =
11551566
11561567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
11571568-- 'L.Response' record.
1158−
11591569cookieJar :: L.CookieJar -> Option scheme
11601570cookieJar jar = withRequest $ \x ->
1161− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
11621572
11631573----------------------------------------------------------------------------
11641574-- Request—Optional parameters—Authentication
@@ -1176,42 +1586,66 @@ cookieJar jar = withRequest $ \x ->
11761586-- | The 'Option' adds basic authentication.
11771587--
11781588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1179−
1180−basicAuth
1181− :: ByteString -- ^ Username
1182− -> ByteString -- ^ Password
1183− -> Option 'Https -- ^ Auth 'Option'
1589+basicAuth ::
1590+ -- | Username
1591+ ByteString ->
1592+ -- | Password
1593+ ByteString ->
1594+ -- | Auth 'Option'
1595+ Option 'Https
11841596basicAuth = basicAuthUnsafe
11851597
11861598-- | An alternative to 'basicAuth' which works for any scheme. Note that
1187−-- using basic access authentication without SSL/TLS is vulnerable to
1599+-- using basic access authentication without SSL\/TLS is vulnerable to
11881600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
11891601--
11901602-- @since 0.3.1
1191−
1192−basicAuthUnsafe
1193− :: ByteString -- ^ Username
1194− -> ByteString -- ^ Password
1195− -> Option scheme -- ^ Auth 'Option'
1196−basicAuthUnsafe username password = asFinalizer
1197− (pure . L.applyBasicAuth username password)
1603+basicAuthUnsafe ::
1604+ -- | Username
1605+ ByteString ->
1606+ -- | Password
1607+ ByteString ->
1608+ -- | Auth 'Option'
1609+ Option scheme
1610+basicAuthUnsafe username password =
1611+ customAuth
1612+ (pure . L.applyBasicAuth username password)
1613+
1614+-- | The 'Option' set basic proxy authentication header.
1615+--
1616+-- @since 1.1.0
1617+basicProxyAuth ::
1618+ -- | Username
1619+ ByteString ->
1620+ -- | Password
1621+ ByteString ->
1622+ -- | Auth 'Option'
1623+ Option scheme
1624+basicProxyAuth username password =
1625+ withRequest (L.applyBasicProxyAuth username password)
11981626
11991627-- | The 'Option' adds OAuth1 authentication.
12001628--
12011629-- @since 0.2.0
1202−
1203−oAuth1
1204− :: ByteString -- ^ Consumer token
1205− -> ByteString -- ^ Consumer secret
1206− -> ByteString -- ^ OAuth token
1207− -> ByteString -- ^ OAuth token secret
1208− -> Option scheme -- ^ Auth 'Option'
1630+oAuth1 ::
1631+ -- | Consumer token
1632+ ByteString ->
1633+ -- | Consumer secret
1634+ ByteString ->
1635+ -- | OAuth token
1636+ ByteString ->
1637+ -- | OAuth token secret
1638+ ByteString ->
1639+ -- | Auth 'Option'
1640+ Option scheme
12091641oAuth1 consumerToken consumerSecret token tokenSecret =
1210− asFinalizer (OAuth.signOAuth app creds)
1642+ customAuth (OAuth.signOAuth app creds)
12111643 where
1212− app = OAuth.newOAuth
1213− { OAuth.oauthConsumerKey = consumerToken
1214− , OAuth.oauthConsumerSecret = consumerSecret }
1644+ app =
1645+ OAuth.newOAuth
1646+ { OAuth.oauthConsumerKey = consumerToken,
1647+ OAuth.oauthConsumerSecret = consumerSecret
1648+ }
12151649 creds = OAuth.newCredential token tokenSecret
12161650
12171651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1222,12 +1656,14 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
12221656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
12231657--
12241658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1225−
1226−oAuth2Bearer
1227− :: ByteString -- ^ Token
1228− -> Option 'Https -- ^ Auth 'Option'
1229−oAuth2Bearer token = asFinalizer
1230− (pure . attachHeader "Authorization" ("Bearer " <> token))
1659+oAuth2Bearer ::
1660+ -- | Token
1661+ ByteString ->
1662+ -- | Auth 'Option'
1663+ Option 'Https
1664+oAuth2Bearer token =
1665+ customAuth
1666+ (pure . attachHeader "Authorization" ("Bearer " <> token))
12311667
12321668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
12331669-- to be used only by GitHub). This will be treated by whatever services
@@ -1238,26 +1674,35 @@ oAuth2Bearer token = asFinalizer
12381674-- > oAuth2Token token = header "Authorization" ("token" <> token)
12391675--
12401676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1241−
1242−oAuth2Token
1243− :: ByteString -- ^ Token
1244− -> Option 'Https -- ^ Auth 'Option'
1245−oAuth2Token token = asFinalizer
1246− (pure . attachHeader "Authorization" ("token " <> token))
1677+oAuth2Token ::
1678+ -- | Token
1679+ ByteString ->
1680+ -- | Auth 'Option'
1681+ Option 'Https
1682+oAuth2Token token =
1683+ customAuth
1684+ (pure . attachHeader "Authorization" ("token " <> token))
1685+
1686+-- | A helper to create custom authentication 'Option's. The given
1687+-- 'IO'-enabled request transformation is applied after all other
1688+-- modifications when constructing a request. Use wisely.
1689+--
1690+-- @since 1.1.0
1691+customAuth :: (L.Request -> IO L.Request) -> Option scheme
1692+customAuth = Option mempty . pure
12471693
12481694----------------------------------------------------------------------------
12491695-- Request—Optional parameters—Other
12501696
12511697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
12521698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1253−-- 'Option' allows to choose arbitrary port overwriting the defaults.
1254−
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
12551700port :: Int -> Option scheme
12561701port n = withRequest $ \x ->
1257− x { L.port = n }
1702+ x {L.port = n}
12581703
12591704-- | This 'Option' controls whether gzipped data should be decompressed on
1260−-- the fly. By default everything except for @application\/x-tar@ is
1705+-- the fly. By default everything except for @\"application\/x-tar\"@ is
12611706-- decompressed, i.e. we have:
12621707--
12631708-- > decompress (/= "application/x-tar")
@@ -1265,163 +1710,212 @@ port n = withRequest $ \x ->
12651710-- You can also choose to decompress everything like this:
12661711--
12671712-- > decompress (const True)
1268−
1269−decompress
1270− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1271− -- returns 'True' when content should be decompressed on the fly.
1272− -> Option scheme
1713+decompress ::
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1715+ -- should be decompressed on the fly.
1716+ (ByteString -> Bool) ->
1717+ Option scheme
12731718decompress f = withRequest $ \x ->
1274− x { L.decompress = f }
1719+ x {L.decompress = f}
12751720
12761721-- | Specify the number of microseconds to wait for response. The default
1277−-- value is 30 seconds.
1278−
1279−responseTimeout
1280− :: Int -- ^ Number of microseconds to wait
1281− -> Option scheme
1722+-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
1723+-- 'L.Manager').
1724+responseTimeout ::
1725+ -- | Number of microseconds to wait
1726+ Int ->
1727+ Option scheme
12821728responseTimeout n = withRequest $ \x ->
1283− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
12841730
12851731-- | HTTP version to send to the server, the default is HTTP 1.1.
1286−
1287−httpVersion
1288− :: Int -- ^ Major version number
1289− -> Int -- ^ Minor version number
1290− -> Option scheme
1732+httpVersion ::
1733+ -- | Major version number
1734+ Int ->
1735+ -- | Minor version number
1736+ Int ->
1737+ Option scheme
12911738httpVersion major minor = withRequest $ \x ->
1292− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
12931740
12941741----------------------------------------------------------------------------
12951742-- Response interpretations
12961743
1297−-- | Make a request and ignore body of response.
1298−
1299−data IgnoreResponse = IgnoreResponse (L.Response ())
1744+-- | Make a request and ignore the body of the response.
1745+newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
13001747
13011748instance HttpResponse IgnoreResponse where
13021749 type HttpResponseBody IgnoreResponse = ()
1303− toVanillaResponse (IgnoreResponse response) = response
1304− getHttpResponse request manager =
1305− IgnoreResponse <$> liftIO (L.httpNoBody request manager)
1306− makeResponseBodyPreview _ = return "<ignored response>"
1750+ toVanillaResponse (IgnoreResponse r) = r
1751+ getHttpResponse r = return $ IgnoreResponse (void r)
13071752
13081753-- | Use this as the fourth argument of 'req' to specify that you want it to
1309−-- return the 'IgnoreResponse' interpretation.
1310−
1754+-- ignore the response body.
13111755ignoreResponse :: Proxy IgnoreResponse
13121756ignoreResponse = Proxy
13131757
1314−-- | Make a request and interpret body of response as JSON. The
1758+-- | Make a request and interpret the body of the response as JSON. The
13151759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
13161760-- monad in which you use 'req' will determine what to do in the case when
13171761-- parsing fails (the 'JsonHttpException' constructor will be used).
1762+newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
13181764
1319−data JsonResponse a = JsonResponse (L.Response a) ByteString
1320−
1321−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
13221766 type HttpResponseBody (JsonResponse a) = a
1323− toVanillaResponse (JsonResponse response _) = response
1324− getHttpResponse request manager = do
1325− response <- L.httpLbs request manager
1326− case A.eitherDecode (L.responseBody response) of
1767+ toVanillaResponse (JsonResponse r) = r
1768+ getHttpResponse r = do
1769+ chunks <- L.brConsume (L.responseBody r)
1770+ case A.eitherDecode (BL.fromChunks chunks) of
13271771 Left e -> throwIO (JsonHttpException e)
1328− Right x -> do
1329− let preview
1330− = BL.toStrict
1331− . BL.take bodyPreviewLength
1332− . L.responseBody
1333− $ response
1334− return $ JsonResponse response { L.responseBody = x } preview
1335− makeResponseBodyPreview (JsonResponse _ preview) = return preview
1336−
1337−-- | Use this as the forth argument of 'req' to specify that you want it to
1338−-- return the 'JsonResponse' interpretation.
1772+ Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
13391774
1775+-- | Use this as the fourth argument of 'req' to specify that you want it to
1776+-- return the 'JsonResponse' interpretation.
13401777jsonResponse :: Proxy (JsonResponse a)
13411778jsonResponse = Proxy
13421779
1343−-- | Make a request and interpret body of response as a strict 'ByteString'.
1344−
1780+-- | Make a request and interpret the body of the response as a strict
1781+-- 'ByteString'.
13451782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
13461784
13471785instance HttpResponse BsResponse where
13481786 type HttpResponseBody BsResponse = ByteString
1349− toVanillaResponse (BsResponse response) = response
1350− getHttpResponse request manager =
1351− L.withResponse request manager $ \response -> do
1352− chunks <- L.brConsume (L.responseBody response)
1353− return $ BsResponse response { L.responseBody = B.concat chunks }
1354− makeResponseBodyPreview = return . B.take bodyPreviewLength . responseBody
1355−
1356−-- | Use this as the forth argument of 'req' to specify that you want to
1357−-- interpret response body as a strict 'ByteString'.
1787+ toVanillaResponse (BsResponse r) = r
1788+ getHttpResponse r = do
1789+ chunks <- L.brConsume (L.responseBody r)
1790+ return $ BsResponse (B.concat chunks <$ r)
13581791
1792+-- | Use this as the fourth argument of 'req' to specify that you want to
1793+-- interpret the response body as a strict 'ByteString'.
13591794bsResponse :: Proxy BsResponse
13601795bsResponse = Proxy
13611796
1362−-- | Make a request and interpret body of response as a lazy
1797+-- | Make a request and interpret the body of the response as a lazy
13631798-- 'BL.ByteString'.
1364−
13651799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
13661801
13671802instance HttpResponse LbsResponse where
13681803 type HttpResponseBody LbsResponse = BL.ByteString
1369− toVanillaResponse (LbsResponse response) = response
1370− getHttpResponse request manager =
1371− LbsResponse <$> L.httpLbs request manager
1372− makeResponseBodyPreview = return . BL.toStrict . BL.take 1027 . responseBody
1373−
1374−-- | Use this as the forth argument of 'req' to specify that you want to
1375−-- interpret response body as a lazy 'BL.ByteString'.
1804+ toVanillaResponse (LbsResponse r) = r
1805+ getHttpResponse r = do
1806+ chunks <- L.brConsume (L.responseBody r)
1807+ return $ LbsResponse (BL.fromChunks chunks <$ r)
13761808
1809+-- | Use this as the fourth argument of 'req' to specify that you want to
1810+-- interpret the response body as a lazy 'BL.ByteString'.
13771811lbsResponse :: Proxy LbsResponse
13781812lbsResponse = Proxy
13791813
1814+----------------------------------------------------------------------------
1815+-- Helpers for response interpretations
1816+
1817+-- | Fetch beginning of the response and return it together with a new
1818+-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
1819+-- 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)
1827+grabPreview nbytes r = do
1828+ let br = L.responseBody r
1829+ (target, leftover, done) <- brReadN br nbytes
1830+ nref <- newIORef (0 :: Int)
1831+ let br' = do
1832+ n <- readIORef nref
1833+ let incn = modifyIORef' nref (+ 1)
1834+ case n of
1835+ 0 -> do
1836+ incn
1837+ if B.null target
1838+ then br'
1839+ else return target
1840+ 1 -> do
1841+ incn
1842+ if B.null leftover
1843+ then br'
1844+ else return leftover
1845+ _ ->
1846+ if done
1847+ then return B.empty
1848+ else br
1849+ return (target, r {L.responseBody = br'})
1850+
1851+-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
1852+-- 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)
1860+brReadN br n = go 0 id id
1861+ where
1862+ go !tlen t l = do
1863+ chunk <- br
1864+ if B.null chunk
1865+ then return (r t, r l, True)
1866+ else do
1867+ let (target, leftover) = B.splitAt (n - tlen) chunk
1868+ tlen' = B.length target
1869+ t' = t . (target :)
1870+ l' = l . (leftover :)
1871+ if tlen + tlen' < n
1872+ then go (tlen + tlen') t' l'
1873+ else return (r t', r l', False)
1874+ r f = B.concat (f [])
1875+
13801876----------------------------------------------------------------------------
13811877-- Inspecting a response
13821878
13831879-- | Get the response body.
1384−
1385−responseBody
1386− :: HttpResponse response
1387− => response
1388− -> HttpResponseBody response
1880+responseBody ::
1881+ (HttpResponse response) =>
1882+ response ->
1883+ HttpResponseBody response
13891884responseBody = L.responseBody . toVanillaResponse
13901885
13911886-- | Get the response status code.
1392−
1393−responseStatusCode
1394− :: HttpResponse response
1395− => response
1396− -> Int
1887+responseStatusCode ::
1888+ (HttpResponse response) =>
1889+ response ->
1890+ Int
13971891responseStatusCode =
13981892 Y.statusCode . L.responseStatus . toVanillaResponse
13991893
14001894-- | Get the response status message.
1401−
1402−responseStatusMessage
1403− :: HttpResponse response
1404− => response
1405− -> ByteString
1895+responseStatusMessage ::
1896+ (HttpResponse response) =>
1897+ response ->
1898+ ByteString
14061899responseStatusMessage =
14071900 Y.statusMessage . L.responseStatus . toVanillaResponse
14081901
14091902-- | Lookup a particular header from a response.
1410−
1411−responseHeader
1412− :: HttpResponse response
1413− => response -- ^ Response interpretation
1414− -> ByteString -- ^ Header to lookup
1415− -> Maybe ByteString -- ^ Header value if found
1903+responseHeader ::
1904+ (HttpResponse response) =>
1905+ -- | Response interpretation
1906+ response ->
1907+ -- | Header to lookup
1908+ ByteString ->
1909+ -- | Header value if found
1910+ Maybe ByteString
14161911responseHeader r h =
14171912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
14181913
14191914-- | Get the response 'L.CookieJar'.
1420−
1421−responseCookieJar
1422− :: HttpResponse response
1423− => response
1424− -> L.CookieJar
1915+responseCookieJar ::
1916+ (HttpResponse response) =>
1917+ response ->
1918+ L.CookieJar
14251919responseCookieJar = L.responseCookieJar . toVanillaResponse
14261920
14271921----------------------------------------------------------------------------
@@ -1430,34 +1924,58 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
14301924-- $new-response-interpretation
14311925--
14321926-- To create a new response interpretation you just need to make your data
1433−-- type an instance of 'HttpResponse' type class.
1434−
1435−-- | A type class for response interpretations. It allows to fully control
1436−-- how request is made and how its body is parsed.
1927+-- type an instance of the 'HttpResponse' type class.
14371928
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.
14381932class HttpResponse response where
1439−
14401933 -- | The associated type is the type of body that can be extracted from an
14411934 -- instance of 'HttpResponse'.
1442−
1443− type HttpResponseBody response :: *
1935+ type HttpResponseBody response :: Type
14441936
14451937 -- | The method describes how to get the underlying 'L.Response' record.
1446−
14471938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
14481939
1449− -- | This method describes how to make an HTTP request given 'L.Request'
1450− -- (prepared by the library) and 'L.Manager'.
1451−
1452− getHttpResponse :: L.Request -> L.Manager -> IO response
1453−
1454− -- | Construct a “preview” of response body. It is recommend to limit the
1455− -- length to 1024 bytes. This is mainly useful for inclusion of response
1456− -- body fragments in exceptions.
1940+ -- | This method describes how to consume response body and, more
1941+ -- generally, obtain @response@ value from @'L.Response' 'L.BodyReader'@.
1942+ --
1943+ -- __Note__: 'L.BodyReader' is nothing but @'IO' 'ByteString'@. You should
1944+ -- call this action repeatedly until it yields the empty 'ByteString'. In
1945+ -- that case streaming of response is finished (which apparently leads to
1946+ -- closing of the connection, so don't call the reader after it has
1947+ -- returned the empty 'ByteString' once) and you can concatenate the
1948+ -- chunks to obtain the final result. (Of course you could as well stream
1949+ -- the contents to a file or do whatever you want.)
1950+ --
1951+ -- __Note__: signature of this function was changed in the version
1952+ -- /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.
14571965 --
1458− -- @since 0.3.0
1966+ -- @since 2.1.0
1967+ acceptHeader :: Proxy response -> Maybe ByteString
1968+ acceptHeader Proxy = Nothing
14591969
1460− makeResponseBodyPreview :: response -> IO ByteString
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
14611979
14621980----------------------------------------------------------------------------
14631981-- Other
@@ -1467,15 +1985,14 @@ class HttpResponse response where
14671985-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
14681986-- monoid of endomorphisms under composition, it's used to chain different
14691987-- request components easier using @('<>')@.
1470−
1988+--
1989+-- __Note__: this type class is not a part of the public API.
14711990class RequestComponent a where
1472−
14731991 -- | Get a function that takes a 'L.Request' and changes it somehow
1474− -- returning another 'L.Request'. For example HTTP method instance of
1475− -- 'RequestComponent' just overwrites method. The function is wrapped in
1476− -- 'Endo' so it's easier to chain such “modifying applications” together
1477− -- building bigger and bigger 'RequestComponent's.
1478−
1992+ -- returning another 'L.Request'. For example, the 'HttpMethod' instance
1993+ -- of 'RequestComponent' just overwrites method. The function is wrapped
1994+ -- in 'Endo' so it's easier to chain such “modifying applications”
1995+ -- together building bigger and bigger 'RequestComponent's.
14791996 getRequestMod :: a -> Endo L.Request
14801997
14811998-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -1485,42 +2002,50 @@ class RequestComponent a where
14852002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
14862003-- which instance to use (i.e. the constraints are taken into account later,
14872004-- when instance is already chosen).
1488−
1489−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
14902006
14912007-- | Exceptions that this library throws.
1492−
14932008data HttpException
1494− = VanillaHttpException L.HttpException
1495− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1496− | JsonHttpException String
1497− -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
1498− deriving (Show, Typeable, Generic)
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
2012+ -- failed
2013+ JsonHttpException String
2014+ deriving (Show, Generic)
14992015
15002016instance Exception HttpException
15012017
1502−-- | A simple 'Bool'-like type we only have for better error messages. We
1503−-- use it as a kind and its data constructors as type-level tags.
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
15042020--
1505−-- See also: 'HttpMethod' and 'HttpBody'.
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
15062031
2032+-- | A simple type isomorphic to 'Bool' that we only have for better error
2033+-- messages. We use it as a kind and its data constructors as type-level
2034+-- tags.
2035+--
2036+-- See also: 'HttpMethod' and 'HttpBody'.
15072037data CanHaveBody
1508− = CanHaveBody -- ^ Indeed can have a body
1509− | NoBody -- ^ Should not have a body
2038+ = -- | Indeed can have a body
2039+ CanHaveBody
2040+ | -- | Should not have a body
2041+ NoBody
15102042
15112043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
15122044-- enabled). This is used to force TLS requirement for some authentication
15132045-- 'Option's.
1514−
15152046data Scheme
1516− = Http -- ^ HTTP
1517− | Https -- ^ HTTPS
1518− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1519−
1520−----------------------------------------------------------------------------
1521−-- Constants
1522−
1523−-- | Max length of preview fragment of response body.
1524−
1525−bodyPreviewLength :: Num a => a
1526−bodyPreviewLength = 1024
2047+ = -- | HTTP
2048+ Http
2049+ | -- | HTTPS
2050+ Https
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)