@@ -1,20 +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 #-}
17−{-# LANGUAGE StandaloneDeriving #-}
187{-# LANGUAGE TemplateHaskellQuotes #-}
198{-# LANGUAGE TypeFamilies #-}
209{-# LANGUAGE UndecidableInstances #-}
@@ -30,61 +19,40 @@
3019--
3120-- The documentation below is structured in such a way that the most
3221-- important information is presented first: you learn how to do HTTP
33−-- 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
3423-- details about less-common things you may want to know about. The
3524-- documentation is written with sufficient coverage of details and
3625-- examples, and it's designed to be a complete tutorial on its own.
3726--
38−-- /(A modest intro goes here, click on 'req' to start making requests.)/
39−--
4027-- === About the library
4128--
42−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
43−-- library that just works without any fooling around.
44−--
45−-- What does the phrase “easy-to-use” mean? It means that the library is
46−-- designed to be beginner-friendly so it's simple to add to your monad
47−-- stack, intuitive to work with, well-documented, and does not get in your
48−-- way. Doing HTTP requests is a common task and Haskell library for this
49−-- should be very approachable and clear to beginners, thus certain
50−-- compromises were made. For example, one cannot currently modify
51−-- 'L.ManagerSettings' of the default manager because the library always
52−-- uses the same implicit global manager for simplicity and maximal
53−-- connection sharing. There is a way to use your own manager with different
54−-- settings, but it requires a bit more typing.
55−--
56−-- “Type-safe” means that the library is protective and eliminates certain
57−-- classes of errors. For example, we have correct-by-construction 'Url's,
58−-- it's guaranteed that the user does not send the request body when using
59−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
60−-- is minimized by making the user specify his\/her intentions in an
61−-- explicit form (for example, it's not possible to avoid specifying the
62−-- body or method of request). Authentication methods that assume HTTPS
63−-- force the user to use HTTPS at the type level. The library also carefully
64−-- hides underlying types from the lower-level @http-client@ package because
65−-- those types are not safe enough (for example 'L.Request' is an instance
66−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
67−-- run-time).
68−--
69−-- “Expandable” refers to the ability of the library to be expanded without
70−-- having to resort to ugly hacking. For example, it's possible to define
71−-- your own HTTP methods, create new ways to construct the body of a
72−-- request, create new authorization options, perform a request in a
73−-- different way, and create your own methods to parse and represent a
74−-- response. As the user extends the library to satisfy his\/her special
75−-- needs, the new solutions will work just like the built-ins. However, all
76−-- of the common cases are also covered by the library out-of-the-box.
77−--
78−-- “High-level” means that there are less details to worry about. The
79−-- library is a result of my experiences as a Haskell consultant. Working
80−-- for several clients, who had very different projects, showed me that the
81−-- library should adapt easily to any particular style of writing Haskell
82−-- applications. For example, some people prefer throwing exceptions, while
83−-- others are concerned with purity. Just define 'handleHttpException'
84−-- accordingly when making your monad instance of 'MonadHttp' and it will
85−-- play together seamlessly. Finally, the library cuts down boilerplate
86−-- considerably, and helps you write concise, easy to read, and maintainable
87−-- 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.
8856--
8957-- === Using with other libraries
9058--
@@ -176,11 +144,13 @@ module Network.HTTP.Req
176144 -- $query-parameters
177145 (=:),
178146 queryFlag,
147+ formToQuery,
179148 QueryParam (..),
180149
181150 -- *** Headers
182151 header,
183152 attachHeader,
153+ headerRedacted,
184154
185155 -- *** Cookies
186156 -- $cookies
@@ -227,58 +197,78 @@ module Network.HTTP.Req
227197
228198 -- * Other
229199 HttpException (..),
200+ isStatusCodeException,
230201 CanHaveBody (..),
231202 Scheme (..),
232203 )
233204where
234205
235−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
236207import Control.Applicative
237208import Control.Arrow (first, second)
238209import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
239211import Control.Monad.Base
240212import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
241213import Control.Monad.IO.Class
242214import Control.Monad.IO.Unlift
243−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)
244218import 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
245231import Control.Retry
246232import Data.Aeson (FromJSON (..), ToJSON (..))
247−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
248234import Data.ByteString (ByteString)
249−import qualified Data.ByteString as B
250−import qualified Data.ByteString.Lazy as BL
251−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
252238import Data.Data (Data)
239+import Data.Default.Class (def)
253240import Data.Function (on)
254241import Data.IORef
255242import Data.Kind (Constraint, Type)
256243import Data.List (foldl', nubBy)
257244import Data.List.NonEmpty (NonEmpty (..))
258−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
259246import Data.Maybe (fromMaybe)
260247import Data.Proxy
261−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
262250import Data.Text (Text)
263−import qualified Data.Text as T
264−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
265253import Data.Typeable (Typeable, cast)
266254import GHC.Generics
267255import GHC.TypeLits
268−import qualified Language.Haskell.TH as TH
269−import qualified Language.Haskell.TH.Quote as TH
270−import qualified Language.Haskell.TH.Syntax as TH
271−import qualified Network.Connection as NC
272−import qualified Network.HTTP.Client as L
273−import qualified Network.HTTP.Client.Internal as LI
274−import qualified Network.HTTP.Client.MultipartFormData as LM
275−import qualified Network.HTTP.Client.TLS as L
276−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
277265import System.IO.Unsafe (unsafePerformIO)
278266import Text.URI (URI)
279−import qualified Text.URI as URI
280−import qualified Text.URI.QQ as QQ
281−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
282272import Web.HttpApiData (ToHttpApiData (..))
283273
284274----------------------------------------------------------------------------
@@ -303,7 +293,7 @@ import Web.HttpApiData (ToHttpApiData (..))
303293--
304294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
305295-- tutorial has a section about HTTP bodies, but usage is very
306−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
307297--
308298-- @response@ is a type hint how to make and interpret response of an HTTP
309299-- request. Out-of-the-box it can be the following:
@@ -499,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
499489--
500490-- @since 3.7.0
501491reqHandler ::
502− MonadHttp m =>
492+ (MonadHttp m) =>
503493 -- | How to get final result from a 'L.Response'
504494 (L.Response L.BodyReader -> IO b) ->
505495 -- | 'L.Request' to perform
@@ -588,22 +578,22 @@ req' method url body options m = do
588578 nubHeaders
589579 <> getRequestMod options
590580 <> getRequestMod config
591− <> getRequestMod (Womb body :: Womb "body" body)
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
592582 <> getRequestMod url
593− <> getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
594584 request <- finalizeRequest options request'
595585 withReqManager (m request)
596586
597587-- | Perform an action using the global implicit 'L.Manager' that the rest
598−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
599589-- 'L.Manager' controls.
600−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
601−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
602592
603−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
604−-- settings, so users don't need to deal with this manager stuff at all, but
605−-- when we create a request, instance 'HttpConfig' can affect the default
606−-- 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'.
607597--
608598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
609599-- The value of 'globalManager' is named and lives on top level. This means
@@ -611,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
611601-- manager. From that moment on the 'IORef' will be just reused—exactly the
612602-- behavior we want here in order to maximize connection sharing. GHC could
613603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
614−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
615605globalManager = unsafePerformIO $ do
616606 context <- NC.initConnectionContext
617607 let settings =
618608 L.mkManagerSettingsContext
619609 (Just context)
620− (NC.TLSSettingsSimple False False False)
610+ def
621611 Nothing
622612 manager <- L.newManager settings
623− newIORef manager
613+ return manager
624614{-# NOINLINE globalManager #-}
625615
626616----------------------------------------------------------------------------
@@ -634,13 +624,13 @@ globalManager = unsafePerformIO $ do
634624-- When writing a library, keep your API polymorphic in terms of
635625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
636626-- Another option is to use a @newtype@-wrapped monad stack and define
637−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
638−-- 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).
639629
640630-- | A type class for monads that support performing HTTP requests.
641631-- Typically, you only need to define the 'handleHttpException' method
642632-- unless you want to tweak 'HttpConfig'.
643−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
644634 -- | This method describes how to deal with 'HttpException' that was
645635 -- caught by the library. One option is to re-throw it if you are OK with
646636 -- exceptions, but if you prefer working with something like
@@ -648,17 +638,16 @@ class MonadIO m => MonadHttp m where
648638 -- 'Control.Monad.Except.throwError'.
649639 handleHttpException :: HttpException -> m a
650640
651− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
652− -- implementation returns its 'def' value, which is described in the
653− -- documentation for the type. Common usage pattern with manually defined
654− -- '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
655645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
656646 -- approach to configuration is desirable.
657647 getHttpConfig :: m HttpConfig
658648 getHttpConfig = return defaultHttpConfig
659649
660−-- | 'HttpConfig' contains general and default settings to be used when
661−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
662651data HttpConfig = HttpConfig
663652 { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
664653 -- environment variables are respected, this setting overwrites them.
@@ -702,8 +691,8 @@ data HttpConfig = HttpConfig
702691 -- | The retry policy to use for request retrying. By default 'def' is
703692 -- used (see 'RetryPolicyM').
704693 --
705− -- __Note__: signature of this function was changed in the version
706− -- /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/.
707696 --
708697 -- @since 0.3.0
709698 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -725,11 +714,10 @@ data HttpConfig = HttpConfig
725714 -- | Max length of preview fragment of response body.
726715 --
727716 -- @since 3.6.0
728− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
729718 }
730− deriving (Typeable)
731719
732−-- | Default value of 'HttpConfig'.
720+-- | The default value of 'HttpConfig'.
733721--
734722-- @since 2.0.0
735723defaultHttpConfig :: HttpConfig
@@ -773,7 +761,7 @@ instance RequestComponent HttpConfig where
773761 LI.requestManagerOverride = httpConfigAltManager
774762 }
775763
776−-- | 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
777765-- having to define new instances.
778766--
779767-- @since 0.4.0
@@ -809,12 +797,87 @@ instance MonadHttp Req where
809797 handleHttpException = Req . lift . throwIO
810798 getHttpConfig = Req ask
811799
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+
812875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
813−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
814877--
815878-- @since 0.4.0
816879runReq ::
817− MonadIO m =>
880+ (MonadIO m) =>
818881 -- | 'HttpConfig' to use
819882 HttpConfig ->
820883 -- | Computation to run
@@ -919,7 +982,7 @@ class HttpMethod a where
919982 -- | Return name of the method as a 'ByteString'.
920983 httpMethodName :: Proxy a -> ByteString
921984
922−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
923986 getRequestMod _ = Endo $ \x ->
924987 x {L.method = httpMethodName (Proxy :: Proxy method)}
925988
@@ -961,23 +1024,20 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
9611024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
9621025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
9631026 -- NOTE The second value is the path segments in reversed order.
964− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
9651028
9661029type role Url nominal
9671030
9681031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
969−-- the derived lift forgets the type of scheme.
970−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
9711034 lift url =
9721035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
9731036 Url Http _ -> [t|Url 'Http|]
9741037 Url Https _ -> [t|Url 'Https|]
9751038 where
9761039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
977−
978−#if MIN_VERSION_template_haskell(2,16,0)
979− liftTyped url = TH.TExp <$> TH.lift url
980−#endif
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
9811041
9821042-- | Given host name, produce a 'Url' which has “http” as its scheme and
9831043-- empty path. This also sets port to @80@.
@@ -989,14 +1049,14 @@ http = Url Http . pure
9891049https :: Text -> Url 'Https
9901050https = Url Https . pure
9911051
992−-- | 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
9931053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
9941054infixl 5 /~
9951055
996−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
9971057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
9981058
999−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
10001060-- when next URL piece is a 'Data.Text.Text' literal.
10011061infixl 5 /:
10021062
@@ -1029,8 +1089,7 @@ useHttpURI uri = do
10291089 urlHead <- http <$> uriHost uri
10301090 let url = case URI.uriPath uri of
10311091 Nothing -> urlHead
1032− Just (_, xs) ->
1033− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
10341093 return (url, uriOptions uri)
10351094
10361095-- | Just like 'useHttpURI', but expects the “https” scheme.
@@ -1042,10 +1101,21 @@ useHttpsURI uri = do
10421101 urlHead <- https <$> uriHost uri
10431102 let url = case URI.uriPath uri of
10441103 Nothing -> urlHead
1045− Just (_, xs) ->
1046− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
10471105 return (url, uriOptions uri)
10481106
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+
10491119-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
10501120-- is not known in advance.
10511121--
@@ -1162,21 +1232,21 @@ data NoReqBody = NoReqBody
11621232instance HttpBody NoReqBody where
11631233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
11641234
1165−-- | This body option allows to use a JSON object as request body—probably
1166−-- the most popular format right now. Just wrap a data type that is an
1167−-- instance of 'ToJSON' type class and you are done: it will be converted to
1168−-- 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.
11691239--
11701240-- This body option sets the @Content-Type@ header to @\"application/json;
11711241-- charset=utf-8\"@ value.
11721242newtype ReqBodyJson a = ReqBodyJson a
11731243
1174−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
11751245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
11761246 getRequestContentType _ = pure "application/json; charset=utf-8"
11771247
11781248-- | This body option streams request body from a file. It is expected that
1179−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
11801250--
11811251-- Using of this body option does not set the @Content-Type@ header.
11821252newtype ReqBodyFile = ReqBodyFile FilePath
@@ -1201,12 +1271,11 @@ newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
12011271instance HttpBody ReqBodyLbs where
12021272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
12031273
1204−-- | Form URL-encoded body. This can hold a collection of parameters which
1205−-- are encoded similarly to query parameters at the end of query string,
1206−-- with the only difference that they are stored in request body. The
1207−-- similarity is reflected in the API as well, as you can use the same
1208−-- combinators you would use to add query parameters: @('=:')@ and
1209−-- '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'.
12101279--
12111280-- This body option sets the @Content-Type@ header to
12121281-- @\"application/x-www-form-urlencoded\"@ value.
@@ -1225,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
12251294instance QueryParam FormUrlEncodedParam where
12261295 queryParam name mvalue =
12271296 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
12281304
12291305-- | Multipart form data. Please consult the
12301306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1264,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
12641340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
12651341--
12661342-- @since 0.2.0
1267−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
12681344reqBodyMultipart parts = liftIO $ do
12691345 boundary <- LM.webkitBoundary
12701346 body <- LM.renderParts boundary parts
@@ -1292,9 +1368,6 @@ type family ProvidesBody body :: CanHaveBody where
12921368-- | This type function allows any HTTP body if method says it
12931369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
12941370-- body option to use is 'NoReqBody'.
1295−--
1296−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1297−-- error message when method does not allow a body and body is provided.
12981371type family
12991372 HttpBodyAllowed
13001373 (allowsBody :: CanHaveBody)
@@ -1307,8 +1380,8 @@ type family
13071380 TypeError
13081381 ('Text "This HTTP method does not allow attaching a request body.")
13091382
1310−instance HttpBody body => RequestComponent (Womb "body" body) where
1311− getRequestMod (Womb body) = Endo $ \x ->
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
13121385 x
13131386 { L.requestBody = getRequestBody body,
13141387 L.requestHeaders =
@@ -1337,8 +1410,8 @@ data Option (scheme :: Scheme)
13371410 = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
13381411
13391412-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1340−-- Request to avoid appending to existing query string in request every
1341−-- 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
13421415-- L.Request) is a finalizer that will be applied after all other
13431416-- transformations. This is for authentication methods that sign requests
13441417-- based on data in Request.
@@ -1353,6 +1426,12 @@ instance Monoid (Option scheme) where
13531426 mempty = Option mempty Nothing
13541427 mappend = (<>)
13551428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
13561435-- | A helper to create an 'Option' that modifies only collection of query
13571436-- parameters. This helper is not a part of the public API.
13581437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1371,7 +1450,7 @@ instance RequestComponent (Option scheme) where
13711450
13721451-- | Finalize given 'L.Request' by applying a finalizer from the given
13731452-- 'Option' (if it has any).
1374−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
13751454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
13761455
13771456----------------------------------------------------------------------------
@@ -1395,7 +1474,7 @@ infix 7 =:
13951474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
13961475name =: value = queryParam name (pure value)
13971476
1398−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
13991478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
14001479-- with a value:
14011480--
@@ -1404,9 +1483,27 @@ name =: value = queryParam name (pure value)
14041483-- This operator is defined in terms of 'queryParam':
14051484--
14061485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1407−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
14081487queryFlag name = queryParam name (Nothing :: Maybe ())
14091488
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+
14101507-- | A type class for query-parameter-like things. The reason to have an
14111508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
14121509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1416,11 +1513,17 @@ class QueryParam param where
14161513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
14171514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
14181515 -- method, because they are easier to read.
1419− 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)]
14201522
14211523instance QueryParam (Option scheme) where
14221524 queryParam name mvalue =
14231525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
14241527
14251528----------------------------------------------------------------------------
14261529-- Request—Optional parameters—Headers
@@ -1444,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
14441547attachHeader name value x =
14451548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
14461549
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+
14471558----------------------------------------------------------------------------
14481559-- Request—Optional parameters—Cookies
14491560
@@ -1585,7 +1696,7 @@ customAuth = Option mempty . pure
15851696
15861697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
15871698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1588−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
15891700port :: Int -> Option scheme
15901701port n = withRequest $ \x ->
15911702 x {L.port = n}
@@ -1600,8 +1711,8 @@ port n = withRequest $ \x ->
16001711--
16011712-- > decompress (const True)
16021713decompress ::
1603− -- | Predicate that is given MIME type, it
1604− -- 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.
16051716 (ByteString -> Bool) ->
16061717 Option scheme
16071718decompress f = withRequest $ \x ->
@@ -1651,7 +1762,7 @@ ignoreResponse = Proxy
16511762newtype JsonResponse a = JsonResponse (L.Response a)
16521763 deriving (Show)
16531764
1654−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
16551766 type HttpResponseBody (JsonResponse a) = a
16561767 toVanillaResponse (JsonResponse r) = r
16571768 getHttpResponse r = do
@@ -1703,7 +1814,7 @@ lbsResponse = Proxy
17031814----------------------------------------------------------------------------
17041815-- Helpers for response interpretations
17051816
1706−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
17071818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
17081819-- such.
17091820grabPreview ::
@@ -1767,14 +1878,14 @@ brReadN br n = go 0 id id
17671878
17681879-- | Get the response body.
17691880responseBody ::
1770− HttpResponse response =>
1881+ (HttpResponse response) =>
17711882 response ->
17721883 HttpResponseBody response
17731884responseBody = L.responseBody . toVanillaResponse
17741885
17751886-- | Get the response status code.
17761887responseStatusCode ::
1777− HttpResponse response =>
1888+ (HttpResponse response) =>
17781889 response ->
17791890 Int
17801891responseStatusCode =
@@ -1782,7 +1893,7 @@ responseStatusCode =
17821893
17831894-- | Get the response status message.
17841895responseStatusMessage ::
1785− HttpResponse response =>
1896+ (HttpResponse response) =>
17861897 response ->
17871898 ByteString
17881899responseStatusMessage =
@@ -1790,7 +1901,7 @@ responseStatusMessage =
17901901
17911902-- | Lookup a particular header from a response.
17921903responseHeader ::
1793− HttpResponse response =>
1904+ (HttpResponse response) =>
17941905 -- | Response interpretation
17951906 response ->
17961907 -- | Header to lookup
@@ -1802,7 +1913,7 @@ responseHeader r h =
18021913
18031914-- | Get the response 'L.CookieJar'.
18041915responseCookieJar ::
1805− HttpResponse response =>
1916+ (HttpResponse response) =>
18061917 response ->
18071918 L.CookieJar
18081919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1815,9 +1926,9 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
18151926-- To create a new response interpretation you just need to make your data
18161927-- type an instance of the 'HttpResponse' type class.
18171928
1818−-- | A type class for response interpretations. It allows to describe how to
1819−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1820−-- 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.
18211932class HttpResponse response where
18221933 -- | The associated type is the type of body that can be extracted from an
18231934 -- instance of 'HttpResponse'.
@@ -1856,6 +1967,16 @@ class HttpResponse response where
18561967 acceptHeader :: Proxy response -> Maybe ByteString
18571968 acceptHeader Proxy = Nothing
18581969
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+
18591980----------------------------------------------------------------------------
18601981-- Other
18611982
@@ -1881,7 +2002,7 @@ class RequestComponent a where
18812002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
18822003-- which instance to use (i.e. the constraints are taken into account later,
18832004-- when instance is already chosen).
1884−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
18852006
18862007-- | Exceptions that this library throws.
18872008data HttpException
@@ -1890,10 +2011,24 @@ data HttpException
18902011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
18912012 -- failed
18922013 JsonHttpException String
1893− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
18942015
18952016instance Exception HttpException
18962017
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+
18972032-- | A simple type isomorphic to 'Bool' that we only have for better error
18982033-- messages. We use it as a kind and its data constructors as type-level
18992034-- tags.
@@ -1913,4 +2048,4 @@ data Scheme
19132048 Http
19142049 | -- | HTTPS
19152050 Https
1916− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)