master..526a33a · typeable/req

git.iko.soy/typeable/req

13 files changed+223−295

unifiedsplit

.github/workflows/ci.yaml+13−14 .gitignore−1 CHANGELOG.md+1−19 Network/HTTP/Req.hs+49−39 README.md+1−1 Setup.hs+6 cabal.project−4 httpbin-data/robots.txt → httpbun-data/robots.txt httpbin-data/utf8.html → httpbun-data/utf8.html httpbin-tests/Network/HTTP/ReqSpec.hs → httpbun-tests/Network/HTTP/ReqSpec.hs+91−156 httpbin-tests/Spec.hs → httpbun-tests/Spec.hs pure-tests/Network/HTTP/ReqSpec.hs+17−17 req.cabal+45−44

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

15+ - uses: haskell-actions/run-ormolu@v12

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.8"]

22+ ghc: ["9.0.2", "9.2.5", "9.4.4"]

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

27+ - uses: haskell/actions/setup@v2

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@v3.2.5

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+1−19

@@ -1,20 +1,4 @@

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

1+## Unreleased

182

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

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

@@ -22,8 +6,6 @@

226

237* Switched from `connection` to `crypton-connection`.

248

25−* Builds with GHC 9.6.1.

26−

279## Req 3.13.0

2810

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

Network/HTTP/Req.hs+49−39

@@ -1,9 +1,19 @@

