@@ -1,9 +1,20 @@
1+{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE DataKinds #-}
3{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE DeriveDataTypeable #-}
5+{-# LANGUAGE DeriveGeneric #-}
6+{-# LANGUAGE DeriveLift #-}
7+{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2{-# LANGUAGE LambdaCase #-}
9{-# LANGUAGE LambdaCase #-}
10+{-# LANGUAGE MultiParamTypeClasses #-}
3{-# LANGUAGE OverloadedStrings #-}
11{-# LANGUAGE OverloadedStrings #-}
4{-# LANGUAGE QuasiQuotes #-}
12{-# LANGUAGE QuasiQuotes #-}
13+{-# LANGUAGE RankNTypes #-}
5{-# LANGUAGE RecordWildCards #-}
14{-# LANGUAGE RecordWildCards #-}
6{-# LANGUAGE RoleAnnotations #-}
15{-# LANGUAGE RoleAnnotations #-}
16+{-# LANGUAGE ScopedTypeVariables #-}
17+{-# LANGUAGE StandaloneDeriving #-}
7{-# LANGUAGE TemplateHaskellQuotes #-}
18{-# LANGUAGE TemplateHaskellQuotes #-}
8{-# LANGUAGE TypeFamilies #-}
19{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE UndecidableInstances #-}
20{-# LANGUAGE UndecidableInstances #-}
@@ -144,13 +155,11 @@ module Network.HTTP.Req
144 -- $query-parameters
155 -- $query-parameters
146 queryFlag,
157 queryFlag,
148 QueryParam (..),
158 QueryParam (..),
150 -- *** Headers
160 -- *** Headers
152 attachHeader,
162 attachHeader,
155 -- *** Cookies
164 -- *** Cookies
156 -- $cookies
165 -- $cookies
@@ -197,78 +206,58 @@ module Network.HTTP.Req
198 -- * Other
207 -- * Other
199 HttpException (..),
208 HttpException (..),
200− isStatusCodeException,
201 CanHaveBody (..),
209 CanHaveBody (..),
202 Scheme (..),
210 Scheme (..),
206−import Blaze.ByteString.Builder qualified as BB
214+import qualified Blaze.ByteString.Builder as BB
207import Control.Applicative
215import Control.Applicative
208import Control.Arrow (first, second)
216import Control.Arrow (first, second)
209import Control.Exception hiding (Handler (..), TypeError)
217import Control.Exception hiding (Handler (..), TypeError)
210−import Control.Monad (guard, void, (>=>))
211import Control.Monad.Base
218import Control.Monad.Base
212import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
219import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
213import Control.Monad.IO.Class
220import Control.Monad.IO.Class
214import Control.Monad.IO.Unlift
221import Control.Monad.IO.Unlift
215−import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
222+import Control.Monad.Reader
216−import Control.Monad.Trans.Accum (AccumT)
217−import Control.Monad.Trans.Cont (ContT)
218import Control.Monad.Trans.Control
223import 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
231import Control.Retry
224import Control.Retry
232import Data.Aeson (FromJSON (..), ToJSON (..))
225import Data.Aeson (FromJSON (..), ToJSON (..))
233−import Data.Aeson qualified as A
226+import qualified Data.Aeson as A
234import Data.ByteString (ByteString)
227import Data.ByteString (ByteString)
235−import Data.ByteString qualified as B
228+import qualified Data.ByteString as B
236−import Data.ByteString.Lazy qualified as BL
229+import qualified Data.ByteString.Lazy as BL
237−import Data.CaseInsensitive qualified as CI
230+import qualified Data.CaseInsensitive as CI
238import Data.Data (Data)
231import Data.Data (Data)
239−import Data.Default.Class (def)
240import Data.Function (on)
232import Data.Function (on)
241import Data.IORef
233import Data.IORef
242import Data.Kind (Constraint, Type)
234import Data.Kind (Constraint, Type)
243import Data.List (foldl', nubBy)
235import Data.List (foldl', nubBy)
244import Data.List.NonEmpty (NonEmpty (..))
236import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
237+import qualified Data.List.NonEmpty as NE
246import Data.Maybe (fromMaybe)
238import Data.Maybe (fromMaybe)
247import Data.Proxy
239import Data.Proxy
248−import Data.Semigroup (Endo (..))
240+import Data.Semigroup hiding (Option, option)
249−import Data.Set qualified as S
250import Data.Text (Text)
241import Data.Text (Text)
251−import Data.Text qualified as T
242+import qualified Data.Text as T
252−import Data.Text.Encoding qualified as T
243+import qualified Data.Text.Encoding as T
253import Data.Typeable (Typeable, cast)
244import Data.Typeable (Typeable, cast)
254import GHC.Generics
245import GHC.Generics
255import GHC.TypeLits
246import GHC.TypeLits
256−import Language.Haskell.TH qualified as TH
247+import qualified Language.Haskell.TH as TH
257−import Language.Haskell.TH.Quote qualified as TH
248+import qualified Language.Haskell.TH.Quote as TH
258−import Language.Haskell.TH.Syntax qualified as TH
249+import qualified Language.Haskell.TH.Syntax as TH
259−import Network.Connection qualified as NC
250+import qualified Network.Connection as NC
260−import Network.HTTP.Client qualified as L
251+import qualified Network.HTTP.Client as L
261−import Network.HTTP.Client.Internal qualified as LI
252+import qualified Network.HTTP.Client.Internal as LI
262−import Network.HTTP.Client.MultipartFormData qualified as LM
253+import qualified Network.HTTP.Client.MultipartFormData as LM
263−import Network.HTTP.Client.TLS qualified as L
254+import qualified Network.HTTP.Client.TLS as L
264−import Network.HTTP.Types qualified as Y
255+import qualified Network.HTTP.Types as Y
265import System.IO.Unsafe (unsafePerformIO)
256import System.IO.Unsafe (unsafePerformIO)
266import Text.URI (URI)
257import Text.URI (URI)
267−import Text.URI qualified as URI
258+import qualified Text.URI as URI
268−import Text.URI.QQ qualified as QQ
259+import qualified Text.URI.QQ as QQ
269−import Web.Authenticate.OAuth qualified as OAuth
260+import qualified Web.Authenticate.OAuth as OAuth
270−import Web.FormUrlEncoded (FromForm (..), ToForm (..))
271−import Web.FormUrlEncoded qualified as Form
272import Web.HttpApiData (ToHttpApiData (..))
261import Web.HttpApiData (ToHttpApiData (..))
274----------------------------------------------------------------------------
263----------------------------------------------------------------------------
@@ -489,7 +478,7 @@ reqCb method url body responseProxy options adjustRequest =
490-- @since 3.7.0
479-- @since 3.7.0
491reqHandler ::
480reqHandler ::
492− (MonadHttp m) =>
481+ MonadHttp m =>
493 -- | How to get final result from a 'L.Response'
482 -- | How to get final result from a 'L.Response'
494 (L.Response L.BodyReader -> IO b) ->
483 (L.Response L.BodyReader -> IO b) ->
495 -- | 'L.Request' to perform
484 -- | 'L.Request' to perform
@@ -585,10 +574,10 @@ req' method url body options m = do
585 withReqManager (m request)
574 withReqManager (m request)
587-- | Perform an action using the global implicit 'L.Manager' that the rest
576-- | Perform an action using the global implicit 'L.Manager' that the rest
588−-- of the library uses. This allows us to reuse connections that the
577+-- of the library uses. This allows to reuse connections that the
589-- 'L.Manager' controls.
578-- 'L.Manager' controls.
590−withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
579+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
591−withReqManager m = m globalManager
580+withReqManager m = liftIO (readIORef globalManager) >>= m
593-- | The global 'L.Manager' that 'req' uses. Here we just go with the
582-- | 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
583-- default settings, so users don't need to deal with this manager stuff at
@@ -601,16 +590,16 @@ withReqManager m = m globalManager
601-- manager. From that moment on the 'IORef' will be just reused—exactly the
590-- manager. From that moment on the 'IORef' will be just reused—exactly the
602-- behavior we want here in order to maximize connection sharing. GHC could
591-- behavior we want here in order to maximize connection sharing. GHC could
603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
592-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
593+globalManager :: IORef L.Manager
605globalManager = unsafePerformIO $ do
594globalManager = unsafePerformIO $ do
606 context <- NC.initConnectionContext
595 context <- NC.initConnectionContext
607 let settings =
596 let settings =
608 L.mkManagerSettingsContext
597 L.mkManagerSettingsContext
609 (Just context)
598 (Just context)
610− def
599+ (NC.TLSSettingsSimple False False False)
612 manager <- L.newManager settings
601 manager <- L.newManager settings
613− return manager
602+ newIORef manager
614{-# NOINLINE globalManager #-}
603{-# NOINLINE globalManager #-}
616----------------------------------------------------------------------------
605----------------------------------------------------------------------------
@@ -630,7 +619,7 @@ globalManager = unsafePerformIO $ do
630-- | A type class for monads that support performing HTTP requests.
619-- | A type class for monads that support performing HTTP requests.
631-- Typically, you only need to define the 'handleHttpException' method
620-- Typically, you only need to define the 'handleHttpException' method
632-- unless you want to tweak 'HttpConfig'.
621-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
622+class MonadIO m => MonadHttp m where
634 -- | This method describes how to deal with 'HttpException' that was
623 -- | This method describes how to deal with 'HttpException' that was
635 -- caught by the library. One option is to re-throw it if you are OK with
624 -- caught by the library. One option is to re-throw it if you are OK with
636 -- exceptions, but if you prefer working with something like
625 -- exceptions, but if you prefer working with something like
@@ -691,8 +680,8 @@ data HttpConfig = HttpConfig
691 -- | The retry policy to use for request retrying. By default 'def' is
680 -- | The retry policy to use for request retrying. By default 'def' is
692 -- used (see 'RetryPolicyM').
681 -- used (see 'RetryPolicyM').
694− -- __Note__: signature of this function was changed to disallow 'IO' in
683+ -- __Note__: signature of this function was changed in the version
695− -- version /1.0.0/ and then changed back to its current form in /3.1.0/.
684+ -- /1.0.0/.
697 -- @since 0.3.0
686 -- @since 0.3.0
698 httpConfigRetryPolicy :: RetryPolicyM IO,
687 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -714,8 +703,9 @@ data HttpConfig = HttpConfig
714 -- | Max length of preview fragment of response body.
703 -- | Max length of preview fragment of response body.
716 -- @since 3.6.0
705 -- @since 3.6.0
717− httpConfigBodyPreviewLength :: forall a. (Num a) => a
706+ httpConfigBodyPreviewLength :: forall a. Num a => a
720-- | The default value of 'HttpConfig'.
710-- | The default value of 'HttpConfig'.
@@ -797,87 +787,12 @@ instance MonadHttp Req where
797 handleHttpException = Req . lift . throwIO
787 handleHttpException = Req . lift . throwIO
798 getHttpConfig = Req ask
788 getHttpConfig = Req ask
801−instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802− handleHttpException = lift . handleHttpException
803− getHttpConfig = lift getHttpConfig
806−instance (MonadHttp m) => MonadHttp (ContT r m) where
807− handleHttpException = lift . handleHttpException
808− getHttpConfig = lift getHttpConfig
811−instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812− handleHttpException = lift . handleHttpException
813− getHttpConfig = lift getHttpConfig
816−instance (MonadHttp m) => MonadHttp (IdentityT m) where
817− handleHttpException = lift . handleHttpException
818− getHttpConfig = lift getHttpConfig
821−instance (MonadHttp m) => MonadHttp (MaybeT m) where
822− handleHttpException = lift . handleHttpException
823− getHttpConfig = lift getHttpConfig
826−instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827− handleHttpException = lift . handleHttpException
828− getHttpConfig = lift getHttpConfig
831−instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832− handleHttpException = lift . handleHttpException
833− getHttpConfig = lift getHttpConfig
836−instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837− handleHttpException = lift . handleHttpException
838− getHttpConfig = lift getHttpConfig
841−instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842− handleHttpException = lift . handleHttpException
843− getHttpConfig = lift getHttpConfig
846−instance (MonadHttp m) => MonadHttp (SelectT r m) where
847− handleHttpException = lift . handleHttpException
848− getHttpConfig = lift getHttpConfig
851−instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852− handleHttpException = lift . handleHttpException
853− getHttpConfig = lift getHttpConfig
856−instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857− handleHttpException = lift . handleHttpException
858− getHttpConfig = lift getHttpConfig
861−instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862− handleHttpException = lift . handleHttpException
863− getHttpConfig = lift getHttpConfig
866−instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867− handleHttpException = lift . handleHttpException
868− getHttpConfig = lift getHttpConfig
871−instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872− handleHttpException = lift . handleHttpException
873− getHttpConfig = lift getHttpConfig
875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
790-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
876-- the case of an exceptional situation an 'HttpException' will be thrown.
791-- the case of an exceptional situation an 'HttpException' will be thrown.
878-- @since 0.4.0
793-- @since 0.4.0
880− (MonadIO m) =>
795+ MonadIO m =>
881 -- | 'HttpConfig' to use
796 -- | 'HttpConfig' to use
882 HttpConfig ->
797 HttpConfig ->
883 -- | Computation to run
798 -- | Computation to run
@@ -982,7 +897,7 @@ class HttpMethod a where
982 -- | Return name of the method as a 'ByteString'.
897 -- | Return name of the method as a 'ByteString'.
983 httpMethodName :: Proxy a -> ByteString
898 httpMethodName :: Proxy a -> ByteString
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
900+instance HttpMethod method => RequestComponent (Tagged "method" method) where
986 getRequestMod _ = Endo $ \x ->
901 getRequestMod _ = Endo $ \x ->
987 x {L.method = httpMethodName (Proxy :: Proxy method)}
902 x {L.method = httpMethodName (Proxy :: Proxy method)}
@@ -1024,20 +939,23 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
939-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
940data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026 -- NOTE The second value is the path segments in reversed order.
941 -- NOTE The second value is the path segments in reversed order.
1027− deriving (Eq, Ord, Show, Data, Generic)
942+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
1029type role Url nominal
944type role Url nominal
1031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
946-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1032-- the derived lift forgets the type of the scheme.
947-- the derived lift forgets the type of the scheme.
1033−instance (Typeable scheme) => TH.Lift (Url scheme) where
948+instance Typeable scheme => TH.Lift (Url scheme) where
1034 lift url =
949 lift url =
1035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
950 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036 Url Http _ -> [t|Url 'Http|]
951 Url Http _ -> [t|Url 'Http|]
1037 Url Https _ -> [t|Url 'Https|]
952 Url Https _ -> [t|Url 'Https|]
1039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
954 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
956+#if MIN_VERSION_template_haskell(2,16,0)
1040− liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
957+ liftTyped url = TH.TExp <$> TH.lift url
1042-- | Given host name, produce a 'Url' which has “http” as its scheme and
960-- | Given host name, produce a 'Url' which has “http” as its scheme and
1043-- empty path. This also sets port to @80@.
961-- empty path. This also sets port to @80@.
@@ -1053,7 +971,7 @@ https = Url Https . pure
1053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
971-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1054infixl 5 /~
972infixl 5 /~
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
974+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
975Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1059-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
977-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
@@ -1241,7 +1159,7 @@ instance HttpBody NoReqBody where
1241-- charset=utf-8\"@ value.
1159-- charset=utf-8\"@ value.
1242newtype ReqBodyJson a = ReqBodyJson a
1160newtype ReqBodyJson a = ReqBodyJson a
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
1162+instance ToJSON a => HttpBody (ReqBodyJson a) where
1245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1163 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
1246 getRequestContentType _ = pure "application/json; charset=utf-8"
1164 getRequestContentType _ = pure "application/json; charset=utf-8"
@@ -1294,13 +1212,6 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
1294instance QueryParam FormUrlEncodedParam where
1212instance QueryParam FormUrlEncodedParam where
1295 queryParam name mvalue =
1213 queryParam name mvalue =
1296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1214 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297− queryParamToList (FormUrlEncodedParam p) = p
1299−-- | Use 'formToQuery'.
1302−instance FromForm FormUrlEncodedParam where
1303− fromForm = Right . formToQuery
1305-- | Multipart form data. Please consult the
1216-- | Multipart form data. Please consult the
1306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
1217-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1340,7 +1251,7 @@ instance HttpBody ReqBodyMultipart where
1340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1251-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
1342-- @since 0.2.0
1253-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
1254+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1344reqBodyMultipart parts = liftIO $ do
1255reqBodyMultipart parts = liftIO $ do
1345 boundary <- LM.webkitBoundary
1256 boundary <- LM.webkitBoundary
1346 body <- LM.renderParts boundary parts
1257 body <- LM.renderParts boundary parts
@@ -1380,7 +1291,7 @@ type family
1380 TypeError
1291 TypeError
1381 ('Text "This HTTP method does not allow attaching a request body.")
1292 ('Text "This HTTP method does not allow attaching a request body.")
1383−instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1294+instance HttpBody body => RequestComponent (Tagged "body" body) where
1384 getRequestMod (Tagged body) = Endo $ \x ->
1295 getRequestMod (Tagged body) = Endo $ \x ->
1386 { L.requestBody = getRequestBody body,
1297 { L.requestBody = getRequestBody body,
@@ -1426,12 +1337,6 @@ instance Monoid (Option scheme) where
1426 mempty = Option mempty Nothing
1337 mempty = Option mempty Nothing
1427 mappend = (<>)
1338 mappend = (<>)
1429−-- | Use 'formToQuery'.
1432−instance FromForm (Option scheme) where
1433− fromForm = Right . formToQuery
1435-- | A helper to create an 'Option' that modifies only collection of query
1340-- | A helper to create an 'Option' that modifies only collection of query
1436-- parameters. This helper is not a part of the public API.
1341-- parameters. This helper is not a part of the public API.
1437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
1342withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1450,7 +1355,7 @@ instance RequestComponent (Option scheme) where
1451-- | Finalize given 'L.Request' by applying a finalizer from the given
1356-- | Finalize given 'L.Request' by applying a finalizer from the given
1452-- 'Option' (if it has any).
1357-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1358+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1359finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
1456----------------------------------------------------------------------------
1361----------------------------------------------------------------------------
@@ -1483,27 +1388,9 @@ name =: value = queryParam name (pure value)
1483-- This operator is defined in terms of 'queryParam':
1388-- This operator is defined in terms of 'queryParam':
1485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1390-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486−queryFlag :: (QueryParam param) => Text -> param
1391+queryFlag :: QueryParam param => Text -> param
1487queryFlag name = queryParam name (Nothing :: Maybe ())
1392queryFlag name = queryParam name (Nothing :: Maybe ())
1489−-- | Construct query parameters from a 'ToForm' instance. This function
1490−-- produces the same query params as 'Form.urlEncodeAsFormStable'.
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@).
1498−formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499−formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1501− toParam (key, val) =
1507-- | A type class for query-parameter-like things. The reason to have an
1394-- | A type class for query-parameter-like things. The reason to have an
1508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1395-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
1509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
1396-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1513,17 +1400,11 @@ class QueryParam param where
1513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1400 -- 'Nothing', it won't be included at all (i.e. you create a flag this
1514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1401 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
1515 -- method, because they are easier to read.
1402 -- method, because they are easier to read.
1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1403+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1518− -- | Get the query parameter names and values set by 'queryParam'.
1521− queryParamToList :: param -> [(Text, Maybe Text)]
1523instance QueryParam (Option scheme) where
1405instance QueryParam (Option scheme) where
1524 queryParam name mvalue =
1406 queryParam name mvalue =
1525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1407 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
1528----------------------------------------------------------------------------
1409----------------------------------------------------------------------------
1529-- Request—Optional parameters—Headers
1410-- Request—Optional parameters—Headers
@@ -1547,14 +1428,6 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
1547attachHeader name value x =
1428attachHeader name value x =
1548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
1429 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}
1558----------------------------------------------------------------------------
1431----------------------------------------------------------------------------
1559-- Request—Optional parameters—Cookies
1432-- Request—Optional parameters—Cookies
@@ -1762,7 +1635,7 @@ ignoreResponse = Proxy
1762newtype JsonResponse a = JsonResponse (L.Response a)
1635newtype JsonResponse a = JsonResponse (L.Response a)
1763 deriving (Show)
1636 deriving (Show)
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1638+instance FromJSON a => HttpResponse (JsonResponse a) where
1766 type HttpResponseBody (JsonResponse a) = a
1639 type HttpResponseBody (JsonResponse a) = a
1767 toVanillaResponse (JsonResponse r) = r
1640 toVanillaResponse (JsonResponse r) = r
1768 getHttpResponse r = do
1641 getHttpResponse r = do
@@ -1878,14 +1751,14 @@ brReadN br n = go 0 id id
1879-- | Get the response body.
1752-- | Get the response body.
1880responseBody ::
1753responseBody ::
1881− (HttpResponse response) =>
1754+ HttpResponse response =>
1882 response ->
1755 response ->
1883 HttpResponseBody response
1756 HttpResponseBody response
1884responseBody = L.responseBody . toVanillaResponse
1757responseBody = L.responseBody . toVanillaResponse
1886-- | Get the response status code.
1759-- | Get the response status code.
1887responseStatusCode ::
1760responseStatusCode ::
1888− (HttpResponse response) =>
1761+ HttpResponse response =>
1889 response ->
1762 response ->
1891responseStatusCode =
1764responseStatusCode =
@@ -1893,7 +1766,7 @@ responseStatusCode =
1894-- | Get the response status message.
1767-- | Get the response status message.
1895responseStatusMessage ::
1768responseStatusMessage ::
1896− (HttpResponse response) =>
1769+ HttpResponse response =>
1897 response ->
1770 response ->
1898 ByteString
1771 ByteString
1899responseStatusMessage =
1772responseStatusMessage =
@@ -1901,7 +1774,7 @@ responseStatusMessage =
1902-- | Lookup a particular header from a response.
1775-- | Lookup a particular header from a response.
1903responseHeader ::
1776responseHeader ::
1904− (HttpResponse response) =>
1777+ HttpResponse response =>
1905 -- | Response interpretation
1778 -- | Response interpretation
1906 response ->
1779 response ->
1907 -- | Header to lookup
1780 -- | Header to lookup
@@ -1913,7 +1786,7 @@ responseHeader r h =
1914-- | Get the response 'L.CookieJar'.
1787-- | Get the response 'L.CookieJar'.
1915responseCookieJar ::
1788responseCookieJar ::
1916− (HttpResponse response) =>
1789+ HttpResponse response =>
1917 response ->
1790 response ->
1918 L.CookieJar
1791 L.CookieJar
1919responseCookieJar = L.responseCookieJar . toVanillaResponse
1792responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1967,16 +1840,6 @@ class HttpResponse response where
1967 acceptHeader :: Proxy response -> Maybe ByteString
1840 acceptHeader :: Proxy response -> Maybe ByteString
1968 acceptHeader Proxy = Nothing
1841 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
1980----------------------------------------------------------------------------
1843----------------------------------------------------------------------------
@@ -2011,24 +1874,10 @@ data HttpException
2011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
1874 | -- | A wrapper with Aeson-produced 'String' describing why decoding
2012 -- failed
1875 -- failed
2013 JsonHttpException String
1876 JsonHttpException String
2014− deriving (Show, Generic)
1877+ deriving (Show, Typeable, Generic)
2016instance Exception HttpException
1879instance 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
2032-- | A simple type isomorphic to 'Bool' that we only have for better error
1881-- | A simple type isomorphic to 'Bool' that we only have for better error
2033-- messages. We use it as a kind and its data constructors as type-level
1882-- messages. We use it as a kind and its data constructors as type-level
@@ -2048,4 +1897,4 @@ data Scheme
2049 | -- | HTTPS
1898 | -- | HTTPS
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1900+ deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)