master..455e62b · typeable/req

git.iko.soy/typeable/req

on 455e62b help sign in

.github/dependabot.ymldeleted−6

since splitsnapshots

unifiedsplit

@@ -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:

11 ormolu:

12 runs-on: ubuntu-latest

13 steps:

14− - uses: actions/checkout@v4

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

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

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

16 build:

17 runs-on: ubuntu-latest

18 needs: ormolu

19 strategy:

20 matrix:

21− cabal: ["3.12"]

21+ cabal: ["3.6"]

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

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

23+ env:

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

23 steps:

25 steps:

24− - uses: actions/checkout@v4

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

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

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

26 id: setup-haskell-cabal

28 id: setup-haskell-cabal

27 with:

29 with:

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

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

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

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

30 - run: cabal update

32 - run: cabal update

31− - run: cabal freeze

33+ - run: cabal freeze $CONFIG

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

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

33 with:

35 with:

34 path: |

36 path: |

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

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

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

38 restore-keys: |

40 restore-keys: |

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

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

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

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

41− - run: cabal build

43+ - run: cabal build $CONFIG

42− - run: |

43− docker pull kennethreitz/httpbin

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

45− cabal test

44+ - run: cabal test $CONFIG

46− - run: cabal haddock

45+ - run: cabal haddock $CONFIG

47 - run: cabal sdist

46 - run: cabal sdist

.gitignore−1

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

25cabal.sandbox.config

26dist-*/

27dist/

28−hie.yaml

29stack.yaml

28stack.yaml

30stack.yaml.lock

29stack.yaml.lock

CHANGELOG.md−43

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

37−## Req 3.11.0

38−

39−* Add the `queryParamToList` method to the `QueryParam` type class.

