@@ -1,307 +1,620 @@
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE QuasiQuotes #-}
5+{-# LANGUAGE RecordWildCards #-}
6+{-# LANGUAGE RoleAnnotations #-}
7+{-# LANGUAGE TemplateHaskellQuotes #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+
111-- |
212-- Module : Network.HTTP.Req
3−-- Copyright : © 2016 Mark Karpov
13+-- Copyright : © 2016–present Mark Karpov
414-- License : BSD 3 clause
515--
6−-- Maintainer : Mark Karpov <markkarpov@openmailbox.org>
16+-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
717-- Stability : experimental
818-- Portability : portable
919--
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.)/
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.
1826--
1927-- === About the library
2028--
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 compared to alternative libraries like @wreq@ or vanilla
37−-- @http-client@ and friends. For example, we have correct-by-construction
38−-- 'Url's, it's guaranteed that user does not send request body when using
39−-- methods like 'GET' or 'OPTIONS', amount of implicit assumptions is
40−-- minimized by making user specify his\/her intentions in explicit form
41−-- (for example, it's not possible to avoid specifying body or method of a
42−-- request). Authentication methods that assume TLS force user to use TLS on
43−-- type level. The library carefully hides underlying types from lower-level
44−-- @http-client@ package because it's not type safe enough (for example
45−-- 'L.Request' is an instance of 'Data.String.IsString' and if it's
46−-- malformed, it will blow up at run-time).
47−--
48−-- “Expandable” refers to the ability of the library to be expanded without
49−-- ugly hacking. For example, it's possible to define your own HTTP methods,
50−-- new ways to construct body of request, new authorization options, new
51−-- ways to actually perform request and how to represent\/parse response. As
52−-- user extends the library to satisfy his\/her special needs, the new
53−-- solutions work just like built-ins. That said, all common cases are
54−-- covered by the library out-of-the-box.
55−--
56−-- “High-level” means that there are less details to worry about. The
57−-- library is a result of my experiences as a Haskell consultant, working
58−-- for several clients who have very different projects and so the library
59−-- adapts easily to any particular style of writing Haskell applications.
60−-- For example, some people prefer throwing exceptions, while others are
61−-- concerned with purity: just define 'handleHttpException' accordingly when
62−-- making your monad instance of 'MonadHttp' and it will play seamlessly.
63−-- Finally, the library cuts boilerplate considerably and helps write
64−-- concise, easy to read and maintain code.
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30+-- and expandable.
31+--
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
33+-- so it's simple to add to your monad stack, intuitive to work with,
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
35+-- common task and a Haskell library for this should be approachable and
36+-- clear to beginners, thus certain compromises were made. For example, one
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
39+-- simplicity and maximal connection sharing. There is a way to use your own
40+-- manager with different settings, but it requires more typing.
41+--
42+-- “Type-safe” means that the library tries to eliminate certain classes of
43+-- errors. For example, we have correct-by-construction URLs; it is
44+-- guaranteed that the user does not send the request body when using
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46+-- minimized by making the user specify their intentions in an explicit
47+-- form. For example, it's not possible to avoid specifying the body or the
48+-- method of a request. Authentication methods that assume HTTPS force the
49+-- user to use HTTPS at the type level.
50+--
51+-- “Expandable” refers to the ability to create new components without
52+-- having to resort to hacking. For example, it's possible to define your
53+-- own HTTP methods, create new ways to construct the body of a request,
54+-- create new authorization options, perform a request in a different way,
55+-- and create your own methods to parse a response.
6556--
6657-- === Using with other libraries
6758--
68−-- * You won't need low-level interface of @http-client@ most of the
69−-- time, but when you do, it's better import it qualified because it
70−-- has naming conflicts with @req@.
71−-- * For streaming of large request bodies see companion package
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
7263-- @req-conduit@: <https://hackage.haskell.org/package/req-conduit>.
7364--
7465-- === Lightweight, no risk solution
7566--
7667-- The library uses the following mature packages under the hood to
77−-- guarantee you best experience without bugs or other funny business:
68+-- guarantee you the best experience:
7869--
79−-- * <https://hackage.haskell.org/package/http-client> — low level HTTP
70+-- * <https://hackage.haskell.org/package/http-client>—low level HTTP
8071-- client used everywhere in Haskell.
81−-- * <https://hackage.haskell.org/package/http-client-tls> — TLS (HTTPS)
72+-- * <https://hackage.haskell.org/package/http-client-tls>—TLS (HTTPS)
8273-- support for @http-client@.
8374--
8475-- It's important to note that since we leverage well-known libraries that
85−-- the whole Haskell ecosystem uses, there is no risk in using @req@, as the
76+-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
8677-- machinery for performing requests is the same as with @http-conduit@ and
87−-- @wreq@, it's just the API is different.
88−
89−{-# LANGUAGE CPP #-}
90−{-# LANGUAGE DataKinds #-}
91−{-# LANGUAGE DeriveDataTypeable #-}
92−{-# LANGUAGE DeriveGeneric #-}
93−{-# LANGUAGE FlexibleInstances #-}
94−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
95−{-# LANGUAGE KindSignatures #-}
96−{-# LANGUAGE OverloadedStrings #-}
97−{-# LANGUAGE RecordWildCards #-}
98−{-# LANGUAGE ScopedTypeVariables #-}
99−{-# LANGUAGE TypeFamilies #-}
100−
101−#if __GLASGOW_HASKELL__ >= 800
102−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
103−#endif
104−
78+-- @wreq@. The only difference is the API.
10579module Network.HTTP.Req
10680 ( -- * Making a request
10781 -- $making-a-request
108− req
109− -- * Embedding requests into your monad
82+ req,
83+ reqBr,
84+ reqCb,
85+ req',
86+ withReqManager,
87+
88+ -- * Embedding requests in your monad
11089 -- $embedding-requests
111− , MonadHttp (..)
112− , HttpConfig (..)
90+ MonadHttp (..),
91+ HttpConfig (..),
92+ defaultHttpConfig,
93+ Req,
94+ runReq,
95+
11396 -- * Request
97+
11498 -- ** Method
11599 -- $method
116− , GET (..)
117− , POST (..)
118− , HEAD (..)
119− , PUT (..)
120− , DELETE (..)
121− , TRACE (..)
122− , CONNECT (..)
123− , OPTIONS (..)
124− , PATCH (..)
125− , HttpMethod (..)
100+ GET (..),
101+ POST (..),
102+ HEAD (..),
103+ PUT (..),
104+ DELETE (..),
105+ TRACE (..),
106+ CONNECT (..),
107+ OPTIONS (..),
108+ PATCH (..),
109+ HttpMethod (..),
110+
126111 -- ** URL
127112 -- $url
128− , Url
129− , http
130− , https
131− , (/~)
132− , (/:)
133− , parseUrlHttp
134− , parseUrlHttps
113+ Url,
114+ http,
115+ https,
116+ (/~),
117+ (/:),
118+ useHttpURI,
119+ useHttpsURI,
120+ useURI,
121+ urlQ,
122+ renderUrl,
123+
135124 -- ** Body
136125 -- $body
137− , NoReqBody (..)
138− , ReqBodyJSON (..)
139− , ReqBodyFile (..)
140− , ReqBodyBs (..)
141− , ReqBodyLbs (..)
142− , ReqBodyUrlEnc (..)
143− , FormUrlEncodedParam
144− , HttpBody (..)
145− , ProvidesBody
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+
146139 -- ** Optional parameters
147140 -- $optional-parameters
148− , Option
141+ Option,
142+
149143 -- *** Query parameters
150144 -- $query-parameters
151− , (=:)
152− , queryFlag
153− , QueryParam (..)
145+ (=:),
146+ queryFlag,
147+ formToQuery,
148+ QueryParam (..),
149+
154150 -- *** Headers
155− , header
151+ header,
152+ attachHeader,
153+ headerRedacted,
154+
156155 -- *** Cookies
157156 -- $cookies
158− , cookieJar
157+ cookieJar,
158+
159159 -- *** Authentication
160160 -- $authentication
161− , basicAuth
162− , oAuth1
163− , oAuth2Bearer
164− , oAuth2Token
165− , awsAuth
161+ basicAuth,
162+ basicAuthUnsafe,
163+ basicProxyAuth,
164+ oAuth1,
165+ oAuth2Bearer,
166+ oAuth2Token,
167+ customAuth,
168+
166169 -- *** Other
167− , port
168− , decompress
169− , responseTimeout
170− , httpVersion
170+ port,
171+ decompress,
172+ responseTimeout,
173+ httpVersion,
174+
171175 -- * Response
172− -- $response
176+
173177 -- ** Response interpretations
174− , IgnoreResponse
175− , ignoreResponse
176− , JsonResponse
177− , jsonResponse
178− , BsResponse
179− , bsResponse
180− , LbsResponse
181− , lbsResponse
182− , ReturnRequest
183− , returnRequest
178+ IgnoreResponse,
179+ ignoreResponse,
180+ JsonResponse,
181+ jsonResponse,
182+ BsResponse,
183+ bsResponse,
184+ LbsResponse,
185+ lbsResponse,
186+
184187 -- ** Inspecting a response
185− , responseBody
186− , responseStatusCode
187− , responseStatusMessage
188− , responseHeader
189− , responseCookieJar
190− , responseRequest
188+ responseBody,
189+ responseStatusCode,
190+ responseStatusMessage,
191+ responseHeader,
192+ responseCookieJar,
193+
191194 -- ** Defining your own interpretation
192− , HttpResponse (..)
195+ -- $new-response-interpretation
196+ HttpResponse (..),
197+
193198 -- * Other
194− , HttpException (..)
195− , CanHaveBody (..)
196− , Scheme (..) )
199+ HttpException (..),
200+ isStatusCodeException,
201+ CanHaveBody (..),
202+ Scheme (..),
203+ )
197204where
198205
206+import Blaze.ByteString.Builder qualified as BB
199207import Control.Applicative
200208import Control.Arrow (first, second)
201−import Control.Exception (Exception, try, catch, throwIO)
202−import Control.Monad
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
211+import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
203213import Control.Monad.IO.Class
204−import Data.Aeson (ToJSON (..), FromJSON (..))
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
205234import 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
206238import Data.Data (Data)
207−import Data.Default.Class
239+import Data.Default.Class (def)
208240import Data.Function (on)
209241import Data.IORef
210−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
211244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
246+import Data.Maybe (fromMaybe)
212247import Data.Proxy
213−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
214250import Data.Text (Text)
215−import Data.Typeable (Typeable)
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
253+import Data.Typeable (Typeable, cast)
216254import GHC.Generics
217255import 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
218265import 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
219272import Web.HttpApiData (ToHttpApiData (..))
220−import qualified Blaze.ByteString.Builder as BB
221−import qualified Data.Aeson as A
222−import qualified Data.Binary.Builder as R
223−import qualified Data.ByteString as B
224−import qualified Data.ByteString.Lazy as BL
225−import qualified Data.CaseInsensitive as CI
226−import qualified Data.List.NonEmpty as NE
227−import qualified Data.Text.Encoding as T
228−import qualified Network.Connection as NC
229−import qualified Network.HTTP.Client as L
230−import qualified Network.HTTP.Client.Internal as LI
231−import qualified Network.HTTP.Client.TLS as L
232−import qualified Network.HTTP.Req.AWS as AWS
233−import qualified Network.HTTP.Req.OAuth1 as OAuth1
234−import qualified Network.HTTP.Types as Y
235273
236274----------------------------------------------------------------------------
237275-- Making a request
238276
239277-- $making-a-request
240278--
241−-- To make an HTTP request you need only one function: 'req'.
242−
243−-- | Make an HTTP request.
244−--
245−-- TODO Finish docs of this function when the package is more developed.
246−
247−req
248− :: forall m method body response scheme.
249− ( MonadHttp m
250− , HttpMethod method
251− , HttpBody body
252− , HttpResponse response
253− , AllowsBody method ~ ProvidesBody body )
254− => method -- ^ HTTP method
255− -> Url scheme -- ^ 'Url' — location of resource
256− -> body -- ^ Body of the request
257− -> Proxy response -- ^ A hint how to interpret response
258− -> Option scheme -- ^ Collection of optional parameters
259− -> m response -- ^ Response
260−req method url body Proxy options = do
261− config <- getHttpConfig
262− manager <- liftIO (readIORef globalManager)
279+-- To make an HTTP request you normally need only one function: 'req'.
280+
281+-- | Make an HTTP request. The function takes 5 arguments, 4 of which
282+-- specify required parameters and the final 'Option' argument is a
283+-- collection of optional parameters.
284+--
285+-- Let's go through all the arguments first: @req method url body response
286+-- options@.
287+--
288+-- @method@ is an HTTP method such as 'GET' or 'POST'. The documentation has
289+-- a dedicated section about HTTP methods below.
290+--
291+-- @url@ is a 'Url' that describes location of resource you want to interact
292+-- with.
293+--
294+-- @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
309+-- corresponding section in the documentation. If you don't need anything at
310+-- all, pass 'mempty'.
311+--
312+-- __Note__ that if you use 'req' to do all your requests, connection
313+-- sharing and reuse is done for you automatically.
314+--
315+-- See the examples below to get on the speed quickly.
316+--
317+-- ==== __Examples__
318+--
319+-- First, this is a piece of boilerplate that should be in place before you
320+-- try the examples:
321+--
322+-- > {-# LANGUAGE DeriveGeneric #-}
323+-- > {-# LANGUAGE OverloadedStrings #-}
324+-- >
325+-- > module Main (main) where
326+-- >
327+-- > import Control.Monad
328+-- > import Control.Monad.IO.Class
329+-- > import Data.Aeson
330+-- > import Data.Maybe (fromJust)
331+-- > import Data.Monoid ((<>))
332+-- > import Data.Text (Text)
333+-- > import GHC.Generics
334+-- > import Network.HTTP.Req
335+-- > import qualified Data.ByteString.Char8 as B
336+-- > import qualified Text.URI as URI
337+--
338+-- We will be making requests against the <https://httpbin.org> service.
339+--
340+-- Make a GET request, grab 5 random bytes:
341+--
342+-- > main :: IO ()
343+-- > main = runReq defaultHttpConfig $ do
344+-- > let n :: Int
345+-- > n = 5
346+-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
347+-- > liftIO $ B.putStrLn (responseBody bs)
348+--
349+-- The same, but now we use a query parameter named @\"seed\"@ to control
350+-- seed of the generator:
351+--
352+-- > main :: IO ()
353+-- > main = runReq defaultHttpConfig $ do
354+-- > let n, seed :: Int
355+-- > n = 5
356+-- > seed = 100
357+-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
358+-- > "seed" =: seed
359+-- > liftIO $ B.putStrLn (responseBody bs)
360+--
361+-- POST JSON data and get some info about the POST request:
362+--
363+-- > data MyData = MyData
364+-- > { size :: Int
365+-- > , color :: Text
366+-- > } deriving (Show, Generic)
367+-- >
368+-- > instance ToJSON MyData
369+-- > instance FromJSON MyData
370+-- >
371+-- > main :: IO ()
372+-- > main = runReq defaultHttpConfig $ do
373+-- > let myData = MyData
374+-- > { size = 6
375+-- > , color = "Green" }
376+-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
377+-- > liftIO $ print (responseBody v :: Value)
378+--
379+-- Sending URL-encoded body:
380+--
381+-- > main :: IO ()
382+-- > main = runReq defaultHttpConfig $ do
383+-- > let params =
384+-- > "foo" =: ("bar" :: Text) <>
385+-- > queryFlag "baz"
386+-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
387+-- > liftIO $ print (responseBody response :: Value)
388+--
389+-- Using various optional parameters and URL that is not known in advance:
390+--
391+-- > main :: IO ()
392+-- > main = runReq defaultHttpConfig $ do
393+-- > -- This is an example of what to do when URL is given dynamically. Of
394+-- > -- 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)
397+-- > response <- req GET url NoReqBody jsonResponse $
398+-- > "from" =: (15 :: Int) <>
399+-- > "to" =: (67 :: Int) <>
400+-- > basicAuth "username" "password" <>
401+-- > options <> -- contains the ?foo=bar part
402+-- > 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
263567 let -- NOTE First appearance of any given header wins. This allows to
264568 -- “overwrite” headers when we construct a request by cons-ing.
265569 nubHeaders = Endo $ \x ->
266− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
267− request = flip appEndo L.defaultRequest $
268− -- NOTE Order of 'mappend's matters, here method is overwritten first
269− -- and 'options' take effect last. In particular, this means that
270− -- 'options' can overwrite things set by other request components,
271− -- which is useful for setting port number, "Content-Type" header,
272− -- etc.
273− nubHeaders <>
274− getRequestMod options <>
275− getRequestMod config <>
276− getRequestMod (Womb body :: Womb "body" body) <>
277− getRequestMod url <>
278− getRequestMod (Womb method :: Womb "method" method)
279− wrappingVanilla m = catch m (throwIO . VanillaHttpException)
280− (liftIO . try . wrappingVanilla) (getHttpResponse request manager)
281− >>= either handleHttpException return
282−
283−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
284−-- settings, so users don't need to deal with this manager stuff at all, but
285−-- when we create a request, instance 'HttpConfig' can affect the default
286−-- settings via 'getHttpConfig'.
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'.
287597--
288598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
289599-- The value of 'globalManager' is named and lives on top level. This means
290−-- it will be shared, i.e. computed only once on first use of manager. From
291−-- that moment on the 'IORef' will be just reused — exactly the behaviour we
292−-- want here in order to maximize connection sharing. GHC could spoil the
293−-- plan by inlining the definition, hence the @NOINLINE@ pragma.
294−
295−globalManager :: IORef L.Manager
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
296605globalManager = unsafePerformIO $ do
297606 context <- NC.initConnectionContext
298− let settings = L.mkManagerSettingsContext (Just context) def Nothing
607+ let settings =
608+ L.mkManagerSettingsContext
609+ (Just context)
610+ def
611+ Nothing
299612 manager <- L.newManager settings
300− newIORef manager
613+ return manager
301614{-# NOINLINE globalManager #-}
302615
303616----------------------------------------------------------------------------
304−-- Embedding requests into your monad
617+-- Embedding requests in your monad
305618
306619-- $embedding-requests
307620--
@@ -310,91 +623,281 @@ globalManager = unsafePerformIO $ do
310623--
311624-- When writing a library, keep your API polymorphic in terms of
312625-- '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).
313629
314630-- | A type class for monads that support performing HTTP requests.
315631-- Typically, you only need to define the 'handleHttpException' method
316632-- unless you want to tweak 'HttpConfig'.
317−
318−class MonadIO m => MonadHttp m where
319−
320− {-# MINIMAL handleHttpException #-}
321−
633+class (MonadIO m) => MonadHttp m where
322634 -- | This method describes how to deal with 'HttpException' that was
323635 -- caught by the library. One option is to re-throw it if you are OK with
324636 -- exceptions, but if you prefer working with something like
325− -- 'Control.Monad.Error.MonadError', this is the right place to pass it to
326− -- 'Control.Monad.Error.throwError' for example.
327−
637+ -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
638+ -- 'Control.Monad.Except.throwError'.
328639 handleHttpException :: HttpException -> m a
329640
330− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
331− -- implementation returns its 'def' value, which is described in the
332− -- documentation for the type. Common usage pattern with manually defined
333− -- 'getHttpConfig' is to return some hard-coded value, or value extracted
334− -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
335− -- configuration is desirable.
336−
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.
337647 getHttpConfig :: m HttpConfig
338− getHttpConfig = return def
339−
340−-- | 'HttpConfig' contains general and default settings to be used when
341−-- making HTTP requests.
648+ getHttpConfig = return defaultHttpConfig
342649
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
343651data HttpConfig = HttpConfig
344− { httpConfigProxy :: Maybe L.Proxy
345− -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
652+ { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
346653 -- environment variables are respected, this setting overwrites them.
347654 -- Default value: 'Nothing'.
348− , httpConfigRedirectCount :: Int
349− -- ^ How many redirects to follow when getting a resource. Default
655+ httpConfigProxy :: Maybe L.Proxy,
656+ -- | How many redirects to follow when getting a resource. Default
350657 -- value: 10.
351− , httpConfigAltManager :: Maybe L.Manager
352− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
353− -- that default implicit manager will be used (that's what you want in
354− -- 99% of cases).
355− , httpConfigCheckResponse :: L.Request -> L.Response L.BodyReader -> IO ()
356− -- ^ Function to check the response immediately after receiving the
357− -- status and headers. This is used for throwing exceptions on
358− -- non-success status codes by default (set to @\\_ _ -> return ()@ if
359− -- this behavior is not desirable). Throwing is better then just
360− -- returning a request with non-2xx status code because in that case
361− -- something is wrong and we need a way to short-cut execution. The
362− -- thrown exception is caught by the library though and is available in
363− -- 'handleHttpException'.
364− } deriving Typeable
365−
366−instance Default HttpConfig where
367− def = HttpConfig
368− { httpConfigProxy = Nothing
369− , httpConfigRedirectCount = 10
370− , httpConfigAltManager = Nothing
371− , httpConfigCheckResponse = \_ response ->
372− let Y.Status statusCode _ = L.responseStatus response in
373− unless (200 <= statusCode && statusCode < 300) $ do
374− chunk <- BL.toStrict <$> L.brReadSome (L.responseBody response) 1024
375− LI.throwHttp (L.StatusCodeException (void response) chunk) }
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
376755
377756instance RequestComponent HttpConfig where
378757 getRequestMod HttpConfig {..} = Endo $ \x ->
379− x { L.proxy = httpConfigProxy
380− , L.redirectCount = httpConfigRedirectCount
381− , LI.requestManagerOverride = httpConfigAltManager
382− , LI.checkResponse = httpConfigCheckResponse }
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)
383887
384888----------------------------------------------------------------------------
385−-- Request — Method
889+-- Request—Method
386890
387891-- $method
388892--
389893-- The package supports all methods as defined by RFC 2616, and 'PATCH'
390−-- which is defined by RFC 5789 — that should be enough to talk to RESTful
894+-- which is defined by RFC 5789—that should be enough to talk to RESTful
391895-- APIs. In some cases, however, you may want to add more methods (e.g. you
392896-- work with WebDAV <https://en.wikipedia.org/wiki/WebDAV>); no need to
393897-- compromise on type safety and hack, it only takes a couple of seconds to
394898-- define a new method that will works seamlessly, see 'HttpMethod'.
395899
396900-- | 'GET' method.
397−
398901data GET = GET
399902
400903instance HttpMethod GET where
@@ -402,7 +905,6 @@ instance HttpMethod GET where
402905 httpMethodName Proxy = Y.methodGet
403906
404907-- | 'POST' method.
405−
406908data POST = POST
407909
408910instance HttpMethod POST where
@@ -410,7 +912,6 @@ instance HttpMethod POST where
410912 httpMethodName Proxy = Y.methodPost
411913
412914-- | 'HEAD' method.
413−
414915data HEAD = HEAD
415916
416917instance HttpMethod HEAD where
@@ -418,26 +919,24 @@ instance HttpMethod HEAD where
418919 httpMethodName Proxy = Y.methodHead
419920
420921-- | 'PUT' method.
421−
422922data PUT = PUT
423923
424924instance HttpMethod PUT where
425925 type AllowsBody PUT = 'CanHaveBody
426926 httpMethodName Proxy = Y.methodPut
427927
428−-- | 'DELETE' method. This data type does not allow having request body with
429−-- 'DELETE' requests, as it should be, however some APIs may expect 'DELETE'
430−-- requests to have bodies, in that case define your own variation of
431−-- 'DELETE' method and allow it to have a body.
432−
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.
433933data DELETE = DELETE
434934
435935instance HttpMethod DELETE where
436− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
437937 httpMethodName Proxy = Y.methodDelete
438938
439939-- | 'TRACE' method.
440−
441940data TRACE = TRACE
442941
443942instance HttpMethod TRACE where
@@ -445,7 +944,6 @@ instance HttpMethod TRACE where
445944 httpMethodName Proxy = Y.methodTrace
446945
447946-- | 'CONNECT' method.
448−
449947data CONNECT = CONNECT
450948
451949instance HttpMethod CONNECT where
@@ -453,7 +951,6 @@ instance HttpMethod CONNECT where
453951 httpMethodName Proxy = Y.methodConnect
454952
455953-- | 'OPTIONS' method.
456−
457954data OPTIONS = OPTIONS
458955
459956instance HttpMethod OPTIONS where
@@ -461,7 +958,6 @@ instance HttpMethod OPTIONS where
461958 httpMethodName Proxy = Y.methodOptions
462959
463960-- | 'PATCH' method.
464−
465961data PATCH = PATCH
466962
467963instance HttpMethod PATCH where
@@ -469,47 +965,43 @@ instance HttpMethod PATCH where
469965 httpMethodName Proxy = Y.methodPatch
470966
471967-- | A type class for types that can be used as an HTTP method. To define a
472−-- non-standard method, follow this example that defines COPY:
968+-- non-standard method, follow this example that defines @COPY@:
473969--
474970-- > data COPY = COPY
475971-- >
476972-- > instance HttpMethod COPY where
477973-- > type AllowsBody COPY = 'CanHaveBody
478974-- > httpMethodName Proxy = "COPY"
479−
480975class HttpMethod a where
481−
482− -- | Type function 'AllowsBody' returns type of kind 'CanHaveBody' which
483− -- tells the rest of the library whether the method can have a body or
484− -- not. We use the special type 'CanHaveBody' “lifted” into kind instead
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
485979 -- of 'Bool' to get more user-friendly compiler messages.
486−
487980 type AllowsBody a :: CanHaveBody
488981
489982 -- | Return name of the method as a 'ByteString'.
490−
491983 httpMethodName :: Proxy a -> ByteString
492984
493−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
494986 getRequestMod _ = Endo $ \x ->
495− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
496988
497989----------------------------------------------------------------------------
498−-- Request — URL
990+-- Request—URL
499991
500992-- $url
501993--
502994-- We use 'Url's which are correct by construction, see 'Url'. To build a
503−-- 'Url' from 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
504996
505997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
506998-- specifying the scheme and host at the same time. Then use the @('/~')@
507−-- and @('/:')@ operators to grow path one piece at a time. Every single
508−-- piece of path will be url(percent)-encoded, so @('/:')@ is the only way
509−-- to have forward slashes between path segments. This approach makes
510−-- working with dynamic path segments easy and safe. See examples below how
511−-- to represent various 'Url's (make sure the @OverloadedStrings@ language
512−-- extension is enabled).
999+-- and @('/:')@ operators to grow the path one piece at a time. Every single
1000+-- piece of path will be url(percent)-encoded, so using @('/~')@ and
1001+-- @('/:')@ is the only way to have forward slashes between path segments.
1002+-- This approach makes working with dynamic path segments easy and safe. See
1003+-- examples below how to represent various 'Url's (make sure the
1004+-- @OverloadedStrings@ language extension is enabled).
5131005--
5141006-- ==== __Examples__
5151007--
@@ -530,125 +1022,233 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
5301022--
5311023-- > https "юникод.рф"
5321024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
533−
5341025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
535− -- NOTE The second value is path segments in reversed order.
536− deriving (Eq, Ord, Show, Data, Typeable, Generic)
537−
538−-- | Given host name, produce a 'Url' which have “http” as its scheme and
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
5391043-- empty path. This also sets port to @80@.
540−
5411044http :: Text -> Url 'Http
5421045http = Url Http . pure
5431046
544−-- | Given host name, produce a 'Url' which have “https” as its scheme and
1047+-- | Given host name, produce a 'Url' which has “https” as its scheme and
5451048-- empty path. This also sets port to @443@.
546−
5471049https :: Text -> Url 'Https
5481050https = Url Https . pure
5491051
550−-- | Grow given 'Url' appending a single path segment to it. Note that the
1052+-- | Grow a given 'Url' appending a single path segment to it. Note that the
5511053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
552−
5531054infixl 5 /~
554−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
555−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
5561055
557−-- | Type-constrained version of @('/~')@ to remove ambiguity in cases when
558−-- next URL piece is a 'Text' literal.
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
1057+Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
5591058
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
5601061infixl 5 /:
1062+
5611063(/:) :: Url scheme -> Text -> Url scheme
5621064(/:) = (/~)
5631065
564−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
565−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
566−-- you are given a URL to query dynamically and don't know it beforehand.
567−-- The function parses 'ByteString' because it's the correct type to
568−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
569−-- range, thus we can consider every character a 'Data.Word.Word8' value.
570−--
571−-- This function only parses 'Url' (scheme, host, path) and optional query
572−-- parameters that are returned as 'Option'. It does not parse method name
573−-- or authentication info from given 'ByteString'.
574−
575−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
576−parseUrlHttp url' = do
577− url <- B.stripPrefix "http://" url'
578− (host :| path, option) <- parseUrlHelper url
579− return (foldl (/:) (http host) path, option)
580−
581−-- | Just like 'parseUrlHttp', but expects “https” scheme.
582−
583−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
584−parseUrlHttps url' = do
585− url <- B.stripPrefix "https://" url'
586− (host :| path, option) <- parseUrlHelper url
587− return (foldl (/:) (https host) path, option)
588−
589−-- | Get host\/collection of path pieces and possibly query parameters
590−-- already converted to 'Option'. This function is not public.
591−
592−parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
593−parseUrlHelper url = do
594− let (path', query') = B.break (== 0x3f) url
595− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
596− path <- NE.nonEmpty (Y.decodePathSegments path')
597− return (path, query)
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'')
5981198
5991199instance RequestComponent (Url scheme) where
6001200 getRequestMod (Url scheme segments) = Endo $ \x ->
601− let (host :| path) = NE.reverse segments in
602− x { L.secure = case scheme of
603− Http -> False
604− Https -> True
605− , L.port = case scheme of
606− Http -> 80
607− Https -> 443
608− , L.host = Y.urlEncode False (T.encodeUtf8 host)
609− , L.path =
610− (BL.toStrict . R.toLazyByteString . Y.encodePathSegments) path }
1201+ let (host :| path) = NE.reverse segments
1202+ in x
1203+ { L.secure = case scheme of
1204+ Http -> False
1205+ Https -> True,
1206+ L.port = case scheme of
1207+ Http -> 80
1208+ Https -> 443,
1209+ L.host = Y.urlEncode False (T.encodeUtf8 host),
1210+ L.path =
1211+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
1212+ }
6111213
6121214----------------------------------------------------------------------------
613−-- Request — Body
1215+-- Request—Body
6141216
6151217-- $body
6161218--
6171219-- A number of options for request bodies are available. The @Content-Type@
618−-- header is set for you automatically according to body option you use
619−-- (it's always specified in documentation for given body option). To add
620−-- your own way to represent request body, see 'HttpBody'.
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'.
6211224
6221225-- | This data type represents empty body of an HTTP request. This is the
6231226-- data type to use with 'HttpMethod's that cannot have a body, as it's the
6241227-- only type for which 'ProvidesBody' returns 'NoBody'.
6251228--
6261229-- Using of this body option does not set the @Content-Type@ header.
627−
6281230data NoReqBody = NoReqBody
6291231
6301232instance HttpBody NoReqBody where
6311233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
6321234
633−-- | This body option allows to use a JSON object as request body — probably
634−-- the most popular format right now. Just wrap a data type that is an
635−-- instance of 'ToJSON' type class and you are done: it will be converted to
636−-- JSON and inserted as request body.
1235+-- | This body option allows us to use a JSON object as the request
1236+-- body—probably the most popular format right now. Just wrap a data type
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
1238+-- converted to JSON and inserted as request body.
6371239--
6381240-- This body option sets the @Content-Type@ header to @\"application/json;
6391241-- charset=utf-8\"@ value.
1242+newtype ReqBodyJson a = ReqBodyJson a
6401243
641−newtype ReqBodyJSON a = ReqBodyJSON a
642−
643−instance ToJSON a => HttpBody (ReqBodyJSON a) where
644− getRequestBody (ReqBodyJSON a) = L.RequestBodyLBS (A.encode a)
645− getRequestContentType Proxy = pure "application/json; charset=utf-8"
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
1245+ getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1246+ getRequestContentType _ = pure "application/json; charset=utf-8"
6461247
6471248-- | This body option streams request body from a file. It is expected that
648−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
6491250--
6501251-- Using of this body option does not set the @Content-Type@ header.
651−
6521252newtype ReqBodyFile = ReqBodyFile FilePath
6531253
6541254instance HttpBody ReqBodyFile where
@@ -658,7 +1258,6 @@ instance HttpBody ReqBodyFile where
6581258-- | HTTP request body represented by a strict 'ByteString'.
6591259--
6601260-- Using of this body option does not set the @Content-Type@ header.
661−
6621261newtype ReqBodyBs = ReqBodyBs ByteString
6631262
6641263instance HttpBody ReqBodyBs where
@@ -667,264 +1266,387 @@ instance HttpBody ReqBodyBs where
6671266-- | HTTP request body represented by a lazy 'BL.ByteString'.
6681267--
6691268-- Using of this body option does not set the @Content-Type@ header.
670−
6711269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
6721270
6731271instance HttpBody ReqBodyLbs where
6741272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
6751273
676−-- | Form URL-encoded body. This can hold a collection of parameters which
677−-- are encoded similarly to query parameters at the end of query string,
678−-- with the only difference that they are stored in request body. The
679−-- similarity is reflected in API as well, as you can use the same
680−-- combinators you would use to add query parameters: @('=:')@ and
681−-- 'queryFlag'.
682−--
683−-- Here is an example of use:
684−--
685−-- > req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) mempty
686−-- > where params =
687−-- > "foo" =: "bar" <>
688−-- > queryFlag "baz"
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'.
6891279--
6901280-- This body option sets the @Content-Type@ header to
691−-- @\"application/x-www-from-urlencoded\"@ value.
692−
1281+-- @\"application/x-www-form-urlencoded\"@ value.
6931282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
6941283
6951284instance HttpBody ReqBodyUrlEnc where
6961285 getRequestBody (ReqBodyUrlEnc (FormUrlEncodedParam params)) =
6971286 (L.RequestBodyLBS . BB.toLazyByteString) (Y.renderQueryText False params)
698− getRequestContentType Proxy = pure "application/x-www-form-urlencoded"
1287+ getRequestContentType _ = pure "application/x-www-form-urlencoded"
6991288
7001289-- | An opaque monoidal value that allows to collect URL-encoded parameters
701−-- to be wrapped in 'ReqBodyUrlEnc' (documentation for this type has an
702−-- example of use).
703−
1290+-- to be wrapped in 'ReqBodyUrlEnc'.
7041291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
7051292 deriving (Semigroup, Monoid)
7061293
7071294instance QueryParam FormUrlEncodedParam where
7081295 queryParam name mvalue =
7091296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
7101298
711−-- | A type class for things that can be interpreted as HTTP
712−-- 'L.RequestBody'.
1299+-- | Use 'formToQuery'.
1300+--
1301+-- @since 3.11.0
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
7131304
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
1350+-- 'L.RequestBody'.
7141351class HttpBody body where
715−
716− {-# MINIMAL getRequestBody #-}
717−
7181352 -- | How to get actual 'L.RequestBody'.
719−
7201353 getRequestBody :: body -> L.RequestBody
7211354
722− -- | This method allows to optionally specify value of @Content-Type@
723− -- header that should be used when this body option is used. By default
724− -- this returns 'Nothing' and so @Content-Type@ is not set.
725−
726− getRequestContentType :: Proxy body -> Maybe ByteString
727− getRequestContentType Proxy = Nothing
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
7281360
7291361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
730−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
731−-- 'GET' method and other methods that should not send a body.
732−
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1363+-- with 'GET' method and other methods that should not have body.
7331364type family ProvidesBody body :: CanHaveBody where
7341365 ProvidesBody NoReqBody = 'NoBody
735− ProvidesBody body = 'CanHaveBody
736−
737−instance HttpBody body => RequestComponent (Womb "body" body) where
738− getRequestMod (Womb body) = Endo $ \x ->
739− x { L.requestBody = getRequestBody body
740− , L.requestHeaders =
741− let old = L.requestHeaders x in
742− case getRequestContentType (Proxy :: Proxy body) of
743− Nothing -> old
744− Just contentType ->
745− (Y.hContentType, contentType) : old }
1366+ ProvidesBody body = 'CanHaveBody
1367+
1368+-- | 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+ }
7461394
7471395----------------------------------------------------------------------------
748−-- Request — Optional parameters
1396+-- Request—Optional parameters
7491397
7501398-- $optional-parameters
7511399--
752−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
7531401-- headers, port number, etc. All optional parameters have the type
7541402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
7551403-- the last argument of 'req' to specify no optional parameters, or combine
756−-- 'Option's using 'mappend' (or @('<>')@) to have several of them at once.
1404+-- 'Option's using 'mappend' or @('<>')@ to have several of them at once.
7571405
758−-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
759−-- optional parameters like query parameters and headers. See sections below
760−-- to learn which 'Option' primitives are available.
1406+-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
1407+-- of optional parameters like query parameters and headers. See sections
1408+-- below to learn which 'Option' primitives are available.
1409+data Option (scheme :: Scheme)
1410+ = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
7611411
762−-- TODO We need examples here.
763−
764−data Option (scheme :: Scheme) =
765− Option (Endo (Y.QueryText, L.Request)) (Maybe (Endo L.Request))
766− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
767− -- Request to avoid appending to existing query string in request every
768− -- time new parameter is added. Additional Maybe (Endo Request) is a
769− -- finalizer that will be applied after all over options. This is for
770− -- authentication methods that sign requests based on data in Request.
1412+-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1413+-- Request to avoid appending to an existing query string in request every
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
1415+-- L.Request) is a finalizer that will be applied after all other
1416+-- transformations. This is for authentication methods that sign requests
1417+-- based on data in Request.
7711418
7721419instance Semigroup (Option scheme) where
773− Option er0 mr0 <> Option er1 mr1 = Option
774− (er0 <> er1) (mr0 <|> mr1)
1420+ Option er0 mr0 <> Option er1 mr1 =
1421+ Option
1422+ (er0 <> er1)
1423+ (mr0 <|> mr1)
7751424
7761425instance Monoid (Option scheme) where
777− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
7781427 mappend = (<>)
7791428
780−-- | A helper to create an 'Option' that modifies only collection of query
781−-- parameters. This helper is not a part of public API.
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
7821434
1435+-- | A helper to create an 'Option' that modifies only collection of query
1436+-- parameters. This helper is not a part of the public API.
7831437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
7841438withQueryParams f = Option (Endo (first f)) Nothing
7851439
7861440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
7871441-- helper is not a part of public API.
788−
7891442withRequest :: (L.Request -> L.Request) -> Option scheme
7901443withRequest f = Option (Endo (second f)) Nothing
7911444
792−-- | A helper to create an 'Option' that adds a finalizer (request
793−-- endomorphism that is run after all other modifications).
794−
795−asFinalizer :: (L.Request -> L.Request) -> Option scheme
796−asFinalizer f = Option mempty (Just (Endo f))
797−
7981445instance RequestComponent (Option scheme) where
799− getRequestMod (Option f finalizer) = Endo $ \x ->
1446+ getRequestMod (Option f _) = Endo $ \x ->
8001447 let (qparams, x') = appEndo f ([], x)
801− query = Y.renderQuery True (Y.queryTextToQuery qparams)
802− in maybe id appEndo finalizer x' { L.queryString = query }
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
8031455
8041456----------------------------------------------------------------------------
805−-- Request — Optional parameters — Query Parameters
1457+-- Request—Optional parameters—Query Parameters
8061458
8071459-- $query-parameters
8081460--
8091461-- This section describes a polymorphic interface that can be used to
810−-- construct query parameters (of type 'Option') and form URL-encoded bodies
811−-- (of type 'FormUrlEncodedParam').
1462+-- construct query parameters (of the type 'Option') and form URL-encoded
1463+-- bodies (of the type 'FormUrlEncodedParam').
8121464
8131465-- | This operator builds a query parameter that will be included in URL of
814−-- your request after question sign @?@. This is the same syntax you use
1466+-- your request after the question sign @?@. This is the same syntax you use
8151467-- with form URL encoded request bodies.
8161468--
8171469-- This operator is defined in terms of 'queryParam':
8181470--
8191471-- > name =: value = queryParam name (pure value)
820−
8211472infix 7 =:
1473+
8221474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
8231475name =: value = queryParam name (pure value)
8241476
825−-- | Construct a flag, that is, valueless query parameter. For example, in
826−-- the following URL @a@ is a flag, @b@ is a query parameter with a value:
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
1478+-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
1479+-- with a value:
8271480--
8281481-- > https://httpbin.org/foo/bar?a&b=10
8291482--
8301483-- This operator is defined in terms of 'queryParam':
8311484--
832−-- > queryFlag name = queryParam name Nothing
833−
834−queryFlag :: QueryParam param => Text -> param
1485+-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486+queryFlag :: (QueryParam param) => Text -> param
8351487queryFlag name = queryParam name (Nothing :: Maybe ())
8361488
837−-- | A type class for query-parameter-like things. The reason to have
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
8381508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
8391509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
8401510-- Having the same syntax for these cases seems natural and user-friendly.
841−
8421511class QueryParam param where
843−
8441512 -- | Create a query parameter with given name and value. If value is
8451513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
8461514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
8471515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
8481517
849− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1519+ --
1520+ -- @since 3.11.0
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
8501522
8511523instance QueryParam (Option scheme) where
8521524 queryParam name mvalue =
8531525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
8541527
8551528----------------------------------------------------------------------------
856−-- Request — Optional parameters — Headers
1529+-- Request—Optional parameters—Headers
8571530
8581531-- | Create an 'Option' that adds a header. Note that if you 'mappend' two
8591532-- headers with the same names the leftmost header will win. This means, in
8601533-- particular, that you cannot create a request with several headers of the
8611534-- same name.
862−
863−header
864− :: ByteString -- ^ Header name
865− -> ByteString -- ^ Header value
866− -> Option scheme
1535+header ::
1536+ -- | Header name
1537+ ByteString ->
1538+ -- | Header value
1539+ ByteString ->
1540+ Option scheme
8671541header name value = withRequest (attachHeader name value)
8681542
869−-- | A non-public helper that attaches a header with given name and content
870−-- to a 'L.Request'.
871−
1543+-- | Attach a header with given name and content to a 'L.Request'.
1544+--
1545+-- @since 1.1.0
8721546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
8731547attachHeader name value x =
874− x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
1548+ x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1549+
1550+-- | Same as 'header', but with redacted values on print.
1551+--
1552+-- @since 3.13.0
1553+headerRedacted :: ByteString -> ByteString -> Option scheme
1554+headerRedacted name value = withRequest $ \x ->
1555+ let y = attachHeader name value x
1556+ in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
8751557
8761558----------------------------------------------------------------------------
877−-- Request — Optional parameters — Cookies
1559+-- Request—Optional parameters—Cookies
8781560
8791561-- $cookies
8801562--
881−-- Support for cookies is quite minimalistic at the moment, its' possible to
1563+-- Support for cookies is quite minimalistic at the moment. It's possible to
8821564-- specify which cookies to send using 'cookieJar' and inspect 'L.Response'
883−-- to extract 'L.CookieJar' from it.
1565+-- to extract 'L.CookieJar' from it (see 'responseCookieJar').
8841566
8851567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
8861568-- 'L.Response' record.
887−
8881569cookieJar :: L.CookieJar -> Option scheme
8891570cookieJar jar = withRequest $ \x ->
890− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
8911572
8921573----------------------------------------------------------------------------
893−-- Request — Optional parameters — Authentication
1574+-- Request—Optional parameters—Authentication
8941575
8951576-- $authentication
8961577--
897−-- This section provides common authentication helpers in form of 'Option's.
898−-- You should always prefer the provided authentication 'Option's to manual
899−-- construction of headers because it ensures that you only use one
900−-- authentication method at a time (they overwrite each other) and provides
901−-- additional type safety that prevents leaking of credentials in cases when
902−-- authentication relies on TLS for encrypting sensitive data.
903−
904−-- | OAuth 1 authentication 'Option'.
905−--
906−-- See also: <https://en.wikipedia.org/wiki/OAuth>
907−
908−oAuth1
909− :: ByteString -- ^ Consumer token
910− -> ByteString -- ^ Consumer secret
911− -> ByteString -- ^ OAuth token
912− -> ByteString -- ^ OAuth token secret
913− -> Option scheme
914−oAuth1 ctoken csecret otoken osecret = asFinalizer
915− (OAuth1.signRequest ctoken csecret otoken osecret)
916−
917−-- | The 'Option' adds basic authentication. The 'Text' values will be UTF-8
918−-- encoded.
919−--
920−-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>
921−
922−basicAuth
923− :: ByteString -- ^ Username
924− -> ByteString -- ^ Password
925− -> Option 'Https -- ^ Auth 'Option'
926−basicAuth username password = asFinalizer
927− (L.applyBasicAuth username password)
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.
1585+
1586+-- | The 'Option' adds basic authentication.
1587+--
1588+-- 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
9281650
9291651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
9301652-- services as the equivalent of a username and password.
@@ -933,13 +1655,15 @@ basicAuth username password = asFinalizer
9331655--
9341656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
9351657--
936−-- See also: <https://en.wikipedia.org/wiki/OAuth>
937−
938−oAuth2Bearer
939− :: ByteString -- ^ Token
940− -> Option 'Https -- ^ Auth 'Option'
941−oAuth2Bearer token = asFinalizer
942− (attachHeader "Authorization" ("Bearer " <> token))
1658+-- 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))
9431667
9441668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
9451669-- to be used only by GitHub). This will be treated by whatever services
@@ -949,38 +1673,36 @@ oAuth2Bearer token = asFinalizer
9491673--
9501674-- > oAuth2Token token = header "Authorization" ("token" <> token)
9511675--
952−-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>
953−
954−oAuth2Token
955− :: ByteString -- ^ Token
956− -> Option 'Https -- ^ Auth 'Option'
957−oAuth2Token token = asFinalizer
958− (attachHeader "Authorization" ("token" <> token))
1676+-- 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))
9591685
960−-- | The 'Option' adds AWS v4 request signature.
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.
9611689--
962−-- See also: <https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html>
963−
964−awsAuth
965− :: ByteString -- ^ AWS access key
966− -> ByteString -- ^ AWS secret access key
967− -> Option 'Https -- ^ Auth 'Option'
968−awsAuth accessKey secretKey = asFinalizer
969− (AWS.signRequest accessKey secretKey)
1690+-- @since 1.1.0
1691+customAuth :: (L.Request -> IO L.Request) -> Option scheme
1692+customAuth = Option mempty . pure
9701693
9711694----------------------------------------------------------------------------
972−-- Request — Optional parameters — Other
1695+-- Request—Optional parameters—Other
9731696
9741697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
975−-- determines default port, @80@ for HTTP and @443@ for HTTPS, this 'Option'
976−-- allows to choose arbitrary port overwriting the defaults.
977−
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.
9781700port :: Int -> Option scheme
9791701port n = withRequest $ \x ->
980− x { L.port = n }
1702+ x {L.port = n}
9811703
9821704-- | This 'Option' controls whether gzipped data should be decompressed on
983−-- the fly. By default everything except for @application\/x-tar@ is
1705+-- the fly. By default everything except for @\"application\/x-tar\"@ is
9841706-- decompressed, i.e. we have:
9851707--
9861708-- > decompress (/= "application/x-tar")
@@ -988,263 +1710,342 @@ port n = withRequest $ \x ->
9881710-- You can also choose to decompress everything like this:
9891711--
9901712-- > decompress (const True)
991−
992−decompress
993− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
994− -- returns 'True' when content should be decompressed on the fly.
995− -> Option scheme
1713+decompress ::
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1715+ -- should be decompressed on the fly.
1716+ (ByteString -> Bool) ->
1717+ Option scheme
9961718decompress f = withRequest $ \x ->
997− x { L.decompress = f }
998−
999−-- | Specify number of microseconds to wait for response. Default is 30
1000−-- seconds.
1001−
1002−responseTimeout
1003− :: Int -- ^ Number of microseconds to wait
1004− -> Option scheme
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
10051728responseTimeout n = withRequest $ \x ->
1006− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1007−
1008−-- | HTTP version to send to server, default is HTTP 1.1.
1009−
1010−httpVersion
1011− :: Int -- ^ Major version number
1012− -> Int -- ^ Minor version number
1013− -> Option scheme
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
10141738httpVersion major minor = withRequest $ \x ->
1015− x { L.requestVersion = Y.HttpVersion major minor }
1016−
1017−----------------------------------------------------------------------------
1018−-- Response
1019−
1020−-- $response
1021−--
1022−-- This section is divided into three sub-sections. The first one describes
1023−-- options for response interpretation that are available to you
1024−-- out-of-the-box. The second section called “Inspecting a response” lists a
1025−-- set of functions that can be used to extract useful info from a response
1026−-- returned by 'req'. Finally the third section talks about 'HttpResponse'
1027−-- type class that allows user to add new interpretations of HTTP responses.
1739+ x {L.requestVersion = Y.HttpVersion major minor}
10281740
10291741----------------------------------------------------------------------------
10301742-- Response interpretations
10311743
1032−-- | Make a request and ignore body of response.
1033−
1034−data IgnoreResponse = IgnoreResponse (L.Response ())
1744+-- | Make a request and ignore the body of the response.
1745+newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
10351747
10361748instance HttpResponse IgnoreResponse where
10371749 type HttpResponseBody IgnoreResponse = ()
1038− toVanillaResponse (IgnoreResponse response) = response
1039− getHttpResponse request manager =
1040− IgnoreResponse <$> liftIO (L.httpNoBody request manager)
1750+ toVanillaResponse (IgnoreResponse r) = r
1751+ getHttpResponse r = return $ IgnoreResponse (void r)
10411752
10421753-- | Use this as the fourth argument of 'req' to specify that you want it to
1043−-- return the 'IgnoreResponse' interpretation.
1044−
1754+-- ignore the response body.
10451755ignoreResponse :: Proxy IgnoreResponse
10461756ignoreResponse = Proxy
10471757
1048−-- | Make a request and interpret body of response as JSON. The
1758+-- | Make a request and interpret the body of the response as JSON. The
10491759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
10501760-- monad in which you use 'req' will determine what to do in the case when
1051−-- parsing fails ('JsonHttpException' constructor will be used).
1052−--
1053−-- The @req-conduit@ package has an alternative response interpretation that
1054−-- streams and parses JSON object in constant space using @conduit@.
1055−
1761+-- parsing fails (the 'JsonHttpException' constructor will be used).
10561762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
10571764
1058−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
10591766 type HttpResponseBody (JsonResponse a) = a
1060− toVanillaResponse (JsonResponse response) = response
1061− getHttpResponse request manager = do
1062− response <- L.httpLbs request manager
1063− case A.eitherDecode (L.responseBody response) of
1767+ toVanillaResponse (JsonResponse r) = r
1768+ getHttpResponse r = do
1769+ chunks <- L.brConsume (L.responseBody r)
1770+ case A.eitherDecode (BL.fromChunks chunks) of
10641771 Left e -> throwIO (JsonHttpException e)
1065− Right x -> return $ JsonResponse response { L.responseBody = x }
1772+ Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
10661774
1067−-- | Use this as the forth argument of 'req' to specify that you want it to
1775+-- | Use this as the fourth argument of 'req' to specify that you want it to
10681776-- return the 'JsonResponse' interpretation.
1069−
1070−jsonResponse :: Proxy JsonResponse
1777+jsonResponse :: Proxy (JsonResponse a)
10711778jsonResponse = Proxy
10721779
1073−-- | Make a request and interpret body of response as a strict 'ByteString'.
1074−
1780+-- | Make a request and interpret the body of the response as a strict
1781+-- 'ByteString'.
10751782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
10761784
10771785instance HttpResponse BsResponse where
10781786 type HttpResponseBody BsResponse = ByteString
1079− toVanillaResponse (BsResponse response) = response
1080− getHttpResponse request manager =
1081− L.withResponse request manager $ \response -> do
1082− chunks <- L.brConsume (L.responseBody response)
1083− return $ BsResponse response { L.responseBody = B.concat chunks }
1084−
1085−-- | Use this as the forth argument of 'req' to specify that you want to
1086−-- interpret response body as a strict 'ByteString'.
1787+ toVanillaResponse (BsResponse r) = r
1788+ getHttpResponse r = do
1789+ chunks <- L.brConsume (L.responseBody r)
1790+ return $ BsResponse (B.concat chunks <$ r)
10871791
1792+-- | Use this as the fourth argument of 'req' to specify that you want to
1793+-- interpret the response body as a strict 'ByteString'.
10881794bsResponse :: Proxy BsResponse
10891795bsResponse = Proxy
10901796
1091−-- | Make a request and interpret body of response as a lazy
1797+-- | Make a request and interpret the body of the response as a lazy
10921798-- 'BL.ByteString'.
1093−
10941799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
10951801
10961802instance HttpResponse LbsResponse where
10971803 type HttpResponseBody LbsResponse = BL.ByteString
1098− toVanillaResponse (LbsResponse response) = response
1099− getHttpResponse request manager =
1100− LbsResponse <$> L.httpLbs request manager
1101−
1102−-- | Use this as the forth argument of 'req' to specify that you want to
1103−-- interpret response body as a lazy 'BL.ByteString'.
1804+ toVanillaResponse (LbsResponse r) = r
1805+ getHttpResponse r = do
1806+ chunks <- L.brConsume (L.responseBody r)
1807+ return $ LbsResponse (BL.fromChunks chunks <$ r)
11041808
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'.
11051811lbsResponse :: Proxy LbsResponse
11061812lbsResponse = Proxy
11071813
1108−-- | This interpretation does not result in any call at all, but you can use
1109−-- the 'responseRequest' function to extract 'L.Request' that 'req' has
1110−-- prepared. This is useful primarily for testing.
1111−--
1112−-- Note that when you use this interpretation inspecting response will
1113−-- diverge (i.e. it'll blow up with an error, don't do that).
1114−
1115−newtype ReturnRequest = ReturnRequest L.Request
1116−
1117−instance HttpResponse ReturnRequest where
1118− type HttpResponseBody ReturnRequest = ()
1119− toVanillaResponse (ReturnRequest _) = error
1120− "Network.HTTP.Req.ReturnRequest interpretation does not make requests"
1121− getHttpResponse request _ = return (ReturnRequest request)
1122−
1123−-- | Use this as the forth argument of 'req' to specify that you want it to
1124−-- just return the request it consturcted without making any requests.
1125−
1126−returnRequest :: Proxy ReturnRequest
1127−returnRequest = Proxy
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 [])
11281875
11291876----------------------------------------------------------------------------
11301877-- Inspecting a response
11311878
1132−-- | Get response body.
1133−
1134−responseBody
1135− :: HttpResponse response
1136− => response
1137− -> HttpResponseBody response
1879+-- | Get the response body.
1880+responseBody ::
1881+ (HttpResponse response) =>
1882+ response ->
1883+ HttpResponseBody response
11381884responseBody = L.responseBody . toVanillaResponse
11391885
1140−-- | Get response status code.
1141−
1142−responseStatusCode
1143− :: HttpResponse response
1144− => response
1145− -> Int
1886+-- | Get the response status code.
1887+responseStatusCode ::
1888+ (HttpResponse response) =>
1889+ response ->
1890+ Int
11461891responseStatusCode =
11471892 Y.statusCode . L.responseStatus . toVanillaResponse
11481893
1149−-- | Get response status message.
1150−
1151−responseStatusMessage
1152− :: HttpResponse response
1153− => response
1154− -> ByteString
1894+-- | Get the response status message.
1895+responseStatusMessage ::
1896+ (HttpResponse response) =>
1897+ response ->
1898+ ByteString
11551899responseStatusMessage =
11561900 Y.statusMessage . L.responseStatus . toVanillaResponse
11571901
1158−-- | Look a particular header from a response.
1159−
1160−responseHeader
1161− :: HttpResponse response
1162− => response -- ^ Response interpretation
1163− -> ByteString -- ^ Header to lookup
1164− -> Maybe ByteString -- ^ Header value if found
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
11651911responseHeader r h =
11661912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
11671913
1168−-- | Get response 'L.CookieJar'.
1169−
1170−responseCookieJar
1171− :: HttpResponse response
1172− => response
1173− -> L.CookieJar
1914+-- | Get the response 'L.CookieJar'.
1915+responseCookieJar ::
1916+ (HttpResponse response) =>
1917+ response ->
1918+ L.CookieJar
11741919responseCookieJar = L.responseCookieJar . toVanillaResponse
11751920
1176−-- | Get the original request from 'ReturnRequest' response interpretation.
1177−
1178−responseRequest :: ReturnRequest -> L.Request
1179−responseRequest (ReturnRequest request) = request
1180−
11811921----------------------------------------------------------------------------
1182−-- Response — defining your own interpretation
1922+-- Response—Defining your own interpretation
11831923
1184−-- | Here we need to provide various options how to consume responses.
1924+-- $new-response-interpretation
1925+--
1926+-- To create a new response interpretation you just need to make your data
1927+-- type an instance of the 'HttpResponse' type class.
11851928
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.
11861932class HttpResponse response where
1933+ -- | The associated type is the type of body that can be extracted from an
1934+ -- instance of 'HttpResponse'.
1935+ type HttpResponseBody response :: Type
11871936
1188− type HttpResponseBody response :: *
1189−
1937+ -- | The method describes how to get the underlying 'L.Response' record.
11901938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
11911939
1192− getHttpResponse :: L.Request -> L.Manager -> IO response
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
11931979
11941980----------------------------------------------------------------------------
11951981-- Other
11961982
11971983-- | The main class for things that are “parts” of 'L.Request' in the sense
11981984-- that if we have a 'L.Request', then we know how to apply an instance of
1199−-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is
1200−-- endomorphism of functions under composition, it's used to chain different
1201−-- request component easier using @('<>')@.
1202−
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.
12031990class RequestComponent a where
1204−
12051991 -- | Get a function that takes a 'L.Request' and changes it somehow
1206− -- returning another 'L.Request'. For example HTTP method instance of
1207− -- 'RequestComponent' just overwrites method. The function is wrapped in
1208− -- 'Endo' so it's easier to chain such “modifying applications” together
1209− -- building bigger and bigger 'RequestComponent's.
1210−
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.
12111996 getRequestMod :: a -> Endo L.Request
12121997
1213−-- | This wrapper is only used to attach a type-level tag to given type.
1998+-- | This wrapper is only used to attach a type-level tag to a given type.
12141999-- This is necessary to define instances of 'RequestComponent' for any thing
1215−-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC is not
1216−-- able to see difference between @'HttpMethod' method => 'RequestComponent'
2000+-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC can't
2001+-- see the difference between @'HttpMethod' method => 'RequestComponent'
12172002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
1218−-- which instance to use (i.e. constraints are taken into account later,
2003+-- which instance to use (i.e. the constraints are taken into account later,
12192004-- when instance is already chosen).
1220−
1221−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
12222006
12232007-- | Exceptions that this library throws.
1224−
12252008data HttpException
1226− = VanillaHttpException L.HttpException
1227− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1228− | JsonHttpException String
1229− -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
1230− deriving (Show, Typeable, Generic)
2009+ = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2010+ VanillaHttpException L.HttpException
2011+ | -- | A wrapper with Aeson-produced 'String' describing why decoding
2012+ -- failed
2013+ JsonHttpException String
2014+ deriving (Show, Generic)
12312015
12322016instance Exception HttpException
12332017
1234−-- | A simple 'Bool'-like type we only have for better error messages. We
1235−-- use it as a kind and its data constructors as type-level tags.
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
12362020--
1237−-- See also: 'HttpMethod' and 'HttpBody'.
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2026+ _
2027+ (L.StatusCodeException r _)
2028+ )
2029+ ) = Just r
2030+isStatusCodeException _ = Nothing
12382031
2032+-- | A simple type isomorphic to 'Bool' that we only have for better error
2033+-- messages. We use it as a kind and its data constructors as type-level
2034+-- tags.
2035+--
2036+-- See also: 'HttpMethod' and 'HttpBody'.
12392037data CanHaveBody
1240− = CanHaveBody -- ^ Indeed can have a body
1241− | NoBody -- ^ Should not have a body
2038+ = -- | Indeed can have a body
2039+ CanHaveBody
2040+ | -- | Should not have a body
2041+ NoBody
12422042
1243−-- | A type-level tag that specifies URL scheme used (and thus if TLS is
2043+-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
12442044-- enabled). This is used to force TLS requirement for some authentication
12452045-- 'Option's.
1246−
12472046data Scheme
1248− = Http -- ^ HTTP, no TLS
1249− | Https -- ^ HTTPS
1250− deriving (Eq, Ord, Show, Data, Typeable, Generic)
2047+ = -- | HTTP
2048+ Http
2049+ | -- | HTTPS
2050+ Https
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)