master..d053507 · typeable/req

git.iko.soy/typeable/req

11 files changed+204−251

unifiedsplit

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

.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@v6

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−26

@@ -1,29 +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−

271## Req 3.13.0

282

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

Network/HTTP/Req.hs+83−67

@@ -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 #-}

@@ -203,7 +214,7 @@ module Network.HTTP.Req

203214 )

204215where

205216

206−import Blaze.ByteString.Builder qualified as BB

217+import qualified Blaze.ByteString.Builder as BB

207218import Control.Applicative

208219import Control.Arrow (first, second)

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

@@ -219,56 +230,55 @@ import Control.Monad.Trans.Control

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

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

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

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

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

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

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

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

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

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

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

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

231242import Control.Retry

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

233−import Data.Aeson qualified as A

244+import qualified Data.Aeson as A

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

246+import qualified Data.ByteString as B

247+import qualified Data.ByteString.Lazy as BL

248+import qualified Data.CaseInsensitive as CI

238249import Data.Data (Data)

239−import Data.Default.Class (def)

240250import Data.Function (on)

241251import Data.IORef

242252import Data.Kind (Constraint, Type)

243253import Data.List (foldl', nubBy)

244254import Data.List.NonEmpty (NonEmpty (..))

245−import Data.List.NonEmpty qualified as NE

255+import qualified Data.List.NonEmpty as NE

246256import Data.Maybe (fromMaybe)

247257import Data.Proxy

248258import Data.Semigroup (Endo (..))

249−import Data.Set qualified as S

259+import qualified Data.Set as S

250260import Data.Text (Text)

251−import Data.Text qualified as T

252−import Data.Text.Encoding qualified as T

261+import qualified Data.Text as T

262+import qualified Data.Text.Encoding as T

253263import Data.Typeable (Typeable, cast)

254264import GHC.Generics

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

266+import qualified Language.Haskell.TH as TH

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

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

269+import qualified Network.Connection as NC

270+import qualified Network.HTTP.Client as L

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

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

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

274+import qualified Network.HTTP.Types as Y

265275import System.IO.Unsafe (unsafePerformIO)

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

277+import qualified Text.URI as URI

278+import qualified Text.URI.QQ as QQ

279+import qualified Web.Authenticate.OAuth as OAuth

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

271−import Web.FormUrlEncoded qualified as Form

281+import qualified Web.FormUrlEncoded as Form

272282import Web.HttpApiData (ToHttpApiData (..))

273283

274284----------------------------------------------------------------------------

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

489499--

490500-- @since 3.7.0

491501reqHandler ::

492− (MonadHttp m) =>

502+ MonadHttp m =>

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

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

495505 -- | 'L.Request' to perform

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

585595 withReqManager (m request)

586596

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

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

589599-- 'L.Manager' controls.

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

591−withReqManager m = m globalManager

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

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

592602

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

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

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

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

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

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

604−globalManager :: L.Manager

614+globalManager :: IORef L.Manager

605615globalManager = unsafePerformIO $ do

606616 context <- NC.initConnectionContext

607617 let settings =

608618 L.mkManagerSettingsContext

609619 (Just context)

610− def

620+ (NC.TLSSettingsSimple False False False)

611621 Nothing

612622 manager <- L.newManager settings

613− return manager

623+ newIORef manager

614624{-# NOINLINE globalManager #-}

615625

616626----------------------------------------------------------------------------

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

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

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

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

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

643+class MonadIO m => MonadHttp m where

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

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

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

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

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

715725 --

716726 -- @since 3.6.0

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

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

718728 }

729+ deriving (Typeable)

719730

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

721732--

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

803814 getHttpConfig = lift getHttpConfig

804815

805816-- | @since 3.10.0

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

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

807818 handleHttpException = lift . handleHttpException

808819 getHttpConfig = lift getHttpConfig

809820

810821-- | @since 3.10.0

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

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

812823 handleHttpException = lift . handleHttpException

813824 getHttpConfig = lift getHttpConfig

814825

815826-- | @since 3.10.0

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

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

817828 handleHttpException = lift . handleHttpException

818829 getHttpConfig = lift getHttpConfig

819830

820831-- | @since 3.10.0

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

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

822833 handleHttpException = lift . handleHttpException

823834 getHttpConfig = lift getHttpConfig

824835

825836-- | @since 3.10.0

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

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

827838 handleHttpException = lift . handleHttpException

828839 getHttpConfig = lift getHttpConfig

829840

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

843854 getHttpConfig = lift getHttpConfig

844855

845856-- | @since 3.10.0

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

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

847858 handleHttpException = lift . handleHttpException

848859 getHttpConfig = lift getHttpConfig

849860

850861-- | @since 3.10.0

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

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

852863 handleHttpException = lift . handleHttpException

853864 getHttpConfig = lift getHttpConfig

854865

855866-- | @since 3.10.0

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

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

857868 handleHttpException = lift . handleHttpException

858869 getHttpConfig = lift getHttpConfig

859870

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

877888--

878889-- @since 0.4.0

879890runReq ::

880− (MonadIO m) =>

891+ MonadIO m =>

881892 -- | 'HttpConfig' to use

882893 HttpConfig ->

883894 -- | Computation to run

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

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

983994 httpMethodName :: Proxy a -> ByteString

984995

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

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

986997 getRequestMod _ = Endo $ \x ->

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

988999

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

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

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

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

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

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

10281039

10291040type role Url nominal

10301041

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

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

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

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

10341045 lift url =

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

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

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

10381049 where

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

1051+

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

10401053 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift

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

1055+ liftTyped = TH.unsafeTExpCoerce . TH.lift

1056+#endif

10411057

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

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

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

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

10541070infixl 5 /~

10551071

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

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

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

10581074

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

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

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

12421258newtype ReqBodyJson a = ReqBodyJson a

12431259

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

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

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

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

12471263

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

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

13411357--

13421358-- @since 0.2.0

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

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

13441360reqBodyMultipart parts = liftIO $ do

13451361 boundary <- LM.webkitBoundary

13461362 body <- LM.renderParts boundary parts

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

13801396 TypeError

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

13821398

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

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

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

13851401 x

13861402 { L.requestBody = getRequestBody body,

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

14501466

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

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

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

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

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

14551471

14561472----------------------------------------------------------------------------

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

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

14841500--

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

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

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

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

14881504

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

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

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

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

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

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

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

15171533

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

15191535 --

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

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

17631779 deriving (Show)

17641780

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

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

17661782 type HttpResponseBody (JsonResponse a) = a

17671783 toVanillaResponse (JsonResponse r) = r

17681784 getHttpResponse r = do

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

18781894

18791895-- | Get the response body.

18801896responseBody ::

1881− (HttpResponse response) =>

1897+ HttpResponse response =>

18821898 response ->

18831899 HttpResponseBody response

18841900responseBody = L.responseBody . toVanillaResponse

18851901

18861902-- | Get the response status code.

18871903responseStatusCode ::

1888− (HttpResponse response) =>

1904+ HttpResponse response =>

18891905 response ->

18901906 Int

18911907responseStatusCode =

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

18931909

18941910-- | Get the response status message.

18951911responseStatusMessage ::

1896− (HttpResponse response) =>

1912+ HttpResponse response =>

18971913 response ->

18981914 ByteString

18991915responseStatusMessage =

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

19011917

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

19031919responseHeader ::

1904− (HttpResponse response) =>

1920+ HttpResponse response =>

19051921 -- | Response interpretation

19061922 response ->

19071923 -- | Header to lookup

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

19131929

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

19151931responseCookieJar ::

1916− (HttpResponse response) =>

1932+ HttpResponse response =>

19171933 response ->

19181934 L.CookieJar

19191935responseCookieJar = L.responseCookieJar . toVanillaResponse

@@ -2011,7 +2027,7 @@ data HttpException

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

20122028 -- failed

20132029 JsonHttpException String

2014− deriving (Show, Generic)

2030+ deriving (Show, Typeable, Generic)

20152031

20162032instance Exception HttpException

20172033

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

20482064 Http

20492065 | -- | HTTPS

20502066 Https

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

2067+ 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+41−73

@@ -11,22 +11,21 @@ import Control.Exception

1111import Control.Monad (forM_)

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

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

8584 .= object

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

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

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

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

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

8989 ]

9090 ]