40−* Add the `formToQuery` function. [Issue 126](https://github.com/mrkkrp/req/issues/126).

41−* Add `FromForm` instances (in the `Web.FormUrlEncoded` module) to the

42− `Option` and `FormUrlEncodedParam` types.

43−

44## Req 3.10.0

1## Req 3.10.0

46* Add `MonadHttp` instances for `transformers` types.

3* Add `MonadHttp` instances for `transformers` types.

Network/HTTP/Req.hs+83−143

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

1+{-# LANGUAGE BangPatterns #-}

2+{-# LANGUAGE CPP #-}

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

145 (=:),

156 (=:),

146 queryFlag,

157 queryFlag,

147− formToQuery,

148 QueryParam (..),

158 QueryParam (..),

149

159

150 -- *** Headers

160 -- *** Headers

151 header,

161 header,

152 attachHeader,

162 attachHeader,

153− headerRedacted,

154

163

155 -- *** Cookies

164 -- *** Cookies

156 -- $cookies

165 -- $cookies

@@ -197,78 +206,72 @@ module Network.HTTP.Req

197

206

198 -- * Other

207 -- * Other

199 HttpException (..),

208 HttpException (..),

200− isStatusCodeException,

201 CanHaveBody (..),

209 CanHaveBody (..),

202 Scheme (..),

210 Scheme (..),

203 )

211 )

204where

212where

205

213

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

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

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

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

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

218import Control.Monad.Trans.Control

225import Control.Monad.Trans.Control

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

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

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

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

221import Control.Monad.Trans.Maybe (MaybeT)

228import Control.Monad.Trans.Maybe (MaybeT)

222−import Control.Monad.Trans.RWS.CPS qualified as RWS.CPS

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

223−import Control.Monad.Trans.RWS.Lazy qualified as RWS.Lazy

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

224−import Control.Monad.Trans.RWS.Strict qualified as RWS.Strict

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

225import Control.Monad.Trans.Select (SelectT)

232import Control.Monad.Trans.Select (SelectT)

226−import Control.Monad.Trans.State.Lazy qualified as State.Lazy

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

227−import Control.Monad.Trans.State.Strict qualified as State.Strict

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

228−import Control.Monad.Trans.Writer.CPS qualified as Writer.CPS

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

229−import Control.Monad.Trans.Writer.Lazy qualified as Writer.Lazy

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

230−import Control.Monad.Trans.Writer.Strict qualified as Writer.Strict

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

231import Control.Retry

238import Control.Retry

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

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

233−import Data.Aeson qualified as A

240+import qualified Data.Aeson as A

234import Data.ByteString (ByteString)

241import Data.ByteString (ByteString)

235−import Data.ByteString qualified as B

242+import qualified Data.ByteString as B

236−import Data.ByteString.Lazy qualified as BL

243+import qualified Data.ByteString.Lazy as BL

237−import Data.CaseInsensitive qualified as CI

244+import qualified Data.CaseInsensitive as CI

238import Data.Data (Data)

245import Data.Data (Data)

239−import Data.Default.Class (def)

240import Data.Function (on)

246import Data.Function (on)

241import Data.IORef

247import Data.IORef

242import Data.Kind (Constraint, Type)

248import Data.Kind (Constraint, Type)

243import Data.List (foldl', nubBy)

249import Data.List (foldl', nubBy)

244import Data.List.NonEmpty (NonEmpty (..))

250import Data.List.NonEmpty (NonEmpty (..))

245−import Data.List.NonEmpty qualified as NE

251+import qualified Data.List.NonEmpty as NE

246import Data.Maybe (fromMaybe)

252import Data.Maybe (fromMaybe)

247import Data.Proxy

253import Data.Proxy

248−import Data.Semigroup (Endo (..))

254+import Data.Semigroup hiding (Option, option)

249−import Data.Set qualified as S

250import Data.Text (Text)

255import Data.Text (Text)

251−import Data.Text qualified as T

256+import qualified Data.Text as T

252−import Data.Text.Encoding qualified as T

257+import qualified Data.Text.Encoding as T

253import Data.Typeable (Typeable, cast)

258import Data.Typeable (Typeable, cast)

254import GHC.Generics

259import GHC.Generics

255import GHC.TypeLits

260import GHC.TypeLits

256−import Language.Haskell.TH qualified as TH

261+import qualified Language.Haskell.TH as TH

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

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

258−import Language.Haskell.TH.Syntax qualified as TH

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

259−import Network.Connection qualified as NC

264+import qualified Network.Connection as NC

260−import Network.HTTP.Client qualified as L

265+import qualified Network.HTTP.Client as L

261−import Network.HTTP.Client.Internal qualified as LI

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

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

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

263−import Network.HTTP.Client.TLS qualified as L

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

264−import Network.HTTP.Types qualified as Y

269+import qualified Network.HTTP.Types as Y

265import System.IO.Unsafe (unsafePerformIO)

270import System.IO.Unsafe (unsafePerformIO)

266import Text.URI (URI)

271import Text.URI (URI)

267−import Text.URI qualified as URI

272+import qualified Text.URI as URI

268−import Text.URI.QQ qualified as QQ

273+import qualified Text.URI.QQ as QQ

269−import Web.Authenticate.OAuth qualified as OAuth

274+import qualified Web.Authenticate.OAuth as OAuth

270−import Web.FormUrlEncoded (FromForm (..), ToForm (..))

271−import Web.FormUrlEncoded qualified as Form

272import Web.HttpApiData (ToHttpApiData (..))

275import Web.HttpApiData (ToHttpApiData (..))

273

276

274----------------------------------------------------------------------------

277----------------------------------------------------------------------------

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

489--

492--

490-- @since 3.7.0

493-- @since 3.7.0

491reqHandler ::

494reqHandler ::

492− (MonadHttp m) =>

495+ MonadHttp m =>

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

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

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

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

495 -- | 'L.Request' to perform

498 -- | 'L.Request' to perform

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

585 withReqManager (m request)

588 withReqManager (m request)

586

589

587-- | Perform an action using the global implicit 'L.Manager' that the rest

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

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

589-- 'L.Manager' controls.

592-- 'L.Manager' controls.

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

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

591−withReqManager m = m globalManager

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

592

595

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

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

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

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

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

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

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

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

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

604−globalManager :: L.Manager

607+globalManager :: IORef L.Manager

605globalManager = unsafePerformIO $ do

608globalManager = unsafePerformIO $ do

606 context <- NC.initConnectionContext

609 context <- NC.initConnectionContext

607 let settings =

610 let settings =

608 L.mkManagerSettingsContext

611 L.mkManagerSettingsContext

609 (Just context)

612 (Just context)

610− def

613+ (NC.TLSSettingsSimple False False False)

611 Nothing

614 Nothing

612 manager <- L.newManager settings

615 manager <- L.newManager settings

613− return manager

616+ newIORef manager

614{-# NOINLINE globalManager #-}

617{-# NOINLINE globalManager #-}

615

618

616----------------------------------------------------------------------------

619----------------------------------------------------------------------------

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

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

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

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

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

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

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

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

636+class MonadIO m => MonadHttp m where

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

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

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

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

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

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

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

715 --

718 --

716 -- @since 3.6.0

719 -- @since 3.6.0

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

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

718 }

721 }

722+ deriving (Typeable)

719

723

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

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

721--

725--

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

803 getHttpConfig = lift getHttpConfig

807 getHttpConfig = lift getHttpConfig

804

808

805-- | @since 3.10.0

809-- | @since 3.10.0

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

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

807 handleHttpException = lift . handleHttpException

811 handleHttpException = lift . handleHttpException

808 getHttpConfig = lift getHttpConfig

812 getHttpConfig = lift getHttpConfig

809

813

810-- | @since 3.10.0

814-- | @since 3.10.0

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

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

812 handleHttpException = lift . handleHttpException

816 handleHttpException = lift . handleHttpException

813 getHttpConfig = lift getHttpConfig

817 getHttpConfig = lift getHttpConfig

814

818

815-- | @since 3.10.0

819-- | @since 3.10.0

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

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

817 handleHttpException = lift . handleHttpException

821 handleHttpException = lift . handleHttpException

818 getHttpConfig = lift getHttpConfig

822 getHttpConfig = lift getHttpConfig

819

823

820-- | @since 3.10.0

824-- | @since 3.10.0

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

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

822 handleHttpException = lift . handleHttpException

826 handleHttpException = lift . handleHttpException

823 getHttpConfig = lift getHttpConfig

827 getHttpConfig = lift getHttpConfig

824

828

825-- | @since 3.10.0

829-- | @since 3.10.0

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

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

827 handleHttpException = lift . handleHttpException

831 handleHttpException = lift . handleHttpException

828 getHttpConfig = lift getHttpConfig

832 getHttpConfig = lift getHttpConfig

829

833

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

843 getHttpConfig = lift getHttpConfig

847 getHttpConfig = lift getHttpConfig

844

848

845-- | @since 3.10.0

849-- | @since 3.10.0

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

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

847 handleHttpException = lift . handleHttpException

851 handleHttpException = lift . handleHttpException

848 getHttpConfig = lift getHttpConfig

852 getHttpConfig = lift getHttpConfig

849

853

850-- | @since 3.10.0

854-- | @since 3.10.0

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

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

852 handleHttpException = lift . handleHttpException

856 handleHttpException = lift . handleHttpException

853 getHttpConfig = lift getHttpConfig

857 getHttpConfig = lift getHttpConfig

854

858

855-- | @since 3.10.0

859-- | @since 3.10.0

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

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

857 handleHttpException = lift . handleHttpException

861 handleHttpException = lift . handleHttpException

858 getHttpConfig = lift getHttpConfig

862 getHttpConfig = lift getHttpConfig

859

863

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

877--

881--

878-- @since 0.4.0

882-- @since 0.4.0

879runReq ::

883runReq ::

880− (MonadIO m) =>

884+ MonadIO m =>

881 -- | 'HttpConfig' to use

885 -- | 'HttpConfig' to use

882 HttpConfig ->

886 HttpConfig ->

883 -- | Computation to run

887 -- | Computation to run

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

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

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

983 httpMethodName :: Proxy a -> ByteString

987 httpMethodName :: Proxy a -> ByteString

984

988

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

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

986 getRequestMod _ = Endo $ \x ->

990 getRequestMod _ = Endo $ \x ->

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

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

988

992

@@ -1024,20 +1028,25 @@ 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

1028-- > -- 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)

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

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

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

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

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

1028

1032

1029type role Url nominal

1033type role Url nominal

1030

1034

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

1035-- 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.

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

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

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

1034 lift url =

1038 lift url =

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

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

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

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

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

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

1038 where

1042 where

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

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

1044+

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

1040 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift

1046 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift

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

1048+ liftTyped = TH.unsafeTExpCoerce . TH.lift

1049+#endif

1041

1050

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

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

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

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

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

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

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

1054infixl 5 /~

1063infixl 5 /~

1055

1064

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

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

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

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

1058

1067

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

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

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

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

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

1242newtype ReqBodyJson a = ReqBodyJson a

1251newtype ReqBodyJson a = ReqBodyJson a

1243

1252

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

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

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

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

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

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

1247

1256

@@ -1294,13 +1303,6 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]

1294instance QueryParam FormUrlEncodedParam where

1303instance QueryParam FormUrlEncodedParam where

1295 queryParam name mvalue =

1304 queryParam name mvalue =

1296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]

