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