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