1305 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]

1297− queryParamToList (FormUrlEncodedParam p) = p

1298−

1299−-- | Use 'formToQuery'.

1300−--

1301−-- @since 3.11.0

1302−instance FromForm FormUrlEncodedParam where

1303− fromForm = Right . formToQuery

1304

1306

1305-- | Multipart form data. Please consult the

1307-- | Multipart form data. Please consult the

1306-- "Network.HTTP.Client.MultipartFormData" module for how to construct

1308-- "Network.HTTP.Client.MultipartFormData" module for how to construct

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

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

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

1341--

1343--

1342-- @since 0.2.0

1344-- @since 0.2.0

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

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

1344reqBodyMultipart parts = liftIO $ do

1346reqBodyMultipart parts = liftIO $ do

1345 boundary <- LM.webkitBoundary

1347 boundary <- LM.webkitBoundary

1346 body <- LM.renderParts boundary parts

1348 body <- LM.renderParts boundary parts

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

1380 TypeError

1382 TypeError

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

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

1382

1384

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

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

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

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

1385 x

1387 x

1386 { L.requestBody = getRequestBody body,

1388 { L.requestBody = getRequestBody body,

@@ -1426,12 +1428,6 @@ instance Monoid (Option scheme) where

1426 mempty = Option mempty Nothing

1428 mempty = Option mempty Nothing

1427 mappend = (<>)

1429 mappend = (<>)

1428

1430

1429−-- | Use 'formToQuery'.

1430−--

1431−-- @since 3.11.0

1432−instance FromForm (Option scheme) where

1433− fromForm = Right . formToQuery

1434−

1435-- | A helper to create an 'Option' that modifies only collection of query

1431-- | A helper to create an 'Option' that modifies only collection of query

1436-- parameters. This helper is not a part of the public API.

1432-- parameters. This helper is not a part of the public API.

1437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme

1433withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme

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

1450

1446

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

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

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

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

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

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

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

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

1455

1451

1456----------------------------------------------------------------------------

1452----------------------------------------------------------------------------

@@ -1483,27 +1479,9 @@ name =: value = queryParam name (pure value)

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

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

1484--

1480--

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

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

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

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

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

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

1488

1484

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

1490−-- produces the same query params as 'Form.urlEncodeAsFormStable'.

1491−--

1492−-- Note that 'Form.Form' doesn't have the concept of parameters with the

1493−-- empty value (i.e. what you can get by @key =: ""@). If the value is

1494−-- empty, it will be encoded as a valueless parameter (i.e. what you can get

1495−-- by @queryFlag key@).

1496−--

1497−-- @since 3.11.0

1498−formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param

1499−formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f

1500− where

1501− toParam (key, val) =

1502− queryParam key $

1503− if val == ""

1504− then Nothing

1505− else Just val

1506−

1507-- | A type class for query-parameter-like things. The reason to have an

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

1486-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a

1509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.

1487-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.

@@ -1513,17 +1491,11 @@ class QueryParam param where

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

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

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

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

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

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

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

1517−

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

1519− --

1520− -- @since 3.11.0

1521− queryParamToList :: param -> [(Text, Maybe Text)]

1522

1495

1523instance QueryParam (Option scheme) where

1496instance QueryParam (Option scheme) where

1524 queryParam name mvalue =

1497 queryParam name mvalue =

1525 withQueryParams ((:) (name, toQueryParam <$> mvalue))

1498 withQueryParams ((:) (name, toQueryParam <$> mvalue))

1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)

1527

1499

1528----------------------------------------------------------------------------

1500----------------------------------------------------------------------------

1529-- Request—Optional parameters—Headers

1501-- Request—Optional parameters—Headers

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

1547attachHeader name value x =

1519attachHeader name value x =

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

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

1549

1521

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−

1558----------------------------------------------------------------------------

1522----------------------------------------------------------------------------

1559-- Request—Optional parameters—Cookies

1523-- Request—Optional parameters—Cookies

1560

1524

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

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

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

1763 deriving (Show)

1727 deriving (Show)

1764

1728

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

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

1766 type HttpResponseBody (JsonResponse a) = a

1730 type HttpResponseBody (JsonResponse a) = a

1767 toVanillaResponse (JsonResponse r) = r

1731 toVanillaResponse (JsonResponse r) = r

1768 getHttpResponse r = do

1732 getHttpResponse r = do

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

1878

1842

1879-- | Get the response body.

1843-- | Get the response body.

1880responseBody ::

1844responseBody ::

1881− (HttpResponse response) =>

1845+ HttpResponse response =>

1882 response ->

1846 response ->

1883 HttpResponseBody response

1847 HttpResponseBody response

1884responseBody = L.responseBody . toVanillaResponse

1848responseBody = L.responseBody . toVanillaResponse

1885

1849

1886-- | Get the response status code.

1850-- | Get the response status code.

1887responseStatusCode ::

1851responseStatusCode ::

1888− (HttpResponse response) =>

1852+ HttpResponse response =>

1889 response ->

1853 response ->

1890 Int

1854 Int

1891responseStatusCode =

1855responseStatusCode =

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

1893

1857

1894-- | Get the response status message.

1858-- | Get the response status message.

1895responseStatusMessage ::

1859responseStatusMessage ::

1896− (HttpResponse response) =>

1860+ HttpResponse response =>

1897 response ->

1861 response ->

1898 ByteString

1862 ByteString

1899responseStatusMessage =

1863responseStatusMessage =

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

1901

1865

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

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

1903responseHeader ::

1867responseHeader ::

1904− (HttpResponse response) =>

1868+ HttpResponse response =>

1905 -- | Response interpretation

1869 -- | Response interpretation

1906 response ->

1870 response ->

1907 -- | Header to lookup

1871 -- | Header to lookup

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

1913

1877

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

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

1915responseCookieJar ::

1879responseCookieJar ::

1916− (HttpResponse response) =>

1880+ HttpResponse response =>

1917 response ->

1881 response ->

1918 L.CookieJar

1882 L.CookieJar

1919responseCookieJar = L.responseCookieJar . toVanillaResponse

1883responseCookieJar = L.responseCookieJar . toVanillaResponse

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

1967 acceptHeader :: Proxy response -> Maybe ByteString

1931 acceptHeader :: Proxy response -> Maybe ByteString

1968 acceptHeader Proxy = Nothing

1932 acceptHeader Proxy = Nothing

1969

1933

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−

1980----------------------------------------------------------------------------

1934----------------------------------------------------------------------------

1981-- Other

1935-- Other

1982

1936

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

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

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

2012 -- failed

1966 -- failed

2013 JsonHttpException String

1967 JsonHttpException String

2014− deriving (Show, Generic)

1968+ deriving (Show, Typeable, Generic)

2015

1969

2016instance Exception HttpException

1970instance Exception HttpException

2017

1971

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−

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

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

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

2034-- tags.

1974-- tags.

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

2048 Http

1988 Http

2049 | -- | HTTPS

1989 | -- | HTTPS

2050 Https

1990 Https

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

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

README.md+1−1

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

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

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

6[![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)

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

10* [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+58−99

@@ -8,25 +8,23 @@

8module Network.HTTP.ReqSpec (spec) where

10import Control.Exception

11−import Control.Monad (forM_)

11+import Control.Monad.Reader

12import Control.Monad.Trans.Control

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

14−import Data.Aeson qualified as A

14+import qualified Data.Aeson as A

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

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

16−import Data.ByteString qualified as B

16+import qualified Data.ByteString as B

17−import Data.ByteString.Lazy qualified as BL

17+import qualified Data.ByteString.Lazy as BL

18import Data.Functor.Identity (runIdentity)

19−import Data.Maybe (fromJust)

20import Data.Proxy

19import Data.Proxy

21import Data.Text (Text)

20import Data.Text (Text)

22−import Data.Text qualified as T

21+import qualified Data.Text as T

23−import Data.Text.Encoding qualified as T

22+import qualified Data.Text.Encoding as T

24−import Data.Text.IO qualified as TIO

23+import qualified Data.Text.IO as TIO

25−import Network.HTTP.Client qualified as L

24+import qualified Network.HTTP.Client as L

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

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

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

26+import Network.HTTP.Req

28−import Network.HTTP.Req qualified as Req

29−import Network.HTTP.Types qualified as Y

27+import qualified Network.HTTP.Types as Y

30import Test.Hspec

28import Test.Hspec

31import Test.QuickCheck

29import Test.QuickCheck

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

50 blindlyThrowing (req GET httpbin NoReqBody ignoreResponse mempty)

48 blindlyThrowing (req GET httpbin NoReqBody ignoreResponse mempty)

51 `shouldThrow` anyException

49 `shouldThrow` anyException

53− describe "isStatusCodeException" $

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

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

56− `shouldThrow` selector404ByStatusCodeException

57−

58 describe "receiving user-agent header back" $

51 describe "receiving user-agent header back" $

59 it "works" $ do

52 it "works" $ do

60 r <-

53 r <-

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

85 .= object

78 .= object

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

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

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

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

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

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

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

89 ]

83 ]

90 ]