1+{-# LANGUAGE BangPatterns #-}

12{-# LANGUAGE DataKinds #-}

3+{-# LANGUAGE DeriveDataTypeable #-}

4+{-# LANGUAGE DeriveGeneric #-}

5+{-# LANGUAGE DeriveLift #-}

6+{-# LANGUAGE FlexibleInstances #-}

7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}

28{-# LANGUAGE LambdaCase #-}

9+{-# LANGUAGE MultiParamTypeClasses #-}

310{-# LANGUAGE OverloadedStrings #-}

411{-# LANGUAGE QuasiQuotes #-}

12+{-# LANGUAGE RankNTypes #-}

513{-# LANGUAGE RecordWildCards #-}

614{-# LANGUAGE RoleAnnotations #-}

15+{-# LANGUAGE ScopedTypeVariables #-}

16+{-# LANGUAGE StandaloneDeriving #-}

717{-# LANGUAGE TemplateHaskellQuotes #-}

818{-# LANGUAGE TypeFamilies #-}

919{-# LANGUAGE UndecidableInstances #-}

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

203213 )

204214where

205215

206−import Blaze.ByteString.Builder qualified as BB

216+import qualified Blaze.ByteString.Builder as BB

207217import Control.Applicative

208218import Control.Arrow (first, second)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

231241import Control.Retry

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

233−import Data.Aeson qualified as A

243+import qualified Data.Aeson as A

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

245+import qualified Data.ByteString as B

246+import qualified Data.ByteString.Lazy as BL

247+import qualified Data.CaseInsensitive as CI

238248import Data.Data (Data)

239−import Data.Default.Class (def)

240249import Data.Function (on)

241250import Data.IORef

242251import Data.Kind (Constraint, Type)

243252import Data.List (foldl', nubBy)

244253import Data.List.NonEmpty (NonEmpty (..))

245−import Data.List.NonEmpty qualified as NE

254+import qualified Data.List.NonEmpty as NE

246255import Data.Maybe (fromMaybe)

247256import Data.Proxy

248257import Data.Semigroup (Endo (..))

249−import Data.Set qualified as S

258+import qualified Data.Set as S

250259import Data.Text (Text)

251−import Data.Text qualified as T

252−import Data.Text.Encoding qualified as T

260+import qualified Data.Text as T

261+import qualified Data.Text.Encoding as T

253262import Data.Typeable (Typeable, cast)

254263import GHC.Generics

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

265+import qualified Language.Haskell.TH as TH

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

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

268+import qualified Network.Connection as NC

269+import qualified Network.HTTP.Client as L

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

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

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

273+import qualified Network.HTTP.Types as Y

265274import System.IO.Unsafe (unsafePerformIO)

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

276+import qualified Text.URI as URI

277+import qualified Text.URI.QQ as QQ

278+import qualified Web.Authenticate.OAuth as OAuth

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

271−import Web.FormUrlEncoded qualified as Form

280+import qualified Web.FormUrlEncoded as Form

272281import Web.HttpApiData (ToHttpApiData (..))

273282

274283----------------------------------------------------------------------------

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

585594 withReqManager (m request)

586595

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

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

589598-- 'L.Manager' controls.

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

591−withReqManager m = m globalManager

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

592601

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

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

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

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

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

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

604−globalManager :: L.Manager

613+globalManager :: IORef L.Manager

605614globalManager = unsafePerformIO $ do

606615 context <- NC.initConnectionContext

607616 let settings =

608617 L.mkManagerSettingsContext

609618 (Just context)

610− def

619+ (NC.TLSSettingsSimple False False False)

611620 Nothing

612621 manager <- L.newManager settings

613− return manager

622+ newIORef manager

614623{-# NOINLINE globalManager #-}

615624

616625----------------------------------------------------------------------------

@@ -716,6 +725,7 @@ data HttpConfig = HttpConfig

716725 -- @since 3.6.0

717726 httpConfigBodyPreviewLength :: forall a. (Num a) => a

718727 }

728+ deriving (Typeable)

719729

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

721731--

@@ -1024,7 +1034,7 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where

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

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

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

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

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

10281038

10291039type role Url nominal

10301040

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

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

20122022 -- failed

20132023 JsonHttpException String

2014− deriving (Show, Generic)

2024+ deriving (Show, Typeable, Generic)

20152025

20162026instance Exception HttpException

20172027

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

20482058 Http

20492059 | -- | HTTPS

20502060 Https

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

2061+ 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-data/robots.txt → httpbun-data/robots.txtrenamed

The content is the same.

httpbin-data/utf8.html → httpbun-data/utf8.htmlrenamed

The content is the same.

httpbin-tests/Network/HTTP/ReqSpec.hs → httpbun-tests/Network/HTTP/ReqSpec.hsrenamed+91−156

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

@@ -34,25 +33,25 @@ spec :: Spec

3433spec = do

3534 describe "exception throwing on non-2xx status codes" $

3635 it "throws indeed for non-2xx" $

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

36+ req GET (httpbun /: "foo") NoReqBody ignoreResponse mempty

3837 `shouldThrow` selector404

3938

4039 describe "exception throwing on non-2xx status codes (Req monad)" $

4140 it "throws indeed for non-2xx" $

4241 asIO . runReq defaultHttpConfig $

4342 liftBaseWith $ \run ->

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

43+ run (req GET (httpbun /: "foo") NoReqBody ignoreResponse mempty)

4544 `shouldThrow` selector404

4645

4746 describe "response check via httpConfigCheckResponse" $

4847 context "if it's set to always throw" $

4948 it "throws indeed" $

50− blindlyThrowing (req GET httpbin NoReqBody ignoreResponse mempty)

49+ blindlyThrowing (req GET httpbun NoReqBody ignoreResponse mempty)

5150 `shouldThrow` anyException

5251

5352 describe "isStatusCodeException" $

5453 it "extracts non-2xx response" $

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

54+ req GET (httpbun /: "foo") NoReqBody ignoreResponse mempty

5655 `shouldThrow` selector404ByStatusCodeException

5756

5857 describe "receiving user-agent header back" $

@@ -60,7 +59,7 @@ spec = do

6059 r <-

6160 req

6261 GET

63− (httpbin /: "user-agent")

62+ (httpbun /: "user-agent")

6463 NoReqBody

6564 jsonResponse

6665 (header "user-agent" "Req")

@@ -75,7 +74,7 @@ spec = do

7574 r <-

7675 req

7776 GET

78− (httpbin /: "headers")

77+ (httpbun /: "headers")

7978 NoReqBody

8079 jsonResponse

8180 (header "Foo" "bar" <> header "Baz" "quux")

@@ -93,11 +92,12 @@ spec = do

9392

9493 describe "receiving GET data back" $

9594 it "works" $ do

96− r <- req GET (httpbin /: "get") NoReqBody jsonResponse mempty

95+ r <- req GET (httpbun /: "get") NoReqBody jsonResponse mempty

9796 (stripFunnyHeaders . stripOrigin) (responseBody r)

9897 `shouldBe` object

9998 [ "args" .= emptyObject,

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

99+ "url" .= ("https://httpbun.org/get" :: Text),

100+ "method" .= ("GET" :: Text),

101101 "headers"

102102 .= object

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

@@ -111,13 +111,14 @@ spec = do

111111 it "works" $ do

112112 let text = "foo" :: Text

113113 reflected = reflectJSON text

114− r <- req POST (httpbin /: "post") (ReqBodyJson text) jsonResponse mempty

114+ r <- req POST (httpbun /: "post") (ReqBodyJson text) jsonResponse mempty

115115 (stripFunnyHeaders . stripOrigin) (responseBody r)

116116 `shouldBe` object

117117 [ "args" .= emptyObject,

118118 "json" .= text,

119119 "data" .= reflected,

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

120+ "url" .= ("https://httpbun.org/post" :: Text),

121+ "method" .= ("POST" :: Text),

121122 "headers"

122123 .= object

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

@@ -138,14 +139,15 @@ spec = do

138139 [ LM.partBS "foo" "foo data!",

139140 LM.partBS "bar" "bar data!"

140141 ]

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

142+ r <- req POST (httpbun /: "post") body jsonResponse mempty

142143 let contentType = fromJust (getRequestContentType body)

143144 (stripFunnyHeaders . stripOrigin) (responseBody r)

144145 `shouldBe` object

145146 [ "args" .= emptyObject,

146147 "json" .= Null,

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

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

149+ "url" .= ("https://httpbun.org/post" :: Text),

150+ "method" .= ("POST" :: Text),

149151 "headers"

150152 .= object

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

@@ -166,15 +168,16 @@ spec = do

166168 describe "receiving PATCHed file back" $

167169 it "works" $ do

168170 let file :: FilePath

169− file = "httpbin-data/robots.txt"

171+ file = "httpbun-data/robots.txt"

170172 contents <- TIO.readFile file

171− r <- req PATCH (httpbin /: "patch") (ReqBodyFile file) jsonResponse mempty

173+ r <- req PATCH (httpbun /: "patch") (ReqBodyFile file) jsonResponse mempty

172174 (stripFunnyHeaders . stripOrigin) (responseBody r)

173175 `shouldBe` object

174176 [ "args" .= emptyObject,

175177 "json" .= Null,

176178 "data" .= contents,

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

179+ "url" .= ("https://httpbun.org/patch" :: Text),

180+ "method" .= ("PATCH" :: Text),

178181 "headers"

179182 .= object

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

@@ -193,13 +196,14 @@ spec = do

193196 "foo" =: ("bar" :: Text)

194197 <> "baz" =: (5 :: Int)

195198 <> queryFlag "quux"

196− r <- req PUT (httpbin /: "put") (ReqBodyUrlEnc params) jsonResponse mempty

199+ r <- req PUT (httpbun /: "put") (ReqBodyUrlEnc params) jsonResponse mempty

197200 (stripFunnyHeaders . stripOrigin) (responseBody r)

198201 `shouldBe` object

199202 [ "args" .= emptyObject,

200203 "json" .= Null,

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

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

205+ "url" .= ("https://httpbun.org/put" :: Text),

206+ "method" .= ("PUT" :: Text),

203207 "headers"

204208 .= object

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

@@ -218,24 +222,19 @@ spec = do

218222 responseStatusCode r `shouldBe` 200

219223 responseStatusMessage r `shouldBe` "OK"

220224

221− -- TODO /delete

222−

223− describe "receiving UTF-8 encoded Unicode data" $

224− it "works" $ do

225− r <-

226− req

227− GET

228− (httpbin /: "encoding" /: "utf8")

229− NoReqBody

230− bsResponse

231− mempty

232− utf8data <- B.readFile "httpbin-data/utf8.html"

233− responseBody r `shouldBe` utf8data

234− responseStatusCode r `shouldBe` 200

235− responseStatusMessage r `shouldBe` "OK"

236−

237− -- TODO /gzip

238− -- TODO /deflate

225+ -- describe "receiving UTF-8 encoded Unicode data" $

226+ -- it "works" $ do

227+ -- r <-

228+ -- req

229+ -- GET

230+ -- (httpbun /: "encoding" /: "utf8")

231+ -- NoReqBody

232+ -- bsResponse

233+ -- mempty

234+ -- utf8data <- B.readFile "httpbun-data/utf8.html"

235+ -- responseBody r `shouldBe` utf8data

236+ -- responseStatusCode r `shouldBe` 200

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

239238

240239 describe "retrying" $

241240 it "retries as many times as specified" $ do

@@ -246,7 +245,7 @@ spec = do

246245 prepareForShit $

247246 req

248247 GET

249− (httpbin /: "status" /~ status)

248+ (httpbun /: "status" /~ status)

250249 NoReqBody

251250 ignoreResponse

252251 mempty

@@ -258,25 +257,18 @@ spec = do

258257 forM_ [400 .. 431] checkStatusCode

259258 forM_ [500 .. 511] checkStatusCode

260259

261− -- TODO /response-headers

262− -- TODO /redirect

263−

264260 describe "redirects" $

265261 it "follows redirects" $ do

266262 r <-

267263 req

268264 GET

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

265+ (httpbun /: "redirect-to")

270266 NoReqBody

271267 ignoreResponse

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

268+ ("url" =: ("https://httpbun.org" :: Text))

273269 responseStatusCode r `shouldBe` 200

274270 responseStatusMessage r `shouldBe` "OK"

275271

276− -- TODO /relative-redicet

277− -- TODO /absolute-redirect

278− -- TODO /cookies

279−

280272 describe "basicAuth" $ do

281273 let user, password :: Text

282274 user = "Scooby"

@@ -287,43 +279,32 @@ spec = do

287279 prepareForShit $

288280 req

289281 GET

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

282+ (httpbun /: "basic-auth" /~ user /~ password)

291283 NoReqBody

292284 ignoreResponse

293285 mempty

294286 responseStatusCode r `shouldBe` 401

295− responseStatusMessage r `shouldBe` "UNAUTHORIZED"

287+ responseStatusMessage r `shouldBe` "Unauthorized"

296288 context "when we provide appropriate basic auth data" $

297289 it "succeeds" $ do

298290 r <-

299291 req

300292 GET

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

293+ (httpbun /: "basic-auth" /~ user /~ password)

302294 NoReqBody

303295 ignoreResponse

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

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

305297 responseStatusCode r `shouldBe` 200

306298 responseStatusMessage r `shouldBe` "OK"

307299

308− -- TODO /hidden-basic-auth

309− -- TODO /digest-auth

310− -- TODO /stream

311− -- TODO /delay

312− -- TODO /drip

313− -- TODO /range

314− -- TODO /html

315−

316300 describe "robots.txt" $

317301 it "works" $ do

318− r <- req GET (httpbin /: "robots.txt") NoReqBody bsResponse mempty

319− robots <- B.readFile "httpbin-data/robots.txt"

302+ r <- req GET (httpbun /: "robots.txt") NoReqBody bsResponse mempty

303+ robots <- B.readFile "httpbun-data/robots.txt"

320304 responseBody r `shouldBe` robots

321305 responseStatusCode r `shouldBe` 200

322306 responseStatusMessage r `shouldBe` "OK"

323307

324− -- TODO /deny

325− -- TODO /cache

326−

327308 describe "getting random bytes" $ do

328309 it "works" $

329310 property $ \n' -> do

@@ -332,7 +313,7 @@ spec = do

332313 r <-

333314 req

334315 GET

335− (httpbin /: "bytes" /~ n)

316+ (httpbun /: "bytes" /~ n)

336317 NoReqBody

337318 lbsResponse

338319 mempty

@@ -348,36 +329,27 @@ spec = do

348329 n = 1000

349330 req

350331 GET

351− (httpbin /: "bytes" /~ n)

332+ (httpbun /: "bytes" /~ n)

352333 NoReqBody

353334 (Proxy :: Proxy (JsonResponse Value))

354335 mempty

355336 `shouldThrow` selector

356337

357− describe "streaming random bytes" $

358− it "works" $

359− property $ \n' -> do

360− let n :: Word

361− n = getSmall n'

362− r <-

363− req

364− GET

365− (httpbin /: "stream-bytes" /~ n)

366− NoReqBody

367− bsResponse

368− mempty

369− responseBody r `shouldSatisfy` ((== n) . fromIntegral . B.length)

370− responseStatusCode r `shouldBe` 200

371− responseStatusMessage r `shouldBe` "OK"

372−

373−-- TODO /links

374−-- TODO /image

375−-- TODO /image/png

376−-- TODO /image/jpeg

377−-- TODO /image/webp

378−-- TODO /image/svg

379−-- TODO /forms/post

380−-- TODO /xml

338+-- describe "streaming random bytes" $

339+-- it "works" $

340+-- property $ \n' -> do

341+-- let n :: Word

342+-- n = getSmall n'

343+-- r <-

344+-- req

345+-- GET

346+-- (httpbun /: "stream-bytes" /~ n)

347+-- NoReqBody

348+-- bsResponse

349+-- mempty

350+-- responseBody r `shouldSatisfy` ((== n) . fromIntegral . B.length)

351+-- responseStatusCode r `shouldBe` 200

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

381353

382354----------------------------------------------------------------------------

383355-- Instances

@@ -400,29 +372,9 @@ blindlyThrowing = runReq defaultHttpConfig {httpConfigCheckResponse = doit}

400372 where

401373 doit _ _ = error "Oops!"

402374

403−-- | '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

375+-- | 'Url' representing <https://httpbun.org>.

376+httpbun :: Url 'Https

377+httpbun = https "httpbun.org"

426378

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

428380-- to depend on that.

@@ -432,38 +384,21 @@ stripOrigin value = value

432384

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

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

465−

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

387+stripFunnyHeaders (Object m) =

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

389+ f value = value

390+ hs =

391+ [ "Content-Type",

392+ "Accept-Encoding",

393+ "Host",

394+ "Content-Length",

395+ "Foo",

396+ "Baz"

397+ ]

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

399+stripFunnyHeaders value = value

400+

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

467402-- get various response status codes.

468403checkStatusCode :: Int -> SpecWith ()

469404checkStatusCode code =

@@ -473,7 +408,7 @@ checkStatusCode code =

473408 prepareForShit $

474409 req

475410 GET

476− (httpbin /: "status" /~ code)

411+ (httpbun /: "status" /~ code)

477412 NoReqBody

478413 ignoreResponse

479414 mempty

httpbin-tests/Spec.hs → httpbun-tests/Spec.hsrenamed

The content is the same.

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

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

req.cabal+45−44

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

11cabal-version: 2.4

22name: req

3−version: 3.13.4

3+version: 3.13.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 ==9.0.2 ghc ==9.2.5 ghc ==9.4.4

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

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

1111synopsis: HTTP client library

@@ -13,8 +13,8 @@ description: HTTP client library.

1313category: Network, Web

1414build-type: Simple

1515data-files:

16− httpbin-data/utf8.html

17− httpbin-data/robots.txt

16+ httpbun-data/utf8.html

17+ httpbun-data/robots.txt

1818

1919extra-doc-files:

2020 CHANGELOG.md

@@ -31,97 +31,98 @@ 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.15 && <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+ containers >=0.5 && <0.7,

43+ crypton-connection >=0.2.2 && <0.4,

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.20,

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,

7881 base >=4.15 && <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.20,

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

101103

102−test-suite httpbin-tests

104+test-suite httpbun-tests

103105 type: exitcode-stdio-1.0

104106 main-is: Spec.hs

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

106− hs-source-dirs: httpbin-tests

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

108+ hs-source-dirs: httpbun-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.15 && <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