@@ -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 #-}
92{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
113{-# LANGUAGE OverloadedStrings #-}
124{-# LANGUAGE QuasiQuotes #-}
13−{-# LANGUAGE RankNTypes #-}
145{-# LANGUAGE RecordWildCards #-}
156{-# LANGUAGE RoleAnnotations #-}
16−{-# LANGUAGE ScopedTypeVariables #-}
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--
@@ -175,11 +144,13 @@ module Network.HTTP.Req
175144 -- $query-parameters
176145 (=:),
177146 queryFlag,
147+ formToQuery,
178148 QueryParam (..),
179149
180150 -- *** Headers
181151 header,
182152 attachHeader,
153+ headerRedacted,
183154
184155 -- *** Cookies
185156 -- $cookies
@@ -226,58 +197,78 @@ module Network.HTTP.Req
226197
227198 -- * Other
228199 HttpException (..),
200+ isStatusCodeException,
229201 CanHaveBody (..),
230202 Scheme (..),
231203 )
232204where
233205
234−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
235207import Control.Applicative
236208import Control.Arrow (first, second)
237209import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
238211import Control.Monad.Base
239−import Control.Monad.Catch (Handler (..))
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
240213import Control.Monad.IO.Class
241214import Control.Monad.IO.Unlift
242−import Control.Monad.Reader
215+import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216+import Control.Monad.Trans.Accum (AccumT)
217+import Control.Monad.Trans.Cont (ContT)
243218import 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
244231import Control.Retry
245232import Data.Aeson (FromJSON (..), ToJSON (..))
246−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
247234import Data.ByteString (ByteString)
248−import qualified Data.ByteString as B
249−import qualified Data.ByteString.Lazy as BL
250−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
251238import Data.Data (Data)
239+import Data.Default.Class (def)
252240import Data.Function (on)
253241import Data.IORef
254242import Data.Kind (Constraint, Type)
255243import Data.List (foldl', nubBy)
256244import Data.List.NonEmpty (NonEmpty (..))
257−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
258246import Data.Maybe (fromMaybe)
259247import Data.Proxy
260−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
261250import Data.Text (Text)
262−import qualified Data.Text as T
263−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
264253import Data.Typeable (Typeable, cast)
265254import GHC.Generics
266255import GHC.TypeLits
267−import qualified Language.Haskell.TH as TH
268−import qualified Language.Haskell.TH.Quote as TH
269−import qualified Language.Haskell.TH.Syntax as TH
270−import qualified Network.Connection as NC
271−import qualified Network.HTTP.Client as L
272−import qualified Network.HTTP.Client.Internal as LI
273−import qualified Network.HTTP.Client.MultipartFormData as LM
274−import qualified Network.HTTP.Client.TLS as L
275−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
276265import System.IO.Unsafe (unsafePerformIO)
277266import Text.URI (URI)
278−import qualified Text.URI as URI
279−import qualified Text.URI.QQ as QQ
280−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
281272import Web.HttpApiData (ToHttpApiData (..))
282273
283274----------------------------------------------------------------------------
@@ -302,7 +293,7 @@ import Web.HttpApiData (ToHttpApiData (..))
302293--
303294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
304295-- tutorial has a section about HTTP bodies, but usage is very
305−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
306297--
307298-- @response@ is a type hint how to make and interpret response of an HTTP
308299-- request. Out-of-the-box it can be the following:
@@ -458,8 +449,8 @@ reqBr ::
458449reqBr method url body options consume =
459450 req' method url body options (reqHandler consume)
460451
461−-- | A version of 'req' that takes a callback to modify the @'L.Request',
462−-- but otherwise performs the request identically.
452+-- | A version of 'req' that takes a callback to modify the 'L.Request', but
453+-- otherwise performs the request identically.
463454--
464455-- @since 3.7.0
465456reqCb ::
@@ -498,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
498489--
499490-- @since 3.7.0
500491reqHandler ::
501− MonadHttp m =>
492+ (MonadHttp m) =>
502493 -- | How to get final result from a 'L.Response'
503494 (L.Response L.BodyReader -> IO b) ->
504495 -- | 'L.Request' to perform
@@ -587,22 +578,22 @@ req' method url body options m = do
587578 nubHeaders
588579 <> getRequestMod options
589580 <> getRequestMod config
590− <> getRequestMod (Womb body :: Womb "body" body)
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
591582 <> getRequestMod url
592− <> getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
593584 request <- finalizeRequest options request'
594585 withReqManager (m request)
595586
596587-- | Perform an action using the global implicit 'L.Manager' that the rest
597−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
598589-- 'L.Manager' controls.
599−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
600−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
601592
602−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
603−-- settings, so users don't need to deal with this manager stuff at all, but
604−-- when we create a request, instance 'HttpConfig' can affect the default
605−-- 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'.
606597--
607598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
608599-- The value of 'globalManager' is named and lives on top level. This means
@@ -610,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
610601-- manager. From that moment on the 'IORef' will be just reused—exactly the
611602-- behavior we want here in order to maximize connection sharing. GHC could
612603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
613−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
614605globalManager = unsafePerformIO $ do
615606 context <- NC.initConnectionContext
616607 let settings =
617608 L.mkManagerSettingsContext
618609 (Just context)
619− (NC.TLSSettingsSimple False False False)
610+ def
620611 Nothing
621612 manager <- L.newManager settings
622− newIORef manager
613+ return manager
623614{-# NOINLINE globalManager #-}
624615
625616----------------------------------------------------------------------------
@@ -633,13 +624,13 @@ globalManager = unsafePerformIO $ do
633624-- When writing a library, keep your API polymorphic in terms of
634625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
635626-- Another option is to use a @newtype@-wrapped monad stack and define
636−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
637−-- 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).
638629
639630-- | A type class for monads that support performing HTTP requests.
640631-- Typically, you only need to define the 'handleHttpException' method
641632-- unless you want to tweak 'HttpConfig'.
642−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
643634 -- | This method describes how to deal with 'HttpException' that was
644635 -- caught by the library. One option is to re-throw it if you are OK with
645636 -- exceptions, but if you prefer working with something like
@@ -647,17 +638,16 @@ class MonadIO m => MonadHttp m where
647638 -- 'Control.Monad.Except.throwError'.
648639 handleHttpException :: HttpException -> m a
649640
650− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
651− -- implementation returns its 'def' value, which is described in the
652− -- documentation for the type. Common usage pattern with manually defined
653− -- '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
654645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
655646 -- approach to configuration is desirable.
656647 getHttpConfig :: m HttpConfig
657648 getHttpConfig = return defaultHttpConfig
658649
659−-- | 'HttpConfig' contains general and default settings to be used when
660−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
661651data HttpConfig = HttpConfig
662652 { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
663653 -- environment variables are respected, this setting overwrites them.
@@ -701,8 +691,8 @@ data HttpConfig = HttpConfig
701691 -- | The retry policy to use for request retrying. By default 'def' is
702692 -- used (see 'RetryPolicyM').
703693 --
704− -- __Note__: signature of this function was changed in the version
705− -- /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/.
706696 --
707697 -- @since 0.3.0
708698 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -715,18 +705,19 @@ data HttpConfig = HttpConfig
715705 -- @since 0.3.0
716706 httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
717707 -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
718− -- retry requests that resulted in an exception.
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/).
719711 --
720712 -- @since 3.4.0
721713 httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
722714 -- | Max length of preview fragment of response body.
723715 --
724716 -- @since 3.6.0
725− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
726718 }
727− deriving (Typeable)
728719
729−-- | Default value of 'HttpConfig'.
720+-- | The default value of 'HttpConfig'.
730721--
731722-- @since 2.0.0
732723defaultHttpConfig :: HttpConfig
@@ -749,7 +740,14 @@ defaultHttpConfig =
749740 598, -- (Informal convention) Network read timeout error
750741 599 -- (Informal convention) Network connect timeout error
751742 ],
752− httpConfigRetryJudgeException = \_ _ -> False,
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,
753751 httpConfigBodyPreviewLength = 1024
754752 }
755753 where
@@ -763,7 +761,7 @@ instance RequestComponent HttpConfig where
763761 LI.requestManagerOverride = httpConfigAltManager
764762 }
765763
766−-- | 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
767765-- having to define new instances.
768766--
769767-- @since 0.4.0
@@ -776,6 +774,15 @@ newtype Req a = Req (ReaderT HttpConfig IO a)
776774 MonadUnliftIO
777775 )
778776
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+
779786instance MonadBase IO Req where
780787 liftBase = liftIO
781788
@@ -790,12 +797,87 @@ instance MonadHttp Req where
790797 handleHttpException = Req . lift . throwIO
791798 getHttpConfig = Req ask
792799
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+
793875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
794−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
795877--
796878-- @since 0.4.0
797879runReq ::
798− MonadIO m =>
880+ (MonadIO m) =>
799881 -- | 'HttpConfig' to use
800882 HttpConfig ->
801883 -- | Computation to run
@@ -900,7 +982,7 @@ class HttpMethod a where
900982 -- | Return name of the method as a 'ByteString'.
901983 httpMethodName :: Proxy a -> ByteString
902984
903−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
904986 getRequestMod _ = Endo $ \x ->
905987 x {L.method = httpMethodName (Proxy :: Proxy method)}
906988
@@ -942,23 +1024,20 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
9421024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
9431025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
9441026 -- NOTE The second value is the path segments in reversed order.
945− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
9461028
9471029type role Url nominal
9481030
9491031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
950−-- the derived lift forgets the type of scheme.
951−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
9521034 lift url =
9531035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
9541036 Url Http _ -> [t|Url 'Http|]
9551037 Url Https _ -> [t|Url 'Https|]
9561038 where
9571039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
958−
959−#if MIN_VERSION_template_haskell(2,16,0)
960− liftTyped url = TH.TExp <$> TH.lift url
961−#endif
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
9621041
9631042-- | Given host name, produce a 'Url' which has “http” as its scheme and
9641043-- empty path. This also sets port to @80@.
@@ -970,14 +1049,14 @@ http = Url Http . pure
9701049https :: Text -> Url 'Https
9711050https = Url Https . pure
9721051
973−-- | 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
9741053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
9751054infixl 5 /~
9761055
977−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
9781057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
9791058
980−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
9811060-- when next URL piece is a 'Data.Text.Text' literal.
9821061infixl 5 /:
9831062
@@ -1010,8 +1089,7 @@ useHttpURI uri = do
10101089 urlHead <- http <$> uriHost uri
10111090 let url = case URI.uriPath uri of
10121091 Nothing -> urlHead
1013− Just (_, xs) ->
1014− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
10151093 return (url, uriOptions uri)
10161094
10171095-- | Just like 'useHttpURI', but expects the “https” scheme.
@@ -1023,10 +1101,21 @@ useHttpsURI uri = do
10231101 urlHead <- https <$> uriHost uri
10241102 let url = case URI.uriPath uri of
10251103 Nothing -> urlHead
1026− Just (_, xs) ->
1027− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
10281105 return (url, uriOptions uri)
10291106
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+
10301119-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
10311120-- is not known in advance.
10321121--
@@ -1143,21 +1232,21 @@ data NoReqBody = NoReqBody
11431232instance HttpBody NoReqBody where
11441233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
11451234
1146−-- | This body option allows to use a JSON object as request body—probably
1147−-- the most popular format right now. Just wrap a data type that is an
1148−-- instance of 'ToJSON' type class and you are done: it will be converted to
1149−-- 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.
11501239--
11511240-- This body option sets the @Content-Type@ header to @\"application/json;
11521241-- charset=utf-8\"@ value.
11531242newtype ReqBodyJson a = ReqBodyJson a
11541243
1155−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
11561245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
11571246 getRequestContentType _ = pure "application/json; charset=utf-8"
11581247
11591248-- | This body option streams request body from a file. It is expected that
1160−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
11611250--
11621251-- Using of this body option does not set the @Content-Type@ header.
11631252newtype ReqBodyFile = ReqBodyFile FilePath
@@ -1182,12 +1271,11 @@ newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
11821271instance HttpBody ReqBodyLbs where
11831272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
11841273
1185−-- | Form URL-encoded body. This can hold a collection of parameters which
1186−-- are encoded similarly to query parameters at the end of query string,
1187−-- with the only difference that they are stored in request body. The
1188−-- similarity is reflected in the API as well, as you can use the same
1189−-- combinators you would use to add query parameters: @('=:')@ and
1190−-- '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'.
11911279--
11921280-- This body option sets the @Content-Type@ header to
11931281-- @\"application/x-www-form-urlencoded\"@ value.
@@ -1206,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
12061294instance QueryParam FormUrlEncodedParam where
12071295 queryParam name mvalue =
12081296 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
12091304
12101305-- | Multipart form data. Please consult the
12111306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1245,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
12451340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
12461341--
12471342-- @since 0.2.0
1248−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
12491344reqBodyMultipart parts = liftIO $ do
12501345 boundary <- LM.webkitBoundary
12511346 body <- LM.renderParts boundary parts
@@ -1273,9 +1368,6 @@ type family ProvidesBody body :: CanHaveBody where
12731368-- | This type function allows any HTTP body if method says it
12741369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
12751370-- body option to use is 'NoReqBody'.
1276−--
1277−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1278−-- error message when method does not allow a body and body is provided.
12791371type family
12801372 HttpBodyAllowed
12811373 (allowsBody :: CanHaveBody)
@@ -1288,8 +1380,8 @@ type family
12881380 TypeError
12891381 ('Text "This HTTP method does not allow attaching a request body.")
12901382
1291−instance HttpBody body => RequestComponent (Womb "body" body) where
1292− getRequestMod (Womb body) = Endo $ \x ->
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
12931385 x
12941386 { L.requestBody = getRequestBody body,
12951387 L.requestHeaders =
@@ -1318,8 +1410,8 @@ data Option (scheme :: Scheme)
13181410 = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
13191411
13201412-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1321−-- Request to avoid appending to existing query string in request every
1322−-- 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
13231415-- L.Request) is a finalizer that will be applied after all other
13241416-- transformations. This is for authentication methods that sign requests
13251417-- based on data in Request.
@@ -1334,6 +1426,12 @@ instance Monoid (Option scheme) where
13341426 mempty = Option mempty Nothing
13351427 mappend = (<>)
13361428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
13371435-- | A helper to create an 'Option' that modifies only collection of query
13381436-- parameters. This helper is not a part of the public API.
13391437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1352,7 +1450,7 @@ instance RequestComponent (Option scheme) where
13521450
13531451-- | Finalize given 'L.Request' by applying a finalizer from the given
13541452-- 'Option' (if it has any).
1355−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
13561454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
13571455
13581456----------------------------------------------------------------------------
@@ -1376,7 +1474,7 @@ infix 7 =:
13761474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
13771475name =: value = queryParam name (pure value)
13781476
1379−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
13801478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
13811479-- with a value:
13821480--
@@ -1385,9 +1483,27 @@ name =: value = queryParam name (pure value)
13851483-- This operator is defined in terms of 'queryParam':
13861484--
13871485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1388−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
13891487queryFlag name = queryParam name (Nothing :: Maybe ())
13901488
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+
13911507-- | A type class for query-parameter-like things. The reason to have an
13921508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
13931509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1397,11 +1513,17 @@ class QueryParam param where
13971513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
13981514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
13991515 -- method, because they are easier to read.
1400− 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)]
14011522
14021523instance QueryParam (Option scheme) where
14031524 queryParam name mvalue =
14041525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
14051527
14061528----------------------------------------------------------------------------
14071529-- Request—Optional parameters—Headers
@@ -1425,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
14251547attachHeader name value x =
14261548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
14271549
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+
14281558----------------------------------------------------------------------------
14291559-- Request—Optional parameters—Cookies
14301560
@@ -1566,7 +1696,7 @@ customAuth = Option mempty . pure
15661696
15671697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
15681698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1569−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
15701700port :: Int -> Option scheme
15711701port n = withRequest $ \x ->
15721702 x {L.port = n}
@@ -1581,8 +1711,8 @@ port n = withRequest $ \x ->
15811711--
15821712-- > decompress (const True)
15831713decompress ::
1584− -- | Predicate that is given MIME type, it
1585− -- 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.
15861716 (ByteString -> Bool) ->
15871717 Option scheme
15881718decompress f = withRequest $ \x ->
@@ -1632,7 +1762,7 @@ ignoreResponse = Proxy
16321762newtype JsonResponse a = JsonResponse (L.Response a)
16331763 deriving (Show)
16341764
1635−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
16361766 type HttpResponseBody (JsonResponse a) = a
16371767 toVanillaResponse (JsonResponse r) = r
16381768 getHttpResponse r = do
@@ -1684,7 +1814,7 @@ lbsResponse = Proxy
16841814----------------------------------------------------------------------------
16851815-- Helpers for response interpretations
16861816
1687−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
16881818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
16891819-- such.
16901820grabPreview ::
@@ -1748,14 +1878,14 @@ brReadN br n = go 0 id id
17481878
17491879-- | Get the response body.
17501880responseBody ::
1751− HttpResponse response =>
1881+ (HttpResponse response) =>
17521882 response ->
17531883 HttpResponseBody response
17541884responseBody = L.responseBody . toVanillaResponse
17551885
17561886-- | Get the response status code.
17571887responseStatusCode ::
1758− HttpResponse response =>
1888+ (HttpResponse response) =>
17591889 response ->
17601890 Int
17611891responseStatusCode =
@@ -1763,7 +1893,7 @@ responseStatusCode =
17631893
17641894-- | Get the response status message.
17651895responseStatusMessage ::
1766− HttpResponse response =>
1896+ (HttpResponse response) =>
17671897 response ->
17681898 ByteString
17691899responseStatusMessage =
@@ -1771,7 +1901,7 @@ responseStatusMessage =
17711901
17721902-- | Lookup a particular header from a response.
17731903responseHeader ::
1774− HttpResponse response =>
1904+ (HttpResponse response) =>
17751905 -- | Response interpretation
17761906 response ->
17771907 -- | Header to lookup
@@ -1783,7 +1913,7 @@ responseHeader r h =
17831913
17841914-- | Get the response 'L.CookieJar'.
17851915responseCookieJar ::
1786− HttpResponse response =>
1916+ (HttpResponse response) =>
17871917 response ->
17881918 L.CookieJar
17891919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1796,9 +1926,9 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
17961926-- To create a new response interpretation you just need to make your data
17971927-- type an instance of the 'HttpResponse' type class.
17981928
1799−-- | A type class for response interpretations. It allows to describe how to
1800−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1801−-- 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.
18021932class HttpResponse response where
18031933 -- | The associated type is the type of body that can be extracted from an
18041934 -- instance of 'HttpResponse'.
@@ -1837,6 +1967,16 @@ class HttpResponse response where
18371967 acceptHeader :: Proxy response -> Maybe ByteString
18381968 acceptHeader Proxy = Nothing
18391969
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+
18401980----------------------------------------------------------------------------
18411981-- Other
18421982
@@ -1862,7 +2002,7 @@ class RequestComponent a where
18622002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
18632003-- which instance to use (i.e. the constraints are taken into account later,
18642004-- when instance is already chosen).
1865−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
18662006
18672007-- | Exceptions that this library throws.
18682008data HttpException
@@ -1871,10 +2011,24 @@ data HttpException
18712011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
18722012 -- failed
18732013 JsonHttpException String
1874− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
18752015
18762016instance Exception HttpException
18772017
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+
18782032-- | A simple type isomorphic to 'Bool' that we only have for better error
18792033-- messages. We use it as a kind and its data constructors as type-level
18802034-- tags.
@@ -1894,4 +2048,4 @@ data Scheme
18942048 Http
18952049 | -- | HTTPS
18962050 Https
1897− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)