84 ]

91 responseStatusCode r `shouldBe` 200

85 responseStatusCode r `shouldBe` 200

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

97 (stripFunnyHeaders . stripOrigin) (responseBody r)

91 (stripFunnyHeaders . stripOrigin) (responseBody r)

98 `shouldBe` object

92 `shouldBe` object

99 [ "args" .= emptyObject,

93 [ "args" .= emptyObject,

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

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

101 "headers"

95 "headers"

102 .= object

96 .= object

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

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

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

104 ]

99 ]

105 ]

100 ]

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

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

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

117 [ "args" .= emptyObject,

112 [ "args" .= emptyObject,

118 "json" .= text,

113 "json" .= text,

119 "data" .= reflected,

114 "data" .= reflected,

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

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

121 "headers"

116 "headers"

122 .= object

117 .= object

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

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

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

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

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

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

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

126 ],

122 ],

127 "files" .= emptyObject,

123 "files" .= emptyObject,

@@ -139,17 +135,18 @@ spec = do

139 LM.partBS "bar" "bar data!"

135 LM.partBS "bar" "bar data!"

140 ]

136 ]

141 r <- req POST (httpbin /: "post") body jsonResponse mempty

137 r <- req POST (httpbin /: "post") body jsonResponse mempty

142− let contentType = fromJust (getRequestContentType body)