9191 responseStatusCode r `shouldBe` 200

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

9797 (stripFunnyHeaders . stripOrigin) (responseBody r)

9898 `shouldBe` object

9999 [ "args" .= emptyObject,

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

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

101101 "headers"

102102 .= object

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

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

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

104105 ]

105106 ]

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

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

117118 [ "args" .= emptyObject,

118119 "json" .= text,

119120 "data" .= reflected,

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

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

121122 "headers"

122123 .= object

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

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

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

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

126128 ],

127129 "files" .= emptyObject,

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

145147 [ "args" .= emptyObject,

146148 "json" .= Null,

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

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

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

149151 "headers"

150152 .= object

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

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

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

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

154157 ],

155158 "files" .= emptyObject,

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

174177 [ "args" .= emptyObject,

175178 "json" .= Null,

176179 "data" .= contents,

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

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

178181 "headers"

179182 .= object

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

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

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

182186 ],

183187 "files" .= emptyObject,

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

199203 [ "args" .= emptyObject,

200204 "json" .= Null,

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

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

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

203207 "headers"

204208 .= object

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

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

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

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

208213 ],

209214 "files" .= emptyObject,

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

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

302307 NoReqBody

303308 ignoreResponse

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

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

305310 responseStatusCode r `shouldBe` 200

