@@ -1,258 +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 use the
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
31−-- same implicit global manager for simplicity and maximal connection
39+-- simplicity and maximal connection sharing. There is a way to use your own
32−-- sharing. There is a way to use your own manager with different settings,
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− , oAuth1
164+ oAuth1,
172− , oAuth2Bearer
165+ oAuth2Bearer,
173− , oAuth2Token
166+ oAuth2Token,
174− , awsAuth
167+ customAuth,
175 -- *** Other
169 -- *** Other
177− , decompress
171+ decompress,
178− , responseTimeout
172+ responseTimeout,
179− , httpVersion
173+ httpVersion,
180 -- * Response
175 -- * Response
181 -- ** Response interpretations
177 -- ** Response interpretations
182− , IgnoreResponse
178+ IgnoreResponse,
183− , ignoreResponse
179+ ignoreResponse,
184− , JsonResponse
180+ JsonResponse,
185− , jsonResponse
181+ jsonResponse,
186− , BsResponse
182+ BsResponse,
187− , bsResponse
183+ bsResponse,
188− , LbsResponse
184+ LbsResponse,
189− , lbsResponse
185+ lbsResponse,
192 -- ** Inspecting a response
187 -- ** Inspecting a response
193− , responseBody
188+ responseBody,
194− , responseStatusCode
189+ responseStatusCode,
195− , responseStatusMessage
190+ responseStatusMessage,
196− , responseHeader
191+ responseHeader,
197− , responseCookieJar
192+ responseCookieJar,
198− , responseRequest
193+
199 -- ** Defining your own interpretation
194 -- ** Defining your own interpretation
200 -- $new-response-interpretation
195 -- $new-response-interpretation
201− , HttpResponse (..)
196+ HttpResponse (..),
202 -- * Other
198 -- * Other
203− , HttpException (..)
199+ HttpException (..),
200+ isStatusCodeException,
204− , CanHaveBody (..)
201+ CanHaveBody (..),
205− , Scheme (..) )
202+ Scheme (..),
206+import Blaze.ByteString.Builder qualified as BB
208import Control.Applicative
207import Control.Applicative
209import Control.Arrow (first, second)
208import Control.Arrow (first, second)
210−import Control.Exception (Exception, try, catch, throwIO)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
211−import Control.Monad
211+import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
212import Control.Monad.IO.Class
213import Control.Monad.IO.Class
213−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
214import 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
215import Data.Data (Data)
238import Data.Data (Data)
216−import Data.Default.Class
239+import Data.Default.Class (def)
217import Data.Function (on)
240import Data.Function (on)
218import Data.IORef
241import Data.IORef
219−import Data.List (nubBy)
242+import Data.Kind (Constraint, Type)
243+import Data.List (foldl', nubBy)
220import Data.List.NonEmpty (NonEmpty (..))
244import Data.List.NonEmpty (NonEmpty (..))
245+import Data.List.NonEmpty qualified as NE
246+import Data.Maybe (fromMaybe)
221import Data.Proxy
247import Data.Proxy
222−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
223−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)
224import GHC.Generics
254import GHC.Generics
225import 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
226import 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
227import Web.HttpApiData (ToHttpApiData (..))
272import Web.HttpApiData (ToHttpApiData (..))
228−import qualified Blaze.ByteString.Builder as BB
229−import qualified Data.Aeson as A
230−import qualified Data.ByteString as B
231−import qualified Data.ByteString.Lazy as BL
232−import qualified Data.CaseInsensitive as CI
233−import qualified Data.List.NonEmpty as NE
234−import qualified Data.Text as T
235−import qualified Data.Text.Encoding as T
236−import qualified Network.Connection as NC
237−import qualified Network.HTTP.Client as L
238−import qualified Network.HTTP.Client.Internal as LI
239−import qualified Network.HTTP.Client.TLS as L
240−import qualified Network.HTTP.Req.AWS as AWS
241−import qualified Network.HTTP.Req.OAuth1 as OAuth1
242−import qualified Network.HTTP.Types as Y
244−#if MIN_VERSION_base(4,9,0)
245−import Data.Kind (Constraint)
247−import GHC.Exts (Constraint)
250----------------------------------------------------------------------------
274----------------------------------------------------------------------------
251-- Making a request
275-- Making a request
253-- $making-a-request
277-- $making-a-request
255−-- To make an HTTP request you need only one function: 'req'.
279+-- To make an HTTP request you normally need only one function: 'req'.
257-- | 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
258-- specify required parameters and the final 'Option' argument is a
282-- specify required parameters and the final 'Option' argument is a
@@ -264,42 +288,44 @@ import GHC.Exts (Constraint)
264-- @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
265-- a dedicated section about HTTP methods below.
289-- a dedicated section about HTTP methods below.
267−-- @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
268−-- with. It's of type 'Url' (if you click the link it will tell everything
292+-- with.
269−-- about construction of 'Url' things).
271-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
272−-- tutorial has a section about HTTP bodies, but usage in very
295+-- tutorial has a section about HTTP bodies, but usage is very
273−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
275−-- @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
276−-- request, out-of-the-box it can be the following: 'ignoreResponse',
299+-- request. Out-of-the-box it can be the following:
301+-- * 'ignoreResponse'
277−-- 'jsonResponse', 'bsResponse' (to get strict 'ByteString'), 'lbsResponse'
303+-- * 'bsResponse' (to get a strict 'ByteString')
278−-- (to get lazy 'BL.ByteString'), and 'returnRequest' (makes no request,
304+-- * 'lbsResponse' (to get a lazy 'BL.ByteString')
279−-- just returns response, used for testing).
281−-- 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
282−-- other optional things like query parameters, headers, non-standard port
307+-- other optional settings like query parameters, headers, non-standard port
283−-- 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
284-- 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
285-- all, pass 'mempty'.
310-- all, pass 'mempty'.
287-- __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
288-- sharing and reuse is done for you automatically.
313-- sharing and reuse is done for you automatically.
290−-- See the examples below to get on the speed very quickly.
315+-- See the examples below to get on the speed quickly.
292-- ==== __Examples__
317-- ==== __Examples__
294-- 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
295-- try the examples:
320-- try the examples:
322+-- > {-# LANGUAGE DeriveGeneric #-}
297-- > {-# LANGUAGE OverloadedStrings #-}
323-- > {-# LANGUAGE OverloadedStrings #-}
299-- > module Main (main) where
325-- > module Main (main) where
301−-- > import Control.Exception (throwIO)
302-- > import Control.Monad
327-- > import Control.Monad
328+-- > import Control.Monad.IO.Class
303-- > import Data.Aeson
329-- > import Data.Aeson
304-- > import Data.Maybe (fromJust)
330-- > import Data.Maybe (fromJust)
305-- > import Data.Monoid ((<>))
331-- > import Data.Monoid ((<>))
@@ -307,32 +333,30 @@ import GHC.Exts (Constraint)
307-- > import GHC.Generics
333-- > import GHC.Generics
308-- > import Network.HTTP.Req
334-- > import Network.HTTP.Req
309-- > import qualified Data.ByteString.Char8 as B
335-- > import qualified Data.ByteString.Char8 as B
310−-- >
336+-- > import qualified Text.URI as URI
311−-- > instance MonadHttp IO where
312−-- > handleHttpException = throwIO
314-- We will be making requests against the <https://httpbin.org> service.
338-- We will be making requests against the <https://httpbin.org> service.
316-- Make a GET request, grab 5 random bytes:
340-- Make a GET request, grab 5 random bytes:
318-- > main :: IO ()
342-- > main :: IO ()
319−-- > main = do
343+-- > main = runReq defaultHttpConfig $ do
320-- > let n :: Int
344-- > let n :: Int
321-- > n = 5
345-- > n = 5
322-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
323−-- > B.putStrLn (responseBody bs)
347+-- > liftIO $ B.putStrLn (responseBody bs)
325-- 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
326-- seed of the generator:
350-- seed of the generator:
328-- > main :: IO ()
352-- > main :: IO ()
329−-- > main = do
353+-- > main = runReq defaultHttpConfig $ do
330-- > let n, seed :: Int
354-- > let n, seed :: Int
331-- > n = 5
355-- > n = 5
332-- > seed = 100
356-- > seed = 100
333-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
357-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
334-- > "seed" =: seed
358-- > "seed" =: seed
335−-- > B.putStrLn (responseBody bs)
359+-- > liftIO $ B.putStrLn (responseBody bs)
337-- POST JSON data and get some info about the POST request:
361-- POST JSON data and get some info about the POST request:
@@ -345,103 +369,252 @@ import GHC.Exts (Constraint)
345-- > instance FromJSON MyData
369-- > instance FromJSON MyData
347-- > main :: IO ()
371-- > main :: IO ()
348−-- > main = do
372+-- > main = runReq defaultHttpConfig $ do
349-- > let myData = MyData
373-- > let myData = MyData
350-- > { size = 6
374-- > { size = 6
351-- > , color = "Green" }
375-- > , color = "Green" }
352-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
376-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
353−-- > print (responseBody v :: Value)
377+-- > liftIO $ print (responseBody v :: Value)
355-- Sending URL-encoded body:
379-- Sending URL-encoded body:
357-- > main :: IO ()
381-- > main :: IO ()
358−-- > main = do
382+-- > main = runReq defaultHttpConfig $ do
359-- > let params =
383-- > let params =
360-- > "foo" =: ("bar" :: Text) <>
384-- > "foo" =: ("bar" :: Text) <>
361-- > queryFlag "baz"
385-- > queryFlag "baz"
362-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
386-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
363−-- > print (responseBody response :: Value)
387+-- > liftIO $ print (responseBody response :: Value)
365-- 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:
367-- > main :: IO ()
391-- > main :: IO ()
368−-- > main = do
392+-- > main = runReq defaultHttpConfig $ do
369-- > -- 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
370-- > -- 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'.
371−-- > 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)
372-- > response <- req GET url NoReqBody jsonResponse $
397-- > response <- req GET url NoReqBody jsonResponse $
373-- > "from" =: (15 :: Int) <>
398-- > "from" =: (15 :: Int) <>
374-- > "to" =: (67 :: Int) <>
399-- > "to" =: (67 :: Int) <>
375-- > basicAuth "username" "password" <>
400-- > basicAuth "username" "password" <>
376-- > options <> -- contains the ?foo=bar part
401-- > options <> -- contains the ?foo=bar part
377-- > port 443 -- here you can put any port of course
402-- > port 443 -- here you can put any port of course
378−-- > print (responseBody response :: Value)
403+-- > liftIO $ print (responseBody response :: Value)
380−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.
381− :: forall m method body response scheme.
547+ forall m method body scheme a.
382− ( MonadHttp m
548+ ( MonadHttp m,
383− , HttpMethod method
549+ HttpMethod method,
384− , HttpBody body
550+ HttpBody body,
385− , HttpResponse response
386− , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
551+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
387− => method -- ^ HTTP method
553+ -- | HTTP method
388− -> Url scheme -- ^ 'Url' — location of resource
555+ -- | 'Url'—location of resource
389− -> body -- ^ Body of the request
557+ -- | Body of the request
390− -> Proxy response -- ^ A hint how to interpret response
558+ body ->
559+ -- | Collection of optional parameters
391− -> Option scheme -- ^ Collection of optional parameters
560+ Option scheme ->
392− -> m response -- ^ Response
561+ -- | How to perform request
562+ (L.Request -> L.Manager -> m a) ->
393−req method url body Proxy options = do
565+req' method url body options m = do
394− config <- getHttpConfig
566+ config <- getHttpConfig
395− manager <- liftIO (readIORef globalManager)
396 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
397 -- “overwrite” headers when we construct a request by cons-ing.
568 -- “overwrite” headers when we construct a request by cons-ing.
398 nubHeaders = Endo $ \x ->
569 nubHeaders = Endo $ \x ->
399− x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
570+ x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
400− request = flip appEndo L.defaultRequest $
572+ flip appEndo L.defaultRequest $
401− -- NOTE Order of 'mappend's matters, here method is overwritten first
573+ -- NOTE The order of 'mappend's matters, here method is overwritten
402− -- and 'options' take effect last. In particular, this means that
574+ -- first and 'options' take effect last. In particular, this means
403− -- 'options' can overwrite things set by other request components,
575+ -- that 'options' can overwrite things set by other request
404− -- which is useful for setting port number, "Content-Type" header,
576+ -- components, which is useful for setting port number,
405− -- etc.
577+ -- "Content-Type" header, etc.
406− nubHeaders <>
578+ nubHeaders
407− getRequestMod options <>
579+ <> getRequestMod options
408− getRequestMod config <>
580+ <> getRequestMod config
409− getRequestMod (Womb body :: Womb "body" body) <>
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
410− getRequestMod url <>
582+ <> getRequestMod url
411− getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
412− wrappingVanilla m = catch m (throwIO . VanillaHttpException)
584+ request <- finalizeRequest options request'
413− (liftIO . try . wrappingVanilla) (getHttpResponse request manager)
585+ withReqManager (m request)
414− >>= either handleHttpException return
586+
415−
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
416−-- | 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
417−-- 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
418−-- when we create a request, instance 'HttpConfig' can affect the default
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
419−-- settings via 'getHttpConfig'.
596+-- default settings via 'getHttpConfig'.
421-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
422-- 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
423−-- 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
424−-- 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
425−-- 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
426−-- plan by inlining the definition, hence the @NOINLINE@ pragma.
603+-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
428−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
429globalManager = unsafePerformIO $ do
605globalManager = unsafePerformIO $ do
430 context <- NC.initConnectionContext
606 context <- NC.initConnectionContext
431− let settings = L.mkManagerSettingsContext (Just context) def Nothing
608+ L.mkManagerSettingsContext
432 manager <- L.newManager settings
612 manager <- L.newManager settings
433− newIORef manager
613+ return manager
434{-# NOINLINE globalManager #-}
614{-# NOINLINE globalManager #-}
436−-- | Perform an action using global implicit 'L.Manager' that the rest of
437−-- the library uses. This allows to reuse connections that the 'L.Manager'
440−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
441−withReqManager m = liftIO (readIORef globalManager) >>= m
443----------------------------------------------------------------------------
616----------------------------------------------------------------------------
444−-- Embedding requests into your monad
617+-- Embedding requests in your monad
446-- $embedding-requests
619-- $embedding-requests
@@ -450,91 +623,281 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
451-- When writing a library, keep your API polymorphic in terms of
624-- When writing a library, keep your API polymorphic in terms of
452-- '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).
454-- | A type class for monads that support performing HTTP requests.
630-- | A type class for monads that support performing HTTP requests.
455-- Typically, you only need to define the 'handleHttpException' method
631-- Typically, you only need to define the 'handleHttpException' method
456-- unless you want to tweak 'HttpConfig'.
632-- unless you want to tweak 'HttpConfig'.
458−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
460− {-# MINIMAL handleHttpException #-}
462 -- | This method describes how to deal with 'HttpException' that was
634 -- | This method describes how to deal with 'HttpException' that was
463 -- 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
464 -- exceptions, but if you prefer working with something like
636 -- exceptions, but if you prefer working with something like
465− -- '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
466− -- 'Control.Monad.Error.throwError'.
638+ -- 'Control.Monad.Except.throwError'.
468 handleHttpException :: HttpException -> m a
639 handleHttpException :: HttpException -> m a
470− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
471− -- implementation returns its 'def' value, which is described in the
642+ -- Default implementation returns its 'def' value, which is described in
472− -- documentation for the type. Common usage pattern with manually defined
643+ -- the documentation for the type. Common usage pattern with manually
473− -- 'getHttpConfig' is to return some hard-coded value, or value extracted
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
474− -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
645+ -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
475− -- configuration is desirable.
646+ -- approach to configuration is desirable.
477 getHttpConfig :: m HttpConfig
647 getHttpConfig :: m HttpConfig
478− getHttpConfig = return def
648+ getHttpConfig = return defaultHttpConfig
480−-- | 'HttpConfig' contains general and default settings to be used when
481−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
483data HttpConfig = HttpConfig
651data HttpConfig = HttpConfig
484− { httpConfigProxy :: Maybe L.Proxy
485− -- ^ 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@
486 -- environment variables are respected, this setting overwrites them.
653 -- environment variables are respected, this setting overwrites them.
487 -- Default value: 'Nothing'.
654 -- Default value: 'Nothing'.
488− , httpConfigRedirectCount :: Int
655+ httpConfigProxy :: Maybe L.Proxy,
489− -- ^ How many redirects to follow when getting a resource. Default
656+ -- | How many redirects to follow when getting a resource. Default
490 -- value: 10.
657 -- value: 10.
491− , httpConfigAltManager :: Maybe L.Manager
658+ httpConfigRedirectCount :: Int,
492− -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
659+ -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
493− -- 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
494− -- 99% of cases).
661+ -- in 99% of cases).
495− , httpConfigCheckResponse :: L.Request -> L.Response L.BodyReader -> IO ()
662+ httpConfigAltManager :: Maybe L.Manager,
496− -- ^ 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
497− -- status and headers. This is used for throwing exceptions on
666+ -- bytes). This is used for throwing exceptions on non-success status
498− -- non-success status codes by default (set to @\\_ _ -> return ()@ if
667+ -- codes by default (set to @\\_ _ _ -> Nothing@ if this behavior is not
499− -- 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
500− -- 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
501− -- 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
502− -- thrown exception is caught by the library though and is available in
678+ -- something exceptional). The thrown exception is caught by the library
503− -- 'handleHttpException'.
679+ -- though and is available in 'handleHttpException'.
504− } deriving Typeable
680+ --
505−
681+ -- __Note__: signature of this function was changed in the version
506−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
507− def = HttpConfig
725+ HttpConfig
508− { httpConfigProxy = Nothing
726+ { httpConfigProxy = Nothing,
509− , httpConfigRedirectCount = 10
727+ httpConfigRedirectCount = 10,
510− , httpConfigAltManager = Nothing
728+ httpConfigAltManager = Nothing,
511− , httpConfigCheckResponse = \_ response ->
729+ httpConfigCheckResponse = \_ response preview ->
512− let Y.Status statusCode _ = L.responseStatus response in
730+ let scode = statusCode response
513− unless (200 <= statusCode && statusCode < 300) $ do
731+ in if 200 <= scode && scode < 300
514− chunk <- BL.toStrict <$> L.brReadSome (L.responseBody response) 1024
732+ then Nothing
515− 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
517instance RequestComponent HttpConfig where
756instance RequestComponent HttpConfig where
518 getRequestMod HttpConfig {..} = Endo $ \x ->
757 getRequestMod HttpConfig {..} = Endo $ \x ->
519− x { L.proxy = httpConfigProxy
759+ { L.proxy = httpConfigProxy,
520− , L.redirectCount = httpConfigRedirectCount
760+ L.redirectCount = httpConfigRedirectCount,
521− , LI.requestManagerOverride = httpConfigAltManager
761+ LI.requestManagerOverride = httpConfigAltManager
522− , 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)
524----------------------------------------------------------------------------
888----------------------------------------------------------------------------
525−-- Request — Method
889+-- Request—Method
527-- $method
891-- $method
529-- 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'
530−-- 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
531-- 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
532-- 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
533-- 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
534-- define a new method that will works seamlessly, see 'HttpMethod'.
898-- define a new method that will works seamlessly, see 'HttpMethod'.
536-- | 'GET' method.
900-- | 'GET' method.
538data GET = GET
901data GET = GET
540instance HttpMethod GET where
903instance HttpMethod GET where
@@ -542,7 +905,6 @@ instance HttpMethod GET where
542 httpMethodName Proxy = Y.methodGet
905 httpMethodName Proxy = Y.methodGet
544-- | 'POST' method.
907-- | 'POST' method.
546data POST = POST
908data POST = POST
548instance HttpMethod POST where
910instance HttpMethod POST where
@@ -550,7 +912,6 @@ instance HttpMethod POST where
550 httpMethodName Proxy = Y.methodPost
912 httpMethodName Proxy = Y.methodPost
552-- | 'HEAD' method.
914-- | 'HEAD' method.
554data HEAD = HEAD
915data HEAD = HEAD
556instance HttpMethod HEAD where
917instance HttpMethod HEAD where
@@ -558,26 +919,24 @@ instance HttpMethod HEAD where
558 httpMethodName Proxy = Y.methodHead
919 httpMethodName Proxy = Y.methodHead
560-- | 'PUT' method.
921-- | 'PUT' method.
562data PUT = PUT
922data PUT = PUT
564instance HttpMethod PUT where
924instance HttpMethod PUT where
565 type AllowsBody PUT = 'CanHaveBody
925 type AllowsBody PUT = 'CanHaveBody
566 httpMethodName Proxy = Y.methodPut
926 httpMethodName Proxy = Y.methodPut
568−-- | 'DELETE' method. This data type does not allow having request body with
928+-- | 'DELETE' method. RFC 7231 allows a payload in DELETE but without
569−-- 'DELETE' requests, as it should be, however some APIs may expect 'DELETE'
929+-- semantics.
570−-- requests to have bodies, in that case define your own variation of
930+--
571−-- 'DELETE' method and allow it to have a body.
931+-- __Note__: before version /3.4.0/ this method did not allow request
573data DELETE = DELETE
933data DELETE = DELETE
575instance HttpMethod DELETE where
935instance HttpMethod DELETE where
576− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
577 httpMethodName Proxy = Y.methodDelete
937 httpMethodName Proxy = Y.methodDelete
579-- | 'TRACE' method.
939-- | 'TRACE' method.
581data TRACE = TRACE
940data TRACE = TRACE
583instance HttpMethod TRACE where
942instance HttpMethod TRACE where
@@ -585,7 +944,6 @@ instance HttpMethod TRACE where
585 httpMethodName Proxy = Y.methodTrace
944 httpMethodName Proxy = Y.methodTrace
587-- | 'CONNECT' method.
946-- | 'CONNECT' method.
589data CONNECT = CONNECT
947data CONNECT = CONNECT
591instance HttpMethod CONNECT where
949instance HttpMethod CONNECT where
@@ -593,7 +951,6 @@ instance HttpMethod CONNECT where
593 httpMethodName Proxy = Y.methodConnect
951 httpMethodName Proxy = Y.methodConnect
595-- | 'OPTIONS' method.
953-- | 'OPTIONS' method.
597data OPTIONS = OPTIONS
954data OPTIONS = OPTIONS
599instance HttpMethod OPTIONS where
956instance HttpMethod OPTIONS where
@@ -601,7 +958,6 @@ instance HttpMethod OPTIONS where
601 httpMethodName Proxy = Y.methodOptions
958 httpMethodName Proxy = Y.methodOptions
603-- | 'PATCH' method.
960-- | 'PATCH' method.
605data PATCH = PATCH
961data PATCH = PATCH
607instance HttpMethod PATCH where
963instance HttpMethod PATCH where
@@ -609,42 +965,38 @@ instance HttpMethod PATCH where
609 httpMethodName Proxy = Y.methodPatch
965 httpMethodName Proxy = Y.methodPatch
611-- | 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
612−-- non-standard method, follow this example that defines COPY:
968+-- non-standard method, follow this example that defines @COPY@:
614-- > data COPY = COPY
970-- > data COPY = COPY
616-- > instance HttpMethod COPY where
972-- > instance HttpMethod COPY where
617-- > type AllowsBody COPY = 'CanHaveBody
973-- > type AllowsBody COPY = 'CanHaveBody
618-- > httpMethodName Proxy = "COPY"
974-- > httpMethodName Proxy = "COPY"
620class HttpMethod a where
975class HttpMethod a where
622− -- | Type function 'AllowsBody' returns type of kind 'CanHaveBody' which
976+ -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
623− -- 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.
624− -- not. We use the special type 'CanHaveBody' “lifted” into kind instead
978+ -- We use the special type 'CanHaveBody' lifted to the kind level instead
625 -- of 'Bool' to get more user-friendly compiler messages.
979 -- of 'Bool' to get more user-friendly compiler messages.
627 type AllowsBody a :: CanHaveBody
980 type AllowsBody a :: CanHaveBody
629 -- | Return name of the method as a 'ByteString'.
982 -- | Return name of the method as a 'ByteString'.
631 httpMethodName :: Proxy a -> ByteString
983 httpMethodName :: Proxy a -> ByteString
633−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
634 getRequestMod _ = Endo $ \x ->
986 getRequestMod _ = Endo $ \x ->
635− x { L.method = httpMethodName (Proxy :: Proxy method) }
987+ x {L.method = httpMethodName (Proxy :: Proxy method)}
637----------------------------------------------------------------------------
989----------------------------------------------------------------------------
638−-- Request — URL
990+-- Request—URL
642-- 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
643−-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
995+-- 'Url' from a 'URI', use 'useHttpURI', 'useHttpsURI', or generic 'useURI'.
645-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
646-- 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 @('/~')@
647−-- 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
648-- piece of path will be url(percent)-encoded, so using @('/~')@ and
1000-- piece of path will be url(percent)-encoded, so using @('/~')@ and
649-- @('/:')@ is the only way to have forward slashes between path segments.
1001-- @('/:')@ is the only way to have forward slashes between path segments.
650-- 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
@@ -670,125 +1022,233 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
671-- > https "юникод.рф"
1023-- > https "юникод.рф"
672-- > -- 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
674−data Url (scheme :: Scheme) = Url Scheme (NonEmpty T.Text)
1025+data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
675− -- NOTE The second value is path segments in reversed order.
1026+ -- NOTE The second value is the path segments in reversed order.
676− 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
678−-- | 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
679-- empty path. This also sets port to @80@.
1043-- empty path. This also sets port to @80@.
681−http :: T.Text -> Url 'Http
1044+http :: Text -> Url 'Http
682http = Url Http . pure
1045http = Url Http . pure
684−-- | 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
685-- empty path. This also sets port to @443@.
1048-- empty path. This also sets port to @443@.
687−https :: T.Text -> Url 'Https
1049+https :: Text -> Url 'Https
688https = Url Https . pure
1050https = Url Https . pure
690−-- | 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
691-- 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'.
693infixl 5 /~
1054infixl 5 /~
694−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
695−Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
697−-- | Type-constrained version of @('/~')@ to remove ambiguity in cases when
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
698−-- 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.
700infixl 5 /:
1061infixl 5 /:
701−(/:) :: Url scheme -> T.Text -> Url scheme
1063+(/:) :: Url scheme -> Text -> Url scheme
702(/:) = (/~)
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)
704−-- | The 'parseUrlHttp' function provides an alternative method to get 'Url'
1079+-- | The 'useHttpURI' function provides an alternative method to get 'Url'
705−-- (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
706−-- 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.
707−-- The function parses 'ByteString' because it's the correct type to
1082+--
708−-- 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.
709−-- range, thus we can consider every character a 'Data.Word.Word8' value.
1084+--
710−--
1085+-- @since 3.0.0
711−-- This function only parses 'Url' (scheme, host, path) and optional query
1086+useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
712−-- parameters that are returned as 'Option'. It does not parse method name
1087+useHttpURI uri = do
713−-- or authentication info from given 'ByteString'.
1088+ guard (URI.uriScheme uri == Just [QQ.scheme|http|])
714−
1089+ urlHead <- http <$> uriHost uri
715−parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
1090+ let url = case URI.uriPath uri of
716−parseUrlHttp url' = do
1091+ Nothing -> urlHead
717− url <- B.stripPrefix "http://" url'
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
718− (host :| path, option) <- parseUrlHelper url
1093+ return (url, uriOptions uri)
719− return (foldl (/:) (http host) path, option)
1094+
721−-- | Just like 'parseUrlHttp', but expects “https” scheme.
1095+-- | Just like 'useHttpURI', but expects the “https” scheme.
723−parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
1098+useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
724−parseUrlHttps url' = do
1099+useHttpsURI uri = do
725− url <- B.stripPrefix "https://" url'
1100+ guard (URI.uriScheme uri == Just [QQ.scheme|https|])
726− (host :| path, option) <- parseUrlHelper url
1101+ urlHead <- https <$> uriHost uri
727− return (foldl (/:) (https host) path, option)
1102+ let url = case URI.uriPath uri of
728−
1103+ Nothing -> urlHead
729−-- | Get host\/collection of path pieces and possibly query parameters
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
730−-- already converted to 'Option'. This function is not public.
1105+ return (url, uriOptions uri)
732−parseUrlHelper :: ByteString -> Maybe (NonEmpty T.Text, Option scheme)
1107+-- | Convert URI path to a 'Url'. Internal.
733−parseUrlHelper url = do
1108+--
734− let (path', query') = B.break (== 0x3f) url
1109+-- @since 3.9.0
735− query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
1110+uriPathToUrl ::
736− path <- NE.nonEmpty (Y.decodePathSegments path')
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
737− 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'')
739instance RequestComponent (Url scheme) where
1199instance RequestComponent (Url scheme) where
740 getRequestMod (Url scheme segments) = Endo $ \x ->
1200 getRequestMod (Url scheme segments) = Endo $ \x ->
741− let (host :| path) = NE.reverse segments in
1201+ let (host :| path) = NE.reverse segments
742− x { L.secure = case scheme of
1203+ { L.secure = case scheme of
743− Http -> False
1204+ Http -> False
744− Https -> True
1205+ Https -> True,
745− , L.port = case scheme of
1206+ L.port = case scheme of
746− Http -> 80
1207+ Http -> 80
747− Https -> 443
1208+ Https -> 443,
748− , L.host = Y.urlEncode False (T.encodeUtf8 host)
1209+ L.host = Y.urlEncode False (T.encodeUtf8 host),
749− , L.path =
1210+ L.path =
750− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1211+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
752----------------------------------------------------------------------------
1214----------------------------------------------------------------------------
753−-- Request — Body
1215+-- Request—Body
757-- 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@
758−-- 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
759−-- (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
760−-- your own way to represent request body, see 'HttpBody'.
1222+-- add your own way to represent request body, define an instance of
762-- | 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
763-- 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
764-- only type for which 'ProvidesBody' returns 'NoBody'.
1227-- only type for which 'ProvidesBody' returns 'NoBody'.
766-- 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.
768data NoReqBody = NoReqBody
1230data NoReqBody = NoReqBody
770instance HttpBody NoReqBody where
1232instance HttpBody NoReqBody where
771 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
773−-- | 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
774−-- 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
775−-- 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
776−-- JSON and inserted as request body.
1238+-- converted to JSON and inserted as request body.
778-- This body option sets the @Content-Type@ header to @\"application/json;
1240-- This body option sets the @Content-Type@ header to @\"application/json;
779-- charset=utf-8\"@ value.
1241-- charset=utf-8\"@ value.
781newtype ReqBodyJson a = ReqBodyJson a
1242newtype ReqBodyJson a = ReqBodyJson a
783−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
784 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
785− getRequestContentType Proxy = pure "application/json; charset=utf-8"
1246+ getRequestContentType _ = pure "application/json; charset=utf-8"
787-- | 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
788−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
790-- 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.
792newtype ReqBodyFile = ReqBodyFile FilePath
1252newtype ReqBodyFile = ReqBodyFile FilePath
794instance HttpBody ReqBodyFile where
1254instance HttpBody ReqBodyFile where
@@ -798,7 +1258,6 @@ instance HttpBody ReqBodyFile where
798-- | HTTP request body represented by a strict 'ByteString'.
1258-- | HTTP request body represented by a strict 'ByteString'.
800-- 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.
802newtype ReqBodyBs = ReqBodyBs ByteString
1261newtype ReqBodyBs = ReqBodyBs ByteString
804instance HttpBody ReqBodyBs where
1263instance HttpBody ReqBodyBs where
@@ -807,270 +1266,387 @@ instance HttpBody ReqBodyBs where
807-- | HTTP request body represented by a lazy 'BL.ByteString'.
1266-- | HTTP request body represented by a lazy 'BL.ByteString'.
809-- 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.
811newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
813instance HttpBody ReqBodyLbs where
1271instance HttpBody ReqBodyLbs where
814 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
816−-- | 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
817−-- 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
818−-- 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
819−-- 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
820−-- combinators you would use to add query parameters: @('=:')@ and
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
823-- This body option sets the @Content-Type@ header to
1280-- This body option sets the @Content-Type@ header to
824−-- @\"application/x-www-from-urlencoded\"@ value.
1281+-- @\"application/x-www-form-urlencoded\"@ value.
826newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
1282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
828instance HttpBody ReqBodyUrlEnc where
1284instance HttpBody ReqBodyUrlEnc where
829 getRequestBody (ReqBodyUrlEnc (FormUrlEncodedParam params)) =
1285 getRequestBody (ReqBodyUrlEnc (FormUrlEncodedParam params)) =
830 (L.RequestBodyLBS . BB.toLazyByteString) (Y.renderQueryText False params)
1286 (L.RequestBodyLBS . BB.toLazyByteString) (Y.renderQueryText False params)
831− getRequestContentType Proxy = pure "application/x-www-form-urlencoded"
1287+ getRequestContentType _ = pure "application/x-www-form-urlencoded"
833-- | An opaque monoidal value that allows to collect URL-encoded parameters
1289-- | An opaque monoidal value that allows to collect URL-encoded parameters
834-- to be wrapped in 'ReqBodyUrlEnc'.
1290-- to be wrapped in 'ReqBodyUrlEnc'.
836−newtype FormUrlEncodedParam = FormUrlEncodedParam [(T.Text, Maybe T.Text)]
1291+newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
837 deriving (Semigroup, Monoid)
1292 deriving (Semigroup, Monoid)
839instance QueryParam FormUrlEncodedParam where
1294instance QueryParam FormUrlEncodedParam where
840 queryParam name mvalue =
1295 queryParam name mvalue =
841 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
843−-- | A type class for things that can be interpreted as HTTP
1299+-- | Use 'formToQuery'.
844−-- '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
846class HttpBody body where
1351class HttpBody body where
848− {-# MINIMAL getRequestBody #-}
850 -- | How to get actual 'L.RequestBody'.
1352 -- | How to get actual 'L.RequestBody'.
852 getRequestBody :: body -> L.RequestBody
1353 getRequestBody :: body -> L.RequestBody
854− -- | This method allows to optionally specify value of @Content-Type@
1355+ -- | This method allows us to optionally specify the value of
855− -- header that should be used with particular body option. By default it
1356+ -- @Content-Type@ header that should be used with particular body option.
856− -- returns 'Nothing' and so @Content-Type@ is not set.
1357+ -- By default it returns 'Nothing' and so @Content-Type@ is not set.
858− getRequestContentType :: Proxy body -> Maybe ByteString
1358+ getRequestContentType :: body -> Maybe ByteString
859− getRequestContentType Proxy = Nothing
1359+ getRequestContentType = const Nothing
861-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
862−-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
1362+-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
863−-- 'GET' method and other methods that should not send a body.
1363+-- with 'GET' method and other methods that should not have body.
865type family ProvidesBody body :: CanHaveBody where
1364type family ProvidesBody body :: CanHaveBody where
866 ProvidesBody NoReqBody = 'NoBody
1365 ProvidesBody NoReqBody = 'NoBody
867− ProvidesBody body = 'CanHaveBody
1366+ ProvidesBody body = 'CanHaveBody
869-- | This type function allows any HTTP body if method says it
1368-- | This type function allows any HTTP body if method says it
870−-- 'CanHaveBody'. When method says it should have 'NoBody', the only body
1369+-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
871−-- option to use is 'NoReqBody'.
1370+-- body option to use is 'NoReqBody'.
873−-- __Note__: users of GHC 8.0.1 will see slightly more friendly error
874−-- messages when method does not allow a body and body is provided.
876−type family HttpBodyAllowed
1371+type family
877− (allowsBody :: CanHaveBody)
1373+ (allowsBody :: CanHaveBody)
878− (providesBody :: CanHaveBody) :: Constraint where
1374+ (providesBody :: CanHaveBody) ::
879− HttpBodyAllowed 'NoBody 'NoBody = ()
1377+ HttpBodyAllowed 'NoBody 'NoBody = ()
880− HttpBodyAllowed 'CanHaveBody body = ()
1378+ HttpBodyAllowed 'CanHaveBody body = ()
881−#if MIN_VERSION_base(4,9,0)
882− HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1379+ HttpBodyAllowed 'NoBody 'CanHaveBody =
883− ('Text "This HTTP method does not allow attaching a request body.")
1381+ ('Text "This HTTP method does not allow attaching a request body.")
886−instance HttpBody body => RequestComponent (Womb "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
887− getRequestMod (Womb body) = Endo $ \x ->
1384+ getRequestMod (Tagged body) = Endo $ \x ->
888− x { L.requestBody = getRequestBody body
1386+ { L.requestBody = getRequestBody body,
889− , L.requestHeaders =
1387+ L.requestHeaders =
890− let old = L.requestHeaders x in
1388+ let old = L.requestHeaders x
891− case getRequestContentType (Proxy :: Proxy body) of
1389+ in case getRequestContentType body of
892− Nothing -> old
1390+ Nothing -> old
893− Just contentType ->
1391+ Just contentType ->
894− (Y.hContentType, contentType) : old }
1392+ (Y.hContentType, contentType) : old
896----------------------------------------------------------------------------
1395----------------------------------------------------------------------------
897−-- Request — Optional parameters
1396+-- Request—Optional parameters
899-- $optional-parameters
1398-- $optional-parameters
901−-- Optional parameters to a request include things like query parameters,
1400+-- Optional parameters of request include things like query parameters,
902-- headers, port number, etc. All optional parameters have the type
1401-- headers, port number, etc. All optional parameters have the type
903-- '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
904-- 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
905−-- '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.
907−-- | 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
908−-- optional parameters like query parameters and headers. See sections below
1407+-- of optional parameters like query parameters and headers. See sections
909−-- 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))
911−data Option (scheme :: Scheme) =
912− Option (Endo (Y.QueryText, L.Request)) (Maybe (Endo L.Request))
913− -- 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
914− -- Request to avoid appending to existing query string in request every
1413+-- Request to avoid appending to an existing query string in request every
915− -- time new parameter is added. Additional Maybe (Endo Request) is a
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
916− -- 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
917− -- 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.
919instance Semigroup (Option scheme) where
1419instance Semigroup (Option scheme) where
920− Option er0 mr0 <> Option er1 mr1 = Option
1420+ Option er0 mr0 <> Option er1 mr1 =
921− (er0 <> er1) (mr0 <|> mr1)
1422+ (er0 <> er1)
923instance Monoid (Option scheme) where
1425instance Monoid (Option scheme) where
924− mempty = Option mempty Nothing
1426+ mempty = Option mempty Nothing
925 mappend = (<>)
1427 mappend = (<>)
927−-- | A helper to create an 'Option' that modifies only collection of query
1429+-- | Use 'formToQuery'.
928−-- 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.
930withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
931withQueryParams f = Option (Endo (first f)) Nothing
1438withQueryParams f = Option (Endo (first f)) Nothing
933-- | 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
934-- helper is not a part of public API.
1441-- helper is not a part of public API.
936withRequest :: (L.Request -> L.Request) -> Option scheme
1442withRequest :: (L.Request -> L.Request) -> Option scheme
937withRequest f = Option (Endo (second f)) Nothing
1443withRequest f = Option (Endo (second f)) Nothing
939−-- | A helper to create an 'Option' that adds a finalizer (request
940−-- endomorphism that is run after all other modifications).
942−asFinalizer :: (L.Request -> L.Request) -> Option scheme
943−asFinalizer f = Option mempty (Just (Endo f))
945instance RequestComponent (Option scheme) where
1445instance RequestComponent (Option scheme) where
946− getRequestMod (Option f finalizer) = Endo $ \x ->
1446+ getRequestMod (Option f _) = Endo $ \x ->
947 let (qparams, x') = appEndo f ([], x)
1447 let (qparams, x') = appEndo f ([], x)
948− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1448+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
949− 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
951----------------------------------------------------------------------------
1456----------------------------------------------------------------------------
952−-- Request — Optional parameters — Query Parameters
1457+-- Request—Optional parameters—Query Parameters
954-- $query-parameters
1459-- $query-parameters
956-- This section describes a polymorphic interface that can be used to
1461-- This section describes a polymorphic interface that can be used to
957−-- construct query parameters (of type 'Option') and form URL-encoded bodies
1462+-- construct query parameters (of the type 'Option') and form URL-encoded
958−-- (of type 'FormUrlEncodedParam').
1463+-- bodies (of the type 'FormUrlEncodedParam').
960-- | 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
961−-- 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
962-- with form URL encoded request bodies.
1467-- with form URL encoded request bodies.
964-- This operator is defined in terms of 'queryParam':
1469-- This operator is defined in terms of 'queryParam':
966-- > name =: value = queryParam name (pure value)
1471-- > name =: value = queryParam name (pure value)
968infix 7 =:
1472infix 7 =:
969−(=:) :: (QueryParam param, ToHttpApiData a) => T.Text -> a -> param
1474+(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
970name =: value = queryParam name (pure value)
1475name =: value = queryParam name (pure value)
972−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
973−-- 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
975-- > https://httpbin.org/foo/bar?a&b=10
1481-- > https://httpbin.org/foo/bar?a&b=10
977-- This operator is defined in terms of 'queryParam':
1483-- This operator is defined in terms of 'queryParam':
979−-- > queryFlag name = queryParam name Nothing
1485+-- > queryFlag name = queryParam name (Nothing :: Maybe ())
981−queryFlag :: QueryParam param => T.Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
982queryFlag 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) =
984−-- | 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
985-- 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
986-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
987-- 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.
989class QueryParam param where
1511class QueryParam param where
991 -- | 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
992 -- '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
993 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
994 -- method, because they are easier to read.
1515 -- method, because they are easier to read.
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
996− 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)]
998instance QueryParam (Option scheme) where
1523instance QueryParam (Option scheme) where
999 queryParam name mvalue =
1524 queryParam name mvalue =
1000 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
1002----------------------------------------------------------------------------
1528----------------------------------------------------------------------------
1003−-- Request — Optional parameters — Headers
1529+-- Request—Optional parameters—Headers
1005-- | 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
1006-- 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
1007-- 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
1008-- same name.
1534-- same name.
1010−header
1535+header ::
1011− :: ByteString -- ^ Header name
1536+ -- | Header name
1012− -> ByteString -- ^ Header value
1538+ -- | Header value
1013− -> Option scheme
1540+ Option scheme
1014header name value = withRequest (attachHeader name value)
1541header name value = withRequest (attachHeader name value)
1016−-- | 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'.
1017−-- to a 'L.Request'.
1544+--
1018−
1545+-- @since 1.1.0
1019attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1020attachHeader name value x =
1547attachHeader name value x =
1021− 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}
1023----------------------------------------------------------------------------
1558----------------------------------------------------------------------------
1024−-- Request — Optional parameters — Cookies
1559+-- Request—Optional parameters—Cookies
1026-- $cookies
1561-- $cookies
1028−-- 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
1029-- specify which cookies to send using 'cookieJar' and inspect 'L.Response'
1564-- specify which cookies to send using 'cookieJar' and inspect 'L.Response'
1030-- to extract 'L.CookieJar' from it (see 'responseCookieJar').
1565-- to extract 'L.CookieJar' from it (see 'responseCookieJar').
1032-- | 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
1033-- 'L.Response' record.
1568-- 'L.Response' record.
1035cookieJar :: L.CookieJar -> Option scheme
1569cookieJar :: L.CookieJar -> Option scheme
1036cookieJar jar = withRequest $ \x ->
1570cookieJar jar = withRequest $ \x ->
1037− x { L.cookieJar = Just jar }
1571+ x {L.cookieJar = Just jar}
1039----------------------------------------------------------------------------
1573----------------------------------------------------------------------------
1040−-- Request — Optional parameters — Authentication
1574+-- Request—Optional parameters—Authentication
1042-- $authentication
1576-- $authentication
1044−-- This section provides common authentication helpers in form of 'Option's.
1578+-- This section provides the common authentication helpers in the form of
1045−-- You should always prefer the provided authentication 'Option's to manual
1579+-- 'Option's. You should always prefer the provided authentication 'Option's
1046−-- construction of headers because it ensures that you only use one
1580+-- to manual construction of headers because it ensures that you only use
1047−-- authentication method at a time (they overwrite each other) and provides
1581+-- one authentication method at a time (they overwrite each other) and
1048−-- additional type safety that prevents leaking of credentials in cases when
1582+-- provides additional type safety that prevents leaking of credentials in
1049−-- authentication relies on TLS for encrypting sensitive data.
1583+-- the cases when authentication relies on HTTPS for encrypting sensitive
1051-- | The 'Option' adds basic authentication.
1586-- | The 'Option' adds basic authentication.
1053-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1055−basicAuth
1589+basicAuth ::
1056− :: ByteString -- ^ Username
1590+ -- | Username
1057− -> ByteString -- ^ Password
1592+ -- | Password
1058− -> 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.
1059−basicAuth username password = asFinalizer
1610+basicAuthUnsafe username password =
1060− (L.applyBasicAuth username password)
1612+ (pure . L.applyBasicAuth username password)
1062−-- | OAuth 1 authentication 'Option'.
1614+-- | The 'Option' set basic proxy authentication header.
1064−-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1616+-- @since 1.1.0
1065−
1617+basicProxyAuth ::
1066−oAuth1
1618+ -- | Username
1067− :: ByteString -- ^ Consumer token
1068− -> ByteString -- ^ Consumer secret
1619+ ByteString ->
1069− -> ByteString -- ^ OAuth token
1620+ -- | Password
1070− -> ByteString -- ^ OAuth token secret
1621+ ByteString ->
1071− -> Option scheme
1623+ Option scheme
1072−oAuth1 ctoken csecret otoken osecret = asFinalizer
1624+basicProxyAuth username password =
1073− (OAuth1.signRequest ctoken csecret otoken osecret)
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
1075-- | 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
1076-- services as the equivalent of a username and password.
1652-- services as the equivalent of a username and password.
@@ -1080,12 +1656,14 @@ oAuth1 ctoken csecret otoken osecret = asFinalizer
1080-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1082-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1084−oAuth2Bearer
1659+oAuth2Bearer ::
1085− :: ByteString -- ^ Token
1660+ -- | Token
1086− -> Option 'Https -- ^ Auth 'Option'
1662+ -- | Auth 'Option'
1087−oAuth2Bearer token = asFinalizer
1664+oAuth2Bearer token =
1088− (attachHeader "Authorization" ("Bearer " <> token))
1666+ (pure . attachHeader "Authorization" ("Bearer " <> token))
1090-- | 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
1091-- 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
@@ -1096,37 +1674,35 @@ oAuth2Bearer token = asFinalizer
1096-- > oAuth2Token token = header "Authorization" ("token" <> token)
1674-- > oAuth2Token token = header "Authorization" ("token" <> token)
1098-- 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>.
1100−oAuth2Token
1677+oAuth2Token ::
1101− :: ByteString -- ^ Token
1678+ -- | Token
1102− -> Option 'Https -- ^ Auth 'Option'
1680+ -- | Auth 'Option'
1103−oAuth2Token token = asFinalizer
1682+oAuth2Token token =
1104− (attachHeader "Authorization" ("token " <> token))
1684+ (pure . attachHeader "Authorization" ("token " <> token))
1106−-- | The 'Option' adds AWS v4 request signature.
1686+-- | A helper to create custom authentication 'Option's. The given
1107−--
1687+-- 'IO'-enabled request transformation is applied after all other
1108−-- See also: <https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html>.
1688+-- modifications when constructing a request. Use wisely.
1110−awsAuth
1690+-- @since 1.1.0
1111− :: ByteString -- ^ AWS access key
1691+customAuth :: (L.Request -> IO L.Request) -> Option scheme
1112− -> ByteString -- ^ AWS secret access key
1692+customAuth = Option mempty . pure
1113− -> Option 'Https -- ^ Auth 'Option'
1114−awsAuth accessKey secretKey = asFinalizer
1115− (AWS.signRequest accessKey secretKey)
1117----------------------------------------------------------------------------
1694----------------------------------------------------------------------------
1118−-- Request — Optional parameters — Other
1695+-- Request—Optional parameters—Other
1120-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1121−-- 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
1122−-- allows to choose arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1124port :: Int -> Option scheme
1700port :: Int -> Option scheme
1125port n = withRequest $ \x ->
1701port n = withRequest $ \x ->
1126− x { L.port = n }
1702+ x {L.port = n}
1128-- | This 'Option' controls whether gzipped data should be decompressed on
1704-- | This 'Option' controls whether gzipped data should be decompressed on
1129−-- the fly. By default everything except for @application\/x-tar@ is
1705+-- the fly. By default everything except for @\"application\/x-tar\"@ is
1130-- decompressed, i.e. we have:
1706-- decompressed, i.e. we have:
1132-- > decompress (/= "application/x-tar")
1708-- > decompress (/= "application/x-tar")
@@ -1134,262 +1710,342 @@ port n = withRequest $ \x ->
1134-- You can also choose to decompress everything like this:
1710-- You can also choose to decompress everything like this:
1136-- > decompress (const True)
1712-- > decompress (const True)
1138−decompress
1713+decompress ::
1139− :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1140− -- returns 'True' when content should be decompressed on the fly.
1715+ -- should be decompressed on the fly.
1716+ (ByteString -> Bool) ->
1141− -> Option scheme
1717+ Option scheme
1142decompress f = withRequest $ \x ->
1718decompress f = withRequest $ \x ->
1143− x { L.decompress = f }
1719+ x {L.decompress = f}
1145−-- | Specify number of microseconds to wait for response. Default is 30
1721+-- | Specify the number of microseconds to wait for response. The default
1146−-- seconds.
1722+-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
1147−
1723+-- 'L.Manager').
1148−responseTimeout
1724+responseTimeout ::
1149− :: Int -- ^ Number of microseconds to wait
1725+ -- | Number of microseconds to wait
1150− -> Option scheme
1727+ Option scheme
1151responseTimeout n = withRequest $ \x ->
1728responseTimeout n = withRequest $ \x ->
1152− x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1729+ x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1154−-- | 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.
1156−httpVersion
1732+httpVersion ::
1157− :: Int -- ^ Major version number
1733+ -- | Major version number
1158− -> Int -- ^ Minor version number
1735+ -- | Minor version number
1159− -> Option scheme
1737+ Option scheme
1160httpVersion major minor = withRequest $ \x ->
1738httpVersion major minor = withRequest $ \x ->
1161− x { L.requestVersion = Y.HttpVersion major minor }
1739+ x {L.requestVersion = Y.HttpVersion major minor}
1163----------------------------------------------------------------------------
1741----------------------------------------------------------------------------
1164-- Response interpretations
1742-- Response interpretations
1166−-- | Make a request and ignore body of response.
1744+-- | Make a request and ignore the body of the response.
1168−data IgnoreResponse = IgnoreResponse (L.Response ())
1745+newtype IgnoreResponse = IgnoreResponse (L.Response ())
1170instance HttpResponse IgnoreResponse where
1748instance HttpResponse IgnoreResponse where
1171 type HttpResponseBody IgnoreResponse = ()
1749 type HttpResponseBody IgnoreResponse = ()
1172− toVanillaResponse (IgnoreResponse response) = response
1750+ toVanillaResponse (IgnoreResponse r) = r
1173− getHttpResponse request manager =
1751+ getHttpResponse r = return $ IgnoreResponse (void r)
1174− IgnoreResponse <$> liftIO (L.httpNoBody request manager)
1176-- | 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
1177−-- return the 'IgnoreResponse' interpretation.
1754+-- ignore the response body.
1179ignoreResponse :: Proxy IgnoreResponse
1755ignoreResponse :: Proxy IgnoreResponse
1180ignoreResponse = Proxy
1756ignoreResponse = Proxy
1182−-- | 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
1183-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1184-- 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
1185−-- parsing fails ('JsonHttpException' constructor will be used).
1761+-- parsing fails (the 'JsonHttpException' constructor will be used).
1187newtype JsonResponse a = JsonResponse (L.Response a)
1762newtype JsonResponse a = JsonResponse (L.Response a)
1189−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
1190 type HttpResponseBody (JsonResponse a) = a
1766 type HttpResponseBody (JsonResponse a) = a
1191− toVanillaResponse (JsonResponse response) = response
1767+ toVanillaResponse (JsonResponse r) = r
1192− getHttpResponse request manager = do
1768+ getHttpResponse r = do
1193− response <- L.httpLbs request manager
1769+ chunks <- L.brConsume (L.responseBody r)
1194− case A.eitherDecode (L.responseBody response) of
1770+ case A.eitherDecode (BL.fromChunks chunks) of
1195 Left e -> throwIO (JsonHttpException e)
1771 Left e -> throwIO (JsonHttpException e)
1196− Right x -> return $ JsonResponse response { L.responseBody = x }
1772+ Right x -> return $ JsonResponse (x <$ r)
1773+ acceptHeader Proxy = Just "application/json"
1198−-- | 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
1199-- return the 'JsonResponse' interpretation.
1776-- return the 'JsonResponse' interpretation.
1201jsonResponse :: Proxy (JsonResponse a)
1777jsonResponse :: Proxy (JsonResponse a)
1202jsonResponse = Proxy
1778jsonResponse = Proxy
1204−-- | 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
1205−
1781+-- 'ByteString'.
1206newtype BsResponse = BsResponse (L.Response ByteString)
1782newtype BsResponse = BsResponse (L.Response ByteString)
1208instance HttpResponse BsResponse where
1785instance HttpResponse BsResponse where
1209 type HttpResponseBody BsResponse = ByteString
1786 type HttpResponseBody BsResponse = ByteString
1210− toVanillaResponse (BsResponse response) = response
1787+ toVanillaResponse (BsResponse r) = r
1211− getHttpResponse request manager =
1788+ getHttpResponse r = do
1212− L.withResponse request manager $ \response -> do
1213− chunks <- L.brConsume (L.responseBody response)
1789+ chunks <- L.brConsume (L.responseBody r)
1214− return $ BsResponse response { L.responseBody = B.concat chunks }
1790+ return $ BsResponse (B.concat chunks <$ r)
1216−-- | Use this as the forth argument of 'req' to specify that you want to
1217−-- 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'.
1219bsResponse :: Proxy BsResponse
1794bsResponse :: Proxy BsResponse
1220bsResponse = Proxy
1795bsResponse = Proxy
1222−-- | 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
1223-- 'BL.ByteString'.
1798-- 'BL.ByteString'.
1225newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1227instance HttpResponse LbsResponse where
1802instance HttpResponse LbsResponse where
1228 type HttpResponseBody LbsResponse = BL.ByteString
1803 type HttpResponseBody LbsResponse = BL.ByteString
1229− toVanillaResponse (LbsResponse response) = response
1804+ toVanillaResponse (LbsResponse r) = r
1230− getHttpResponse request manager =
1805+ getHttpResponse r = do
1231− LbsResponse <$> L.httpLbs request manager
1806+ chunks <- L.brConsume (L.responseBody r)
1232−
1807+ return $ LbsResponse (BL.fromChunks chunks <$ r)
1233−-- | Use this as the forth argument of 'req' to specify that you want to
1234−-- 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'.
1236lbsResponse :: Proxy LbsResponse
1811lbsResponse :: Proxy LbsResponse
1237lbsResponse = Proxy
1812lbsResponse = Proxy
1239−-- | This interpretation does not result in any call at all, but you can use
1814+----------------------------------------------------------------------------
1240−-- the 'responseRequest' function to extract 'L.Request' that 'req' has
1815+-- Helpers for response interpretations
1241−-- prepared. This is useful primarily for testing.
1816+
1242−--
1817+-- | Fetch beginning of the response and return it together with a new
1243−-- Note that when you use this interpretation inspecting response will
1818+-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
1244−-- diverge (i.e. it'll blow up with an error, don't do that).
1819+-- such.
1246−newtype ReturnRequest = ReturnRequest L.Request
1821+ -- | How many bytes to fetch
1248−instance HttpResponse ReturnRequest where
1823+ -- | Response with body reader inside
1249− type HttpResponseBody ReturnRequest = ()
1824+ L.Response L.BodyReader ->
1250− toVanillaResponse (ReturnRequest _) = error
1825+ -- | Preview 'ByteString' and new response with body reader inside
1251− "Network.HTTP.Req.ReturnRequest interpretation does not make requests"
1826+ IO (ByteString, L.Response L.BodyReader)
1252− getHttpResponse request _ = return (ReturnRequest request)
1827+grabPreview nbytes r = do
1253−
1828+ let br = L.responseBody r
1254−-- | Use this as the forth argument of 'req' to specify that you want it to
1829+ (target, leftover, done) <- brReadN br nbytes
1255−-- just return the request it consturcted without making any requests.
1830+ nref <- newIORef (0 :: Int)
1257−returnRequest :: Proxy ReturnRequest
1832+ n <- readIORef nref
1258−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 [])
1260----------------------------------------------------------------------------
1876----------------------------------------------------------------------------
1261-- Inspecting a response
1877-- Inspecting a response
1263−-- | Get response body.
1879+-- | Get the response body.
1265−responseBody
1880+responseBody ::
1266− :: HttpResponse response
1881+ (HttpResponse response) =>
1267− => response
1882+ response ->
1268− -> HttpResponseBody response
1883+ HttpResponseBody response
1269responseBody = L.responseBody . toVanillaResponse
1884responseBody = L.responseBody . toVanillaResponse
1271−-- | Get response status code.
1886+-- | Get the response status code.
1273−responseStatusCode
1887+responseStatusCode ::
1274− :: HttpResponse response
1888+ (HttpResponse response) =>
1275− => response
1889+ response ->
1277responseStatusCode =
1891responseStatusCode =
1278 Y.statusCode . L.responseStatus . toVanillaResponse
1892 Y.statusCode . L.responseStatus . toVanillaResponse
1280−-- | Get response status message.
1894+-- | Get the response status message.
1282−responseStatusMessage
1895+responseStatusMessage ::
1283− :: HttpResponse response
1896+ (HttpResponse response) =>
1284− => response
1897+ response ->
1285− -> ByteString
1898+ ByteString
1286responseStatusMessage =
1899responseStatusMessage =
1287 Y.statusMessage . L.responseStatus . toVanillaResponse
1900 Y.statusMessage . L.responseStatus . toVanillaResponse
1289−-- | Look a particular header from a response.
1902+-- | Lookup a particular header from a response.
1291−responseHeader
1903+responseHeader ::
1292− :: HttpResponse response
1904+ (HttpResponse response) =>
1293− => response -- ^ Response interpretation
1905+ -- | Response interpretation
1294− -> ByteString -- ^ Header to lookup
1907+ -- | Header to lookup
1295− -> Maybe ByteString -- ^ Header value if found
1909+ -- | Header value if found
1296responseHeader r h =
1911responseHeader r h =
1297 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1299−-- | Get response 'L.CookieJar'.
1914+-- | Get the response 'L.CookieJar'.
1301−responseCookieJar
1915+responseCookieJar ::
1302− :: HttpResponse response
1916+ (HttpResponse response) =>
1303− => response
1917+ response ->
1304− -> L.CookieJar
1918+ L.CookieJar
1305responseCookieJar = L.responseCookieJar . toVanillaResponse
1919responseCookieJar = L.responseCookieJar . toVanillaResponse
1307−-- | Get the original request from 'ReturnRequest' response interpretation.
1309−responseRequest :: ReturnRequest -> L.Request
1310−responseRequest (ReturnRequest request) = request
1312----------------------------------------------------------------------------
1921----------------------------------------------------------------------------
1313−-- Response — defining your own interpretation
1922+-- Response—Defining your own interpretation
1315-- $new-response-interpretation
1924-- $new-response-interpretation
1317-- 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
1318−-- type an instance of 'HttpResponse' type class.
1927+-- type an instance of the 'HttpResponse' type class.
1320−-- | A type class for response interpretations. It allows to fully control
1321−-- 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.
1323class HttpResponse response where
1932class HttpResponse response where
1325− -- | 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
1326 -- instance of 'HttpResponse'.
1934 -- instance of 'HttpResponse'.
1935+ type HttpResponseBody response :: Type
1328− type HttpResponseBody response :: *
1330− -- | The method describes how to get underlying 'L.Response' record.
1937+ -- | The method describes how to get the underlying 'L.Response' record.
1332 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1334− -- | This method describes how to make an HTTP request given 'L.Request'
1940+ -- | This method describes how to consume response body and, more
1335− -- (prepared by the rest of the library) and 'L.Manager'.
1941+ -- generally, obtain @response@ value from @'L.Response' 'L.BodyReader'@.
1337− 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
1339----------------------------------------------------------------------------
1980----------------------------------------------------------------------------
1342-- | 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
1343-- 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
1344−-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is
1985+-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1345−-- endomorphism of functions under composition, it's used to chain different
1986+-- monoid of endomorphisms under composition, it's used to chain different
1346−-- request component easier using @('<>')@.
1987+-- request components easier using @('<>')@.
1989+-- __Note__: this type class is not a part of the public API.
1348class RequestComponent a where
1990class RequestComponent a where
1350 -- | 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
1351− -- returning another 'L.Request'. For example HTTP method instance of
1992+ -- returning another 'L.Request'. For example, the 'HttpMethod' instance
1352− -- 'RequestComponent' just overwrites method. The function is wrapped in
1993+ -- of 'RequestComponent' just overwrites method. The function is wrapped
1353− -- 'Endo' so it's easier to chain such “modifying applications” together
1994+ -- in 'Endo' so it's easier to chain such “modifying applications”
1354− -- building bigger and bigger 'RequestComponent's.
1995+ -- together building bigger and bigger 'RequestComponent's.
1356 getRequestMod :: a -> Endo L.Request
1996 getRequestMod :: a -> Endo L.Request
1358−-- | 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.
1359-- This is necessary to define instances of 'RequestComponent' for any thing
1999-- This is necessary to define instances of 'RequestComponent' for any thing
1360−-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC is not
2000+-- that implements 'HttpMethod' or 'HttpBody'. Without the tag, GHC can't
1361−-- able to see difference between @'HttpMethod' method => 'RequestComponent'
2001+-- see the difference between @'HttpMethod' method => 'RequestComponent'
1362-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
2002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
1363−-- 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,
1364-- when instance is already chosen).
2004-- when instance is already chosen).
1366−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
1368-- | Exceptions that this library throws.
2007-- | Exceptions that this library throws.
1370data HttpException
2008data HttpException
1371− = VanillaHttpException L.HttpException
1372− -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2009+ = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1373− | JsonHttpException String
2010+ VanillaHttpException L.HttpException
1374− -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
2011+ | -- | A wrapper with Aeson-produced 'String' describing why decoding
2013+ JsonHttpException String
1375− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
1377instance Exception HttpException
2016instance Exception HttpException
1379−-- | 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
1380−-- use it as a kind and its data constructors as type-level tags.
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
1382−-- 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'.
1384data CanHaveBody
2037data CanHaveBody
1385− = CanHaveBody -- ^ Indeed can have a body
2038+ = -- | Indeed can have a body
1386− | NoBody -- ^ Should not have a body
2040+ | -- | Should not have a body
1388−-- | 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
1389-- enabled). This is used to force TLS requirement for some authentication
2044-- enabled). This is used to force TLS requirement for some authentication
1390-- 'Option's.
2045-- 'Option's.
1392data Scheme
2046data Scheme
1393− = Http -- ^ HTTP, no TLS
2047+ = -- | HTTP
1394− | Https -- ^ HTTPS
2049+ | -- | HTTPS
1395− deriving (Eq, Ord, Show, Data, Typeable, Generic)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)