@@ -1,17 +1,10 @@
1−{-# LANGUAGE BangPatterns #-}
21{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7−{-# LANGUAGE KindSignatures #-}
82{-# LANGUAGE LambdaCase #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
103{-# LANGUAGE OverloadedStrings #-}
114{-# LANGUAGE QuasiQuotes #-}
12−{-# LANGUAGE RankNTypes #-}
135{-# LANGUAGE RecordWildCards #-}
14−{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE RoleAnnotations #-}
7+{-# LANGUAGE TemplateHaskellQuotes #-}
158{-# LANGUAGE TypeFamilies #-}
169{-# LANGUAGE UndecidableInstances #-}
1710
@@ -26,61 +19,40 @@
2619--
2720-- The documentation below is structured in such a way that the most
2821-- important information is presented first: you learn how to do HTTP
29−-- requests, how to embed them in any monad you have, and then it gives you
22+-- requests, how to embed them in the monad you have, and then it gives you
3023-- details about less-common things you may want to know about. The
3124-- documentation is written with sufficient coverage of details and
3225-- examples, and it's designed to be a complete tutorial on its own.
3326--
34−-- /(A modest intro goes here, click on 'req' to start making requests.)/
35−--
3627-- === About the library
3728--
38−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
39−-- library that just works without any fooling around.
40−--
41−-- What does the phrase “easy-to-use” mean? It means that the library is
42−-- designed to be beginner-friendly so it's simple to add to your monad
43−-- stack, intuitive to work with, well-documented, and does not get in your
44−-- way. Doing HTTP requests is a common task and Haskell library for this
45−-- should be very approachable and clear to beginners, thus certain
46−-- compromises were made. For example, one cannot currently modify
47−-- 'L.ManagerSettings' of the default manager because the library always
48−-- uses the same implicit global manager for simplicity and maximal
49−-- connection sharing. There is a way to use your own manager with different
50−-- settings, but it requires a bit more typing.
51−--
52−-- “Type-safe” means that the library is protective and eliminates certain
53−-- classes of errors. For example, we have correct-by-construction 'Url's,
54−-- it's guaranteed that the user does not send the request body when using
55−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
56−-- is minimized by making the user specify his\/her intentions in an
57−-- explicit form (for example, it's not possible to avoid specifying the
58−-- body or method of request). Authentication methods that assume HTTPS
59−-- force the user to use HTTPS at the type level. The library also carefully
60−-- hides underlying types from the lower-level @http-client@ package because
61−-- those types are not safe enough (for example 'L.Request' is an instance
62−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
63−-- run-time).
64−--
65−-- “Expandable” refers to the ability of the library to be expanded without
66−-- having to resort to ugly hacking. For example, it's possible to define
67−-- your own HTTP methods, create new ways to construct the body of a
68−-- request, create new authorization options, perform a request in a
69−-- different way, and create your own methods to parse and represent a
70−-- response. As the user extends the library to satisfy his\/her special
71−-- needs, the new solutions will work just like the built-ins. However, all
72−-- of the common cases are also covered by the library out-of-the-box.
73−--
74−-- “High-level” means that there are less details to worry about. The
75−-- library is a result of my experiences as a Haskell consultant. Working
76−-- for several clients, who had very different projects, showed me that the
77−-- library should adapt easily to any particular style of writing Haskell
78−-- applications. For example, some people prefer throwing exceptions, while
79−-- others are concerned with purity. Just define 'handleHttpException'
80−-- accordingly when making your monad instance of 'MonadHttp' and it will
81−-- play together seamlessly. Finally, the library cuts down boilerplate
82−-- considerably, and helps you write concise, easy to read, and maintainable
83−-- code.
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30+-- and expandable.
31+--
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
33+-- so it's simple to add to your monad stack, intuitive to work with,
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
35+-- common task and a Haskell library for this should be approachable and
36+-- clear to beginners, thus certain compromises were made. For example, one
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
39+-- simplicity and maximal connection sharing. There is a way to use your own
40+-- manager with different settings, but it requires more typing.
41+--
42+-- “Type-safe” means that the library tries to eliminate certain classes of
43+-- errors. For example, we have correct-by-construction URLs; it is
44+-- guaranteed that the user does not send the request body when using
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46+-- minimized by making the user specify their intentions in an explicit
47+-- form. For example, it's not possible to avoid specifying the body or the
48+-- method of a request. Authentication methods that assume HTTPS force the
49+-- user to use HTTPS at the type level.
50+--
51+-- “Expandable” refers to the ability to create new components without
52+-- having to resort to hacking. For example, it's possible to define your
53+-- own HTTP methods, create new ways to construct the body of a request,
54+-- create new authorization options, perform a request in a different way,
55+-- and create your own methods to parse a response.
8456--
8557-- === Using with other libraries
8658--
@@ -109,6 +81,7 @@ module Network.HTTP.Req
10981 -- $making-a-request
11082 req,
11183 reqBr,
84+ reqCb,
11285 req',
11386 withReqManager,
11487
@@ -145,6 +118,8 @@ module Network.HTTP.Req
145118 useHttpURI,
146119 useHttpsURI,
147120 useURI,
121+ urlQ,
122+ renderUrl,
148123
149124 -- ** Body
150125 -- $body
@@ -169,11 +144,13 @@ module Network.HTTP.Req
169144 -- $query-parameters
170145 (=:),
171146 queryFlag,
147+ formToQuery,
172148 QueryParam (..),
173149
174150 -- *** Headers
175151 header,
176152 attachHeader,
153+ headerRedacted,
177154
178155 -- *** Cookies
179156 -- $cookies
@@ -220,52 +197,78 @@ module Network.HTTP.Req
220197
221198 -- * Other
222199 HttpException (..),
200+ isStatusCodeException,
223201 CanHaveBody (..),
224202 Scheme (..),
225203 )
226204where
227205
228−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
229207import Control.Applicative
230208import Control.Arrow (first, second)
231−import Control.Exception hiding (TypeError)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
232211import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
233213import Control.Monad.IO.Class
234−import Control.Monad.Reader
214+import Control.Monad.IO.Unlift
215+import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216+import Control.Monad.Trans.Accum (AccumT)
217+import Control.Monad.Trans.Cont (ContT)
235218import 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
236231import Control.Retry
237232import Data.Aeson (FromJSON (..), ToJSON (..))
238−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
239234import Data.ByteString (ByteString)
240−import qualified Data.ByteString as B
241−import qualified Data.ByteString.Lazy as BL
242−import qualified Data.CaseInsensitive as CI
235+import Data.ByteString qualified as B
236+import Data.ByteString.Lazy qualified as BL
237+import Data.CaseInsensitive qualified as CI
243238import Data.Data (Data)
239+import Data.Default.Class (def)
244240import Data.Function (on)
245241import Data.IORef
246242import Data.Kind (Constraint, Type)
247243import Data.List (foldl', nubBy)
248244import Data.List.NonEmpty (NonEmpty (..))
249−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
250246import Data.Maybe (fromMaybe)
251247import Data.Proxy
252−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
253250import Data.Text (Text)
254−import qualified Data.Text.Encoding as T
255−import Data.Typeable (Typeable)
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
253+import Data.Typeable (Typeable, cast)
256254import GHC.Generics
257255import GHC.TypeLits
258−import qualified Network.Connection as NC
259−import qualified Network.HTTP.Client as L
260−import qualified Network.HTTP.Client.Internal as LI
261−import qualified Network.HTTP.Client.MultipartFormData as LM
262−import qualified Network.HTTP.Client.TLS as L
263−import qualified Network.HTTP.Types as Y
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
264265import System.IO.Unsafe (unsafePerformIO)
265266import Text.URI (URI)
266−import qualified Text.URI as URI
267−import qualified Text.URI.QQ as QQ
268−import qualified Web.Authenticate.OAuth as OAuth
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
269272import Web.HttpApiData (ToHttpApiData (..))
270273
271274----------------------------------------------------------------------------
@@ -290,7 +293,7 @@ import Web.HttpApiData (ToHttpApiData (..))
290293--
291294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
292295-- tutorial has a section about HTTP bodies, but usage is very
293−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
294297--
295298-- @response@ is a type hint how to make and interpret response of an HTTP
296299-- request. Out-of-the-box it can be the following:
@@ -418,12 +421,7 @@ req ::
418421 -- | Response
419422 m response
420423req method url body responseProxy options =
421− reqBr method url body (options <> extraOptions) getHttpResponse
422− where
423− extraOptions =
424− case acceptHeader responseProxy of
425− Nothing -> mempty
426− Just accept -> header "Accept" accept
424+ reqCb method url body responseProxy options pure
427425
428426-- | A version of 'req' that does not use one of the predefined instances of
429427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
@@ -448,7 +446,58 @@ reqBr ::
448446 (L.Response L.BodyReader -> IO a) ->
449447 -- | Result
450448 m a
451−reqBr method url body options consume = req' method url body options $ \request manager -> do
449+reqBr method url body options consume =
450+ req' method url body options (reqHandler consume)
451+
452+-- | A version of 'req' that takes a callback to modify the 'L.Request', but
453+-- otherwise performs the request identically.
454+--
455+-- @since 3.7.0
456+reqCb ::
457+ ( MonadHttp m,
458+ HttpMethod method,
459+ HttpBody body,
460+ HttpResponse response,
461+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
462+ ) =>
463+ -- | HTTP method
464+ method ->
465+ -- | 'Url'—location of resource
466+ Url scheme ->
467+ -- | Body of the request
468+ body ->
469+ -- | A hint how to interpret response
470+ Proxy response ->
471+ -- | Collection of optional parameters
472+ Option scheme ->
473+ -- | Callback to modify the request
474+ (L.Request -> m L.Request) ->
475+ -- | Response
476+ m response
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
481+ where
482+ extraOptions =
483+ case acceptHeader responseProxy of
484+ Nothing -> mempty
485+ Just accept -> header "Accept" accept
486+
487+-- | The default handler function that the higher-level request functions
488+-- pass to 'req''. Internal function.
489+--
490+-- @since 3.7.0
491+reqHandler ::
492+ (MonadHttp m) =>
493+ -- | How to get final result from a 'L.Response'
494+ (L.Response L.BodyReader -> IO b) ->
495+ -- | 'L.Request' to perform
496+ L.Request ->
497+ -- | 'L.Manager' to use
498+ L.Manager ->
499+ m b
500+reqHandler consume request manager = do
452501 HttpConfig {..} <- getHttpConfig
453502 let wrapVanilla = handle (throwIO . VanillaHttpException)
454503 wrapExc = handle (throwIO . LI.toHttpException request)
@@ -464,12 +513,23 @@ reqBr method url body options consume = req' method url body options $ \request
464513 r' <- L.responseOpen request manager
465514 writeIORef rref (Just r')
466515 return r'
516+ exceptionRetryPolicies =
517+ skipAsyncExceptions
518+ ++ [ \retryStatus -> Handler $ \e ->
519+ return $ httpConfigRetryJudgeException retryStatus e
520+ ]
467521 r <-
468522 retrying
469523 httpConfigRetryPolicy
470− (\st r -> return $ httpConfigRetryJudge st r)
471− (const openResponse)
472− (preview, r') <- grabPreview bodyPreviewLength r
524+ (\retryStatus r -> return $ httpConfigRetryJudge retryStatus r)
525+ ( const
526+ ( recovering
527+ httpConfigRetryPolicy
528+ exceptionRetryPolicies
529+ (const openResponse)
530+ )
531+ )
532+ (preview, r') <- grabPreview httpConfigBodyPreviewLength r
473533 mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
474534 consume r'
475535 )
@@ -518,22 +578,22 @@ req' method url body options m = do
518578 nubHeaders
519579 <> getRequestMod options
520580 <> getRequestMod config
521− <> getRequestMod (Womb body :: Womb "body" body)
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
522582 <> getRequestMod url
523− <> getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
524584 request <- finalizeRequest options request'
525585 withReqManager (m request)
526586
527587-- | Perform an action using the global implicit 'L.Manager' that the rest
528−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
529589-- 'L.Manager' controls.
530−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
531−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
532592
533−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
534−-- settings, so users don't need to deal with this manager stuff at all, but
535−-- when we create a request, instance 'HttpConfig' can affect the default
536−-- settings via 'getHttpConfig'.
593+-- | The global 'L.Manager' that 'req' uses. Here we just go with the
594+-- default settings, so users don't need to deal with this manager stuff at
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
596+-- default settings via 'getHttpConfig'.
537597--
538598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
539599-- The value of 'globalManager' is named and lives on top level. This means
@@ -541,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
541601-- manager. From that moment on the 'IORef' will be just reused—exactly the
542602-- behavior we want here in order to maximize connection sharing. GHC could
543603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
544−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
545605globalManager = unsafePerformIO $ do
546606 context <- NC.initConnectionContext
547607 let settings =
548608 L.mkManagerSettingsContext
549609 (Just context)
550− (NC.TLSSettingsSimple False False False)
610+ def
551611 Nothing
552612 manager <- L.newManager settings
553− newIORef manager
613+ return manager
554614{-# NOINLINE globalManager #-}
555615
556616----------------------------------------------------------------------------
@@ -564,13 +624,13 @@ globalManager = unsafePerformIO $ do
564624-- When writing a library, keep your API polymorphic in terms of
565625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
566626-- Another option is to use a @newtype@-wrapped monad stack and define
567−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
568−-- this strategy is provided out-of-the-box (see below).
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).
569629
570630-- | A type class for monads that support performing HTTP requests.
571631-- Typically, you only need to define the 'handleHttpException' method
572632-- unless you want to tweak 'HttpConfig'.
573−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
574634 -- | This method describes how to deal with 'HttpException' that was
575635 -- caught by the library. One option is to re-throw it if you are OK with
576636 -- exceptions, but if you prefer working with something like
@@ -578,17 +638,16 @@ class MonadIO m => MonadHttp m where
578638 -- 'Control.Monad.Except.throwError'.
579639 handleHttpException :: HttpException -> m a
580640
581− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
582− -- implementation returns its 'def' value, which is described in the
583− -- documentation for the type. Common usage pattern with manually defined
584− -- 'getHttpConfig' is to return some hard-coded value, or a value
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
642+ -- Default implementation returns its 'def' value, which is described in
643+ -- the documentation for the type. Common usage pattern with manually
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
585645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
586646 -- approach to configuration is desirable.
587647 getHttpConfig :: m HttpConfig
588648 getHttpConfig = return defaultHttpConfig
589649
590−-- | 'HttpConfig' contains general and default settings to be used when
591−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
592651data HttpConfig = HttpConfig
593652 { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
594653 -- environment variables are respected, this setting overwrites them.
@@ -632,8 +691,8 @@ data HttpConfig = HttpConfig
632691 -- | The retry policy to use for request retrying. By default 'def' is
633692 -- used (see 'RetryPolicyM').
634693 --
635− -- __Note__: signature of this function was changed in the version
636− -- /1.0.0/.
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/.
637696 --
638697 -- @since 0.3.0
639698 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -644,11 +703,21 @@ data HttpConfig = HttpConfig
644703 -- /1.0.0/.
645704 --
646705 -- @since 0.3.0
647− httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool
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
710+ -- /3.8.0/).
711+ --
712+ -- @since 3.4.0
713+ httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714+ -- | Max length of preview fragment of response body.
715+ --
716+ -- @since 3.6.0
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
648718 }
649− deriving (Typeable)
650719
651−-- | Default value of 'HttpConfig'.
720+-- | The default value of 'HttpConfig'.
652721--
653722-- @since 2.0.0
654723defaultHttpConfig :: HttpConfig
@@ -670,7 +739,16 @@ defaultHttpConfig =
670739 524, -- A timeout occurred
671740 598, -- (Informal convention) Network read timeout error
672741 599 -- (Informal convention) Network connect timeout error
673− ]
742+ ],
743+ httpConfigRetryJudgeException = \_ e ->
744+ case fromException e of
745+ Just (L.HttpExceptionRequest _ c) ->
746+ case c of
747+ L.ResponseTimeout -> True
748+ L.ConnectionTimeout -> True
749+ _ -> False
750+ _ -> False,
751+ httpConfigBodyPreviewLength = 1024
674752 }
675753 where
676754 statusCode = Y.statusCode . L.responseStatus
@@ -683,7 +761,7 @@ instance RequestComponent HttpConfig where
683761 LI.requestManagerOverride = httpConfigAltManager
684762 }
685763
686−-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
764+-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
687765-- having to define new instances.
688766--
689767-- @since 0.4.0
@@ -692,9 +770,19 @@ newtype Req a = Req (ReaderT HttpConfig IO a)
692770 ( Functor,
693771 Applicative,
694772 Monad,
695− MonadIO
773+ MonadIO,
774+ MonadUnliftIO
696775 )
697776
777+-- | @since 3.7.0
778+deriving instance MonadThrow Req
779+
780+-- | @since 3.7.0
781+deriving instance MonadCatch Req
782+
783+-- | @since 3.7.0
784+deriving instance MonadMask Req
785+
698786instance MonadBase IO Req where
699787 liftBase = liftIO
700788
@@ -709,12 +797,87 @@ instance MonadHttp Req where
709797 handleHttpException = Req . lift . throwIO
710798 getHttpConfig = Req ask
711799
800+-- | @since 3.10.0
801+instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802+ handleHttpException = lift . handleHttpException
803+ getHttpConfig = lift getHttpConfig
804+
805+-- | @since 3.10.0
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
807+ handleHttpException = lift . handleHttpException
808+ getHttpConfig = lift getHttpConfig
809+
810+-- | @since 3.10.0
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812+ handleHttpException = lift . handleHttpException
813+ getHttpConfig = lift getHttpConfig
814+
815+-- | @since 3.10.0
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
817+ handleHttpException = lift . handleHttpException
818+ getHttpConfig = lift getHttpConfig
819+
820+-- | @since 3.10.0
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
822+ handleHttpException = lift . handleHttpException
823+ getHttpConfig = lift getHttpConfig
824+
825+-- | @since 3.10.0
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827+ handleHttpException = lift . handleHttpException
828+ getHttpConfig = lift getHttpConfig
829+
830+-- | @since 3.10.0
831+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832+ handleHttpException = lift . handleHttpException
833+ getHttpConfig = lift getHttpConfig
834+
835+-- | @since 3.10.0
836+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837+ handleHttpException = lift . handleHttpException
838+ getHttpConfig = lift getHttpConfig
839+
840+-- | @since 3.10.0
841+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842+ handleHttpException = lift . handleHttpException
843+ getHttpConfig = lift getHttpConfig
844+
845+-- | @since 3.10.0
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
847+ handleHttpException = lift . handleHttpException
848+ getHttpConfig = lift getHttpConfig
849+
850+-- | @since 3.10.0
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852+ handleHttpException = lift . handleHttpException
853+ getHttpConfig = lift getHttpConfig
854+
855+-- | @since 3.10.0
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857+ handleHttpException = lift . handleHttpException
858+ getHttpConfig = lift getHttpConfig
859+
860+-- | @since 3.10.0
861+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862+ handleHttpException = lift . handleHttpException
863+ getHttpConfig = lift getHttpConfig
864+
865+-- | @since 3.10.0
866+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867+ handleHttpException = lift . handleHttpException
868+ getHttpConfig = lift getHttpConfig
869+
870+-- | @since 3.10.0
871+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872+ handleHttpException = lift . handleHttpException
873+ getHttpConfig = lift getHttpConfig
874+
712875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
713−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
714877--
715878-- @since 0.4.0
716879runReq ::
717− MonadIO m =>
880+ (MonadIO m) =>
718881 -- | 'HttpConfig' to use
719882 HttpConfig ->
720883 -- | Computation to run
@@ -762,14 +925,15 @@ instance HttpMethod PUT where
762925 type AllowsBody PUT = 'CanHaveBody
763926 httpMethodName Proxy = Y.methodPut
764927
765−-- | 'DELETE' method. This data type does not allow having request body with
766−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
767−-- requests to have bodies, in that case define your own variation of
768−-- 'DELETE' method and allow it to have a body.
928+-- | 'DELETE' method. RFC 7231 allows a payload in DELETE but without
929+-- semantics.
930+--
931+-- __Note__: before version /3.4.0/ this method did not allow request
932+-- bodies.
769933data DELETE = DELETE
770934
771935instance HttpMethod DELETE where
772− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
773937 httpMethodName Proxy = Y.methodDelete
774938
775939-- | 'TRACE' method.
@@ -818,7 +982,7 @@ class HttpMethod a where
818982 -- | Return name of the method as a 'ByteString'.
819983 httpMethodName :: Proxy a -> ByteString
820984
821−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
822986 getRequestMod _ = Endo $ \x ->
823987 x {L.method = httpMethodName (Proxy :: Proxy method)}
824988
@@ -860,7 +1024,20 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8601024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
8611025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8621026 -- NOTE The second value is the path segments in reversed order.
863− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1028+
1029+type role Url nominal
1030+
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
1034+ lift url =
1035+ TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036+ Url Http _ -> [t|Url 'Http|]
1037+ Url Https _ -> [t|Url 'Https|]
1038+ where
1039+ liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
8641041
8651042-- | Given host name, produce a 'Url' which has “http” as its scheme and
8661043-- empty path. This also sets port to @80@.
@@ -872,20 +1049,33 @@ http = Url Http . pure
8721049https :: Text -> Url 'Https
8731050https = Url Https . pure
8741051
875−-- | Grow given 'Url' appending a single path segment to it. Note that the
1052+-- | Grow a given 'Url' appending a single path segment to it. Note that the
8761053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
8771054infixl 5 /~
8781055
879−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
8801057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
8811058
882−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
8831060-- when next URL piece is a 'Data.Text.Text' literal.
8841061infixl 5 /:
8851062
8861063(/:) :: Url scheme -> Text -> Url scheme
8871064(/:) = (/~)
8881065
1066+-- | Render a 'Url' as 'Text'.
1067+--
1068+-- @since 3.4.0
1069+renderUrl :: Url scheme -> Text
1070+renderUrl = \case
1071+ Url Https parts ->
1072+ "https://" <> renderParts parts
1073+ Url Http parts ->
1074+ "http://" <> renderParts parts
1075+ where
1076+ renderParts parts =
1077+ T.intercalate "/" (reverse $ NE.toList parts)
1078+
8891079-- | The 'useHttpURI' function provides an alternative method to get 'Url'
8901080-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
8911081-- given a URL to query dynamically and don't know it beforehand.
@@ -899,8 +1089,7 @@ useHttpURI uri = do
8991089 urlHead <- http <$> uriHost uri
9001090 let url = case URI.uriPath uri of
9011091 Nothing -> urlHead
902− Just (_, xs) ->
903− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
9041093 return (url, uriOptions uri)
9051094
9061095-- | Just like 'useHttpURI', but expects the “https” scheme.
@@ -912,10 +1101,21 @@ useHttpsURI uri = do
9121101 urlHead <- https <$> uriHost uri
9131102 let url = case URI.uriPath uri of
9141103 Nothing -> urlHead
915− Just (_, xs) ->
916− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
9171105 return (url, uriOptions uri)
9181106
1107+-- | Convert URI path to a 'Url'. Internal.
1108+--
1109+-- @since 3.9.0
1110+uriPathToUrl ::
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
1112+ Url scheme ->
1113+ Url scheme
1114+uriPathToUrl (trailingSlash, xs) urlHead =
1115+ if trailingSlash then path /: T.empty else path
1116+ where
1117+ path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1118+
9191119-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
9201120-- is not known in advance.
9211121--
@@ -937,6 +1137,29 @@ uriHost uri = case URI.uriAuthority uri of
9371137 Right URI.Authority {..} ->
9381138 Just (URI.unRText authHost)
9391139
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.
1143+--
1144+-- @since 3.2.0
1145+urlQ :: TH.QuasiQuoter
1146+urlQ =
1147+ 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"
1153+ Just eurl ->
1154+ TH.tupE
1155+ [ either (TH.lift . fst) (TH.lift . fst) eurl,
1156+ [|uriOptions uri|]
1157+ ],
1158+ quotePat = error "This usage is not supported",
1159+ quoteType = error "This usage is not supported",
1160+ quoteDec = error "This usage is not supported"
1161+ }
1162+
9401163-- | An internal helper function to extract 'Option's from a 'URI'.
9411164uriOptions :: forall scheme. URI -> Option scheme
9421165uriOptions uri =
@@ -1009,21 +1232,21 @@ data NoReqBody = NoReqBody
10091232instance HttpBody NoReqBody where
10101233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
10111234
1012−-- | This body option allows to use a JSON object as request body—probably
1013−-- the most popular format right now. Just wrap a data type that is an
1014−-- instance of 'ToJSON' type class and you are done: it will be converted to
1015−-- JSON and inserted as request body.
1235+-- | This body option allows us to use a JSON object as the request
1236+-- body—probably the most popular format right now. Just wrap a data type
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
1238+-- converted to JSON and inserted as request body.
10161239--
10171240-- This body option sets the @Content-Type@ header to @\"application/json;
10181241-- charset=utf-8\"@ value.
10191242newtype ReqBodyJson a = ReqBodyJson a
10201243
1021−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
10221245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
10231246 getRequestContentType _ = pure "application/json; charset=utf-8"
10241247
10251248-- | This body option streams request body from a file. It is expected that
1026−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
10271250--
10281251-- Using of this body option does not set the @Content-Type@ header.
10291252newtype ReqBodyFile = ReqBodyFile FilePath
@@ -1048,12 +1271,11 @@ newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
10481271instance HttpBody ReqBodyLbs where
10491272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
10501273
1051−-- | Form URL-encoded body. This can hold a collection of parameters which
1052−-- are encoded similarly to query parameters at the end of query string,
1053−-- with the only difference that they are stored in request body. The
1054−-- similarity is reflected in the API as well, as you can use the same
1055−-- combinators you would use to add query parameters: @('=:')@ and
1056−-- 'queryFlag'.
1274+-- | URL-encoded body. This can hold a collection of parameters which are
1275+-- encoded similarly to query parameters at the end of query string, with
1276+-- the only difference that they are stored in request body. The similarity
1277+-- is reflected in the API as well, as you can use the same combinators you
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
10571279--
10581280-- This body option sets the @Content-Type@ header to
10591281-- @\"application/x-www-form-urlencoded\"@ value.
@@ -1072,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
10721294instance QueryParam FormUrlEncodedParam where
10731295 queryParam name mvalue =
10741296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
1298+
1299+-- | Use 'formToQuery'.
1300+--
1301+-- @since 3.11.0
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
10751304
10761305-- | Multipart form data. Please consult the
10771306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1111,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
11111340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
11121341--
11131342-- @since 0.2.0
1114−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
11151344reqBodyMultipart parts = liftIO $ do
11161345 boundary <- LM.webkitBoundary
11171346 body <- LM.renderParts boundary parts
@@ -1139,9 +1368,6 @@ type family ProvidesBody body :: CanHaveBody where
11391368-- | This type function allows any HTTP body if method says it
11401369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
11411370-- body option to use is 'NoReqBody'.
1142−--
1143−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1144−-- error message when method does not allow a body and body is provided.
11451371type family
11461372 HttpBodyAllowed
11471373 (allowsBody :: CanHaveBody)
@@ -1154,8 +1380,8 @@ type family
11541380 TypeError
11551381 ('Text "This HTTP method does not allow attaching a request body.")
11561382
1157−instance HttpBody body => RequestComponent (Womb "body" body) where
1158− getRequestMod (Womb body) = Endo $ \x ->
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
11591385 x
11601386 { L.requestBody = getRequestBody body,
11611387 L.requestHeaders =
@@ -1184,8 +1410,8 @@ data Option (scheme :: Scheme)
11841410 = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
11851411
11861412-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1187−-- Request to avoid appending to existing query string in request every
1188−-- time new parameter is added. Additional Maybe (L.Request -> IO
1413+-- Request to avoid appending to an existing query string in request every
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
11891415-- L.Request) is a finalizer that will be applied after all other
11901416-- transformations. This is for authentication methods that sign requests
11911417-- based on data in Request.
@@ -1200,6 +1426,12 @@ instance Monoid (Option scheme) where
12001426 mempty = Option mempty Nothing
12011427 mappend = (<>)
12021428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
12031435-- | A helper to create an 'Option' that modifies only collection of query
12041436-- parameters. This helper is not a part of the public API.
12051437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1218,7 +1450,7 @@ instance RequestComponent (Option scheme) where
12181450
12191451-- | Finalize given 'L.Request' by applying a finalizer from the given
12201452-- 'Option' (if it has any).
1221−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
12221454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
12231455
12241456----------------------------------------------------------------------------
@@ -1242,7 +1474,7 @@ infix 7 =:
12421474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
12431475name =: value = queryParam name (pure value)
12441476
1245−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
12461478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
12471479-- with a value:
12481480--
@@ -1251,9 +1483,27 @@ name =: value = queryParam name (pure value)
12511483-- This operator is defined in terms of 'queryParam':
12521484--
12531485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1254−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
12551487queryFlag name = queryParam name (Nothing :: Maybe ())
12561488
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491+--
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@).
1496+--
1497+-- @since 3.11.0
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500+ where
1501+ toParam (key, val) =
1502+ queryParam key $
1503+ if val == ""
1504+ then Nothing
1505+ else Just val
1506+
12571507-- | A type class for query-parameter-like things. The reason to have an
12581508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
12591509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1263,11 +1513,17 @@ class QueryParam param where
12631513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
12641514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
12651515 -- method, because they are easier to read.
1266− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1517+
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1519+ --
1520+ -- @since 3.11.0
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
12671522
12681523instance QueryParam (Option scheme) where
12691524 queryParam name mvalue =
12701525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
12711527
12721528----------------------------------------------------------------------------
12731529-- Request—Optional parameters—Headers
@@ -1291,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
12911547attachHeader name value x =
12921548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
12931549
1550+-- | Same as 'header', but with redacted values on print.
1551+--
1552+-- @since 3.13.0
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}
1557+
12941558----------------------------------------------------------------------------
12951559-- Request—Optional parameters—Cookies
12961560
@@ -1432,7 +1696,7 @@ customAuth = Option mempty . pure
14321696
14331697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
14341698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1435−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
14361700port :: Int -> Option scheme
14371701port n = withRequest $ \x ->
14381702 x {L.port = n}
@@ -1447,8 +1711,8 @@ port n = withRequest $ \x ->
14471711--
14481712-- > decompress (const True)
14491713decompress ::
1450− -- | Predicate that is given MIME type, it
1451− -- returns 'True' when content should be decompressed on the fly.
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1715+ -- should be decompressed on the fly.
14521716 (ByteString -> Bool) ->
14531717 Option scheme
14541718decompress f = withRequest $ \x ->
@@ -1479,6 +1743,7 @@ httpVersion major minor = withRequest $ \x ->
14791743
14801744-- | Make a request and ignore the body of the response.
14811745newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
14821747
14831748instance HttpResponse IgnoreResponse where
14841749 type HttpResponseBody IgnoreResponse = ()
@@ -1495,8 +1760,9 @@ ignoreResponse = Proxy
14951760-- monad in which you use 'req' will determine what to do in the case when
14961761-- parsing fails (the 'JsonHttpException' constructor will be used).
14971762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
14981764
1499−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
15001766 type HttpResponseBody (JsonResponse a) = a
15011767 toVanillaResponse (JsonResponse r) = r
15021768 getHttpResponse r = do
@@ -1514,6 +1780,7 @@ jsonResponse = Proxy
15141780-- | Make a request and interpret the body of the response as a strict
15151781-- 'ByteString'.
15161782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
15171784
15181785instance HttpResponse BsResponse where
15191786 type HttpResponseBody BsResponse = ByteString
@@ -1530,6 +1797,7 @@ bsResponse = Proxy
15301797-- | Make a request and interpret the body of the response as a lazy
15311798-- 'BL.ByteString'.
15321799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
15331801
15341802instance HttpResponse LbsResponse where
15351803 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1546,7 +1814,7 @@ lbsResponse = Proxy
15461814----------------------------------------------------------------------------
15471815-- Helpers for response interpretations
15481816
1549−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
15501818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
15511819-- such.
15521820grabPreview ::
@@ -1610,14 +1878,14 @@ brReadN br n = go 0 id id
16101878
16111879-- | Get the response body.
16121880responseBody ::
1613− HttpResponse response =>
1881+ (HttpResponse response) =>
16141882 response ->
16151883 HttpResponseBody response
16161884responseBody = L.responseBody . toVanillaResponse
16171885
16181886-- | Get the response status code.
16191887responseStatusCode ::
1620− HttpResponse response =>
1888+ (HttpResponse response) =>
16211889 response ->
16221890 Int
16231891responseStatusCode =
@@ -1625,7 +1893,7 @@ responseStatusCode =
16251893
16261894-- | Get the response status message.
16271895responseStatusMessage ::
1628− HttpResponse response =>
1896+ (HttpResponse response) =>
16291897 response ->
16301898 ByteString
16311899responseStatusMessage =
@@ -1633,7 +1901,7 @@ responseStatusMessage =
16331901
16341902-- | Lookup a particular header from a response.
16351903responseHeader ::
1636− HttpResponse response =>
1904+ (HttpResponse response) =>
16371905 -- | Response interpretation
16381906 response ->
16391907 -- | Header to lookup
@@ -1645,7 +1913,7 @@ responseHeader r h =
16451913
16461914-- | Get the response 'L.CookieJar'.
16471915responseCookieJar ::
1648− HttpResponse response =>
1916+ (HttpResponse response) =>
16491917 response ->
16501918 L.CookieJar
16511919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1658,9 +1926,9 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
16581926-- To create a new response interpretation you just need to make your data
16591927-- type an instance of the 'HttpResponse' type class.
16601928
1661−-- | A type class for response interpretations. It allows to describe how to
1662−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1663−-- final result that is to be returned to the user.
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.
16641932class HttpResponse response where
16651933 -- | The associated type is the type of body that can be extracted from an
16661934 -- instance of 'HttpResponse'.
@@ -1699,6 +1967,16 @@ class HttpResponse response where
16991967 acceptHeader :: Proxy response -> Maybe ByteString
17001968 acceptHeader Proxy = Nothing
17011969
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1972+-- etc.
1973+--
1974+-- @since 3.12.0
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
1979+
17021980----------------------------------------------------------------------------
17031981-- Other
17041982
@@ -1724,7 +2002,7 @@ class RequestComponent a where
17242002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
17252003-- which instance to use (i.e. the constraints are taken into account later,
17262004-- when instance is already chosen).
1727−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
17282006
17292007-- | Exceptions that this library throws.
17302008data HttpException
@@ -1733,10 +2011,24 @@ data HttpException
17332011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
17342012 -- failed
17352013 JsonHttpException String
1736− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
17372015
17382016instance Exception HttpException
17392017
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2020+--
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2026+ _
2027+ (L.StatusCodeException r _)
2028+ )
2029+ ) = Just r
2030+isStatusCodeException _ = Nothing
2031+
17402032-- | A simple type isomorphic to 'Bool' that we only have for better error
17412033-- messages. We use it as a kind and its data constructors as type-level
17422034-- tags.
@@ -1756,11 +2048,4 @@ data Scheme
17562048 Http
17572049 | -- | HTTPS
17582050 Https
1759− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1760−
1761−----------------------------------------------------------------------------
1762−-- Constants
1763−
1764−-- | Max length of preview fragment of response body.
1765−bodyPreviewLength :: Num a => a
1766−bodyPreviewLength = 1024
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)