306311 responseStatusMessage r `shouldBe` "OK"

307312

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

401406 doit _ _ = error "Oops!"

402407

403408-- | '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

409+httpbin :: Url 'Https

410+httpbin = https "httpbin.org"

426411

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

428413-- to depend on that.

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

432417

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

434419stripFunnyHeaders :: 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− ]

420+stripFunnyHeaders (Object m) =

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

422+ f value = value

423+ hs =

424+ [ "Content-Type",

425+ "Accept-Encoding",

426+ "Host",

427+ "Content-Length",

428+ "Foo",

429+ "Baz"

430+ ]

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

432+stripFunnyHeaders value = value

465433

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

467435-- get various response status codes.

@@ -503,7 +471,7 @@ emptyObject :: Value

503471emptyObject = Object Aeson.KeyMap.empty

504472

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

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

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

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

508476

509477-- | 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+42−41

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

11cabal-version: 2.4

22name: req

3−version: 3.13.4

3+version: 3.12.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,72 @@ 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,

43+ containers >=0.5 && <0.7,

4544 exceptions >=0.6 && <0.11,

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

45+ http-api-data >=0.2 && <0.6,

4746 http-client >=0.7.13.1 && <0.8,

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

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

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

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

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

5251 mtl >=2.0 && <3.0,

5352 retry >=0.8 && <0.10,

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

55− text >=0.2 && <2.2,

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

54+ text >=0.2 && <2.1,

55+ time >=1.2 && <1.13,

5656 transformers >=0.5.3.0 && <0.7,

5757 transformers-base,

5858 unliftio-core >=0.1.1 && <0.3

5959

6060 if flag(dev)

61− ghc-options:

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

63− -Wno-unused-imports

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

6462

6563 else

6664 ghc-options: -O2 -Wall

6765

66+ if flag(dev)

67+ ghc-options:

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

69+ -Wnoncanonical-monad-instances

70+

6871test-suite pure-tests

6972 type: exitcode-stdio-1.0

7073 main-is: Spec.hs

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

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

7275 hs-source-dirs: pure-tests

7376 other-modules: Network.HTTP.ReqSpec

74− default-language: GHC2021

77+ default-language: Haskell2010

7578 build-depends:

76− QuickCheck >=2.7 && <3,

79+ QuickCheck >=2.7 && <3.0,

7780 aeson >=0.9 && <3,

78− base >=4.15 && <5.0,

81+ base >=4.13 && <5.0,

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

80− bytestring >=0.10.8 && <0.13,

83+ bytestring >=0.10.8 && <0.12,

8184 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,

85+ hspec >=2.0 && <3.0,

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

87+ http-api-data >=0.2 && <0.6,

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

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

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

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

91+ mtl >=2.0 && <3.0,

8892 req,

8993 retry >=0.8 && <0.10,

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

91− text >=0.2 && <2.2,

92− time >=1.2 && <1.15

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

95+ text >=0.2 && <2.1,

96+ time >=1.2 && <1.13

9397

9498 if flag(dev)

95− ghc-options:

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

97− -Wunused-packages

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

98100

99101 else

100102 ghc-options: -O2 -Wall

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

102104test-suite httpbin-tests

103105 type: exitcode-stdio-1.0

104106 main-is: Spec.hs

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

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

106108 hs-source-dirs: httpbin-tests

107109 other-modules: Network.HTTP.ReqSpec

108− default-language: GHC2021

110+ default-language: Haskell2010

109111 build-depends:

110− QuickCheck >=2.7 && <3,

112+ QuickCheck >=2.7 && <3.0,

111113 aeson >=2 && <3,

112− base >=4.15 && <5,

113− bytestring >=0.10.8 && <0.13,

114+ base >=4.13 && <5.0,

115+ bytestring >=0.10.8 && <0.12,

114116 hspec >=2.0 && <3.0,

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

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

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

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

120+ mtl >=2.0 && <3.0,

118121 req,

119− text >=0.2 && <2.2

122+ text >=0.2 && <2.1

120123

121124 if flag(dev)

122− ghc-options:

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

124− -Wunused-packages

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

125126

126127 else

127− buildable: False

128+ ghc-options: -O2 -Wall