@@ -1,16 +1,6 @@
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 <markkarpov92@gmail.com>
@@ -19,40 +9,61 @@
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 HTTPS
49−-- user to use HTTPS at the type level.
42+-- force the user to use HTTPS 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
@@ -76,207 +87,186 @@
76-- the whole Haskell ecosystem uses, there is no risk in using @req@. The
87-- 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
88-- machinery for performing requests is the same as with @http-conduit@ and
78-- @wreq@. The only difference is the API.
89-- @wreq@. The only difference is the API.
92+{-# LANGUAGE DataKinds #-}
93+{-# LANGUAGE DeriveDataTypeable #-}
94+{-# LANGUAGE DeriveGeneric #-}
95+{-# LANGUAGE FlexibleInstances #-}
96+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
97+{-# LANGUAGE KindSignatures #-}
98+{-# LANGUAGE MultiParamTypeClasses #-}
99+{-# LANGUAGE OverloadedStrings #-}
100+{-# LANGUAGE RankNTypes #-}
101+{-# LANGUAGE RecordWildCards #-}
102+{-# LANGUAGE ScopedTypeVariables #-}
103+{-# LANGUAGE TypeFamilies #-}
105+#if MIN_VERSION_base(4,9,0)
106+{-# LANGUAGE UndecidableInstances #-}
109+#if __GLASGOW_HASKELL__ < 710
110+{-# LANGUAGE ConstraintKinds #-}
113+#if __GLASGOW_HASKELL__ >= 800
114+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
79module Network.HTTP.Req
117module Network.HTTP.Req
80 ( -- * Making a request
118 ( -- * Making a request
81 -- $making-a-request
119 -- $making-a-request
86− withReqManager,
122+ , withReqManager
88− -- * Embedding requests in your monad
123+ -- * Embedding requests into your monad
89 -- $embedding-requests
124 -- $embedding-requests
90− MonadHttp (..),
125+ , MonadHttp (..)
91− HttpConfig (..),
126+ , HttpConfig (..)
96 -- * Request
129 -- * Request
98 -- ** Method
130 -- ** Method
99 -- $method
131 -- $method
100− GET (..),
132+ , GET (..)
101− POST (..),
133+ , POST (..)
102− HEAD (..),
134+ , HEAD (..)
103− PUT (..),
135+ , PUT (..)
104− DELETE (..),
136+ , DELETE (..)
105− TRACE (..),
137+ , TRACE (..)
106− CONNECT (..),
138+ , CONNECT (..)
107− OPTIONS (..),
139+ , OPTIONS (..)
108− PATCH (..),
140+ , PATCH (..)
109− HttpMethod (..),
141+ , HttpMethod (..)
111 -- ** URL
142 -- ** URL
118− useHttpURI,
149+ , parseUrlHttp
119− useHttpsURI,
150+ , parseUrlHttps
124 -- ** Body
151 -- ** Body
126− NoReqBody (..),
153+ , NoReqBody (..)
127− ReqBodyJson (..),
154+ , ReqBodyJson (..)
128− ReqBodyFile (..),
155+ , ReqBodyFile (..)
129− ReqBodyBs (..),
156+ , ReqBodyBs (..)
130− ReqBodyLbs (..),
157+ , ReqBodyLbs (..)
131− ReqBodyUrlEnc (..),
158+ , ReqBodyUrlEnc (..)
132− FormUrlEncodedParam,
159+ , FormUrlEncodedParam
133− ReqBodyMultipart,
160+ , ReqBodyMultipart
134− reqBodyMultipart,
161+ , reqBodyMultipart
135− HttpBody (..),
162+ , HttpBody (..)
136− ProvidesBody,
163+ , ProvidesBody
137− HttpBodyAllowed,
164+ , HttpBodyAllowed
139 -- ** Optional parameters
165 -- ** Optional parameters
140 -- $optional-parameters
166 -- $optional-parameters
141− Option,
167+ , Option
143 -- *** Query parameters
168 -- *** Query parameters
144 -- $query-parameters
169 -- $query-parameters
146− queryFlag,
171+ , queryFlag
148− QueryParam (..),
172+ , QueryParam (..)
150 -- *** Headers
173 -- *** Headers
151− header,
174+ , header
155 -- *** Cookies
175 -- *** Cookies
156 -- $cookies
176 -- $cookies
157− cookieJar,
177+ , cookieJar
159 -- *** Authentication
178 -- *** Authentication
160 -- $authentication
179 -- $authentication
161− basicAuth,
180+ , basicAuth
162− basicAuthUnsafe,
181+ , basicAuthUnsafe
164− oAuth1,
182+ , oAuth1
165− oAuth2Bearer,
183+ , oAuth2Bearer
166− oAuth2Token,
184+ , oAuth2Token
169 -- *** Other
185 -- *** Other
171− decompress,
187+ , decompress
172− responseTimeout,
188+ , responseTimeout
173− httpVersion,
189+ , httpVersion
175 -- * Response
190 -- * Response
177 -- ** Response interpretations
191 -- ** Response interpretations
178− IgnoreResponse,
192+ , IgnoreResponse
179− ignoreResponse,
193+ , ignoreResponse
180− JsonResponse,
194+ , JsonResponse
181− jsonResponse,
195+ , jsonResponse
182− BsResponse,
196+ , BsResponse
183− bsResponse,
197+ , bsResponse
184− LbsResponse,
198+ , LbsResponse
185− lbsResponse,
199+ , lbsResponse
187 -- ** Inspecting a response
200 -- ** Inspecting a response
188− responseBody,
201+ , responseBody
189− responseStatusCode,
202+ , responseStatusCode
190− responseStatusMessage,
203+ , responseStatusMessage
191− responseHeader,
204+ , responseHeader
192− responseCookieJar,
205+ , responseCookieJar
194 -- ** Defining your own interpretation
206 -- ** Defining your own interpretation
195 -- $new-response-interpretation
207 -- $new-response-interpretation
196− HttpResponse (..),
208+ , HttpResponse (..)
198 -- * Other
209 -- * Other
199− HttpException (..),
210+ , HttpException (..)
200− isStatusCodeException,
201− CanHaveBody (..),
211+ , CanHaveBody (..)
202− Scheme (..),
212+ , Scheme (..) )
206−import Blaze.ByteString.Builder qualified as BB
207import Control.Applicative
215import Control.Applicative
208import Control.Arrow (first, second)
216import Control.Arrow (first, second)
209−import Control.Exception hiding (Handler (..), TypeError)
217+import Control.Exception (Exception, try, handle, throwIO)
210−import Control.Monad (guard, void, (>=>))
218+import Control.Monad
211import Control.Monad.Base
219import Control.Monad.Base
212−import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
213import Control.Monad.IO.Class
220import Control.Monad.IO.Class
214−import Control.Monad.IO.Unlift
221+import Control.Monad.Reader
215−import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216−import Control.Monad.Trans.Accum (AccumT)
217−import Control.Monad.Trans.Cont (ContT)
218import Control.Monad.Trans.Control
222import 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
231import Control.Retry
223import Control.Retry
232−import Data.Aeson (FromJSON (..), ToJSON (..))
224+import Data.Aeson (ToJSON (..), FromJSON (..))
233−import Data.Aeson qualified as A
234import Data.ByteString (ByteString)
225import 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)
226import Data.Data (Data)
239−import Data.Default.Class (def)
227+import Data.Default.Class
240import Data.Function (on)
228import Data.Function (on)
241import Data.IORef
229import Data.IORef
242−import Data.Kind (Constraint, Type)
230+import Data.List (nubBy)
243−import Data.List (foldl', nubBy)
244import Data.List.NonEmpty (NonEmpty (..))
231import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
246import Data.Maybe (fromMaybe)
232import Data.Maybe (fromMaybe)
247import Data.Proxy
233import Data.Proxy
248−import Data.Semigroup (Endo (..))
234+import Data.Semigroup hiding (Option, option)
249−import Data.Set qualified as S
250import Data.Text (Text)
235import Data.Text (Text)
251−import Data.Text qualified as T
252−import Data.Text.Encoding qualified as T
253−import Data.Typeable (Typeable, cast)
236+import Data.Typeable (Typeable)
254import GHC.Generics
237import GHC.Generics
255import GHC.TypeLits
238import 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)
239import 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 (..))
240import Web.HttpApiData (ToHttpApiData (..))
241+import qualified Blaze.ByteString.Builder as BB
242+import qualified Data.Aeson as A
243+import qualified Data.ByteString as B
244+import qualified Data.ByteString.Lazy as BL
245+import qualified Data.CaseInsensitive as CI
246+import qualified Data.List.NonEmpty as NE
247+import qualified Data.Text as T
248+import qualified Data.Text.Encoding as T
249+import qualified Data.Text.Read as TR
250+import qualified Network.Connection as NC
251+import qualified Network.HTTP.Client as L
252+import qualified Network.HTTP.Client.Internal as LI
253+import qualified Network.HTTP.Client.MultipartFormData as LM
254+import qualified Network.HTTP.Client.TLS as L
255+import qualified Network.HTTP.Types as Y
256+import qualified Web.Authenticate.OAuth as OAuth
258+#if MIN_VERSION_base(4,9,0)
259+import Data.Kind (Constraint)
261+import GHC.Exts (Constraint)
274----------------------------------------------------------------------------
264----------------------------------------------------------------------------
275-- Making a request
265-- Making a request
277-- $making-a-request
267-- $making-a-request
279−-- To make an HTTP request you normally need only one function: 'req'.
269+-- To make an HTTP request you need only one function: 'req'.
281-- | Make an HTTP request. The function takes 5 arguments, 4 of which
271-- | Make an HTTP request. The function takes 5 arguments, 4 of which
282-- specify required parameters and the final 'Option' argument is a
272-- specify required parameters and the final 'Option' argument is a
@@ -293,7 +283,7 @@ import Web.HttpApiData (ToHttpApiData (..))
294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
284-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
295-- tutorial has a section about HTTP bodies, but usage is very
285-- tutorial has a section about HTTP bodies, but usage is very
296−-- straightforward and should be clear from the examples.
286+-- straightforward and should be clear from the examples below.
298-- @response@ is a type hint how to make and interpret response of an HTTP
288-- @response@ is a type hint how to make and interpret response of an HTTP
299-- request. Out-of-the-box it can be the following:
289-- request. Out-of-the-box it can be the following:
@@ -319,13 +309,12 @@ import Web.HttpApiData (ToHttpApiData (..))
319-- First, this is a piece of boilerplate that should be in place before you
309-- First, this is a piece of boilerplate that should be in place before you
320-- try the examples:
310-- try the examples:
322−-- > {-# LANGUAGE DeriveGeneric #-}
323-- > {-# LANGUAGE OverloadedStrings #-}
312-- > {-# LANGUAGE OverloadedStrings #-}
325-- > module Main (main) where
314-- > module Main (main) where
316+-- > import Control.Exception (throwIO)
327-- > import Control.Monad
317-- > import Control.Monad
328−-- > import Control.Monad.IO.Class
329-- > import Data.Aeson
318-- > import Data.Aeson
330-- > import Data.Maybe (fromJust)
319-- > import Data.Maybe (fromJust)
331-- > import Data.Monoid ((<>))
320-- > import Data.Monoid ((<>))
@@ -333,30 +322,32 @@ import Web.HttpApiData (ToHttpApiData (..))
333-- > import GHC.Generics
322-- > import GHC.Generics
334-- > import Network.HTTP.Req
323-- > import Network.HTTP.Req
335-- > import qualified Data.ByteString.Char8 as B
324-- > import qualified Data.ByteString.Char8 as B
336−-- > import qualified Text.URI as URI
325+-- >
326+-- > instance MonadHttp IO where
327+-- > handleHttpException = throwIO
338-- We will be making requests against the <https://httpbin.org> service.
329-- We will be making requests against the <https://httpbin.org> service.
340-- Make a GET request, grab 5 random bytes:
331-- Make a GET request, grab 5 random bytes:
342-- > main :: IO ()
333-- > main :: IO ()
343−-- > main = runReq defaultHttpConfig $ do
334+-- > main = do
344-- > let n :: Int
335-- > let n :: Int
345-- > n = 5
336-- > n = 5
346-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
337-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse mempty
347−-- > liftIO $ B.putStrLn (responseBody bs)
338+-- > B.putStrLn (responseBody bs)
349-- The same, but now we use a query parameter named @\"seed\"@ to control
340-- The same, but now we use a query parameter named @\"seed\"@ to control
350-- seed of the generator:
341-- seed of the generator:
352-- > main :: IO ()
343-- > main :: IO ()
353−-- > main = runReq defaultHttpConfig $ do
344+-- > main = do
354-- > let n, seed :: Int
345-- > let n, seed :: Int
355-- > n = 5
346-- > n = 5
356-- > seed = 100
347-- > seed = 100
357-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
348-- > bs <- req GET (https "httpbin.org" /: "bytes" /~ n) NoReqBody bsResponse $
358-- > "seed" =: seed
349-- > "seed" =: seed
359−-- > liftIO $ B.putStrLn (responseBody bs)
350+-- > B.putStrLn (responseBody bs)
361-- POST JSON data and get some info about the POST request:
352-- POST JSON data and get some info about the POST request:
@@ -369,231 +360,108 @@ import Web.HttpApiData (ToHttpApiData (..))
369-- > instance FromJSON MyData
360-- > instance FromJSON MyData
371-- > main :: IO ()
362-- > main :: IO ()
372−-- > main = runReq defaultHttpConfig $ do
363+-- > main = do
373-- > let myData = MyData
364-- > let myData = MyData
374-- > { size = 6
365-- > { size = 6
375-- > , color = "Green" }
366-- > , color = "Green" }
376-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
367-- > v <- req POST (https "httpbin.org" /: "post") (ReqBodyJson myData) jsonResponse mempty
377−-- > liftIO $ print (responseBody v :: Value)
368+-- > print (responseBody v :: Value)
379-- Sending URL-encoded body:
370-- Sending URL-encoded body:
381-- > main :: IO ()
372-- > main :: IO ()
382−-- > main = runReq defaultHttpConfig $ do
373+-- > main = do
383-- > let params =
374-- > let params =
384-- > "foo" =: ("bar" :: Text) <>
375-- > "foo" =: ("bar" :: Text) <>
385-- > queryFlag "baz"
376-- > queryFlag "baz"
386-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
377-- > response <- req POST (https "httpbin.org" /: "post") (ReqBodyUrlEnc params) jsonResponse mempty
387−-- > liftIO $ print (responseBody response :: Value)
378+-- > print (responseBody response :: Value)
389-- Using various optional parameters and URL that is not known in advance:
380-- Using various optional parameters and URL that is not known in advance:
391-- > main :: IO ()
382-- > main :: IO ()
392−-- > main = runReq defaultHttpConfig $ do
383+-- > main = do
393-- > -- This is an example of what to do when URL is given dynamically. Of
384-- > -- 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'.
385-- > -- course in a real application you may not want to use 'fromJust'.
395−-- > uri <- URI.mkURI "https://httpbin.org/get?foo=bar"
386+-- > 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 $
387-- > response <- req GET url NoReqBody jsonResponse $
398-- > "from" =: (15 :: Int) <>
388-- > "from" =: (15 :: Int) <>
399-- > "to" =: (67 :: Int) <>
389-- > "to" =: (67 :: Int) <>
400-- > basicAuth "username" "password" <>
390-- > basicAuth "username" "password" <>
401-- > options <> -- contains the ?foo=bar part
391-- > options <> -- contains the ?foo=bar part
402-- > port 443 -- here you can put any port of course
392-- > port 443 -- here you can put any port of course
403−-- > liftIO $ print (responseBody response :: Value)
393+-- > print (responseBody response :: Value)
405− ( MonadHttp m,
396+ :: ( MonadHttp m
406− HttpMethod method,
397+ , HttpMethod method
407− HttpBody body,
398+ , HttpBody body
408− HttpResponse response,
399+ , HttpResponse response
409− HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
400+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
411− -- | HTTP method
401+ => method -- ^ HTTP method
413− -- | 'Url'—location of resource
402+ -> Url scheme -- ^ 'Url'—location of resource
415− -- | Body of the request
403+ -> body -- ^ Body of the request
417− -- | A hint how to interpret response
404+ -> Proxy response -- ^ A hint how to interpret response
419− -- | Collection of optional parameters
405+ -> Option scheme -- ^ Collection of optional parameters
421− -- | Response
406+ -> m response -- ^ Response
423−req method url body responseProxy options =
407+req method url body Proxy options = req' method url body options $ \request manager -> do
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
408+ HttpConfig {..} <- getHttpConfig
502− let wrapVanilla = handle (throwIO . VanillaHttpException)
409+ let wrappingVanilla = handle (throwIO . VanillaHttpException)
503− wrapExc = handle (throwIO . LI.toHttpException request)
410+ wrapExc = handle (throwIO . LI.toHttpException request)
507− (readIORef >=> mapM_ L.responseClose)
508− (liftIO . try . wrapVanilla . wrapExc)
411+ (liftIO . try . wrappingVanilla . wrapExc) (do
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
412+ response <- retrying httpConfigRetryPolicy httpConfigRetryJudge
524− (\retryStatus r -> return $ httpConfigRetryJudge retryStatus r)
413+ (const $ getHttpResponse request manager)
527− httpConfigRetryPolicy
528− exceptionRetryPolicies
529− (const openResponse)
532− (preview, r') <- grabPreview httpConfigBodyPreviewLength r
533− mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
414+ httpConfigCheckResponse request response
534− consume r'
415+ return response)
536 >>= either handleHttpException return
416 >>= either handleHttpException return
538-- | Mostly like 'req' with respect to its arguments, but accepts a callback
418-- | Mostly like 'req' with respect to its arguments, but accepts a callback
539-- that allows to perform a request in arbitrary fashion.
419-- that allows to perform a request in arbitrary fashion.
541-- This function /does not/ perform handling\/wrapping exceptions, checking
421-- This function /does not/ perform handling\/wrapping exceptions, checking
542−-- response (with 'httpConfigCheckResponse'), and retrying. It only prepares
422+-- response, and retrying. It only prepares 'L.Request' and allows you to
543−-- 'L.Request' and allows you to use it.
423+-- use it.
545-- @since 0.3.0
425-- @since 0.3.0
547− forall m method body scheme a.
428+ :: forall m method body scheme a.
548− ( MonadHttp m,
429+ ( MonadHttp m
549− HttpMethod method,
430+ , HttpMethod method
550− HttpBody body,
431+ , HttpBody body
551− HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
432+ , HttpBodyAllowed (AllowsBody method) (ProvidesBody body) )
553− -- | HTTP method
433+ => method -- ^ HTTP method
555− -- | 'Url'—location of resource
434+ -> Url scheme -- ^ 'Url'—location of resource
557− -- | Body of the request
435+ -> body -- ^ Body of the request
559− -- | Collection of optional parameters
436+ -> Option scheme -- ^ Collection of optional parameters
561− -- | How to perform request
437+ -> (L.Request -> L.Manager -> m a) -- ^ How to perform request
562− (L.Request -> L.Manager -> m a) ->
565req' method url body options m = do
439req' method url body options m = do
566− config <- getHttpConfig
440+ config@HttpConfig {..} <- getHttpConfig
441+ manager <- liftIO (readIORef globalManager)
567 let -- NOTE First appearance of any given header wins. This allows to
442 let -- NOTE First appearance of any given header wins. This allows to
568 -- “overwrite” headers when we construct a request by cons-ing.
443 -- “overwrite” headers when we construct a request by cons-ing.
569 nubHeaders = Endo $ \x ->
444 nubHeaders = Endo $ \x ->
570− x {L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x)}
445+ x { L.requestHeaders = nubBy ((==) `on` fst) (L.requestHeaders x) }
572− flip appEndo L.defaultRequest $
446+ request' = flip appEndo L.defaultRequest $
573− -- NOTE The order of 'mappend's matters, here method is overwritten
447+ -- NOTE The order of 'mappend's matters, here method is overwritten
574− -- first and 'options' take effect last. In particular, this means
448+ -- first and 'options' take effect last. In particular, this means
575− -- that 'options' can overwrite things set by other request
449+ -- that 'options' can overwrite things set by other request
576− -- components, which is useful for setting port number,
450+ -- components, which is useful for setting port number,
577− -- "Content-Type" header, etc.
451+ -- "Content-Type" header, etc.
578− nubHeaders
452+ nubHeaders <>
579− <> getRequestMod options
453+ getRequestMod options <>
580− <> getRequestMod config
454+ getRequestMod config <>
581− <> getRequestMod (Tagged body :: Tagged "body" body)
455+ getRequestMod (Womb body :: Womb "body" body) <>
582− <> getRequestMod url
456+ getRequestMod url <>
583− <> getRequestMod (Tagged method :: Tagged "method" method)
457+ getRequestMod (Womb method :: Womb "method" method)
584 request <- finalizeRequest options request'
458 request <- finalizeRequest options request'
585− withReqManager (m request)
459+ m request manager
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
461+-- | 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
462+-- 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
463+-- when we create a request, instance 'HttpConfig' can affect the default
596−-- default settings via 'getHttpConfig'.
464+-- settings via 'getHttpConfig'.
598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
466-- 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
467-- The value of 'globalManager' is named and lives on top level. This means
@@ -601,20 +469,24 @@ withReqManager m = m globalManager
601-- manager. From that moment on the 'IORef' will be just reused—exactly the
469-- manager. From that moment on the 'IORef' will be just reused—exactly the
602-- behavior we want here in order to maximize connection sharing. GHC could
470-- behavior we want here in order to maximize connection sharing. GHC could
603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
471-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
473+globalManager :: IORef L.Manager
605globalManager = unsafePerformIO $ do
474globalManager = unsafePerformIO $ do
606 context <- NC.initConnectionContext
475 context <- NC.initConnectionContext
608− L.mkManagerSettingsContext
476+ let settings = L.mkManagerSettingsContext (Just context) def Nothing
612 manager <- L.newManager settings
477 manager <- L.newManager settings
613− return manager
478+ newIORef manager
614{-# NOINLINE globalManager #-}
479{-# NOINLINE globalManager #-}
481+-- | Perform an action using global implicit 'L.Manager' that the rest of
482+-- the library uses. This allows to reuse connections that the 'L.Manager'
485+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
486+withReqManager m = liftIO (readIORef globalManager) >>= m
616----------------------------------------------------------------------------
488----------------------------------------------------------------------------
617−-- Embedding requests in your monad
489+-- Embedding requests into your monad
619-- $embedding-requests
491-- $embedding-requests
@@ -623,165 +495,109 @@ globalManager = unsafePerformIO $ do
624-- When writing a library, keep your API polymorphic in terms of
496-- When writing a library, keep your API polymorphic in terms of
625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
497-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
626−-- Another option is to use a @newtype@-wrapped monad stack and define
498+-- Another option is to use @newtype@ wrapped monad stack and define
627−-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
499+-- 'MonadHttp' for it.
628−-- follows this strategy is provided out-of-the-box (see below).
630-- | A type class for monads that support performing HTTP requests.
501-- | A type class for monads that support performing HTTP requests.
631-- Typically, you only need to define the 'handleHttpException' method
502-- Typically, you only need to define the 'handleHttpException' method
632-- unless you want to tweak 'HttpConfig'.
503-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
505+class MonadIO m => MonadHttp m where
634 -- | This method describes how to deal with 'HttpException' that was
507 -- | 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
508 -- 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
509 -- exceptions, but if you prefer working with something like
637 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
510 -- 'Control.Monad.Except.MonadError', this is the right place to pass it to
638 -- 'Control.Monad.Except.throwError'.
511 -- 'Control.Monad.Except.throwError'.
639 handleHttpException :: HttpException -> m a
513 handleHttpException :: HttpException -> m a
641− -- | Return the 'HttpConfig' to be used when performing HTTP requests.
515+ -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
642− -- Default implementation returns its 'def' value, which is described in
516+ -- implementation returns its 'def' value, which is described in the
643− -- the documentation for the type. Common usage pattern with manually
517+ -- documentation for the type. Common usage pattern with manually defined
644− -- defined 'getHttpConfig' is to return some hard-coded value, or a value
518+ -- 'getHttpConfig' is to return some hard-coded value, or value extracted
645− -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
519+ -- from 'Control.Monad.Reader.MonadReader' if a more flexible approach to
646− -- approach to configuration is desirable.
520+ -- configuration is desirable.
647 getHttpConfig :: m HttpConfig
522 getHttpConfig :: m HttpConfig
648− getHttpConfig = return defaultHttpConfig
523+ getHttpConfig = return def
525+-- | 'HttpConfig' contains general and default settings to be used when
526+-- making HTTP requests.
650−-- | 'HttpConfig' contains settings to be used when making HTTP requests.
651data HttpConfig = HttpConfig
528data HttpConfig = HttpConfig
529+ { httpConfigProxy :: Maybe L.Proxy
652− { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
530+ -- ^ Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
653 -- environment variables are respected, this setting overwrites them.
531 -- environment variables are respected, this setting overwrites them.
654 -- Default value: 'Nothing'.
532 -- Default value: 'Nothing'.
655− httpConfigProxy :: Maybe L.Proxy,
533+ , httpConfigRedirectCount :: Int
656− -- | How many redirects to follow when getting a resource. Default
534+ -- ^ How many redirects to follow when getting a resource. Default
657 -- value: 10.
535 -- value: 10.
658− httpConfigRedirectCount :: Int,
536+ , httpConfigAltManager :: Maybe L.Manager
659− -- | Alternative 'L.Manager' to use. 'Nothing' (default value) means
537+ -- ^ Alternative 'L.Manager' to use. 'Nothing' (default value) means
660− -- that the default implicit manager will be used (that's what you want
538+ -- that default implicit manager will be used (that's what you want in
661− -- in 99% of cases).
539+ -- 99% of cases).
662− httpConfigAltManager :: Maybe L.Manager,
540+ , httpConfigCheckResponse :: forall r. HttpResponse r => L.Request -> r -> IO ()
663− -- | Function to check the response immediately after receiving the
541+ -- ^ 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
542+ -- status and headers. This is used for throwing exceptions on
667− -- codes by default (set to @\\_ _ _ -> Nothing@ if this behavior is not
543+ -- non-success status codes by default (set to @\\_ _ -> return ()@ if
668− -- desirable).
544+ -- 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
545+ -- 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
546+ -- 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
547+ -- thrown exception is caught by the library though and is available in
679− -- though and is available in 'handleHttpException'.
548+ -- 'handleHttpException'.
681− -- __Note__: signature of this function was changed in the version
684 -- @since 0.3.0
550 -- @since 0.3.0
685− httpConfigCheckResponse ::
551+ , httpConfigRetryPolicy :: RetryPolicyM IO
690− Maybe L.HttpExceptionContent,
691− -- | The retry policy to use for request retrying. By default 'def' is
552+ -- ^ The retry policy to use for request retrying. By default 'def' is
692 -- used (see 'RetryPolicyM').
553 -- 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/.
697 -- @since 0.3.0
555 -- @since 0.3.0
698− httpConfigRetryPolicy :: RetryPolicyM IO,
556+ , httpConfigRetryJudge :: forall r. HttpResponse r => RetryStatus -> r -> IO Bool
699− -- | The function is used to decide whether to retry a request. 'True'
557+ -- ^ The function is used to decide whether to retry a request. 'True'
700 -- means that the request should be retried.
558 -- means that the request should be retried.
702− -- __Note__: signature of this function was changed in the version
705 -- @since 0.3.0
560 -- @since 0.3.0
706− httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
561+ } deriving Typeable
707− -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
562+
708− -- retry requests that resulted in an exception. By default it retries
563+instance Default HttpConfig where
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
564+ def = HttpConfig
726− { httpConfigProxy = Nothing,
565+ { httpConfigProxy = Nothing
727− httpConfigRedirectCount = 10,
566+ , httpConfigRedirectCount = 10
728− httpConfigAltManager = Nothing,
567+ , httpConfigAltManager = Nothing
729− httpConfigCheckResponse = \_ response preview ->
568+ , httpConfigCheckResponse = \_ response ->
730− let scode = statusCode response
569+ let statusCode = responseStatusCode response in
731− in if 200 <= scode && scode < 300
570+ unless (200 <= statusCode && statusCode < 300) $ do
732− then Nothing
571+ chunk <- makeResponseBodyPreview response
572+ let vresponse = toVanillaResponse response
733− else Just (L.StatusCodeException (void response) preview),
573+ LI.throwHttp (L.StatusCodeException (void vresponse) chunk)
734− httpConfigRetryPolicy = retryPolicyDefault,
574+ , httpConfigRetryPolicy = def
735− httpConfigRetryJudge = \_ response ->
575+ , httpConfigRetryJudge = \_ r -> return $
736− statusCode response
576+ responseStatusCode r `elem`
737− `elem` [ 408, -- Request timeout
577+ [ 408 -- Request timeout
738− 504, -- Gateway timeout
578+ , 504 -- Gateway timeout
739− 524, -- A timeout occurred
579+ , 524 -- A timeout occurred
740− 598, -- (Informal convention) Network read timeout error
580+ , 598 -- (Informal convention) Network read timeout error
741− 599 -- (Informal convention) Network connect timeout error
581+ , 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
585instance RequestComponent HttpConfig where
757 getRequestMod HttpConfig {..} = Endo $ \x ->
586 getRequestMod HttpConfig {..} = Endo $ \x ->
759− { L.proxy = httpConfigProxy,
587+ x { L.proxy = httpConfigProxy
760− L.redirectCount = httpConfigRedirectCount,
588+ , L.redirectCount = httpConfigRedirectCount
761− LI.requestManagerOverride = httpConfigAltManager
589+ , LI.requestManagerOverride = httpConfigAltManager }
764−-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
591+-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
765-- having to define new instances.
592-- having to define new instances.
767-- @since 0.4.0
594-- @since 0.4.0
768−newtype Req a = Req (ReaderT HttpConfig IO a)
778−deriving instance MonadThrow Req
781−deriving instance MonadCatch Req
783−-- | @since 3.7.0
596+newtype Req a = Req (ReaderT HttpConfig IO a)
784−deriving instance MonadMask Req
597+ deriving ( Functor
786instance MonadBase IO Req where
602instance MonadBase IO Req where
787 liftBase = liftIO
603 liftBase = liftIO
@@ -790,99 +606,22 @@ instance MonadBaseControl IO Req where
790 type StM Req a = a
606 type StM Req a = a
791 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
607 liftBaseWith f = Req . ReaderT $ \r -> f (runReq r)
792 {-# INLINEABLE liftBaseWith #-}
608 {-# INLINEABLE liftBaseWith #-}
793− restoreM = Req . ReaderT . const . return
609+ restoreM = Req . ReaderT . const . return
794 {-# INLINEABLE restoreM #-}
610 {-# INLINEABLE restoreM #-}
796instance MonadHttp Req where
612instance MonadHttp Req where
797 handleHttpException = Req . lift . throwIO
613 handleHttpException = Req . lift . throwIO
798− getHttpConfig = Req ask
614+ 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
616-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
876−-- the case of an exceptional situation an 'HttpException' will be thrown.
617+-- case of exceptional situation an 'HttpException' will be thrown.
878-- @since 0.4.0
619-- @since 0.4.0
880− (MonadIO m) =>
621+runReq :: MonadIO m
881− -- | 'HttpConfig' to use
622+ => HttpConfig -- ^ 'HttpConfig' to use
883− -- | Computation to run
623+ -> Req a -- ^ Computation to run
886runReq config (Req m) = liftIO (runReaderT m config)
625runReq config (Req m) = liftIO (runReaderT m config)
888----------------------------------------------------------------------------
627----------------------------------------------------------------------------
@@ -898,6 +637,7 @@ runReq config (Req m) = liftIO (runReaderT m config)
898-- define a new method that will works seamlessly, see 'HttpMethod'.
637-- define a new method that will works seamlessly, see 'HttpMethod'.
900-- | 'GET' method.
639-- | 'GET' method.
901data GET = GET
641data GET = GET
903instance HttpMethod GET where
643instance HttpMethod GET where
@@ -905,6 +645,7 @@ instance HttpMethod GET where
905 httpMethodName Proxy = Y.methodGet
645 httpMethodName Proxy = Y.methodGet
907-- | 'POST' method.
647-- | 'POST' method.
908data POST = POST
649data POST = POST
910instance HttpMethod POST where
651instance HttpMethod POST where
@@ -912,6 +653,7 @@ instance HttpMethod POST where
912 httpMethodName Proxy = Y.methodPost
653 httpMethodName Proxy = Y.methodPost
914-- | 'HEAD' method.
655-- | 'HEAD' method.
915data HEAD = HEAD
657data HEAD = HEAD
917instance HttpMethod HEAD where
659instance HttpMethod HEAD where
@@ -919,24 +661,26 @@ instance HttpMethod HEAD where
919 httpMethodName Proxy = Y.methodHead
661 httpMethodName Proxy = Y.methodHead
921-- | 'PUT' method.
663-- | 'PUT' method.
922data PUT = PUT
665data PUT = PUT
924instance HttpMethod PUT where
667instance HttpMethod PUT where
925 type AllowsBody PUT = 'CanHaveBody
668 type AllowsBody PUT = 'CanHaveBody
926 httpMethodName Proxy = Y.methodPut
669 httpMethodName Proxy = Y.methodPut
928−-- | 'DELETE' method. RFC 7231 allows a payload in DELETE but without
671+-- | 'DELETE' method. This data type does not allow having request body with
929−-- semantics.
672+-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
930−--
673+-- 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
674+-- 'DELETE' method and allow it to have a body.
933data DELETE = DELETE
676data DELETE = DELETE
935instance HttpMethod DELETE where
678instance HttpMethod DELETE where
936− type AllowsBody DELETE = 'CanHaveBody
679+ type AllowsBody DELETE = 'NoBody
937 httpMethodName Proxy = Y.methodDelete
680 httpMethodName Proxy = Y.methodDelete
939-- | 'TRACE' method.
682-- | 'TRACE' method.
940data TRACE = TRACE
684data TRACE = TRACE
942instance HttpMethod TRACE where
686instance HttpMethod TRACE where
@@ -944,6 +688,7 @@ instance HttpMethod TRACE where
944 httpMethodName Proxy = Y.methodTrace
688 httpMethodName Proxy = Y.methodTrace
946-- | 'CONNECT' method.
690-- | 'CONNECT' method.
947data CONNECT = CONNECT
692data CONNECT = CONNECT
949instance HttpMethod CONNECT where
694instance HttpMethod CONNECT where
@@ -951,6 +696,7 @@ instance HttpMethod CONNECT where
951 httpMethodName Proxy = Y.methodConnect
696 httpMethodName Proxy = Y.methodConnect
953-- | 'OPTIONS' method.
698-- | 'OPTIONS' method.
954data OPTIONS = OPTIONS
700data OPTIONS = OPTIONS
956instance HttpMethod OPTIONS where
702instance HttpMethod OPTIONS where
@@ -958,6 +704,7 @@ instance HttpMethod OPTIONS where
958 httpMethodName Proxy = Y.methodOptions
704 httpMethodName Proxy = Y.methodOptions
960-- | 'PATCH' method.
706-- | 'PATCH' method.
961data PATCH = PATCH
708data PATCH = PATCH
963instance HttpMethod PATCH where
710instance HttpMethod PATCH where
@@ -965,26 +712,30 @@ instance HttpMethod PATCH where
965 httpMethodName Proxy = Y.methodPatch
712 httpMethodName Proxy = Y.methodPatch
967-- | A type class for types that can be used as an HTTP method. To define a
714-- | 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@:
715+-- non-standard method, follow this example that defines COPY:
970-- > data COPY = COPY
717-- > data COPY = COPY
972-- > instance HttpMethod COPY where
719-- > instance HttpMethod COPY where
973-- > type AllowsBody COPY = 'CanHaveBody
720-- > type AllowsBody COPY = 'CanHaveBody
974-- > httpMethodName Proxy = "COPY"
721-- > httpMethodName Proxy = "COPY"
975class HttpMethod a where
723class HttpMethod a where
976 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
725 -- | Type function 'AllowsBody' returns a type of kind 'CanHaveBody' which
977− -- tells the rest of the library whether the method can have body or not.
726+ -- 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
727+ -- not. We use the special type 'CanHaveBody' “lifted” to kind level
979− -- of 'Bool' to get more user-friendly compiler messages.
728+ -- instead of 'Bool' to get more user-friendly compiler messages.
980 type AllowsBody a :: CanHaveBody
730 type AllowsBody a :: CanHaveBody
982 -- | Return name of the method as a 'ByteString'.
732 -- | Return name of the method as a 'ByteString'.
983 httpMethodName :: Proxy a -> ByteString
734 httpMethodName :: Proxy a -> ByteString
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
736+instance HttpMethod method => RequestComponent (Womb "method" method) where
986 getRequestMod _ = Endo $ \x ->
737 getRequestMod _ = Endo $ \x ->
987− x {L.method = httpMethodName (Proxy :: Proxy method)}
738+ x { L.method = httpMethodName (Proxy :: Proxy method) }
989----------------------------------------------------------------------------
740----------------------------------------------------------------------------
990-- Request—URL
741-- Request—URL
@@ -992,7 +743,7 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
994-- We use 'Url's which are correct by construction, see 'Url'. To build a
745-- 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'.
746+-- 'Url' from a 'ByteString', use 'parseUrlHttp' or 'parseUrlHttps'.
997-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
748-- | Request's 'Url'. Start constructing your 'Url' with 'http' or 'https'
998-- specifying the scheme and host at the same time. Then use the @('/~')@
749-- specifying the scheme and host at the same time. Then use the @('/~')@
@@ -1022,194 +773,91 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1023-- > https "юникод.рф"
774-- > https "юникод.рф"
1024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
775-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
777data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026 -- NOTE The second value is the path segments in reversed order.
778 -- NOTE The second value is the path segments in reversed order.
1027− deriving (Eq, Ord, Show, Data, Generic)
779+ 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
781+-- | Given host name, produce a 'Url' which have “http” as its scheme and
1043-- empty path. This also sets port to @80@.
782-- empty path. This also sets port to @80@.
1044http :: Text -> Url 'Http
784http :: Text -> Url 'Http
1045http = Url Http . pure
785http = Url Http . pure
1047−-- | Given host name, produce a 'Url' which has “https” as its scheme and
787+-- | Given host name, produce a 'Url' which have “https” as its scheme and
1048-- empty path. This also sets port to @443@.
788-- empty path. This also sets port to @443@.
1049https :: Text -> Url 'Https
790https :: Text -> Url 'Https
1050https = Url Https . pure
791https = Url Https . pure
1052−-- | Grow a given 'Url' appending a single path segment to it. Note that the
793+-- | 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'.
794-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
797+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
798Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1059−-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
800+-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1060−-- when next URL piece is a 'Data.Text.Text' literal.
801+-- when next URL piece is a 'Text' literal.
1063(/:) :: Url scheme -> Text -> Url scheme
804(/:) :: Url scheme -> Text -> Url scheme
1064(/:) = (/~)
805(/:) = (/~)
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'
807+-- | 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
808+-- (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.
809+-- you are given a URL to query dynamically and don't know it beforehand.
1082−--
810+-- 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.
811+-- represent a URL, as 'Url' cannot contain characters outside of ASCII
1084−--
812+-- range, thus we can consider every character a 'Data.Word.Word8' value.
1085−-- @since 3.0.0
813+--
814+-- This function only parses 'Url' (scheme, host, path) and optional query
815+-- parameters that are returned as 'Option'. It does not parse method name
816+-- or authentication info from given 'ByteString'.
1086−useHttpURI :: URI -> Maybe (Url 'Http, Option scheme)
818+parseUrlHttp :: ByteString -> Maybe (Url 'Http, Option scheme)
1087−useHttpURI uri = do
819+parseUrlHttp url' = do
1088− guard (URI.uriScheme uri == Just [QQ.scheme|http|])
820+ url <- B.stripPrefix "http://" url'
1089− urlHead <- http <$> uriHost uri
821+ (host :| path, option) <- parseUrlHelper url
1090− let url = case URI.uriPath uri of
822+ return (foldl (/:) (http host) path, option)
1091− Nothing -> urlHead
823+
1092− Just uriPath -> uriPathToUrl uriPath urlHead
1093− return (url, uriOptions uri)
1095−-- | Just like 'useHttpURI', but expects the “https” scheme.
824+-- | Just like 'parseUrlHttp', but expects “https” scheme.
1098−useHttpsURI :: URI -> Maybe (Url 'Https, Option scheme)
826+parseUrlHttps :: ByteString -> Maybe (Url 'Https, Option scheme)
1099−useHttpsURI uri = do
827+parseUrlHttps url' = do
1100− guard (URI.uriScheme uri == Just [QQ.scheme|https|])
828+ url <- B.stripPrefix "https://" url'
1101− urlHead <- https <$> uriHost uri
829+ (host :| path, option) <- parseUrlHelper url
1102− let url = case URI.uriPath uri of
830+ return (foldl (/:) (https host) path, option)
1103− Nothing -> urlHead
831+
1104− Just uriPath -> uriPathToUrl uriPath urlHead
832+-- | Get host\/collection of path pieces and possibly query parameters
1105− return (url, uriOptions uri)
833+-- already converted to 'Option'. This function is not public.
1107−-- | Convert URI path to a 'Url'. Internal.
835+parseUrlHelper :: ByteString -> Maybe (NonEmpty Text, Option scheme)
1108−--
836+parseUrlHelper url = do
1109−-- @since 3.9.0
837+ let (path', query') = B.break (== 0x3f) url
1110−uriPathToUrl ::
838+ query = mconcat (uncurry queryParam <$> Y.parseQueryText query')
1111− (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
839+ p' :| ps <- NE.nonEmpty (Y.decodePathSegments path')
1112− Url scheme ->
840+ (p, port') <-
1113− Url scheme
841+ case T.break (== ':') p' of
1114−uriPathToUrl (trailingSlash, xs) urlHead =
842+ (x, "") -> return (x, mempty)
1115− if trailingSlash then path /: T.empty else path
843+ (x, prt) ->
1116− where
844+ case TR.decimal (T.drop 1 prt) of
1117− path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
845+ Right (prt',"") -> return (x, port prt')
1119−-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
847+ return (p :| ps, query <> port')
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
849instance RequestComponent (Url scheme) where
1200 getRequestMod (Url scheme segments) = Endo $ \x ->
850 getRequestMod (Url scheme segments) = Endo $ \x ->
1201− let (host :| path) = NE.reverse segments
851+ let (host :| path) = NE.reverse segments in
1203− { L.secure = case scheme of
852+ x { L.secure = case scheme of
1204− Http -> False
853+ Http -> False
1205− Https -> True,
854+ Https -> True
1206− L.port = case scheme of
855+ , L.port = case scheme of
1207− Http -> 80
856+ Http -> 80
1208− Https -> 443,
857+ Https -> 443
1209− L.host = Y.urlEncode False (T.encodeUtf8 host),
858+ , L.host = Y.urlEncode False (T.encodeUtf8 host)
1210− L.path =
859+ , L.path =
1211− (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path
860+ (BL.toStrict . BB.toLazyByteString . Y.encodePathSegments) path }
1214----------------------------------------------------------------------------
862----------------------------------------------------------------------------
1215-- Request—Body
863-- Request—Body
@@ -1218,37 +866,39 @@ instance RequestComponent (Url scheme) where
1219-- A number of options for request bodies are available. The @Content-Type@
867-- 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
868-- header is set for you automatically according to the body option you use
1221−-- (it's always specified in the documentation for a given body option). To
869+-- (it's always specified in documentation for a given body option). To add
1222−-- add your own way to represent request body, define an instance of
870+-- your own way to represent request body, see 'HttpBody'.
1225-- | This data type represents empty body of an HTTP request. This is the
872-- | 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
873-- data type to use with 'HttpMethod's that cannot have a body, as it's the
1227-- only type for which 'ProvidesBody' returns 'NoBody'.
874-- only type for which 'ProvidesBody' returns 'NoBody'.
1229-- Using of this body option does not set the @Content-Type@ header.
876-- Using of this body option does not set the @Content-Type@ header.
1230data NoReqBody = NoReqBody
878data NoReqBody = NoReqBody
1232instance HttpBody NoReqBody where
880instance HttpBody NoReqBody where
1233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
881 getRequestBody NoReqBody = L.RequestBodyBS B.empty
1235−-- | This body option allows us to use a JSON object as the request
883+-- | 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
884+-- 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
885+-- instance of 'ToJSON' type class and you are done: it will be converted to
1238−-- converted to JSON and inserted as request body.
886+-- JSON and inserted as request body.
1240-- This body option sets the @Content-Type@ header to @\"application/json;
888-- This body option sets the @Content-Type@ header to @\"application/json;
1241-- charset=utf-8\"@ value.
889-- charset=utf-8\"@ value.
1242newtype ReqBodyJson a = ReqBodyJson a
891newtype ReqBodyJson a = ReqBodyJson a
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
893+instance ToJSON a => HttpBody (ReqBodyJson a) where
1245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
894 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1246 getRequestContentType _ = pure "application/json; charset=utf-8"
895 getRequestContentType _ = pure "application/json; charset=utf-8"
1248-- | This body option streams request body from a file. It is expected that
897-- | This body option streams request body from a file. It is expected that
1249−-- the file size does not change during streaming.
898+-- the file size does not change during the streaming.
1251-- Using of this body option does not set the @Content-Type@ header.
900-- Using of this body option does not set the @Content-Type@ header.
1252newtype ReqBodyFile = ReqBodyFile FilePath
902newtype ReqBodyFile = ReqBodyFile FilePath
1254instance HttpBody ReqBodyFile where
904instance HttpBody ReqBodyFile where
@@ -1258,6 +908,7 @@ instance HttpBody ReqBodyFile where
1258-- | HTTP request body represented by a strict 'ByteString'.
908-- | HTTP request body represented by a strict 'ByteString'.
1260-- Using of this body option does not set the @Content-Type@ header.
910-- Using of this body option does not set the @Content-Type@ header.
1261newtype ReqBodyBs = ReqBodyBs ByteString
912newtype ReqBodyBs = ReqBodyBs ByteString
1263instance HttpBody ReqBodyBs where
914instance HttpBody ReqBodyBs where
@@ -1266,19 +917,22 @@ instance HttpBody ReqBodyBs where
1266-- | HTTP request body represented by a lazy 'BL.ByteString'.
917-- | HTTP request body represented by a lazy 'BL.ByteString'.
1268-- Using of this body option does not set the @Content-Type@ header.
919-- Using of this body option does not set the @Content-Type@ header.
1269newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
921newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
1271instance HttpBody ReqBodyLbs where
923instance HttpBody ReqBodyLbs where
1272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
924 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
1274−-- | URL-encoded body. This can hold a collection of parameters which are
926+-- | 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
927+-- 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
928+-- 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
929+-- similarity is reflected in the API as well, as you can use the same
1278−-- would use to add query parameters: @('=:')@ and 'queryFlag'.
930+-- combinators you would use to add query parameters: @('=:')@ and
1280-- This body option sets the @Content-Type@ header to
933-- This body option sets the @Content-Type@ header to
1281−-- @\"application/x-www-form-urlencoded\"@ value.
934+-- @\"application/x-www-from-urlencoded\"@ value.
1282newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
936newtype ReqBodyUrlEnc = ReqBodyUrlEnc FormUrlEncodedParam
1284instance HttpBody ReqBodyUrlEnc where
938instance HttpBody ReqBodyUrlEnc where
@@ -1288,37 +942,33 @@ instance HttpBody ReqBodyUrlEnc where
1289-- | An opaque monoidal value that allows to collect URL-encoded parameters
943-- | An opaque monoidal value that allows to collect URL-encoded parameters
1290-- to be wrapped in 'ReqBodyUrlEnc'.
944-- to be wrapped in 'ReqBodyUrlEnc'.
1291newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
946newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
1292 deriving (Semigroup, Monoid)
947 deriving (Semigroup, Monoid)
1294instance QueryParam FormUrlEncodedParam where
949instance QueryParam FormUrlEncodedParam where
1295 queryParam name mvalue =
950 queryParam name mvalue =
1296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
951 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
953-- | Multipart form data. Please consult the
1306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
954-- "Network.HTTP.Client.MultipartFormData" module for how to construct
1307-- parts, then use 'reqBodyMultipart' to create actual request body from the
955-- 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
956+-- parts. 'reqBodyMultipart' is the only way to get a value of type
1309-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
957-- 'ReqBodyMultipart', as its constructor is not exported on purpose.
1311-- @since 0.2.0
959-- @since 0.2.0
1313−-- ==== __Examples__
961+-- ==== __Example__
1315−-- > import Control.Monad.IO.Class
963+-- > import Control.Exception (throwIO)
1316−-- > import Data.Default.Class
1317−-- > import Network.HTTP.Req
1318-- > import qualified Network.HTTP.Client.MultipartFormData as LM
964-- > import qualified Network.HTTP.Client.MultipartFormData as LM
965+-- > import Network.HTTP.Req
967+-- > instance MonadHttp IO where
968+-- > handleHttpException = throwIO
1320-- > main :: IO ()
970-- > main :: IO ()
1321−-- > main = runReq def $ do
971+-- > main = do
1322-- > body <-
972-- > body <-
1323-- > reqBodyMultipart
973-- > reqBodyMultipart
1324-- > [ LM.partBS "title" "My Image"
974-- > [ LM.partBS "title" "My Image"
@@ -1329,7 +979,8 @@ instance FromForm FormUrlEncodedParam where
1329-- > body
979-- > body
1330-- > bsResponse
980-- > bsResponse
1331-- > mempty
981-- > mempty
1332−-- > liftIO $ print (responseBody response)
982+-- > print $ responseBody response
1333data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
984data ReqBodyMultipart = ReqBodyMultipart ByteString LI.RequestBody
1335instance HttpBody ReqBodyMultipart where
986instance HttpBody ReqBodyMultipart where
@@ -1340,117 +991,126 @@ instance HttpBody ReqBodyMultipart where
1340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
991-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1342-- @since 0.2.0
993-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
995+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1344reqBodyMultipart parts = liftIO $ do
996reqBodyMultipart parts = liftIO $ do
1345 boundary <- LM.webkitBoundary
997 boundary <- LM.webkitBoundary
1346− body <- LM.renderParts boundary parts
998+ body <- LM.renderParts boundary parts
1347 return (ReqBodyMultipart boundary body)
999 return (ReqBodyMultipart boundary body)
1349-- | A type class for things that can be interpreted as an HTTP
1001-- | A type class for things that can be interpreted as an HTTP
1350-- 'L.RequestBody'.
1002-- 'L.RequestBody'.
1351class HttpBody body where
1004class HttpBody body where
1006+ {-# MINIMAL getRequestBody #-}
1352 -- | How to get actual 'L.RequestBody'.
1008 -- | How to get actual 'L.RequestBody'.
1353 getRequestBody :: body -> L.RequestBody
1010 getRequestBody :: body -> L.RequestBody
1355− -- | This method allows us to optionally specify the value of
1012+ -- | This method allows to optionally specify value of @Content-Type@
1356− -- @Content-Type@ header that should be used with particular body option.
1013+ -- 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.
1014+ -- returns 'Nothing' and so @Content-Type@ is not set.
1358 getRequestContentType :: body -> Maybe ByteString
1016 getRequestContentType :: body -> Maybe ByteString
1359 getRequestContentType = const Nothing
1017 getRequestContentType = const Nothing
1361-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1019-- | The type function recognizes 'NoReqBody' as having 'NoBody', while any
1362−-- other body option 'CanHaveBody'. This forces the user to use 'NoReqBody'
1020+-- other body option 'CanHaveBody'. This forces user to use 'NoReqBody' with
1363−-- with 'GET' method and other methods that should not have body.
1021+-- 'GET' method and other methods that should not send a body.
1364type family ProvidesBody body :: CanHaveBody where
1023type family ProvidesBody body :: CanHaveBody where
1365 ProvidesBody NoReqBody = 'NoBody
1024 ProvidesBody NoReqBody = 'NoBody
1366− ProvidesBody body = 'CanHaveBody
1025+ ProvidesBody body = 'CanHaveBody
1368-- | This type function allows any HTTP body if method says it
1027-- | This type function allows any HTTP body if method says it
1369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
1028-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
1370-- body option to use is 'NoReqBody'.
1029-- body option to use is 'NoReqBody'.
1031+-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1032+-- error message when method does not allow a body and body is provided.
1372− HttpBodyAllowed
1034+type family HttpBodyAllowed
1373− (allowsBody :: CanHaveBody)
1035+ (allowsBody :: CanHaveBody)
1374− (providesBody :: CanHaveBody) ::
1036+ (providesBody :: CanHaveBody) :: Constraint where
1377− HttpBodyAllowed 'NoBody 'NoBody = ()
1037+ HttpBodyAllowed 'NoBody 'NoBody = ()
1378− HttpBodyAllowed 'CanHaveBody body = ()
1038+ HttpBodyAllowed 'CanHaveBody body = ()
1039+#if MIN_VERSION_base(4,9,0)
1379− HttpBodyAllowed 'NoBody 'CanHaveBody =
1040+ HttpBodyAllowed 'NoBody 'CanHaveBody = TypeError
1381− ('Text "This HTTP method does not allow attaching a request body.")
1041+ ('Text "This HTTP method does not allow attaching a request body.")
1383−instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1044+instance HttpBody body => RequestComponent (Womb "body" body) where
1384− getRequestMod (Tagged body) = Endo $ \x ->
1045+ getRequestMod (Womb body) = Endo $ \x ->
1386− { L.requestBody = getRequestBody body,
1046+ x { L.requestBody = getRequestBody body
1387− L.requestHeaders =
1047+ , L.requestHeaders =
1388− let old = L.requestHeaders x
1048+ let old = L.requestHeaders x in
1389− in case getRequestContentType body of
1049+ case getRequestContentType body of
1390− Nothing -> old
1050+ Nothing -> old
1391− Just contentType ->
1051+ Just contentType ->
1392− (Y.hContentType, contentType) : old
1052+ (Y.hContentType, contentType) : old }
1395----------------------------------------------------------------------------
1054----------------------------------------------------------------------------
1396-- Request—Optional parameters
1055-- Request—Optional parameters
1398-- $optional-parameters
1057-- $optional-parameters
1400−-- Optional parameters of request include things like query parameters,
1059+-- Optional parameters to a request include things like query parameters,
1401-- headers, port number, etc. All optional parameters have the type
1060-- headers, port number, etc. All optional parameters have the type
1402-- 'Option', which is a 'Monoid'. This means that you can use 'mempty' as
1061-- '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
1062-- 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.
1063+-- '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
1065+-- | Opaque 'Option' type is a 'Monoid' you can use to pack collection of
1407−-- of optional parameters like query parameters and headers. See sections
1066+-- optional parameters like query parameters and headers. See sections below
1408−-- below to learn which 'Option' primitives are available.
1067+-- 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))
1069+data Option (scheme :: Scheme) =
1070+ 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
1071+ -- 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
1072+ -- Request to avoid appending to existing query string in request every
1414−-- time new parameter is added. The additional Maybe (L.Request -> IO
1073+ -- time new parameter is added. Additional Maybe (L.Request -> IO
1415−-- L.Request) is a finalizer that will be applied after all other
1074+ -- L.Request) is a finalizer that will be applied after all other
1416−-- transformations. This is for authentication methods that sign requests
1075+ -- transformations. This is for authentication methods that sign requests
1417−-- based on data in Request.
1076+ -- based on data in Request.
1419instance Semigroup (Option scheme) where
1078instance Semigroup (Option scheme) where
1420− Option er0 mr0 <> Option er1 mr1 =
1079+ Option er0 mr0 <> Option er1 mr1 = Option
1422− (er0 <> er1)
1080+ (er0 <> er1) (mr0 <|> mr1)
1425instance Monoid (Option scheme) where
1082instance Monoid (Option scheme) where
1426− mempty = Option mempty Nothing
1083+ mempty = Option mempty Nothing
1427 mappend = (<>)
1084 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
1086-- | A helper to create an 'Option' that modifies only collection of query
1436-- parameters. This helper is not a part of the public API.
1087-- parameters. This helper is not a part of the public API.
1437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1089withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1438withQueryParams f = Option (Endo (first f)) Nothing
1090withQueryParams f = Option (Endo (first f)) Nothing
1440-- | A helper to create an 'Option' that modifies only 'L.Request'. This
1092-- | A helper to create an 'Option' that modifies only 'L.Request'. This
1441-- helper is not a part of public API.
1093-- helper is not a part of public API.
1442withRequest :: (L.Request -> L.Request) -> Option scheme
1095withRequest :: (L.Request -> L.Request) -> Option scheme
1443withRequest f = Option (Endo (second f)) Nothing
1096withRequest f = Option (Endo (second f)) Nothing
1098+-- | A helper to create an 'Option' that adds a finalizer (request
1099+-- transformation that is applied after all other modifications).
1101+asFinalizer :: (L.Request -> IO L.Request) -> Option scheme
1102+asFinalizer = Option mempty . pure
1445instance RequestComponent (Option scheme) where
1104instance RequestComponent (Option scheme) where
1446 getRequestMod (Option f _) = Endo $ \x ->
1105 getRequestMod (Option f _) = Endo $ \x ->
1447 let (qparams, x') = appEndo f ([], x)
1106 let (qparams, x') = appEndo f ([], x)
1448− query = Y.renderQuery True (Y.queryTextToQuery qparams)
1107+ query = Y.renderQuery True (Y.queryTextToQuery qparams)
1449− in x' {L.queryString = query}
1108+ in x' { L.queryString = query }
1451-- | Finalize given 'L.Request' by applying a finalizer from the given
1110-- | Finalize given 'L.Request' by applying a finalizer from the given
1452-- 'Option' (if it has any).
1111-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1113+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1114finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1456----------------------------------------------------------------------------
1116----------------------------------------------------------------------------
@@ -1463,67 +1123,47 @@ finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1463-- bodies (of the type 'FormUrlEncodedParam').
1123-- bodies (of the type 'FormUrlEncodedParam').
1465-- | This operator builds a query parameter that will be included in URL of
1125-- | 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
1126+-- your request after question sign @?@. This is the same syntax you use
1467-- with form URL encoded request bodies.
1127-- with form URL encoded request bodies.
1469-- This operator is defined in terms of 'queryParam':
1129-- This operator is defined in terms of 'queryParam':
1471-- > name =: value = queryParam name (pure value)
1131-- > name =: value = queryParam name (pure value)
1474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
1134(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
1475name =: value = queryParam name (pure value)
1135name =: value = queryParam name (pure value)
1477−-- | Construct a flag, that is, a valueless query parameter. For example, in
1137+-- | 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
1138+-- the following URL @a@ is a flag, while @b@ is a query parameter with a
1479−-- with a value:
1139+-- value:
1481-- > https://httpbin.org/foo/bar?a&b=10
1141-- > https://httpbin.org/foo/bar?a&b=10
1483-- This operator is defined in terms of 'queryParam':
1143-- This operator is defined in terms of 'queryParam':
1485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1145-- > queryFlag name = queryParam name (Nothing :: Maybe ())
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
1147+queryFlag :: QueryParam param => Text -> param
1499−formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1148+queryFlag name = queryParam name (Nothing :: Maybe ())
1501− toParam (key, val) =
1507-- | A type class for query-parameter-like things. The reason to have an
1150-- | A type class for query-parameter-like things. The reason to have an
1508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1151-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1152-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1510-- Having the same syntax for these cases seems natural and user-friendly.
1153-- Having the same syntax for these cases seems natural and user-friendly.
1511class QueryParam param where
1155class QueryParam param where
1512 -- | Create a query parameter with given name and value. If value is
1157 -- | 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
1158 -- '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
1159 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1515 -- method, because they are easier to read.
1160 -- 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'.
1162+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1521− queryParamToList :: param -> [(Text, Maybe Text)]
1523instance QueryParam (Option scheme) where
1164instance QueryParam (Option scheme) where
1524 queryParam name mvalue =
1165 queryParam name mvalue =
1525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1166 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
1528----------------------------------------------------------------------------
1168----------------------------------------------------------------------------
1529-- Request—Optional parameters—Headers
1169-- Request—Optional parameters—Headers
@@ -1532,28 +1172,19 @@ instance QueryParam (Option scheme) where
1532-- headers with the same names the leftmost header will win. This means, in
1172-- 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
1173-- particular, that you cannot create a request with several headers of the
1534-- same name.
1174-- same name.
1535−header ::
1176+header
1536− -- | Header name
1177+ :: ByteString -- ^ Header name
1538− -- | Header value
1178+ -> ByteString -- ^ Header value
1540− Option scheme
1179+ -> Option scheme
1541header name value = withRequest (attachHeader name value)
1180header name value = withRequest (attachHeader name value)
1543−-- | Attach a header with given name and content to a 'L.Request'.
1182+-- | A non-public helper that attaches a header with given name and content
1544−--
1183+-- to a 'L.Request'.
1545−-- @since 1.1.0
1184+
1546attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1185attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1547attachHeader name value x =
1186attachHeader name value x =
1548− x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1187+ 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----------------------------------------------------------------------------
1189----------------------------------------------------------------------------
1559-- Request—Optional parameters—Cookies
1190-- Request—Optional parameters—Cookies
@@ -1566,9 +1197,10 @@ headerRedacted name value = withRequest $ \x ->
1567-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
1198-- | Use the given 'L.CookieJar'. A 'L.CookieJar' can be obtained from a
1568-- 'L.Response' record.
1199-- 'L.Response' record.
1569cookieJar :: L.CookieJar -> Option scheme
1201cookieJar :: L.CookieJar -> Option scheme
1570cookieJar jar = withRequest $ \x ->
1202cookieJar jar = withRequest $ \x ->
1571− x {L.cookieJar = Just jar}
1203+ x { L.cookieJar = Just jar }
1573----------------------------------------------------------------------------
1205----------------------------------------------------------------------------
1574-- Request—Optional parameters—Authentication
1206-- Request—Optional parameters—Authentication
@@ -1586,66 +1218,42 @@ cookieJar jar = withRequest $ \x ->
1586-- | The 'Option' adds basic authentication.
1218-- | The 'Option' adds basic authentication.
1588-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1220-- See also: <https://en.wikipedia.org/wiki/Basic_access_authentication>.
1589−basicAuth ::
1222+basicAuth
1590− -- | Username
1223+ :: ByteString -- ^ Username
1592− -- | Password
1224+ -> ByteString -- ^ Password
1595− Option 'Https
1225+ -> Option 'Https -- ^ Auth 'Option'
1596basicAuth = basicAuthUnsafe
1226basicAuth = basicAuthUnsafe
1598-- | An alternative to 'basicAuth' which works for any scheme. Note that
1228-- | An alternative to 'basicAuth' which works for any scheme. Note that
1599−-- using basic access authentication without SSL\/TLS is vulnerable to
1229+-- using basic access authentication without SSL/TLS is vulnerable to
1600-- attacks. Use 'basicAuth' instead unless you know what you are doing.
1230-- attacks. Use 'basicAuth' instead unless you know what you are doing.
1602-- @since 0.3.1
1232-- @since 0.3.1
1603−basicAuthUnsafe ::
1234+basicAuthUnsafe
1604− -- | Username
1235+ :: ByteString -- ^ Username
1606− -- | Password
1236+ -> ByteString -- ^ Password
1608− -- | Auth 'Option'
1237+ -> Option scheme -- ^ Auth 'Option'
1610−basicAuthUnsafe username password =
1238+basicAuthUnsafe username password = asFinalizer
1612− (pure . L.applyBasicAuth username password)
1239+ (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.
1241-- | The 'Option' adds OAuth1 authentication.
1629-- @since 0.2.0
1243-- @since 0.2.0
1630−oAuth1 ::
1245+oAuth1
1631− -- | Consumer token
1246+ :: ByteString -- ^ Consumer token
1633− -- | Consumer secret
1247+ -> ByteString -- ^ Consumer secret
1634− ByteString ->
1248+ -> ByteString -- ^ OAuth token
1637− -- | OAuth token secret
1249+ -> ByteString -- ^ OAuth token secret
1640− Option scheme
1250+ -> Option scheme -- ^ Auth 'Option'
1641oAuth1 consumerToken consumerSecret token tokenSecret =
1251oAuth1 consumerToken consumerSecret token tokenSecret =
1642− customAuth (OAuth.signOAuth app creds)
1252+ asFinalizer (OAuth.signOAuth app creds)
1645− OAuth.newOAuth
1254+ app = OAuth.newOAuth
1646− { OAuth.oauthConsumerKey = consumerToken,
1255+ { OAuth.oauthConsumerKey = consumerToken
1647− OAuth.oauthConsumerSecret = consumerSecret
1256+ , OAuth.oauthConsumerSecret = consumerSecret }
1649 creds = OAuth.newCredential token tokenSecret
1257 creds = OAuth.newCredential token tokenSecret
1651-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
1259-- | The 'Option' adds an OAuth2 bearer token. This is treated by many
@@ -1656,14 +1264,12 @@ oAuth1 consumerToken consumerSecret token tokenSecret =
1656-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1264-- > oAuth2Bearer token = header "Authorization" ("Bearer " <> token)
1658-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1266-- See also: <https://en.wikipedia.org/wiki/OAuth>.
1659−oAuth2Bearer ::
1268+oAuth2Bearer
1661− ByteString ->
1269+ :: ByteString -- ^ Token
1663− Option 'Https
1270+ -> Option 'Https -- ^ Auth 'Option'
1664−oAuth2Bearer token =
1271+oAuth2Bearer token = asFinalizer
1666− (pure . attachHeader "Authorization" ("Bearer " <> token))
1272+ (pure . attachHeader "Authorization" ("Bearer " <> token))
1668-- | The 'Option' adds a not-quite-standard OAuth2 bearer token (that seems
1274-- | 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
1275-- to be used only by GitHub). This will be treated by whatever services
@@ -1674,35 +1280,26 @@ oAuth2Bearer token =
1674-- > oAuth2Token token = header "Authorization" ("token" <> token)
1280-- > oAuth2Token token = header "Authorization" ("token" <> token)
1676-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1282-- See also: <https://developer.github.com/v3/oauth#3-use-the-access-token-to-access-the-api>.
1677−oAuth2Token ::
1284+oAuth2Token
1678− -- | Token
1285+ :: ByteString -- ^ Token
1681− Option 'Https
1286+ -> Option 'Https -- ^ Auth 'Option'
1682−oAuth2Token token =
1287+oAuth2Token token = asFinalizer
1684− (pure . attachHeader "Authorization" ("token " <> token))
1288+ (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----------------------------------------------------------------------------
1290----------------------------------------------------------------------------
1695-- Request—Optional parameters—Other
1291-- Request—Optional parameters—Other
1697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1293-- | Specify the port to connect to explicitly. Normally, 'Url' you use
1698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1294-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1699−-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1295+-- 'Option' allows to choose arbitrary port overwriting the defaults.
1700port :: Int -> Option scheme
1297port :: Int -> Option scheme
1701port n = withRequest $ \x ->
1298port n = withRequest $ \x ->
1702− x {L.port = n}
1299+ x { L.port = n }
1704-- | This 'Option' controls whether gzipped data should be decompressed on
1301-- | This 'Option' controls whether gzipped data should be decompressed on
1705−-- the fly. By default everything except for @\"application\/x-tar\"@ is
1302+-- the fly. By default everything except for @application\/x-tar@ is
1706-- decompressed, i.e. we have:
1303-- decompressed, i.e. we have:
1708-- > decompress (/= "application/x-tar")
1305-- > decompress (/= "application/x-tar")
@@ -1710,212 +1307,163 @@ port n = withRequest $ \x ->
1710-- You can also choose to decompress everything like this:
1307-- You can also choose to decompress everything like this:
1712-- > decompress (const True)
1309-- > decompress (const True)
1713−decompress ::
1311+decompress
1714− -- | Predicate that is given MIME type, it returns 'True' when content
1312+ :: (ByteString -> Bool) -- ^ Predicate that is given MIME type, it
1715− -- should be decompressed on the fly.
1313+ -- returns 'True' when content should be decompressed on the fly.
1716− (ByteString -> Bool) ->
1717− Option scheme
1314+ -> Option scheme
1718decompress f = withRequest $ \x ->
1315decompress f = withRequest $ \x ->
1719− x {L.decompress = f}
1316+ x { L.decompress = f }
1721-- | Specify the number of microseconds to wait for response. The default
1318-- | Specify the number of microseconds to wait for response. The default
1722−-- value is 30 seconds (defined in 'L.ManagerSettings' of connection
1319+-- value is 30 seconds.
1723−-- 'L.Manager').
1320+
1724−responseTimeout ::
1321+responseTimeout
1725− -- | Number of microseconds to wait
1322+ :: Int -- ^ Number of microseconds to wait
1727− Option scheme
1323+ -> Option scheme
1728responseTimeout n = withRequest $ \x ->
1324responseTimeout n = withRequest $ \x ->
1729− x {L.responseTimeout = LI.ResponseTimeoutMicro n}
1325+ x { L.responseTimeout = LI.ResponseTimeoutMicro n }
1731-- | HTTP version to send to the server, the default is HTTP 1.1.
1327-- | HTTP version to send to the server, the default is HTTP 1.1.
1732−httpVersion ::
1329+httpVersion
1733− -- | Major version number
1330+ :: Int -- ^ Major version number
1735− -- | Minor version number
1331+ -> Int -- ^ Minor version number
1737− Option scheme
1332+ -> Option scheme
1738httpVersion major minor = withRequest $ \x ->
1333httpVersion major minor = withRequest $ \x ->
1739− x {L.requestVersion = Y.HttpVersion major minor}
1334+ x { L.requestVersion = Y.HttpVersion major minor }
1741----------------------------------------------------------------------------
1336----------------------------------------------------------------------------
1742-- Response interpretations
1337-- Response interpretations
1744−-- | Make a request and ignore the body of the response.
1339+-- | Make a request and ignore body of response.
1745−newtype IgnoreResponse = IgnoreResponse (L.Response ())
1341+data IgnoreResponse = IgnoreResponse (L.Response ())
1748instance HttpResponse IgnoreResponse where
1343instance HttpResponse IgnoreResponse where
1749 type HttpResponseBody IgnoreResponse = ()
1344 type HttpResponseBody IgnoreResponse = ()
1750− toVanillaResponse (IgnoreResponse r) = r
1345+ toVanillaResponse (IgnoreResponse response) = response
1751− getHttpResponse r = return $ IgnoreResponse (void r)
1346+ getHttpResponse request manager =
1347+ IgnoreResponse <$> liftIO (L.httpNoBody request manager)
1348+ makeResponseBodyPreview _ = return "<ignored response>"
1753-- | Use this as the fourth argument of 'req' to specify that you want it to
1350-- | Use this as the fourth argument of 'req' to specify that you want it to
1754−-- ignore the response body.
1351+-- return the 'IgnoreResponse' interpretation.
1755ignoreResponse :: Proxy IgnoreResponse
1353ignoreResponse :: Proxy IgnoreResponse
1756ignoreResponse = Proxy
1354ignoreResponse = Proxy
1758−-- | Make a request and interpret the body of the response as JSON. The
1356+-- | Make a request and interpret body of response as JSON. The
1759-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1357-- 'handleHttpException' method of 'MonadHttp' instance corresponding to
1760-- monad in which you use 'req' will determine what to do in the case when
1358-- monad in which you use 'req' will determine what to do in the case when
1761-- parsing fails (the 'JsonHttpException' constructor will be used).
1359-- parsing fails (the 'JsonHttpException' constructor will be used).
1762−newtype JsonResponse a = JsonResponse (L.Response a)
1361+data JsonResponse a = JsonResponse (L.Response a) ByteString
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1363+instance FromJSON a => HttpResponse (JsonResponse a) where
1766 type HttpResponseBody (JsonResponse a) = a
1364 type HttpResponseBody (JsonResponse a) = a
1767− toVanillaResponse (JsonResponse r) = r
1365+ toVanillaResponse (JsonResponse response _) = response
1768− getHttpResponse r = do
1366+ getHttpResponse request manager = do
1769− chunks <- L.brConsume (L.responseBody r)
1367+ response <- L.httpLbs request manager
1770− case A.eitherDecode (BL.fromChunks chunks) of
1368+ case A.eitherDecode (L.responseBody response) of
1771 Left e -> throwIO (JsonHttpException e)
1369 Left e -> throwIO (JsonHttpException e)
1373+ . BL.take bodyPreviewLength
1772− Right x -> return $ JsonResponse (x <$ r)
1376+ return $ JsonResponse response { L.responseBody = x } preview
1773− acceptHeader Proxy = Just "application/json"
1377+ makeResponseBodyPreview (JsonResponse _ preview) = return preview
1775−-- | Use this as the fourth argument of 'req' to specify that you want it to
1379+-- | Use this as the forth argument of 'req' to specify that you want it to
1776-- return the 'JsonResponse' interpretation.
1380-- return the 'JsonResponse' interpretation.
1777jsonResponse :: Proxy (JsonResponse a)
1382jsonResponse :: Proxy (JsonResponse a)
1778jsonResponse = Proxy
1383jsonResponse = Proxy
1780−-- | Make a request and interpret the body of the response as a strict
1385+-- | Make a request and interpret body of response as a strict 'ByteString'.
1781−-- 'ByteString'.
1386+
1782newtype BsResponse = BsResponse (L.Response ByteString)
1387newtype BsResponse = BsResponse (L.Response ByteString)
1785instance HttpResponse BsResponse where
1389instance HttpResponse BsResponse where
1786 type HttpResponseBody BsResponse = ByteString
1390 type HttpResponseBody BsResponse = ByteString
1787− toVanillaResponse (BsResponse r) = r
1391+ toVanillaResponse (BsResponse response) = response
1788− getHttpResponse r = do
1392+ getHttpResponse request manager =
1393+ L.withResponse request manager $ \response -> do
1789− chunks <- L.brConsume (L.responseBody r)
1394+ chunks <- L.brConsume (L.responseBody response)
1790− return $ BsResponse (B.concat chunks <$ r)
1395+ return $ BsResponse response { L.responseBody = B.concat chunks }
1396+ makeResponseBodyPreview = return . B.take bodyPreviewLength . responseBody
1398+-- | Use this as the forth argument of 'req' to specify that you want to
1399+-- 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
1401bsResponse :: Proxy BsResponse
1795bsResponse = Proxy
1402bsResponse = Proxy
1797−-- | Make a request and interpret the body of the response as a lazy
1404+-- | Make a request and interpret body of response as a lazy
1798-- 'BL.ByteString'.
1405-- 'BL.ByteString'.
1799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1407newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1802instance HttpResponse LbsResponse where
1409instance HttpResponse LbsResponse where
1803 type HttpResponseBody LbsResponse = BL.ByteString
1410 type HttpResponseBody LbsResponse = BL.ByteString
1804− toVanillaResponse (LbsResponse r) = r
1411+ toVanillaResponse (LbsResponse response) = response
1805− getHttpResponse r = do
1412+ getHttpResponse request manager =
1806− chunks <- L.brConsume (L.responseBody r)
1413+ LbsResponse <$> L.httpLbs request manager
1807− return $ LbsResponse (BL.fromChunks chunks <$ r)
1414+ makeResponseBodyPreview = return . BL.toStrict . BL.take 1027 . responseBody
1416+-- | Use this as the forth argument of 'req' to specify that you want to
1417+-- 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
1419lbsResponse :: Proxy LbsResponse
1812lbsResponse = Proxy
1420lbsResponse = Proxy
1814−----------------------------------------------------------------------------
1815−-- Helpers for response interpretations
1817−-- | Fetch beginning of the response and return it together with a new
1818−-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
1821− -- | How many bytes to fetch
1823− -- | Response with body reader inside
1824− L.Response L.BodyReader ->
1825− -- | Preview 'ByteString' and new response with body reader inside
1826− IO (ByteString, L.Response L.BodyReader)
1827−grabPreview nbytes r = do
1828− let br = L.responseBody r
1829− (target, leftover, done) <- brReadN br nbytes
1830− nref <- newIORef (0 :: Int)
1832− n <- readIORef nref
1833− let incn = modifyIORef' nref (+ 1)
1844− else return leftover
1847− then return B.empty
1849− return (target, r {L.responseBody = br'})
1851−-- | Consume N bytes from 'L.BodyReader', return the target chunk, the
1852−-- leftover (may be empty), and whether we're done consuming the body.
1854− -- | Body reader to stream from
1856− -- | How many bytes to consume
1858− -- | Target chunk, the leftover, whether we're done
1859− IO (ByteString, ByteString, Bool)
1860−brReadN br n = go 0 id id
1865− then return (r t, r l, True)
1867− let (target, leftover) = B.splitAt (n - tlen) chunk
1868− tlen' = B.length target
1869− t' = t . (target :)
1870− l' = l . (leftover :)
1871− if tlen + tlen' < n
1872− then go (tlen + tlen') t' l'
1873− else return (r t', r l', False)
1874− r f = B.concat (f [])
1876----------------------------------------------------------------------------
1422----------------------------------------------------------------------------
1877-- Inspecting a response
1423-- Inspecting a response
1879-- | Get the response body.
1425-- | Get the response body.
1880−responseBody ::
1427+responseBody
1881− (HttpResponse response) =>
1428+ :: HttpResponse response
1882− response ->
1429+ => response
1883− HttpResponseBody response
1430+ -> HttpResponseBody response
1884responseBody = L.responseBody . toVanillaResponse
1431responseBody = L.responseBody . toVanillaResponse
1886-- | Get the response status code.
1433-- | Get the response status code.
1887−responseStatusCode ::
1435+responseStatusCode
1888− (HttpResponse response) =>
1436+ :: HttpResponse response
1889− response ->
1437+ => response
1891responseStatusCode =
1439responseStatusCode =
1892 Y.statusCode . L.responseStatus . toVanillaResponse
1440 Y.statusCode . L.responseStatus . toVanillaResponse
1894-- | Get the response status message.
1442-- | Get the response status message.
1895−responseStatusMessage ::
1444+responseStatusMessage
1896− (HttpResponse response) =>
1445+ :: HttpResponse response
1897− response ->
1446+ => response
1898− ByteString
1447+ -> ByteString
1899responseStatusMessage =
1448responseStatusMessage =
1900 Y.statusMessage . L.responseStatus . toVanillaResponse
1449 Y.statusMessage . L.responseStatus . toVanillaResponse
1902-- | Lookup a particular header from a response.
1451-- | Lookup a particular header from a response.
1903−responseHeader ::
1453+responseHeader
1904− (HttpResponse response) =>
1454+ :: HttpResponse response
1905− -- | Response interpretation
1455+ => response -- ^ Response interpretation
1907− -- | Header to lookup
1456+ -> ByteString -- ^ Header to lookup
1909− -- | Header value if found
1457+ -> Maybe ByteString -- ^ Header value if found
1911responseHeader r h =
1458responseHeader r h =
1912 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1459 (lookup (CI.mk h) . L.responseHeaders . toVanillaResponse) r
1914-- | Get the response 'L.CookieJar'.
1461-- | Get the response 'L.CookieJar'.
1915−responseCookieJar ::
1463+responseCookieJar
1916− (HttpResponse response) =>
1464+ :: HttpResponse response
1917− response ->
1465+ => response
1918− L.CookieJar
1466+ -> L.CookieJar
1919responseCookieJar = L.responseCookieJar . toVanillaResponse
1467responseCookieJar = L.responseCookieJar . toVanillaResponse
1921----------------------------------------------------------------------------
1469----------------------------------------------------------------------------
@@ -1924,58 +1472,34 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
1924-- $new-response-interpretation
1472-- $new-response-interpretation
1926-- To create a new response interpretation you just need to make your data
1474-- To create a new response interpretation you just need to make your data
1927−-- type an instance of the 'HttpResponse' type class.
1475+-- type an instance of 'HttpResponse' type class.
1477+-- | A type class for response interpretations. It allows to fully control
1478+-- 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
1480class HttpResponse response where
1933 -- | The associated type is the type of body that can be extracted from an
1482 -- | The associated type is the type of body that can be extracted from an
1934 -- instance of 'HttpResponse'.
1483 -- instance of 'HttpResponse'.
1935− type HttpResponseBody response :: Type
1485+ type HttpResponseBody response :: *
1937 -- | The method describes how to get the underlying 'L.Response' record.
1487 -- | The method describes how to get the underlying 'L.Response' record.
1938 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1489 toVanillaResponse :: response -> L.Response (HttpResponseBody response)
1940− -- | This method describes how to consume response body and, more
1491+ -- | This method describes how to make an HTTP request given 'L.Request'
1941− -- generally, obtain @response@ value from @'L.Response' 'L.BodyReader'@.
1492+ -- (prepared by the library) and 'L.Manager'.
1943− -- __Note__: 'L.BodyReader' is nothing but @'IO' 'ByteString'@. You should
1944− -- call this action repeatedly until it yields the empty 'ByteString'. In
1945− -- that case streaming of response is finished (which apparently leads to
1946− -- closing of the connection, so don't call the reader after it has
1947− -- returned the empty 'ByteString' once) and you can concatenate the
1948− -- chunks to obtain the final result. (Of course you could as well stream
1949− -- the contents to a file or do whatever you want.)
1951− -- __Note__: signature of this function was changed in the version
1953− getHttpResponse ::
1494+ getHttpResponse :: L.Request -> L.Manager -> IO response
1954− -- | Response with body reader inside
1495+
1955− L.Response L.BodyReader ->
1496+ -- | Construct a “preview” of response body. It is recommend to limit the
1956− -- | The final result
1497+ -- length to 1024 bytes. This is mainly useful for inclusion of response
1957− IO response
1498+ -- body fragments in exceptions.
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.
1966− -- @since 2.1.0
1500+ -- @since 0.3.0
1967− acceptHeader :: Proxy response -> Maybe ByteString
1968− acceptHeader Proxy = Nothing
1970−-- | This instance has been added to make it easier to inspect 'L.Response'
1502+ makeResponseBodyPreview :: response -> IO ByteString
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----------------------------------------------------------------------------
1504----------------------------------------------------------------------------
@@ -1985,14 +1509,15 @@ instance HttpResponse (L.Response ()) where
1985-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1509-- 'RequestComponent' changing\/overwriting something in it. 'Endo' is a
1986-- monoid of endomorphisms under composition, it's used to chain different
1510-- monoid of endomorphisms under composition, it's used to chain different
1987-- request components easier using @('<>')@.
1511-- request components easier using @('<>')@.
1989−-- __Note__: this type class is not a part of the public API.
1990class RequestComponent a where
1513class RequestComponent a where
1991 -- | Get a function that takes a 'L.Request' and changes it somehow
1515 -- | Get a function that takes a 'L.Request' and changes it somehow
1992− -- returning another 'L.Request'. For example, the 'HttpMethod' instance
1516+ -- returning another 'L.Request'. For example HTTP method instance of
1993− -- of 'RequestComponent' just overwrites method. The function is wrapped
1517+ -- 'RequestComponent' just overwrites method. The function is wrapped in
1994− -- in 'Endo' so it's easier to chain such “modifying applications”
1518+ -- 'Endo' so it's easier to chain such “modifying applications” together
1995− -- together building bigger and bigger 'RequestComponent's.
1519+ -- building bigger and bigger 'RequestComponent's.
1996 getRequestMod :: a -> Endo L.Request
1521 getRequestMod :: a -> Endo L.Request
1998-- | This wrapper is only used to attach a type-level tag to a given type.
1523-- | This wrapper is only used to attach a type-level tag to a given type.
@@ -2002,50 +1527,42 @@ class RequestComponent a where
2002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
1527-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
2003-- which instance to use (i.e. the constraints are taken into account later,
1528-- which instance to use (i.e. the constraints are taken into account later,
2004-- when instance is already chosen).
1529-- when instance is already chosen).
2005−newtype Tagged (tag :: Symbol) a = Tagged a
1531+newtype Womb (tag :: Symbol) a = Womb a
2007-- | Exceptions that this library throws.
1533-- | Exceptions that this library throws.
2008data HttpException
1535data HttpException
1536+ = VanillaHttpException L.HttpException
2009− = -- | A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
1537+ -- ^ A wrapper with an 'L.HttpException' from "Network.HTTP.Client"
2010− VanillaHttpException L.HttpException
1538+ | JsonHttpException String
2011− | -- | A wrapper with Aeson-produced 'String' describing why decoding
1539+ -- ^ A wrapper with Aeson-produced 'String' describing why decoding failed
2013− JsonHttpException String
2014− deriving (Show, Generic)
1540+ deriving (Show, Typeable, Generic)
2016instance Exception HttpException
1542instance 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
1544+-- | 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
1545+-- use it as a kind and its data constructors as type-level tags.
2036-- See also: 'HttpMethod' and 'HttpBody'.
1547-- See also: 'HttpMethod' and 'HttpBody'.
2037data CanHaveBody
1549data CanHaveBody
2038− = -- | Indeed can have a body
1550+ = CanHaveBody -- ^ Indeed can have a body
2040− | -- | Should not have a body
1551+ | NoBody -- ^ Should not have a body
2043-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
1553-- | A type-level tag that specifies URL scheme used (and thus if HTTPS is
2044-- enabled). This is used to force TLS requirement for some authentication
1554-- enabled). This is used to force TLS requirement for some authentication
2045-- 'Option's.
1555-- 'Option's.
2046data Scheme
1557data Scheme
2047− = -- | HTTP
1558+ = Http -- ^ HTTP
2049− | -- | HTTPS
1559+ | Https -- ^ HTTPS
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1560+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
1562+----------------------------------------------------------------------------
1565+-- | Max length of preview fragment of response body.
1567+bodyPreviewLength :: Num a => a
1568+bodyPreviewLength = 1024