@@ -1,16 +1,6 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE QuasiQuotes #-}
5−{-# LANGUAGE RecordWildCards #-}
6−{-# LANGUAGE RoleAnnotations #-}
7−{-# LANGUAGE TemplateHaskellQuotes #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE UndecidableInstances #-}
10−
111-- |
122-- Module : Network.HTTP.Req
13−-- Copyright : © 2016–present Mark Karpov
3+-- Copyright : © 2016–2017 Mark Karpov
144-- License : BSD 3 clause
155--
166-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
@@ -19,40 +9,61 @@
199--
2010-- The documentation below is structured in such a way that the most
2111-- important information is presented first: you learn how to do HTTP
22−-- requests, how to embed them in the monad you have, and then it gives you
12+-- requests, how to embed them in any monad you have, and then it gives you
2313-- details about less-common things you may want to know about. The
2414-- documentation is written with sufficient coverage of details and
2515-- examples, and it's designed to be a complete tutorial on its own.
2616--
17+-- /(A modest intro goes here, click on 'req' to start making requests.)/
18+--
2719-- === About the library
2820--
29−-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30−-- and expandable.
31−--
32−-- “Easy-to-use” means that the library is designed to be beginner-friendly
33−-- so it's simple to add to your monad stack, intuitive to work with,
34−-- well-documented, and does not get in your way. Doing HTTP requests is a
35−-- common task and a Haskell library for this should be approachable and
36−-- clear to beginners, thus certain compromises were made. For example, one
37−-- cannot currently modify 'L.ManagerSettings' of the default manager
38−-- because the library always uses the same implicit global manager for
39−-- simplicity and maximal connection sharing. There is a way to use your own
40−-- manager with different settings, but it requires more typing.
41−--
42−-- “Type-safe” means that the library tries to eliminate certain classes of
43−-- errors. For example, we have correct-by-construction URLs; it is
44−-- guaranteed that the user does not send the request body when using
45−-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46−-- minimized by making the user specify their intentions in an explicit
47−-- form. For example, it's not possible to avoid specifying the body or the
48−-- method of a request. Authentication methods that assume HTTPS force the
49−-- user to use HTTPS at the type level.
50−--
51−-- “Expandable” refers to the ability to create new components without
52−-- having to resort to hacking. For example, it's possible to define your
53−-- own HTTP methods, create new ways to construct the body of a request,
54−-- create new authorization options, perform a request in a different way,
55−-- and create your own methods to parse a response.
21+-- Req is an easy-to-use, type-safe, expandable, high-level HTTP 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.
5667--
5768-- === Using with other libraries
5869--
@@ -76,207 +87,179 @@
7687-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
7788-- machinery for performing requests is the same as with @http-conduit@ and
7889-- @wreq@. The only difference is the API.
90+
91+{-# LANGUAGE CPP #-}
92+{-# LANGUAGE DataKinds #-}
93+{-# LANGUAGE DeriveDataTypeable #-}
94+{-# LANGUAGE DeriveGeneric #-}
95+{-# LANGUAGE FlexibleInstances #-}
96+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
97+{-# LANGUAGE KindSignatures #-}
98+{-# LANGUAGE OverloadedStrings #-}
99+{-# LANGUAGE RecordWildCards #-}
100+{-# LANGUAGE ScopedTypeVariables #-}
101+{-# LANGUAGE TypeFamilies #-}
102+
103+#if MIN_VERSION_base(4,9,0)
104+{-# LANGUAGE UndecidableInstances #-}
105+#endif
106+
107+#if __GLASGOW_HASKELL__ < 710
108+{-# LANGUAGE ConstraintKinds #-}
109+#endif
110+
111+#if __GLASGOW_HASKELL__ >= 800
112+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
113+#endif
114+
79115module Network.HTTP.Req
80116 ( -- * Making a request
81117 -- $making-a-request
82− req,
83− reqBr,
84− reqCb,
85− req',
86− withReqManager,
87−
88− -- * Embedding requests in your monad
118+ req
119+ , withReqManager
120+ -- * Embedding requests into your monad
89121 -- $embedding-requests
90− MonadHttp (..),
91− HttpConfig (..),
92− defaultHttpConfig,
93− Req,
94− runReq,
95−
122+ , MonadHttp (..)
123+ , HttpConfig (..)
96124 -- * Request
97−
98125 -- ** Method
99126 -- $method
100− GET (..),
101− POST (..),
102− HEAD (..),
103− PUT (..),
104− DELETE (..),
105− TRACE (..),
106− CONNECT (..),
107− OPTIONS (..),
108− PATCH (..),
109− HttpMethod (..),
110−
127+ , GET (..)
128+ , POST (..)
129+ , HEAD (..)
130+ , PUT (..)
131+ , DELETE (..)
132+ , TRACE (..)
133+ , CONNECT (..)
134+ , OPTIONS (..)
135+ , PATCH (..)
136+ , HttpMethod (..)
111137 -- ** URL
112138 -- $url
113− Url,
114− http,
115− https,
116− (/~),
117− (/:),
118− useHttpURI,
119− useHttpsURI,
120− useURI,
121− urlQ,
122− renderUrl,
123−
139+ , Url
140+ , http
141+ , https
142+ , (/~)
143+ , (/:)
144+ , parseUrlHttp
145+ , parseUrlHttps
124146 -- ** Body
125147 -- $body
126− NoReqBody (..),
127− ReqBodyJson (..),
128− ReqBodyFile (..),
129− ReqBodyBs (..),
130− ReqBodyLbs (..),
131− ReqBodyUrlEnc (..),
132− FormUrlEncodedParam,
133− ReqBodyMultipart,
134− reqBodyMultipart,
135− HttpBody (..),
136− ProvidesBody,
137− HttpBodyAllowed,
138−
148+ , NoReqBody (..)
149+ , ReqBodyJson (..)
150+ , ReqBodyFile (..)
151+ , ReqBodyBs (..)
152+ , ReqBodyLbs (..)
153+ , ReqBodyUrlEnc (..)
154+ , FormUrlEncodedParam
155+ , ReqBodyMultipart
156+ , reqBodyMultipart
157+ , HttpBody (..)
158+ , ProvidesBody
159+ , HttpBodyAllowed
139160 -- ** Optional parameters
140161 -- $optional-parameters
141− Option,
142−
162+ , Option
143163 -- *** Query parameters
144164 -- $query-parameters
145− (=:),
146− queryFlag,
147− formToQuery,
148− QueryParam (..),
149−
165+ , (=:)
166+ , queryFlag
167+ , QueryParam (..)
150168 -- *** Headers
151− header,
152− attachHeader,
153− headerRedacted,
154−
169+ , header
155170 -- *** Cookies
156171 -- $cookies
157− cookieJar,
158−
172+ , cookieJar
159173 -- *** Authentication
160174 -- $authentication
161− basicAuth,
162− basicAuthUnsafe,
163− basicProxyAuth,
164− oAuth1,
165− oAuth2Bearer,
166− oAuth2Token,
167− customAuth,
168−
175+ , basicAuth
176+ , oAuth1
177+ , oAuth2Bearer
178+ , oAuth2Token
169179 -- *** Other
170− port,
171− decompress,
172− responseTimeout,
173− httpVersion,
174−
180+ , port
181+ , decompress
182+ , responseTimeout
183+ , httpVersion
175184 -- * Response
176−
177185 -- ** Response interpretations
178− IgnoreResponse,
179− ignoreResponse,
180− JsonResponse,
181− jsonResponse,
182− BsResponse,
183− bsResponse,
184− LbsResponse,
185− lbsResponse,
186−
186+ , IgnoreResponse
187+ , ignoreResponse
188+ , JsonResponse
189+ , jsonResponse
190+ , BsResponse
191+ , bsResponse
192+ , LbsResponse
193+ , lbsResponse
194+ , ReturnRequest
195+ , returnRequest
187196 -- ** Inspecting a response
188− responseBody,
189− responseStatusCode,
190− responseStatusMessage,
191− responseHeader,
192− responseCookieJar,
193−
197+ , responseBody
198+ , responseStatusCode
199+ , responseStatusMessage
200+ , responseHeader
201+ , responseCookieJar
202+ , responseRequest
194203 -- ** Defining your own interpretation
195204 -- $new-response-interpretation
196− HttpResponse (..),
197−
205+ , HttpResponse (..)
198206 -- * Other
199− HttpException (..),
200− isStatusCodeException,
201− CanHaveBody (..),
202− Scheme (..),
203− )
207+ , HttpException (..)
208+ , CanHaveBody (..)
209+ , Scheme (..) )
204210where
205211
206−import Blaze.ByteString.Builder qualified as BB
207212import Control.Applicative
208213import Control.Arrow (first, second)
209−import Control.Exception hiding (Handler (..), TypeError)
210−import Control.Monad (guard, void, (>=>))
211−import Control.Monad.Base
212−import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
214+import Control.Exception (Exception, try, catch, throwIO)
215+import Control.Monad
213216import Control.Monad.IO.Class
214−import Control.Monad.IO.Unlift
215−import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216−import Control.Monad.Trans.Accum (AccumT)
217−import Control.Monad.Trans.Cont (ContT)
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
231−import Control.Retry
232−import Data.Aeson (FromJSON (..), ToJSON (..))
233−import Data.Aeson qualified as A
217+import Data.Aeson (ToJSON (..), FromJSON (..))
234218import 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
238219import Data.Data (Data)
239−import Data.Default.Class (def)
220+import Data.Default.Class
240221import Data.Function (on)
241222import Data.IORef
242−import Data.Kind (Constraint, Type)
243−import Data.List (foldl', nubBy)
223+import Data.List (nubBy)
244224import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
246225import Data.Maybe (fromMaybe)
247226import Data.Proxy
248−import Data.Semigroup (Endo (..))
249−import Data.Set qualified as S
227+import Data.Semigroup hiding (Option, option)
250228import Data.Text (Text)
251−import Data.Text qualified as T
252−import Data.Text.Encoding qualified as T
253−import Data.Typeable (Typeable, cast)
229+import Data.Typeable (Typeable)
254230import GHC.Generics
255231import 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
265232import 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
272233import Web.HttpApiData (ToHttpApiData (..))
234+import qualified Blaze.ByteString.Builder as BB
235+import qualified Data.Aeson as A
236+import qualified Data.ByteString as B
237+import qualified Data.ByteString.Lazy as BL
238+import qualified Data.CaseInsensitive as CI
239+import qualified Data.List.NonEmpty as NE
240+import qualified Data.Text as T
241+import qualified Data.Text.Encoding as T
242+import qualified Data.Text.Read as TR
243+import qualified Network.Connection as NC
244+import qualified Network.HTTP.Client as L
245+import qualified Network.HTTP.Client.Internal as LI
246+import qualified Network.HTTP.Client.MultipartFormData as LM
247+import qualified Network.HTTP.Client.TLS as L
248+import qualified Network.HTTP.Types as Y
249+import qualified Web.Authenticate.OAuth as OAuth
250+
251+#if MIN_VERSION_base(4,9,0)
252+import Data.Kind (Constraint)
253+#else
254+import GHC.Exts (Constraint)
255+#endif
273256
274257----------------------------------------------------------------------------
275258-- Making a request
276259
277260-- $making-a-request
278261--
279−-- To make an HTTP request you normally need only one function: 'req'.
262+-- To make an HTTP request you need only one function: 'req'.
280263
281264-- | Make an HTTP request. The function takes 5 arguments, 4 of which
282265-- specify required parameters and the final 'Option' argument is a
@@ -293,7 +276,7 @@ import Web.HttpApiData (ToHttpApiData (..))
293276--
294277-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
295278-- tutorial has a section about HTTP bodies, but usage is very
296−-- straightforward and should be clear from the examples.
279+-- straightforward and should be clear from the examples below.
297280--
298281-- @response@ is a type hint how to make and interpret response of an HTTP
299282-- request. Out-of-the-box it can be the following:
@@ -302,8 +285,10 @@ import Web.HttpApiData (ToHttpApiData (..))
302285-- * 'jsonResponse'
303286-- * 'bsResponse' (to get a strict 'ByteString')
304287-- * 'lbsResponse' (to get a lazy 'BL.ByteString')
288+-- * 'returnRequest' (makes no request, but returns the constructed
289+-- request itself, used for testing).
305290--
306−-- Finally, @options@ is a 'Monoid' that holds a composite 'Option' for all
291+-- Finally @options@ is a 'Monoid' that holds a composite 'Option' for all
307292-- other optional settings like query parameters, headers, non-standard port
308293-- number, etc. There are quite a few things you can put there, see the
309294-- corresponding section in the documentation. If you don't need anything at
@@ -319,13 +304,12 @@ import Web.HttpApiData (ToHttpApiData (..))
319304-- First, this is a piece of boilerplate that should be in place before you
320305-- try the examples:
321306--
322−-- > {-# LANGUAGE DeriveGeneric #-}
323307-- > {-# LANGUAGE OverloadedStrings #-}
324308-- >
325309-- > module Main (main) where
326310-- >
311+-- > import Control.Exception (throwIO)
327312-- > import Control.Monad
328−-- > import Control.Monad.IO.Class
329313-- > import Data.Aeson
330314-- > import Data.Maybe (fromJust)
331315-- > import Data.Monoid ((<>))
@@ -333,30 +317,32 @@ import Web.HttpApiData (ToHttpApiData (..))
333317-- > import GHC.Generics
334318-- > import Network.HTTP.Req
335319-- > import qualified Data.ByteString.Char8 as B
336−-- > import qualified Text.URI as URI
320+-- >
321+-- > instance MonadHttp IO where
322+-- > handleHttpException = throwIO
337323--
338324-- We will be making requests against the <https://httpbin.org> service.
339325--
340326-- Make a GET request, grab 5 random bytes:
341327--
342328-- > main :: IO ()
343−-- > main = runReq defaultHttpConfig $ do
329+-- > main = do
344330-- > let n :: Int
345331-- > n = 5
346332-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
347−-- > liftIO $ B.putStrLn (responseBody bs)
333+-- > B.putStrLn (responseBody bs)
348334--
349335-- The same, but now we use a query parameter named @\"seed\"@ to control
350336-- seed of the generator:
351337--
352338-- > main :: IO ()
353−-- > main = runReq defaultHttpConfig $ do
339+-- > main = do
354340-- > let n, seed :: Int
355341-- > n = 5
356342-- > seed = 100
357343-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
358344-- > "seed" =: seed
359−-- > liftIO $ B.putStrLn (responseBody bs)
345+-- > B.putStrLn (responseBody bs)
360346--
361347-- POST JSON data and get some info about the POST request:
362348--
@@ -369,231 +355,79 @@ import Web.HttpApiData (ToHttpApiData (..))
369355-- > instance FromJSON MyData
370356-- >
371357-- > main :: IO ()
372−-- > main = runReq defaultHttpConfig $ do
358+-- > main = do
373359-- > let myData = MyData
374360-- > { size = 6
375361-- > , color = "Green" }
376362-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
377−-- > liftIO $ print (responseBody v :: Value)
363+-- > print (responseBody v :: Value)
378364--
379365-- Sending URL-encoded body:
380366--
381367-- > main :: IO ()
382−-- > main = runReq defaultHttpConfig $ do
368+-- > main = do
383369-- > let params =
384370-- > "foo" =: ("bar" :: Text) <>
385371-- > queryFlag "baz"
386372-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
387−-- > liftIO $ print (responseBody response :: Value)
373+-- > print (responseBody response :: Value)
388374--
389375-- Using various optional parameters and URL that is not known in advance:
390376--
391377-- > main :: IO ()
392−-- > main = runReq defaultHttpConfig $ do
378+-- > main = do
393379-- > -- This is an example of what to do when URL is given dynamically. Of
394380-- > -- course in a real application you may not want to use 'fromJust'.
395−-- > uri <- URI.mkURI "https://httpbin.org/get?foo=bar"
396−-- > let (url, options) = fromJust (useHttpsURI uri)
381+-- > let (url, options) = fromJust (parseUrlHttps "https://httpbin.org/get?foo=bar")
397382-- > response <- req GET url NoReqBody jsonResponse $
398383-- > "from" =: (15 :: Int) <>
399384-- > "to" =: (67 :: Int) <>
400385-- > basicAuth "username" "password" <>
401386-- > options <> -- contains the ?foo=bar part
402387-- > port 443 -- here you can put any port of course
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− )
536− >>= either handleHttpException return
537−
538−-- | Mostly like 'req' with respect to its arguments, but accepts a callback
539−-- that allows to perform a request in arbitrary fashion.
540−--
541−-- This function /does not/ perform handling\/wrapping exceptions, checking
542−-- response (with 'httpConfigCheckResponse'), and retrying. It only prepares
543−-- 'L.Request' and allows you to use it.
544−--
545−-- @since 0.3.0
546−req' ::
547− forall m method body scheme a.
548− ( MonadHttp m,
549− HttpMethod method,
550− HttpBody body,
551− HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
552− ) =>
553− -- | HTTP method
554− method ->
555− -- | 'Url'—location of resource
556− Url scheme ->
557− -- | Body of the request
558− body ->
559− -- | Collection of optional parameters
560− Option scheme ->
561− -- | How to perform request
562− (L.Request -> L.Manager -> m a) ->
563− -- | Result
564− m a
565−req' method url body options m = do
566− config <- getHttpConfig
388+-- > print (responseBody response :: Value)
389+
390+req
391+ :: forall m method body response scheme.
392+ ( MonadHttp m
393+ , HttpMethod method
394+ , HttpBody body
395+ , HttpResponse response
396+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
397+ => method -- ^ HTTP method
398+ -> Url scheme -- ^ 'Url'—location of resource
399+ -> body -- ^ Body of the request
400+ -> Proxy response -- ^ A hint how to interpret response
401+ -> Option scheme -- ^ Collection of optional parameters
402+ -> m response -- ^ Response
403+req method url body Proxy options = do
404+ config <- getHttpConfig
405+ manager <- liftIO (readIORef globalManager)
567406 let -- NOTE First appearance of any given header wins. This allows to
568407 -- “overwrite” headers when we construct a request by cons-ing.
569408 nubHeaders = Endo $ \x ->
570− x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
571− request' =
572− flip appEndo L.defaultRequest $
573− -- NOTE The order of 'mappend's matters, here method is overwritten
574− -- first and 'options' take effect last. In particular, this means
575− -- that 'options' can overwrite things set by other request
576− -- components, which is useful for setting port number,
577− -- "Content-Type" header, etc.
578− nubHeaders
579− <> getRequestMod options
580− <> getRequestMod config
581− <> getRequestMod (Tagged body :: Tagged "body" body)
582− <> getRequestMod url
583− <> getRequestMod (Tagged method :: Tagged "method" method)
409+ x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
410+ request' = flip appEndo L.defaultRequest $
411+ -- NOTE The order of 'mappend's matters, here method is overwritten
412+ -- first and 'options' take effect last. In particular, this means
413+ -- that 'options' can overwrite things set by other request
414+ -- components, which is useful for setting port number,
415+ -- "Content-Type" header, etc.
416+ nubHeaders <>
417+ getRequestMod options <>
418+ getRequestMod config <>
419+ getRequestMod (Womb body :: Womb "body" body) <>
420+ getRequestMod url <>
421+ getRequestMod (Womb method :: Womb "method" method)
422+ wrappingVanilla m = catch m (throwIO . VanillaHttpException)
584423 request <- finalizeRequest options request'
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
424+ (liftIO . try . wrappingVanilla) (getHttpResponse request manager)
425+ >>= either handleHttpException return
592426
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'.
427+-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
428+-- settings, so users don't need to deal with this manager stuff at all, but
429+-- when we create a request, instance 'HttpConfig' can affect the default
430+-- settings via 'getHttpConfig'.
597431--
598432-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
599433-- The value of 'globalManager' is named and lives on top level. This means
@@ -601,20 +435,24 @@ withReqManager m = m globalManager
601435-- manager. From that moment on the 'IORef' will be just reused—exactly the
602436-- behavior we want here in order to maximize connection sharing. GHC could
603437-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
438+
439+globalManager :: IORef L.Manager
605440globalManager = unsafePerformIO $ do
606441 context <- NC.initConnectionContext
607− let settings =
608− L.mkManagerSettingsContext
609− (Just context)
610− def
611− Nothing
442+ let settings = L.mkManagerSettingsContext (Just context) def Nothing
612443 manager <- L.newManager settings
613− return manager
444+ newIORef manager
614445{-# NOINLINE globalManager #-}
615446
447+-- | Perform an action using global implicit 'L.Manager' that the rest of
448+-- the library uses. This allows to reuse connections that the 'L.Manager'
449+-- controls.
450+
451+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
452+withReqManager m = liftIO (readIORef globalManager) >>= m
453+
616454----------------------------------------------------------------------------
617−-- Embedding requests in your monad
455+-- Embedding requests into your monad
618456
619457-- $embedding-requests
620458--
@@ -623,267 +461,78 @@ globalManager = unsafePerformIO $ do
623461--
624462-- When writing a library, keep your API polymorphic in terms of
625463-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
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).
464+-- Another option is to use @newtype@ wrapped monad stack and define
465+-- 'MonadHttp' for it.
629466
630467-- | A type class for monads that support performing HTTP requests.
631468-- Typically, you only need to define the 'handleHttpException' method
632469-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
470+
471+class MonadIO m => MonadHttp m where
472+
473+ {-# MINIMAL handleHttpException #-}
474+
634475 -- | This method describes how to deal with 'HttpException' that was
635476 -- caught by the library. One option is to re-throw it if you are OK with
636477 -- exceptions, but if you prefer working with something like
637478 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
638479 -- 'Control.Monad.Except.throwError'.
480+
639481 handleHttpException :: HttpException -> m a
640482
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.
483+ -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
484+ -- implementation returns its 'def' value, which is described in the
485+ -- documentation for the type. Common usage pattern with manually defined
486+ -- 'getHttpConfig' is to return some hard-coded value, or value extracted
487+ -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
488+ -- configuration is desirable.
489+
647490 getHttpConfig :: m HttpConfig
648− getHttpConfig = return defaultHttpConfig
491+ getHttpConfig = return def
492+
493+-- | 'HttpConfig' contains general and default settings to be used when
494+-- making HTTP requests.
649495
650−-- | 'HttpConfig' contains settings to be used when making HTTP requests.
651496data HttpConfig = HttpConfig
652− { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
497+ { httpConfigProxy :: Maybe L.Proxy
498+ -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
653499 -- environment variables are respected, this setting overwrites them.
654500 -- Default value: 'Nothing'.
655− httpConfigProxy :: Maybe L.Proxy,
656− -- | How many redirects to follow when getting a resource. Default
501+ , httpConfigRedirectCount :: Int
502+ -- ^ How many redirects to follow when getting a resource. Default
657503 -- value: 10.
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/.
683− --
684− -- @since 0.3.0
685− httpConfigCheckResponse ::
686− forall b.
687− L.Request ->
688− L.Response b ->
689− ByteString ->
690− Maybe L.HttpExceptionContent,
691− -- | The retry policy to use for request retrying. By default 'def' is
692− -- used (see 'RetryPolicyM').
693− --
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− --
697− -- @since 0.3.0
698− httpConfigRetryPolicy :: RetryPolicyM IO,
699− -- | The function is used to decide whether to retry a request. 'True'
700− -- means that the request should be retried.
701− --
702− -- __Note__: signature of this function was changed in the version
703− -- /1.0.0/.
704− --
705− -- @since 0.3.0
706− httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
707− -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
708− -- retry requests that resulted in an exception. By default it retries
709− -- on response timeout and connection timeout (changed in version
710− -- /3.8.0/).
711− --
712− -- @since 3.4.0
713− httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714− -- | Max length of preview fragment of response body.
715− --
716− -- @since 3.6.0
717− httpConfigBodyPreviewLength :: forall a. (Num a) => a
718− }
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
752− }
753− where
754− statusCode = Y.statusCode . L.responseStatus
504+ , httpConfigAltManager :: Maybe L.Manager
505+ -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
506+ -- that default implicit manager will be used (that's what you want in
507+ -- 99% of cases).
508+ , httpConfigCheckResponse :: L.Request -> L.Response L.BodyReader -> IO ()
509+ -- ^ Function to check the response immediately after receiving the
510+ -- status and headers. This is used for throwing exceptions on
511+ -- non-success status codes by default (set to @\\_ _ -> return ()@ if
512+ -- this behavior is not desirable). Throwing is better then just
513+ -- returning a request with non-2xx status code because in that case
514+ -- something is wrong and we need a way to short-cut execution. The
515+ -- thrown exception is caught by the library though and is available in
516+ -- 'handleHttpException'.
517+ } deriving Typeable
518+
519+instance Default HttpConfig where
520+ def = HttpConfig
521+ { httpConfigProxy = Nothing
522+ , httpConfigRedirectCount = 10
523+ , httpConfigAltManager = Nothing
524+ , httpConfigCheckResponse = \_ response ->
525+ let Y.Status statusCode _ = L.responseStatus response in
526+ unless (200 <= statusCode && statusCode < 300) $ do
527+ chunk <- BL.toStrict <$> L.brReadSome (L.responseBody response) 1024
528+ LI.throwHttp (L.StatusCodeException (void response) chunk) }
755529
756530instance RequestComponent HttpConfig where
757531 getRequestMod HttpConfig {..} = Endo $ \x ->
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)
532+ x { L.proxy = httpConfigProxy
533+ , L.redirectCount = httpConfigRedirectCount
534+ , LI.requestManagerOverride = httpConfigAltManager
535+ , LI.checkResponse = httpConfigCheckResponse }
887536
888537----------------------------------------------------------------------------
889538-- Request—Method
@@ -898,6 +547,7 @@ runReq config (Req m) = liftIO (runReaderT m config)
898547-- define a new method that will works seamlessly, see 'HttpMethod'.
899548
900549-- | 'GET' method.
550+
901551data GET = GET
902552
903553instance HttpMethod GET where
@@ -905,6 +555,7 @@ instance HttpMethod GET where
905555 httpMethodName Proxy = Y.methodGet
906556
907557-- | 'POST' method.
558+
908559data POST = POST
909560
910561instance HttpMethod POST where
@@ -912,6 +563,7 @@ instance HttpMethod POST where
912563 httpMethodName Proxy = Y.methodPost
913564
914565-- | 'HEAD' method.
566+
915567data HEAD = HEAD
916568
917569instance HttpMethod HEAD where
@@ -919,24 +571,26 @@ instance HttpMethod HEAD where
919571 httpMethodName Proxy = Y.methodHead
920572
921573-- | 'PUT' method.
574+
922575data PUT = PUT
923576
924577instance HttpMethod PUT where
925578 type AllowsBody PUT = 'CanHaveBody
926579 httpMethodName Proxy = Y.methodPut
927580
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.
581+-- | 'DELETE' method. This data type does not allow having request body with
582+-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
583+-- requests to have bodies, in that case define your own variation of
584+-- 'DELETE' method and allow it to have a body.
585+
933586data DELETE = DELETE
934587
935588instance HttpMethod DELETE where
936− type AllowsBody DELETE = 'CanHaveBody
589+ type AllowsBody DELETE = 'NoBody
937590 httpMethodName Proxy = Y.methodDelete
938591
939592-- | 'TRACE' method.
593+
940594data TRACE = TRACE
941595
942596instance HttpMethod TRACE where
@@ -944,6 +598,7 @@ instance HttpMethod TRACE where
944598 httpMethodName Proxy = Y.methodTrace
945599
946600-- | 'CONNECT' method.
601+
947602data CONNECT = CONNECT
948603
949604instance HttpMethod CONNECT where
@@ -951,6 +606,7 @@ instance HttpMethod CONNECT where
951606 httpMethodName Proxy = Y.methodConnect
952607
953608-- | 'OPTIONS' method.
609+
954610data OPTIONS = OPTIONS
955611
956612instance HttpMethod OPTIONS where
@@ -958,6 +614,7 @@ instance HttpMethod OPTIONS where
958614 httpMethodName Proxy = Y.methodOptions
959615
960616-- | 'PATCH' method.
617+
961618data PATCH = PATCH
962619
963620instance HttpMethod PATCH where
@@ -965,26 +622,30 @@ instance HttpMethod PATCH where
965622 httpMethodName Proxy = Y.methodPatch
966623
967624-- | A type class for types that can be used as an HTTP method. To define a
968−-- non-standard method, follow this example that defines @COPY@:
625+-- non-standard method, follow this example that defines COPY:
969626--
970627-- > data COPY = COPY
971628-- >
972629-- > instance HttpMethod COPY where
973630-- > type AllowsBody COPY = 'CanHaveBody
974631-- > httpMethodName Proxy = "COPY"
632+
975633class HttpMethod a where
634+
976635 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
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.
636+ -- tells the rest of the library whether the method can have a body or
637+ -- not. We use the special type 'CanHaveBody' “lifted” to kind level
638+ -- instead of 'Bool' to get more user-friendly compiler messages.
639+
980640 type AllowsBody a :: CanHaveBody
981641
982642 -- | Return name of the method as a 'ByteString'.
643+
983644 httpMethodName :: Proxy a -> ByteString
984645
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
646+instance HttpMethod method => RequestComponent (Womb "method" method) where
986647 getRequestMod _ = Endo $ \x ->
987− x {L.method = httpMethodName (Proxy :: Proxy method)}
648+ x { L.method = httpMethodName (Proxy :: Proxy method) }
988649
989650----------------------------------------------------------------------------
990651-- Request—URL
@@ -992,7 +653,7 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
992653-- $url
993654--
994655-- We use 'Url's which are correct by construction, see 'Url'. To build a
995−-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
656+-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
996657
997658-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
998659-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -1022,194 +683,91 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1022683--
1023684-- > https "юникод.рф"
1024685-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
686+
1025687data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026688 -- NOTE The second value is the path segments in reversed order.
1027− deriving (Eq, Ord, Show, Data, Generic)
1028−
1029−type role Url nominal
1030−
1031−-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1032−-- the derived lift forgets the type of the scheme.
1033−instance (Typeable scheme) => TH.Lift (Url scheme) where
1034− lift url =
1035− TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036− Url Http _ -> [t|Url 'Http|]
1037− Url Https _ -> [t|Url 'Https|]
1038− where
1039− liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040− liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
1041−
1042−-- | Given host name, produce a 'Url' which has “http” as its scheme and
689+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
690+
691+-- | Given host name, produce a 'Url' which have “http” as its scheme and
1043692-- empty path. This also sets port to @80@.
693+
1044694http :: Text -> Url 'Http
1045695http = Url Http . pure
1046696
1047−-- | Given host name, produce a 'Url' which has “https” as its scheme and
697+-- | Given host name, produce a 'Url' which have “https” as its scheme and
1048698-- empty path. This also sets port to @443@.
699+
1049700https :: Text -> Url 'Https
1050701https = Url Https . pure
1051702
1052−-- | Grow a given 'Url' appending a single path segment to it. Note that the
703+-- | Grow given 'Url' appending a single path segment to it. Note that the
1053704-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1054−infixl 5 /~
1055705
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
706+infixl 5 /~
707+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057708Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1058709
1059−-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060−-- when next URL piece is a 'Data.Text.Text' literal.
1061−infixl 5 /:
710+-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
711+-- when next URL piece is a 'Text' literal.
1062712
713+infixl 5 /:
1063714(/:) :: Url scheme -> Text -> Url scheme
1064715(/:) = (/~)
1065716
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'')
717+-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
718+-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
719+-- you are given a URL to query dynamically and don't know it beforehand.
720+-- The function parses 'ByteString' because it's the correct type to
721+-- represent a URL, as 'Url' cannot contain characters outside of ASCII
722+-- range, thus we can consider every character a 'Data.Word.Word8' value.
723+--
724+-- This function only parses 'Url' (scheme, host, path) and optional query
725+-- parameters that are returned as 'Option'. It does not parse method name
726+-- or authentication info from given 'ByteString'.
727+
728+parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
729+parseUrlHttp url' = do
730+ url <- B.stripPrefix "http://" url'
731+ (host :| path, option) <- parseUrlHelper url
732+ return (foldl (/:) (http host) path, option)
733+
734+-- | Just like 'parseUrlHttp', but expects “https” scheme.
735+
736+parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
737+parseUrlHttps url' = do
738+ url <- B.stripPrefix "https://" url'
739+ (host :| path, option) <- parseUrlHelper url
740+ return (foldl (/:) (https host) path, option)
741+
742+-- | Get host\/collection of path pieces and possibly query parameters
743+-- already converted to 'Option'. This function is not public.
744+
745+parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
746+parseUrlHelper url = do
747+ let (path', query') = B.break (== 0x3f) url
748+ query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
749+ p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
750+ (p, port') <-
751+ case T.break (== ':') p' of
752+ (x, "") -> return (x, mempty)
753+ (x, prt) ->
754+ case TR.decimal (T.drop 1 prt) of
755+ Right (prt',"") -> return (x, port prt')
756+ _ -> Nothing
757+ return (p :| ps, query <> port')
1198758
1199759instance RequestComponent (Url scheme) where
1200760 getRequestMod (Url scheme segments) = Endo $ \x ->
1201− let (host :| path) = NE.reverse segments
1202− in x
1203− { L.secure = case scheme of
1204− Http -> False
1205− Https -> True,
1206− L.port = case scheme of
1207− Http -> 80
1208− Https -> 443,
1209− L.host = Y.urlEncode False (T.encodeUtf8 host),
1210− L.path =
1211− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
1212− }
761+ let (host :| path) = NE.reverse segments in
762+ x { L.secure = case scheme of
763+ Http -> False
764+ Https -> True
765+ , L.port = case scheme of
766+ Http -> 80
767+ Https -> 443
768+ , L.host = Y.urlEncode False (T.encodeUtf8 host)
769+ , L.path =
770+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1213771
1214772----------------------------------------------------------------------------
1215773-- Request—Body
@@ -1218,37 +776,39 @@ instance RequestComponent (Url scheme) where
1218776--
1219777-- A number of options for request bodies are available. The @Content-Type@
1220778-- header is set for you automatically according to the body option you use
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'.
779+-- (it's always specified in documentation for a given body option). To add
780+-- your own way to represent request body, see 'HttpBody'.
1224781
1225782-- | This data type represents empty body of an HTTP request. This is the
1226783-- data type to use with 'HttpMethod's that cannot have a body, as it's the
1227784-- only type for which 'ProvidesBody' returns 'NoBody'.
1228785--
1229786-- Using of this body option does not set the @Content-Type@ header.
787+
1230788data NoReqBody = NoReqBody
1231789
1232790instance HttpBody NoReqBody where
1233791 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1234792
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.
793+-- | This body option allows to use a JSON object as request body—probably
794+-- the most popular format right now. Just wrap a data type that is an
795+-- instance of 'ToJSON' type class and you are done: it will be converted to
796+-- JSON and inserted as request body.
1239797--
1240798-- This body option sets the @Content-Type@ header to @\"application/json;
1241799-- charset=utf-8\"@ value.
800+
1242801newtype ReqBodyJson a = ReqBodyJson a
1243802
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
803+instance ToJSON a => HttpBody (ReqBodyJson a) where
1245804 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1246805 getRequestContentType _ = pure "application/json; charset=utf-8"
1247806
1248807-- | This body option streams request body from a file. It is expected that
1249−-- the file size does not change during streaming.
808+-- the file size does not change during the streaming.
1250809--
1251810-- Using of this body option does not set the @Content-Type@ header.
811+
1252812newtype ReqBodyFile = ReqBodyFile FilePath
1253813
1254814instance HttpBody ReqBodyFile where
@@ -1258,6 +818,7 @@ instance HttpBody ReqBodyFile where
1258818-- | HTTP request body represented by a strict 'ByteString'.
1259819--
1260820-- Using of this body option does not set the @Content-Type@ header.
821+
1261822newtype ReqBodyBs = ReqBodyBs ByteString
1262823
1263824instance HttpBody ReqBodyBs where
@@ -1266,19 +827,22 @@ instance HttpBody ReqBodyBs where
1266827-- | HTTP request body represented by a lazy 'BL.ByteString'.
1267828--
1268829-- Using of this body option does not set the @Content-Type@ header.
830+
1269831newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1270832
1271833instance HttpBody ReqBodyLbs where
1272834 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1273835
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'.
836+-- | Form URL-encoded body. This can hold a collection of parameters which
837+-- are encoded similarly to query parameters at the end of query string,
838+-- with the only difference that they are stored in request body. The
839+-- similarity is reflected in the API as well, as you can use the same
840+-- combinators you would use to add query parameters: @('=:')@ and
841+-- 'queryFlag'.
1279842--
1280843-- This body option sets the @Content-Type@ header to
1281−-- @\"application/x-www-form-urlencoded\"@ value.
844+-- @\"application/x-www-from-urlencoded\"@ value.
845+
1282846newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
1283847
1284848instance HttpBody ReqBodyUrlEnc where
@@ -1288,37 +852,33 @@ instance HttpBody ReqBodyUrlEnc where
1288852
1289853-- | An opaque monoidal value that allows to collect URL-encoded parameters
1290854-- to be wrapped in 'ReqBodyUrlEnc'.
855+
1291856newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
1292857 deriving (Semigroup, Monoid)
1293858
1294859instance QueryParam FormUrlEncodedParam where
1295860 queryParam name mvalue =
1296861 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
1304862
1305863-- | Multipart form data. Please consult the
1306864-- "Network.HTTP.Client.MultipartFormData" module for how to construct
1307865-- parts, then use 'reqBodyMultipart' to create actual request body from the
1308−-- parts. 'reqBodyMultipart' is the only way to get a value of the type
866+-- parts. 'reqBodyMultipart' is the only way to get a value of type
1309867-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
1310868--
1311869-- @since 0.2.0
1312870--
1313−-- ==== __Examples__
871+-- ==== __Example__
1314872--
1315−-- > import Control.Monad.IO.Class
1316−-- > import Data.Default.Class
1317−-- > import Network.HTTP.Req
873+-- > import Control.Exception (throwIO)
1318874-- > import qualified Network.HTTP.Client.MultipartFormData as LM
875+-- > import Network.HTTP.Req
876+-- >
877+-- > instance MonadHttp IO where
878+-- > handleHttpException = throwIO
1319879-- >
1320880-- > main :: IO ()
1321−-- > main = runReq def $ do
881+-- > main = do
1322882-- > body <-
1323883-- > reqBodyMultipart
1324884-- > [ LM.partBS "title" "My Image"
@@ -1329,7 +889,8 @@ instance FromForm FormUrlEncodedParam where
1329889-- > body
1330890-- > bsResponse
1331891-- > mempty
1332−-- > liftIO $ print (responseBody response)
892+-- > print $ responseBody response
893+
1333894data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
1334895
1335896instance HttpBody ReqBodyMultipart where
@@ -1340,117 +901,126 @@ instance HttpBody ReqBodyMultipart where
1340901-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1341902--
1342903-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
904+
905+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1344906reqBodyMultipart parts = liftIO $ do
1345907 boundary <- LM.webkitBoundary
1346− body <- LM.renderParts boundary parts
908+ body <- LM.renderParts boundary parts
1347909 return (ReqBodyMultipart boundary body)
1348910
1349911-- | A type class for things that can be interpreted as an HTTP
1350912-- 'L.RequestBody'.
913+
1351914class HttpBody body where
915+
916+ {-# MINIMAL getRequestBody #-}
917+
1352918 -- | How to get actual 'L.RequestBody'.
919+
1353920 getRequestBody :: body -> L.RequestBody
1354921
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.
922+ -- | This method allows to optionally specify value of @Content-Type@
923+ -- header that should be used with particular body option. By default it
924+ -- returns 'Nothing' and so @Content-Type@ is not set.
925+
1358926 getRequestContentType :: body -> Maybe ByteString
1359927 getRequestContentType = const Nothing
1360928
1361929-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1362−-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1363−-- with 'GET' method and other methods that should not have body.
930+-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
931+-- 'GET' method and other methods that should not send a body.
932+
1364933type family ProvidesBody body :: CanHaveBody where
1365934 ProvidesBody NoReqBody = 'NoBody
1366− ProvidesBody body = 'CanHaveBody
935+ ProvidesBody body = 'CanHaveBody
1367936
1368937-- | This type function allows any HTTP body if method says it
1369938-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
1370939-- body option to use is 'NoReqBody'.
1371−type family
1372− HttpBodyAllowed
1373− (allowsBody :: CanHaveBody)
1374− (providesBody :: CanHaveBody) ::
1375− Constraint
1376− where
1377− HttpBodyAllowed 'NoBody 'NoBody = ()
1378− HttpBodyAllowed 'CanHaveBody body = ()
1379− HttpBodyAllowed 'NoBody 'CanHaveBody =
1380− TypeError
1381− ('Text "This HTTP method does not allow attaching a request body.")
1382−
1383−instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384− getRequestMod (Tagged body) = Endo $ \x ->
1385− x
1386− { L.requestBody = getRequestBody body,
1387− L.requestHeaders =
1388− let old = L.requestHeaders x
1389− in case getRequestContentType body of
1390− Nothing -> old
1391− Just contentType ->
1392− (Y.hContentType, contentType) : old
1393− }
940+--
941+-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
942+-- error message when method does not allow a body and body is provided.
943+
944+type family HttpBodyAllowed
945+ (allowsBody :: CanHaveBody)
946+ (providesBody :: CanHaveBody) :: Constraint where
947+ HttpBodyAllowed 'NoBody 'NoBody = ()
948+ HttpBodyAllowed 'CanHaveBody body = ()
949+#if MIN_VERSION_base(4,9,0)
950+ HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
951+ ('Text "This HTTP method does not allow attaching a request body.")
952+#endif
953+
954+instance HttpBody body => RequestComponent (Womb "body" body) where
955+ getRequestMod (Womb body) = Endo $ \x ->
956+ x { L.requestBody = getRequestBody body
957+ , L.requestHeaders =
958+ let old = L.requestHeaders x in
959+ case getRequestContentType body of
960+ Nothing -> old
961+ Just contentType ->
962+ (Y.hContentType, contentType) : old }
1394963
1395964----------------------------------------------------------------------------
1396965-- Request—Optional parameters
1397966
1398967-- $optional-parameters
1399968--
1400−-- Optional parameters of request include things like query parameters,
969+-- Optional parameters to a request include things like query parameters,
1401970-- headers, port number, etc. All optional parameters have the type
1402971-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
1403972-- the last argument of 'req' to specify no optional parameters, or combine
1404−-- 'Option's using 'mappend' or @('<>')@ to have several of them at once.
973+-- 'Option's using 'mappend' (or @('<>')@) to have several of them at once.
1405974
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))
975+-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
976+-- optional parameters like query parameters and headers. See sections below
977+-- to learn which 'Option' primitives are available.
1411978
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.
979+data Option (scheme :: Scheme) =
980+ Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
981+ -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
982+ -- Request to avoid appending to existing query string in request every
983+ -- time new parameter is added. Additional Maybe (L.Request -> IO
984+ -- L.Request) is a finalizer that will be applied after all other
985+ -- transformations. This is for authentication methods that sign requests
986+ -- based on data in Request.
1418987
1419988instance Semigroup (Option scheme) where
1420− Option er0 mr0 <> Option er1 mr1 =
1421− Option
1422− (er0 <> er1)
1423− (mr0 <|> mr1)
989+ Option er0 mr0 <> Option er1 mr1 = Option
990+ (er0 <> er1) (mr0 <|> mr1)
1424991
1425992instance Monoid (Option scheme) where
1426− mempty = Option mempty Nothing
993+ mempty = Option mempty Nothing
1427994 mappend = (<>)
1428995
1429−-- | Use 'formToQuery'.
1430−--
1431−-- @since 3.11.0
1432−instance FromForm (Option scheme) where
1433− fromForm = Right . formToQuery
1434−
1435996-- | A helper to create an 'Option' that modifies only collection of query
1436997-- parameters. This helper is not a part of the public API.
998+
1437999withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
14381000withQueryParams f = Option (Endo (first f)) Nothing
14391001
14401002-- | A helper to create an 'Option' that modifies only 'L.Request'. This
14411003-- helper is not a part of public API.
1004+
14421005withRequest :: (L.Request -> L.Request) -> Option scheme
14431006withRequest f = Option (Endo (second f)) Nothing
14441007
1008+-- | A helper to create an 'Option' that adds a finalizer (request
1009+-- transformation that is applied after all other modifications).
1010+
1011+asFinalizer :: (L.Request -> IO L.Request) -> Option scheme
1012+asFinalizer = Option mempty . pure
1013+
14451014instance RequestComponent (Option scheme) where
14461015 getRequestMod (Option f _) = Endo $ \x ->
14471016 let (qparams, x') = appEndo f ([], x)
1448− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449− in x' {L.queryString = query}
1017+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1018+ in x' { L.queryString = query }
14501019
14511020-- | Finalize given 'L.Request' by applying a finalizer from the given
14521021-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1022+
1023+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
14541024finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14551025
14561026----------------------------------------------------------------------------
@@ -1463,67 +1033,47 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14631033-- bodies (of the type 'FormUrlEncodedParam').
14641034
14651035-- | This operator builds a query parameter that will be included in URL of
1466−-- your request after the question sign @?@. This is the same syntax you use
1036+-- your request after question sign @?@. This is the same syntax you use
14671037-- with form URL encoded request bodies.
14681038--
14691039-- This operator is defined in terms of 'queryParam':
14701040--
14711041-- > name =: value = queryParam name (pure value)
1472−infix 7 =:
14731042
1043+infix 7 =:
14741044(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
14751045name =: value = queryParam name (pure value)
14761046
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:
1047+-- | Construct a flag, that is, valueless query parameter. For example, in
1048+-- the following URL @a@ is a flag, while @b@ is a query parameter with a
1049+-- value:
14801050--
14811051-- > https://httpbin.org/foo/bar?a&b=10
14821052--
14831053-- This operator is defined in terms of 'queryParam':
14841054--
14851055-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486−queryFlag :: (QueryParam param) => Text -> param
1487−queryFlag name = queryParam name (Nothing :: Maybe ())
14881056
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
1057+queryFlag :: QueryParam param => Text -> param
1058+queryFlag name = queryParam name (Nothing :: Maybe ())
15061059
15071060-- | A type class for query-parameter-like things. The reason to have an
15081061-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
15091062-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
15101063-- Having the same syntax for these cases seems natural and user-friendly.
1064+
15111065class QueryParam param where
1066+
15121067 -- | Create a query parameter with given name and value. If value is
15131068 -- 'Nothing', it won't be included at all (i.e. you create a flag this
15141069 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
15151070 -- method, because they are easier to read.
1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
15171071
1518− -- | Get the query parameter names and values set by 'queryParam'.
1519− --
1520− -- @since 3.11.0
1521− queryParamToList :: param -> [(Text, Maybe Text)]
1072+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param
15221073
15231074instance QueryParam (Option scheme) where
15241075 queryParam name mvalue =
15251076 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
15271077
15281078----------------------------------------------------------------------------
15291079-- Request—Optional parameters—Headers
@@ -1532,28 +1082,19 @@ instance QueryParam (Option scheme) where
15321082-- headers with the same names the leftmost header will win. This means, in
15331083-- particular, that you cannot create a request with several headers of the
15341084-- same name.
1535−header ::
1536− -- | Header name
1537− ByteString ->
1538− -- | Header value
1539− ByteString ->
1540− Option scheme
1085+
1086+header
1087+ :: ByteString -- ^ Header name
1088+ -> ByteString -- ^ Header value
1089+ -> Option scheme
15411090header name value = withRequest (attachHeader name value)
15421091
1543−-- | Attach a header with given name and content to a 'L.Request'.
1544−--
1545−-- @since 1.1.0
1092+-- | A non-public helper that attaches a header with given name and content
1093+-- to a 'L.Request'.
1094+
15461095attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15471096attachHeader name value x =
1548− x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1549−
1550−-- | Same as 'header', but with redacted values on print.
1551−--
1552−-- @since 3.13.0
1553−headerRedacted :: ByteString -> ByteString -> Option scheme
1554−headerRedacted name value = withRequest $ \x ->
1555− let y = attachHeader name value x
1556− in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
1097+ x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
15571098
15581099----------------------------------------------------------------------------
15591100-- Request—Optional parameters—Cookies
@@ -1566,9 +1107,10 @@ headerRedacted name value = withRequest $ \x ->
15661107
15671108-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
15681109-- 'L.Response' record.
1110+
15691111cookieJar :: L.CookieJar -> Option scheme
15701112cookieJar jar = withRequest $ \x ->
1571− x {L.cookieJar = Just jar}
1113+ x { L.cookieJar = Just jar }
15721114
15731115----------------------------------------------------------------------------
15741116-- Request—Optional parameters—Authentication
@@ -1586,66 +1128,30 @@ cookieJar jar = withRequest $ \x ->
15861128-- | The 'Option' adds basic authentication.
15871129--
15881130-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1589−basicAuth ::
1590− -- | Username
1591− ByteString ->
1592− -- | Password
1593− ByteString ->
1594− -- | Auth 'Option'
1595− Option 'Https
1596−basicAuth = basicAuthUnsafe
1597−
1598−-- | An alternative to 'basicAuth' which works for any scheme. Note that
1599−-- using basic access authentication without SSL\/TLS is vulnerable to
1600−-- attacks. Use 'basicAuth' instead unless you know what you are doing.
1601−--
1602−-- @since 0.3.1
1603−basicAuthUnsafe ::
1604− -- | Username
1605− ByteString ->
1606− -- | Password
1607− ByteString ->
1608− -- | Auth 'Option'
1609− Option scheme
1610−basicAuthUnsafe username password =
1611− customAuth
1612− (pure . L.applyBasicAuth username password)
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)
1131+
1132+basicAuth
1133+ :: ByteString -- ^ Username
1134+ -> ByteString -- ^ Password
1135+ -> Option 'Https -- ^ Auth 'Option'
1136+basicAuth username password = asFinalizer
1137+ (pure . L.applyBasicAuth username password)
16261138
16271139-- | The 'Option' adds OAuth1 authentication.
16281140--
16291141-- @since 0.2.0
1630−oAuth1 ::
1631− -- | Consumer token
1632− ByteString ->
1633− -- | Consumer secret
1634− ByteString ->
1635− -- | OAuth token
1636− ByteString ->
1637− -- | OAuth token secret
1638− ByteString ->
1639− -- | Auth 'Option'
1640− Option scheme
1142+
1143+oAuth1
1144+ :: ByteString -- ^ Consumer token
1145+ -> ByteString -- ^ Consumer secret
1146+ -> ByteString -- ^ OAuth token
1147+ -> ByteString -- ^ OAuth token secret
1148+ -> Option scheme -- ^ Auth 'Option'
16411149oAuth1 consumerToken consumerSecret token tokenSecret =
1642− customAuth (OAuth.signOAuth app creds)
1150+ asFinalizer (OAuth.signOAuth app creds)
16431151 where
1644− app =
1645− OAuth.newOAuth
1646− { OAuth.oauthConsumerKey = consumerToken,
1647− OAuth.oauthConsumerSecret = consumerSecret
1648− }
1152+ app = OAuth.newOAuth
1153+ { OAuth.oauthConsumerKey = consumerToken
1154+ , OAuth.oauthConsumerSecret = consumerSecret }
16491155 creds = OAuth.newCredential token tokenSecret
16501156
16511157-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1656,14 +1162,12 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
16561162-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
16571163--
16581164-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1659−oAuth2Bearer ::
1660− -- | Token
1661− ByteString ->
1662− -- | Auth 'Option'
1663− Option 'Https
1664−oAuth2Bearer token =
1665− customAuth
1666− (pure . attachHeader "Authorization" ("Bearer " <> token))
1165+
1166+oAuth2Bearer
1167+ :: ByteString -- ^ Token
1168+ -> Option 'Https -- ^ Auth 'Option'
1169+oAuth2Bearer token = asFinalizer
1170+ (pure . attachHeader "Authorization" ("Bearer " <> token))
16671171
16681172-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
16691173-- to be used only by GitHub). This will be treated by whatever services
@@ -1674,35 +1178,26 @@ oAuth2Bearer token =
16741178-- > oAuth2Token token = header "Authorization" ("token" <> token)
16751179--
16761180-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1677−oAuth2Token ::
1678− -- | Token
1679− ByteString ->
1680− -- | Auth 'Option'
1681− Option 'Https
1682−oAuth2Token token =
1683− customAuth
1684− (pure . attachHeader "Authorization" ("token " <> token))
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
1181+
1182+oAuth2Token
1183+ :: ByteString -- ^ Token
1184+ -> Option 'Https -- ^ Auth 'Option'
1185+oAuth2Token token = asFinalizer
1186+ (pure . attachHeader "Authorization" ("token " <> token))
16931187
16941188----------------------------------------------------------------------------
16951189-- Request—Optional parameters—Other
16961190
16971191-- | Specify the port to connect to explicitly. Normally, 'Url' you use
16981192-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1699−-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1193+-- 'Option' allows to choose arbitrary port overwriting the defaults.
1194+
17001195port :: Int -> Option scheme
17011196port n = withRequest $ \x ->
1702− x {L.port = n}
1197+ x { L.port = n }
17031198
17041199-- | This 'Option' controls whether gzipped data should be decompressed on
1705−-- the fly. By default everything except for @\"application\/x-tar\"@ is
1200+-- the fly. By default everything except for @application\/x-tar@ is
17061201-- decompressed, i.e. we have:
17071202--
17081203-- > decompress (/= "application/x-tar")
@@ -1710,272 +1205,207 @@ port n = withRequest $ \x ->
17101205-- You can also choose to decompress everything like this:
17111206--
17121207-- > decompress (const True)
1713−decompress ::
1714− -- | Predicate that is given MIME type, it returns 'True' when content
1715− -- should be decompressed on the fly.
1716− (ByteString -> Bool) ->
1717− Option scheme
1208+
1209+decompress
1210+ :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1211+ -- returns 'True' when content should be decompressed on the fly.
1212+ -> Option scheme
17181213decompress f = withRequest $ \x ->
1719− x {L.decompress = f}
1214+ x { L.decompress = f }
17201215
17211216-- | Specify the number of microseconds to wait for response. The default
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
1217+-- value is 30 seconds.
1218+
1219+responseTimeout
1220+ :: Int -- ^ Number of microseconds to wait
1221+ -> Option scheme
17281222responseTimeout n = withRequest $ \x ->
1729− x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1223+ x { L.responseTimeout = LI.ResponseTimeoutMicro n }
17301224
17311225-- | HTTP version to send to the server, the default is HTTP 1.1.
1732−httpVersion ::
1733− -- | Major version number
1734− Int ->
1735− -- | Minor version number
1736− Int ->
1737− Option scheme
1226+
1227+httpVersion
1228+ :: Int -- ^ Major version number
1229+ -> Int -- ^ Minor version number
1230+ -> Option scheme
17381231httpVersion major minor = withRequest $ \x ->
1739− x {L.requestVersion = Y.HttpVersion major minor}
1232+ x { L.requestVersion = Y.HttpVersion major minor }
17401233
17411234----------------------------------------------------------------------------
17421235-- Response interpretations
17431236
1744−-- | Make a request and ignore the body of the response.
1745−newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746− deriving (Show)
1237+-- | Make a request and ignore body of response.
1238+
1239+data IgnoreResponse = IgnoreResponse (L.Response ())
17471240
17481241instance HttpResponse IgnoreResponse where
17491242 type HttpResponseBody IgnoreResponse = ()
1750− toVanillaResponse (IgnoreResponse r) = r
1751− getHttpResponse r = return $ IgnoreResponse (void r)
1243+ toVanillaResponse (IgnoreResponse response) = response
1244+ getHttpResponse request manager =
1245+ IgnoreResponse <$> liftIO (L.httpNoBody request manager)
17521246
17531247-- | Use this as the fourth argument of 'req' to specify that you want it to
1754−-- ignore the response body.
1248+-- return the 'IgnoreResponse' interpretation.
1249+
17551250ignoreResponse :: Proxy IgnoreResponse
17561251ignoreResponse = Proxy
17571252
1758−-- | Make a request and interpret the body of the response as JSON. The
1253+-- | Make a request and interpret body of response as JSON. The
17591254-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
17601255-- monad in which you use 'req' will determine what to do in the case when
17611256-- parsing fails (the 'JsonHttpException' constructor will be used).
1257+
17621258newtype JsonResponse a = JsonResponse (L.Response a)
1763− deriving (Show)
17641259
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1260+instance FromJSON a => HttpResponse (JsonResponse a) where
17661261 type HttpResponseBody (JsonResponse a) = a
1767− toVanillaResponse (JsonResponse r) = r
1768− getHttpResponse r = do
1769− chunks <- L.brConsume (L.responseBody r)
1770− case A.eitherDecode (BL.fromChunks chunks) of
1262+ toVanillaResponse (JsonResponse response) = response
1263+ getHttpResponse request manager = do
1264+ response <- L.httpLbs request manager
1265+ case A.eitherDecode (L.responseBody response) of
17711266 Left e -> throwIO (JsonHttpException e)
1772− Right x -> return $ JsonResponse (x <$ r)
1773− acceptHeader Proxy = Just "application/json"
1267+ Right x -> return $ JsonResponse response { L.responseBody = x }
17741268
1775−-- | Use this as the fourth argument of 'req' to specify that you want it to
1269+-- | Use this as the forth argument of 'req' to specify that you want it to
17761270-- return the 'JsonResponse' interpretation.
1271+
17771272jsonResponse :: Proxy (JsonResponse a)
17781273jsonResponse = Proxy
17791274
1780−-- | Make a request and interpret the body of the response as a strict
1781−-- 'ByteString'.
1275+-- | Make a request and interpret body of response as a strict 'ByteString'.
1276+
17821277newtype BsResponse = BsResponse (L.Response ByteString)
1783− deriving (Show)
17841278
17851279instance HttpResponse BsResponse where
17861280 type HttpResponseBody BsResponse = ByteString
1787− toVanillaResponse (BsResponse r) = r
1788− getHttpResponse r = do
1789− chunks <- L.brConsume (L.responseBody r)
1790− return $ BsResponse (B.concat chunks <$ r)
1281+ toVanillaResponse (BsResponse response) = response
1282+ getHttpResponse request manager =
1283+ L.withResponse request manager $ \response -> do
1284+ chunks <- L.brConsume (L.responseBody response)
1285+ return $ BsResponse response { L.responseBody = B.concat chunks }
1286+
1287+-- | Use this as the forth argument of 'req' to specify that you want to
1288+-- interpret response body as a strict 'ByteString'.
17911289
1792−-- | Use this as the fourth argument of 'req' to specify that you want to
1793−-- interpret the response body as a strict 'ByteString'.
17941290bsResponse :: Proxy BsResponse
17951291bsResponse = Proxy
17961292
1797−-- | Make a request and interpret the body of the response as a lazy
1293+-- | Make a request and interpret body of response as a lazy
17981294-- 'BL.ByteString'.
1295+
17991296newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800− deriving (Show)
18011297
18021298instance HttpResponse LbsResponse where
18031299 type HttpResponseBody LbsResponse = 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)
1300+ toVanillaResponse (LbsResponse response) = response
1301+ getHttpResponse request manager =
1302+ LbsResponse <$> L.httpLbs request manager
1303+
1304+-- | Use this as the forth argument of 'req' to specify that you want to
1305+-- interpret response body as a lazy 'BL.ByteString'.
18081306
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'.
18111307lbsResponse :: Proxy LbsResponse
18121308lbsResponse = Proxy
18131309
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 [])
1310+-- | This interpretation does not result in any request at all, but you can
1311+-- use the 'responseRequest' function to extract 'L.Request' that 'req' has
1312+-- prepared. This is useful primarily for testing.
1313+--
1314+-- Note that when you use this interpretation inspecting response will
1315+-- diverge (i.e. it'll blow up with an error, don't do that).
1316+
1317+newtype ReturnRequest = ReturnRequest L.Request
1318+
1319+instance HttpResponse ReturnRequest where
1320+ type HttpResponseBody ReturnRequest = ()
1321+ toVanillaResponse (ReturnRequest _) = error
1322+ "Network.HTTP.Req.ReturnRequest interpretation does not make requests"
1323+ getHttpResponse request _ = return (ReturnRequest request)
1324+
1325+-- | Use this as the forth argument of 'req' to specify that you want it to
1326+-- just return the request it consturcted without making any requests.
1327+
1328+returnRequest :: Proxy ReturnRequest
1329+returnRequest = Proxy
18751330
18761331----------------------------------------------------------------------------
18771332-- Inspecting a response
18781333
18791334-- | Get the response body.
1880−responseBody ::
1881− (HttpResponse response) =>
1882− response ->
1883− HttpResponseBody response
1335+
1336+responseBody
1337+ :: HttpResponse response
1338+ => response
1339+ -> HttpResponseBody response
18841340responseBody = L.responseBody . toVanillaResponse
18851341
18861342-- | Get the response status code.
1887−responseStatusCode ::
1888− (HttpResponse response) =>
1889− response ->
1890− Int
1343+
1344+responseStatusCode
1345+ :: HttpResponse response
1346+ => response
1347+ -> Int
18911348responseStatusCode =
18921349 Y.statusCode . L.responseStatus . toVanillaResponse
18931350
18941351-- | Get the response status message.
1895−responseStatusMessage ::
1896− (HttpResponse response) =>
1897− response ->
1898− ByteString
1352+
1353+responseStatusMessage
1354+ :: HttpResponse response
1355+ => response
1356+ -> ByteString
18991357responseStatusMessage =
19001358 Y.statusMessage . L.responseStatus . toVanillaResponse
19011359
19021360-- | Lookup a particular header from a response.
1903−responseHeader ::
1904− (HttpResponse response) =>
1905− -- | Response interpretation
1906− response ->
1907− -- | Header to lookup
1908− ByteString ->
1909− -- | Header value if found
1910− Maybe ByteString
1361+
1362+responseHeader
1363+ :: HttpResponse response
1364+ => response -- ^ Response interpretation
1365+ -> ByteString -- ^ Header to lookup
1366+ -> Maybe ByteString -- ^ Header value if found
19111367responseHeader r h =
19121368 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
19131369
19141370-- | Get the response 'L.CookieJar'.
1915−responseCookieJar ::
1916− (HttpResponse response) =>
1917− response ->
1918− L.CookieJar
1371+
1372+responseCookieJar
1373+ :: HttpResponse response
1374+ => response
1375+ -> L.CookieJar
19191376responseCookieJar = L.responseCookieJar . toVanillaResponse
19201377
1378+-- | Get the original request from 'ReturnRequest' response interpretation.
1379+
1380+responseRequest :: ReturnRequest -> L.Request
1381+responseRequest (ReturnRequest request) = request
1382+
19211383----------------------------------------------------------------------------
19221384-- Response—Defining your own interpretation
19231385
19241386-- $new-response-interpretation
19251387--
19261388-- To create a new response interpretation you just need to make your data
1927−-- type an instance of the 'HttpResponse' type class.
1389+-- type an instance of 'HttpResponse' type class.
1390+
1391+-- | A type class for response interpretations. It allows to fully control
1392+-- how request is made and how its body is parsed.
19281393
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.
19321394class HttpResponse response where
1395+
19331396 -- | The associated type is the type of body that can be extracted from an
19341397 -- instance of 'HttpResponse'.
1935− type HttpResponseBody response :: Type
1398+
1399+ type HttpResponseBody response :: *
19361400
19371401 -- | The method describes how to get the underlying 'L.Response' record.
1402+
19381403 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
19391404
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.
1965− --
1966− -- @since 2.1.0
1967− acceptHeader :: Proxy response -> Maybe ByteString
1968− acceptHeader Proxy = Nothing
1969−
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
1405+ -- | This method describes how to make an HTTP request given 'L.Request'
1406+ -- (prepared by the library) and 'L.Manager'.
1407+
1408+ getHttpResponse :: L.Request -> L.Manager -> IO response
19791409
19801410----------------------------------------------------------------------------
19811411-- Other
@@ -1985,14 +1415,15 @@ instance HttpResponse (L.Response ()) where
19851415-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
19861416-- monoid of endomorphisms under composition, it's used to chain different
19871417-- request components easier using @('<>')@.
1988−--
1989−-- __Note__: this type class is not a part of the public API.
1418+
19901419class RequestComponent a where
1420+
19911421 -- | Get a function that takes a 'L.Request' and changes it somehow
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.
1422+ -- returning another 'L.Request'. For example HTTP method instance of
1423+ -- 'RequestComponent' just overwrites method. The function is wrapped in
1424+ -- 'Endo' so it's easier to chain such “modifying applications” together
1425+ -- building bigger and bigger 'RequestComponent's.
1426+
19961427 getRequestMod :: a -> Endo L.Request
19971428
19981429-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -2002,50 +1433,34 @@ class RequestComponent a where
20021433-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
20031434-- which instance to use (i.e. the constraints are taken into account later,
20041435-- when instance is already chosen).
2005−newtype Tagged (tag :: Symbol) a = Tagged a
1436+
1437+newtype Womb (tag :: Symbol) a = Womb a
20061438
20071439-- | Exceptions that this library throws.
1440+
20081441data HttpException
2009− = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2010− VanillaHttpException L.HttpException
2011− | -- | A wrapper with Aeson-produced 'String' describing why decoding
2012− -- failed
2013− JsonHttpException String
2014− deriving (Show, Generic)
1442+ = VanillaHttpException L.HttpException
1443+ -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1444+ | JsonHttpException String
1445+ -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
1446+ deriving (Show, Typeable, Generic)
20151447
20161448instance Exception HttpException
20171449
2018−-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019−-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2020−--
2021−-- @since 3.12.0
2022−isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023−isStatusCodeException
2024− ( VanillaHttpException
2025− ( L.HttpExceptionRequest
2026− _
2027− (L.StatusCodeException r _)
2028− )
2029− ) = Just r
2030−isStatusCodeException _ = Nothing
2031−
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.
1450+-- | A simple 'Bool'-like type we only have for better error messages. We
1451+-- use it as a kind and its data constructors as type-level tags.
20351452--
20361453-- See also: 'HttpMethod' and 'HttpBody'.
1454+
20371455data CanHaveBody
2038− = -- | Indeed can have a body
2039− CanHaveBody
2040− | -- | Should not have a body
2041− NoBody
1456+ = CanHaveBody -- ^ Indeed can have a body
1457+ | NoBody -- ^ Should not have a body
20421458
20431459-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
20441460-- enabled). This is used to force TLS requirement for some authentication
20451461-- 'Option's.
1462+
20461463data Scheme
2047− = -- | HTTP
2048− Http
2049− | -- | HTTPS
2050− Https
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1464+ = Http -- ^ HTTP
1465+ | Https -- ^ HTTPS
1466+ deriving (Eq, Ord, Show, Data, Typeable, Generic)