138+ let Just contentType = getRequestContentType body

143 (stripFunnyHeaders . stripOrigin) (responseBody r)

139 (stripFunnyHeaders . stripOrigin) (responseBody r)

144 `shouldBe` object

140 `shouldBe` object

145 [ "args" .= emptyObject,

141 [ "args" .= emptyObject,

146 "json" .= Null,

142 "json" .= Null,

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

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

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

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

149 "headers"

145 "headers"

150 .= object

146 .= object

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

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

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

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

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

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

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

154 ],

151 ],

155 "files" .= emptyObject,

152 "files" .= emptyObject,

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

174 [ "args" .= emptyObject,

171 [ "args" .= emptyObject,

175 "json" .= Null,

172 "json" .= Null,

176 "data" .= contents,

173 "data" .= contents,

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

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

178 "headers"

175 "headers"

179 .= object

176 .= object

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

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

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

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

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

182 ],

180 ],

183 "files" .= emptyObject,

181 "files" .= emptyObject,

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

199 [ "args" .= emptyObject,

197 [ "args" .= emptyObject,

200 "json" .= Null,

198 "json" .= Null,

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

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

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

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

203 "headers"

201 "headers"

204 .= object

202 .= object

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

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

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

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

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

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

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

208 ],

207 ],

209 "files" .= emptyObject,

