@@ -1,282 +1,255 @@
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 Mark Karpov
144-- License : BSD 3 clause
155--
16−-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
6+-- Maintainer : Mark Karpov <markkarpov@openmailbox.org>
177-- Stability : experimental
188-- Portability : portable
199--
20−-- The documentation below is structured in such a way that the most
21−-- 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
23−-- details about less-common things you may want to know about. The
24−-- documentation is written with sufficient coverage of details and
25−-- examples, and it's designed to be a complete tutorial on its own.
10+-- The documentation below is structured in such a way that most important
11+-- information goes first: you learn how to do HTTP requests, then how to
12+-- embed them in any monad you have, then it goes on giving you details
13+-- about less-common things you may want to know about. The documentation is
14+-- written with sufficient coverage of details and examples, it's designed
15+-- to be a complete tutorial on its own.
16+--
17+-- /(A modest intro goes here, click on 'req' to start making requests.)/
2618--
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+-- This 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 “easy-to-use” phrase mean? It means that the library is
25+-- designed to be beginner-friendly, so it's simple to add it to your monad
26+-- stack, intuitive to work with, well-documented, and does not get in your
27+-- way. Doing HTTP requests is a common task and Haskell library for this
28+-- should be very approachable and clear to beginners, thus certain
29+-- compromises were made. For example, one cannot currently modify
30+-- 'L.ManagerSettings' of default manager because the library always use the
31+-- same implicit global manager for simplicity and maximal connection
32+-- sharing. There is a way to use your own manager with different settings,
33+-- but it requires a bit more typing.
34+--
35+-- “Type-safe” means that the library is protective and eliminates certain
36+-- class of errors. For example, we have correct-by-construction 'Url's,
37+-- it's guaranteed that user does not send request body when using methods
38+-- like 'GET' or 'OPTIONS', amount of implicit assumptions is minimized by
39+-- making user specify his\/her intentions in explicit form (for example,
40+-- it's not possible to avoid specifying body or method of a request).
41+-- Authentication methods that assume TLS force user to use TLS on type
42+-- level. The library carefully hides underlying types from lower-level
43+-- @http-client@ package because it's not safe enough (for example
44+-- 'L.Request' is an instance of 'Data.String.IsString' and if it's
45+-- malformed, it will blow up at run-time).
46+--
47+-- “Expandable” refers to the ability of the library to be expanded without
48+-- ugly hacking. For example, it's possible to define your own HTTP methods,
49+-- new ways to construct body of request, new authorization options, new
50+-- ways to actually perform request and how to represent\/parse response. As
51+-- user extends the library to satisfy his\/her special needs, the new
52+-- solutions work just like built-ins. That said, all common cases are
53+-- covered by the library out-of-the-box.
54+--
55+-- “High-level” means that there are less details to worry about. The
56+-- library is a result of my experiences as a Haskell consultant, working
57+-- for several clients who have very different projects and so the library
58+-- adapts easily to any particular style of writing Haskell applications.
59+-- For example, some people prefer throwing exceptions, while others are
60+-- concerned with purity: just define 'handleHttpException' accordingly when
61+-- making your monad instance of 'MonadHttp' and it will play seamlessly.
62+-- Finally, the library cuts boilerplate considerably and helps write
63+-- concise, easy to read and maintain code.
5664--
5765-- === Using with other libraries
5866--
59−-- * You won't need the low-level interface of @http-client@ most of the
60−-- time, but when you do, it's better to do a qualified import,
61−-- because @http-client@ has naming conflicts with @req@.
62−-- * For streaming of large request bodies see the companion package
67+-- * You won't need low-level interface of @http-client@ most of the
68+-- time, but when you do, it's better import it qualified because it
69+-- has naming conflicts with @req@.
70+-- * For streaming of large request bodies see companion package
6371-- @req-conduit@: <https://hackage.haskell.org/package/req-conduit>.
6472--
6573-- === Lightweight, no risk solution
6674--
6775-- The library uses the following mature packages under the hood to
68−-- guarantee you the best experience:
76+-- guarantee you best experience without bugs or other funny business:
6977--
70−-- * <https://hackage.haskell.org/package/http-client>—low level HTTP
78+-- * <https://hackage.haskell.org/package/http-client> — low level HTTP
7179-- client used everywhere in Haskell.
72−-- * <https://hackage.haskell.org/package/http-client-tls>—TLS (HTTPS)
80+-- * <https://hackage.haskell.org/package/http-client-tls> — TLS (HTTPS)
7381-- support for @http-client@.
7482--
7583-- It's important to note that since we leverage well-known libraries that
76−-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
84+-- the whole Haskell ecosystem uses, there is no risk in using @req@, as the
7785-- machinery for performing requests is the same as with @http-conduit@ and
78−-- @wreq@. The only difference is the API.
86+-- @wreq@, it's just the API is different.
87+
88+{-# LANGUAGE CPP #-}
89+{-# LANGUAGE DataKinds #-}
90+{-# LANGUAGE DeriveDataTypeable #-}
91+{-# LANGUAGE DeriveGeneric #-}
92+{-# LANGUAGE FlexibleInstances #-}
93+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
94+{-# LANGUAGE KindSignatures #-}
95+{-# LANGUAGE OverloadedStrings #-}
96+{-# LANGUAGE RecordWildCards #-}
97+{-# LANGUAGE ScopedTypeVariables #-}
98+{-# LANGUAGE TypeFamilies #-}
99+
100+#if MIN_VERSION_base(4,9,0)
101+{-# LANGUAGE UndecidableInstances #-}
102+#endif
103+
104+#if __GLASGOW_HASKELL__ >= 800
105+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
106+#endif
107+
79108module Network.HTTP.Req
80109 ( -- * Making a request
81110 -- $making-a-request
82− req,
83− reqBr,
84− reqCb,
85− req',
86− withReqManager,
87−
88− -- * Embedding requests in your monad
111+ req
112+ , withReqManager
113+ -- * Embedding requests into your monad
89114 -- $embedding-requests
90− MonadHttp (..),
91− HttpConfig (..),
92− defaultHttpConfig,
93− Req,
94− runReq,
95−
115+ , MonadHttp (..)
116+ , HttpConfig (..)
96117 -- * Request
97−
98118 -- ** Method
99119 -- $method
100− GET (..),
101− POST (..),
102− HEAD (..),
103− PUT (..),
104− DELETE (..),
105− TRACE (..),
106− CONNECT (..),
107− OPTIONS (..),
108− PATCH (..),
109− HttpMethod (..),
110−
120+ , GET (..)
121+ , POST (..)
122+ , HEAD (..)
123+ , PUT (..)
124+ , DELETE (..)
125+ , TRACE (..)
126+ , CONNECT (..)
127+ , OPTIONS (..)
128+ , PATCH (..)
129+ , HttpMethod (..)
111130 -- ** URL
112131 -- $url
113− Url,
114− http,
115− https,
116− (/~),
117− (/:),
118− useHttpURI,
119− useHttpsURI,
120− useURI,
121− urlQ,
122− renderUrl,
123−
132+ , Url
133+ , http
134+ , https
135+ , (/~)
136+ , (/:)
137+ , parseUrlHttp
138+ , parseUrlHttps
124139 -- ** Body
125140 -- $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−
141+ , NoReqBody (..)
142+ , ReqBodyJson (..)
143+ , ReqBodyFile (..)
144+ , ReqBodyBs (..)
145+ , ReqBodyLbs (..)
146+ , ReqBodyUrlEnc (..)
147+ , FormUrlEncodedParam
148+ , HttpBody (..)
149+ , ProvidesBody
150+ , HttpBodyAllowed
139151 -- ** Optional parameters
140152 -- $optional-parameters
141− Option,
142−
153+ , Option
143154 -- *** Query parameters
144155 -- $query-parameters
145− (=:),
146− queryFlag,
147− formToQuery,
148− QueryParam (..),
149−
156+ , (=:)
157+ , queryFlag
158+ , QueryParam (..)
150159 -- *** Headers
151− header,
152− attachHeader,
153− headerRedacted,
154−
160+ , header
155161 -- *** Cookies
156162 -- $cookies
157− cookieJar,
158−
163+ , cookieJar
159164 -- *** Authentication
160165 -- $authentication
161− basicAuth,
162− basicAuthUnsafe,
163− basicProxyAuth,
164− oAuth1,
165− oAuth2Bearer,
166− oAuth2Token,
167− customAuth,
168−
166+ , basicAuth
167+ , oAuth1
168+ , oAuth2Bearer
169+ , oAuth2Token
170+ , awsAuth
169171 -- *** Other
170− port,
171− decompress,
172− responseTimeout,
173− httpVersion,
174−
172+ , port
173+ , decompress
174+ , responseTimeout
175+ , httpVersion
175176 -- * Response
176−
177177 -- ** Response interpretations
178− IgnoreResponse,
179− ignoreResponse,
180− JsonResponse,
181− jsonResponse,
182− BsResponse,
183− bsResponse,
184− LbsResponse,
185− lbsResponse,
186−
178+ , IgnoreResponse
179+ , ignoreResponse
180+ , JsonResponse
181+ , jsonResponse
182+ , BsResponse
183+ , bsResponse
184+ , LbsResponse
185+ , lbsResponse
186+ , ReturnRequest
187+ , returnRequest
187188 -- ** Inspecting a response
188− responseBody,
189− responseStatusCode,
190− responseStatusMessage,
191− responseHeader,
192− responseCookieJar,
193−
189+ , responseBody
190+ , responseStatusCode
191+ , responseStatusMessage
192+ , responseHeader
193+ , responseCookieJar
194+ , responseRequest
194195 -- ** Defining your own interpretation
195196 -- $new-response-interpretation
196− HttpResponse (..),
197−
197+ , HttpResponse (..)
198198 -- * Other
199− HttpException (..),
200− isStatusCodeException,
201− CanHaveBody (..),
202− Scheme (..),
203− )
199+ , HttpException (..)
200+ , CanHaveBody (..)
201+ , Scheme (..) )
204202where
205203
206−import Blaze.ByteString.Builder qualified as BB
207204import Control.Applicative
208205import 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)
206+import Control.Exception (Exception, try, catch, throwIO)
207+import Control.Monad
213208import 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
209+import Data.Aeson (ToJSON (..), FromJSON (..))
234210import 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
238211import Data.Data (Data)
239−import Data.Default.Class (def)
212+import Data.Default.Class
240213import Data.Function (on)
241214import Data.IORef
242−import Data.Kind (Constraint, Type)
243−import Data.List (foldl', nubBy)
215+import Data.List (nubBy)
244216import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
246−import Data.Maybe (fromMaybe)
247217import Data.Proxy
248−import Data.Semigroup (Endo (..))
249−import Data.Set qualified as S
250−import Data.Text (Text)
251−import Data.Text qualified as T
252−import Data.Text.Encoding qualified as T
253−import Data.Typeable (Typeable, cast)
218+import Data.Semigroup hiding (Option, option)
219+import Data.Typeable (Typeable)
254220import GHC.Generics
255221import 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
265222import 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
272223import Web.HttpApiData (ToHttpApiData (..))
224+import qualified Blaze.ByteString.Builder as BB
225+import qualified Data.Aeson as A
226+import qualified Data.Binary.Builder as R
227+import qualified Data.ByteString as B
228+import qualified Data.ByteString.Lazy as BL
229+import qualified Data.CaseInsensitive as CI
230+import qualified Data.List.NonEmpty as NE
231+import qualified Data.Text as T
232+import qualified Data.Text.Encoding as T
233+import qualified Network.Connection as NC
234+import qualified Network.HTTP.Client as L
235+import qualified Network.HTTP.Client.Internal as LI
236+import qualified Network.HTTP.Client.TLS as L
237+import qualified Network.HTTP.Req.AWS as AWS
238+import qualified Network.HTTP.Req.OAuth1 as OAuth1
239+import qualified Network.HTTP.Types as Y
240+
241+#if MIN_VERSION_base(4,9,0)
242+import Data.Kind (Constraint)
243+#else
244+import GHC.Exts (Constraint)
245+#endif
273246
274247----------------------------------------------------------------------------
275248-- Making a request
276249
277250-- $making-a-request
278251--
279−-- To make an HTTP request you normally need only one function: 'req'.
252+-- To make an HTTP request you need only one function: 'req'.
280253
281254-- | Make an HTTP request. The function takes 5 arguments, 4 of which
282255-- specify required parameters and the final 'Option' argument is a
@@ -288,44 +261,42 @@ import Web.HttpApiData (ToHttpApiData (..))
288261-- @method@ is an HTTP method such as 'GET' or 'POST'. The documentation has
289262-- a dedicated section about HTTP methods below.
290263--
291−-- @url@ is a 'Url' that describes location of resource you want to interact
292−-- with.
264+-- @url@ is a URL that describes location of resource you want to interact
265+-- with. It's of type 'Url' (if you click the link it will tell everything
266+-- about construction of 'Url' things).
293267--
294268-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
295−-- tutorial has a section about HTTP bodies, but usage is very
296−-- straightforward and should be clear from the examples.
297−--
298−-- @response@ is a type hint how to make and interpret response of an HTTP
299−-- request. Out-of-the-box it can be the following:
300−--
301−-- * 'ignoreResponse'
302−-- * 'jsonResponse'
303−-- * 'bsResponse' (to get a strict 'ByteString')
304−-- * 'lbsResponse' (to get a lazy 'BL.ByteString')
305−--
306−-- Finally, @options@ is a 'Monoid' that holds a composite 'Option' for all
307−-- other optional settings like query parameters, headers, non-standard port
308−-- number, etc. There are quite a few things you can put there, see the
269+-- tutorial has a section about HTTP bodies, but usage in very
270+-- straightforward and should be clear from the examples below.
271+--
272+-- @response@ is a type hint how to make and interpret response of HTTP
273+-- request, out-of-the-box it can be the following: 'ignoreResponse',
274+-- 'jsonResponse', 'bsResponse' (to get strict 'ByteString'), 'lbsResponse'
275+-- (to get lazy 'BL.ByteString'), and 'returnRequest' (makes no request,
276+-- just returns response, used for testing).
277+--
278+-- Finally @options@ is a 'Monoid' that holds a composite 'Option' for all
279+-- other optional things like query parameters, headers, non-standard port
280+-- number, etc. There are quite a few things you can put there, see
309281-- corresponding section in the documentation. If you don't need anything at
310282-- all, pass 'mempty'.
311283--
312284-- __Note__ that if you use 'req' to do all your requests, connection
313285-- sharing and reuse is done for you automatically.
314286--
315−-- See the examples below to get on the speed quickly.
287+-- See the examples below to get on the speed very quickly.
316288--
317289-- ==== __Examples__
318290--
319291-- First, this is a piece of boilerplate that should be in place before you
320292-- try the examples:
321293--
322−-- > {-# LANGUAGE DeriveGeneric #-}
323294-- > {-# LANGUAGE OverloadedStrings #-}
324295-- >
325296-- > module Main (main) where
326297-- >
298+-- > import Control.Exception (throwIO)
327299-- > import Control.Monad
328−-- > import Control.Monad.IO.Class
329300-- > import Data.Aeson
330301-- > import Data.Maybe (fromJust)
331302-- > import Data.Monoid ((<>))
@@ -333,30 +304,32 @@ import Web.HttpApiData (ToHttpApiData (..))
333304-- > import GHC.Generics
334305-- > import Network.HTTP.Req
335306-- > import qualified Data.ByteString.Char8 as B
336−-- > import qualified Text.URI as URI
307+-- >
308+-- > instance MonadHttp IO where
309+-- > handleHttpException = throwIO
337310--
338311-- We will be making requests against the <https://httpbin.org> service.
339312--
340313-- Make a GET request, grab 5 random bytes:
341314--
342315-- > main :: IO ()
343−-- > main = runReq defaultHttpConfig $ do
316+-- > main = do
344317-- > let n :: Int
345318-- > n = 5
346319-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
347−-- > liftIO $ B.putStrLn (responseBody bs)
320+-- > B.putStrLn (responseBody bs)
348321--
349322-- The same, but now we use a query parameter named @\"seed\"@ to control
350323-- seed of the generator:
351324--
352325-- > main :: IO ()
353−-- > main = runReq defaultHttpConfig $ do
326+-- > main = do
354327-- > let n, seed :: Int
355328-- > n = 5
356329-- > seed = 100
357330-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
358331-- > "seed" =: seed
359−-- > liftIO $ B.putStrLn (responseBody bs)
332+-- > B.putStrLn (responseBody bs)
360333--
361334-- POST JSON data and get some info about the POST request:
362335--
@@ -369,252 +342,103 @@ import Web.HttpApiData (ToHttpApiData (..))
369342-- > instance FromJSON MyData
370343-- >
371344-- > main :: IO ()
372−-- > main = runReq defaultHttpConfig $ do
345+-- > main = do
373346-- > let myData = MyData
374347-- > { size = 6
375348-- > , color = "Green" }
376349-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
377−-- > liftIO $ print (responseBody v :: Value)
350+-- > print (responseBody v :: Value)
378351--
379352-- Sending URL-encoded body:
380353--
381354-- > main :: IO ()
382−-- > main = runReq defaultHttpConfig $ do
355+-- > main = do
383356-- > let params =
384357-- > "foo" =: ("bar" :: Text) <>
385358-- > queryFlag "baz"
386359-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
387−-- > liftIO $ print (responseBody response :: Value)
360+-- > print (responseBody response :: Value)
388361--
389362-- Using various optional parameters and URL that is not known in advance:
390363--
391364-- > main :: IO ()
392−-- > main = runReq defaultHttpConfig $ do
365+-- > main = do
393366-- > -- This is an example of what to do when URL is given dynamically. Of
394367-- > -- 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)
368+-- > let (url, options) = fromJust (parseUrlHttps "https://httpbin.org/get?foo=bar")
397369-- > response <- req GET url NoReqBody jsonResponse $
398370-- > "from" =: (15 :: Int) <>
399371-- > "to" =: (67 :: Int) <>
400372-- > basicAuth "username" "password" <>
401373-- > options <> -- contains the ?foo=bar part
402374-- > 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
375+-- > print (responseBody response :: Value)
376+
377+req
378+ :: forall m method body response scheme.
379+ ( MonadHttp m
380+ , HttpMethod method
381+ , HttpBody body
382+ , HttpResponse response
383+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
384+ => method -- ^ HTTP method
385+ -> Url scheme -- ^ 'Url' — location of resource
386+ -> body -- ^ Body of the request
387+ -> Proxy response -- ^ A hint how to interpret response
388+ -> Option scheme -- ^ Collection of optional parameters
389+ -> m response -- ^ Response
390+req method url body Proxy options = do
391+ config <- getHttpConfig
392+ manager <- liftIO (readIORef globalManager)
567393 let -- NOTE First appearance of any given header wins. This allows to
568394 -- “overwrite” headers when we construct a request by cons-ing.
569395 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)
584− 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
592−
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'.
396+ x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
397+ request = flip appEndo L.defaultRequest $
398+ -- NOTE Order of 'mappend's matters, here method is overwritten first
399+ -- and 'options' take effect last. In particular, this means that
400+ -- 'options' can overwrite things set by other request components,
401+ -- which is useful for setting port number, "Content-Type" header,
402+ -- etc.
403+ nubHeaders <>
404+ getRequestMod options <>
405+ getRequestMod config <>
406+ getRequestMod (Womb body :: Womb "body" body) <>
407+ getRequestMod url <>
408+ getRequestMod (Womb method :: Womb "method" method)
409+ wrappingVanilla m = catch m (throwIO . VanillaHttpException)
410+ (liftIO . try . wrappingVanilla) (getHttpResponse request manager)
411+ >>= either handleHttpException return
412+
413+-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
414+-- settings, so users don't need to deal with this manager stuff at all, but
415+-- when we create a request, instance 'HttpConfig' can affect the default
416+-- settings via 'getHttpConfig'.
597417--
598418-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
599419-- The value of 'globalManager' is named and lives on top level. This means
600−-- it will be shared, i.e. computed only once on the first use of the
601−-- manager. From that moment on the 'IORef' will be just reused—exactly the
602−-- behavior we want here in order to maximize connection sharing. GHC could
603−-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
420+-- it will be shared, i.e. computed only once on first use of manager. From
421+-- that moment on the 'IORef' will be just reused — exactly the behaviour we
422+-- want here in order to maximize connection sharing. GHC could spoil the
423+-- plan by inlining the definition, hence the @NOINLINE@ pragma.
424+
425+globalManager :: IORef L.Manager
605426globalManager = unsafePerformIO $ do
606427 context <- NC.initConnectionContext
607− let settings =
608− L.mkManagerSettingsContext
609− (Just context)
610− def
611− Nothing
428+ let settings = L.mkManagerSettingsContext (Just context) def Nothing
612429 manager <- L.newManager settings
613− return manager
430+ newIORef manager
614431{-# NOINLINE globalManager #-}
615432
433+-- | Perform an action using global implicit 'L.Manager' that the rest of
434+-- the library uses. This allows to reuse connections that the 'L.Manager'
435+-- controls.
436+
437+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
438+withReqManager m = liftIO (readIORef globalManager) >>= m
439+
616440----------------------------------------------------------------------------
617−-- Embedding requests in your monad
441+-- Embedding requests into your monad
618442
619443-- $embedding-requests
620444--
@@ -623,281 +447,91 @@ globalManager = unsafePerformIO $ do
623447--
624448-- When writing a library, keep your API polymorphic in terms of
625449-- '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).
629450
630451-- | A type class for monads that support performing HTTP requests.
631452-- Typically, you only need to define the 'handleHttpException' method
632453-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
454+
455+class MonadIO m => MonadHttp m where
456+
457+ {-# MINIMAL handleHttpException #-}
458+
634459 -- | This method describes how to deal with 'HttpException' that was
635460 -- caught by the library. One option is to re-throw it if you are OK with
636461 -- exceptions, but if you prefer working with something like
637− -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
638− -- 'Control.Monad.Except.throwError'.
462+ -- 'Control.Monad.Error.MonadError', this is the right place to pass it to
463+ -- 'Control.Monad.Error.throwError'.
464+
639465 handleHttpException :: HttpException -> m a
640466
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.
467+ -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
468+ -- implementation returns its 'def' value, which is described in the
469+ -- documentation for the type. Common usage pattern with manually defined
470+ -- 'getHttpConfig' is to return some hard-coded value, or value extracted
471+ -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
472+ -- configuration is desirable.
473+
647474 getHttpConfig :: m HttpConfig
648− getHttpConfig = return defaultHttpConfig
475+ getHttpConfig = return def
476+
477+-- | 'HttpConfig' contains general and default settings to be used when
478+-- making HTTP requests.
649479
650−-- | 'HttpConfig' contains settings to be used when making HTTP requests.
651480data HttpConfig = HttpConfig
652− { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
481+ { httpConfigProxy :: Maybe L.Proxy
482+ -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
653483 -- environment variables are respected, this setting overwrites them.
654484 -- Default value: 'Nothing'.
655− httpConfigProxy :: Maybe L.Proxy,
656− -- | How many redirects to follow when getting a resource. Default
485+ , httpConfigRedirectCount :: Int
486+ -- ^ How many redirects to follow when getting a resource. Default
657487 -- 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
488+ , httpConfigAltManager :: Maybe L.Manager
489+ -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
490+ -- that default implicit manager will be used (that's what you want in
491+ -- 99% of cases).
492+ , httpConfigCheckResponse :: L.Request -> L.Response L.BodyReader -> IO ()
493+ -- ^ Function to check the response immediately after receiving the
494+ -- status and headers. This is used for throwing exceptions on
495+ -- non-success status codes by default (set to @\\_ _ -> return ()@ if
496+ -- this behavior is not desirable). Throwing is better then just
497+ -- returning a request with non-2xx status code because in that case
498+ -- something is wrong and we need a way to short-cut execution. The
499+ -- thrown exception is caught by the library though and is available in
500+ -- 'handleHttpException'.
501+ } deriving Typeable
502+
503+instance Default HttpConfig where
504+ def = HttpConfig
505+ { httpConfigProxy = Nothing
506+ , httpConfigRedirectCount = 10
507+ , httpConfigAltManager = Nothing
508+ , httpConfigCheckResponse = \_ response ->
509+ let Y.Status statusCode _ = L.responseStatus response in
510+ unless (200 <= statusCode && statusCode < 300) $ do
511+ chunk <- BL.toStrict <$> L.brReadSome (L.responseBody response) 1024
512+ LI.throwHttp (L.StatusCodeException (void response) chunk) }
755513
756514instance RequestComponent HttpConfig where
757515 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)
516+ x { L.proxy = httpConfigProxy
517+ , L.redirectCount = httpConfigRedirectCount
518+ , LI.requestManagerOverride = httpConfigAltManager
519+ , LI.checkResponse = httpConfigCheckResponse }
887520
888521----------------------------------------------------------------------------
889−-- Request—Method
522+-- Request — Method
890523
891524-- $method
892525--
893526-- The package supports all methods as defined by RFC 2616, and 'PATCH'
894−-- which is defined by RFC 5789—that should be enough to talk to RESTful
527+-- which is defined by RFC 5789 — that should be enough to talk to RESTful
895528-- APIs. In some cases, however, you may want to add more methods (e.g. you
896529-- work with WebDAV <https://en.wikipedia.org/wiki/WebDAV>); no need to
897530-- compromise on type safety and hack, it only takes a couple of seconds to
898531-- define a new method that will works seamlessly, see 'HttpMethod'.
899532
900533-- | 'GET' method.
534+
901535data GET = GET
902536
903537instance HttpMethod GET where
@@ -905,6 +539,7 @@ instance HttpMethod GET where
905539 httpMethodName Proxy = Y.methodGet
906540
907541-- | 'POST' method.
542+
908543data POST = POST
909544
910545instance HttpMethod POST where
@@ -912,6 +547,7 @@ instance HttpMethod POST where
912547 httpMethodName Proxy = Y.methodPost
913548
914549-- | 'HEAD' method.
550+
915551data HEAD = HEAD
916552
917553instance HttpMethod HEAD where
@@ -919,24 +555,26 @@ instance HttpMethod HEAD where
919555 httpMethodName Proxy = Y.methodHead
920556
921557-- | 'PUT' method.
558+
922559data PUT = PUT
923560
924561instance HttpMethod PUT where
925562 type AllowsBody PUT = 'CanHaveBody
926563 httpMethodName Proxy = Y.methodPut
927564
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.
565+-- | 'DELETE' method. This data type does not allow having request body with
566+-- 'DELETE' requests, as it should be, however some APIs may expect 'DELETE'
567+-- requests to have bodies, in that case define your own variation of
568+-- 'DELETE' method and allow it to have a body.
569+
933570data DELETE = DELETE
934571
935572instance HttpMethod DELETE where
936− type AllowsBody DELETE = 'CanHaveBody
573+ type AllowsBody DELETE = 'NoBody
937574 httpMethodName Proxy = Y.methodDelete
938575
939576-- | 'TRACE' method.
577+
940578data TRACE = TRACE
941579
942580instance HttpMethod TRACE where
@@ -944,6 +582,7 @@ instance HttpMethod TRACE where
944582 httpMethodName Proxy = Y.methodTrace
945583
946584-- | 'CONNECT' method.
585+
947586data CONNECT = CONNECT
948587
949588instance HttpMethod CONNECT where
@@ -951,6 +590,7 @@ instance HttpMethod CONNECT where
951590 httpMethodName Proxy = Y.methodConnect
952591
953592-- | 'OPTIONS' method.
593+
954594data OPTIONS = OPTIONS
955595
956596instance HttpMethod OPTIONS where
@@ -958,6 +598,7 @@ instance HttpMethod OPTIONS where
958598 httpMethodName Proxy = Y.methodOptions
959599
960600-- | 'PATCH' method.
601+
961602data PATCH = PATCH
962603
963604instance HttpMethod PATCH where
@@ -965,38 +606,42 @@ instance HttpMethod PATCH where
965606 httpMethodName Proxy = Y.methodPatch
966607
967608-- | 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@:
609+-- non-standard method, follow this example that defines COPY:
969610--
970611-- > data COPY = COPY
971612-- >
972613-- > instance HttpMethod COPY where
973614-- > type AllowsBody COPY = 'CanHaveBody
974615-- > httpMethodName Proxy = "COPY"
616+
975617class HttpMethod a where
976− -- | 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
618+
619+ -- | Type function 'AllowsBody' returns type of kind 'CanHaveBody' which
620+ -- tells the rest of the library whether the method can have a body or
621+ -- not. We use the special type 'CanHaveBody' “lifted” into kind instead
979622 -- of 'Bool' to get more user-friendly compiler messages.
623+
980624 type AllowsBody a :: CanHaveBody
981625
982626 -- | Return name of the method as a 'ByteString'.
627+
983628 httpMethodName :: Proxy a -> ByteString
984629
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
630+instance HttpMethod method => RequestComponent (Womb "method" method) where
986631 getRequestMod _ = Endo $ \x ->
987− x {L.method = httpMethodName (Proxy :: Proxy method)}
632+ x { L.method = httpMethodName (Proxy :: Proxy method) }
988633
989634----------------------------------------------------------------------------
990−-- Request—URL
635+-- Request — URL
991636
992637-- $url
993638--
994639-- 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'.
640+-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
996641
997642-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
998643-- specifying the scheme and host at the same time. Then use the @('/~')@
999−-- and @('/:')@ operators to grow the path one piece at a time. Every single
644+-- and @('/:')@ operators to grow path one piece at a time. Every single
1000645-- piece of path will be url(percent)-encoded, so using @('/~')@ and
1001646-- @('/:')@ is the only way to have forward slashes between path segments.
1002647-- This approach makes working with dynamic path segments easy and safe. See
@@ -1022,233 +667,125 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1022667--
1023668-- > https "юникод.рф"
1024669-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1025−data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026− -- 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
670+
671+data Url (scheme :: Scheme) = Url Scheme (NonEmpty T.Text)
672+ -- NOTE The second value is path segments in reversed order.
673+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
674+
675+-- | Given host name, produce a 'Url' which have “http” as its scheme and
1043676-- empty path. This also sets port to @80@.
1044−http :: Text -> Url 'Http
677+
678+http :: T.Text -> Url 'Http
1045679http = Url Http . pure
1046680
1047−-- | Given host name, produce a 'Url' which has “https” as its scheme and
681+-- | Given host name, produce a 'Url' which have “https” as its scheme and
1048682-- empty path. This also sets port to @443@.
1049−https :: Text -> Url 'Https
683+
684+https :: T.Text -> Url 'Https
1050685https = Url Https . pure
1051686
1052−-- | Grow a given 'Url' appending a single path segment to it. Note that the
687+-- | Grow given 'Url' appending a single path segment to it. Note that the
1053688-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1054−infixl 5 /~
1055689
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
690+infixl 5 /~
691+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057692Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1058693
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 /:
694+-- | Type-constrained version of @('/~')@ to remove ambiguity in cases when
695+-- next URL piece is a 'Text' literal.
1062696
1063−(/:) :: Url scheme -> Text -> Url scheme
697+infixl 5 /:
698+(/:) :: Url scheme -> T.Text -> Url scheme
1064699(/:) = (/~)
1065700
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'')
701+-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
702+-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
703+-- you are given a URL to query dynamically and don't know it beforehand.
704+-- The function parses 'ByteString' because it's the correct type to
705+-- represent a URL, as 'Url' cannot contain characters outside of ASCII
706+-- range, thus we can consider every character a 'Data.Word.Word8' value.
707+--
708+-- This function only parses 'Url' (scheme, host, path) and optional query
709+-- parameters that are returned as 'Option'. It does not parse method name
710+-- or authentication info from given 'ByteString'.
711+
712+parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
713+parseUrlHttp url' = do
714+ url <- B.stripPrefix "http://" url'
715+ (host :| path, option) <- parseUrlHelper url
716+ return (foldl (/:) (http host) path, option)
717+
718+-- | Just like 'parseUrlHttp', but expects “https” scheme.
719+
720+parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
721+parseUrlHttps url' = do
722+ url <- B.stripPrefix "https://" url'
723+ (host :| path, option) <- parseUrlHelper url
724+ return (foldl (/:) (https host) path, option)
725+
726+-- | Get host\/collection of path pieces and possibly query parameters
727+-- already converted to 'Option'. This function is not public.
728+
729+parseUrlHelper :: ByteString -> Maybe (NonEmpty T.Text, Option scheme)
730+parseUrlHelper url = do
731+ let (path', query') = B.break (== 0x3f) url
732+ query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
733+ path <- NE.nonEmpty (Y.decodePathSegments path')
734+ return (path, query)
1198735
1199736instance RequestComponent (Url scheme) where
1200737 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− }
738+ let (host :| path) = NE.reverse segments in
739+ x { L.secure = case scheme of
740+ Http -> False
741+ Https -> True
742+ , L.port = case scheme of
743+ Http -> 80
744+ Https -> 443
745+ , L.host = Y.urlEncode False (T.encodeUtf8 host)
746+ , L.path =
747+ (BL.toStrict . R.toLazyByteString . Y.encodePathSegments) path }
1213748
1214749----------------------------------------------------------------------------
1215−-- Request—Body
750+-- Request — Body
1216751
1217752-- $body
1218753--
1219754-- A number of options for request bodies are available. The @Content-Type@
1220−-- 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'.
755+-- header is set for you automatically according to body option you use
756+-- (it's always specified in documentation for given body option). To add
757+-- your own way to represent request body, see 'HttpBody'.
1224758
1225759-- | This data type represents empty body of an HTTP request. This is the
1226760-- data type to use with 'HttpMethod's that cannot have a body, as it's the
1227761-- only type for which 'ProvidesBody' returns 'NoBody'.
1228762--
1229763-- Using of this body option does not set the @Content-Type@ header.
764+
1230765data NoReqBody = NoReqBody
1231766
1232767instance HttpBody NoReqBody where
1233768 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1234769
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.
770+-- | This body option allows to use a JSON object as request body — probably
771+-- the most popular format right now. Just wrap a data type that is an
772+-- instance of 'ToJSON' type class and you are done: it will be converted to
773+-- JSON and inserted as request body.
1239774--
1240775-- This body option sets the @Content-Type@ header to @\"application/json;
1241776-- charset=utf-8\"@ value.
777+
1242778newtype ReqBodyJson a = ReqBodyJson a
1243779
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
780+instance ToJSON a => HttpBody (ReqBodyJson a) where
1245781 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1246− getRequestContentType _ = pure "application/json; charset=utf-8"
782+ getRequestContentType Proxy = pure "application/json; charset=utf-8"
1247783
1248784-- | This body option streams request body from a file. It is expected that
1249−-- the file size does not change during streaming.
785+-- the file size does not change during the streaming.
1250786--
1251787-- Using of this body option does not set the @Content-Type@ header.
788+
1252789newtype ReqBodyFile = ReqBodyFile FilePath
1253790
1254791instance HttpBody ReqBodyFile where
@@ -1258,6 +795,7 @@ instance HttpBody ReqBodyFile where
1258795-- | HTTP request body represented by a strict 'ByteString'.
1259796--
1260797-- Using of this body option does not set the @Content-Type@ header.
798+
1261799newtype ReqBodyBs = ReqBodyBs ByteString
1262800
1263801instance HttpBody ReqBodyBs where
@@ -1266,387 +804,270 @@ instance HttpBody ReqBodyBs where
1266804-- | HTTP request body represented by a lazy 'BL.ByteString'.
1267805--
1268806-- Using of this body option does not set the @Content-Type@ header.
807+
1269808newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1270809
1271810instance HttpBody ReqBodyLbs where
1272811 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1273812
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'.
813+-- | Form URL-encoded body. This can hold a collection of parameters which
814+-- are encoded similarly to query parameters at the end of query string,
815+-- with the only difference that they are stored in request body. The
816+-- similarity is reflected in the API as well, as you can use the same
817+-- combinators you would use to add query parameters: @('=:')@ and
818+-- 'queryFlag'.
1279819--
1280820-- This body option sets the @Content-Type@ header to
1281−-- @\"application/x-www-form-urlencoded\"@ value.
821+-- @\"application/x-www-from-urlencoded\"@ value.
822+
1282823newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
1283824
1284825instance HttpBody ReqBodyUrlEnc where
1285826 getRequestBody (ReqBodyUrlEnc (FormUrlEncodedParam params)) =
1286827 (L.RequestBodyLBS . BB.toLazyByteString) (Y.renderQueryText False params)
1287− getRequestContentType _ = pure "application/x-www-form-urlencoded"
828+ getRequestContentType Proxy = pure "application/x-www-form-urlencoded"
1288829
1289830-- | An opaque monoidal value that allows to collect URL-encoded parameters
1290831-- to be wrapped in 'ReqBodyUrlEnc'.
1291−newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
832+
833+newtype FormUrlEncodedParam = FormUrlEncodedParam [(T.Text, Maybe T.Text)]
1292834 deriving (Semigroup, Monoid)
1293835
1294836instance QueryParam FormUrlEncodedParam where
1295837 queryParam name mvalue =
1296838 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
1304839
1305−-- | Multipart form data. Please consult the
1306−-- "Network.HTTP.Client.MultipartFormData" module for how to construct
1307−-- 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
1309−-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
1310−--
1311−-- @since 0.2.0
1312−--
1313−-- ==== __Examples__
1314−--
1315−-- > import Control.Monad.IO.Class
1316−-- > import Data.Default.Class
1317−-- > import Network.HTTP.Req
1318−-- > import qualified Network.HTTP.Client.MultipartFormData as LM
1319−-- >
1320−-- > main :: IO ()
1321−-- > main = runReq def $ do
1322−-- > body <-
1323−-- > reqBodyMultipart
1324−-- > [ LM.partBS "title" "My Image"
1325−-- > , LM.partFileSource "file1" "/tmp/image.jpg"
1326−-- > ]
1327−-- > response <-
1328−-- > req POST (http "example.com" /: "post")
1329−-- > body
1330−-- > bsResponse
1331−-- > mempty
1332−-- > liftIO $ print (responseBody response)
1333−data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
1334−
1335−instance HttpBody ReqBodyMultipart where
1336− getRequestBody (ReqBodyMultipart _ body) = body
1337− getRequestContentType (ReqBodyMultipart boundary _) =
1338− pure ("multipart/form-data; boundary=" <> boundary)
1339−
1340−-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1341−--
1342−-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
1344−reqBodyMultipart parts = liftIO $ do
1345− boundary <- LM.webkitBoundary
1346− body <- LM.renderParts boundary parts
1347− return (ReqBodyMultipart boundary body)
1348−
1349−-- | A type class for things that can be interpreted as an HTTP
840+-- | A type class for things that can be interpreted as HTTP
1350841-- 'L.RequestBody'.
842+
1351843class HttpBody body where
844+
845+ {-# MINIMAL getRequestBody #-}
846+
1352847 -- | How to get actual 'L.RequestBody'.
848+
1353849 getRequestBody :: body -> L.RequestBody
1354850
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.
1358− getRequestContentType :: body -> Maybe ByteString
1359− getRequestContentType = const Nothing
851+ -- | This method allows to optionally specify value of @Content-Type@
852+ -- header that should be used with particular body option. By default it
853+ -- returns 'Nothing' and so @Content-Type@ is not set.
854+
855+ getRequestContentType :: Proxy body -> Maybe ByteString
856+ getRequestContentType Proxy = Nothing
1360857
1361858-- | 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.
859+-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
860+-- 'GET' method and other methods that should not send a body.
861+
1364862type family ProvidesBody body :: CanHaveBody where
1365863 ProvidesBody NoReqBody = 'NoBody
1366− ProvidesBody body = 'CanHaveBody
864+ ProvidesBody body = 'CanHaveBody
1367865
1368866-- | This type function allows any HTTP body if method says it
1369−-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
1370−-- 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− }
867+-- 'CanHaveBody'. When method says it should have 'NoBody', the only body
868+-- option to use is 'NoReqBody'.
869+--
870+-- __Note__: users of GHC 8.0.1 will see slightly more friendly error
871+-- messages when method does not allow a body and body is provided.
872+
873+type family HttpBodyAllowed
874+ (allowsBody :: CanHaveBody)
875+ (providesBody :: CanHaveBody) :: Constraint where
876+ HttpBodyAllowed 'NoBody 'NoBody = ()
877+ HttpBodyAllowed 'CanHaveBody body = ()
878+#if MIN_VERSION_base(4,9,0)
879+ HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
880+ ('Text "This HTTP method does not allow attaching a request body.")
881+#endif
882+
883+instance HttpBody body => RequestComponent (Womb "body" body) where
884+ getRequestMod (Womb body) = Endo $ \x ->
885+ x { L.requestBody = getRequestBody body
886+ , L.requestHeaders =
887+ let old = L.requestHeaders x in
888+ case getRequestContentType (Proxy :: Proxy body) of
889+ Nothing -> old
890+ Just contentType ->
891+ (Y.hContentType, contentType) : old }
1394892
1395893----------------------------------------------------------------------------
1396−-- Request—Optional parameters
894+-- Request — Optional parameters
1397895
1398896-- $optional-parameters
1399897--
1400−-- Optional parameters of request include things like query parameters,
898+-- Optional parameters to a request include things like query parameters,
1401899-- headers, port number, etc. All optional parameters have the type
1402900-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
1403901-- 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.
902+-- 'Option's using 'mappend' (or @('<>')@) to have several of them at once.
1405903
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))
904+-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
905+-- optional parameters like query parameters and headers. See sections below
906+-- to learn which 'Option' primitives are available.
1411907
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.
908+data Option (scheme :: Scheme) =
909+ Option (Endo (Y.QueryText, L.Request)) (Maybe (Endo L.Request))
910+ -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
911+ -- Request to avoid appending to existing query string in request every
912+ -- time new parameter is added. Additional Maybe (Endo Request) is a
913+ -- finalizer that will be applied after all over options. This is for
914+ -- authentication methods that sign requests based on data in Request.
1418915
1419916instance Semigroup (Option scheme) where
1420− Option er0 mr0 <> Option er1 mr1 =
1421− Option
1422− (er0 <> er1)
1423− (mr0 <|> mr1)
917+ Option er0 mr0 <> Option er1 mr1 = Option
918+ (er0 <> er1) (mr0 <|> mr1)
1424919
1425920instance Monoid (Option scheme) where
1426− mempty = Option mempty Nothing
921+ mempty = Option mempty Nothing
1427922 mappend = (<>)
1428923
1429−-- | Use 'formToQuery'.
1430−--
1431−-- @since 3.11.0
1432−instance FromForm (Option scheme) where
1433− fromForm = Right . formToQuery
1434−
1435924-- | A helper to create an 'Option' that modifies only collection of query
1436−-- parameters. This helper is not a part of the public API.
925+-- parameters. This helper is not a part of public API.
926+
1437927withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1438928withQueryParams f = Option (Endo (first f)) Nothing
1439929
1440930-- | A helper to create an 'Option' that modifies only 'L.Request'. This
1441931-- helper is not a part of public API.
932+
1442933withRequest :: (L.Request -> L.Request) -> Option scheme
1443934withRequest f = Option (Endo (second f)) Nothing
1444935
936+-- | A helper to create an 'Option' that adds a finalizer (request
937+-- endomorphism that is run after all other modifications).
938+
939+asFinalizer :: (L.Request -> L.Request) -> Option scheme
940+asFinalizer f = Option mempty (Just (Endo f))
941+
1445942instance RequestComponent (Option scheme) where
1446− getRequestMod (Option f _) = Endo $ \x ->
943+ getRequestMod (Option f finalizer) = Endo $ \x ->
1447944 let (qparams, x') = appEndo f ([], x)
1448− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449− in x' {L.queryString = query}
1450−
1451−-- | Finalize given 'L.Request' by applying a finalizer from the given
1452−-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1454−finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
945+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
946+ in maybe id appEndo finalizer x' { L.queryString = query }
1455947
1456948----------------------------------------------------------------------------
1457−-- Request—Optional parameters—Query Parameters
949+-- Request — Optional parameters — Query Parameters
1458950
1459951-- $query-parameters
1460952--
1461953-- This section describes a polymorphic interface that can be used to
1462−-- construct query parameters (of the type 'Option') and form URL-encoded
1463−-- bodies (of the type 'FormUrlEncodedParam').
954+-- construct query parameters (of type 'Option') and form URL-encoded bodies
955+-- (of type 'FormUrlEncodedParam').
1464956
1465957-- | 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
958+-- your request after question sign @?@. This is the same syntax you use
1467959-- with form URL encoded request bodies.
1468960--
1469961-- This operator is defined in terms of 'queryParam':
1470962--
1471963-- > name =: value = queryParam name (pure value)
1472−infix 7 =:
1473964
1474−(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
965+infix 7 =:
966+(=:) :: (QueryParam param, ToHttpApiData a) => T.Text -> a -> param
1475967name =: value = queryParam name (pure value)
1476968
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:
969+-- | Construct a flag, that is, valueless query parameter. For example, in
970+-- the following URL @a@ is a flag, @b@ is a query parameter with a value:
1480971--
1481972-- > https://httpbin.org/foo/bar?a&b=10
1482973--
1483974-- This operator is defined in terms of 'queryParam':
1484975--
1485−-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486−queryFlag :: (QueryParam param) => Text -> param
976+-- > queryFlag name = queryParam name Nothing
977+
978+queryFlag :: QueryParam param => T.Text -> param
1487979queryFlag name = queryParam name (Nothing :: Maybe ())
1488980
1489−-- | Construct query parameters from a 'ToForm' instance. This function
1490−-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491−--
1492−-- Note that 'Form.Form' doesn't have the concept of parameters with the
1493−-- empty value (i.e. what you can get by @key =: ""@). If the value is
1494−-- empty, it will be encoded as a valueless parameter (i.e. what you can get
1495−-- by @queryFlag key@).
1496−--
1497−-- @since 3.11.0
1498−formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499−formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500− where
1501− toParam (key, val) =
1502− queryParam key $
1503− if val == ""
1504− then Nothing
1505− else Just val
1506−
1507−-- | A type class for query-parameter-like things. The reason to have an
981+-- | A type class for query-parameter-like things. The reason to have
1508982-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1509983-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1510984-- Having the same syntax for these cases seems natural and user-friendly.
985+
1511986class QueryParam param where
987+
1512988 -- | Create a query parameter with given name and value. If value is
1513989 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1514990 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1515991 -- method, because they are easier to read.
1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1517992
1518− -- | Get the query parameter names and values set by 'queryParam'.
1519− --
1520− -- @since 3.11.0
1521− queryParamToList :: param -> [(Text, Maybe Text)]
993+ queryParam :: ToHttpApiData a => T.Text -> Maybe a -> param
1522994
1523995instance QueryParam (Option scheme) where
1524996 queryParam name mvalue =
1525997 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
1527998
1528999----------------------------------------------------------------------------
1529−-- Request—Optional parameters—Headers
1000+-- Request — Optional parameters — Headers
15301001
15311002-- | Create an 'Option' that adds a header. Note that if you 'mappend' two
15321003-- headers with the same names the leftmost header will win. This means, in
15331004-- particular, that you cannot create a request with several headers of the
15341005-- same name.
1535−header ::
1536− -- | Header name
1537− ByteString ->
1538− -- | Header value
1539− ByteString ->
1540− Option scheme
1006+
1007+header
1008+ :: ByteString -- ^ Header name
1009+ -> ByteString -- ^ Header value
1010+ -> Option scheme
15411011header name value = withRequest (attachHeader name value)
15421012
1543−-- | Attach a header with given name and content to a 'L.Request'.
1544−--
1545−-- @since 1.1.0
1013+-- | A non-public helper that attaches a header with given name and content
1014+-- to a 'L.Request'.
1015+
15461016attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15471017attachHeader 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}
1018+ x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
15571019
15581020----------------------------------------------------------------------------
1559−-- Request—Optional parameters—Cookies
1021+-- Request — Optional parameters — Cookies
15601022
15611023-- $cookies
15621024--
1563−-- Support for cookies is quite minimalistic at the moment. It's possible to
1025+-- Support for cookies is quite minimalistic at the moment, its' possible to
15641026-- specify which cookies to send using 'cookieJar' and inspect 'L.Response'
15651027-- to extract 'L.CookieJar' from it (see 'responseCookieJar').
15661028
15671029-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
15681030-- 'L.Response' record.
1031+
15691032cookieJar :: L.CookieJar -> Option scheme
15701033cookieJar jar = withRequest $ \x ->
1571− x {L.cookieJar = Just jar}
1034+ x { L.cookieJar = Just jar }
15721035
15731036----------------------------------------------------------------------------
1574−-- Request—Optional parameters—Authentication
1037+-- Request — Optional parameters — Authentication
15751038
15761039-- $authentication
15771040--
1578−-- This section provides the common authentication helpers in the form of
1579−-- 'Option's. You should always prefer the provided authentication 'Option's
1580−-- to manual construction of headers because it ensures that you only use
1581−-- one authentication method at a time (they overwrite each other) and
1582−-- provides additional type safety that prevents leaking of credentials in
1583−-- the cases when authentication relies on HTTPS for encrypting sensitive
1584−-- data.
1041+-- This section provides common authentication helpers in form of 'Option's.
1042+-- You should always prefer the provided authentication 'Option's to manual
1043+-- construction of headers because it ensures that you only use one
1044+-- authentication method at a time (they overwrite each other) and provides
1045+-- additional type safety that prevents leaking of credentials in cases when
1046+-- authentication relies on TLS for encrypting sensitive data.
15851047
15861048-- | The 'Option' adds basic authentication.
15871049--
15881050-- 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)
1626−
1627−-- | The 'Option' adds OAuth1 authentication.
1628−--
1629−-- @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
1641−oAuth1 consumerToken consumerSecret token tokenSecret =
1642− customAuth (OAuth.signOAuth app creds)
1643− where
1644− app =
1645− OAuth.newOAuth
1646− { OAuth.oauthConsumerKey = consumerToken,
1647− OAuth.oauthConsumerSecret = consumerSecret
1648− }
1649− creds = OAuth.newCredential token tokenSecret
1051+
1052+basicAuth
1053+ :: ByteString -- ^ Username
1054+ -> ByteString -- ^ Password
1055+ -> Option 'Https -- ^ Auth 'Option'
1056+basicAuth username password = asFinalizer
1057+ (L.applyBasicAuth username password)
1058+
1059+-- | OAuth 1 authentication 'Option'.
1060+--
1061+-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1062+
1063+oAuth1
1064+ :: ByteString -- ^ Consumer token
1065+ -> ByteString -- ^ Consumer secret
1066+ -> ByteString -- ^ OAuth token
1067+ -> ByteString -- ^ OAuth token secret
1068+ -> Option scheme
1069+oAuth1 ctoken csecret otoken osecret = asFinalizer
1070+ (OAuth1.signRequest ctoken csecret otoken osecret)
16501071
16511072-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
16521073-- services as the equivalent of a username and password.
@@ -1656,14 +1077,12 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
16561077-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
16571078--
16581079-- 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))
1080+
1081+oAuth2Bearer
1082+ :: ByteString -- ^ Token
1083+ -> Option 'Https -- ^ Auth 'Option'
1084+oAuth2Bearer token = asFinalizer
1085+ (attachHeader "Authorization" ("Bearer " <> token))
16671086
16681087-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
16691088-- to be used only by GitHub). This will be treated by whatever services
@@ -1674,35 +1093,37 @@ oAuth2Bearer token =
16741093-- > oAuth2Token token = header "Authorization" ("token" <> token)
16751094--
16761095-- 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
1096+
1097+oAuth2Token
1098+ :: ByteString -- ^ Token
1099+ -> Option 'Https -- ^ Auth 'Option'
1100+oAuth2Token token = asFinalizer
1101+ (attachHeader "Authorization" ("token" <> token))
1102+
1103+-- | The 'Option' adds AWS v4 request signature.
1104+--
1105+-- See also: <https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html>.
1106+
1107+awsAuth
1108+ :: ByteString -- ^ AWS access key
1109+ -> ByteString -- ^ AWS secret access key
1110+ -> Option 'Https -- ^ Auth 'Option'
1111+awsAuth accessKey secretKey = asFinalizer
1112+ (AWS.signRequest accessKey secretKey)
16931113
16941114----------------------------------------------------------------------------
1695−-- Request—Optional parameters—Other
1115+-- Request — Optional parameters — Other
16961116
16971117-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1698−-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1699−-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1118+-- determines default port, @80@ for HTTP and @443@ for HTTPS, this 'Option'
1119+-- allows to choose arbitrary port overwriting the defaults.
1120+
17001121port :: Int -> Option scheme
17011122port n = withRequest $ \x ->
1702− x {L.port = n}
1123+ x { L.port = n }
17031124
17041125-- | This 'Option' controls whether gzipped data should be decompressed on
1705−-- the fly. By default everything except for @\"application\/x-tar\"@ is
1126+-- the fly. By default everything except for @application\/x-tar@ is
17061127-- decompressed, i.e. we have:
17071128--
17081129-- > decompress (/= "application/x-tar")
@@ -1710,342 +1131,262 @@ port n = withRequest $ \x ->
17101131-- You can also choose to decompress everything like this:
17111132--
17121133-- > 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
1134+
1135+decompress
1136+ :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1137+ -- returns 'True' when content should be decompressed on the fly.
1138+ -> Option scheme
17181139decompress f = withRequest $ \x ->
1719− x {L.decompress = f}
1720−
1721−-- | 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
1140+ x { L.decompress = f }
1141+
1142+-- | Specify number of microseconds to wait for response. Default is 30
1143+-- seconds.
1144+
1145+responseTimeout
1146+ :: Int -- ^ Number of microseconds to wait
1147+ -> Option scheme
17281148responseTimeout n = withRequest $ \x ->
1729− x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1730−
1731−-- | 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
1149+ x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1150+
1151+-- | HTTP version to send to server, default is HTTP 1.1.
1152+
1153+httpVersion
1154+ :: Int -- ^ Major version number
1155+ -> Int -- ^ Minor version number
1156+ -> Option scheme
17381157httpVersion major minor = withRequest $ \x ->
1739− x {L.requestVersion = Y.HttpVersion major minor}
1158+ x { L.requestVersion = Y.HttpVersion major minor }
17401159
17411160----------------------------------------------------------------------------
17421161-- Response interpretations
17431162
1744−-- | Make a request and ignore the body of the response.
1745−newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746− deriving (Show)
1163+-- | Make a request and ignore body of response.
1164+
1165+data IgnoreResponse = IgnoreResponse (L.Response ())
17471166
17481167instance HttpResponse IgnoreResponse where
17491168 type HttpResponseBody IgnoreResponse = ()
1750− toVanillaResponse (IgnoreResponse r) = r
1751− getHttpResponse r = return $ IgnoreResponse (void r)
1169+ toVanillaResponse (IgnoreResponse response) = response
1170+ getHttpResponse request manager =
1171+ IgnoreResponse <$> liftIO (L.httpNoBody request manager)
17521172
17531173-- | Use this as the fourth argument of 'req' to specify that you want it to
1754−-- ignore the response body.
1174+-- return the 'IgnoreResponse' interpretation.
1175+
17551176ignoreResponse :: Proxy IgnoreResponse
17561177ignoreResponse = Proxy
17571178
1758−-- | Make a request and interpret the body of the response as JSON. The
1179+-- | Make a request and interpret body of response as JSON. The
17591180-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
17601181-- monad in which you use 'req' will determine what to do in the case when
1761−-- parsing fails (the 'JsonHttpException' constructor will be used).
1182+-- parsing fails ('JsonHttpException' constructor will be used).
1183+
17621184newtype JsonResponse a = JsonResponse (L.Response a)
1763− deriving (Show)
17641185
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1186+instance FromJSON a => HttpResponse (JsonResponse a) where
17661187 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
1188+ toVanillaResponse (JsonResponse response) = response
1189+ getHttpResponse request manager = do
1190+ response <- L.httpLbs request manager
1191+ case A.eitherDecode (L.responseBody response) of
17711192 Left e -> throwIO (JsonHttpException e)
1772− Right x -> return $ JsonResponse (x <$ r)
1773− acceptHeader Proxy = Just "application/json"
1193+ Right x -> return $ JsonResponse response { L.responseBody = x }
17741194
1775−-- | Use this as the fourth argument of 'req' to specify that you want it to
1195+-- | Use this as the forth argument of 'req' to specify that you want it to
17761196-- return the 'JsonResponse' interpretation.
1197+
17771198jsonResponse :: Proxy (JsonResponse a)
17781199jsonResponse = Proxy
17791200
1780−-- | Make a request and interpret the body of the response as a strict
1781−-- 'ByteString'.
1201+-- | Make a request and interpret body of response as a strict 'ByteString'.
1202+
17821203newtype BsResponse = BsResponse (L.Response ByteString)
1783− deriving (Show)
17841204
17851205instance HttpResponse BsResponse where
17861206 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)
1207+ toVanillaResponse (BsResponse response) = response
1208+ getHttpResponse request manager =
1209+ L.withResponse request manager $ \response -> do
1210+ chunks <- L.brConsume (L.responseBody response)
1211+ return $ BsResponse response { L.responseBody = B.concat chunks }
1212+
1213+-- | Use this as the forth argument of 'req' to specify that you want to
1214+-- interpret response body as a strict 'ByteString'.
17911215
1792−-- | Use this as the fourth argument of 'req' to specify that you want to
1793−-- interpret the response body as a strict 'ByteString'.
17941216bsResponse :: Proxy BsResponse
17951217bsResponse = Proxy
17961218
1797−-- | Make a request and interpret the body of the response as a lazy
1219+-- | Make a request and interpret body of response as a lazy
17981220-- 'BL.ByteString'.
1221+
17991222newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800− deriving (Show)
18011223
18021224instance HttpResponse LbsResponse where
18031225 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)
1226+ toVanillaResponse (LbsResponse response) = response
1227+ getHttpResponse request manager =
1228+ LbsResponse <$> L.httpLbs request manager
1229+
1230+-- | Use this as the forth argument of 'req' to specify that you want to
1231+-- interpret response body as a lazy 'BL.ByteString'.
18081232
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'.
18111233lbsResponse :: Proxy LbsResponse
18121234lbsResponse = Proxy
18131235
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 [])
1236+-- | This interpretation does not result in any call at all, but you can use
1237+-- the 'responseRequest' function to extract 'L.Request' that 'req' has
1238+-- prepared. This is useful primarily for testing.
1239+--
1240+-- Note that when you use this interpretation inspecting response will
1241+-- diverge (i.e. it'll blow up with an error, don't do that).
1242+
1243+newtype ReturnRequest = ReturnRequest L.Request
1244+
1245+instance HttpResponse ReturnRequest where
1246+ type HttpResponseBody ReturnRequest = ()
1247+ toVanillaResponse (ReturnRequest _) = error
1248+ "Network.HTTP.Req.ReturnRequest interpretation does not make requests"
1249+ getHttpResponse request _ = return (ReturnRequest request)
1250+
1251+-- | Use this as the forth argument of 'req' to specify that you want it to
1252+-- just return the request it consturcted without making any requests.
1253+
1254+returnRequest :: Proxy ReturnRequest
1255+returnRequest = Proxy
18751256
18761257----------------------------------------------------------------------------
18771258-- Inspecting a response
18781259
1879−-- | Get the response body.
1880−responseBody ::
1881− (HttpResponse response) =>
1882− response ->
1883− HttpResponseBody response
1260+-- | Get response body.
1261+
1262+responseBody
1263+ :: HttpResponse response
1264+ => response
1265+ -> HttpResponseBody response
18841266responseBody = L.responseBody . toVanillaResponse
18851267
1886−-- | Get the response status code.
1887−responseStatusCode ::
1888− (HttpResponse response) =>
1889− response ->
1890− Int
1268+-- | Get response status code.
1269+
1270+responseStatusCode
1271+ :: HttpResponse response
1272+ => response
1273+ -> Int
18911274responseStatusCode =
18921275 Y.statusCode . L.responseStatus . toVanillaResponse
18931276
1894−-- | Get the response status message.
1895−responseStatusMessage ::
1896− (HttpResponse response) =>
1897− response ->
1898− ByteString
1277+-- | Get response status message.
1278+
1279+responseStatusMessage
1280+ :: HttpResponse response
1281+ => response
1282+ -> ByteString
18991283responseStatusMessage =
19001284 Y.statusMessage . L.responseStatus . toVanillaResponse
19011285
1902−-- | 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
1286+-- | Look a particular header from a response.
1287+
1288+responseHeader
1289+ :: HttpResponse response
1290+ => response -- ^ Response interpretation
1291+ -> ByteString -- ^ Header to lookup
1292+ -> Maybe ByteString -- ^ Header value if found
19111293responseHeader r h =
19121294 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
19131295
1914−-- | Get the response 'L.CookieJar'.
1915−responseCookieJar ::
1916− (HttpResponse response) =>
1917− response ->
1918− L.CookieJar
1296+-- | Get response 'L.CookieJar'.
1297+
1298+responseCookieJar
1299+ :: HttpResponse response
1300+ => response
1301+ -> L.CookieJar
19191302responseCookieJar = L.responseCookieJar . toVanillaResponse
19201303
1304+-- | Get the original request from 'ReturnRequest' response interpretation.
1305+
1306+responseRequest :: ReturnRequest -> L.Request
1307+responseRequest (ReturnRequest request) = request
1308+
19211309----------------------------------------------------------------------------
1922−-- Response—Defining your own interpretation
1310+-- Response — defining your own interpretation
19231311
19241312-- $new-response-interpretation
19251313--
19261314-- To create a new response interpretation you just need to make your data
1927−-- type an instance of the 'HttpResponse' type class.
1315+-- type an instance of 'HttpResponse' type class.
1316+
1317+-- | A type class for response interpretations. It allows to fully control
1318+-- how request is made and how its body is parsed.
19281319
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.
19321320class HttpResponse response where
1933− -- | The associated type is the type of body that can be extracted from an
1321+
1322+ -- | The associated type is type of body that can be extracted from a
19341323 -- instance of 'HttpResponse'.
1935− type HttpResponseBody response :: Type
19361324
1937− -- | The method describes how to get the underlying 'L.Response' record.
1325+ type HttpResponseBody response :: *
1326+
1327+ -- | The method describes how to get underlying 'L.Response' record.
1328+
19381329 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
19391330
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
1331+ -- | This method describes how to make an HTTP request given 'L.Request'
1332+ -- (prepared by the rest of the library) and 'L.Manager'.
1333+
1334+ getHttpResponse :: L.Request -> L.Manager -> IO response
19791335
19801336----------------------------------------------------------------------------
19811337-- Other
19821338
19831339-- | The main class for things that are “parts” of 'L.Request' in the sense
19841340-- that if we have a 'L.Request', then we know how to apply an instance of
1985−-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1986−-- monoid of endomorphisms under composition, it's used to chain different
1987−-- request components easier using @('<>')@.
1988−--
1989−-- __Note__: this type class is not a part of the public API.
1341+-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is
1342+-- endomorphism of functions under composition, it's used to chain different
1343+-- request component easier using @('<>')@.
1344+
19901345class RequestComponent a where
1346+
19911347 -- | 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.
1348+ -- returning another 'L.Request'. For example HTTP method instance of
1349+ -- 'RequestComponent' just overwrites method. The function is wrapped in
1350+ -- 'Endo' so it's easier to chain such “modifying applications” together
1351+ -- building bigger and bigger 'RequestComponent's.
1352+
19961353 getRequestMod :: a -> Endo L.Request
19971354
1998−-- | This wrapper is only used to attach a type-level tag to a given type.
1355+-- | This wrapper is only used to attach a type-level tag to given type.
19991356-- This is necessary to define instances of 'RequestComponent' for any thing
2000−-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC can't
2001−-- see the difference between @'HttpMethod' method => 'RequestComponent'
1357+-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC is not
1358+-- able to see difference between @'HttpMethod' method => 'RequestComponent'
20021359-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
2003−-- which instance to use (i.e. the constraints are taken into account later,
1360+-- which instance to use (i.e. constraints are taken into account later,
20041361-- when instance is already chosen).
2005−newtype Tagged (tag :: Symbol) a = Tagged a
1362+
1363+newtype Womb (tag :: Symbol) a = Womb a
20061364
20071365-- | Exceptions that this library throws.
1366+
20081367data 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)
1368+ = VanillaHttpException L.HttpException
1369+ -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1370+ | JsonHttpException String
1371+ -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
1372+ deriving (Show, Typeable, Generic)
20151373
20161374instance Exception HttpException
20171375
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.
1376+-- | A simple 'Bool'-like type we only have for better error messages. We
1377+-- use it as a kind and its data constructors as type-level tags.
20351378--
20361379-- See also: 'HttpMethod' and 'HttpBody'.
1380+
20371381data CanHaveBody
2038− = -- | Indeed can have a body
2039− CanHaveBody
2040− | -- | Should not have a body
2041− NoBody
1382+ = CanHaveBody -- ^ Indeed can have a body
1383+ | NoBody -- ^ Should not have a body
20421384
2043−-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
1385+-- | A type-level tag that specifies URL scheme used (and thus if TLS is
20441386-- enabled). This is used to force TLS requirement for some authentication
20451387-- 'Option's.
1388+
20461389data Scheme
2047− = -- | HTTP
2048− Http
2049− | -- | HTTPS
2050− Https
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1390+ = Http -- ^ HTTP, no TLS
1391+ | Https -- ^ HTTPS
1392+ deriving (Eq, Ord, Show, Data, Typeable, Generic)