526a33a...master · typeable/req

git.iko.soy/typeable/req

13 files changed+295−223

since splitsnapshots

unifiedsplit

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

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

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

1111 ormolu:

1212 runs-on: ubuntu-latest

1313 steps:

14− - uses: actions/checkout@v3

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

14+ - uses: actions/checkout@v4

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

1616 build:

1717 runs-on: ubuntu-latest

1818 needs: ormolu

1919 strategy:

2020 matrix:

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"

21+ cabal: ["3.12"]

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

2523 steps:

26− - uses: actions/checkout@v3

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

24+ - uses: actions/checkout@v4

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

2826 id: setup-haskell-cabal

2927 with:

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

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

3230 - run: cabal update

33− - run: cabal freeze $CONFIG

34− - uses: actions/cache@v3.2.5

31+ - run: cabal freeze

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

3533 with:

3634 path: |

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

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

4038 restore-keys: |

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

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

43− - run: cabal build $CONFIG

44− - run: cabal test $CONFIG

45− - run: cabal haddock $CONFIG

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

4647 - run: cabal sdist

.gitignore+1

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

2525cabal.sandbox.config

2626dist-*/

2727dist/

28+hie.yaml

2829stack.yaml

2930stack.yaml.lock

CHANGELOG.md+19−1

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

1−## Unreleased

1+## Req 3.13.4

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

7+## Req 3.13.3

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

218

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

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

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

622

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

824

25+* Builds with GHC 9.6.1.

26+

927## Req 3.13.0

1028

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

Network/HTTP/Req.hs+39−49

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