208 "files" .= emptyObject,

@@ -261,17 +260,21 @@ spec = do

261 -- TODO /response-headers

260 -- TODO /response-headers

262 -- TODO /redirect

261 -- TODO /redirect

263

262

263+ -- FIXME Redirects test is temporarily disabled due to

264+ --

265+ -- https://github.com/postmanlabs/httpbin/issues/617

266+

264− describe "redirects" $

267+ -- describe "redirects" $

265− it "follows redirects" $ do

268+ -- it "follows redirects" $ do

266− r <-

269+ -- r <-

267− req

270+ -- req

268− GET

271+ -- GET

269− (httpbin /: "redirect-to")

272+ -- (httpbin /: "redirect-to")

270− NoReqBody

273+ -- NoReqBody

271− ignoreResponse

274+ -- ignoreResponse

272− ("url" =: ("https://httpbin.org" :: Text))

275+ -- ("url" =: ("https://httpbin.org" :: Text))

273− responseStatusCode r `shouldBe` 200

276+ -- responseStatusCode r `shouldBe` 200

274− responseStatusMessage r `shouldBe` "OK"

277+ -- responseStatusMessage r `shouldBe` "OK"

275

278

276 -- TODO /relative-redicet

279 -- TODO /relative-redicet

277 -- TODO /absolute-redirect

280 -- TODO /absolute-redirect

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

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

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

302 NoReqBody

305 NoReqBody

303 ignoreResponse

306 ignoreResponse

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

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

305 responseStatusCode r `shouldBe` 200

308 responseStatusCode r `shouldBe` 200

306 responseStatusMessage r `shouldBe` "OK"

309 responseStatusMessage r `shouldBe` "OK"

307

310

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

401 doit _ _ = error "Oops!"

404 doit _ _ = error "Oops!"

402

405

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

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

404−httpbin :: Url 'Http

407+httpbin :: Url 'Https

405−httpbin = http "localhost"

408+httpbin = https "httpbin.org"

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

426

409

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

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

428-- to depend on that.

411-- to depend on that.

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

432

415

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

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

434stripFunnyHeaders :: Value -> Value

417stripFunnyHeaders :: Value -> Value

435−stripFunnyHeaders = \case

418+stripFunnyHeaders (Object m) =

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

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

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

455− p

456− value -> value

420+ f value = value

457− where

421+ hs =

458− whitelistedHeaders =

459− [ "Content-Type",

422+ [ "Content-Type",

460− "Accept-Encoding",

423+ "Accept-Encoding",

424+ "Host",

461− "Content-Length",

425+ "Content-Length",

462− "Foo",

426+ "Foo",

463− "Baz"

427+ "Baz"

464− ]

428+ ]

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

430+stripFunnyHeaders value = value

465

431

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

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

467-- get various response status codes.

433-- get various response status codes.

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

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

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

492selector404 _ = False

458selector404 _ = False

493

459

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−

501-- | The empty JSON 'Object'.

460-- | The empty JSON 'Object'.

502emptyObject :: Value

461emptyObject :: Value

503emptyObject = Object Aeson.KeyMap.empty

462emptyObject = Object Aeson.KeyMap.empty

504

463

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

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

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

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

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

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

508

467

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

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

pure-tests/Network/HTTP/ReqSpec.hs+21−53

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

14module Network.HTTP.ReqSpec (spec) where

16−import Blaze.ByteString.Builder qualified as BB

16+import qualified Blaze.ByteString.Builder as BB

17import Control.Exception (throwIO)

18import Control.Monad

19import Control.Retry

20import Data.Aeson (ToJSON (..))

21−import Data.Aeson qualified as A

21+import qualified Data.Aeson as A

22import Data.ByteString (ByteString)

23−import Data.ByteString qualified as B

23+import qualified Data.ByteString as B

24−import Data.ByteString.Char8 qualified as B8

24+import qualified Data.ByteString.Char8 as B8

25−import Data.ByteString.Lazy qualified as BL

25+import qualified Data.ByteString.Lazy as BL

26−import Data.CaseInsensitive qualified as CI

26+import qualified Data.CaseInsensitive as CI

27import Data.Either (isRight)

28−import Data.List.NonEmpty qualified as NE

28+import qualified Data.List.NonEmpty as NE

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

30import Data.Proxy

31import Data.Text (Text)

32−import Data.Text qualified as T

32+import qualified Data.Text as T

33−import Data.Text.Encoding qualified as T

33+import qualified Data.Text.Encoding as T

34import Data.Time

35import Data.Typeable (Typeable, eqT)

36−import GHC.Exts (IsList (..))

37import GHC.Generics

36import GHC.Generics

