@@ -1,254 +1,282 @@
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 #-}
2-- Module : Network.HTTP.Req
12-- Module : Network.HTTP.Req
3−-- Copyright : © 2016 Mark Karpov
13+-- Copyright : © 2016–present Mark Karpov
4-- License : BSD 3 clause
14-- License : BSD 3 clause
6−-- Maintainer : Mark Karpov <markkarpov@openmailbox.org>
16+-- Maintainer : Mark Karpov <markkarpov92@gmail.com>
7-- Stability : experimental
17-- Stability : experimental
8-- Portability : portable
18-- Portability : portable
10−-- The documentation below is structured in such a way that most important
20+-- The documentation below is structured in such a way that the most
11−-- information goes first: you learn how to do HTTP requests, then how to
21+-- important information is presented first: you learn how to do HTTP
12−-- embed them in any monad you have, then it goes on giving you details
22+-- requests, how to embed them in the monad you have, and then it gives you
13−-- about less-common things you may want to know about. The documentation is
23+-- details about less-common things you may want to know about. The
14−-- written with sufficient coverage of details and examples, it's designed
24+-- documentation is written with sufficient coverage of details and
15−-- to be a complete tutorial on its own.
25+-- examples, and it's designed to be a complete tutorial on its own.
17−-- /(A modest intro goes here, click on 'req' to start making requests.)/
19-- === About the library
27-- === About the library
21−-- This is an easy-to-use, type-safe, expandable, high-level HTTP library
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
22−-- that just works without any fooling around.
30+-- and expandable.
24−-- What does the “easy-to-use” phrase mean? It means that the library is
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
25−-- designed to be beginner-friendly, so it's simple to add it to your monad
33+-- so it's simple to add to your monad stack, intuitive to work with,
26−-- stack, intuitive to work with, well-documented, and does not get in your
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
27−-- way. Doing HTTP requests is a common task and Haskell library for this
35+-- common task and a Haskell library for this should be approachable and
28−-- should be very approachable and clear to beginners, thus certain
29−-- compromises were made. For example, one cannot currently modify
36+-- clear to beginners, thus certain compromises were made. For example, one
30−-- 'L.ManagerSettings' of default manager because the library always uses
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
31−-- the same implicit global manager for simplicity and maximal connection
38+-- because the library always uses the same implicit global manager for
32−-- sharing. There is a way to use your own manager with different settings,
39+-- simplicity and maximal connection sharing. There is a way to use your own
33−-- but it requires a bit more typing.
40+-- manager with different settings, but it requires more typing.
35−-- “Type-safe” means that the library is protective and eliminates certain
42+-- “Type-safe” means that the library tries to eliminate certain classes of
36−-- class of errors. For example, we have correct-by-construction 'Url's,
43+-- errors. For example, we have correct-by-construction URLs; it is
37−-- it's guaranteed that user does not send request body when using methods
44+-- guaranteed that the user does not send the request body when using
38−-- like 'GET' or 'OPTIONS', amount of implicit assumptions is minimized by
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
39−-- making user specify his\/her intentions in explicit form (for example,
46+-- minimized by making the user specify their intentions in an explicit
40−-- it's not possible to avoid specifying body or method of a request).
47+-- form. For example, it's not possible to avoid specifying the body or the
41−-- Authentication methods that assume TLS force user to use TLS on type
48+-- method of a request. Authentication methods that assume HTTPS force the
42−-- level. The library carefully hides underlying types from lower-level
49+-- user to use HTTPS at the type level.
43−-- @http-client@ package because it's not safe enough (for example
44−-- 'L.Request' is an instance of 'Data.String.IsString' and if it's
45−-- malformed, it will blow up at run-time).
47−-- “Expandable” refers to the ability of the library to be expanded without
51+-- “Expandable” refers to the ability to create new components without
48−-- ugly hacking. For example, it's possible to define your own HTTP methods,
52+-- having to resort to hacking. For example, it's possible to define your
49−-- new ways to construct body of request, new authorization options, new
53+-- own HTTP methods, create new ways to construct the body of a request,
50−-- ways to actually perform request and how to represent\/parse response. As
54+-- create new authorization options, perform a request in a different way,
51−-- user extends the library to satisfy his\/her special needs, the new
55+-- and create your own methods to parse a response.
52−-- solutions work just like built-ins. That said, all common cases are
53−-- covered by the library out-of-the-box.
55−-- “High-level” means that there are less details to worry about. The
56−-- library is a result of my experiences as a Haskell consultant, working
57−-- for several clients who have very different projects and so the library
58−-- adapts easily to any particular style of writing Haskell applications.
59−-- For example, some people prefer throwing exceptions, while others are
60−-- concerned with purity: just define 'handleHttpException' accordingly when
61−-- making your monad instance of 'MonadHttp' and it will play seamlessly.
62−-- Finally, the library cuts boilerplate considerably and helps write
63−-- concise, easy to read and maintain code.
65-- === Using with other libraries
57-- === Using with other libraries
67−-- * You won't need low-level interface of @http-client@ most of the
59+-- * You won't need the low-level interface of @http-client@ most of the
68−-- time, but when you do, it's better import it qualified because it
60+-- time, but when you do, it's better to do a qualified import,
69−-- has naming conflicts with @req@.
61+-- because @http-client@ has naming conflicts with @req@.
70−-- * For streaming of large request bodies see companion package
62+-- * For streaming of large request bodies see the companion package
71-- @req-conduit@: <https://hackage.haskell.org/package/req-conduit>.
63-- @req-conduit@: <https://hackage.haskell.org/package/req-conduit>.
73-- === Lightweight, no risk solution
65-- === Lightweight, no risk solution
75-- The library uses the following mature packages under the hood to
67-- The library uses the following mature packages under the hood to
76−-- guarantee you best experience without bugs or other funny business:
68+-- guarantee you the best experience:
78−-- * <https://hackage.haskell.org/package/http-client> — low level HTTP
70+-- * <https://hackage.haskell.org/package/http-client>—low level HTTP
79-- client used everywhere in Haskell.
71-- client used everywhere in Haskell.
80−-- * <https://hackage.haskell.org/package/http-client-tls> — TLS (HTTPS)
72+-- * <https://hackage.haskell.org/package/http-client-tls>—TLS (HTTPS)
81-- support for @http-client@.
73-- support for @http-client@.
83-- It's important to note that since we leverage well-known libraries that
75-- It's important to note that since we leverage well-known libraries that
84−-- 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
85-- machinery for performing requests is the same as with @http-conduit@ and
77-- machinery for performing requests is the same as with @http-conduit@ and
86−-- @wreq@, it's just the API is different.
78+-- @wreq@. The only difference is the API.
89−{-# LANGUAGE DataKinds #-}
90−{-# LANGUAGE DeriveDataTypeable #-}
91−{-# LANGUAGE DeriveGeneric #-}
92−{-# LANGUAGE FlexibleInstances #-}
93−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
94−{-# LANGUAGE KindSignatures #-}
95−{-# LANGUAGE OverloadedStrings #-}
96−{-# LANGUAGE RecordWildCards #-}
97−{-# LANGUAGE ScopedTypeVariables #-}
98−{-# LANGUAGE TypeFamilies #-}
100−#if MIN_VERSION_base(4,9,0)
101−{-# LANGUAGE UndecidableInstances #-}
104−#if __GLASGOW_HASKELL__ < 710
105−{-# LANGUAGE ConstraintKinds #-}
108−#if __GLASGOW_HASKELL__ >= 800
109−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
112module Network.HTTP.Req
79module Network.HTTP.Req
113 ( -- * Making a request
80 ( -- * Making a request
114 -- $making-a-request
81 -- $making-a-request
116− , withReqManager
86+ withReqManager,
117− -- * Embedding requests into your monad
88+ -- * Embedding requests in your monad
118 -- $embedding-requests
89 -- $embedding-requests
119− , MonadHttp (..)
90+ MonadHttp (..),
120− , HttpConfig (..)
91+ HttpConfig (..),
121 -- * Request
96 -- * Request
122 -- ** Method
98 -- ** Method
123 -- $method
99 -- $method
124− , GET (..)
100+ GET (..),
125− , POST (..)
101+ POST (..),
126− , HEAD (..)
102+ HEAD (..),
127− , PUT (..)
103+ PUT (..),
128− , DELETE (..)
104+ DELETE (..),
129− , TRACE (..)
105+ TRACE (..),
130− , CONNECT (..)
106+ CONNECT (..),
131− , OPTIONS (..)
107+ OPTIONS (..),
132− , PATCH (..)
108+ PATCH (..),
133− , HttpMethod (..)
109+ HttpMethod (..),
134 -- ** URL
111 -- ** URL
141− , parseUrlHttp
118+ useHttpURI,
142− , parseUrlHttps
119+ useHttpsURI,
143 -- ** Body
124 -- ** Body
145− , NoReqBody (..)
126+ NoReqBody (..),
146− , ReqBodyJson (..)
127+ ReqBodyJson (..),
147− , ReqBodyFile (..)
128+ ReqBodyFile (..),
148− , ReqBodyBs (..)
129+ ReqBodyBs (..),
149− , ReqBodyLbs (..)
130+ ReqBodyLbs (..),
150− , ReqBodyUrlEnc (..)
131+ ReqBodyUrlEnc (..),
151− , FormUrlEncodedParam
132+ FormUrlEncodedParam,
152− , HttpBody (..)
135+ HttpBody (..),
153− , ProvidesBody
136+ ProvidesBody,
154− , HttpBodyAllowed
137+ HttpBodyAllowed,
155 -- ** Optional parameters
139 -- ** Optional parameters
156 -- $optional-parameters
140 -- $optional-parameters
157− , Option
141+ Option,
158 -- *** Query parameters
143 -- *** Query parameters
159 -- $query-parameters
144 -- $query-parameters
161− , queryFlag
146+ queryFlag,
162− , QueryParam (..)
148+ QueryParam (..),
163 -- *** Headers
150 -- *** Headers
164− , header
151+ header,
165 -- *** Cookies
155 -- *** Cookies
166 -- $cookies
156 -- $cookies
167− , cookieJar
157+ cookieJar,
168 -- *** Authentication
159 -- *** Authentication
169 -- $authentication
160 -- $authentication
170− , basicAuth
161+ basicAuth,
171− , oAuth2Bearer
165+ oAuth2Bearer,
172− , oAuth2Token
166+ oAuth2Token,
173 -- *** Other
169 -- *** Other
175− , decompress
171+ decompress,
176− , responseTimeout
172+ responseTimeout,
177− , httpVersion
173+ httpVersion,
178 -- * Response
175 -- * Response
179 -- ** Response interpretations
177 -- ** Response interpretations
180− , IgnoreResponse
178+ IgnoreResponse,
181− , ignoreResponse
179+ ignoreResponse,
182− , JsonResponse
180+ JsonResponse,
183− , jsonResponse
181+ jsonResponse,
184− , BsResponse
182+ BsResponse,
185− , bsResponse
183+ bsResponse,
186− , LbsResponse
184+ LbsResponse,
187− , lbsResponse
185+ lbsResponse,
190 -- ** Inspecting a response
187 -- ** Inspecting a response
191− , responseBody
188+ responseBody,
192− , responseStatusCode
189+ responseStatusCode,
193− , responseStatusMessage
190+ responseStatusMessage,
194− , responseHeader
191+ responseHeader,
195− , responseCookieJar
192+ responseCookieJar,
196− , responseRequest
193+
197 -- ** Defining your own interpretation
194 -- ** Defining your own interpretation
198 -- $new-response-interpretation
195 -- $new-response-interpretation
199− , HttpResponse (..)
196+ HttpResponse (..),
200 -- * Other
198 -- * Other
201− , HttpException (..)
199+ HttpException (..),
200+ isStatusCodeException,
202− , CanHaveBody (..)
201+ CanHaveBody (..),
203− , Scheme (..) )
202+ Scheme (..),
206+import Blaze.ByteString.Builder qualified as BB
206import Control.Applicative
207import Control.Applicative
207import Control.Arrow (first, second)
208import Control.Arrow (first, second)
208−import Control.Exception (Exception, try, catch, throwIO)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
209−import Control.Monad
211+import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
210import Control.Monad.IO.Class
213import Control.Monad.IO.Class
211−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
232+import Data.Aeson (FromJSON (..), ToJSON (..))
233+import Data.Aeson qualified as A
212import Data.ByteString (ByteString)
234import 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
213import Data.Data (Data)
238import Data.Data (Data)
214−import Data.Default.Class
239+import Data.Default.Class (def)
215import Data.Function (on)
240import Data.Function (on)
216import Data.IORef
241import Data.IORef
217−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
218import Data.List.NonEmpty (NonEmpty (..))
244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
246+import Data.Maybe (fromMaybe)
219import Data.Proxy
247import Data.Proxy
220−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
221−import Data.Typeable (Typeable)
249+import Data.Set qualified as S
250+import Data.Text (Text)
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
253+import Data.Typeable (Typeable, cast)
222import GHC.Generics
254import GHC.Generics
223import GHC.TypeLits
255import 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
224import System.IO.Unsafe (unsafePerformIO)
265import 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
225import Web.HttpApiData (ToHttpApiData (..))
272import Web.HttpApiData (ToHttpApiData (..))
226−import qualified Blaze.ByteString.Builder as BB
227−import qualified Data.Aeson as A
228−import qualified Data.ByteString as B
229−import qualified Data.ByteString.Lazy as BL
230−import qualified Data.CaseInsensitive as CI
231−import qualified Data.List.NonEmpty as NE
232−import qualified Data.Text as T
233−import qualified Data.Text.Encoding as T
234−import qualified Network.Connection as NC
235−import qualified Network.HTTP.Client as L
236−import qualified Network.HTTP.Client.Internal as LI
237−import qualified Network.HTTP.Client.TLS as L
238−import qualified Network.HTTP.Types as Y
240−#if MIN_VERSION_base(4,9,0)
241−import Data.Kind (Constraint)
243−import GHC.Exts (Constraint)
246----------------------------------------------------------------------------
274----------------------------------------------------------------------------
247-- Making a request
275-- Making a request
249-- $making-a-request
277-- $making-a-request
251−-- To make an HTTP request you need only one function: 'req'.
279+-- To make an HTTP request you normally need only one function: 'req'.
253-- | Make an HTTP request. The function takes 5 arguments, 4 of which
281-- | Make an HTTP request. The function takes 5 arguments, 4 of which
254-- specify required parameters and the final 'Option' argument is a
282-- specify required parameters and the final 'Option' argument is a
@@ -260,42 +288,44 @@ import GHC.Exts (Constraint)
260-- @method@ is an HTTP method such as 'GET' or 'POST'. The documentation has
288-- @method@ is an HTTP method such as 'GET' or 'POST'. The documentation has
261-- a dedicated section about HTTP methods below.
289-- a dedicated section about HTTP methods below.
263−-- @url@ is a URL that describes location of resource you want to interact
291+-- @url@ is a 'Url' that describes location of resource you want to interact
264−-- with. It's of type 'Url' (if you click the link it will tell everything
292+-- with.
265−-- about construction of 'Url' things).
267-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
268−-- tutorial has a section about HTTP bodies, but usage in very
295+-- tutorial has a section about HTTP bodies, but usage is very
269−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
271−-- @response@ is a type hint how to make and interpret response of HTTP
298+-- @response@ is a type hint how to make and interpret response of an HTTP
272−-- request, out-of-the-box it can be the following: 'ignoreResponse',
299+-- request. Out-of-the-box it can be the following:
301+-- * 'ignoreResponse'
273−-- 'jsonResponse', 'bsResponse' (to get strict 'ByteString'), 'lbsResponse'
303+-- * 'bsResponse' (to get a strict 'ByteString')
274−-- (to get lazy 'BL.ByteString'), and 'returnRequest' (makes no request,
304+-- * 'lbsResponse' (to get a lazy 'BL.ByteString')
275−-- just returns response, used for testing).
277−-- Finally @options@ is a 'Monoid' that holds a composite 'Option' for all
306+-- Finally, @options@ is a 'Monoid' that holds a composite 'Option' for all
278−-- other optional things like query parameters, headers, non-standard port
307+-- other optional settings like query parameters, headers, non-standard port
279−-- number, etc. There are quite a few things you can put there, see
308+-- number, etc. There are quite a few things you can put there, see the
280-- corresponding section in the documentation. If you don't need anything at
309-- corresponding section in the documentation. If you don't need anything at
281-- all, pass 'mempty'.
310-- all, pass 'mempty'.
283-- __Note__ that if you use 'req' to do all your requests, connection
312-- __Note__ that if you use 'req' to do all your requests, connection
284-- sharing and reuse is done for you automatically.
313-- sharing and reuse is done for you automatically.
286−-- See the examples below to get on the speed very quickly.
315+-- See the examples below to get on the speed quickly.
288-- ==== __Examples__
317-- ==== __Examples__
290-- First, this is a piece of boilerplate that should be in place before you
319-- First, this is a piece of boilerplate that should be in place before you
291-- try the examples:
320-- try the examples:
322+-- > {-# LANGUAGE DeriveGeneric #-}
293-- > {-# LANGUAGE OverloadedStrings #-}
323-- > {-# LANGUAGE OverloadedStrings #-}
295-- > module Main (main) where
325-- > module Main (main) where
297−-- > import Control.Exception (throwIO)
298-- > import Control.Monad
327-- > import Control.Monad
328+-- > import Control.Monad.IO.Class
299-- > import Data.Aeson
329-- > import Data.Aeson
300-- > import Data.Maybe (fromJust)
330-- > import Data.Maybe (fromJust)
301-- > import Data.Monoid ((<>))
331-- > import Data.Monoid ((<>))
@@ -303,32 +333,30 @@ import GHC.Exts (Constraint)
303-- > import GHC.Generics
333-- > import GHC.Generics
304-- > import Network.HTTP.Req
334-- > import Network.HTTP.Req
305-- > import qualified Data.ByteString.Char8 as B
335-- > import qualified Data.ByteString.Char8 as B
306−-- >
336+-- > import qualified Text.URI as URI
307−-- > instance MonadHttp IO where
308−-- > handleHttpException = throwIO
310-- We will be making requests against the <https://httpbin.org> service.
338-- We will be making requests against the <https://httpbin.org> service.
312-- Make a GET request, grab 5 random bytes:
340-- Make a GET request, grab 5 random bytes:
314-- > main :: IO ()
342-- > main :: IO ()
315−-- > main = do
343+-- > main = runReq defaultHttpConfig $ do
316-- > let n :: Int
344-- > let n :: Int
317-- > n = 5
345-- > n = 5
318-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
319−-- > B.putStrLn (responseBody bs)
347+-- > liftIO $ B.putStrLn (responseBody bs)
321-- The same, but now we use a query parameter named @\"seed\"@ to control
349-- The same, but now we use a query parameter named @\"seed\"@ to control
322-- seed of the generator:
350-- seed of the generator:
324-- > main :: IO ()
352-- > main :: IO ()
325−-- > main = do
353+-- > main = runReq defaultHttpConfig $ do
326-- > let n, seed :: Int
354-- > let n, seed :: Int
327-- > n = 5
355-- > n = 5
328-- > seed = 100
356-- > seed = 100
329-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
357-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
330-- > "seed" =: seed
358-- > "seed" =: seed
331−-- > B.putStrLn (responseBody bs)
359+-- > liftIO $ B.putStrLn (responseBody bs)
333-- POST JSON data and get some info about the POST request:
361-- POST JSON data and get some info about the POST request:
@@ -341,103 +369,252 @@ import GHC.Exts (Constraint)
341-- > instance FromJSON MyData
369-- > instance FromJSON MyData
343-- > main :: IO ()
371-- > main :: IO ()
344−-- > main = do
372+-- > main = runReq defaultHttpConfig $ do
345-- > let myData = MyData
373-- > let myData = MyData
346-- > { size = 6
374-- > { size = 6
347-- > , color = "Green" }
375-- > , color = "Green" }
348-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
376-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
349−-- > print (responseBody v :: Value)
377+-- > liftIO $ print (responseBody v :: Value)
351-- Sending URL-encoded body:
379-- Sending URL-encoded body:
353-- > main :: IO ()
381-- > main :: IO ()
354−-- > main = do
382+-- > main = runReq defaultHttpConfig $ do
355-- > let params =
383-- > let params =
356-- > "foo" =: ("bar" :: Text) <>
384-- > "foo" =: ("bar" :: Text) <>
357-- > queryFlag "baz"
385-- > queryFlag "baz"
358-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
386-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
359−-- > print (responseBody response :: Value)
387+-- > liftIO $ print (responseBody response :: Value)
361-- Using various optional parameters and URL that is not known in advance:
389-- Using various optional parameters and URL that is not known in advance:
363-- > main :: IO ()
391-- > main :: IO ()
364−-- > main = do
392+-- > main = runReq defaultHttpConfig $ do
365-- > -- This is an example of what to do when URL is given dynamically. Of
393-- > -- This is an example of what to do when URL is given dynamically. Of
366-- > -- course in a real application you may not want to use 'fromJust'.
394-- > -- course in a real application you may not want to use 'fromJust'.
367−-- > let (url, options) = fromJust (parseUrlHttps "https://httpbin.org/get?foo=bar")
395+-- > uri <- URI.mkURI "https://httpbin.org/get?foo=bar"
396+-- > let (url, options) = fromJust (useHttpsURI uri)
368-- > response <- req GET url NoReqBody jsonResponse $
397-- > response <- req GET url NoReqBody jsonResponse $
369-- > "from" =: (15 :: Int) <>
398-- > "from" =: (15 :: Int) <>
370-- > "to" =: (67 :: Int) <>
399-- > "to" =: (67 :: Int) <>
371-- > basicAuth "username" "password" <>
400-- > basicAuth "username" "password" <>
372-- > options <> -- contains the ?foo=bar part
401-- > options <> -- contains the ?foo=bar part
373-- > port 443 -- here you can put any port of course
402-- > port 443 -- here you can put any port of course
374−-- > print (responseBody response :: Value)
403+-- > liftIO $ print (responseBody response :: Value)
376−req
405+ ( MonadHttp m,
408+ HttpResponse response,
409+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
413+ -- | 'Url'—location of resource
415+ -- | Body of the request
417+ -- | A hint how to interpret response
419+ -- | Collection of optional parameters
423+req method url body responseProxy options =
424+ reqCb method url body responseProxy options pure
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.
435+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
439+ -- | 'Url'—location of resource
441+ -- | Body of the request
443+ -- | Collection of optional parameters
445+ -- | How to consume response
446+ (L.Response L.BodyReader -> IO a) ->
449+reqBr method url body options consume =
450+ req' method url body options (reqHandler consume)
452+-- | A version of 'req' that takes a callback to modify the 'L.Request', but
453+-- otherwise performs the request identically.
460+ HttpResponse response,
461+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
465+ -- | 'Url'—location of resource
467+ -- | Body of the request
469+ -- | A hint how to interpret response
471+ -- | Collection of optional parameters
473+ -- | Callback to modify the request
474+ (L.Request -> m L.Request) ->
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
483+ case acceptHeader responseProxy of
485+ Just accept -> header "Accept" accept
487+-- | The default handler function that the higher-level request functions
488+-- pass to 'req''. Internal function.
493+ -- | How to get final result from a 'L.Response'
494+ (L.Response L.BodyReader -> IO b) ->
495+ -- | 'L.Request' to perform
497+ -- | 'L.Manager' to use
500+reqHandler consume request manager = do
501+ HttpConfig {..} <- getHttpConfig
502+ let wrapVanilla = handle (throwIO . VanillaHttpException)
503+ wrapExc = handle (throwIO . LI.toHttpException request)
507+ (readIORef >=> mapM_ L.responseClose)
508+ (liftIO . try . wrapVanilla . wrapExc)
509+ ( withRRef $ \rref -> do
510+ let openResponse = mask_ $ do
512+ mapM_ L.responseClose r
513+ r' <- L.responseOpen request manager
514+ writeIORef rref (Just r')
516+ exceptionRetryPolicies =
518+ ++ [ \retryStatus -> Handler $ \e ->
519+ return $ httpConfigRetryJudgeException retryStatus e
523+ httpConfigRetryPolicy
524+ (\retryStatus r -> return $ httpConfigRetryJudge retryStatus r)
527+ httpConfigRetryPolicy
528+ exceptionRetryPolicies
529+ (const openResponse)
532+ (preview, r') <- grabPreview httpConfigBodyPreviewLength r
533+ mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
536+ >>= either handleHttpException return
538+-- | Mostly like 'req' with respect to its arguments, but accepts a callback
539+-- that allows to perform a request in arbitrary fashion.
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.
377− :: forall m method body response scheme.
547+ forall m method body scheme a.
378− ( MonadHttp m
548+ ( MonadHttp m,
379− , HttpMethod method
549+ HttpMethod method,
380− , HttpBody body
550+ HttpBody body,
381− , HttpResponse response
382− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
551+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
383− => method -- ^ HTTP method
553+ -- | HTTP method
384− -> Url scheme -- ^ 'Url' — location of resource
555+ -- | 'Url'—location of resource
385− -> body -- ^ Body of the request
557+ -- | Body of the request
386− -> Proxy response -- ^ A hint how to interpret response
558+ body ->
559+ -- | Collection of optional parameters
387− -> Option scheme -- ^ Collection of optional parameters
560+ Option scheme ->
388− -> m response -- ^ Response
561+ -- | How to perform request
562+ (L.Request -> L.Manager -> m a) ->
389−req method url body Proxy options = do
565+req' method url body options m = do
390− config <- getHttpConfig
566+ config <- getHttpConfig
391− manager <- liftIO (readIORef globalManager)
392 let -- NOTE First appearance of any given header wins. This allows to
567 let -- NOTE First appearance of any given header wins. This allows to
393 -- “overwrite” headers when we construct a request by cons-ing.
568 -- “overwrite” headers when we construct a request by cons-ing.
394 nubHeaders = Endo $ \x ->
569 nubHeaders = Endo $ \x ->
395− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
570+ x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
396− request = flip appEndo L.defaultRequest $
572+ flip appEndo L.defaultRequest $
397− -- NOTE Order of 'mappend's matters, here method is overwritten first
573+ -- NOTE The order of 'mappend's matters, here method is overwritten
398− -- and 'options' take effect last. In particular, this means that
574+ -- first and 'options' take effect last. In particular, this means
399− -- 'options' can overwrite things set by other request components,
575+ -- that 'options' can overwrite things set by other request
400− -- which is useful for setting port number, "Content-Type" header,
576+ -- components, which is useful for setting port number,
401− -- etc.
577+ -- "Content-Type" header, etc.
402− nubHeaders <>
578+ nubHeaders
403− getRequestMod options <>
579+ <> getRequestMod options
404− getRequestMod config <>
580+ <> getRequestMod config
405− getRequestMod (Womb body :: Womb "body" body) <>
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
406− getRequestMod url <>
582+ <> getRequestMod url
407− getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
408− wrappingVanilla m = catch m (throwIO . VanillaHttpException)
584+ request <- finalizeRequest options request'
409− (liftIO . try . wrappingVanilla) (getHttpResponse request manager)
585+ withReqManager (m request)
410− >>= either handleHttpException return
586+
411−
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
412−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
593+-- | The global 'L.Manager' that 'req' uses. Here we just go with the
413−-- settings, so users don't need to deal with this manager stuff at all, but
594+-- default settings, so users don't need to deal with this manager stuff at
414−-- when we create a request, instance 'HttpConfig' can affect the default
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
415−-- settings via 'getHttpConfig'.
596+-- default settings via 'getHttpConfig'.
417-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
418-- The value of 'globalManager' is named and lives on top level. This means
599-- The value of 'globalManager' is named and lives on top level. This means
419−-- it will be shared, i.e. computed only once on first use of manager. From
600+-- it will be shared, i.e. computed only once on the first use of the
420−-- that moment on the 'IORef' will be just reused — exactly the behaviour we
601+-- manager. From that moment on the 'IORef' will be just reused—exactly the
421−-- want here in order to maximize connection sharing. GHC could spoil the
602+-- behavior we want here in order to maximize connection sharing. GHC could
422−-- plan by inlining the definition, hence the @NOINLINE@ pragma.
603+-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
424−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
425globalManager = unsafePerformIO $ do
605globalManager = unsafePerformIO $ do
426 context <- NC.initConnectionContext
606 context <- NC.initConnectionContext
427− let settings = L.mkManagerSettingsContext (Just context) def Nothing
608+ L.mkManagerSettingsContext
428 manager <- L.newManager settings
612 manager <- L.newManager settings
429− newIORef manager
613+ return manager
430{-# NOINLINE globalManager #-}
614{-# NOINLINE globalManager #-}
432−-- | Perform an action using global implicit 'L.Manager' that the rest of
433−-- the library uses. This allows to reuse connections that the 'L.Manager'
436−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
437−withReqManager m = liftIO (readIORef globalManager) >>= m
439----------------------------------------------------------------------------
616----------------------------------------------------------------------------
440−-- Embedding requests into your monad
617+-- Embedding requests in your monad
442-- $embedding-requests
619-- $embedding-requests
@@ -446,91 +623,281 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
447-- When writing a library, keep your API polymorphic in terms of
624-- When writing a library, keep your API polymorphic in terms of
448-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
625-- '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).
450-- | A type class for monads that support performing HTTP requests.
630-- | A type class for monads that support performing HTTP requests.
451-- Typically, you only need to define the 'handleHttpException' method
631-- Typically, you only need to define the 'handleHttpException' method
452-- unless you want to tweak 'HttpConfig'.
632-- unless you want to tweak 'HttpConfig'.
454−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
456− {-# MINIMAL handleHttpException #-}
458 -- | This method describes how to deal with 'HttpException' that was
634 -- | This method describes how to deal with 'HttpException' that was
459 -- caught by the library. One option is to re-throw it if you are OK with
635 -- caught by the library. One option is to re-throw it if you are OK with
460 -- exceptions, but if you prefer working with something like
636 -- exceptions, but if you prefer working with something like
461− -- 'Control.Monad.Error.MonadError', this is the right place to pass it to
637+ -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
462− -- 'Control.Monad.Error.throwError'.
638+ -- 'Control.Monad.Except.throwError'.
464 handleHttpException :: HttpException -> m a
639 handleHttpException :: HttpException -> m a
466− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
467− -- implementation returns its 'def' value, which is described in the
642+ -- Default implementation returns its 'def' value, which is described in
468− -- documentation for the type. Common usage pattern with manually defined
643+ -- the documentation for the type. Common usage pattern with manually
469− -- 'getHttpConfig' is to return some hard-coded value, or value extracted
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
470− -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
645+ -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
471− -- configuration is desirable.
646+ -- approach to configuration is desirable.
473 getHttpConfig :: m HttpConfig
647 getHttpConfig :: m HttpConfig
474− getHttpConfig = return def
648+ getHttpConfig = return defaultHttpConfig
476−-- | 'HttpConfig' contains general and default settings to be used when
477−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
479data HttpConfig = HttpConfig
651data HttpConfig = HttpConfig
480− { httpConfigProxy :: Maybe L.Proxy
481− -- ^ 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@
482 -- environment variables are respected, this setting overwrites them.
653 -- environment variables are respected, this setting overwrites them.
483 -- Default value: 'Nothing'.
654 -- Default value: 'Nothing'.
484− , httpConfigRedirectCount :: Int
655+ httpConfigProxy :: Maybe L.Proxy,
485− -- ^ How many redirects to follow when getting a resource. Default
656+ -- | How many redirects to follow when getting a resource. Default
486 -- value: 10.
657 -- value: 10.
487− , httpConfigAltManager :: Maybe L.Manager
658+ httpConfigRedirectCount :: Int,
488− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
489− -- that default implicit manager will be used (that's what you want in
660+ -- that the default implicit manager will be used (that's what you want
490− -- 99% of cases).
661+ -- in 99% of cases).
491− , httpConfigCheckResponse :: L.Request -> L.Response L.BodyReader -> IO ()
662+ httpConfigAltManager :: Maybe L.Manager,
492− -- ^ Function to check the response immediately after receiving the
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
493− -- status and headers. This is used for throwing exceptions on
666+ -- bytes). This is used for throwing exceptions on non-success status
494− -- non-success status codes by default (set to @\\_ _ -> return ()@ if
667+ -- codes by default (set to @\\_ _ _ -> Nothing@ if this behavior is not
495− -- this behavior is not desirable). Throwing is better then just
668+ -- desirable).
670+ -- When the value this function returns is 'Nothing', nothing will
671+ -- happen. When it there is 'L.HttpExceptionContent' inside 'Just', it
496− -- returning a request with non-2xx status code because in that case
674+ -- Throwing is better then just returning a request with non-2xx status
497− -- something is wrong and we need a way to short-cut execution. The
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
498− -- thrown exception is caught by the library though and is available in
678+ -- something exceptional). The thrown exception is caught by the library
499− -- 'handleHttpException'.
679+ -- though and is available in 'handleHttpException'.
500− } deriving Typeable
680+ --
501−
681+ -- __Note__: signature of this function was changed in the version
502−instance Default HttpConfig where
682+ -- /1.0.0/.
685+ httpConfigCheckResponse ::
690+ Maybe L.HttpExceptionContent,
691+ -- | The retry policy to use for request retrying. By default 'def' is
692+ -- used (see 'RetryPolicyM').
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/.
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.
702+ -- __Note__: signature of this function was changed in the version
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
713+ httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714+ -- | Max length of preview fragment of response body.
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
720+-- | The default value of 'HttpConfig'.
723+defaultHttpConfig :: HttpConfig
503− def = HttpConfig
725+ HttpConfig
504− { httpConfigProxy = Nothing
726+ { httpConfigProxy = Nothing,
505− , httpConfigRedirectCount = 10
727+ httpConfigRedirectCount = 10,
506− , httpConfigAltManager = Nothing
728+ httpConfigAltManager = Nothing,
507− , httpConfigCheckResponse = \_ response ->
729+ httpConfigCheckResponse = \_ response preview ->
508− let Y.Status statusCode _ = L.responseStatus response in
730+ let scode = statusCode response
509− unless (200 <= statusCode && statusCode < 300) $ do
731+ in if 200 <= scode && scode < 300
510− chunk <- BL.toStrict <$> L.brReadSome (L.responseBody response) 1024
732+ then Nothing
511− LI.throwHttp (L.StatusCodeException (void response) chunk) }
733+ else Just (L.StatusCodeException (void response) preview),
734+ httpConfigRetryPolicy = retryPolicyDefault,
735+ httpConfigRetryJudge = \_ 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
743+ httpConfigRetryJudgeException = \_ e ->
744+ case fromException e of
745+ Just (L.HttpExceptionRequest _ c) ->
747+ L.ResponseTimeout -> True
748+ L.ConnectionTimeout -> True
751+ httpConfigBodyPreviewLength = 1024
754+ statusCode = Y.statusCode . L.responseStatus
513instance RequestComponent HttpConfig where
756instance RequestComponent HttpConfig where
514 getRequestMod HttpConfig {..} = Endo $ \x ->
757 getRequestMod HttpConfig {..} = Endo $ \x ->
515− x { L.proxy = httpConfigProxy
759+ { L.proxy = httpConfigProxy,
516− , L.redirectCount = httpConfigRedirectCount
760+ L.redirectCount = httpConfigRedirectCount,
517− , LI.requestManagerOverride = httpConfigAltManager
761+ LI.requestManagerOverride = httpConfigAltManager
518− , LI.checkResponse = httpConfigCheckResponse }
762+ }
764+-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
765+-- having to define new instances.
768+newtype Req a = Req (ReaderT HttpConfig IO a)
778+deriving instance MonadThrow Req
781+deriving instance MonadCatch Req
784+deriving instance MonadMask Req
786+instance MonadBase IO Req where
789+instance MonadBaseControl IO Req where
791+ liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
792+ {-# INLINEABLE liftBaseWith #-}
793+ restoreM = Req . ReaderT . const . return
794+ {-# INLINEABLE restoreM #-}
796+instance MonadHttp Req where
797+ handleHttpException = Req . lift . throwIO
798+ getHttpConfig = Req ask
801+instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802+ handleHttpException = lift . handleHttpException
803+ getHttpConfig = lift getHttpConfig
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
807+ handleHttpException = lift . handleHttpException
808+ getHttpConfig = lift getHttpConfig
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812+ handleHttpException = lift . handleHttpException
813+ getHttpConfig = lift getHttpConfig
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
817+ handleHttpException = lift . handleHttpException
818+ getHttpConfig = lift getHttpConfig
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
822+ handleHttpException = lift . handleHttpException
823+ getHttpConfig = lift getHttpConfig
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827+ handleHttpException = lift . handleHttpException
828+ getHttpConfig = lift getHttpConfig
831+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832+ handleHttpException = lift . handleHttpException
833+ getHttpConfig = lift getHttpConfig
836+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837+ handleHttpException = lift . handleHttpException
838+ getHttpConfig = lift getHttpConfig
841+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842+ handleHttpException = lift . handleHttpException
843+ getHttpConfig = lift getHttpConfig
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
847+ handleHttpException = lift . handleHttpException
848+ getHttpConfig = lift getHttpConfig
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852+ handleHttpException = lift . handleHttpException
853+ getHttpConfig = lift getHttpConfig
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857+ handleHttpException = lift . handleHttpException
858+ getHttpConfig = lift getHttpConfig
861+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862+ handleHttpException = lift . handleHttpException
863+ getHttpConfig = lift getHttpConfig
866+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867+ handleHttpException = lift . handleHttpException
868+ getHttpConfig = lift getHttpConfig
871+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872+ handleHttpException = lift . handleHttpException
873+ getHttpConfig = lift getHttpConfig
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.
881+ -- | 'HttpConfig' to use
883+ -- | Computation to run
886+runReq config (Req m) = liftIO (runReaderT m config)
520----------------------------------------------------------------------------
888----------------------------------------------------------------------------
521−-- Request — Method
889+-- Request—Method
523-- $method
891-- $method
525-- The package supports all methods as defined by RFC 2616, and 'PATCH'
893-- The package supports all methods as defined by RFC 2616, and 'PATCH'
526−-- 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
527-- APIs. In some cases, however, you may want to add more methods (e.g. you
895-- APIs. In some cases, however, you may want to add more methods (e.g. you
528-- work with WebDAV <https://en.wikipedia.org/wiki/WebDAV>); no need to
896-- work with WebDAV <https://en.wikipedia.org/wiki/WebDAV>); no need to
529-- compromise on type safety and hack, it only takes a couple of seconds to
897-- compromise on type safety and hack, it only takes a couple of seconds to
530-- define a new method that will works seamlessly, see 'HttpMethod'.
898-- define a new method that will works seamlessly, see 'HttpMethod'.
532-- | 'GET' method.
900-- | 'GET' method.
534data GET = GET
901data GET = GET
536instance HttpMethod GET where
903instance HttpMethod GET where
@@ -538,7 +905,6 @@ instance HttpMethod GET where
538 httpMethodName Proxy = Y.methodGet
905 httpMethodName Proxy = Y.methodGet
540-- | 'POST' method.
907-- | 'POST' method.
542data POST = POST
908data POST = POST
544instance HttpMethod POST where
910instance HttpMethod POST where
@@ -546,7 +912,6 @@ instance HttpMethod POST where
546 httpMethodName Proxy = Y.methodPost
912 httpMethodName Proxy = Y.methodPost
548-- | 'HEAD' method.
914-- | 'HEAD' method.
550data HEAD = HEAD
915data HEAD = HEAD
552instance HttpMethod HEAD where
917instance HttpMethod HEAD where
@@ -554,26 +919,24 @@ instance HttpMethod HEAD where
554 httpMethodName Proxy = Y.methodHead
919 httpMethodName Proxy = Y.methodHead
556-- | 'PUT' method.
921-- | 'PUT' method.
558data PUT = PUT
922data PUT = PUT
560instance HttpMethod PUT where
924instance HttpMethod PUT where
561 type AllowsBody PUT = 'CanHaveBody
925 type AllowsBody PUT = 'CanHaveBody
562 httpMethodName Proxy = Y.methodPut
926 httpMethodName Proxy = Y.methodPut
564−-- | 'DELETE' method. This data type does not allow having request body with
928+-- | 'DELETE' method. RFC 7231 allows a payload in DELETE but without
565−-- 'DELETE' requests, as it should be, however some APIs may expect 'DELETE'
929+-- semantics.
566−-- requests to have bodies, in that case define your own variation of
930+--
567−-- 'DELETE' method and allow it to have a body.
931+-- __Note__: before version /3.4.0/ this method did not allow request
569data DELETE = DELETE
933data DELETE = DELETE
571instance HttpMethod DELETE where
935instance HttpMethod DELETE where
572− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
573 httpMethodName Proxy = Y.methodDelete
937 httpMethodName Proxy = Y.methodDelete
575-- | 'TRACE' method.
939-- | 'TRACE' method.
577data TRACE = TRACE
940data TRACE = TRACE
579instance HttpMethod TRACE where
942instance HttpMethod TRACE where
@@ -581,7 +944,6 @@ instance HttpMethod TRACE where
581 httpMethodName Proxy = Y.methodTrace
944 httpMethodName Proxy = Y.methodTrace
583-- | 'CONNECT' method.
946-- | 'CONNECT' method.
585data CONNECT = CONNECT
947data CONNECT = CONNECT
587instance HttpMethod CONNECT where
949instance HttpMethod CONNECT where
@@ -589,7 +951,6 @@ instance HttpMethod CONNECT where
589 httpMethodName Proxy = Y.methodConnect
951 httpMethodName Proxy = Y.methodConnect
591-- | 'OPTIONS' method.
953-- | 'OPTIONS' method.
593data OPTIONS = OPTIONS
954data OPTIONS = OPTIONS
595instance HttpMethod OPTIONS where
956instance HttpMethod OPTIONS where
@@ -597,7 +958,6 @@ instance HttpMethod OPTIONS where
597 httpMethodName Proxy = Y.methodOptions
958 httpMethodName Proxy = Y.methodOptions
599-- | 'PATCH' method.
960-- | 'PATCH' method.
601data PATCH = PATCH
961data PATCH = PATCH
603instance HttpMethod PATCH where
963instance HttpMethod PATCH where
@@ -605,42 +965,38 @@ instance HttpMethod PATCH where
605 httpMethodName Proxy = Y.methodPatch
965 httpMethodName Proxy = Y.methodPatch
607-- | A type class for types that can be used as an HTTP method. To define a
967-- | A type class for types that can be used as an HTTP method. To define a
608−-- non-standard method, follow this example that defines COPY:
968+-- non-standard method, follow this example that defines @COPY@:
610-- > data COPY = COPY
970-- > data COPY = COPY
612-- > instance HttpMethod COPY where
972-- > instance HttpMethod COPY where
613-- > type AllowsBody COPY = 'CanHaveBody
973-- > type AllowsBody COPY = 'CanHaveBody
614-- > httpMethodName Proxy = "COPY"
974-- > httpMethodName Proxy = "COPY"
616class HttpMethod a where
975class HttpMethod a where
618− -- | Type function 'AllowsBody' returns type of kind 'CanHaveBody' which
976+ -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
619− -- tells the rest of the library whether the method can have a body or
977+ -- tells the rest of the library whether the method can have body or not.
620− -- not. We use the special type 'CanHaveBody' “lifted” into kind instead
978+ -- We use the special type 'CanHaveBody' lifted to the kind level instead
621 -- of 'Bool' to get more user-friendly compiler messages.
979 -- of 'Bool' to get more user-friendly compiler messages.
623 type AllowsBody a :: CanHaveBody
980 type AllowsBody a :: CanHaveBody
625 -- | Return name of the method as a 'ByteString'.
982 -- | Return name of the method as a 'ByteString'.
627 httpMethodName :: Proxy a -> ByteString
983 httpMethodName :: Proxy a -> ByteString
629−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
630 getRequestMod _ = Endo $ \x ->
986 getRequestMod _ = Endo $ \x ->
631− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
633----------------------------------------------------------------------------
989----------------------------------------------------------------------------
634−-- Request — URL
990+-- Request—URL
638-- We use 'Url's which are correct by construction, see 'Url'. To build a
994-- We use 'Url's which are correct by construction, see 'Url'. To build a
639−-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
641-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
642-- specifying the scheme and host at the same time. Then use the @('/~')@
998-- specifying the scheme and host at the same time. Then use the @('/~')@
643−-- and @('/:')@ operators to grow path one piece at a time. Every single
999+-- and @('/:')@ operators to grow the path one piece at a time. Every single
644-- piece of path will be url(percent)-encoded, so using @('/~')@ and
1000-- piece of path will be url(percent)-encoded, so using @('/~')@ and
645-- @('/:')@ is the only way to have forward slashes between path segments.
1001-- @('/:')@ is the only way to have forward slashes between path segments.
646-- This approach makes working with dynamic path segments easy and safe. See
1002-- This approach makes working with dynamic path segments easy and safe. See
@@ -666,125 +1022,233 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
667-- > https "юникод.рф"
1023-- > https "юникод.рф"
668-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
670−data Url (scheme :: Scheme) = Url Scheme (NonEmpty T.Text)
1025+data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
671− -- NOTE The second value is path segments in reversed order.
1026+ -- NOTE The second value is the path segments in reversed order.
672− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1029+type role Url nominal
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
1035+ TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036+ Url Http _ -> [t|Url 'Http|]
1037+ Url Https _ -> [t|Url 'Https|]
1039+ liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
674−-- | Given host name, produce a 'Url' which have “http” as its scheme and
1042+-- | Given host name, produce a 'Url' which has “http” as its scheme and
675-- empty path. This also sets port to @80@.
1043-- empty path. This also sets port to @80@.
677−http :: T.Text -> Url 'Http
1044+http :: Text -> Url 'Http
678http = Url Http . pure
1045http = Url Http . pure
680−-- | 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
681-- empty path. This also sets port to @443@.
1048-- empty path. This also sets port to @443@.
683−https :: T.Text -> Url 'Https
1049+https :: Text -> Url 'Https
684https = Url Https . pure
1050https = Url Https . pure
686−-- | 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
687-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
689infixl 5 /~
1054infixl 5 /~
690−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
691−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
693−-- | Type-constrained version of @('/~')@ to remove ambiguity in cases when
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
694−-- next URL piece is a 'Text' literal.
1057+Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1060+-- when next URL piece is a 'Data.Text.Text' literal.
696infixl 5 /:
1061infixl 5 /:
697−(/:) :: Url scheme -> T.Text -> Url scheme
1063+(/:) :: Url scheme -> Text -> Url scheme
698(/:) = (/~)
1064(/:) = (/~)
1066+-- | Render a 'Url' as 'Text'.
1069+renderUrl :: Url scheme -> Text
1072+ "https://" <> renderParts parts
1074+ "http://" <> renderParts parts
1076+ renderParts parts =
1077+ T.intercalate "/" (reverse $ NE.toList parts)
700−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
1079+-- | The 'useHttpURI' function provides an alternative method to get 'Url'
701−-- (possibly with some 'Option's) from a 'ByteString'. This is useful when
1080+-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
702−-- you are given a URL to query dynamically and don't know it beforehand.
1081+-- given a URL to query dynamically and don't know it beforehand.
703−-- The function parses 'ByteString' because it's the correct type to
1082+--
704−-- represent a URL, as 'Url' cannot contain characters outside of ASCII
1083+-- This function expects the scheme to be “http” and host to be present.
705−-- range, thus we can consider every character a 'Data.Word.Word8' value.
1084+--
706−--
1085+-- @since 3.0.0
707−-- This function only parses 'Url' (scheme, host, path) and optional query
1086+useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
708−-- parameters that are returned as 'Option'. It does not parse method name
1087+useHttpURI uri = do
709−-- or authentication info from given 'ByteString'.
1088+ guard (URI.uriScheme uri == Just [QQ.scheme|http|])
710−
1089+ urlHead <- http <$> uriHost uri
711−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
1090+ let url = case URI.uriPath uri of
712−parseUrlHttp url' = do
1091+ Nothing -> urlHead
713− url <- B.stripPrefix "http://" url'
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
714− (host :| path, option) <- parseUrlHelper url
1093+ return (url, uriOptions uri)
715− return (foldl (/:) (http host) path, option)
1094+
717−-- | Just like 'parseUrlHttp', but expects “https” scheme.
1095+-- | Just like 'useHttpURI', but expects the “https” scheme.
719−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
1098+useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
720−parseUrlHttps url' = do
1099+useHttpsURI uri = do
721− url <- B.stripPrefix "https://" url'
1100+ guard (URI.uriScheme uri == Just [QQ.scheme|https|])
722− (host :| path, option) <- parseUrlHelper url
1101+ urlHead <- https <$> uriHost uri
723− return (foldl (/:) (https host) path, option)
1102+ let url = case URI.uriPath uri of
724−
1103+ Nothing -> urlHead
725−-- | Get host\/collection of path pieces and possibly query parameters
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
726−-- already converted to 'Option'. This function is not public.
1105+ return (url, uriOptions uri)
728−parseUrlHelper :: ByteString -> Maybe (NonEmpty T.Text, Option scheme)
1107+-- | Convert URI path to a 'Url'. Internal.
729−parseUrlHelper url = do
1108+--
730− let (path', query') = B.break (== 0x3f) url
1109+-- @since 3.9.0
731− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
1110+uriPathToUrl ::
732− path <- NE.nonEmpty (Y.decodePathSegments path')
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
733− return (path, query)
1112+ Url scheme ->
1114+uriPathToUrl (trailingSlash, xs) urlHead =
1115+ if trailingSlash then path /: T.empty else path
1117+ path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1119+-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
1120+-- is not known in advance.
1127+ (Url 'Http, Option scheme0)
1128+ (Url 'Https, Option scheme1)
1131+ (Left <$> useHttpURI uri) <|> (Right <$> useHttpsURI uri)
1133+-- | An internal helper function to extract host from a 'URI'.
1134+uriHost :: URI -> Maybe Text
1135+uriHost uri = case URI.uriAuthority uri of
1137+ Right URI.Authority {..} ->
1138+ Just (URI.unRText authHost)
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.
1145+urlQ :: 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"
1155+ [ either (TH.lift . fst) (TH.lift . fst) eurl,
1158+ quotePat = error "This usage is not supported",
1159+ quoteType = error "This usage is not supported",
1160+ quoteDec = error "This usage is not supported"
1163+-- | An internal helper function to extract 'Option's from a 'URI'.
1164+uriOptions :: forall scheme. URI -> Option scheme
1174+ case URI.uriAuthority uri of
1175+ Left _ -> (mempty, mempty)
1176+ Right URI.Authority {..} ->
1177+ let auth0 = case authUserInfo of
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
1185+ Just port'' -> port (fromIntegral port'')
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)
1193+-- TODO Blocked on upstream: https://github.com/snoyberg/http-client/issues/424
1195+-- case URI.uriFragment uri of
1196+-- Nothing -> mempty
1197+-- Just fragment'' -> fragment (URI.unRText fragment'')
735instance RequestComponent (Url scheme) where
1199instance RequestComponent (Url scheme) where
736 getRequestMod (Url scheme segments) = Endo $ \x ->
1200 getRequestMod (Url scheme segments) = Endo $ \x ->
737− let (host :| path) = NE.reverse segments in
1201+ let (host :| path) = NE.reverse segments
738− x { L.secure = case scheme of
1203+ { L.secure = case scheme of
739− Http -> False
1204+ Http -> False
740− Https -> True
1205+ Https -> True,
741− , L.port = case scheme of
1206+ L.port = case scheme of
742− Http -> 80
1207+ Http -> 80
743− Https -> 443
1208+ Https -> 443,
744− , L.host = Y.urlEncode False (T.encodeUtf8 host)
1209+ L.host = Y.urlEncode False (T.encodeUtf8 host),
745− , L.path =
1210+ L.path =
746− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1211+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
748----------------------------------------------------------------------------
1214----------------------------------------------------------------------------
749−-- Request — Body
1215+-- Request—Body
753-- A number of options for request bodies are available. The @Content-Type@
1219-- A number of options for request bodies are available. The @Content-Type@
754−-- header is set for you automatically according to body option you use
1220+-- header is set for you automatically according to the body option you use
755−-- (it's always specified in documentation for given body option). To add
1221+-- (it's always specified in the documentation for a given body option). To
756−-- your own way to represent request body, see 'HttpBody'.
1222+-- add your own way to represent request body, define an instance of
758-- | This data type represents empty body of an HTTP request. This is the
1225-- | This data type represents empty body of an HTTP request. This is the
759-- data type to use with 'HttpMethod's that cannot have a body, as it's the
1226-- data type to use with 'HttpMethod's that cannot have a body, as it's the
760-- only type for which 'ProvidesBody' returns 'NoBody'.
1227-- only type for which 'ProvidesBody' returns 'NoBody'.
762-- Using of this body option does not set the @Content-Type@ header.
1229-- Using of this body option does not set the @Content-Type@ header.
764data NoReqBody = NoReqBody
1230data NoReqBody = NoReqBody
766instance HttpBody NoReqBody where
1232instance HttpBody NoReqBody where
767 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
769−-- | This body option allows to use a JSON object as request body — probably
1235+-- | This body option allows us to use a JSON object as the request
770−-- the most popular format right now. Just wrap a data type that is an
1236+-- body—probably the most popular format right now. Just wrap a data type
771−-- instance of 'ToJSON' type class and you are done: it will be converted to
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
772−-- JSON and inserted as request body.
1238+-- converted to JSON and inserted as request body.
774-- This body option sets the @Content-Type@ header to @\"application/json;
1240-- This body option sets the @Content-Type@ header to @\"application/json;
775-- charset=utf-8\"@ value.
1241-- charset=utf-8\"@ value.
777newtype ReqBodyJson a = ReqBodyJson a
1242newtype ReqBodyJson a = ReqBodyJson a
779−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
780 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
781− getRequestContentType Proxy = pure "application/json; charset=utf-8"
1246+ getRequestContentType _ = pure "application/json; charset=utf-8"
783-- | This body option streams request body from a file. It is expected that
1248-- | This body option streams request body from a file. It is expected that
784−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
786-- Using of this body option does not set the @Content-Type@ header.
1251-- Using of this body option does not set the @Content-Type@ header.
788newtype ReqBodyFile = ReqBodyFile FilePath
1252newtype ReqBodyFile = ReqBodyFile FilePath
790instance HttpBody ReqBodyFile where
1254instance HttpBody ReqBodyFile where
@@ -794,7 +1258,6 @@ instance HttpBody ReqBodyFile where
794-- | HTTP request body represented by a strict 'ByteString'.
1258-- | HTTP request body represented by a strict 'ByteString'.
796-- Using of this body option does not set the @Content-Type@ header.
1260-- Using of this body option does not set the @Content-Type@ header.
798newtype ReqBodyBs = ReqBodyBs ByteString
1261newtype ReqBodyBs = ReqBodyBs ByteString
800instance HttpBody ReqBodyBs where
1263instance HttpBody ReqBodyBs where
@@ -803,257 +1266,387 @@ instance HttpBody ReqBodyBs where
803-- | HTTP request body represented by a lazy 'BL.ByteString'.
1266-- | HTTP request body represented by a lazy 'BL.ByteString'.
805-- Using of this body option does not set the @Content-Type@ header.
1268-- Using of this body option does not set the @Content-Type@ header.
807newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
809instance HttpBody ReqBodyLbs where
1271instance HttpBody ReqBodyLbs where
810 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
812−-- | Form URL-encoded body. This can hold a collection of parameters which
1274+-- | URL-encoded body. This can hold a collection of parameters which are
813−-- are encoded similarly to query parameters at the end of query string,
1275+-- encoded similarly to query parameters at the end of query string, with
814−-- with the only difference that they are stored in request body. The
1276+-- the only difference that they are stored in request body. The similarity
815−-- similarity is reflected in the API as well, as you can use the same
1277+-- is reflected in the API as well, as you can use the same combinators you
816−-- combinators you would use to add query parameters: @('=:')@ and
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
819-- This body option sets the @Content-Type@ header to
1280-- This body option sets the @Content-Type@ header to
820−-- @\"application/x-www-from-urlencoded\"@ value.
1281+-- @\"application/x-www-form-urlencoded\"@ value.
822newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
1282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
824instance HttpBody ReqBodyUrlEnc where
1284instance HttpBody ReqBodyUrlEnc where
825 getRequestBody (ReqBodyUrlEnc (FormUrlEncodedParam params)) =
1285 getRequestBody (ReqBodyUrlEnc (FormUrlEncodedParam params)) =
826 (L.RequestBodyLBS . BB.toLazyByteString) (Y.renderQueryText False params)
1286 (L.RequestBodyLBS . BB.toLazyByteString) (Y.renderQueryText False params)
827− getRequestContentType Proxy = pure "application/x-www-form-urlencoded"
1287+ getRequestContentType _ = pure "application/x-www-form-urlencoded"
829-- | An opaque monoidal value that allows to collect URL-encoded parameters
1289-- | An opaque monoidal value that allows to collect URL-encoded parameters
830-- to be wrapped in 'ReqBodyUrlEnc'.
1290-- to be wrapped in 'ReqBodyUrlEnc'.
832−newtype FormUrlEncodedParam = FormUrlEncodedParam [(T.Text, Maybe T.Text)]
1291+newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
833 deriving (Semigroup, Monoid)
1292 deriving (Semigroup, Monoid)
835instance QueryParam FormUrlEncodedParam where
1294instance QueryParam FormUrlEncodedParam where
836 queryParam name mvalue =
1295 queryParam name mvalue =
837 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
839−-- | A type class for things that can be interpreted as HTTP
1299+-- | Use 'formToQuery'.
840−-- 'L.RequestBody'.
1300+--
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
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.
1313+-- ==== __Examples__
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
1321+-- > main = runReq def $ do
1323+-- > reqBodyMultipart
1324+-- > [ LM.partBS "title" "My Image"
1325+-- > , LM.partFileSource "file1" "/tmp/image.jpg"
1328+-- > req POST (http "example.com" /: "post")
1332+-- > liftIO $ print (responseBody response)
1333+data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
1335+instance HttpBody ReqBodyMultipart where
1336+ getRequestBody (ReqBodyMultipart _ body) = body
1337+ getRequestContentType (ReqBodyMultipart boundary _) =
1338+ pure ("multipart/form-data; boundary=" <> boundary)
1340+-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
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)
1349+-- | A type class for things that can be interpreted as an HTTP
842class HttpBody body where
1351class HttpBody body where
844− {-# MINIMAL getRequestBody #-}
846 -- | How to get actual 'L.RequestBody'.
1352 -- | How to get actual 'L.RequestBody'.
848 getRequestBody :: body -> L.RequestBody
1353 getRequestBody :: body -> L.RequestBody
850− -- | This method allows to optionally specify value of @Content-Type@
1355+ -- | This method allows us to optionally specify the value of
851− -- header that should be used with particular body option. By default it
1356+ -- @Content-Type@ header that should be used with particular body option.
852− -- returns 'Nothing' and so @Content-Type@ is not set.
1357+ -- By default it returns 'Nothing' and so @Content-Type@ is not set.
854− getRequestContentType :: Proxy body -> Maybe ByteString
1358+ getRequestContentType :: body -> Maybe ByteString
855− getRequestContentType Proxy = Nothing
1359+ getRequestContentType = const Nothing
857-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
858−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
859−-- 'GET' method and other methods that should not send a body.
1363+-- with 'GET' method and other methods that should not have body.
861type family ProvidesBody body :: CanHaveBody where
1364type family ProvidesBody body :: CanHaveBody where
862 ProvidesBody NoReqBody = 'NoBody
1365 ProvidesBody NoReqBody = 'NoBody
863− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
865-- | This type function allows any HTTP body if method says it
1368-- | This type function allows any HTTP body if method says it
866−-- 'CanHaveBody'. When method says it should have 'NoBody', the only body
1369+-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
867−-- option to use is 'NoReqBody'.
1370+-- body option to use is 'NoReqBody'.
869−-- __Note__: users of GHC 8.0.1 will see slightly more friendly error
870−-- messages when method does not allow a body and body is provided.
872−type family HttpBodyAllowed
1371+type family
873− (allowsBody :: CanHaveBody)
1373+ (allowsBody :: CanHaveBody)
874− (providesBody :: CanHaveBody) :: Constraint where
1374+ (providesBody :: CanHaveBody) ::
875− HttpBodyAllowed 'NoBody 'NoBody = ()
1377+ HttpBodyAllowed 'NoBody 'NoBody = ()
876− HttpBodyAllowed 'CanHaveBody body = ()
1378+ HttpBodyAllowed 'CanHaveBody body = ()
877−#if MIN_VERSION_base(4,9,0)
878− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1379+ HttpBodyAllowed 'NoBody 'CanHaveBody =
879− ('Text "This HTTP method does not allow attaching a request body.")
1381+ ('Text "This HTTP method does not allow attaching a request body.")
882−instance HttpBody body => RequestComponent (Womb "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
883− getRequestMod (Womb body) = Endo $ \x ->
1384+ getRequestMod (Tagged body) = Endo $ \x ->
884− x { L.requestBody = getRequestBody body
1386+ { L.requestBody = getRequestBody body,
885− , L.requestHeaders =
1387+ L.requestHeaders =
886− let old = L.requestHeaders x in
1388+ let old = L.requestHeaders x
887− case getRequestContentType (Proxy :: Proxy body) of
1389+ in case getRequestContentType body of
888− Nothing -> old
1390+ Nothing -> old
889− Just contentType ->
1391+ Just contentType ->
890− (Y.hContentType, contentType) : old }
1392+ (Y.hContentType, contentType) : old
892----------------------------------------------------------------------------
1395----------------------------------------------------------------------------
893−-- Request — Optional parameters
1396+-- Request—Optional parameters
895-- $optional-parameters
1398-- $optional-parameters
897−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
898-- headers, port number, etc. All optional parameters have the type
1401-- headers, port number, etc. All optional parameters have the type
899-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
1402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
900-- the last argument of 'req' to specify no optional parameters, or combine
1403-- the last argument of 'req' to specify no optional parameters, or combine
901−-- '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.
903−-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
1406+-- | The opaque 'Option' type is a 'Monoid' you can use to pack collection
904−-- optional parameters like query parameters and headers. See sections below
1407+-- of optional parameters like query parameters and headers. See sections
905−-- to learn which 'Option' primitives are available.
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))
907−data Option (scheme :: Scheme) =
908− Option (Endo (Y.QueryText, L.Request)) (Maybe (Endo L.Request))
909− -- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1412+-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
910− -- Request to avoid appending to existing query string in request every
1413+-- Request to avoid appending to an existing query string in request every
911− -- time new parameter is added. Additional Maybe (Endo Request) is a
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
912− -- finalizer that will be applied after all over options. This is for
1415+-- L.Request) is a finalizer that will be applied after all other
913− -- authentication methods that sign requests based on data in Request.
1416+-- transformations. This is for authentication methods that sign requests
1417+-- based on data in Request.
915instance Semigroup (Option scheme) where
1419instance Semigroup (Option scheme) where
916− Option er0 mr0 <> Option er1 mr1 = Option
1420+ Option er0 mr0 <> Option er1 mr1 =
917− (er0 <> er1) (mr0 <|> mr1)
1422+ (er0 <> er1)
919instance Monoid (Option scheme) where
1425instance Monoid (Option scheme) where
920− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
921 mappend = (<>)
1427 mappend = (<>)
923−-- | A helper to create an 'Option' that modifies only collection of query
1429+-- | Use 'formToQuery'.
924−-- parameters. This helper is not a part of public API.
1430+--
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
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.
926withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
927withQueryParams f = Option (Endo (first f)) Nothing
1438withQueryParams f = Option (Endo (first f)) Nothing
929-- | A helper to create an 'Option' that modifies only 'L.Request'. This
1440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
930-- helper is not a part of public API.
1441-- helper is not a part of public API.
932withRequest :: (L.Request -> L.Request) -> Option scheme
1442withRequest :: (L.Request -> L.Request) -> Option scheme
933withRequest f = Option (Endo (second f)) Nothing
1443withRequest f = Option (Endo (second f)) Nothing
935−-- | A helper to create an 'Option' that adds a finalizer (request
936−-- endomorphism that is run after all other modifications).
938−asFinalizer :: (L.Request -> L.Request) -> Option scheme
939−asFinalizer f = Option mempty (Just (Endo f))
941instance RequestComponent (Option scheme) where
1445instance RequestComponent (Option scheme) where
942− getRequestMod (Option f finalizer) = Endo $ \x ->
1446+ getRequestMod (Option f _) = Endo $ \x ->
943 let (qparams, x') = appEndo f ([], x)
1447 let (qparams, x') = appEndo f ([], x)
944− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
945− in maybe id appEndo finalizer x' { L.queryString = query }
1449+ in x' {L.queryString = query}
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
947----------------------------------------------------------------------------
1456----------------------------------------------------------------------------
948−-- Request — Optional parameters — Query Parameters
1457+-- Request—Optional parameters—Query Parameters
950-- $query-parameters
1459-- $query-parameters
952-- This section describes a polymorphic interface that can be used to
1461-- This section describes a polymorphic interface that can be used to
953−-- construct query parameters (of type 'Option') and form URL-encoded bodies
1462+-- construct query parameters (of the type 'Option') and form URL-encoded
954−-- (of type 'FormUrlEncodedParam').
1463+-- bodies (of the type 'FormUrlEncodedParam').
956-- | This operator builds a query parameter that will be included in URL of
1465-- | This operator builds a query parameter that will be included in URL of
957−-- 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
958-- with form URL encoded request bodies.
1467-- with form URL encoded request bodies.
960-- This operator is defined in terms of 'queryParam':
1469-- This operator is defined in terms of 'queryParam':
962-- > name =: value = queryParam name (pure value)
1471-- > name =: value = queryParam name (pure value)
964infix 7 =:
1472infix 7 =:
965−(=:) :: (QueryParam param, ToHttpApiData a) => T.Text -> a -> param
1474+(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
966name =: value = queryParam name (pure value)
1475name =: value = queryParam name (pure value)
968−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
969−-- the following URL @a@ is a flag, @b@ is a query parameter with a value:
1478+-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
971-- > https://httpbin.org/foo/bar?a&b=10
1481-- > https://httpbin.org/foo/bar?a&b=10
973-- This operator is defined in terms of 'queryParam':
1483-- This operator is defined in terms of 'queryParam':
975−-- > queryFlag name = queryParam name Nothing
1485+-- > queryFlag name = queryParam name (Nothing :: Maybe ())
977−queryFlag :: QueryParam param => T.Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
978queryFlag name = queryParam name (Nothing :: Maybe ())
1487queryFlag name = queryParam name (Nothing :: Maybe ())
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
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@).
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1501+ toParam (key, val) =
980−-- | A type class for query-parameter-like things. The reason to have
1507+-- | A type class for query-parameter-like things. The reason to have an
981-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
982-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
983-- Having the same syntax for these cases seems natural and user-friendly.
1510-- Having the same syntax for these cases seems natural and user-friendly.
985class QueryParam param where
1511class QueryParam param where
987 -- | Create a query parameter with given name and value. If value is
1512 -- | Create a query parameter with given name and value. If value is
988 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
989 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
990 -- method, because they are easier to read.
1515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
992− queryParam :: ToHttpApiData a => T.Text -> Maybe a -> param
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
994instance QueryParam (Option scheme) where
1523instance QueryParam (Option scheme) where
995 queryParam name mvalue =
1524 queryParam name mvalue =
996 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
998----------------------------------------------------------------------------
1528----------------------------------------------------------------------------
999−-- Request — Optional parameters — Headers
1529+-- Request—Optional parameters—Headers
1001-- | Create an 'Option' that adds a header. Note that if you 'mappend' two
1531-- | Create an 'Option' that adds a header. Note that if you 'mappend' two
1002-- headers with the same names the leftmost header will win. This means, in
1532-- headers with the same names the leftmost header will win. This means, in
1003-- particular, that you cannot create a request with several headers of the
1533-- particular, that you cannot create a request with several headers of the
1004-- same name.
1534-- same name.
1006−header
1535+header ::
1007− :: ByteString -- ^ Header name
1536+ -- | Header name
1008− -> ByteString -- ^ Header value
1538+ -- | Header value
1009− -> Option scheme
1540+ Option scheme
1010header name value = withRequest (attachHeader name value)
1541header name value = withRequest (attachHeader name value)
1012−-- | A non-public helper that attaches a header with given name and content
1543+-- | Attach a header with given name and content to a 'L.Request'.
1013−-- to a 'L.Request'.
1544+--
1014−
1545+-- @since 1.1.0
1015attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1016attachHeader name value x =
1547attachHeader name value x =
1017− x { L.requestHeaders = (CI.mk name, value) : L.requestHeaders x }
1548+ x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1550+-- | Same as 'header', but with redacted values on print.
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}
1019----------------------------------------------------------------------------
1558----------------------------------------------------------------------------
1020−-- Request — Optional parameters — Cookies
1559+-- Request—Optional parameters—Cookies
1022-- $cookies
1561-- $cookies
1024−-- 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
1025-- specify which cookies to send using 'cookieJar' and inspect 'L.Response'
1564-- specify which cookies to send using 'cookieJar' and inspect 'L.Response'
1026-- to extract 'L.CookieJar' from it (see 'responseCookieJar').
1565-- to extract 'L.CookieJar' from it (see 'responseCookieJar').
1028-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
1567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
1029-- 'L.Response' record.
1568-- 'L.Response' record.
1031cookieJar :: L.CookieJar -> Option scheme
1569cookieJar :: L.CookieJar -> Option scheme
1032cookieJar jar = withRequest $ \x ->
1570cookieJar jar = withRequest $ \x ->
1033− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
1035----------------------------------------------------------------------------
1573----------------------------------------------------------------------------
1036−-- Request — Optional parameters — Authentication
1574+-- Request—Optional parameters—Authentication
1038-- $authentication
1576-- $authentication
1040−-- This section provides common authentication helpers in form of 'Option's.
1578+-- This section provides the common authentication helpers in the form of
1041−-- You should always prefer the provided authentication 'Option's to manual
1579+-- 'Option's. You should always prefer the provided authentication 'Option's
1042−-- construction of headers because it ensures that you only use one
1580+-- to manual construction of headers because it ensures that you only use
1043−-- authentication method at a time (they overwrite each other) and provides
1581+-- one authentication method at a time (they overwrite each other) and
1044−-- additional type safety that prevents leaking of credentials in cases when
1582+-- provides additional type safety that prevents leaking of credentials in
1045−-- authentication relies on TLS for encrypting sensitive data.
1583+-- the cases when authentication relies on HTTPS for encrypting sensitive
1047-- | The 'Option' adds basic authentication.
1586-- | The 'Option' adds basic authentication.
1049-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1051−basicAuth
1589+basicAuth ::
1052− :: ByteString -- ^ Username
1590+ -- | Username
1053− -> ByteString -- ^ Password
1592+ -- | Password
1054− -> Option 'Https -- ^ Auth 'Option'
1595+ Option 'Https
1596+basicAuth = basicAuthUnsafe
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.
1055−basicAuth username password = asFinalizer
1610+basicAuthUnsafe username password =
1056− (L.applyBasicAuth username password)
1612+ (pure . L.applyBasicAuth username password)
1614+-- | The 'Option' set basic proxy authentication header.
1624+basicProxyAuth username password =
1625+ withRequest (L.applyBasicProxyAuth username password)
1627+-- | The 'Option' adds OAuth1 authentication.
1631+ -- | Consumer token
1633+ -- | Consumer secret
1637+ -- | OAuth token secret
1641+oAuth1 consumerToken consumerSecret token tokenSecret =
1642+ customAuth (OAuth.signOAuth app creds)
1646+ { OAuth.oauthConsumerKey = consumerToken,
1647+ OAuth.oauthConsumerSecret = consumerSecret
1649+ creds = OAuth.newCredential token tokenSecret
1058-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
1651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
1059-- services as the equivalent of a username and password.
1652-- services as the equivalent of a username and password.
@@ -1063,12 +1656,14 @@ basicAuth username password = asFinalizer
1063-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1065-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1067−oAuth2Bearer
1659+oAuth2Bearer ::
1068− :: ByteString -- ^ Token
1660+ -- | Token
1069− -> Option 'Https -- ^ Auth 'Option'
1662+ -- | Auth 'Option'
1070−oAuth2Bearer token = asFinalizer
1664+oAuth2Bearer token =
1071− (attachHeader "Authorization" ("Bearer " <> token))
1666+ (pure . attachHeader "Authorization" ("Bearer " <> token))
1073-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
1668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
1074-- to be used only by GitHub). This will be treated by whatever services
1669-- to be used only by GitHub). This will be treated by whatever services
@@ -1079,26 +1674,35 @@ oAuth2Bearer token = asFinalizer
1079-- > oAuth2Token token = header "Authorization" ("token" <> token)
1674-- > oAuth2Token token = header "Authorization" ("token" <> token)
1081-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1083−oAuth2Token
1677+oAuth2Token ::
1084− :: ByteString -- ^ Token
1678+ -- | Token
1085− -> Option 'Https -- ^ Auth 'Option'
1681+ Option 'Https
1086−oAuth2Token token = asFinalizer
1682+oAuth2Token token =
1087− (attachHeader "Authorization" ("token " <> token))
1684+ (pure . attachHeader "Authorization" ("token " <> token))
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.
1691+customAuth :: (L.Request -> IO L.Request) -> Option scheme
1692+customAuth = Option mempty . pure
1089----------------------------------------------------------------------------
1694----------------------------------------------------------------------------
1090−-- Request — Optional parameters — Other
1695+-- Request—Optional parameters—Other
1092-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1093−-- determines default port, @80@ for HTTP and @443@ for HTTPS, this 'Option'
1698+-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1094−-- allows to choose arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1096port :: Int -> Option scheme
1700port :: Int -> Option scheme
1097port n = withRequest $ \x ->
1701port n = withRequest $ \x ->
1098− x { L.port = n }
1702+ x {L.port = n}
1100-- | This 'Option' controls whether gzipped data should be decompressed on
1704-- | This 'Option' controls whether gzipped data should be decompressed on
1101−-- the fly. By default everything except for @application\/x-tar@ is
1705+-- the fly. By default everything except for @\"application\/x-tar\"@ is
1102-- decompressed, i.e. we have:
1706-- decompressed, i.e. we have:
1104-- > decompress (/= "application/x-tar")
1708-- > decompress (/= "application/x-tar")
@@ -1106,262 +1710,342 @@ port n = withRequest $ \x ->
1106-- You can also choose to decompress everything like this:
1710-- You can also choose to decompress everything like this:
1108-- > decompress (const True)
1712-- > decompress (const True)
1110−decompress
1713+decompress ::
1111− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1112− -- returns 'True' when content should be decompressed on the fly.
1715+ -- should be decompressed on the fly.
1716+ (ByteString -> Bool) ->
1113− -> Option scheme
1717+ Option scheme
1114decompress f = withRequest $ \x ->
1718decompress f = withRequest $ \x ->
1115− x { L.decompress = f }
1719+ x {L.decompress = f}
1117−-- | Specify number of microseconds to wait for response. Default is 30
1721+-- | Specify the number of microseconds to wait for response. The default
1118−-- seconds.
1722+-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
1119−
1723+-- 'L.Manager').
1120−responseTimeout
1724+responseTimeout ::
1121− :: Int -- ^ Number of microseconds to wait
1725+ -- | Number of microseconds to wait
1122− -> Option scheme
1727+ Option scheme
1123responseTimeout n = withRequest $ \x ->
1728responseTimeout n = withRequest $ \x ->
1124− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1126−-- | HTTP version to send to server, default is HTTP 1.1.
1731+-- | HTTP version to send to the server, the default is HTTP 1.1.
1128−httpVersion
1732+httpVersion ::
1129− :: Int -- ^ Major version number
1733+ -- | Major version number
1130− -> Int -- ^ Minor version number
1735+ -- | Minor version number
1131− -> Option scheme
1737+ Option scheme
1132httpVersion major minor = withRequest $ \x ->
1738httpVersion major minor = withRequest $ \x ->
1133− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
1135----------------------------------------------------------------------------
1741----------------------------------------------------------------------------
1136-- Response interpretations
1742-- Response interpretations
1138−-- | Make a request and ignore body of response.
1744+-- | Make a request and ignore the body of the response.
1140−data IgnoreResponse = IgnoreResponse (L.Response ())
1745+newtype IgnoreResponse = IgnoreResponse (L.Response ())
1142instance HttpResponse IgnoreResponse where
1748instance HttpResponse IgnoreResponse where
1143 type HttpResponseBody IgnoreResponse = ()
1749 type HttpResponseBody IgnoreResponse = ()
1144− toVanillaResponse (IgnoreResponse response) = response
1750+ toVanillaResponse (IgnoreResponse r) = r
1145− getHttpResponse request manager =
1751+ getHttpResponse r = return $ IgnoreResponse (void r)
1146− IgnoreResponse <$> liftIO (L.httpNoBody request manager)
1148-- | Use this as the fourth argument of 'req' to specify that you want it to
1753-- | Use this as the fourth argument of 'req' to specify that you want it to
1149−-- return the 'IgnoreResponse' interpretation.
1754+-- ignore the response body.
1151ignoreResponse :: Proxy IgnoreResponse
1755ignoreResponse :: Proxy IgnoreResponse
1152ignoreResponse = Proxy
1756ignoreResponse = Proxy
1154−-- | 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
1155-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1156-- monad in which you use 'req' will determine what to do in the case when
1760-- monad in which you use 'req' will determine what to do in the case when
1157−-- parsing fails ('JsonHttpException' constructor will be used).
1761+-- parsing fails (the 'JsonHttpException' constructor will be used).
1159newtype JsonResponse a = JsonResponse (L.Response a)
1762newtype JsonResponse a = JsonResponse (L.Response a)
1161−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
1162 type HttpResponseBody (JsonResponse a) = a
1766 type HttpResponseBody (JsonResponse a) = a
1163− toVanillaResponse (JsonResponse response) = response
1767+ toVanillaResponse (JsonResponse r) = r
1164− getHttpResponse request manager = do
1768+ getHttpResponse r = do
1165− response <- L.httpLbs request manager
1769+ chunks <- L.brConsume (L.responseBody r)
1166− case A.eitherDecode (L.responseBody response) of
1770+ case A.eitherDecode (BL.fromChunks chunks) of
1167 Left e -> throwIO (JsonHttpException e)
1771 Left e -> throwIO (JsonHttpException e)
1168− Right x -> return $ JsonResponse response { L.responseBody = x }
1772+ Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
1170−-- | 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
1171-- return the 'JsonResponse' interpretation.
1776-- return the 'JsonResponse' interpretation.
1173jsonResponse :: Proxy (JsonResponse a)
1777jsonResponse :: Proxy (JsonResponse a)
1174jsonResponse = Proxy
1778jsonResponse = Proxy
1176−-- | Make a request and interpret body of response as a strict 'ByteString'.
1780+-- | Make a request and interpret the body of the response as a strict
1177−
1781+-- 'ByteString'.
1178newtype BsResponse = BsResponse (L.Response ByteString)
1782newtype BsResponse = BsResponse (L.Response ByteString)
1180instance HttpResponse BsResponse where
1785instance HttpResponse BsResponse where
1181 type HttpResponseBody BsResponse = ByteString
1786 type HttpResponseBody BsResponse = ByteString
1182− toVanillaResponse (BsResponse response) = response
1787+ toVanillaResponse (BsResponse r) = r
1183− getHttpResponse request manager =
1788+ getHttpResponse r = do
1184− L.withResponse request manager $ \response -> do
1185− chunks <- L.brConsume (L.responseBody response)
1789+ chunks <- L.brConsume (L.responseBody r)
1186− return $ BsResponse response { L.responseBody = B.concat chunks }
1790+ return $ BsResponse (B.concat chunks <$ r)
1188−-- | Use this as the forth argument of 'req' to specify that you want to
1189−-- interpret response body as a strict 'ByteString'.
1792+-- | Use this as the fourth argument of 'req' to specify that you want to
1793+-- interpret the response body as a strict 'ByteString'.
1191bsResponse :: Proxy BsResponse
1794bsResponse :: Proxy BsResponse
1192bsResponse = Proxy
1795bsResponse = Proxy
1194−-- | 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
1195-- 'BL.ByteString'.
1798-- 'BL.ByteString'.
1197newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1199instance HttpResponse LbsResponse where
1802instance HttpResponse LbsResponse where
1200 type HttpResponseBody LbsResponse = BL.ByteString
1803 type HttpResponseBody LbsResponse = BL.ByteString
1201− toVanillaResponse (LbsResponse response) = response
1804+ toVanillaResponse (LbsResponse r) = r
1202− getHttpResponse request manager =
1805+ getHttpResponse r = do
1203− LbsResponse <$> L.httpLbs request manager
1806+ chunks <- L.brConsume (L.responseBody r)
1204−
1807+ return $ LbsResponse (BL.fromChunks chunks <$ r)
1205−-- | Use this as the forth argument of 'req' to specify that you want to
1206−-- interpret response body as a lazy 'BL.ByteString'.
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'.
1208lbsResponse :: Proxy LbsResponse
1811lbsResponse :: Proxy LbsResponse
1209lbsResponse = Proxy
1812lbsResponse = Proxy
1211−-- | This interpretation does not result in any call at all, but you can use
1814+----------------------------------------------------------------------------
1212−-- the 'responseRequest' function to extract 'L.Request' that 'req' has
1815+-- Helpers for response interpretations
1213−-- prepared. This is useful primarily for testing.
1816+
1214−--
1817+-- | Fetch beginning of the response and return it together with a new
1215−-- Note that when you use this interpretation inspecting response will
1818+-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
1216−-- diverge (i.e. it'll blow up with an error, don't do that).
1819+-- such.
1218−newtype ReturnRequest = ReturnRequest L.Request
1821+ -- | How many bytes to fetch
1220−instance HttpResponse ReturnRequest where
1823+ -- | Response with body reader inside
1221− type HttpResponseBody ReturnRequest = ()
1824+ L.Response L.BodyReader ->
1222− toVanillaResponse (ReturnRequest _) = error
1825+ -- | Preview 'ByteString' and new response with body reader inside
1223− "Network.HTTP.Req.ReturnRequest interpretation does not make requests"
1826+ IO (ByteString, L.Response L.BodyReader)
1224− getHttpResponse request _ = return (ReturnRequest request)
1827+grabPreview nbytes r = do
1225−
1828+ let br = L.responseBody r
1226−-- | Use this as the forth argument of 'req' to specify that you want it to
1829+ (target, leftover, done) <- brReadN br nbytes
1227−-- just return the request it consturcted without making any requests.
1830+ nref <- newIORef (0 :: Int)
1229−returnRequest :: Proxy ReturnRequest
1832+ n <- readIORef nref
1230−returnRequest = Proxy
1833+ let incn = modifyIORef' nref (+ 1)
1844+ else return leftover
1847+ then return B.empty
1849+ return (target, r {L.responseBody = br'})
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.
1854+ -- | Body reader to stream from
1856+ -- | How many bytes to consume
1858+ -- | Target chunk, the leftover, whether we're done
1859+ IO (ByteString, ByteString, Bool)
1860+brReadN br n = go 0 id id
1865+ then return (r t, r l, True)
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 [])
1232----------------------------------------------------------------------------
1876----------------------------------------------------------------------------
1233-- Inspecting a response
1877-- Inspecting a response
1235−-- | Get response body.
1879+-- | Get the response body.
1237−responseBody
1880+responseBody ::
1238− :: HttpResponse response
1881+ (HttpResponse response) =>
1239− => response
1882+ response ->
1240− -> HttpResponseBody response
1883+ HttpResponseBody response
1241responseBody = L.responseBody . toVanillaResponse
1884responseBody = L.responseBody . toVanillaResponse
1243−-- | Get response status code.
1886+-- | Get the response status code.
1245−responseStatusCode
1887+responseStatusCode ::
1246− :: HttpResponse response
1888+ (HttpResponse response) =>
1247− => response
1889+ response ->
1249responseStatusCode =
1891responseStatusCode =
1250 Y.statusCode . L.responseStatus . toVanillaResponse
1892 Y.statusCode . L.responseStatus . toVanillaResponse
1252−-- | Get response status message.
1894+-- | Get the response status message.
1254−responseStatusMessage
1895+responseStatusMessage ::
1255− :: HttpResponse response
1896+ (HttpResponse response) =>
1256− => response
1897+ response ->
1257− -> ByteString
1898+ ByteString
1258responseStatusMessage =
1899responseStatusMessage =
1259 Y.statusMessage . L.responseStatus . toVanillaResponse
1900 Y.statusMessage . L.responseStatus . toVanillaResponse
1261−-- | Look a particular header from a response.
1902+-- | Lookup a particular header from a response.
1263−responseHeader
1903+responseHeader ::
1264− :: HttpResponse response
1904+ (HttpResponse response) =>
1265− => response -- ^ Response interpretation
1905+ -- | Response interpretation
1266− -> ByteString -- ^ Header to lookup
1907+ -- | Header to lookup
1267− -> Maybe ByteString -- ^ Header value if found
1909+ -- | Header value if found
1268responseHeader r h =
1911responseHeader r h =
1269 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1271−-- | Get response 'L.CookieJar'.
1914+-- | Get the response 'L.CookieJar'.
1273−responseCookieJar
1915+responseCookieJar ::
1274− :: HttpResponse response
1916+ (HttpResponse response) =>
1275− => response
1917+ response ->
1276− -> L.CookieJar
1918+ L.CookieJar
1277responseCookieJar = L.responseCookieJar . toVanillaResponse
1919responseCookieJar = L.responseCookieJar . toVanillaResponse
1279−-- | Get the original request from 'ReturnRequest' response interpretation.
1281−responseRequest :: ReturnRequest -> L.Request
1282−responseRequest (ReturnRequest request) = request
1284----------------------------------------------------------------------------
1921----------------------------------------------------------------------------
1285−-- Response — defining your own interpretation
1922+-- Response—Defining your own interpretation
1287-- $new-response-interpretation
1924-- $new-response-interpretation
1289-- To create a new response interpretation you just need to make your data
1926-- To create a new response interpretation you just need to make your data
1290−-- type an instance of 'HttpResponse' type class.
1927+-- type an instance of the 'HttpResponse' type class.
1292−-- | A type class for response interpretations. It allows to fully control
1293−-- how request is made and how its body is parsed.
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.
1295class HttpResponse response where
1932class HttpResponse response where
1297− -- | The associated type is type of body that can be extracted from a
1933+ -- | The associated type is the type of body that can be extracted from an
1298 -- instance of 'HttpResponse'.
1934 -- instance of 'HttpResponse'.
1935+ type HttpResponseBody response :: Type
1300− type HttpResponseBody response :: *
1302− -- | The method describes how to get underlying 'L.Response' record.
1937+ -- | The method describes how to get the underlying 'L.Response' record.
1304 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1306− -- | This method describes how to make an HTTP request given 'L.Request'
1940+ -- | This method describes how to consume response body and, more
1307− -- (prepared by the rest of the library) and 'L.Manager'.
1941+ -- generally, obtain @response@ value from @'L.Response' 'L.BodyReader'@.
1309− getHttpResponse :: L.Request -> L.Manager -> IO response
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.)
1951+ -- __Note__: signature of this function was changed in the version
1954+ -- | Response with body reader inside
1955+ L.Response L.BodyReader ->
1956+ -- | The final result
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.
1963+ -- __Note__: manually specified 'Options' that set the @\"Accept\"@ header
1964+ -- will take precedence.
1967+ acceptHeader :: Proxy response -> Maybe ByteString
1968+ acceptHeader Proxy = Nothing
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
1311----------------------------------------------------------------------------
1980----------------------------------------------------------------------------
1314-- | The main class for things that are “parts” of 'L.Request' in the sense
1983-- | The main class for things that are “parts” of 'L.Request' in the sense
1315-- that if we have a 'L.Request', then we know how to apply an instance of
1984-- that if we have a 'L.Request', then we know how to apply an instance of
1316−-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is
1985+-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1317−-- endomorphism of functions under composition, it's used to chain different
1986+-- monoid of endomorphisms under composition, it's used to chain different
1318−-- request component easier using @('<>')@.
1987+-- request components easier using @('<>')@.
1989+-- __Note__: this type class is not a part of the public API.
1320class RequestComponent a where
1990class RequestComponent a where
1322 -- | Get a function that takes a 'L.Request' and changes it somehow
1991 -- | Get a function that takes a 'L.Request' and changes it somehow
1323− -- returning another 'L.Request'. For example HTTP method instance of
1992+ -- returning another 'L.Request'. For example, the 'HttpMethod' instance
1324− -- 'RequestComponent' just overwrites method. The function is wrapped in
1993+ -- of 'RequestComponent' just overwrites method. The function is wrapped
1325− -- 'Endo' so it's easier to chain such “modifying applications” together
1994+ -- in 'Endo' so it's easier to chain such “modifying applications”
1326− -- building bigger and bigger 'RequestComponent's.
1995+ -- together building bigger and bigger 'RequestComponent's.
1328 getRequestMod :: a -> Endo L.Request
1996 getRequestMod :: a -> Endo L.Request
1330−-- | 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.
1331-- This is necessary to define instances of 'RequestComponent' for any thing
1999-- This is necessary to define instances of 'RequestComponent' for any thing
1332−-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC is not
2000+-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC can't
1333−-- able to see difference between @'HttpMethod' method => 'RequestComponent'
2001+-- see the difference between @'HttpMethod' method => 'RequestComponent'
1334-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
2002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
1335−-- 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,
1336-- when instance is already chosen).
2004-- when instance is already chosen).
1338−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
1340-- | Exceptions that this library throws.
2007-- | Exceptions that this library throws.
1342data HttpException
2008data HttpException
1343− = VanillaHttpException L.HttpException
1344− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2009+ = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1345− | JsonHttpException String
2010+ VanillaHttpException L.HttpException
1346− -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
2011+ | -- | A wrapper with Aeson-produced 'String' describing why decoding
2013+ JsonHttpException String
1347− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
1349instance Exception HttpException
2016instance Exception HttpException
1351−-- | A simple 'Bool'-like type we only have for better error messages. We
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
1352−-- use it as a kind and its data constructors as type-level tags.
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
1354−-- See also: 'HttpMethod' and 'HttpBody'.
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2027+ (L.StatusCodeException r _)
2030+isStatusCodeException _ = Nothing
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
2036+-- See also: 'HttpMethod' and 'HttpBody'.
1356data CanHaveBody
2037data CanHaveBody
1357− = CanHaveBody -- ^ Indeed can have a body
2038+ = -- | Indeed can have a body
1358− | NoBody -- ^ Should not have a body
2040+ | -- | Should not have a body
1360−-- | 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
1361-- enabled). This is used to force TLS requirement for some authentication
2044-- enabled). This is used to force TLS requirement for some authentication
1362-- 'Option's.
2045-- 'Option's.
1364data Scheme
2046data Scheme
1365− = Http -- ^ HTTP, no TLS
2047+ = -- | HTTP
1366− | Https -- ^ HTTPS
2049+ | -- | HTTPS
1367− deriving (Eq, Ord, Show, Data, Typeable, Generic)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)