master..67be279 · typeable/req

git.iko.soy/typeable/req

11 files changed+206−312

unifiedsplit

.github/dependabot.yml−6 .github/workflows/ci.yaml+13−14 .gitignore−1 CHANGELOG.md−36 Network/HTTP/Req.hs+83−103 README.md+1−1 Setup.hs+6 cabal.project−4 httpbin-tests/Network/HTTP/ReqSpec.hs+42−86 pure-tests/Network/HTTP/ReqSpec.hs+18−18 req.cabal+43−43

.github/dependabot.ymldeleted−6

@@ -1,6 +0,0 @@

1−version: 2

2−updates:

3− - package-ecosystem: "github-actions"

4− directory: "/"

5− schedule:

6− interval: "weekly"

.github/workflows/ci.yaml+13−14

@@ -11,25 +11,27 @@ jobs:

1111 ormolu:

1212 runs-on: ubuntu-latest

1313 steps:

14− - uses: actions/checkout@v4

15− - uses: haskell-actions/run-ormolu@v17

14+ - uses: actions/checkout@v2.3.4

15+ - uses: mrkkrp/ormolu-action@v5

1616 build:

1717 runs-on: ubuntu-latest

1818 needs: ormolu

1919 strategy:

2020 matrix:

21− cabal: ["3.12"]

22− ghc: ["9.6.3", "9.8.2", "9.10.1"]

21+ cabal: ["3.6"]

22+ ghc: ["8.10.7", "9.0.2", "9.2.1"]

23+ env:

24+ CONFIG: "--enable-tests --enable-benchmarks --flags=dev"

2325 steps:

24− - uses: actions/checkout@v4

25− - uses: haskell-actions/setup@v2

26+ - uses: actions/checkout@v2.3.4

27+ - uses: haskell/actions/setup@v1.2.9

2628 id: setup-haskell-cabal

2729 with:

2830 ghc-version: ${{ matrix.ghc }}

2931 cabal-version: ${{ matrix.cabal }}

3032 - run: cabal update

31− - run: cabal freeze

32− - uses: actions/cache@v4.2.3

33+ - run: cabal freeze $CONFIG

34+ - uses: actions/cache@v2.1.3

3335 with:

3436 path: |

3537 ${{ steps.setup-haskell-cabal.outputs.cabal-store }}

@@ -38,10 +40,7 @@ jobs:

3840 restore-keys: |

3941 ${{ runner.os }}-${{ matrix.ghc }}-

4042 - run: cabal format && git diff --exit-code --color=always

41− - run: cabal build

42− - run: |

43− docker pull kennethreitz/httpbin

44− docker run -p 1234:80 kennethreitz/httpbin &

45− cabal test

46− - run: cabal haddock

43+ - run: cabal build $CONFIG

44+ - run: cabal test $CONFIG

45+ - run: cabal haddock $CONFIG

4746 - run: cabal sdist

.gitignore−1

@@ -25,6 +25,5 @@ cabal.project.local

2525cabal.sandbox.config

2626dist-*/

2727dist/

28−hie.yaml

2928stack.yaml

3029stack.yaml.lock

CHANGELOG.md−36

@@ -1,39 +1,3 @@

1−## Req 3.13.4

2−

3−* Fixed empty ciphersuite list when compiling against `tls < 2.0.6`