38−import Language.Haskell.TH qualified as TH

37+import qualified Language.Haskell.TH as TH

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

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

40−import Network.HTTP.Client qualified as L

39+import qualified Network.HTTP.Client as L

41import Network.HTTP.Req

40import Network.HTTP.Req

42−import Network.HTTP.Types qualified as Y

41+import qualified Network.HTTP.Types as Y

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

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

44import Test.Hspec

43import Test.Hspec

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

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

46import Test.QuickCheck

45import Test.QuickCheck

47import Text.URI (URI)

46import Text.URI (URI)

48−import Text.URI qualified as URI

47+import qualified Text.URI as URI

49−import Text.URI.QQ qualified as QQ

48+import qualified Text.URI.QQ as QQ

50−import Web.FormUrlEncoded qualified as F

52spec :: Spec

50spec :: Spec

53spec = do

51spec = do

@@ -161,13 +159,11 @@ spec = do

161 let uriHttp = uri' {URI.uriScheme = Just [QQ.scheme|http|]}

159 let uriHttp = uri' {URI.uriScheme = Just [QQ.scheme|http|]}

162 uriHttps = uri' {URI.uriScheme = Just [QQ.scheme|https|]}

160 uriHttps = uri' {URI.uriScheme = Just [QQ.scheme|https|]}

163 requestHttp <-

161 requestHttp <-

164− case fromJust (useURI uriHttp) of