1−{-# LANGUAGE BangPatterns #-}

21{-# LANGUAGE DataKinds #-}

3−{-# LANGUAGE DeriveDataTypeable #-}

4−{-# LANGUAGE DeriveGeneric #-}

5−{-# LANGUAGE DeriveLift #-}

6−{-# LANGUAGE FlexibleInstances #-}

7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}

82{-# LANGUAGE LambdaCase #-}

9−{-# LANGUAGE MultiParamTypeClasses #-}

103{-# LANGUAGE OverloadedStrings #-}

114{-# LANGUAGE QuasiQuotes #-}

12−{-# LANGUAGE RankNTypes #-}

135{-# LANGUAGE RecordWildCards #-}

146{-# LANGUAGE RoleAnnotations #-}

15−{-# LANGUAGE ScopedTypeVariables #-}

16−{-# LANGUAGE StandaloneDeriving #-}

177{-# LANGUAGE TemplateHaskellQuotes #-}

188{-# LANGUAGE TypeFamilies #-}

199{-# LANGUAGE UndecidableInstances #-}

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

213203 )

214204where

215205

216−import qualified Blaze.ByteString.Builder as BB

206+import Blaze.ByteString.Builder qualified as BB

217207import Control.Applicative

218208import Control.Arrow (first, second)

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

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

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

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

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

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

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

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

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

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

241231import Control.Retry

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

243−import qualified Data.Aeson as A

233+import Data.Aeson qualified as A

244234import Data.ByteString (ByteString)

245−import qualified Data.ByteString as B

246−import qualified Data.ByteString.Lazy as BL

247−import qualified Data.CaseInsensitive as CI

235+import Data.ByteString qualified as B

236+import Data.ByteString.Lazy qualified as BL

237+import Data.CaseInsensitive qualified as CI

248238import Data.Data (Data)

239+import Data.Default.Class (def)

249240import Data.Function (on)

250241import Data.IORef

251242import Data.Kind (Constraint, Type)

252243import Data.List (foldl', nubBy)

253244import Data.List.NonEmpty (NonEmpty (..))

254−import qualified Data.List.NonEmpty as NE

245+import Data.List.NonEmpty qualified as NE

255246import Data.Maybe (fromMaybe)

256247import Data.Proxy

257248import Data.Semigroup (Endo (..))

258−import qualified Data.Set as S

249+import Data.Set qualified as S

259250import Data.Text (Text)

260−import qualified Data.Text as T

261−import qualified Data.Text.Encoding as T

251+import Data.Text qualified as T

252+import Data.Text.Encoding qualified as T

262253import Data.Typeable (Typeable, cast)

263254import GHC.Generics

264255import GHC.TypeLits

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

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

274265import System.IO.Unsafe (unsafePerformIO)

275266import Text.URI (URI)

276−import qualified Text.URI as URI

277−import qualified Text.URI.QQ as QQ

278−import qualified Web.Authenticate.OAuth as OAuth

267+import Text.URI qualified as URI

268+import Text.URI.QQ qualified as QQ

269+import Web.Authenticate.OAuth qualified as OAuth

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

280−import qualified Web.FormUrlEncoded as Form

271+import Web.FormUrlEncoded qualified as Form

281272import Web.HttpApiData (ToHttpApiData (..))

282273

283274----------------------------------------------------------------------------

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

594585 withReqManager (m request)

595586

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

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

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

598589-- 'L.Manager' controls.

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

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

591+withReqManager m = m globalManager

601592

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

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

@@ -610,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m

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

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

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

613−globalManager :: IORef L.Manager

604+globalManager :: L.Manager

614605globalManager = unsafePerformIO $ do

615606 context <- NC.initConnectionContext

616607 let settings =

617608 L.mkManagerSettingsContext

618609 (Just context)

619− (NC.TLSSettingsSimple False False False)

610+ def

620611 Nothing

621612 manager <- L.newManager settings

622− newIORef manager

613+ return manager

623614{-# NOINLINE globalManager #-}

624615

625616----------------------------------------------------------------------------

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

725716 -- @since 3.6.0

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

727718 }

728− deriving (Typeable)

729719

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

731721--

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

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

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

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

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

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

10381028

10391029type role Url nominal

10401030

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

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

20222012 -- failed

20232013 JsonHttpException String

2024− deriving (Show, Typeable, Generic)

2014+ deriving (Show, Generic)

20252015

20262016instance Exception HttpException

20272017

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

20582048 Http

20592049 | -- | HTTPS

20602050 Https

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

2051+ deriving (Eq, Ord, Show, Data, 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/workflows/CI/badge.svg?branch=master)

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

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

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

Setup.hsdeleted−6

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

1−module Main (main) where

2−

3−import Distribution.Simple

4−

5−main :: IO ()

6−main = defaultMain

cabal.projectnew file+4

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

1+packages: .

2+tests: True

3+benchmarks: True

4+constraints: req +dev

httpbun-data/robots.txt → httpbin-data/robots.txtrenamed

The content is the same.

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

The content is the same.

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

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

1111import Control.Monad (forM_)

1212import Control.Monad.Trans.Control

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

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

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

1818import Data.Functor.Identity (runIdentity)

1919import Data.Maybe (fromJust)

2020import Data.Proxy

2121import Data.Text (Text)

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

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

2930import Test.Hspec

3031import Test.QuickCheck

3132

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

3334spec = do

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

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

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

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

3738 `shouldThrow` selector404

3839

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

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

4142 asIO . runReq defaultHttpConfig $

4243 liftBaseWith $ \run ->

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

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

4445 `shouldThrow` selector404

4546

4647 describe "response check via httpConfigCheckResponse" $

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

4849 it "throws indeed" $

49− blindlyThrowing (req GET httpbun NoReqBody ignoreResponse mempty)

50+ blindlyThrowing (req GET httpbin NoReqBody ignoreResponse mempty)

5051 `shouldThrow` anyException

5152

5253 describe "isStatusCodeException" $

5354 it "extracts non-2xx response" $

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

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

5556 `shouldThrow` selector404ByStatusCodeException

5657

5758 describe "receiving user-agent header back" $

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

5960 r <-

6061 req

6162 GET

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

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

6364 NoReqBody

6465 jsonResponse

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

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

7475 r <-

7576 req

7677 GET

77− (httpbun /: "headers")

78+ (httpbin /: "headers")

7879 NoReqBody

7980 jsonResponse

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

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

9293

9394 describe "receiving GET data back" $

9495 it "works" $ do

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

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

9697 (stripFunnyHeaders . stripOrigin) (responseBody r)

9798 `shouldBe` object

9899 [ "args" .= emptyObject,

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

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

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

101101 "headers"

102102 .= object

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

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

111111 it "works" $ do

112112 let text = "foo" :: Text

113113 reflected = reflectJSON text

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

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

115115 (stripFunnyHeaders . stripOrigin) (responseBody r)

116116 `shouldBe` object

117117 [ "args" .= emptyObject,

118118 "json" .= text,

119119 "data" .= reflected,

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

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

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

122121 "headers"

123122 .= object

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

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

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

140139 LM.partBS "bar" "bar data!"

141140 ]

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

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

143142 let contentType = fromJust (getRequestContentType body)

144143 (stripFunnyHeaders . stripOrigin) (responseBody r)

145144 `shouldBe` object

146145 [ "args" .= emptyObject,

147146 "json" .= Null,

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

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

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

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

151149 "headers"

152150 .= object

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

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

168166 describe "receiving PATCHed file back" $

169167 it "works" $ do

170168 let file :: FilePath

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

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

172170 contents <- TIO.readFile file

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

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

174172 (stripFunnyHeaders . stripOrigin) (responseBody r)

175173 `shouldBe` object

176174 [ "args" .= emptyObject,

177175 "json" .= Null,

178176 "data" .= contents,

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

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

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

181178 "headers"

182179 .= object

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

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

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

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

198195 <> queryFlag "quux"

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

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

200197 (stripFunnyHeaders . stripOrigin) (responseBody r)

201198 `shouldBe` object

202199 [ "args" .= emptyObject,

203200 "json" .= Null,

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

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

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

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

207203 "headers"

208204 .= object

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

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

222218 responseStatusCode r `shouldBe` 200

223219 responseStatusMessage r `shouldBe` "OK"

224220

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"

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

238239

239240 describe "retrying" $

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

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

245246 prepareForShit $

246247 req

247248 GET

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

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

249250 NoReqBody

250251 ignoreResponse

251252 mempty

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

257258 forM_ [400 .. 431] checkStatusCode

258259 forM_ [500 .. 511] checkStatusCode

259260

261+ -- TODO /response-headers

262+ -- TODO /redirect

263+

260264 describe "redirects" $

261265 it "follows redirects" $ do

262266 r <-

263267 req

264268 GET

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

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

266270 NoReqBody

267271 ignoreResponse

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

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

269273 responseStatusCode r `shouldBe` 200

270274 responseStatusMessage r `shouldBe` "OK"

271275

276+ -- TODO /relative-redicet

277+ -- TODO /absolute-redirect

278+ -- TODO /cookies

279+

272280 describe "basicAuth" $ do

273281 let user, password :: Text

274282 user = "Scooby"

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

279287 prepareForShit $

280288 req

281289 GET

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

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

283291 NoReqBody

284292 ignoreResponse

285293 mempty

286294 responseStatusCode r `shouldBe` 401

287− responseStatusMessage r `shouldBe` "Unauthorized"

295+ responseStatusMessage r `shouldBe` "UNAUTHORIZED"

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

289297 it "succeeds" $ do

290298 r <-

291299 req

292300 GET

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

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

294302 NoReqBody

295303 ignoreResponse

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

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

297305 responseStatusCode r `shouldBe` 200

298306 responseStatusMessage r `shouldBe` "OK"

299307

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+

300316 describe "robots.txt" $

301317 it "works" $ do

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

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

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

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

304320 responseBody r `shouldBe` robots

305321 responseStatusCode r `shouldBe` 200

306322 responseStatusMessage r `shouldBe` "OK"

307323

324+ -- TODO /deny

325+ -- TODO /cache

326+

308327 describe "getting random bytes" $ do

309328 it "works" $

310329 property $ \n' -> do

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

313332 r <-

314333 req

315334 GET

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

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

317336 NoReqBody

318337 lbsResponse

319338 mempty

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

329348 n = 1000

330349 req

331350 GET

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

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

333352 NoReqBody

334353 (Proxy :: Proxy (JsonResponse Value))

335354 mempty

336355 `shouldThrow` selector

337356

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"

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

353381

354382----------------------------------------------------------------------------

355383-- Instances

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

372400 where

373401 doit _ _ = error "Oops!"

374402

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

376−httpbun :: Url 'Https

377−httpbun = https "httpbun.org"

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

378426

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

380428-- to depend on that.

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

384432

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

386434stripFunnyHeaders :: Value -> Value

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

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

402467-- get various response status codes.

403468checkStatusCode :: Int -> SpecWith ()

404469checkStatusCode code =

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

408473 prepareForShit $

409474 req

410475 GET

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

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

412477 NoReqBody

413478 ignoreResponse

414479 mempty

httpbun-tests/Spec.hs → httpbin-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 qualified Blaze.ByteString.Builder as BB

16+import Blaze.ByteString.Builder qualified as BB

1717import Control.Exception (throwIO)

1818import Control.Monad

1919import Control.Retry

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

21−import qualified Data.Aeson as A

21+import Data.Aeson qualified as A

2222import Data.ByteString (ByteString)

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

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

2727import Data.Either (isRight)

28−import qualified Data.List.NonEmpty as NE

28+import Data.List.NonEmpty qualified as NE

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

3030import Data.Proxy

3131import Data.Text (Text)

32−import qualified Data.Text as T

33−import qualified Data.Text.Encoding as T

32+import Data.Text qualified as T

33+import Data.Text.Encoding qualified as T

3434import Data.Time

3535import Data.Typeable (Typeable, eqT)

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

3737import GHC.Generics

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

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

4141import Network.HTTP.Req

42−import qualified Network.HTTP.Types as Y

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

42+import Network.HTTP.Types qualified as Y

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

4444import Test.Hspec

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

4646import Test.QuickCheck

4747import Text.URI (URI)

48−import qualified Text.URI as URI

49−import qualified Text.URI.QQ as QQ

50−import qualified Web.FormUrlEncoded as F

48+import Text.URI qualified as URI

49+import Text.URI.QQ qualified as QQ

50+import Web.FormUrlEncoded qualified as F

5151

5252spec :: Spec

5353spec = do

req.cabal+44−45

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

11cabal-version: 2.4

22name: req

3−version: 3.13.0

3+version: 3.13.4

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.0.2 ghc ==9.2.5 ghc ==9.4.4

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

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− httpbun-data/utf8.html

17− httpbun-data/robots.txt

16+ httpbin-data/utf8.html

17+ httpbin-data/robots.txt

1818

1919extra-doc-files:

2020 CHANGELOG.md

@@ -31,98 +31,97 @@ flag dev

3131

3232library

3333 exposed-modules: Network.HTTP.Req

34− default-language: Haskell2010

34+ default-language: GHC2021

3535 build-depends:

3636 aeson >=0.9 && <3,

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

38− base >=4.15 && <5.0,

38+ base >=4.15 && <5,

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

40− bytestring >=0.10.8 && <0.12,

40+ bytestring >=0.10.8 && <0.13,

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

42− containers >=0.5 && <0.7,

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

42+ containers >=0.5 && <0.8,

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

44+ data-default-class >=0.2.0.0,

4445 exceptions >=0.6 && <0.11,

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

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

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

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

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

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

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

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

5152 mtl >=2.0 && <3.0,

5253 retry >=0.8 && <0.10,

53− template-haskell >=2.14 && <2.20,

54− text >=0.2 && <2.1,

55− time >=1.2 && <1.13,

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

55+ text >=0.2 && <2.2,

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: -O0 -Wall -Werror

61+ ghc-options:

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

63+ -Wno-unused-imports

6264

6365 else

6466 ghc-options: -O2 -Wall

6567

66− if flag(dev)

67− ghc-options:

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

69− -Wnoncanonical-monad-instances

70−

7168test-suite pure-tests

7269 type: exitcode-stdio-1.0

7370 main-is: Spec.hs

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

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

7572 hs-source-dirs: pure-tests

7673 other-modules: Network.HTTP.ReqSpec

77− default-language: Haskell2010

74+ default-language: GHC2021

7875 build-depends:

79− QuickCheck >=2.7 && <3.0,

76+ QuickCheck >=2.7 && <3,

8077 aeson >=0.9 && <3,

8178 base >=4.15 && <5.0,

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

83− bytestring >=0.10.8 && <0.12,

80+ bytestring >=0.10.8 && <0.13,

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

85− hspec >=2.0 && <3.0,

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

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

82+ hspec >=2.0 && <3,

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

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

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

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

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

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

91− mtl >=2.0 && <3.0,

9288 req,

9389 retry >=0.8 && <0.10,

94− template-haskell >=2.14 && <2.20,

95− text >=0.2 && <2.1,

96− time >=1.2 && <1.13

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

91+ text >=0.2 && <2.2,

92+ time >=1.2 && <1.15

9793

9894 if flag(dev)

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

95+ ghc-options:

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

97+ -Wunused-packages

10098

10199 else

102100 ghc-options: -O2 -Wall

103101

104−test-suite httpbun-tests

102+test-suite httpbin-tests

105103 type: exitcode-stdio-1.0

106104 main-is: Spec.hs

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

108− hs-source-dirs: httpbun-tests

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

106+ hs-source-dirs: httpbin-tests

109107 other-modules: Network.HTTP.ReqSpec

110− default-language: Haskell2010

108+ default-language: GHC2021

111109 build-depends:

112− QuickCheck >=2.7 && <3.0,

110+ QuickCheck >=2.7 && <3,

113111 aeson >=2 && <3,

114− base >=4.15 && <5.0,

115− bytestring >=0.10.8 && <0.12,

112+ base >=4.15 && <5,

113+ bytestring >=0.10.8 && <0.13,

116114 hspec >=2.0 && <3.0,

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

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

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

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

120− mtl >=2.0 && <3.0,

121118 req,

122− text >=0.2 && <2.1

119+ text >=0.2 && <2.2

123120

124121 if flag(dev)

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

122+ ghc-options:

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

124+ -Wunused-packages

126125

127126 else

128− ghc-options: -O2 -Wall

127+ buildable: False