@@ -1,19 +1,9 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
31{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE DeriveDataTypeable #-}
5−{-# LANGUAGE DeriveGeneric #-}
6−{-# LANGUAGE DeriveLift #-}
7−{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9−{-# LANGUAGE KindSignatures #-}
102{-# LANGUAGE LambdaCase #-}
11−{-# LANGUAGE MultiParamTypeClasses #-}
123{-# LANGUAGE OverloadedStrings #-}
134{-# LANGUAGE QuasiQuotes #-}
14−{-# LANGUAGE RankNTypes #-}
155{-# LANGUAGE RecordWildCards #-}
16−{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE RoleAnnotations #-}
177{-# LANGUAGE TemplateHaskellQuotes #-}
188{-# LANGUAGE TypeFamilies #-}
199{-# LANGUAGE UndecidableInstances #-}
@@ -29,61 +19,40 @@
2919--
3020-- The documentation below is structured in such a way that the most
3121-- important information is presented first: you learn how to do HTTP
32−-- 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
3323-- details about less-common things you may want to know about. The
3424-- documentation is written with sufficient coverage of details and
3525-- examples, and it's designed to be a complete tutorial on its own.
3626--
37−-- /(A modest intro goes here, click on 'req' to start making requests.)/
38−--
3927-- === About the library
4028--
41−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
42−-- library that just works without any fooling around.
43−--
44−-- What does the phrase “easy-to-use” mean? It means that the library is
45−-- designed to be beginner-friendly so it's simple to add to your monad
46−-- stack, intuitive to work with, well-documented, and does not get in your
47−-- way. Doing HTTP requests is a common task and Haskell library for this
48−-- should be very approachable and clear to beginners, thus certain
49−-- compromises were made. For example, one cannot currently modify
50−-- 'L.ManagerSettings' of the default manager because the library always
51−-- uses the same implicit global manager for simplicity and maximal
52−-- connection sharing. There is a way to use your own manager with different
53−-- settings, but it requires a bit more typing.
54−--
55−-- “Type-safe” means that the library is protective and eliminates certain
56−-- classes of errors. For example, we have correct-by-construction 'Url's,
57−-- it's guaranteed that the user does not send the request body when using
58−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
59−-- is minimized by making the user specify his\/her intentions in an
60−-- explicit form (for example, it's not possible to avoid specifying the
61−-- body or method of request). Authentication methods that assume HTTPS
62−-- force the user to use HTTPS at the type level. The library also carefully
63−-- hides underlying types from the lower-level @http-client@ package because
64−-- those types are not safe enough (for example 'L.Request' is an instance
65−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
66−-- run-time).
67−--
68−-- “Expandable” refers to the ability of the library to be expanded without
69−-- having to resort to ugly hacking. For example, it's possible to define
70−-- your own HTTP methods, create new ways to construct the body of a
71−-- request, create new authorization options, perform a request in a
72−-- different way, and create your own methods to parse and represent a
73−-- response. As the user extends the library to satisfy his\/her special
74−-- needs, the new solutions will work just like the built-ins. However, all
75−-- of the common cases are also covered by the library out-of-the-box.
76−--
77−-- “High-level” means that there are less details to worry about. The
78−-- library is a result of my experiences as a Haskell consultant. Working
79−-- for several clients, who had very different projects, showed me that the
80−-- library should adapt easily to any particular style of writing Haskell
81−-- applications. For example, some people prefer throwing exceptions, while
82−-- others are concerned with purity. Just define 'handleHttpException'
83−-- accordingly when making your monad instance of 'MonadHttp' and it will
84−-- play together seamlessly. Finally, the library cuts down boilerplate
85−-- considerably, and helps you write concise, easy to read, and maintainable
86−-- 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.
8756--
8857-- === Using with other libraries
8958--
@@ -112,6 +81,7 @@ module Network.HTTP.Req
11281 -- $making-a-request
11382 req,
11483 reqBr,
84+ reqCb,
11585 req',
11686 withReqManager,
11787
@@ -149,6 +119,7 @@ module Network.HTTP.Req
149119 useHttpsURI,
150120 useURI,
151121 urlQ,
122+ renderUrl,
152123
153124 -- ** Body
154125 -- $body
@@ -173,11 +144,13 @@ module Network.HTTP.Req
173144 -- $query-parameters
174145 (=:),
175146 queryFlag,
147+ formToQuery,
176148 QueryParam (..),
177149
178150 -- *** Headers
179151 header,
180152 attachHeader,
153+ headerRedacted,
181154
182155 -- *** Cookies
183156 -- $cookies
@@ -224,56 +197,78 @@ module Network.HTTP.Req
224197
225198 -- * Other
226199 HttpException (..),
200+ isStatusCodeException,
227201 CanHaveBody (..),
228202 Scheme (..),
229203 )
230204where
231205
232−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
233207import Control.Applicative
234208import Control.Arrow (first, second)
235−import Control.Exception hiding (TypeError)
209+import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
236211import Control.Monad.Base
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
237213import Control.Monad.IO.Class
238−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)
239218import 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
240231import Control.Retry
241232import Data.Aeson (FromJSON (..), ToJSON (..))
242−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
243234import Data.ByteString (ByteString)
244−import qualified Data.ByteString as B
245−import qualified Data.ByteString.Lazy as BL
246−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
247238import Data.Data (Data)
239+import Data.Default.Class (def)
248240import Data.Function (on)
249241import Data.IORef
250242import Data.Kind (Constraint, Type)
251243import Data.List (foldl', nubBy)
252244import Data.List.NonEmpty (NonEmpty (..))
253−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
254246import Data.Maybe (fromMaybe)
255247import Data.Proxy
256−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
257250import Data.Text (Text)
258−import qualified Data.Text as T
259−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
260253import Data.Typeable (Typeable, cast)
261254import GHC.Generics
262255import GHC.TypeLits
263−import qualified Language.Haskell.TH as TH
264−import qualified Language.Haskell.TH.Quote as TH
265−import qualified Language.Haskell.TH.Syntax as TH
266−import qualified Network.Connection as NC
267−import qualified Network.HTTP.Client as L
268−import qualified Network.HTTP.Client.Internal as LI
269−import qualified Network.HTTP.Client.MultipartFormData as LM
270−import qualified Network.HTTP.Client.TLS as L
271−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
272265import System.IO.Unsafe (unsafePerformIO)
273266import Text.URI (URI)
274−import qualified Text.URI as URI
275−import qualified Text.URI.QQ as QQ
276−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
277272import Web.HttpApiData (ToHttpApiData (..))
278273
279274----------------------------------------------------------------------------
@@ -298,7 +293,7 @@ import Web.HttpApiData (ToHttpApiData (..))
298293--
299294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
300295-- tutorial has a section about HTTP bodies, but usage is very
301−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
302297--
303298-- @response@ is a type hint how to make and interpret response of an HTTP
304299-- request. Out-of-the-box it can be the following:
@@ -426,12 +421,7 @@ req ::
426421 -- | Response
427422 m response
428423req method url body responseProxy options =
429− reqBr method url body (options <> extraOptions) getHttpResponse
430− where
431− extraOptions =
432− case acceptHeader responseProxy of
433− Nothing -> mempty
434− Just accept -> header "Accept" accept
424+ reqCb method url body responseProxy options pure
435425
436426-- | A version of 'req' that does not use one of the predefined instances of
437427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
@@ -456,7 +446,58 @@ reqBr ::
456446 (L.Response L.BodyReader -> IO a) ->
457447 -- | Result
458448 m a
459−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
460501 HttpConfig {..} <- getHttpConfig
461502 let wrapVanilla = handle (throwIO . VanillaHttpException)
462503 wrapExc = handle (throwIO . LI.toHttpException request)
@@ -472,12 +513,23 @@ reqBr method url body options consume = req' method url body options $ \request
472513 r' <- L.responseOpen request manager
473514 writeIORef rref (Just r')
474515 return r'
516+ exceptionRetryPolicies =
517+ skipAsyncExceptions
518+ ++ [ \retryStatus -> Handler $ \e ->
519+ return $ httpConfigRetryJudgeException retryStatus e
520+ ]
475521 r <-
476522 retrying
477523 httpConfigRetryPolicy
478− (\st r -> return $ httpConfigRetryJudge st r)
479− (const openResponse)
480− (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
481533 mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
482534 consume r'
483535 )
@@ -526,22 +578,22 @@ req' method url body options m = do
526578 nubHeaders
527579 <> getRequestMod options
528580 <> getRequestMod config
529− <> getRequestMod (Womb body :: Womb "body" body)
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
530582 <> getRequestMod url
531− <> getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
532584 request <- finalizeRequest options request'
533585 withReqManager (m request)
534586
535587-- | Perform an action using the global implicit 'L.Manager' that the rest
536−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
537589-- 'L.Manager' controls.
538−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
539−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
540592
541−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
542−-- settings, so users don't need to deal with this manager stuff at all, but
543−-- when we create a request, instance 'HttpConfig' can affect the default
544−-- 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'.
545597--
546598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
547599-- The value of 'globalManager' is named and lives on top level. This means
@@ -549,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
549601-- manager. From that moment on the 'IORef' will be just reused—exactly the
550602-- behavior we want here in order to maximize connection sharing. GHC could
551603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
552−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
553605globalManager = unsafePerformIO $ do
554606 context <- NC.initConnectionContext
555607 let settings =
556608 L.mkManagerSettingsContext
557609 (Just context)
558− (NC.TLSSettingsSimple False False False)
610+ def
559611 Nothing
560612 manager <- L.newManager settings
561− newIORef manager
613+ return manager
562614{-# NOINLINE globalManager #-}
563615
564616----------------------------------------------------------------------------
@@ -572,13 +624,13 @@ globalManager = unsafePerformIO $ do
572624-- When writing a library, keep your API polymorphic in terms of
573625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
574626-- Another option is to use a @newtype@-wrapped monad stack and define
575−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
576−-- 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).
577629
578630-- | A type class for monads that support performing HTTP requests.
579631-- Typically, you only need to define the 'handleHttpException' method
580632-- unless you want to tweak 'HttpConfig'.
581−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
582634 -- | This method describes how to deal with 'HttpException' that was
583635 -- caught by the library. One option is to re-throw it if you are OK with
584636 -- exceptions, but if you prefer working with something like
@@ -586,17 +638,16 @@ class MonadIO m => MonadHttp m where
586638 -- 'Control.Monad.Except.throwError'.
587639 handleHttpException :: HttpException -> m a
588640
589− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
590− -- implementation returns its 'def' value, which is described in the
591− -- documentation for the type. Common usage pattern with manually defined
592− -- '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
593645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
594646 -- approach to configuration is desirable.
595647 getHttpConfig :: m HttpConfig
596648 getHttpConfig = return defaultHttpConfig
597649
598−-- | 'HttpConfig' contains general and default settings to be used when
599−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
600651data HttpConfig = HttpConfig
601652 { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
602653 -- environment variables are respected, this setting overwrites them.
@@ -640,8 +691,8 @@ data HttpConfig = HttpConfig
640691 -- | The retry policy to use for request retrying. By default 'def' is
641692 -- used (see 'RetryPolicyM').
642693 --
643− -- __Note__: signature of this function was changed in the version
644− -- /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/.
645696 --
646697 -- @since 0.3.0
647698 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -652,11 +703,21 @@ data HttpConfig = HttpConfig
652703 -- /1.0.0/.
653704 --
654705 -- @since 0.3.0
655− 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
656718 }
657− deriving (Typeable)
658719
659−-- | Default value of 'HttpConfig'.
720+-- | The default value of 'HttpConfig'.
660721--
661722-- @since 2.0.0
662723defaultHttpConfig :: HttpConfig
@@ -678,7 +739,16 @@ defaultHttpConfig =
678739 524, -- A timeout occurred
679740 598, -- (Informal convention) Network read timeout error
680741 599 -- (Informal convention) Network connect timeout error
681− ]
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
682752 }
683753 where
684754 statusCode = Y.statusCode . L.responseStatus
@@ -691,7 +761,7 @@ instance RequestComponent HttpConfig where
691761 LI.requestManagerOverride = httpConfigAltManager
692762 }
693763
694−-- | 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
695765-- having to define new instances.
696766--
697767-- @since 0.4.0
@@ -700,9 +770,19 @@ newtype Req a = Req (ReaderT HttpConfig IO a)
700770 ( Functor,
701771 Applicative,
702772 Monad,
703− MonadIO
773+ MonadIO,
774+ MonadUnliftIO
704775 )
705776
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+
706786instance MonadBase IO Req where
707787 liftBase = liftIO
708788
@@ -717,12 +797,87 @@ instance MonadHttp Req where
717797 handleHttpException = Req . lift . throwIO
718798 getHttpConfig = Req ask
719799
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+
720875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
721−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
722877--
723878-- @since 0.4.0
724879runReq ::
725− MonadIO m =>
880+ (MonadIO m) =>
726881 -- | 'HttpConfig' to use
727882 HttpConfig ->
728883 -- | Computation to run
@@ -770,14 +925,15 @@ instance HttpMethod PUT where
770925 type AllowsBody PUT = 'CanHaveBody
771926 httpMethodName Proxy = Y.methodPut
772927
773−-- | 'DELETE' method. This data type does not allow having request body with
774−-- 'DELETE' requests, as it should be. However some APIs may expect 'DELETE'
775−-- requests to have bodies, in that case define your own variation of
776−-- '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.
777933data DELETE = DELETE
778934
779935instance HttpMethod DELETE where
780− type AllowsBody DELETE = 'NoBody
936+ type AllowsBody DELETE = 'CanHaveBody
781937 httpMethodName Proxy = Y.methodDelete
782938
783939-- | 'TRACE' method.
@@ -826,7 +982,7 @@ class HttpMethod a where
826982 -- | Return name of the method as a 'ByteString'.
827983 httpMethodName :: Proxy a -> ByteString
828984
829−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
830986 getRequestMod _ = Endo $ \x ->
831987 x {L.method = httpMethodName (Proxy :: Proxy method)}
832988
@@ -868,21 +1024,20 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8681024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
8691025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8701026 -- NOTE The second value is the path segments in reversed order.
871− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1028+
1029+type role Url nominal
8721030
8731031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
874−-- the derived lift forgets the type of scheme.
875−instance Typeable scheme => TH.Lift (Url scheme) where
1032+-- the derived lift forgets the type of the scheme.
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
8761034 lift url =
8771035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
8781036 Url Http _ -> [t|Url 'Http|]
8791037 Url Https _ -> [t|Url 'Https|]
8801038 where
8811039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
882−
883−#if MIN_VERSION_template_haskell(2,16,0)
884− liftTyped url = TH.TExp <$> TH.lift url
885−#endif
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
8861041
8871042-- | Given host name, produce a 'Url' which has “http” as its scheme and
8881043-- empty path. This also sets port to @80@.
@@ -894,20 +1049,33 @@ http = Url Http . pure
8941049https :: Text -> Url 'Https
8951050https = Url Https . pure
8961051
897−-- | 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
8981053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
8991054infixl 5 /~
9001055
901−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
9021057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
9031058
904−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
9051060-- when next URL piece is a 'Data.Text.Text' literal.
9061061infixl 5 /:
9071062
9081063(/:) :: Url scheme -> Text -> Url scheme
9091064(/:) = (/~)
9101065
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+
9111079-- | The 'useHttpURI' function provides an alternative method to get 'Url'
9121080-- (possibly with some 'Option's) from a 'URI'. This is useful when you are
9131081-- given a URL to query dynamically and don't know it beforehand.
@@ -921,8 +1089,7 @@ useHttpURI uri = do
9211089 urlHead <- http <$> uriHost uri
9221090 let url = case URI.uriPath uri of
9231091 Nothing -> urlHead
924− Just (_, xs) ->
925− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
9261093 return (url, uriOptions uri)
9271094
9281095-- | Just like 'useHttpURI', but expects the “https” scheme.
@@ -934,10 +1101,21 @@ useHttpsURI uri = do
9341101 urlHead <- https <$> uriHost uri
9351102 let url = case URI.uriPath uri of
9361103 Nothing -> urlHead
937− Just (_, xs) ->
938− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
9391105 return (url, uriOptions uri)
9401106
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+
9411119-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
9421120-- is not known in advance.
9431121--
@@ -1054,21 +1232,21 @@ data NoReqBody = NoReqBody
10541232instance HttpBody NoReqBody where
10551233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
10561234
1057−-- | This body option allows to use a JSON object as request body—probably
1058−-- the most popular format right now. Just wrap a data type that is an
1059−-- instance of 'ToJSON' type class and you are done: it will be converted to
1060−-- 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.
10611239--
10621240-- This body option sets the @Content-Type@ header to @\"application/json;
10631241-- charset=utf-8\"@ value.
10641242newtype ReqBodyJson a = ReqBodyJson a
10651243
1066−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
10671245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
10681246 getRequestContentType _ = pure "application/json; charset=utf-8"
10691247
10701248-- | This body option streams request body from a file. It is expected that
1071−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
10721250--
10731251-- Using of this body option does not set the @Content-Type@ header.
10741252newtype ReqBodyFile = ReqBodyFile FilePath
@@ -1093,12 +1271,11 @@ newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
10931271instance HttpBody ReqBodyLbs where
10941272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
10951273
1096−-- | Form URL-encoded body. This can hold a collection of parameters which
1097−-- are encoded similarly to query parameters at the end of query string,
1098−-- with the only difference that they are stored in request body. The
1099−-- similarity is reflected in the API as well, as you can use the same
1100−-- combinators you would use to add query parameters: @('=:')@ and
1101−-- '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'.
11021279--
11031280-- This body option sets the @Content-Type@ header to
11041281-- @\"application/x-www-form-urlencoded\"@ value.
@@ -1117,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
11171294instance QueryParam FormUrlEncodedParam where
11181295 queryParam name mvalue =
11191296 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
11201304
11211305-- | Multipart form data. Please consult the
11221306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1156,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
11561340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
11571341--
11581342-- @since 0.2.0
1159−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
11601344reqBodyMultipart parts = liftIO $ do
11611345 boundary <- LM.webkitBoundary
11621346 body <- LM.renderParts boundary parts
@@ -1184,9 +1368,6 @@ type family ProvidesBody body :: CanHaveBody where
11841368-- | This type function allows any HTTP body if method says it
11851369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
11861370-- body option to use is 'NoReqBody'.
1187−--
1188−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1189−-- error message when method does not allow a body and body is provided.
11901371type family
11911372 HttpBodyAllowed
11921373 (allowsBody :: CanHaveBody)
@@ -1199,8 +1380,8 @@ type family
11991380 TypeError
12001381 ('Text "This HTTP method does not allow attaching a request body.")
12011382
1202−instance HttpBody body => RequestComponent (Womb "body" body) where
1203− getRequestMod (Womb body) = Endo $ \x ->
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
12041385 x
12051386 { L.requestBody = getRequestBody body,
12061387 L.requestHeaders =
@@ -1229,8 +1410,8 @@ data Option (scheme :: Scheme)
12291410 = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
12301411
12311412-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1232−-- Request to avoid appending to existing query string in request every
1233−-- 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
12341415-- L.Request) is a finalizer that will be applied after all other
12351416-- transformations. This is for authentication methods that sign requests
12361417-- based on data in Request.
@@ -1245,6 +1426,12 @@ instance Monoid (Option scheme) where
12451426 mempty = Option mempty Nothing
12461427 mappend = (<>)
12471428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
12481435-- | A helper to create an 'Option' that modifies only collection of query
12491436-- parameters. This helper is not a part of the public API.
12501437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1263,7 +1450,7 @@ instance RequestComponent (Option scheme) where
12631450
12641451-- | Finalize given 'L.Request' by applying a finalizer from the given
12651452-- 'Option' (if it has any).
1266−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
12671454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
12681455
12691456----------------------------------------------------------------------------
@@ -1287,7 +1474,7 @@ infix 7 =:
12871474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
12881475name =: value = queryParam name (pure value)
12891476
1290−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
12911478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
12921479-- with a value:
12931480--
@@ -1296,9 +1483,27 @@ name =: value = queryParam name (pure value)
12961483-- This operator is defined in terms of 'queryParam':
12971484--
12981485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1299−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
13001487queryFlag name = queryParam name (Nothing :: Maybe ())
13011488
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+
13021507-- | A type class for query-parameter-like things. The reason to have an
13031508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
13041509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1308,11 +1513,17 @@ class QueryParam param where
13081513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
13091514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
13101515 -- method, because they are easier to read.
1311− 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)]
13121522
13131523instance QueryParam (Option scheme) where
13141524 queryParam name mvalue =
13151525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
13161527
13171528----------------------------------------------------------------------------
13181529-- Request—Optional parameters—Headers
@@ -1336,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
13361547attachHeader name value x =
13371548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
13381549
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+
13391558----------------------------------------------------------------------------
13401559-- Request—Optional parameters—Cookies
13411560
@@ -1477,7 +1696,7 @@ customAuth = Option mempty . pure
14771696
14781697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
14791698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1480−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
14811700port :: Int -> Option scheme
14821701port n = withRequest $ \x ->
14831702 x {L.port = n}
@@ -1492,8 +1711,8 @@ port n = withRequest $ \x ->
14921711--
14931712-- > decompress (const True)
14941713decompress ::
1495− -- | Predicate that is given MIME type, it
1496− -- 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.
14971716 (ByteString -> Bool) ->
14981717 Option scheme
14991718decompress f = withRequest $ \x ->
@@ -1524,6 +1743,7 @@ httpVersion major minor = withRequest $ \x ->
15241743
15251744-- | Make a request and ignore the body of the response.
15261745newtype IgnoreResponse = IgnoreResponse (L.Response ())
1746+ deriving (Show)
15271747
15281748instance HttpResponse IgnoreResponse where
15291749 type HttpResponseBody IgnoreResponse = ()
@@ -1540,8 +1760,9 @@ ignoreResponse = Proxy
15401760-- monad in which you use 'req' will determine what to do in the case when
15411761-- parsing fails (the 'JsonHttpException' constructor will be used).
15421762newtype JsonResponse a = JsonResponse (L.Response a)
1763+ deriving (Show)
15431764
1544−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
15451766 type HttpResponseBody (JsonResponse a) = a
15461767 toVanillaResponse (JsonResponse r) = r
15471768 getHttpResponse r = do
@@ -1559,6 +1780,7 @@ jsonResponse = Proxy
15591780-- | Make a request and interpret the body of the response as a strict
15601781-- 'ByteString'.
15611782newtype BsResponse = BsResponse (L.Response ByteString)
1783+ deriving (Show)
15621784
15631785instance HttpResponse BsResponse where
15641786 type HttpResponseBody BsResponse = ByteString
@@ -1575,6 +1797,7 @@ bsResponse = Proxy
15751797-- | Make a request and interpret the body of the response as a lazy
15761798-- 'BL.ByteString'.
15771799newtype LbsResponse = LbsResponse (L.Response BL.ByteString)
1800+ deriving (Show)
15781801
15791802instance HttpResponse LbsResponse where
15801803 type HttpResponseBody LbsResponse = BL.ByteString
@@ -1591,7 +1814,7 @@ lbsResponse = Proxy
15911814----------------------------------------------------------------------------
15921815-- Helpers for response interpretations
15931816
1594−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
15951818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
15961819-- such.
15971820grabPreview ::
@@ -1655,14 +1878,14 @@ brReadN br n = go 0 id id
16551878
16561879-- | Get the response body.
16571880responseBody ::
1658− HttpResponse response =>
1881+ (HttpResponse response) =>
16591882 response ->
16601883 HttpResponseBody response
16611884responseBody = L.responseBody . toVanillaResponse
16621885
16631886-- | Get the response status code.
16641887responseStatusCode ::
1665− HttpResponse response =>
1888+ (HttpResponse response) =>
16661889 response ->
16671890 Int
16681891responseStatusCode =
@@ -1670,7 +1893,7 @@ responseStatusCode =
16701893
16711894-- | Get the response status message.
16721895responseStatusMessage ::
1673− HttpResponse response =>
1896+ (HttpResponse response) =>
16741897 response ->
16751898 ByteString
16761899responseStatusMessage =
@@ -1678,7 +1901,7 @@ responseStatusMessage =
16781901
16791902-- | Lookup a particular header from a response.
16801903responseHeader ::
1681− HttpResponse response =>
1904+ (HttpResponse response) =>
16821905 -- | Response interpretation
16831906 response ->
16841907 -- | Header to lookup
@@ -1690,7 +1913,7 @@ responseHeader r h =
16901913
16911914-- | Get the response 'L.CookieJar'.
16921915responseCookieJar ::
1693− HttpResponse response =>
1916+ (HttpResponse response) =>
16941917 response ->
16951918 L.CookieJar
16961919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1703,9 +1926,9 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
17031926-- To create a new response interpretation you just need to make your data
17041927-- type an instance of the 'HttpResponse' type class.
17051928
1706−-- | A type class for response interpretations. It allows to describe how to
1707−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1708−-- 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.
17091932class HttpResponse response where
17101933 -- | The associated type is the type of body that can be extracted from an
17111934 -- instance of 'HttpResponse'.
@@ -1744,6 +1967,16 @@ class HttpResponse response where
17441967 acceptHeader :: Proxy response -> Maybe ByteString
17451968 acceptHeader Proxy = Nothing
17461969
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+
17471980----------------------------------------------------------------------------
17481981-- Other
17491982
@@ -1769,7 +2002,7 @@ class RequestComponent a where
17692002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
17702003-- which instance to use (i.e. the constraints are taken into account later,
17712004-- when instance is already chosen).
1772−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
17732006
17742007-- | Exceptions that this library throws.
17752008data HttpException
@@ -1778,10 +2011,24 @@ data HttpException
17782011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
17792012 -- failed
17802013 JsonHttpException String
1781− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
17822015
17832016instance Exception HttpException
17842017
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+
17852032-- | A simple type isomorphic to 'Bool' that we only have for better error
17862033-- messages. We use it as a kind and its data constructors as type-level
17872034-- tags.
@@ -1801,11 +2048,4 @@ data Scheme
18012048 Http
18022049 | -- | HTTPS
18032050 Https
1804− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
1805−
1806−----------------------------------------------------------------------------
1807−-- Constants
1808−
1809−-- | Max length of preview fragment of response body.
1810−bodyPreviewLength :: Num a => a
1811−bodyPreviewLength = 1024
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)