4− (see [PR 175](https://github.com/mrkkrp/req/pull/175)). As a side effect, now

5− compatible with older versions of `crypton-connection` (>= 0.3).

6−

7−## Req 3.13.3

8−

9−* Works with `crypton-connection-0.4` and newer.

10−

11−## Req 3.13.2

12−

13−* Disable the problematic `httpbin-tests` test suite by default. Only enable

14− it when the `dev` flag is enabled. In that case it is expected that an

15− httpbin server is run locally at `localhost:1234`.

16−

17−## Req 3.13.1

18−

19−* Switched the non-pure test suite to use https://httpbun.org instead of

20− https://httpbin.org since the latter proved to be highly unreliable

21− lately.

22−

23−* Switched from `connection` to `crypton-connection`.

24−

25−* Builds with GHC 9.6.1.

26−

27−## Req 3.13.0

28−

29−* Add `headerRedacted` function to add header fields, which will be with

30− redacted values on print.

31−

32−## Req 3.12.0

33−

34−* Add `isStatusCodeException` function.

35−* Add `instance HttpResponse (Network.HTTP.Client.Response ())`.

36−

371## Req 3.11.0

382

393* Add the `queryParamToList` method to the `QueryParam` type class.

Network/HTTP/Req.hs+83−103

@@ -1,9 +1,20 @@

1+{-# LANGUAGE BangPatterns #-}

2+{-# LANGUAGE CPP #-}

13{-# LANGUAGE DataKinds #-}

4+{-# LANGUAGE DeriveDataTypeable #-}

5+{-# LANGUAGE DeriveGeneric #-}

6+{-# LANGUAGE DeriveLift #-}

7+{-# LANGUAGE FlexibleInstances #-}

8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}

29{-# LANGUAGE LambdaCase #-}

10+{-# LANGUAGE MultiParamTypeClasses #-}

311{-# LANGUAGE OverloadedStrings #-}

412{-# LANGUAGE QuasiQuotes #-}

13+{-# LANGUAGE RankNTypes #-}

514{-# LANGUAGE RecordWildCards #-}

615{-# LANGUAGE RoleAnnotations #-}

16+{-# LANGUAGE ScopedTypeVariables #-}

17+{-# LANGUAGE StandaloneDeriving #-}

718{-# LANGUAGE TemplateHaskellQuotes #-}

819{-# LANGUAGE TypeFamilies #-}

920{-# LANGUAGE UndecidableInstances #-}

@@ -150,7 +161,6 @@ module Network.HTTP.Req

150161 -- *** Headers

151162 header,

152163 attachHeader,

153− headerRedacted,

154164

155165 -- *** Cookies

156166 -- $cookies

@@ -197,78 +207,74 @@ module Network.HTTP.Req

197207

198208 -- * Other

199209 HttpException (..),

200− isStatusCodeException,

201210 CanHaveBody (..),

202211 Scheme (..),

203212 )

204213where

205214

206−import Blaze.ByteString.Builder qualified as BB

215+import qualified Blaze.ByteString.Builder as BB

207216import Control.Applicative

208217import Control.Arrow (first, second)

209218import Control.Exception hiding (Handler (..), TypeError)

210−import Control.Monad (guard, void, (>=>))

211219import Control.Monad.Base

212220import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)

213221import Control.Monad.IO.Class

214222import Control.Monad.IO.Unlift

215−import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)

223+import Control.Monad.Reader

216224import Control.Monad.Trans.Accum (AccumT)

217225import Control.Monad.Trans.Cont (ContT)

218226import Control.Monad.Trans.Control

219227import Control.Monad.Trans.Except (ExceptT)

220228import Control.Monad.Trans.Identity (IdentityT)

221229import 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

230+import qualified Control.Monad.Trans.RWS.CPS as RWS.CPS

231+import qualified Control.Monad.Trans.RWS.Lazy as RWS.Lazy

232+import qualified Control.Monad.Trans.RWS.Strict as RWS.Strict

225233import 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

234+import qualified Control.Monad.Trans.State.Lazy as State.Lazy

235+import qualified Control.Monad.Trans.State.Strict as State.Strict

236+import qualified Control.Monad.Trans.Writer.CPS as Writer.CPS

237+import qualified Control.Monad.Trans.Writer.Lazy as Writer.Lazy

238+import qualified Control.Monad.Trans.Writer.Strict as Writer.Strict

231239import Control.Retry

232240import Data.Aeson (FromJSON (..), ToJSON (..))

233−import Data.Aeson qualified as A

241+import qualified Data.Aeson as A

234242import Data.ByteString (ByteString)

235−import Data.ByteString qualified as B

236−import Data.ByteString.Lazy qualified as BL

237−import Data.CaseInsensitive qualified as CI

243+import qualified Data.ByteString as B

244+import qualified Data.ByteString.Lazy as BL

245+import qualified Data.CaseInsensitive as CI

238246import Data.Data (Data)

239−import Data.Default.Class (def)

240247import Data.Function (on)

241248import Data.IORef

242249import Data.Kind (Constraint, Type)

243250import Data.List (foldl', nubBy)

244251import Data.List.NonEmpty (NonEmpty (..))

245−import Data.List.NonEmpty qualified as NE

252+import qualified Data.List.NonEmpty as NE

246253import Data.Maybe (fromMaybe)

247254import Data.Proxy

248255import Data.Semigroup (Endo (..))

249−import Data.Set qualified as S

250256import Data.Text (Text)

251−import Data.Text qualified as T

252−import Data.Text.Encoding qualified as T

257+import qualified Data.Text as T

258+import qualified Data.Text.Encoding as T

253259import Data.Typeable (Typeable, cast)

254260import GHC.Generics

255261import GHC.TypeLits

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

262+import qualified Language.Haskell.TH as TH

263+import qualified Language.Haskell.TH.Quote as TH

264+import qualified Language.Haskell.TH.Syntax as TH

265+import qualified Network.Connection as NC

266+import qualified Network.HTTP.Client as L

267+import qualified Network.HTTP.Client.Internal as LI

268+import qualified Network.HTTP.Client.MultipartFormData as LM

269+import qualified Network.HTTP.Client.TLS as L

270+import qualified Network.HTTP.Types as Y

265271import System.IO.Unsafe (unsafePerformIO)

266272import Text.URI (URI)

267−import Text.URI qualified as URI

268−import Text.URI.QQ qualified as QQ

269−import Web.Authenticate.OAuth qualified as OAuth

273+import qualified Text.URI as URI

274+import qualified Text.URI.QQ as QQ

275+import qualified Web.Authenticate.OAuth as OAuth

270276import Web.FormUrlEncoded (FromForm (..), ToForm (..))

271−import Web.FormUrlEncoded qualified as Form

277+import qualified Web.FormUrlEncoded as Form

272278import Web.HttpApiData (ToHttpApiData (..))

273279

274280----------------------------------------------------------------------------

@@ -489,7 +495,7 @@ reqCb method url body responseProxy options adjustRequest =

489495--

490496-- @since 3.7.0

491497reqHandler ::

492− (MonadHttp m) =>

498+ MonadHttp m =>

493499 -- | How to get final result from a 'L.Response'

494500 (L.Response L.BodyReader -> IO b) ->

495501 -- | 'L.Request' to perform

@@ -585,10 +591,10 @@ req' method url body options m = do

585591 withReqManager (m request)

586592

587593-- | 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

594+-- of the library uses. This allows to reuse connections that the

589595-- 'L.Manager' controls.

590−withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a

591−withReqManager m = m globalManager

596+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a

597+withReqManager m = liftIO (readIORef globalManager) >>= m

592598

593599-- | The global 'L.Manager' that 'req' uses. Here we just go with the

594600-- default settings, so users don't need to deal with this manager stuff at

@@ -601,16 +607,16 @@ withReqManager m = m globalManager

601607-- manager. From that moment on the 'IORef' will be just reused—exactly the

602608-- behavior we want here in order to maximize connection sharing. GHC could

603609-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.

604−globalManager :: L.Manager

610+globalManager :: IORef L.Manager

605611globalManager = unsafePerformIO $ do

606612 context <- NC.initConnectionContext

607613 let settings =

608614 L.mkManagerSettingsContext

609615 (Just context)

610− def

616+ (NC.TLSSettingsSimple False False False)

611617 Nothing

612618 manager <- L.newManager settings

613− return manager

619+ newIORef manager

614620{-# NOINLINE globalManager #-}

615621

616622----------------------------------------------------------------------------

@@ -630,7 +636,7 @@ globalManager = unsafePerformIO $ do

630636-- | A type class for monads that support performing HTTP requests.

631637-- Typically, you only need to define the 'handleHttpException' method

632638-- unless you want to tweak 'HttpConfig'.

633−class (MonadIO m) => MonadHttp m where

639+class MonadIO m => MonadHttp m where

634640 -- | This method describes how to deal with 'HttpException' that was

635641 -- caught by the library. One option is to re-throw it if you are OK with

636642 -- exceptions, but if you prefer working with something like

@@ -714,8 +720,9 @@ data HttpConfig = HttpConfig

714720 -- | Max length of preview fragment of response body.

715721 --

716722 -- @since 3.6.0

717− httpConfigBodyPreviewLength :: forall a. (Num a) => a

723+ httpConfigBodyPreviewLength :: forall a. Num a => a

718724 }

725+ deriving (Typeable)

719726

720727-- | The default value of 'HttpConfig'.

721728--

@@ -803,27 +810,27 @@ instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where

803810 getHttpConfig = lift getHttpConfig

804811

805812-- | @since 3.10.0

806−instance (MonadHttp m) => MonadHttp (ContT r m) where

813+instance MonadHttp m => MonadHttp (ContT r m) where

807814 handleHttpException = lift . handleHttpException

808815 getHttpConfig = lift getHttpConfig

809816

810817-- | @since 3.10.0

811−instance (MonadHttp m) => MonadHttp (ExceptT e m) where

818+instance MonadHttp m => MonadHttp (ExceptT e m) where

812819 handleHttpException = lift . handleHttpException

813820 getHttpConfig = lift getHttpConfig

814821

815822-- | @since 3.10.0

816−instance (MonadHttp m) => MonadHttp (IdentityT m) where

823+instance MonadHttp m => MonadHttp (IdentityT m) where

817824 handleHttpException = lift . handleHttpException

818825 getHttpConfig = lift getHttpConfig

819826

820827-- | @since 3.10.0

821−instance (MonadHttp m) => MonadHttp (MaybeT m) where

828+instance MonadHttp m => MonadHttp (MaybeT m) where

822829 handleHttpException = lift . handleHttpException

823830 getHttpConfig = lift getHttpConfig

824831

825832-- | @since 3.10.0

826−instance (MonadHttp m) => MonadHttp (ReaderT r m) where

833+instance MonadHttp m => MonadHttp (ReaderT r m) where

827834 handleHttpException = lift . handleHttpException

828835 getHttpConfig = lift getHttpConfig

829836

@@ -843,17 +850,17 @@ instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where

843850 getHttpConfig = lift getHttpConfig

844851

845852-- | @since 3.10.0

846−instance (MonadHttp m) => MonadHttp (SelectT r m) where

853+instance MonadHttp m => MonadHttp (SelectT r m) where

847854 handleHttpException = lift . handleHttpException

848855 getHttpConfig = lift getHttpConfig

849856

850857-- | @since 3.10.0

851−instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where

858+instance MonadHttp m => MonadHttp (State.Lazy.StateT s m) where

852859 handleHttpException = lift . handleHttpException

853860 getHttpConfig = lift getHttpConfig

854861

855862-- | @since 3.10.0

856−instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where

863+instance MonadHttp m => MonadHttp (State.Strict.StateT s m) where

857864 handleHttpException = lift . handleHttpException

858865 getHttpConfig = lift getHttpConfig

859866

@@ -877,7 +884,7 @@ instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where

877884--

878885-- @since 0.4.0

879886runReq ::

880− (MonadIO m) =>

887+ MonadIO m =>

881888 -- | 'HttpConfig' to use

882889 HttpConfig ->

883890 -- | Computation to run

@@ -982,7 +989,7 @@ class HttpMethod a where

982989 -- | Return name of the method as a 'ByteString'.

983990 httpMethodName :: Proxy a -> ByteString

984991

985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where

992+instance HttpMethod method => RequestComponent (Tagged "method" method) where

986993 getRequestMod _ = Endo $ \x ->

987994 x {L.method = httpMethodName (Proxy :: Proxy method)}

988995

@@ -1024,20 +1031,25 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where

10241031-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84

10251032data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)

10261033 -- NOTE The second value is the path segments in reversed order.

1027− deriving (Eq, Ord, Show, Data, Generic)

1034+ deriving (Eq, Ord, Show, Data, Typeable, Generic)

10281035

10291036type role Url nominal

10301037

10311038-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however

10321039-- the derived lift forgets the type of the scheme.

1033−instance (Typeable scheme) => TH.Lift (Url scheme) where

1040+instance Typeable scheme => TH.Lift (Url scheme) where

10341041 lift url =

10351042 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of

10361043 Url Http _ -> [t|Url 'Http|]

10371044 Url Https _ -> [t|Url 'Https|]

10381045 where

10391046 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)

1047+

1048+#if MIN_VERSION_template_haskell(2,17,0)

10401049 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift

1050+#elif MIN_VERSION_template_haskell(2,16,0)

1051+ liftTyped = TH.unsafeTExpCoerce . TH.lift

1052+#endif

10411053

10421054-- | Given host name, produce a 'Url' which has “http” as its scheme and

10431055-- empty path. This also sets port to @80@.

@@ -1053,7 +1065,7 @@ https = Url Https . pure

10531065-- path segment can be of any type that is an instance of 'ToHttpApiData'.

10541066infixl 5 /~

10551067

1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme

1068+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme

10571069Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)

10581070

10591071-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases

@@ -1241,7 +1253,7 @@ instance HttpBody NoReqBody where

12411253-- charset=utf-8\"@ value.

12421254newtype ReqBodyJson a = ReqBodyJson a

12431255

1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where

1256+instance ToJSON a => HttpBody (ReqBodyJson a) where

12451257 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)

12461258 getRequestContentType _ = pure "application/json; charset=utf-8"

12471259

@@ -1340,7 +1352,7 @@ instance HttpBody ReqBodyMultipart where

13401352-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.

13411353--

13421354-- @since 0.2.0

1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart

1355+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart

13441356reqBodyMultipart parts = liftIO $ do

13451357 boundary <- LM.webkitBoundary

13461358 body <- LM.renderParts boundary parts

@@ -1380,7 +1392,7 @@ type family

13801392 TypeError

13811393 ('Text "This HTTP method does not allow attaching a request body.")

13821394

1383−instance (HttpBody body) => RequestComponent (Tagged "body" body) where

1395+instance HttpBody body => RequestComponent (Tagged "body" body) where

13841396 getRequestMod (Tagged body) = Endo $ \x ->

13851397 x

13861398 { L.requestBody = getRequestBody body,

@@ -1450,7 +1462,7 @@ instance RequestComponent (Option scheme) where

14501462

14511463-- | Finalize given 'L.Request' by applying a finalizer from the given

14521464-- 'Option' (if it has any).

1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request

1465+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request

14541466finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer

14551467

14561468----------------------------------------------------------------------------

@@ -1483,7 +1495,7 @@ name =: value = queryParam name (pure value)

14831495-- This operator is defined in terms of 'queryParam':

14841496--

14851497-- > queryFlag name = queryParam name (Nothing :: Maybe ())

1486−queryFlag :: (QueryParam param) => Text -> param

1498+queryFlag :: QueryParam param => Text -> param

14871499queryFlag name = queryParam name (Nothing :: Maybe ())

14881500

14891501-- | Construct query parameters from a 'ToForm' instance. This function

@@ -1513,7 +1525,7 @@ class QueryParam param where

15131525 -- 'Nothing', it won't be included at all (i.e. you create a flag this

15141526 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this

15151527 -- method, because they are easier to read.

1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param

1528+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param

15171529

15181530 -- | Get the query parameter names and values set by 'queryParam'.

15191531 --

@@ -1547,14 +1559,6 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request

15471559attachHeader name value x =

15481560 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}

15491561

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−

15581562----------------------------------------------------------------------------

15591563-- Request—Optional parameters—Cookies

15601564

@@ -1762,7 +1766,7 @@ ignoreResponse = Proxy

17621766newtype JsonResponse a = JsonResponse (L.Response a)

17631767 deriving (Show)

17641768

1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where

1769+instance FromJSON a => HttpResponse (JsonResponse a) where

17661770 type HttpResponseBody (JsonResponse a) = a

17671771 toVanillaResponse (JsonResponse r) = r

17681772 getHttpResponse r = do

@@ -1878,14 +1882,14 @@ brReadN br n = go 0 id id

18781882

18791883-- | Get the response body.

18801884responseBody ::

1881− (HttpResponse response) =>

1885+ HttpResponse response =>

18821886 response ->

18831887 HttpResponseBody response

18841888responseBody = L.responseBody . toVanillaResponse

18851889

18861890-- | Get the response status code.

18871891responseStatusCode ::

1888− (HttpResponse response) =>

1892+ HttpResponse response =>

18891893 response ->

18901894 Int

18911895responseStatusCode =

@@ -1893,7 +1897,7 @@ responseStatusCode =

18931897

18941898-- | Get the response status message.

18951899responseStatusMessage ::

1896− (HttpResponse response) =>

1900+ HttpResponse response =>

18971901 response ->

18981902 ByteString

18991903responseStatusMessage =

@@ -1901,7 +1905,7 @@ responseStatusMessage =

19011905

19021906-- | Lookup a particular header from a response.

19031907responseHeader ::

1904− (HttpResponse response) =>

1908+ HttpResponse response =>

19051909 -- | Response interpretation

19061910 response ->

19071911 -- | Header to lookup

@@ -1913,7 +1917,7 @@ responseHeader r h =

19131917

19141918-- | Get the response 'L.CookieJar'.

19151919responseCookieJar ::

1916− (HttpResponse response) =>

1920+ HttpResponse response =>

19171921 response ->

19181922 L.CookieJar

19191923responseCookieJar = L.responseCookieJar . toVanillaResponse

@@ -1967,16 +1971,6 @@ class HttpResponse response where

19671971 acceptHeader :: Proxy response -> Maybe ByteString

19681972 acceptHeader Proxy = Nothing

19691973

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−

19801974----------------------------------------------------------------------------

19811975-- Other

19821976

@@ -2011,24 +2005,10 @@ data HttpException

20112005 | -- | A wrapper with Aeson-produced 'String' describing why decoding

20122006 -- failed

20132007 JsonHttpException String

2014− deriving (Show, Generic)

2008+ deriving (Show, Typeable, Generic)

20152009

20162010instance Exception HttpException

20172011

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−

20322012-- | A simple type isomorphic to 'Bool' that we only have for better error

20332013-- messages. We use it as a kind and its data constructors as type-level

20342014-- tags.

@@ -2048,4 +2028,4 @@ data Scheme

20482028 Http

20492029 | -- | HTTPS

20502030 Https

2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)

2031+ deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)

README.md+1−1

@@ -4,7 +4,7 @@

44[![Hackage](https://img.shields.io/hackage/v/req.svg?style=flat)](https://hackage.haskell.org/package/req)

55[![Stackage Nightly](http://stackage.org/package/req/badge/nightly)](http://stackage.org/nightly/package/req)

66[![Stackage LTS](http://stackage.org/package/req/badge/lts)](http://stackage.org/lts/package/req)

7−[![CI](https://github.com/mrkkrp/req/actions/workflows/ci.yaml/badge.svg)](https://github.com/mrkkrp/req/actions/workflows/ci.yaml)

7+![CI](https://github.com/mrkkrp/req/workflows/CI/badge.svg?branch=master)

99* [Related packages](#related-packages)

1010* [Blog posts](#blog-posts)

Setup.hsnew file+6

@@ -0,0 +1,6 @@

1+module Main (main) where

3+import Distribution.Simple

5+main :: IO ()

6+main = defaultMain

cabal.projectdeleted−4

@@ -1,4 +0,0 @@

1−packages: .

2−tests: True

3−benchmarks: True

4−constraints: req +dev

httpbin-tests/Network/HTTP/ReqSpec.hs+42−86

@@ -8,25 +8,24 @@

88module Network.HTTP.ReqSpec (spec) where

1010import Control.Exception

11−import Control.Monad (forM_)

11+import Control.Monad.Reader

1212import Control.Monad.Trans.Control

1313import Data.Aeson (ToJSON (..), Value (..), object, (.=))

14−import Data.Aeson qualified as A

15−import Data.Aeson.KeyMap qualified as Aeson.KeyMap

16−import Data.ByteString qualified as B

17−import Data.ByteString.Lazy qualified as BL

14+import qualified Data.Aeson as A

15+import qualified Data.Aeson.KeyMap as Aeson.KeyMap

16+import qualified Data.ByteString as B

17+import qualified Data.ByteString.Lazy as BL

1818import Data.Functor.Identity (runIdentity)

1919import Data.Maybe (fromJust)

2020import Data.Proxy

2121import Data.Text (Text)

22−import Data.Text qualified as T

23−import Data.Text.Encoding qualified as T

24−import Data.Text.IO qualified as TIO

25−import Network.HTTP.Client qualified as L

26−import Network.HTTP.Client.MultipartFormData qualified as LM

27−import Network.HTTP.Req hiding (req)

28−import Network.HTTP.Req qualified as Req

29−import Network.HTTP.Types qualified as Y

22+import qualified Data.Text as T

23+import qualified Data.Text.Encoding as T

24+import qualified Data.Text.IO as TIO

25+import qualified Network.HTTP.Client as L

26+import qualified Network.HTTP.Client.MultipartFormData as LM

27+import Network.HTTP.Req

28+import qualified Network.HTTP.Types as Y

3029import Test.Hspec

3130import Test.QuickCheck

3231

@@ -50,11 +49,6 @@ spec = do

5049 blindlyThrowing (req GET httpbin NoReqBody ignoreResponse mempty)

5150 `shouldThrow` anyException

5251

53− describe "isStatusCodeException" $

54− it "extracts non-2xx response" $

55− req GET (httpbin /: "foo") NoReqBody ignoreResponse mempty

56− `shouldThrow` selector404ByStatusCodeException

57−

5852 describe "receiving user-agent header back" $

5953 it "works" $ do

6054 r <-

@@ -85,7 +79,8 @@ spec = do

8579 .= object

8680 [ "Accept-Encoding" .= ("gzip" :: Text),

8781 "Foo" .= ("bar" :: Text),

88− "Baz" .= ("quux" :: Text)

82+ "Baz" .= ("quux" :: Text),

83+ "Host" .= ("httpbin.org" :: Text)

8984 ]

9085 ]

9186 responseStatusCode r `shouldBe` 200

@@ -97,10 +92,11 @@ spec = do

9792 (stripFunnyHeaders . stripOrigin) (responseBody r)

9893 `shouldBe` object

9994 [ "args" .= emptyObject,

100− "url" .= ("http://localhost:1234/get" :: Text),

95+ "url" .= ("https://httpbin.org/get" :: Text),

10196 "headers"

10297 .= object

103− [ "Accept-Encoding" .= ("gzip" :: Text)

98+ [ "Accept-Encoding" .= ("gzip" :: Text),

99+ "Host" .= ("httpbin.org" :: Text)

104100 ]

105101 ]

106102 responseHeader r "Content-Type" `shouldBe` return "application/json"

@@ -117,11 +113,12 @@ spec = do

117113 [ "args" .= emptyObject,

118114 "json" .= text,

119115 "data" .= reflected,

120− "url" .= ("http://localhost:1234/post" :: Text),

116+ "url" .= ("https://httpbin.org/post" :: Text),

121117 "headers"

122118 .= object

123119 [ "Content-Type" .= ("application/json; charset=utf-8" :: Text),

124120 "Accept-Encoding" .= ("gzip" :: Text),

121+ "Host" .= ("httpbin.org" :: Text),

125122 "Content-Length" .= show (T.length reflected)

126123 ],

127124 "files" .= emptyObject,

@@ -145,11 +142,12 @@ spec = do

145142 [ "args" .= emptyObject,

146143 "json" .= Null,

147144 "data" .= ("" :: Text),

148− "url" .= ("http://localhost:1234/post" :: Text),

145+ "url" .= ("https://httpbin.org/post" :: Text),

149146 "headers"

150147 .= object

151148 [ "Content-Type" .= T.decodeUtf8 contentType,

152149 "Accept-Encoding" .= ("gzip" :: Text),

150+ "Host" .= ("httpbin.org" :: Text),

153151 "Content-Length" .= ("242" :: Text)

154152 ],

155153 "files" .= emptyObject,

@@ -174,10 +172,11 @@ spec = do

174172 [ "args" .= emptyObject,

175173 "json" .= Null,

176174 "data" .= contents,

177− "url" .= ("http://localhost:1234/patch" :: Text),

175+ "url" .= ("https://httpbin.org/patch" :: Text),

178176 "headers"

179177 .= object

180178 [ "Accept-Encoding" .= ("gzip" :: Text),

179+ "Host" .= ("httpbin.org" :: Text),

181180 "Content-Length" .= show (T.length contents)

182181 ],

183182 "files" .= emptyObject,

@@ -199,11 +198,12 @@ spec = do

199198 [ "args" .= emptyObject,

200199 "json" .= Null,

201200 "data" .= ("" :: Text),

202− "url" .= ("http://localhost:1234/put" :: Text),

201+ "url" .= ("https://httpbin.org/put" :: Text),

203202 "headers"

204203 .= object

205204 [ "Content-Type" .= ("application/x-www-form-urlencoded" :: Text),

206205 "Accept-Encoding" .= ("gzip" :: Text),

206+ "Host" .= ("httpbin.org" :: Text),

207207 "Content-Length" .= ("18" :: Text)

208208 ],

209209 "files" .= emptyObject,

@@ -301,7 +301,7 @@ spec = do

301301 (httpbin /: "basic-auth" /~ user /~ password)

302302 NoReqBody

303303 ignoreResponse

304− (basicAuthUnsafe (T.encodeUtf8 user) (T.encodeUtf8 password))

304+ (basicAuth (T.encodeUtf8 user) (T.encodeUtf8 password))

305305 responseStatusCode r `shouldBe` 200

306306 responseStatusMessage r `shouldBe` "OK"

307307

@@ -401,28 +401,8 @@ blindlyThrowing = runReq defaultHttpConfig {httpConfigCheckResponse = doit}

401401 doit _ _ = error "Oops!"

402402

403403-- | 'Url' representing <https://httpbin.org>.

404−httpbin :: Url 'Http

405−httpbin = http "localhost"

406−

407−req ::

408− ( MonadHttp m,

409− HttpMethod method,

410− HttpBody body,

411− HttpResponse response,

412− HttpBodyAllowed (AllowsBody method) (ProvidesBody body)

413− ) =>

414− method ->

415− Url scheme ->

416− body ->

417− Proxy response ->

418− Option scheme ->

419− m response

420−req method url body responseProxy options =

421− Req.req method url body responseProxy (options <> defaultOptions)

422−

423−-- | Options to apply by default.

424−defaultOptions :: Option scheme

425−defaultOptions = port 1234

404+httpbin :: Url 'Https

405+httpbin = https "httpbin.org"

426406

427407-- | Remove “origin” field from JSON value. Origin may change, we don't want

428408-- to depend on that.

@@ -432,36 +412,19 @@ stripOrigin value = value

432412

433413-- | Remove funny headers that might break the tests.

434414stripFunnyHeaders :: Value -> Value

435−stripFunnyHeaders = \case

436− Object m ->

437− Object

438− ( runIdentity

439− ( Aeson.KeyMap.alterF

440− (pure . fmap stripFunnyHeaders')

441− "headers"

442− m

443− )

444− )

445− value -> value

446−

447−-- | Similar to 'stripFunnyHeaders', but acts directly on the argument

448−-- without trying to access its "headers" field.

449−stripFunnyHeaders' :: Value -> Value

450−stripFunnyHeaders' = \case

451− Object p ->

452− Object $

453− Aeson.KeyMap.filterWithKey

454− (\k _ -> k `elem` whitelistedHeaders)

455− p

456− value -> value

457− where

458− whitelistedHeaders =

459− [ "Content-Type",

460− "Accept-Encoding",

461− "Content-Length",

462− "Foo",

463− "Baz"

464− ]

415+stripFunnyHeaders (Object m) =

416+ let f (Object p) = Object $ Aeson.KeyMap.filterWithKey (\k _ -> k `elem` hs) p

417+ f value = value

418+ hs =

419+ [ "Content-Type",

420+ "Accept-Encoding",

421+ "Host",

422+ "Content-Length",

423+ "Foo",

424+ "Baz"

425+ ]

426+ in Object (runIdentity (Aeson.KeyMap.alterF (pure . fmap f) "headers" m))

427+stripFunnyHeaders value = value

465428

466429-- | This is a complete test case that makes use of <https://httpbin.org> to

467430-- get various response status codes.

@@ -491,19 +454,12 @@ selector404

491454 L.responseStatus response == Y.status404 && not (B.null chunk)

492455selector404 _ = False

493456

494−-- | Same as 'selector404' except that it uses 'isStatusCodeException'.

495−selector404ByStatusCodeException :: HttpException -> Bool

496−selector404ByStatusCodeException e =

497− case isStatusCodeException e of

498− Nothing -> False

499− Just r -> responseStatusCode r == 404

500−

501457-- | The empty JSON 'Object'.

502458emptyObject :: Value

503459emptyObject = Object Aeson.KeyMap.empty

504460

505461-- | Get a rendered JSON value as 'Text'.

506−reflectJSON :: (ToJSON a) => a -> Text

462+reflectJSON :: ToJSON a => a -> Text

507463reflectJSON = T.decodeUtf8 . BL.toStrict . A.encode

508464

509465-- | Clarify to the type checker that the inner computation is in the 'IO'

pure-tests/Network/HTTP/ReqSpec.hs+18−18

@@ -13,41 +13,41 @@

1313

1414module Network.HTTP.ReqSpec (spec) where

1515

16−import Blaze.ByteString.Builder qualified as BB

16+import qualified Blaze.ByteString.Builder as BB

1717import Control.Exception (throwIO)

1818import Control.Monad

1919import Control.Retry

2020import Data.Aeson (ToJSON (..))

21−import Data.Aeson qualified as A

21+import qualified Data.Aeson as A

2222import Data.ByteString (ByteString)

23−import Data.ByteString qualified as B

24−import Data.ByteString.Char8 qualified as B8

25−import Data.ByteString.Lazy qualified as BL

26−import Data.CaseInsensitive qualified as CI

23+import qualified Data.ByteString as B

24+import qualified Data.ByteString.Char8 as B8

25+import qualified Data.ByteString.Lazy as BL

26+import qualified Data.CaseInsensitive as CI

2727import Data.Either (isRight)

28−import Data.List.NonEmpty qualified as NE

28+import qualified Data.List.NonEmpty as NE

2929import Data.Maybe (fromJust, fromMaybe, isJust, isNothing)

3030import Data.Proxy

3131import Data.Text (Text)

32−import Data.Text qualified as T

33−import Data.Text.Encoding qualified as T

32+import qualified Data.Text as T

33+import qualified Data.Text.Encoding as T

3434import Data.Time

3535import Data.Typeable (Typeable, eqT)

3636import GHC.Exts (IsList (..))

3737import GHC.Generics

38−import Language.Haskell.TH qualified as TH

39−import Language.Haskell.TH.Quote qualified as TH

40−import Network.HTTP.Client qualified as L

38+import qualified Language.Haskell.TH as TH

39+import qualified Language.Haskell.TH.Quote as TH

40+import qualified Network.HTTP.Client as L

4141import Network.HTTP.Req

42−import Network.HTTP.Types qualified as Y

43−import Network.HTTP.Types.Header qualified as Y

42+import qualified Network.HTTP.Types as Y

43+import qualified Network.HTTP.Types.Header as Y

4444import Test.Hspec

4545import Test.Hspec.Core.Spec (SpecM)

4646import Test.QuickCheck

4747import Text.URI (URI)

48−import Text.URI qualified as URI

49−import Text.URI.QQ qualified as QQ

50−import Web.FormUrlEncoded qualified as F

48+import qualified Text.URI as URI

49+import qualified Text.URI.QQ as QQ

50+import qualified Web.FormUrlEncoded as F

5151

5252spec :: Spec

5353spec = do

@@ -413,7 +413,7 @@ spec = do

413413 -- 'Https, Option _) type checks, so we can catch if the type of scheme

414414 -- is unspecified.

415415 let testTypeOfQuoterResult ::

416− forall a s. (Typeable a) => (a, Option s) -> Bool

416+ forall a s. Typeable a => (a, Option s) -> Bool

417417 testTypeOfQuoterResult _ = isJust $ eqT @a @(Url 'Https)

418418 in property $ testTypeOfQuoterResult [urlQ|https://example.org/|]

419419 it "doesn't work for invalid urls" $

req.cabal+43−43

@@ -1,11 +1,11 @@

11cabal-version: 2.4

22name: req

3−version: 3.13.4

3+version: 3.10.0

44license: BSD-3-Clause

55license-file: LICENSE.md

66maintainer: Mark Karpov <markkarpov92@gmail.com>

77author: Mark Karpov <markkarpov92@gmail.com>

8−tested-with: ghc ==9.6.3 ghc ==9.8.2 ghc ==9.10.1

8+tested-with: ghc ==8.10.7 ghc ==9.0.2 ghc ==9.2.1

99homepage: https://github.com/mrkkrp/req

1010bug-reports: https://github.com/mrkkrp/req/issues

1111synopsis: HTTP client library

@@ -31,70 +31,71 @@ flag dev

3131

3232library

3333 exposed-modules: Network.HTTP.Req

34− default-language: GHC2021

34+ default-language: Haskell2010

3535 build-depends:

3636 aeson >=0.9 && <3,

3737 authenticate-oauth >=1.5 && <1.8,

38− base >=4.15 && <5,

38+ base >=4.13 && <5.0,

3939 blaze-builder >=0.3 && <0.5,

40− bytestring >=0.10.8 && <0.13,

40+ bytestring >=0.10.8 && <0.12,

4141 case-insensitive >=0.2 && <1.3,

42− containers >=0.5 && <0.8,

43− crypton-connection >=0.4.2 && <0.5,

44− data-default-class >=0.2.0.0,

42+ connection >=0.2.2 && <0.4,

4543 exceptions >=0.6 && <0.11,

46− http-api-data >=0.2 && <0.7,

47− http-client >=0.7.13.1 && <0.8,

44+ http-api-data >=0.2 && <0.5,

45+ http-client >=0.7 && <0.8,

4846 http-client-tls >=0.3.2 && <0.4,

49− http-types >=0.8 && <10,

47+ http-types >=0.8 && <10.0,

5048 modern-uri >=0.3 && <0.4,

5149 monad-control >=1.0 && <1.1,

5250 mtl >=2.0 && <3.0,

5351 retry >=0.8 && <0.10,

54− template-haskell >=2.19 && <2.23,

55− text >=0.2 && <2.2,

56− transformers >=0.5.3.0 && <0.7,

52+ template-haskell >=2.14 && <2.19,

53+ text >=0.2 && <2.1,

54+ time >=1.2 && <1.13,

55+ transformers >=0.5.3.0 && <0.6,

5756 transformers-base,

5857 unliftio-core >=0.1.1 && <0.3

5958

6059 if flag(dev)

61− ghc-options:

62− -Wall -Werror -Wpartial-fields -Wunused-packages

63− -Wno-unused-imports

60+ ghc-options: -O0 -Wall -Werror

6461

6562 else

6663 ghc-options: -O2 -Wall

6764

65+ if flag(dev)

66+ ghc-options:

67+ -Wcompat -Wincomplete-record-updates -Wincomplete-uni-patterns

68+ -Wnoncanonical-monad-instances

69+

6870test-suite pure-tests

6971 type: exitcode-stdio-1.0

7072 main-is: Spec.hs

71− build-tool-depends: hspec-discover:hspec-discover >=2 && <3

73+ build-tool-depends: hspec-discover:hspec-discover >=2.0 && <3.0

7274 hs-source-dirs: pure-tests

7375 other-modules: Network.HTTP.ReqSpec

74− default-language: GHC2021

76+ default-language: Haskell2010

7577 build-depends:

76− QuickCheck >=2.7 && <3,

78+ QuickCheck >=2.7 && <3.0,

7779 aeson >=0.9 && <3,

78− base >=4.15 && <5.0,

80+ base >=4.13 && <5.0,

7981 blaze-builder >=0.3 && <0.5,

80− bytestring >=0.10.8 && <0.13,

82+ bytestring >=0.10.8 && <0.12,

8183 case-insensitive >=0.2 && <1.3,

82− hspec >=2.0 && <3,

83− hspec-core >=2.0 && <3,

84− http-api-data >=0.2 && <0.7,

84+ hspec >=2.0 && <3.0,

85+ hspec-core >=2.0 && <3.0,

86+ http-api-data >=0.2 && <0.5,

8587 http-client >=0.7 && <0.8,

86− http-types >=0.8 && <10,

88+ http-types >=0.8 && <10.0,

8789 modern-uri >=0.3 && <0.4,

90+ mtl >=2.0 && <3.0,

8891 req,

8992 retry >=0.8 && <0.10,

90− template-haskell >=2.19 && <2.23,

91− text >=0.2 && <2.2,

92− time >=1.2 && <1.15

93+ template-haskell >=2.14 && <2.19,

94+ text >=0.2 && <2.1,

95+ time >=1.2 && <1.13

9396

9497 if flag(dev)

95− ghc-options:

96− -Wall -Werror -Wredundant-constraints -Wpartial-fields

97− -Wunused-packages

98+ ghc-options: -O0 -Wall -Werror

9899

99100 else

100101 ghc-options: -O2 -Wall

@@ -102,26 +103,25 @@ test-suite pure-tests

102103test-suite httpbin-tests

103104 type: exitcode-stdio-1.0

104105 main-is: Spec.hs

105− build-tool-depends: hspec-discover:hspec-discover >=2 && <3

106+ build-tool-depends: hspec-discover:hspec-discover >=2.0 && <3.0

106107 hs-source-dirs: httpbin-tests

107108 other-modules: Network.HTTP.ReqSpec

108− default-language: GHC2021

109+ default-language: Haskell2010

109110 build-depends:

110− QuickCheck >=2.7 && <3,

111+ QuickCheck >=2.7 && <3.0,

111112 aeson >=2 && <3,

112− base >=4.15 && <5,

113− bytestring >=0.10.8 && <0.13,

113+ base >=4.13 && <5.0,

114+ bytestring >=0.10.8 && <0.12,

114115 hspec >=2.0 && <3.0,

115116 http-client >=0.7 && <0.8,

116− http-types >=0.8 && <10,

117+ http-types >=0.8 && <10.0,

117118 monad-control >=1.0 && <1.1,

119+ mtl >=2.0 && <3.0,

118120 req,

119− text >=0.2 && <2.2

121+ text >=0.2 && <2.1

120122

121123 if flag(dev)

122− ghc-options:

123− -Wall -Werror -Wredundant-constraints -Wpartial-fields

124− -Wunused-packages

124+ ghc-options: -O0 -Wall -Werror

125125

126126 else

127− buildable: False

127+ ghc-options: -O2 -Wall