@@ -1,20 +1,9 @@
1−{-# LANGUAGE BangPatterns #-}
3{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE DeriveDataTypeable #-}
5−{-# LANGUAGE DeriveGeneric #-}
6−{-# LANGUAGE DeriveLift #-}
7−{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
11{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
12{-# LANGUAGE QuasiQuotes #-}
4{-# LANGUAGE QuasiQuotes #-}
13−{-# LANGUAGE RankNTypes #-}
14{-# LANGUAGE RecordWildCards #-}
5{-# LANGUAGE RecordWildCards #-}
15{-# LANGUAGE RoleAnnotations #-}
6{-# LANGUAGE RoleAnnotations #-}
16−{-# LANGUAGE ScopedTypeVariables #-}
17−{-# LANGUAGE StandaloneDeriving #-}
18{-# LANGUAGE TemplateHaskellQuotes #-}
7{-# LANGUAGE TemplateHaskellQuotes #-}
19{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
20{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
@@ -161,6 +150,7 @@ module Network.HTTP.Req
161 -- *** Headers
150 -- *** Headers
163 attachHeader,
152 attachHeader,
165 -- *** Cookies
155 -- *** Cookies
166 -- $cookies
156 -- $cookies
@@ -207,74 +197,78 @@ module Network.HTTP.Req
208 -- * Other
198 -- * Other
209 HttpException (..),
199 HttpException (..),
200+ isStatusCodeException,
210 CanHaveBody (..),
201 CanHaveBody (..),
211 Scheme (..),
202 Scheme (..),
215−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
216import Control.Applicative
207import Control.Applicative
217import Control.Arrow (first, second)
208import Control.Arrow (first, second)
218import Control.Exception hiding (Handler (..), TypeError)
209import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
219import Control.Monad.Base
211import Control.Monad.Base
220import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
212import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
221import Control.Monad.IO.Class
213import Control.Monad.IO.Class
222import Control.Monad.IO.Unlift
214import Control.Monad.IO.Unlift
223−import Control.Monad.Reader
215+import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
224import Control.Monad.Trans.Accum (AccumT)
216import Control.Monad.Trans.Accum (AccumT)
225import Control.Monad.Trans.Cont (ContT)
217import Control.Monad.Trans.Cont (ContT)
226import Control.Monad.Trans.Control
218import Control.Monad.Trans.Control
227import Control.Monad.Trans.Except (ExceptT)
219import Control.Monad.Trans.Except (ExceptT)
228import Control.Monad.Trans.Identity (IdentityT)
220import Control.Monad.Trans.Identity (IdentityT)
229import Control.Monad.Trans.Maybe (MaybeT)
221import Control.Monad.Trans.Maybe (MaybeT)
230−import qualified Control.Monad.Trans.RWS.CPS as RWS.CPS
222+import Control.Monad.Trans.RWS.CPS qualified as RWS.CPS
231−import qualified Control.Monad.Trans.RWS.Lazy as RWS.Lazy
223+import Control.Monad.Trans.RWS.Lazy qualified as RWS.Lazy
232−import qualified Control.Monad.Trans.RWS.Strict as RWS.Strict
224+import Control.Monad.Trans.RWS.Strict qualified as RWS.Strict
233import Control.Monad.Trans.Select (SelectT)
225import Control.Monad.Trans.Select (SelectT)
234−import qualified Control.Monad.Trans.State.Lazy as State.Lazy
226+import Control.Monad.Trans.State.Lazy qualified as State.Lazy
235−import qualified Control.Monad.Trans.State.Strict as State.Strict
227+import Control.Monad.Trans.State.Strict qualified as State.Strict
236−import qualified Control.Monad.Trans.Writer.CPS as Writer.CPS
228+import Control.Monad.Trans.Writer.CPS qualified as Writer.CPS
237−import qualified Control.Monad.Trans.Writer.Lazy as Writer.Lazy
229+import Control.Monad.Trans.Writer.Lazy qualified as Writer.Lazy
238−import qualified Control.Monad.Trans.Writer.Strict as Writer.Strict
230+import Control.Monad.Trans.Writer.Strict qualified as Writer.Strict
239import Control.Retry
231import Control.Retry
240import Data.Aeson (FromJSON (..), ToJSON (..))
232import Data.Aeson (FromJSON (..), ToJSON (..))
241−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
242import Data.ByteString (ByteString)
234import Data.ByteString (ByteString)
243−import qualified Data.ByteString as B
235+import Data.ByteString qualified as B
244−import qualified Data.ByteString.Lazy as BL
236+import Data.ByteString.Lazy qualified as BL
245−import qualified Data.CaseInsensitive as CI
237+import Data.CaseInsensitive qualified as CI
246import Data.Data (Data)
238import Data.Data (Data)
239+import Data.Default.Class (def)
247import Data.Function (on)
240import Data.Function (on)
248import Data.IORef
241import Data.IORef
249import Data.Kind (Constraint, Type)
242import Data.Kind (Constraint, Type)
250import Data.List (foldl', nubBy)
243import Data.List (foldl', nubBy)
251import Data.List.NonEmpty (NonEmpty (..))
244import Data.List.NonEmpty (NonEmpty (..))
252−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
253import Data.Maybe (fromMaybe)
246import Data.Maybe (fromMaybe)
254import Data.Proxy
247import Data.Proxy
255import Data.Semigroup (Endo (..))
248import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
256import Data.Text (Text)
250import Data.Text (Text)
257−import qualified Data.Text as T
251+import Data.Text qualified as T
258−import qualified Data.Text.Encoding as T
252+import Data.Text.Encoding qualified as T
259import Data.Typeable (Typeable, cast)
253import Data.Typeable (Typeable, cast)
260import GHC.Generics
254import GHC.Generics
261import GHC.TypeLits
255import GHC.TypeLits
262−import qualified Language.Haskell.TH as TH
256+import Language.Haskell.TH qualified as TH
263−import qualified Language.Haskell.TH.Quote as TH
257+import Language.Haskell.TH.Quote qualified as TH
264−import qualified Language.Haskell.TH.Syntax as TH
258+import Language.Haskell.TH.Syntax qualified as TH
265−import qualified Network.Connection as NC
259+import Network.Connection qualified as NC
266−import qualified Network.HTTP.Client as L
260+import Network.HTTP.Client qualified as L
267−import qualified Network.HTTP.Client.Internal as LI
261+import Network.HTTP.Client.Internal qualified as LI
268−import qualified Network.HTTP.Client.MultipartFormData as LM
262+import Network.HTTP.Client.MultipartFormData qualified as LM
269−import qualified Network.HTTP.Client.TLS as L
263+import Network.HTTP.Client.TLS qualified as L
270−import qualified Network.HTTP.Types as Y
264+import Network.HTTP.Types qualified as Y
271import System.IO.Unsafe (unsafePerformIO)
265import System.IO.Unsafe (unsafePerformIO)
272import Text.URI (URI)
266import Text.URI (URI)
273−import qualified Text.URI as URI
267+import Text.URI qualified as URI
274−import qualified Text.URI.QQ as QQ
268+import Text.URI.QQ qualified as QQ
275−import qualified Web.Authenticate.OAuth as OAuth
269+import Web.Authenticate.OAuth qualified as OAuth
276import Web.FormUrlEncoded (FromForm (..), ToForm (..))
270import Web.FormUrlEncoded (FromForm (..), ToForm (..))
277−import qualified Web.FormUrlEncoded as Form
271+import Web.FormUrlEncoded qualified as Form
278import Web.HttpApiData (ToHttpApiData (..))
272import Web.HttpApiData (ToHttpApiData (..))
280----------------------------------------------------------------------------
274----------------------------------------------------------------------------
@@ -495,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
496-- @since 3.7.0
490-- @since 3.7.0
497reqHandler ::
491reqHandler ::
498− MonadHttp m =>
492+ (MonadHttp m) =>
499 -- | How to get final result from a 'L.Response'
493 -- | How to get final result from a 'L.Response'
500 (L.Response L.BodyReader -> IO b) ->
494 (L.Response L.BodyReader -> IO b) ->
501 -- | 'L.Request' to perform
495 -- | 'L.Request' to perform
@@ -591,10 +585,10 @@ req' method url body options m = do
591 withReqManager (m request)
585 withReqManager (m request)
593-- | Perform an action using the global implicit 'L.Manager' that the rest
587-- | Perform an action using the global implicit 'L.Manager' that the rest
594−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
595-- 'L.Manager' controls.
589-- 'L.Manager' controls.
596−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
597−withReqManager m = liftIO (readIORef globalManager) >>= m
591+withReqManager m = m globalManager
599-- | The global 'L.Manager' that 'req' uses. Here we just go with the
593-- | The global 'L.Manager' that 'req' uses. Here we just go with the
600-- default settings, so users don't need to deal with this manager stuff at
594-- default settings, so users don't need to deal with this manager stuff at
@@ -607,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
607-- manager. From that moment on the 'IORef' will be just reused—exactly the
601-- manager. From that moment on the 'IORef' will be just reused—exactly the
608-- behavior we want here in order to maximize connection sharing. GHC could
602-- behavior we want here in order to maximize connection sharing. GHC could
609-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
610−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
611globalManager = unsafePerformIO $ do
605globalManager = unsafePerformIO $ do
612 context <- NC.initConnectionContext
606 context <- NC.initConnectionContext
613 let settings =
607 let settings =
614 L.mkManagerSettingsContext
608 L.mkManagerSettingsContext
615 (Just context)
609 (Just context)
616− (NC.TLSSettingsSimple False False False)
610+ def
618 manager <- L.newManager settings
612 manager <- L.newManager settings
619− newIORef manager
613+ return manager
620{-# NOINLINE globalManager #-}
614{-# NOINLINE globalManager #-}
622----------------------------------------------------------------------------
616----------------------------------------------------------------------------
@@ -636,7 +630,7 @@ globalManager = unsafePerformIO $ do
636-- | A type class for monads that support performing HTTP requests.
630-- | A type class for monads that support performing HTTP requests.
637-- Typically, you only need to define the 'handleHttpException' method
631-- Typically, you only need to define the 'handleHttpException' method
638-- unless you want to tweak 'HttpConfig'.
632-- unless you want to tweak 'HttpConfig'.
639−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
640 -- | This method describes how to deal with 'HttpException' that was
634 -- | This method describes how to deal with 'HttpException' that was
641 -- caught by the library. One option is to re-throw it if you are OK with
635 -- caught by the library. One option is to re-throw it if you are OK with
642 -- exceptions, but if you prefer working with something like
636 -- exceptions, but if you prefer working with something like
@@ -720,9 +714,8 @@ data HttpConfig = HttpConfig
720 -- | Max length of preview fragment of response body.
714 -- | Max length of preview fragment of response body.
722 -- @since 3.6.0
716 -- @since 3.6.0
723− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
727-- | The default value of 'HttpConfig'.
720-- | The default value of 'HttpConfig'.
@@ -810,27 +803,27 @@ instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
810 getHttpConfig = lift getHttpConfig
803 getHttpConfig = lift getHttpConfig
812-- | @since 3.10.0
805-- | @since 3.10.0
813−instance MonadHttp m => MonadHttp (ContT r m) where
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
814 handleHttpException = lift . handleHttpException
807 handleHttpException = lift . handleHttpException
815 getHttpConfig = lift getHttpConfig
808 getHttpConfig = lift getHttpConfig
817-- | @since 3.10.0
810-- | @since 3.10.0
818−instance MonadHttp m => MonadHttp (ExceptT e m) where
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
819 handleHttpException = lift . handleHttpException
812 handleHttpException = lift . handleHttpException
820 getHttpConfig = lift getHttpConfig
813 getHttpConfig = lift getHttpConfig
822-- | @since 3.10.0
815-- | @since 3.10.0
823−instance MonadHttp m => MonadHttp (IdentityT m) where
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
824 handleHttpException = lift . handleHttpException
817 handleHttpException = lift . handleHttpException
825 getHttpConfig = lift getHttpConfig
818 getHttpConfig = lift getHttpConfig
827-- | @since 3.10.0
820-- | @since 3.10.0
828−instance MonadHttp m => MonadHttp (MaybeT m) where
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
829 handleHttpException = lift . handleHttpException
822 handleHttpException = lift . handleHttpException
830 getHttpConfig = lift getHttpConfig
823 getHttpConfig = lift getHttpConfig
832-- | @since 3.10.0
825-- | @since 3.10.0
833−instance MonadHttp m => MonadHttp (ReaderT r m) where
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
834 handleHttpException = lift . handleHttpException
827 handleHttpException = lift . handleHttpException
835 getHttpConfig = lift getHttpConfig
828 getHttpConfig = lift getHttpConfig
@@ -850,17 +843,17 @@ instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
850 getHttpConfig = lift getHttpConfig
843 getHttpConfig = lift getHttpConfig
852-- | @since 3.10.0
845-- | @since 3.10.0
853−instance MonadHttp m => MonadHttp (SelectT r m) where
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
854 handleHttpException = lift . handleHttpException
847 handleHttpException = lift . handleHttpException
855 getHttpConfig = lift getHttpConfig
848 getHttpConfig = lift getHttpConfig
857-- | @since 3.10.0
850-- | @since 3.10.0
858−instance MonadHttp m => MonadHttp (State.Lazy.StateT s m) where
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
859 handleHttpException = lift . handleHttpException
852 handleHttpException = lift . handleHttpException
860 getHttpConfig = lift getHttpConfig
853 getHttpConfig = lift getHttpConfig
862-- | @since 3.10.0
855-- | @since 3.10.0
863−instance MonadHttp m => MonadHttp (State.Strict.StateT s m) where
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
864 handleHttpException = lift . handleHttpException
857 handleHttpException = lift . handleHttpException
865 getHttpConfig = lift getHttpConfig
858 getHttpConfig = lift getHttpConfig
@@ -884,7 +877,7 @@ instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
885-- @since 0.4.0
878-- @since 0.4.0
887− MonadIO m =>
880+ (MonadIO m) =>
888 -- | 'HttpConfig' to use
881 -- | 'HttpConfig' to use
889 HttpConfig ->
882 HttpConfig ->
890 -- | Computation to run
883 -- | Computation to run
@@ -989,7 +982,7 @@ class HttpMethod a where
989 -- | Return name of the method as a 'ByteString'.
982 -- | Return name of the method as a 'ByteString'.
990 httpMethodName :: Proxy a -> ByteString
983 httpMethodName :: Proxy a -> ByteString
992−instance HttpMethod method => RequestComponent (Tagged "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
993 getRequestMod _ = Endo $ \x ->
986 getRequestMod _ = Endo $ \x ->
994 x {L.method = httpMethodName (Proxy :: Proxy method)}
987 x {L.method = httpMethodName (Proxy :: Proxy method)}
@@ -1031,25 +1024,20 @@ instance HttpMethod method => RequestComponent (Tagged "method" method) where
1031-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1032data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1033 -- NOTE The second value is the path segments in reversed order.
1026 -- NOTE The second value is the path segments in reversed order.
1034− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
1036type role Url nominal
1029type role Url nominal
1038-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1039-- the derived lift forgets the type of the scheme.
1032-- the derived lift forgets the type of the scheme.
1040−instance Typeable scheme => TH.Lift (Url scheme) where
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
1041 lift url =
1034 lift url =
1042 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1043 Url Http _ -> [t|Url 'Http|]
1036 Url Http _ -> [t|Url 'Http|]
1044 Url Https _ -> [t|Url 'Https|]
1037 Url Https _ -> [t|Url 'Https|]
1046 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1048−#if MIN_VERSION_template_haskell(2,17,0)
1049 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
1040 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
1050−#elif MIN_VERSION_template_haskell(2,16,0)
1051− liftTyped = TH.unsafeTExpCoerce . TH.lift
1054-- | Given host name, produce a 'Url' which has “http” as its scheme and
1042-- | Given host name, produce a 'Url' which has “http” as its scheme and
1055-- empty path. This also sets port to @80@.
1043-- empty path. This also sets port to @80@.
@@ -1065,7 +1053,7 @@ https = Url Https . pure
1065-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1066infixl 5 /~
1054infixl 5 /~
1068−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
1069Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1071-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
1059-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
@@ -1253,7 +1241,7 @@ instance HttpBody NoReqBody where
1253-- charset=utf-8\"@ value.
1241-- charset=utf-8\"@ value.
1254newtype ReqBodyJson a = ReqBodyJson a
1242newtype ReqBodyJson a = ReqBodyJson a
1256−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
1257 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1258 getRequestContentType _ = pure "application/json; charset=utf-8"
1246 getRequestContentType _ = pure "application/json; charset=utf-8"
@@ -1352,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
1352-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1354-- @since 0.2.0
1342-- @since 0.2.0
1355−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
1356reqBodyMultipart parts = liftIO $ do
1344reqBodyMultipart parts = liftIO $ do
1357 boundary <- LM.webkitBoundary
1345 boundary <- LM.webkitBoundary
1358 body <- LM.renderParts boundary parts
1346 body <- LM.renderParts boundary parts
@@ -1392,7 +1380,7 @@ type family
1392 TypeError
1380 TypeError
1393 ('Text "This HTTP method does not allow attaching a request body.")
1381 ('Text "This HTTP method does not allow attaching a request body.")
1395−instance HttpBody body => RequestComponent (Tagged "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1396 getRequestMod (Tagged body) = Endo $ \x ->
1384 getRequestMod (Tagged body) = Endo $ \x ->
1398 { L.requestBody = getRequestBody body,
1386 { L.requestBody = getRequestBody body,
@@ -1462,7 +1450,7 @@ instance RequestComponent (Option scheme) where
1463-- | Finalize given 'L.Request' by applying a finalizer from the given
1451-- | Finalize given 'L.Request' by applying a finalizer from the given
1464-- 'Option' (if it has any).
1452-- 'Option' (if it has any).
1465−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1466finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1468----------------------------------------------------------------------------
1456----------------------------------------------------------------------------
@@ -1495,7 +1483,7 @@ name =: value = queryParam name (pure value)
1495-- This operator is defined in terms of 'queryParam':
1483-- This operator is defined in terms of 'queryParam':
1497-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1498−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
1499queryFlag name = queryParam name (Nothing :: Maybe ())
1487queryFlag name = queryParam name (Nothing :: Maybe ())
1501-- | Construct query parameters from a 'ToForm' instance. This function
1489-- | Construct query parameters from a 'ToForm' instance. This function
@@ -1525,7 +1513,7 @@ class QueryParam param where
1525 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1526 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1527 -- method, because they are easier to read.
1515 -- method, because they are easier to read.
1528− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1530 -- | Get the query parameter names and values set by 'queryParam'.
1518 -- | Get the query parameter names and values set by 'queryParam'.
@@ -1559,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1559attachHeader name value x =
1547attachHeader name value x =
1560 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1550+-- | Same as 'header', but with redacted values on print.
1553+headerRedacted :: ByteString -> ByteString -> Option scheme
1554+headerRedacted name value = withRequest $ \x ->
1555+ let y = attachHeader name value x
1556+ in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
1562----------------------------------------------------------------------------
1558----------------------------------------------------------------------------
1563-- Request—Optional parameters—Cookies
1559-- Request—Optional parameters—Cookies
@@ -1766,7 +1762,7 @@ ignoreResponse = Proxy
1766newtype JsonResponse a = JsonResponse (L.Response a)
1762newtype JsonResponse a = JsonResponse (L.Response a)
1767 deriving (Show)
1763 deriving (Show)
1769−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
1770 type HttpResponseBody (JsonResponse a) = a
1766 type HttpResponseBody (JsonResponse a) = a
1771 toVanillaResponse (JsonResponse r) = r
1767 toVanillaResponse (JsonResponse r) = r
1772 getHttpResponse r = do
1768 getHttpResponse r = do
@@ -1882,14 +1878,14 @@ brReadN br n = go 0 id id
1883-- | Get the response body.
1879-- | Get the response body.
1884responseBody ::
1880responseBody ::
1885− HttpResponse response =>
1881+ (HttpResponse response) =>
1886 response ->
1882 response ->
1887 HttpResponseBody response
1883 HttpResponseBody response
1888responseBody = L.responseBody . toVanillaResponse
1884responseBody = L.responseBody . toVanillaResponse
1890-- | Get the response status code.
1886-- | Get the response status code.
1891responseStatusCode ::
1887responseStatusCode ::
1892− HttpResponse response =>
1888+ (HttpResponse response) =>
1893 response ->
1889 response ->
1895responseStatusCode =
1891responseStatusCode =
@@ -1897,7 +1893,7 @@ responseStatusCode =
1898-- | Get the response status message.
1894-- | Get the response status message.
1899responseStatusMessage ::
1895responseStatusMessage ::
1900− HttpResponse response =>
1896+ (HttpResponse response) =>
1901 response ->
1897 response ->
1902 ByteString
1898 ByteString
1903responseStatusMessage =
1899responseStatusMessage =
@@ -1905,7 +1901,7 @@ responseStatusMessage =
1906-- | Lookup a particular header from a response.
1902-- | Lookup a particular header from a response.
1907responseHeader ::
1903responseHeader ::
1908− HttpResponse response =>
1904+ (HttpResponse response) =>
1909 -- | Response interpretation
1905 -- | Response interpretation
1910 response ->
1906 response ->
1911 -- | Header to lookup
1907 -- | Header to lookup
@@ -1917,7 +1913,7 @@ responseHeader r h =
1918-- | Get the response 'L.CookieJar'.
1914-- | Get the response 'L.CookieJar'.
1919responseCookieJar ::
1915responseCookieJar ::
1920− HttpResponse response =>
1916+ (HttpResponse response) =>
1921 response ->
1917 response ->
1922 L.CookieJar
1918 L.CookieJar
1923responseCookieJar = L.responseCookieJar . toVanillaResponse
1919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1971,6 +1967,16 @@ class HttpResponse response where
1971 acceptHeader :: Proxy response -> Maybe ByteString
1967 acceptHeader :: Proxy response -> Maybe ByteString
1972 acceptHeader Proxy = Nothing
1968 acceptHeader Proxy = Nothing
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
1974----------------------------------------------------------------------------
1980----------------------------------------------------------------------------
@@ -2005,10 +2011,24 @@ data HttpException
2005 | -- | A wrapper with Aeson-produced 'String' describing why decoding
2011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
2006 -- failed
2012 -- failed
2007 JsonHttpException String
2013 JsonHttpException String
2008− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
2010instance Exception HttpException
2016instance Exception HttpException
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2027+ (L.StatusCodeException r _)
2030+isStatusCodeException _ = Nothing
2012-- | A simple type isomorphic to 'Bool' that we only have for better error
2032-- | A simple type isomorphic to 'Bool' that we only have for better error
2013-- messages. We use it as a kind and its data constructors as type-level
2033-- messages. We use it as a kind and its data constructors as type-level
@@ -2028,4 +2048,4 @@ data Scheme
2029 | -- | HTTPS
2049 | -- | HTTPS
2031− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)