162+ let Left (url', options) = fromJust (useURI uriHttp)

165− Left (url', options) -> req_ GET url' NoReqBody options

163+ in req_ GET url' NoReqBody options

166− _ -> error "(useURI uriHttp) should have returned Left"

167 requestHttps <-

164 requestHttps <-

168− case fromJust (useURI uriHttps) of

165+ let Right (url', options) = fromJust (useURI uriHttps)

169− Right (url', options) -> req_ GET url' NoReqBody options

166+ in req_ GET url' NoReqBody options

170− _ -> error "(useURI uriHttps) should have returned Right"

171 L.host requestHttp `shouldBe` uriHost uriHttp

167 L.host requestHttp `shouldBe` uriHost uriHttp

172 L.host requestHttps `shouldBe` uriHost uriHttps

168 L.host requestHttps `shouldBe` uriHost uriHttps

173 L.port requestHttp `shouldBe` uriPort 80 uriHttp

169 L.port requestHttp `shouldBe` uriPort 80 uriHttp

@@ -237,19 +233,6 @@ spec = do

237 L.RequestBodyLBS x -> x `shouldBe` renderQuery params

233 L.RequestBodyLBS x -> x `shouldBe` renderQuery params

238 _ -> expectationFailure "Wrong request body constructor."

234 _ -> expectationFailure "Wrong request body constructor."

239

235

240− describe "query params" $ do

241− describe "FormUrlEncodedParam" $ do

242− describe "formToQuery" $ do

243− it "should produce the same parameters as F.urlEncodeFormStable" $

244− property $ \form -> do

245− request <- req_ POST url (ReqBodyUrlEnc $ formToQuery form) mempty

246− case L.requestBody request of

247− L.RequestBodyLBS x -> x `shouldBe` F.urlEncodeFormStable form

248− _ -> expectationFailure "Wrong request body constructor"

249− specParamToList (Proxy :: Proxy FormUrlEncodedParam)

250− describe "Option" $ do

251− specParamToList (Proxy :: Proxy (Option 'Http))

252−

253 describe "optional parameters" $ do

236 describe "optional parameters" $ do

254 describe "header" $ do

237 describe "header" $ do

255 it "sets specified header value" $

238 it "sets specified header value" $

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

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

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

414 -- is unspecified.

397 -- is unspecified.

415 let testTypeOfQuoterResult ::

398 let testTypeOfQuoterResult ::

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

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

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

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

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

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

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

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

@@ -503,9 +486,6 @@ instance Arbitrary Day where

503instance Arbitrary DiffTime where

486instance Arbitrary DiffTime where

504 arbitrary = secondsToDiffTime <$> arbitrary

487 arbitrary = secondsToDiffTime <$> arbitrary

505

488

506−instance Arbitrary F.Form where

507− arbitrary = (F.Form . fromList) <$> arbitrary

508−

509----------------------------------------------------------------------------

489----------------------------------------------------------------------------

510-- Helper types

490-- Helper types

511

491

@@ -618,15 +598,3 @@ basicProxyAuthHeader :: ByteString -> ByteString -> ByteString

618basicProxyAuthHeader username password =

598basicProxyAuthHeader username password =

619 fromJust . lookup Y.hProxyAuthorization . L.requestHeaders $

599 fromJust . lookup Y.hProxyAuthorization . L.requestHeaders $

620 L.applyBasicProxyAuth username password L.defaultRequest

600 L.applyBasicProxyAuth username password L.defaultRequest

621−

622−-- | Spec about 'paramToList' for the type @p@.

623−specParamToList :: (QueryParam p, Monoid p) => Proxy p -> Spec

624−specParamToList typeProxy = do

625− describe "paramToList" $ do

626− it "should reproduce the parameters given by queryParam" $

627− property $ \(QueryParams params) -> do

628− let queryParam0 =

629− (mconcat $ fmap (uncurry queryParam) params)

630− `asProxyTypeOf` typeProxy

631− got = queryParamToList queryParam0

632− got `shouldBe` params

req.cabal+42−43

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

1cabal-version: 2.4

2name: req

3−version: 3.13.4

3+version: 3.10.0

4license: BSD-3-Clause

5license-file: LICENSE.md

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

7author: 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.8.4 ghc ==8.10.7 ghc ==9.0.2

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

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

11synopsis: HTTP client library

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

32library

33 exposed-modules: Network.HTTP.Req

34− default-language: GHC2021

34+ default-language: Haskell2010

35 build-depends:

36 aeson >=0.9 && <3,

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

38− base >=4.15 && <5,

38+ base >=4.13 && <5.0,

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

40− bytestring >=0.10.8 && <0.13,

40+ bytestring >=0.10.8 && <0.12,

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

42− containers >=0.5 && <0.8,

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

42+ connection >=0.2.2 && <0.4,

44− data-default-class >=0.2.0.0,

45 exceptions >=0.6 && <0.11,

43 exceptions >=0.6 && <0.11,

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

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

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

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

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

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

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

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

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

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

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

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

52 mtl >=2.0 && <3.0,

50 mtl >=2.0 && <3.0,

53 retry >=0.8 && <0.10,

51 retry >=0.8 && <0.10,

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

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

55− text >=0.2 && <2.2,

53+ text >=0.2 && <1.3,

54+ time >=1.2 && <1.13,

56− transformers >=0.5.3.0 && <0.7,

55+ transformers >=0.5.3.0 && <0.6,

57 transformers-base,

56 transformers-base,

58 unliftio-core >=0.1.1 && <0.3

57 unliftio-core >=0.1.1 && <0.3

60 if flag(dev)

59 if flag(dev)

61− ghc-options:

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

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

63− -Wno-unused-imports

65 else

62 else

66 ghc-options: -O2 -Wall

63 ghc-options: -O2 -Wall

65+ if flag(dev)

66+ ghc-options:

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

68+ -Wnoncanonical-monad-instances

69+

68test-suite pure-tests

70test-suite pure-tests

69 type: exitcode-stdio-1.0

71 type: exitcode-stdio-1.0

70 main-is: Spec.hs

72 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

72 hs-source-dirs: pure-tests

74 hs-source-dirs: pure-tests

73 other-modules: Network.HTTP.ReqSpec

75 other-modules: Network.HTTP.ReqSpec

74− default-language: GHC2021

76+ default-language: Haskell2010

75 build-depends:

77 build-depends:

76− QuickCheck >=2.7 && <3,

78+ QuickCheck >=2.7 && <3.0,

77 aeson >=0.9 && <3,

79 aeson >=0.9 && <3,

78− base >=4.15 && <5.0,

80+ base >=4.13 && <5.0,

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

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

80− bytestring >=0.10.8 && <0.13,

82+ bytestring >=0.10.8 && <0.12,

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

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

82− hspec >=2.0 && <3,

84+ hspec >=2.0 && <3.0,

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

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

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

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

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

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

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

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

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

89+ mtl >=2.0 && <3.0,

88 req,

90 req,

89 retry >=0.8 && <0.10,

91 retry >=0.8 && <0.10,

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

92+ template-haskell >=2.14 && <2.18,

91− text >=0.2 && <2.2,

93+ text >=0.2 && <1.3,

92− time >=1.2 && <1.15

94+ time >=1.2 && <1.13

94 if flag(dev)

96 if flag(dev)

95− ghc-options:

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

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

97− -Wunused-packages

99 else

100 ghc-options: -O2 -Wall

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

102test-suite httpbin-tests

103 type: exitcode-stdio-1.0

104 main-is: Spec.hs

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

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

106 hs-source-dirs: httpbin-tests

107 other-modules: Network.HTTP.ReqSpec

108− default-language: GHC2021

108+ default-language: Haskell2010

109 build-depends:

110− QuickCheck >=2.7 && <3,

110+ QuickCheck >=2.7 && <3.0,

111 aeson >=2 && <3,

112− base >=4.15 && <5,

112+ base >=4.13 && <5.0,

113− bytestring >=0.10.8 && <0.13,

113+ bytestring >=0.10.8 && <0.12,

114 hspec >=2.0 && <3.0,

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

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

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

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

118+ mtl >=2.0 && <3.0,

118 req,

119 req,

119− text >=0.2 && <2.2

120+ text >=0.2 && <1.3

120

121

121 if flag(dev)

122 if flag(dev)

122− ghc-options:

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

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

124− -Wunused-packages

125

124

126 else

125 else

127− buildable: False

126+ ghc-options: -O2 -Wall