File: CHANGELOG.md

package info (click to toggle)
haskell-req 3.13.4-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 220 kB
  • sloc: haskell: 1,914; makefile: 3
file content (247 lines) | stat: -rw-r--r-- 7,811 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
## Req 3.13.4

* Fixed empty ciphersuite list when compiling against `tls < 2.0.6`
  (see [PR 175](https://github.com/mrkkrp/req/pull/175)). As a side effect, now
  compatible with older versions of `crypton-connection` (>= 0.3).

## Req 3.13.3

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

## Req 3.13.2

* Disable the problematic `httpbin-tests` test suite by default. Only enable
  it when the `dev` flag is enabled. In that case it is expected that an
  httpbin server is run locally at `localhost:1234`.

## Req 3.13.1

* Switched the non-pure test suite to use https://httpbun.org instead of
  https://httpbin.org since the latter proved to be highly unreliable
  lately.

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

* Builds with GHC 9.6.1.

## Req 3.13.0

* Add `headerRedacted` function to add header fields, which will be with
  redacted values on print.

## Req 3.12.0

* Add `isStatusCodeException` function.
* Add `instance HttpResponse (Network.HTTP.Client.Response ())`.

## Req 3.11.0

* Add the `queryParamToList` method to the `QueryParam` type class.
* Add the `formToQuery` function. [Issue 126](https://github.com/mrkkrp/req/issues/126).
* Add `FromForm` instances (in the `Web.FormUrlEncoded` module) to the
  `Option` and `FormUrlEncodedParam` types.

## Req 3.10.0

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

## Req 3.9.2

* The test suite works with `aeson-2.x.x.x`.

## Req 3.9.1

* Builds with GHC 9.0.

## Req 3.9.0

* The `useHttpURI` and `useHttpsURI` functions now preserve trailing
  slashes.

## Req 3.8.0

* Adjusted the value of the `httpConfigRetryJudgeException` field of
  `defaultHttpConfig` to retry on response timeouts and connection timeouts.

## Req 3.7.0

* Added `reqCb`, a function that allows you to modify the `Request` object
  but otherwise performs the requst for you.

* Derived `MonadThrow`, `MonadCatch`, and `MonadMask` for the `Req` monad.

## Req 3.6.0

* Added the `httpConfigBodyPreviewLength` configuration parameter to
  `HttpConfig`.

## Req 3.5.0

* Made `Req` an instance of `MonadUnliftIO`. [Issue
  100](https://github.com/mrkkrp/req/issues/100).

## Req 3.4.0

* Requests using `DELETE` method can now have a body. [Issue
  89](https://github.com/mrkkrp/req/issues/89).

* Added the `httpConfigRetryJudgeException` field to `HttpConfig` so that
  requests that result in exceptions can be retried. [Issue
  93](https://github.com/mrkkrp/req/issues/93).

* Added the function `renderUrl`. [Issue
  83](https://github.com/mrkkrp/req/issues/83).

## Req 3.3.0

* Derived `Show` instances for response types `IgnoreResponse`,
  `JsonResponse`, `BsResponse`, and `LbsResponse`.

## Req 3.2.0

* Made the tests pass with `http-client-0.7` and later.

* Added a quasiquoter for URL creation, `urlQ`.

## Req 3.1.0

* Changed signature of `httpConfigRetryPolicy` to `RetryPolicyM IO`.

## Req 3.0.0

* Dropped functions `parseUrlHttp`, `parseUrlHttps`, and `parseUrl`. Instead
  we now have `useHttpURI`, `useHttpsURI`, and `useURI` take `URI`s from
  `modern-uri` as their argument. You first parse your URL with the
  `modern-uri` package and then pass it to those functions. This allows us
  to work with typed URI representations and seamlessly convert them to
  something `req` can work with. As a side effect basic auth from the `URI`s
  is now taken into consideration. In the future we may also start to
  respect fragments if `http-client` starts to support this.

* Dropped support for GHC 8.2 and older.

## Req 2.1.0

* Dropped support for GHC 7.10.

* Added the new `acceptHeader` method to the `HttpResponse` type class.
  Notably, the `jsonResponse` method now sets `"Accept"` header to
  `"application/json"`.

## Req 2.0.1

* Fixed the `httpbin` tests (they changed something on the server again).

## Req 2.0.0

* Got rid of `data-default-class` dependency, now we export
  `defaultHttpConfig` instead.

## Req 1.2.1

* Fixed a typo in the type signature of `parseUrl`.

## Req 1.2.0

* Added the `parseUrl` function.

## Req 1.1.0

* Added `customAuth` and `attachHeader` to facilitate creation of custom
  authentication options.

* Added `basicProxyAuth` authentication option.

## Req 1.0.0

* Added the `reqBr` function allowing to consume `Response BodyReader`
  without using a pre-defined instance of `HttpResponse`, in a custom way.

* Now streaming of response body does not happen until we've checked headers
  and status code with `httpConfigCheckResponse`. It also doesn't happen on
  every retry. Streaming and obtaining of final response value happens only
  once when we're happy with everything.

  Previously we first tried to consume and interpret response body before
  checking status code and determining whether we should retry the request.
  This was not good, because we could expect a JSON response but get a
  response with status code 500, and then still we would try to parse it as
  JSON first before letting `httpConfigCheckResponse` throw an exception.

  The corrected behavior should also make retrying more efficient.

* Changed signatures of several fields of `HttpConfig`:
  `httpConfigCheckResponse`, `httpConfigRetryPolicy`, and
  `httpConfigRetryJudge` in order to eliminate redundant `IO` and prevent
  the possibility that these functions could start consuming `BodyReader`.

* Removed the `makeResponsePreview` method from the `HttpResponse` type
  class. Preview business is handled by the library automatically on a lower
  level now. Users do not need to concern themselves with such stuff.

* Changed the type signature of the `getHttpResponse` method of the
  `HttpResponse` type class. Previously it left too much freedom (and
  responsibility) to implementers of the method. In fact, we now limit what
  `getHttpResponse` does to just consuming and interpreting `Response
  BodyReader`, so we can properly control details of connection
  opening/closing etc., for the user.

* Dropped support for GHC 7.8.

* Minor documentation improvements.

## Req 0.5.0

* Changed the signature of the `makeResponseBodyPreview` from `response ->
  IO ByteString` to `response -> ByteString`.

* Minor documentation improvements.

## Req 0.4.0

* Added the `Req` monad and `runReq` function to run it. This allows to use
  `req` without defining new (orphan) instances.

## Req 0.3.1

* Added `basicAuthUnsafe`.

## Req 0.3.0

* Made URL parsing functions `parseUrlHttp` and `parseUrlHttps` recognize
  port numbers.

* Added `req'` function that allows to perform requests via a callback that
  receives pre-constructed request and manager.

* Removed the `ReturnRequest` HTTP response implementation as it was not
  quite safe and was not going to work with retrying. Use `req'` instead for
  “pure” testing.

* Changed the type of `httpConfigCheckResponse`, so the second argument can
  be any instance of `HttpResponse`.

* Added built-in automatic retrying. See `httpConfigRetryPolicy` and
  `httpConfigRetryJudge` in `HttpConfig`. The default configuration retries
  5 times on request timeouts.

* Added the `makeResponseBodyPreview` method to the `HttpResponse` type
  class that allows to specify how to build a “preview” of response body for
  inclusion into exceptions.

* Improved wording in the documentation and `README.md`.

## Req 0.2.0

* Added support for multipart form data in the form of `ReqBodyMultipart`
  body option and `reqBodyMultipart` helper function. This also required a
  change in the type signature of `getRequestContentType`, which now takes
  `body`, not `Proxy body` because we need to extract boundary from `body`
  and put it into `Content-Type` header. This change, however, shouldn't be
  too dangerous for end-users.

* Added support for OAuth 1.0 authentication via `oAuth1` option.

## Req 0.1.0

* Initial release.