5 * Feature: force IP resolution (ipv4 or ipv6) [#1608](https://github.com/guzzle/guzzle/pull/1608), [#1659](https://github.com/guzzle/guzzle/pull/1659)
6 * Improvement: Don't include summary in exception message when body is empty [#1621](https://github.com/guzzle/guzzle/pull/1621)
7 * Improvement: Handle `on_headers` option in MockHandler [#1580](https://github.com/guzzle/guzzle/pull/1580)
8 * Improvement: Added SUSE Linux CA path [#1609](https://github.com/guzzle/guzzle/issues/1609)
9 * Improvement: Use class reference for getting the name of the class instead of using hardcoded strings [#1641](https://github.com/guzzle/guzzle/pull/1641)
10 * Feature: Added `read_timeout` option [#1611](https://github.com/guzzle/guzzle/pull/1611)
11 * Bug fix: PHP 7.x fixes [#1685](https://github.com/guzzle/guzzle/pull/1685), [#1686](https://github.com/guzzle/guzzle/pull/1686), [#1811](https://github.com/guzzle/guzzle/pull/1811)
12 * Deprecation: BadResponseException instantiation without a response [#1642](https://github.com/guzzle/guzzle/pull/1642)
13 * Feature: Added NTLM auth [#1569](https://github.com/guzzle/guzzle/pull/1569)
14 * Feature: Track redirect HTTP status codes [#1711](https://github.com/guzzle/guzzle/pull/1711)
15 * Improvement: Check handler type during construction [#1745](https://github.com/guzzle/guzzle/pull/1745)
16 * Improvement: Always include the Content-Length if there's a body [#1721](https://github.com/guzzle/guzzle/pull/1721)
17 * Feature: Added convenience method to access a cookie by name [#1318](https://github.com/guzzle/guzzle/pull/1318)
18 * Bug fix: Fill `CURLOPT_CAPATH` and `CURLOPT_CAINFO` properly [#1684](https://github.com/guzzle/guzzle/pull/1684)
19 * Improvement: Use `\GuzzleHttp\Promise\rejection_for` function instead of object init [#1827](https://github.com/guzzle/guzzle/pull/1827)
22 + Minor code cleanups, documentation fixes and clarifications.
26 * Fix deprecations with guzzle/psr7 version 1.4
30 * Allow to pass nullable Response to delay callable
31 * Only add scheme when host is present
32 * Fix drain case where content-length is the literal string zero
33 * Obfuscate in-URL credentials in exceptions
37 * Address HTTP_PROXY security vulnerability, CVE-2016-5385:
39 * Fixing timeout bug with StreamHandler:
40 https://github.com/guzzle/guzzle/pull/1488
41 * Only read up to `Content-Length` in PHP StreamHandler to avoid timeouts when
42 a server does not honor `Connection: close`.
43 * Ignore URI fragment when sending requests.
47 * Feature: added `GuzzleHttp\json_encode` and `GuzzleHttp\json_decode`.
48 https://github.com/guzzle/guzzle/pull/1389
49 * Bug fix: Fix sleep calculation when waiting for delayed requests.
50 https://github.com/guzzle/guzzle/pull/1324
51 * Feature: More flexible history containers.
52 https://github.com/guzzle/guzzle/pull/1373
53 * Bug fix: defer sink stream opening in StreamHandler.
54 https://github.com/guzzle/guzzle/pull/1377
55 * Bug fix: do not attempt to escape cookie values.
56 https://github.com/guzzle/guzzle/pull/1406
57 * Feature: report original content encoding and length on decoded responses.
58 https://github.com/guzzle/guzzle/pull/1409
59 * Bug fix: rewind seekable request bodies before dispatching to cURL.
60 https://github.com/guzzle/guzzle/pull/1422
61 * Bug fix: provide an empty string to `http_build_query` for HHVM workaround.
62 https://github.com/guzzle/guzzle/pull/1367
66 * Bug fix: Proxy::wrapSync() now correctly proxies to the appropriate handler
67 https://github.com/guzzle/guzzle/commit/911bcbc8b434adce64e223a6d1d14e9a8f63e4e4
68 * Feature: HandlerStack is now more generic.
69 https://github.com/guzzle/guzzle/commit/f2102941331cda544745eedd97fc8fd46e1ee33e
70 * Bug fix: setting verify to false in the StreamHandler now disables peer
71 verification. https://github.com/guzzle/guzzle/issues/1256
72 * Feature: Middleware now uses an exception factory, including more error
73 context. https://github.com/guzzle/guzzle/pull/1282
74 * Feature: better support for disabled functions.
75 https://github.com/guzzle/guzzle/pull/1287
76 * Bug fix: fixed regression where MockHandler was not using `sink`.
77 https://github.com/guzzle/guzzle/pull/1292
81 * Feature: Added the `on_stats` request option to provide access to transfer
82 statistics for requests. https://github.com/guzzle/guzzle/pull/1202
83 * Feature: Added the ability to persist session cookies in CookieJars.
84 https://github.com/guzzle/guzzle/pull/1195
85 * Feature: Some compatibility updates for Google APP Engine
86 https://github.com/guzzle/guzzle/pull/1216
87 * Feature: Added support for NO_PROXY to prevent the use of a proxy based on
88 a simple set of rules. https://github.com/guzzle/guzzle/pull/1197
89 * Feature: Cookies can now contain square brackets.
90 https://github.com/guzzle/guzzle/pull/1237
91 * Bug fix: Now correctly parsing `=` inside of quotes in Cookies.
92 https://github.com/guzzle/guzzle/pull/1232
93 * Bug fix: Cusotm cURL options now correctly override curl options of the
94 same name. https://github.com/guzzle/guzzle/pull/1221
95 * Bug fix: Content-Type header is now added when using an explicitly provided
96 multipart body. https://github.com/guzzle/guzzle/pull/1218
97 * Bug fix: Now ignoring Set-Cookie headers that have no name.
98 * Bug fix: Reason phrase is no longer cast to an int in some cases in the
99 cURL handler. https://github.com/guzzle/guzzle/pull/1187
100 * Bug fix: Remove the Authorization header when redirecting if the Host
101 header changes. https://github.com/guzzle/guzzle/pull/1207
102 * Bug fix: Cookie path matching fixes
103 https://github.com/guzzle/guzzle/issues/1129
104 * Bug fix: Fixing the cURL `body_as_string` setting
105 https://github.com/guzzle/guzzle/pull/1201
106 * Bug fix: quotes are no longer stripped when parsing cookies.
107 https://github.com/guzzle/guzzle/issues/1172
108 * Bug fix: `form_params` and `query` now always uses the `&` separator.
109 https://github.com/guzzle/guzzle/pull/1163
110 * Bug fix: Adding a Content-Length to PHP stream wrapper requests if not set.
111 https://github.com/guzzle/guzzle/pull/1189
113 ## 6.0.2 - 2015-07-04
115 * Fixed a memory leak in the curl handlers in which references to callbacks
116 were not being removed by `curl_reset`.
117 * Cookies are now extracted properly before redirects.
118 * Cookies now allow more character ranges.
119 * Decoded Content-Encoding responses are now modified to correctly reflect
120 their state if the encoding was automatically removed by a handler. This
121 means that the `Content-Encoding` header may be removed an the
122 `Content-Length` modified to reflect the message size after removing the
124 * Added a more explicit error message when trying to use `form_params` and
125 `multipart` in the same request.
126 * Several fixes for HHVM support.
127 * Functions are now conditionally required using an additional level of
128 indirection to help with global Composer installations.
130 ## 6.0.1 - 2015-05-27
132 * Fixed a bug with serializing the `query` request option where the `&`
133 separator was missing.
134 * Added a better error message for when `body` is provided as an array. Please
135 use `form_params` or `multipart` instead.
138 ## 6.0.0 - 2015-05-26
140 * See the UPGRADING.md document for more information.
141 * Added `multipart` and `form_params` request options.
142 * Added `synchronous` request option.
143 * Added the `on_headers` request option.
144 * Fixed `expect` handling.
145 * No longer adding default middlewares in the client ctor. These need to be
146 present on the provided handler in order to work.
147 * Requests are no longer initiated when sending async requests with the
148 CurlMultiHandler. This prevents unexpected recursion from requests completing
149 while ticking the cURL loop.
150 * Removed the semantics of setting `default` to `true`. This is no longer
151 required now that the cURL loop is not ticked for async requests.
152 * Added request and response logging middleware.
153 * No longer allowing self signed certificates when using the StreamHandler.
154 * Ensuring that `sink` is valid if saving to a file.
155 * Request exceptions now include a "handler context" which provides handler
156 specific contextual information.
157 * Added `GuzzleHttp\RequestOptions` to allow request options to be applied
159 * `$maxHandles` has been removed from CurlMultiHandler.
160 * `MultipartPostBody` is now part of the `guzzlehttp/psr7` package.
162 ## 5.3.0 - 2015-05-19
164 * Mock now supports `save_to`
165 * Marked `AbstractRequestEvent::getTransaction()` as public.
166 * Fixed a bug in which multiple headers using different casing would overwrite
167 previous headers in the associative array.
168 * Added `Utils::getDefaultHandler()`
169 * Marked `GuzzleHttp\Client::getDefaultUserAgent` as deprecated.
170 * URL scheme is now always lowercased.
174 * Requires PHP >= 5.5
175 * Updated to use PSR-7
176 * Requires immutable messages, which basically means an event based system
177 owned by a request instance is no longer possible.
178 * Utilizing the [Guzzle PSR-7 package](https://github.com/guzzle/psr7).
179 * Removed the dependency on `guzzlehttp/streams`. These stream abstractions
180 are available in the `guzzlehttp/psr7` package under the `GuzzleHttp\Psr7`
182 * Added middleware and handler system
183 * Replaced the Guzzle event and subscriber system with a middleware system.
184 * No longer depends on RingPHP, but rather places the HTTP handlers directly
185 in Guzzle, operating on PSR-7 messages.
186 * Retry logic is now encapsulated in `GuzzleHttp\Middleware::retry`, which
187 means the `guzzlehttp/retry-subscriber` is now obsolete.
188 * Mocking responses is now handled using `GuzzleHttp\Handler\MockHandler`.
189 * Asynchronous responses
190 * No longer supports the `future` request option to send an async request.
191 Instead, use one of the `*Async` methods of a client (e.g., `requestAsync`,
193 * Utilizing `GuzzleHttp\Promise` instead of React's promise library to avoid
194 recursion required by chaining and forwarding react promises. See
195 https://github.com/guzzle/promises
196 * Added `requestAsync` and `sendAsync` to send request asynchronously.
197 * Added magic methods for `getAsync()`, `postAsync()`, etc. to send requests
200 * POST and form updates
201 * Added the `form_fields` and `form_files` request options.
202 * Removed the `GuzzleHttp\Post` namespace.
203 * The `body` request option no longer accepts an array for POST requests.
204 * The `exceptions` request option has been deprecated in favor of the
205 `http_errors` request options.
206 * The `save_to` request option has been deprecated in favor of `sink` request
208 * Clients no longer accept an array of URI template string and variables for
209 URI variables. You will need to expand URI templates before passing them
210 into a client constructor or request method.
211 * Client methods `get()`, `post()`, `put()`, `patch()`, `options()`, etc. are
212 now magic methods that will send synchronous requests.
213 * Replaced `Utils.php` with plain functions in `functions.php`.
214 * Removed `GuzzleHttp\Collection`.
215 * Removed `GuzzleHttp\BatchResults`. Batched pool results are now returned as
217 * Removed `GuzzleHttp\Query`. Query string handling is now handled using an
218 associative array passed into the `query` request option. The query string
219 is serialized using PHP's `http_build_query`. If you need more control, you
220 can pass the query string in as a string.
221 * `GuzzleHttp\QueryParser` has been replaced with the
222 `GuzzleHttp\Psr7\parse_query`.
224 ## 5.2.0 - 2015-01-27
226 * Added `AppliesHeadersInterface` to make applying headers to a request based
227 on the body more generic and not specific to `PostBodyInterface`.
228 * Reduced the number of stack frames needed to send requests.
229 * Nested futures are now resolved in the client rather than the RequestFsm
230 * Finishing state transitions is now handled in the RequestFsm rather than the
232 * Added a guard in the Pool class to not use recursion for request retries.
234 ## 5.1.0 - 2014-12-19
236 * Pool class no longer uses recursion when a request is intercepted.
237 * The size of a Pool can now be dynamically adjusted using a callback.
238 See https://github.com/guzzle/guzzle/pull/943.
239 * Setting a request option to `null` when creating a request with a client will
240 ensure that the option is not set. This allows you to overwrite default
241 request options on a per-request basis.
242 See https://github.com/guzzle/guzzle/pull/937.
243 * Added the ability to limit which protocols are allowed for redirects by
244 specifying a `protocols` array in the `allow_redirects` request option.
245 * Nested futures due to retries are now resolved when waiting for synchronous
246 responses. See https://github.com/guzzle/guzzle/pull/947.
247 * `"0"` is now an allowed URI path. See
248 https://github.com/guzzle/guzzle/pull/935.
249 * `Query` no longer typehints on the `$query` argument in the constructor,
250 allowing for strings and arrays.
251 * Exceptions thrown in the `end` event are now correctly wrapped with Guzzle
252 specific exceptions if necessary.
254 ## 5.0.3 - 2014-11-03
256 This change updates query strings so that they are treated as un-encoded values
257 by default where the value represents an un-encoded value to send over the
258 wire. A Query object then encodes the value before sending over the wire. This
259 means that even value query string values (e.g., ":") are url encoded. This
260 makes the Query class match PHP's http_build_query function. However, if you
261 want to send requests over the wire using valid query string characters that do
262 not need to be encoded, then you can provide a string to Url::setQuery() and
263 pass true as the second argument to specify that the query string is a raw
264 string that should not be parsed or encoded (unless a call to getQuery() is
265 subsequently made, forcing the query-string to be converted into a Query
268 ## 5.0.2 - 2014-10-30
270 * Added a trailing `\r\n` to multipart/form-data payloads. See
271 https://github.com/guzzle/guzzle/pull/871
272 * Added a `GuzzleHttp\Pool::send()` convenience method to match the docs.
273 * Status codes are now returned as integers. See
274 https://github.com/guzzle/guzzle/issues/881
275 * No longer overwriting an existing `application/x-www-form-urlencoded` header
276 when sending POST requests, allowing for customized headers. See
277 https://github.com/guzzle/guzzle/issues/877
278 * Improved path URL serialization.
280 * No longer double percent-encoding characters in the path or query string if
281 they are already encoded.
282 * Now properly encoding the supplied path to a URL object, instead of only
283 encoding ' ' and '?'.
284 * Note: This has been changed in 5.0.3 to now encode query string values by
285 default unless the `rawString` argument is provided when setting the query
286 string on a URL: Now allowing many more characters to be present in the
287 query string without being percent encoded. See http://tools.ietf.org/html/rfc3986#appendix-A
289 ## 5.0.1 - 2014-10-16
293 * Fixed an issue where connection errors still returned response object in
294 error and end events event though the response is unusable. This has been
295 corrected so that a response is not returned in the `getResponse` method of
296 these events if the response did not complete. https://github.com/guzzle/guzzle/issues/867
297 * Fixed an issue where transfer statistics were not being populated in the
298 RingBridge. https://github.com/guzzle/guzzle/issues/866
300 ## 5.0.0 - 2014-10-12
302 Adding support for non-blocking responses and some minor API cleanup.
306 * Added support for non-blocking responses based on `guzzlehttp/guzzle-ring`.
307 * Added a public API for creating a default HTTP adapter.
308 * Updated the redirect plugin to be non-blocking so that redirects are sent
309 concurrently. Other plugins like this can now be updated to be non-blocking.
310 * Added a "progress" event so that you can get upload and download progress
312 * Added `GuzzleHttp\Pool` which implements FutureInterface and transfers
313 requests concurrently using a capped pool size as efficiently as possible.
314 * Added `hasListeners()` to EmitterInterface.
315 * Removed `GuzzleHttp\ClientInterface::sendAll` and marked
316 `GuzzleHttp\Client::sendAll` as deprecated (it's still there, just not the
321 The breaking changes in this release are relatively minor. The biggest thing to
322 look out for is that request and response objects no longer implement fluent
325 * Removed the fluent interfaces (i.e., `return $this`) from requests,
326 responses, `GuzzleHttp\Collection`, `GuzzleHttp\Url`,
327 `GuzzleHttp\Query`, `GuzzleHttp\Post\PostBody`, and
328 `GuzzleHttp\Cookie\SetCookie`. This blog post provides a good outline of
329 why I did this: http://ocramius.github.io/blog/fluent-interfaces-are-evil/.
330 This also makes the Guzzle message interfaces compatible with the current
331 PSR-7 message proposal.
332 * Removed "functions.php", so that Guzzle is truly PSR-4 compliant. Except
333 for the HTTP request functions from function.php, these functions are now
334 implemented in `GuzzleHttp\Utils` using camelCase. `GuzzleHttp\json_decode`
335 moved to `GuzzleHttp\Utils::jsonDecode`. `GuzzleHttp\get_path` moved to
336 `GuzzleHttp\Utils::getPath`. `GuzzleHttp\set_path` moved to
337 `GuzzleHttp\Utils::setPath`. `GuzzleHttp\batch` should now be
338 `GuzzleHttp\Pool::batch`, which returns an `objectStorage`. Using functions.php
339 caused problems for many users: they aren't PSR-4 compliant, require an
340 explicit include, and needed an if-guard to ensure that the functions are not
341 declared multiple times.
342 * Rewrote adapter layer.
343 * Removing all classes from `GuzzleHttp\Adapter`, these are now
344 implemented as callables that are stored in `GuzzleHttp\Ring\Client`.
345 * Removed the concept of "parallel adapters". Sending requests serially or
346 concurrently is now handled using a single adapter.
347 * Moved `GuzzleHttp\Adapter\Transaction` to `GuzzleHttp\Transaction`. The
348 Transaction object now exposes the request, response, and client as public
349 properties. The getters and setters have been removed.
350 * Removed the "headers" event. This event was only useful for changing the
351 body a response once the headers of the response were known. You can implement
352 a similar behavior in a number of ways. One example might be to use a
353 FnStream that has access to the transaction being sent. For example, when the
354 first byte is written, you could check if the response headers match your
355 expectations, and if so, change the actual stream body that is being
357 * Removed the `asArray` parameter from
358 `GuzzleHttp\Message\MessageInterface::getHeader`. If you want to get a header
359 value as an array, then use the newly added `getHeaderAsArray()` method of
360 `MessageInterface`. This change makes the Guzzle interfaces compatible with
361 the PSR-7 interfaces.
362 * `GuzzleHttp\Message\MessageFactory` no longer allows subclasses to add
363 custom request options using double-dispatch (this was an implementation
364 detail). Instead, you should now provide an associative array to the
365 constructor which is a mapping of the request option name mapping to a
366 function that applies the option value to a request.
367 * Removed the concept of "throwImmediately" from exceptions and error events.
368 This control mechanism was used to stop a transfer of concurrent requests
369 from completing. This can now be handled by throwing the exception or by
370 cancelling a pool of requests or each outstanding future request individually.
371 * Updated to "GuzzleHttp\Streams" 3.0.
372 * `GuzzleHttp\Stream\StreamInterface::getContents()` no longer accepts a
373 `maxLen` parameter. This update makes the Guzzle streams project
374 compatible with the current PSR-7 proposal.
375 * `GuzzleHttp\Stream\Stream::__construct`,
376 `GuzzleHttp\Stream\Stream::factory`, and
377 `GuzzleHttp\Stream\Utils::create` no longer accept a size in the second
378 argument. They now accept an associative array of options, including the
379 "size" key and "metadata" key which can be used to provide custom metadata.
381 ## 4.2.2 - 2014-09-08
383 * Fixed a memory leak in the CurlAdapter when reusing cURL handles.
384 * No longer using `request_fulluri` in stream adapter proxies.
385 * Relative redirects are now based on the last response, not the first response.
387 ## 4.2.1 - 2014-08-19
389 * Ensuring that the StreamAdapter does not always add a Content-Type header
390 * Adding automated github releases with a phar and zip
392 ## 4.2.0 - 2014-08-17
394 * Now merging in default options using a case-insensitive comparison.
395 Closes https://github.com/guzzle/guzzle/issues/767
396 * Added the ability to automatically decode `Content-Encoding` response bodies
397 using the `decode_content` request option. This is set to `true` by default
398 to decode the response body if it comes over the wire with a
399 `Content-Encoding`. Set this value to `false` to disable decoding the
400 response content, and pass a string to provide a request `Accept-Encoding`
401 header and turn on automatic response decoding. This feature now allows you
402 to pass an `Accept-Encoding` header in the headers of a request but still
403 disable automatic response decoding.
404 Closes https://github.com/guzzle/guzzle/issues/764
405 * Added the ability to throw an exception immediately when transferring
406 requests in parallel. Closes https://github.com/guzzle/guzzle/issues/760
407 * Updating guzzlehttp/streams dependency to ~2.1
408 * No longer utilizing the now deprecated namespaced methods from the stream
411 ## 4.1.8 - 2014-08-14
413 * Fixed an issue in the CurlFactory that caused setting the `stream=false`
414 request option to throw an exception.
415 See: https://github.com/guzzle/guzzle/issues/769
416 * TransactionIterator now calls rewind on the inner iterator.
417 See: https://github.com/guzzle/guzzle/pull/765
418 * You can now set the `Content-Type` header to `multipart/form-data`
419 when creating POST requests to force multipart bodies.
420 See https://github.com/guzzle/guzzle/issues/768
422 ## 4.1.7 - 2014-08-07
424 * Fixed an error in the HistoryPlugin that caused the same request and response
425 to be logged multiple times when an HTTP protocol error occurs.
426 * Ensuring that cURL does not add a default Content-Type when no Content-Type
427 has been supplied by the user. This prevents the adapter layer from modifying
428 the request that is sent over the wire after any listeners may have already
429 put the request in a desired state (e.g., signed the request).
430 * Throwing an exception when you attempt to send requests that have the
431 "stream" set to true in parallel using the MultiAdapter.
432 * Only calling curl_multi_select when there are active cURL handles. This was
433 previously changed and caused performance problems on some systems due to PHP
434 always selecting until the maximum select timeout.
435 * Fixed a bug where multipart/form-data POST fields were not correctly
436 aggregated (e.g., values with "&").
438 ## 4.1.6 - 2014-08-03
440 * Added helper methods to make it easier to represent messages as strings,
441 including getting the start line and getting headers as a string.
443 ## 4.1.5 - 2014-08-02
445 * Automatically retrying cURL "Connection died, retrying a fresh connect"
446 errors when possible.
447 * cURL implementation cleanup
448 * Allowing multiple event subscriber listeners to be registered per event by
449 passing an array of arrays of listener configuration.
451 ## 4.1.4 - 2014-07-22
453 * Fixed a bug that caused multi-part POST requests with more than one field to
454 serialize incorrectly.
455 * Paths can now be set to "0"
456 * `ResponseInterface::xml` now accepts a `libxml_options` option and added a
457 missing default argument that was required when parsing XML response bodies.
458 * A `save_to` stream is now created lazily, which means that files are not
459 created on disk unless a request succeeds.
461 ## 4.1.3 - 2014-07-15
463 * Various fixes to multipart/form-data POST uploads
464 * Wrapping function.php in an if-statement to ensure Guzzle can be used
465 globally and in a Composer install
466 * Fixed an issue with generating and merging in events to an event array
467 * POST headers are only applied before sending a request to allow you to change
468 the query aggregator used before uploading
469 * Added much more robust query string parsing
470 * Fixed various parsing and normalization issues with URLs
471 * Fixing an issue where multi-valued headers were not being utilized correctly
474 ## 4.1.2 - 2014-06-18
476 * Added support for sending payloads with GET requests
478 ## 4.1.1 - 2014-06-08
480 * Fixed an issue related to using custom message factory options in subclasses
481 * Fixed an issue with nested form fields in a multi-part POST
482 * Fixed an issue with using the `json` request option for POST requests
483 * Added `ToArrayInterface` to `GuzzleHttp\Cookie\CookieJar`
485 ## 4.1.0 - 2014-05-27
487 * Added a `json` request option to easily serialize JSON payloads.
488 * Added a `GuzzleHttp\json_decode()` wrapper to safely parse JSON.
489 * Added `setPort()` and `getPort()` to `GuzzleHttp\Message\RequestInterface`.
490 * Added the ability to provide an emitter to a client in the client constructor.
491 * Added the ability to persist a cookie session using $_SESSION.
492 * Added a trait that can be used to add event listeners to an iterator.
493 * Removed request method constants from RequestInterface.
494 * Fixed warning when invalid request start-lines are received.
495 * Updated MessageFactory to work with custom request option methods.
496 * Updated cacert bundle to latest build.
501 * Proxy requests using the StreamAdapter now properly use request_fulluri (#632)
502 * Added the ability to set scalars as POST fields (#628)
504 ## 4.0.1 - 2014-04-04
506 * The HTTP status code of a response is now set as the exception code of
507 RequestException objects.
508 * 303 redirects will now correctly switch from POST to GET requests.
509 * The default parallel adapter of a client now correctly uses the MultiAdapter.
510 * HasDataTrait now initializes the internal data array as an empty array so
511 that the toArray() method always returns an array.
513 ## 4.0.0 - 2014-03-29
515 * For more information on the 4.0 transition, see:
516 http://mtdowling.com/blog/2014/03/15/guzzle-4-rc/
517 * For information on changes and upgrading, see:
518 https://github.com/guzzle/guzzle/blob/master/UPGRADING.md#3x-to-40
519 * Added `GuzzleHttp\batch()` as a convenience function for sending requests in
520 parallel without needing to write asynchronous code.
521 * Restructured how events are added to `GuzzleHttp\ClientInterface::sendAll()`.
522 You can now pass a callable or an array of associative arrays where each
523 associative array contains the "fn", "priority", and "once" keys.
525 ## 4.0.0.rc-2 - 2014-03-25
527 * Removed `getConfig()` and `setConfig()` from clients to avoid confusion
528 around whether things like base_url, message_factory, etc. should be able to
529 be retrieved or modified.
530 * Added `getDefaultOption()` and `setDefaultOption()` to ClientInterface
531 * functions.php functions were renamed using snake_case to match PHP idioms
532 * Added support for `HTTP_PROXY`, `HTTPS_PROXY`, and
533 `GUZZLE_CURL_SELECT_TIMEOUT` environment variables
534 * Added the ability to specify custom `sendAll()` event priorities
535 * Added the ability to specify custom stream context options to the stream
537 * Added a functions.php function for `get_path()` and `set_path()`
538 * CurlAdapter and MultiAdapter now use a callable to generate curl resources
539 * MockAdapter now properly reads a body and emits a `headers` event
540 * Updated Url class to check if a scheme and host are set before adding ":"
541 and "//". This allows empty Url (e.g., "") to be serialized as "".
542 * Parsing invalid XML no longer emits warnings
543 * Curl classes now properly throw AdapterExceptions
544 * Various performance optimizations
545 * Streams are created with the faster `Stream\create()` function
546 * Marked deprecation_proxy() as internal
547 * Test server is now a collection of static methods on a class
549 ## 4.0.0-rc.1 - 2014-03-15
551 * See https://github.com/guzzle/guzzle/blob/master/UPGRADING.md#3x-to-40
553 ## 3.8.1 - 2014-01-28
555 * Bug: Always using GET requests when redirecting from a 303 response
556 * Bug: CURLOPT_SSL_VERIFYHOST is now correctly set to false when setting `$certificateAuthority` to false in
557 `Guzzle\Http\ClientInterface::setSslVerification()`
558 * Bug: RedirectPlugin now uses strict RFC 3986 compliance when combining a base URL with a relative URL
559 * Bug: The body of a request can now be set to `"0"`
560 * Sending PHP stream requests no longer forces `HTTP/1.0`
561 * Adding more information to ExceptionCollection exceptions so that users have more context, including a stack trace of
563 * Updated the `$ref` attribute in service descriptions to merge over any existing parameters of a schema (rather than
564 clobbering everything).
565 * Merging URLs will now use the query string object from the relative URL (thus allowing custom query aggregators)
566 * Query strings are now parsed in a way that they do no convert empty keys with no value to have a dangling `=`.
567 For example `foo&bar=baz` is now correctly parsed and recognized as `foo&bar=baz` rather than `foo=&bar=baz`.
568 * Now properly escaping the regular expression delimiter when matching Cookie domains.
569 * Network access is now disabled when loading XML documents
571 ## 3.8.0 - 2013-12-05
573 * Added the ability to define a POST name for a file
574 * JSON response parsing now properly walks additionalProperties
575 * cURL error code 18 is now retried automatically in the BackoffPlugin
576 * Fixed a cURL error when URLs contain fragments
577 * Fixed an issue in the BackoffPlugin retry event where it was trying to access all exceptions as if they were
579 * CURLOPT_PROGRESS function fix for PHP 5.5 (69fcc1e)
580 * Added the ability for Guzzle to work with older versions of cURL that do not support `CURLOPT_TIMEOUT_MS`
581 * Fixed a bug that was encountered when parsing empty header parameters
582 * UriTemplate now has a `setRegex()` method to match the docs
583 * The `debug` request parameter now checks if it is truthy rather than if it exists
584 * Setting the `debug` request parameter to true shows verbose cURL output instead of using the LogPlugin
585 * Added the ability to combine URLs using strict RFC 3986 compliance
586 * Command objects can now return the validation errors encountered by the command
587 * Various fixes to cache revalidation (#437 and 29797e5)
588 * Various fixes to the AsyncPlugin
589 * Cleaned up build scripts
591 ## 3.7.4 - 2013-10-02
593 * Bug fix: 0 is now an allowed value in a description parameter that has a default value (#430)
594 * Bug fix: SchemaFormatter now returns an integer when formatting to a Unix timestamp
595 (see https://github.com/aws/aws-sdk-php/issues/147)
596 * Bug fix: Cleaned up and fixed URL dot segment removal to properly resolve internal dots
597 * Minimum PHP version is now properly specified as 5.3.3 (up from 5.3.2) (#420)
598 * Updated the bundled cacert.pem (#419)
599 * OauthPlugin now supports adding authentication to headers or query string (#425)
601 ## 3.7.3 - 2013-09-08
603 * Added the ability to get the exception associated with a request/command when using `MultiTransferException` and
604 `CommandTransferException`.
605 * Setting `additionalParameters` of a response to false is now honored when parsing responses with a service description
606 * Schemas are only injected into response models when explicitly configured.
607 * No longer guessing Content-Type based on the path of a request. Content-Type is now only guessed based on the path of
609 * Bug fix: ChunkedIterator can now properly chunk a \Traversable as well as an \Iterator.
610 * Bug fix: FilterIterator now relies on `\Iterator` instead of `\Traversable`.
611 * Bug fix: Gracefully handling malformed responses in RequestMediator::writeResponseBody()
612 * Bug fix: Replaced call to canCache with canCacheRequest in the CallbackCanCacheStrategy of the CachePlugin
613 * Bug fix: Visiting XML attributes first before visiting XML children when serializing requests
614 * Bug fix: Properly parsing headers that contain commas contained in quotes
615 * Bug fix: mimetype guessing based on a filename is now case-insensitive
617 ## 3.7.2 - 2013-08-02
619 * Bug fix: Properly URL encoding paths when using the PHP-only version of the UriTemplate expander
620 See https://github.com/guzzle/guzzle/issues/371
621 * Bug fix: Cookie domains are now matched correctly according to RFC 6265
622 See https://github.com/guzzle/guzzle/issues/377
623 * Bug fix: GET parameters are now used when calculating an OAuth signature
624 * Bug fix: Fixed an issue with cache revalidation where the If-None-Match header was being double quoted
625 * `Guzzle\Common\AbstractHasDispatcher::dispatch()` now returns the event that was dispatched
626 * `Guzzle\Http\QueryString::factory()` now guesses the most appropriate query aggregator to used based on the input.
627 See https://github.com/guzzle/guzzle/issues/379
628 * Added a way to add custom domain objects to service description parsing using the `operation.parse_class` event. See
629 https://github.com/guzzle/guzzle/pull/380
630 * cURL multi cleanup and optimizations
632 ## 3.7.1 - 2013-07-05
634 * Bug fix: Setting default options on a client now works
635 * Bug fix: Setting options on HEAD requests now works. See #352
636 * Bug fix: Moving stream factory before send event to before building the stream. See #353
637 * Bug fix: Cookies no longer match on IP addresses per RFC 6265
638 * Bug fix: Correctly parsing header parameters that are in `<>` and quotes
639 * Added `cert` and `ssl_key` as request options
640 * `Host` header can now diverge from the host part of a URL if the header is set manually
641 * `Guzzle\Service\Command\LocationVisitor\Request\XmlVisitor` was rewritten to change from using SimpleXML to XMLWriter
642 * OAuth parameters are only added via the plugin if they aren't already set
643 * Exceptions are now thrown when a URL cannot be parsed
644 * Returning `false` if `Guzzle\Http\EntityBody::getContentMd5()` fails
645 * Not setting a `Content-MD5` on a command if calculating the Content-MD5 fails via the CommandContentMd5Plugin
647 ## 3.7.0 - 2013-06-10
649 * See UPGRADING.md for more information on how to upgrade.
650 * Requests now support the ability to specify an array of $options when creating a request to more easily modify a
651 request. You can pass a 'request.options' configuration setting to a client to apply default request options to
652 every request created by a client (e.g. default query string variables, headers, curl options, etc.).
653 * Added a static facade class that allows you to use Guzzle with static methods and mount the class to `\Guzzle`.
654 See `Guzzle\Http\StaticClient::mount`.
655 * Added `command.request_options` to `Guzzle\Service\Command\AbstractCommand` to pass request options to requests
656 created by a command (e.g. custom headers, query string variables, timeout settings, etc.).
657 * Stream size in `Guzzle\Stream\PhpStreamRequestFactory` will now be set if Content-Length is returned in the
658 headers of a response
659 * Added `Guzzle\Common\Collection::setPath($path, $value)` to set a value into an array using a nested key
660 (e.g. `$collection->setPath('foo/baz/bar', 'test'); echo $collection['foo']['bar']['bar'];`)
661 * ServiceBuilders now support storing and retrieving arbitrary data
662 * CachePlugin can now purge all resources for a given URI
663 * CachePlugin can automatically purge matching cached items when a non-idempotent request is sent to a resource
664 * CachePlugin now uses the Vary header to determine if a resource is a cache hit
665 * `Guzzle\Http\Message\Response` now implements `\Serializable`
666 * Added `Guzzle\Cache\CacheAdapterFactory::fromCache()` to more easily create cache adapters
667 * `Guzzle\Service\ClientInterface::execute()` now accepts an array, single command, or Traversable
668 * Fixed a bug in `Guzzle\Http\Message\Header\Link::addLink()`
669 * Better handling of calculating the size of a stream in `Guzzle\Stream\Stream` using fstat() and caching the size
670 * `Guzzle\Common\Exception\ExceptionCollection` now creates a more readable exception message
671 * Fixing BC break: Added back the MonologLogAdapter implementation rather than extending from PsrLog so that older
672 Symfony users can still use the old version of Monolog.
673 * Fixing BC break: Added the implementation back in for `Guzzle\Http\Message\AbstractMessage::getTokenizedHeader()`.
674 Now triggering an E_USER_DEPRECATED warning when used. Use `$message->getHeader()->parseParams()`.
675 * Several performance improvements to `Guzzle\Common\Collection`
676 * Added an `$options` argument to the end of the following methods of `Guzzle\Http\ClientInterface`:
677 createRequest, head, delete, put, patch, post, options, prepareRequest
678 * Added an `$options` argument to the end of `Guzzle\Http\Message\Request\RequestFactoryInterface::createRequest()`
679 * Added an `applyOptions()` method to `Guzzle\Http\Message\Request\RequestFactoryInterface`
680 * Changed `Guzzle\Http\ClientInterface::get($uri = null, $headers = null, $body = null)` to
681 `Guzzle\Http\ClientInterface::get($uri = null, $headers = null, $options = array())`. You can still pass in a
682 resource, string, or EntityBody into the $options parameter to specify the download location of the response.
683 * Changed `Guzzle\Common\Collection::__construct($data)` to no longer accepts a null value for `$data` but a
685 * Added `Guzzle\Stream\StreamInterface::isRepeatable`
686 * Removed `Guzzle\Http\ClientInterface::setDefaultHeaders(). Use
687 $client->getConfig()->setPath('request.options/headers/{header_name}', 'value')`. or
688 $client->getConfig()->setPath('request.options/headers', array('header_name' => 'value'))`.
689 * Removed `Guzzle\Http\ClientInterface::getDefaultHeaders(). Use $client->getConfig()->getPath('request.options/headers')`.
690 * Removed `Guzzle\Http\ClientInterface::expandTemplate()`
691 * Removed `Guzzle\Http\ClientInterface::setRequestFactory()`
692 * Removed `Guzzle\Http\ClientInterface::getCurlMulti()`
693 * Removed `Guzzle\Http\Message\RequestInterface::canCache`
694 * Removed `Guzzle\Http\Message\RequestInterface::setIsRedirect`
695 * Removed `Guzzle\Http\Message\RequestInterface::isRedirect`
696 * Made `Guzzle\Http\Client::expandTemplate` and `getUriTemplate` protected methods.
697 * You can now enable E_USER_DEPRECATED warnings to see if you are using a deprecated method by setting
698 `Guzzle\Common\Version::$emitWarnings` to true.
699 * Marked `Guzzle\Http\Message\Request::isResponseBodyRepeatable()` as deprecated. Use
700 `$request->getResponseBody()->isRepeatable()` instead.
701 * Marked `Guzzle\Http\Message\Request::canCache()` as deprecated. Use
702 `Guzzle\Plugin\Cache\DefaultCanCacheStrategy->canCacheRequest()` instead.
703 * Marked `Guzzle\Http\Message\Request::canCache()` as deprecated. Use
704 `Guzzle\Plugin\Cache\DefaultCanCacheStrategy->canCacheRequest()` instead.
705 * Marked `Guzzle\Http\Message\Request::setIsRedirect()` as deprecated. Use the HistoryPlugin instead.
706 * Marked `Guzzle\Http\Message\Request::isRedirect()` as deprecated. Use the HistoryPlugin instead.
707 * Marked `Guzzle\Cache\CacheAdapterFactory::factory()` as deprecated
708 * Marked 'command.headers', 'command.response_body' and 'command.on_complete' as deprecated for AbstractCommand.
709 These will work through Guzzle 4.0
710 * Marked 'request.params' for `Guzzle\Http\Client` as deprecated. Use [request.options][params].
711 * Marked `Guzzle\Service\Client::enableMagicMethods()` as deprecated. Magic methods can no longer be disabled on a Guzzle\Service\Client.
712 * Marked `Guzzle\Service\Client::getDefaultHeaders()` as deprecated. Use $client->getConfig()->getPath('request.options/headers')`.
713 * Marked `Guzzle\Service\Client::setDefaultHeaders()` as deprecated. Use $client->getConfig()->setPath('request.options/headers/{header_name}', 'value')`.
714 * Marked `Guzzle\Parser\Url\UrlParser` as deprecated. Just use PHP's `parse_url()` and percent encode your UTF-8.
715 * Marked `Guzzle\Common\Collection::inject()` as deprecated.
716 * Marked `Guzzle\Plugin\CurlAuth\CurlAuthPlugin` as deprecated. Use `$client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest');`
717 * CacheKeyProviderInterface and DefaultCacheKeyProvider are no longer used. All of this logic is handled in a
718 CacheStorageInterface. These two objects and interface will be removed in a future version.
719 * Always setting X-cache headers on cached responses
720 * Default cache TTLs are now handled by the CacheStorageInterface of a CachePlugin
721 * `CacheStorageInterface::cache($key, Response $response, $ttl = null)` has changed to `cache(RequestInterface
722 $request, Response $response);`
723 * `CacheStorageInterface::fetch($key)` has changed to `fetch(RequestInterface $request);`
724 * `CacheStorageInterface::delete($key)` has changed to `delete(RequestInterface $request);`
725 * Added `CacheStorageInterface::purge($url)`
726 * `DefaultRevalidation::__construct(CacheKeyProviderInterface $cacheKey, CacheStorageInterface $cache, CachePlugin
727 $plugin)` has changed to `DefaultRevalidation::__construct(CacheStorageInterface $cache,
728 CanCacheStrategyInterface $canCache = null)`
729 * Added `RevalidationInterface::shouldRevalidate(RequestInterface $request, Response $response)`
731 ## 3.6.0 - 2013-05-29
733 * ServiceDescription now implements ToArrayInterface
734 * Added command.hidden_params to blacklist certain headers from being treated as additionalParameters
735 * Guzzle can now correctly parse incomplete URLs
736 * Mixed casing of headers are now forced to be a single consistent casing across all values for that header.
737 * Messages internally use a HeaderCollection object to delegate handling case-insensitive header resolution
738 * Removed the whole changedHeader() function system of messages because all header changes now go through addHeader().
739 * Specific header implementations can be created for complex headers. When a message creates a header, it uses a
740 HeaderFactory which can map specific headers to specific header classes. There is now a Link header and
741 CacheControl header implementation.
742 * Removed from interface: Guzzle\Http\ClientInterface::setUriTemplate
743 * Removed from interface: Guzzle\Http\ClientInterface::setCurlMulti()
744 * Removed Guzzle\Http\Message\Request::receivedRequestHeader() and implemented this functionality in
745 Guzzle\Http\Curl\RequestMediator
746 * Removed the optional $asString parameter from MessageInterface::getHeader(). Just cast the header to a string.
747 * Removed the optional $tryChunkedTransfer option from Guzzle\Http\Message\EntityEnclosingRequestInterface
748 * Removed the $asObjects argument from Guzzle\Http\Message\MessageInterface::getHeaders()
749 * Removed Guzzle\Parser\ParserRegister::get(). Use getParser()
750 * Removed Guzzle\Parser\ParserRegister::set(). Use registerParser().
751 * All response header helper functions return a string rather than mixing Header objects and strings inconsistently
752 * Removed cURL blacklist support. This is no longer necessary now that Expect, Accept, etc. are managed by Guzzle
753 directly via interfaces
754 * Removed the injecting of a request object onto a response object. The methods to get and set a request still exist
755 but are a no-op until removed.
756 * Most classes that used to require a `Guzzle\Service\Command\CommandInterface` typehint now request a
757 `Guzzle\Service\Command\ArrayCommandInterface`.
758 * Added `Guzzle\Http\Message\RequestInterface::startResponse()` to the RequestInterface to handle injecting a response
759 on a request while the request is still being transferred
760 * The ability to case-insensitively search for header values
761 * Guzzle\Http\Message\Header::hasExactHeader
762 * Guzzle\Http\Message\Header::raw. Use getAll()
763 * Deprecated cache control specific methods on Guzzle\Http\Message\AbstractMessage. Use the CacheControl header object
765 * `Guzzle\Service\Command\CommandInterface` now extends from ToArrayInterface and ArrayAccess
766 * Added the ability to cast Model objects to a string to view debug information.
768 ## 3.5.0 - 2013-05-13
770 * Bug: Fixed a regression so that request responses are parsed only once per oncomplete event rather than multiple times
771 * Bug: Better cleanup of one-time events across the board (when an event is meant to fire once, it will now remove
772 itself from the EventDispatcher)
773 * Bug: `Guzzle\Log\MessageFormatter` now properly writes "total_time" and "connect_time" values
774 * Bug: Cloning an EntityEnclosingRequest now clones the EntityBody too
775 * Bug: Fixed an undefined index error when parsing nested JSON responses with a sentAs parameter that reference a
777 * Bug: All __call() method arguments are now required (helps with mocking frameworks)
778 * Deprecating Response::getRequest() and now using a shallow clone of a request object to remove a circular reference
779 to help with refcount based garbage collection of resources created by sending a request
780 * Deprecating ZF1 cache and log adapters. These will be removed in the next major version.
781 * Deprecating `Response::getPreviousResponse()` (method signature still exists, but it's deprecated). Use the
782 HistoryPlugin for a history.
783 * Added a `responseBody` alias for the `response_body` location
784 * Refactored internals to no longer rely on Response::getRequest()
785 * HistoryPlugin can now be cast to a string
786 * HistoryPlugin now logs transactions rather than requests and responses to more accurately keep track of the requests
787 and responses that are sent over the wire
788 * Added `getEffectiveUrl()` and `getRedirectCount()` to Response objects
790 ## 3.4.3 - 2013-04-30
792 * Bug fix: Fixing bug introduced in 3.4.2 where redirect responses are duplicated on the final redirected response
793 * Added a check to re-extract the temp cacert bundle from the phar before sending each request
795 ## 3.4.2 - 2013-04-29
797 * Bug fix: Stream objects now work correctly with "a" and "a+" modes
798 * Bug fix: Removing `Transfer-Encoding: chunked` header when a Content-Length is present
799 * Bug fix: AsyncPlugin no longer forces HEAD requests
800 * Bug fix: DateTime timezones are now properly handled when using the service description schema formatter
801 * Bug fix: CachePlugin now properly handles stale-if-error directives when a request to the origin server fails
802 * Setting a response on a request will write to the custom request body from the response body if one is specified
803 * LogPlugin now writes to php://output when STDERR is undefined
804 * Added the ability to set multiple POST files for the same key in a single call
805 * application/x-www-form-urlencoded POSTs now use the utf-8 charset by default
806 * Added the ability to queue CurlExceptions to the MockPlugin
807 * Cleaned up how manual responses are queued on requests (removed "queued_response" and now using request.before_send)
808 * Configuration loading now allows remote files
810 ## 3.4.1 - 2013-04-16
812 * Large refactoring to how CurlMulti handles work. There is now a proxy that sits in front of a pool of CurlMulti
813 handles. This greatly simplifies the implementation, fixes a couple bugs, and provides a small performance boost.
814 * Exceptions are now properly grouped when sending requests in parallel
815 * Redirects are now properly aggregated when a multi transaction fails
816 * Redirects now set the response on the original object even in the event of a failure
817 * Bug fix: Model names are now properly set even when using $refs
818 * Added support for PHP 5.5's CurlFile to prevent warnings with the deprecated @ syntax
819 * Added support for oauth_callback in OAuth signatures
820 * Added support for oauth_verifier in OAuth signatures
821 * Added support to attempt to retrieve a command first literally, then ucfirst, the with inflection
823 ## 3.4.0 - 2013-04-11
825 * Bug fix: URLs are now resolved correctly based on http://tools.ietf.org/html/rfc3986#section-5.2. #289
826 * Bug fix: Absolute URLs with a path in a service description will now properly override the base URL. #289
827 * Bug fix: Parsing a query string with a single PHP array value will now result in an array. #263
828 * Bug fix: Better normalization of the User-Agent header to prevent duplicate headers. #264.
829 * Bug fix: Added `number` type to service descriptions.
830 * Bug fix: empty parameters are removed from an OAuth signature
831 * Bug fix: Revalidating a cache entry prefers the Last-Modified over the Date header
832 * Bug fix: Fixed "array to string" error when validating a union of types in a service description
833 * Bug fix: Removed code that attempted to determine the size of a stream when data is written to the stream
834 * Bug fix: Not including an `oauth_token` if the value is null in the OauthPlugin.
835 * Bug fix: Now correctly aggregating successful requests and failed requests in CurlMulti when a redirect occurs.
836 * The new default CURLOPT_TIMEOUT setting has been increased to 150 seconds so that Guzzle works on poor connections.
837 * Added a feature to EntityEnclosingRequest::setBody() that will automatically set the Content-Type of the request if
838 the Content-Type can be determined based on the entity body or the path of the request.
839 * Added the ability to overwrite configuration settings in a client when grabbing a throwaway client from a builder.
840 * Added support for a PSR-3 LogAdapter.
841 * Added a `command.after_prepare` event
842 * Added `oauth_callback` parameter to the OauthPlugin
843 * Added the ability to create a custom stream class when using a stream factory
844 * Added a CachingEntityBody decorator
845 * Added support for `additionalParameters` in service descriptions to define how custom parameters are serialized.
846 * The bundled SSL certificate is now provided in the phar file and extracted when running Guzzle from a phar.
847 * You can now send any EntityEnclosingRequest with POST fields or POST files and cURL will handle creating bodies
848 * POST requests using a custom entity body are now treated exactly like PUT requests but with a custom cURL method. This
849 means that the redirect behavior of POST requests with custom bodies will not be the same as POST requests that use
850 POST fields or files (the latter is only used when emulating a form POST in the browser).
851 * Lots of cleanup to CurlHandle::factory and RequestFactory::createRequest
853 ## 3.3.1 - 2013-03-10
855 * Added the ability to create PHP streaming responses from HTTP requests
856 * Bug fix: Running any filters when parsing response headers with service descriptions
857 * Bug fix: OauthPlugin fixes to allow for multi-dimensional array signing, and sorting parameters before signing
858 * Bug fix: Removed the adding of default empty arrays and false Booleans to responses in order to be consistent across
859 response location visitors.
860 * Bug fix: Removed the possibility of creating configuration files with circular dependencies
861 * RequestFactory::create() now uses the key of a POST file when setting the POST file name
862 * Added xmlAllowEmpty to serialize an XML body even if no XML specific parameters are set
864 ## 3.3.0 - 2013-03-03
866 * A large number of performance optimizations have been made
867 * Bug fix: Added 'wb' as a valid write mode for streams
868 * Bug fix: `Guzzle\Http\Message\Response::json()` now allows scalar values to be returned
869 * Bug fix: Fixed bug in `Guzzle\Http\Message\Response` where wrapping quotes were stripped from `getEtag()`
870 * BC: Removed `Guzzle\Http\Utils` class
871 * BC: Setting a service description on a client will no longer modify the client's command factories.
872 * BC: Emitting IO events from a RequestMediator is now a parameter that must be set in a request's curl options using
873 the 'emit_io' key. This was previously set under a request's parameters using 'curl.emit_io'
874 * BC: `Guzzle\Stream\Stream::getWrapper()` and `Guzzle\Stream\Stream::getSteamType()` are no longer converted to
876 * Operation parameter objects are now lazy loaded internally
877 * Added ErrorResponsePlugin that can throw errors for responses defined in service description operations' errorResponses
878 * Added support for instantiating responseType=class responseClass classes. Classes must implement
879 `Guzzle\Service\Command\ResponseClassInterface`
880 * Added support for additionalProperties for top-level parameters in responseType=model responseClasses. These
881 additional properties also support locations and can be used to parse JSON responses where the outermost part of the
883 * Added support for nested renaming of JSON models (rename sentAs to name)
885 * Added support for stale-if-error so that the CachePlugin can now serve stale content from the cache on error
886 * Debug headers can now added to cached response in the CachePlugin
888 ## 3.2.0 - 2013-02-14
890 * CurlMulti is no longer reused globally. A new multi object is created per-client. This helps to isolate clients.
891 * URLs with no path no longer contain a "/" by default
892 * Guzzle\Http\QueryString does no longer manages the leading "?". This is now handled in Guzzle\Http\Url.
893 * BadResponseException no longer includes the full request and response message
894 * Adding setData() to Guzzle\Service\Description\ServiceDescriptionInterface
895 * Adding getResponseBody() to Guzzle\Http\Message\RequestInterface
896 * Various updates to classes to use ServiceDescriptionInterface type hints rather than ServiceDescription
897 * Header values can now be normalized into distinct values when multiple headers are combined with a comma separated list
898 * xmlEncoding can now be customized for the XML declaration of a XML service description operation
899 * Guzzle\Http\QueryString now uses Guzzle\Http\QueryAggregator\QueryAggregatorInterface objects to add custom value
900 aggregation and no longer uses callbacks
901 * The URL encoding implementation of Guzzle\Http\QueryString can now be customized
902 * Bug fix: Filters were not always invoked for array service description parameters
903 * Bug fix: Redirects now use a target response body rather than a temporary response body
904 * Bug fix: The default exponential backoff BackoffPlugin was not giving when the request threshold was exceeded
905 * Bug fix: Guzzle now takes the first found value when grabbing Cache-Control directives
907 ## 3.1.2 - 2013-01-27
909 * Refactored how operation responses are parsed. Visitors now include a before() method responsible for parsing the
910 response body. For example, the XmlVisitor now parses the XML response into an array in the before() method.
911 * Fixed an issue where cURL would not automatically decompress responses when the Accept-Encoding header was sent
912 * CURLOPT_SSL_VERIFYHOST is never set to 1 because it is deprecated (see 5e0ff2ef20f839e19d1eeb298f90ba3598784444)
913 * Fixed a bug where redirect responses were not chained correctly using getPreviousResponse()
914 * Setting default headers on a client after setting the user-agent will not erase the user-agent setting
916 ## 3.1.1 - 2013-01-20
918 * Adding wildcard support to Guzzle\Common\Collection::getPath()
919 * Adding alias support to ServiceBuilder configs
920 * Adding Guzzle\Service\Resource\CompositeResourceIteratorFactory and cleaning up factory interface
922 ## 3.1.0 - 2013-01-12
924 * BC: CurlException now extends from RequestException rather than BadResponseException
925 * BC: Renamed Guzzle\Plugin\Cache\CanCacheStrategyInterface::canCache() to canCacheRequest() and added CanCacheResponse()
926 * Added getData to ServiceDescriptionInterface
927 * Added context array to RequestInterface::setState()
928 * Bug: Removing hard dependency on the BackoffPlugin from Guzzle\Http
929 * Bug: Adding required content-type when JSON request visitor adds JSON to a command
930 * Bug: Fixing the serialization of a service description with custom data
931 * Made it easier to deal with exceptions thrown when transferring commands or requests in parallel by providing
932 an array of successful and failed responses
933 * Moved getPath from Guzzle\Service\Resource\Model to Guzzle\Common\Collection
934 * Added Guzzle\Http\IoEmittingEntityBody
935 * Moved command filtration from validators to location visitors
936 * Added `extends` attributes to service description parameters
937 * Added getModels to ServiceDescriptionInterface
939 ## 3.0.7 - 2012-12-19
941 * Fixing phar detection when forcing a cacert to system if null or true
942 * Allowing filename to be passed to `Guzzle\Http\Message\Request::setResponseBody()`
943 * Cleaning up `Guzzle\Common\Collection::inject` method
944 * Adding a response_body location to service descriptions
946 ## 3.0.6 - 2012-12-09
948 * CurlMulti performance improvements
949 * Adding setErrorResponses() to Operation
950 * composer.json tweaks
952 ## 3.0.5 - 2012-11-18
954 * Bug: Fixing an infinite recursion bug caused from revalidating with the CachePlugin
955 * Bug: Response body can now be a string containing "0"
956 * Bug: Using Guzzle inside of a phar uses system by default but now allows for a custom cacert
957 * Bug: QueryString::fromString now properly parses query string parameters that contain equal signs
958 * Added support for XML attributes in service description responses
959 * DefaultRequestSerializer now supports array URI parameter values for URI template expansion
960 * Added better mimetype guessing to requests and post files
962 ## 3.0.4 - 2012-11-11
964 * Bug: Fixed a bug when adding multiple cookies to a request to use the correct glue value
965 * Bug: Cookies can now be added that have a name, domain, or value set to "0"
966 * Bug: Using the system cacert bundle when using the Phar
967 * Added json and xml methods to Response to make it easier to parse JSON and XML response data into data structures
968 * Enhanced cookie jar de-duplication
969 * Added the ability to enable strict cookie jars that throw exceptions when invalid cookies are added
970 * Added setStream to StreamInterface to actually make it possible to implement custom rewind behavior for entity bodies
971 * Added the ability to create any sort of hash for a stream rather than just an MD5 hash
973 ## 3.0.3 - 2012-11-04
975 * Implementing redirects in PHP rather than cURL
976 * Added PECL URI template extension and using as default parser if available
977 * Bug: Fixed Content-Length parsing of Response factory
978 * Adding rewind() method to entity bodies and streams. Allows for custom rewinding of non-repeatable streams.
979 * Adding ToArrayInterface throughout library
980 * Fixing OauthPlugin to create unique nonce values per request
982 ## 3.0.2 - 2012-10-25
984 * Magic methods are enabled by default on clients
985 * Magic methods return the result of a command
986 * Service clients no longer require a base_url option in the factory
987 * Bug: Fixed an issue with URI templates where null template variables were being expanded
989 ## 3.0.1 - 2012-10-22
991 * Models can now be used like regular collection objects by calling filter, map, etc.
992 * Models no longer require a Parameter structure or initial data in the constructor
993 * Added a custom AppendIterator to get around a PHP bug with the `\AppendIterator`
995 ## 3.0.0 - 2012-10-15
997 * Rewrote service description format to be based on Swagger
998 * Now based on JSON schema
999 * Added nested input structures and nested response models
1000 * Support for JSON and XML input and output models
1001 * Renamed `commands` to `operations`
1002 * Removed dot class notation
1003 * Removed custom types
1004 * Broke the project into smaller top-level namespaces to be more component friendly
1005 * Removed support for XML configs and descriptions. Use arrays or JSON files.
1006 * Removed the Validation component and Inspector
1007 * Moved all cookie code to Guzzle\Plugin\Cookie
1008 * Magic methods on a Guzzle\Service\Client now return the command un-executed.
1009 * Calling getResult() or getResponse() on a command will lazily execute the command if needed.
1010 * Now shipping with cURL's CA certs and using it by default
1011 * Added previousResponse() method to response objects
1012 * No longer sending Accept and Accept-Encoding headers on every request
1013 * Only sending an Expect header by default when a payload is greater than 1MB
1014 * Added/moved client options:
1015 * curl.blacklist to curl.option.blacklist
1016 * Added ssl.certificate_authority
1017 * Added a Guzzle\Iterator component
1018 * Moved plugins from Guzzle\Http\Plugin to Guzzle\Plugin
1019 * Added a more robust backoff retry strategy (replaced the ExponentialBackoffPlugin)
1020 * Added a more robust caching plugin
1021 * Added setBody to response objects
1022 * Updating LogPlugin to use a more flexible MessageFormatter
1023 * Added a completely revamped build process
1024 * Cleaning up Collection class and removing default values from the get method
1025 * Fixed ZF2 cache adapters
1027 ## 2.8.8 - 2012-10-15
1029 * Bug: Fixed a cookie issue that caused dot prefixed domains to not match where popular browsers did
1031 ## 2.8.7 - 2012-09-30
1033 * Bug: Fixed config file aliases for JSON includes
1034 * Bug: Fixed cookie bug on a request object by using CookieParser to parse cookies on requests
1035 * Bug: Removing the path to a file when sending a Content-Disposition header on a POST upload
1036 * Bug: Hardening request and response parsing to account for missing parts
1037 * Bug: Fixed PEAR packaging
1038 * Bug: Fixed Request::getInfo
1039 * Bug: Fixed cases where CURLM_CALL_MULTI_PERFORM return codes were causing curl transactions to fail
1040 * Adding the ability for the namespace Iterator factory to look in multiple directories
1041 * Added more getters/setters/removers from service descriptions
1042 * Added the ability to remove POST fields from OAuth signatures
1043 * OAuth plugin now supports 2-legged OAuth
1045 ## 2.8.6 - 2012-09-05
1047 * Added the ability to modify and build service descriptions
1048 * Added the use of visitors to apply parameters to locations in service descriptions using the dynamic command
1049 * Added a `json` parameter location
1050 * Now allowing dot notation for classes in the CacheAdapterFactory
1051 * Using the union of two arrays rather than an array_merge when extending service builder services and service params
1052 * Ensuring that a service is a string before doing strpos() checks on it when substituting services for references
1053 in service builder config files.
1054 * Services defined in two different config files that include one another will by default replace the previously
1055 defined service, but you can now create services that extend themselves and merge their settings over the previous
1056 * The JsonLoader now supports aliasing filenames with different filenames. This allows you to alias something like
1057 '_default' with a default JSON configuration file.
1059 ## 2.8.5 - 2012-08-29
1061 * Bug: Suppressed empty arrays from URI templates
1062 * Bug: Added the missing $options argument from ServiceDescription::factory to enable caching
1063 * Added support for HTTP responses that do not contain a reason phrase in the start-line
1064 * AbstractCommand commands are now invokable
1065 * Added a way to get the data used when signing an Oauth request before a request is sent
1067 ## 2.8.4 - 2012-08-15
1069 * Bug: Custom delay time calculations are no longer ignored in the ExponentialBackoffPlugin
1070 * Added the ability to transfer entity bodies as a string rather than streamed. This gets around curl error 65. Set `body_as_string` in a request's curl options to enable.
1071 * Added a StreamInterface, EntityBodyInterface, and added ftell() to Guzzle\Common\Stream
1072 * Added an AbstractEntityBodyDecorator and a ReadLimitEntityBody decorator to transfer only a subset of a decorated stream
1073 * Stream and EntityBody objects will now return the file position to the previous position after a read required operation (e.g. getContentMd5())
1074 * Added additional response status codes
1075 * Removed SSL information from the default User-Agent header
1076 * DELETE requests can now send an entity body
1077 * Added an EventDispatcher to the ExponentialBackoffPlugin and added an ExponentialBackoffLogger to log backoff retries
1078 * Added the ability of the MockPlugin to consume mocked request bodies
1079 * LogPlugin now exposes request and response objects in the extras array
1081 ## 2.8.3 - 2012-07-30
1083 * Bug: Fixed a case where empty POST requests were sent as GET requests
1084 * Bug: Fixed a bug in ExponentialBackoffPlugin that caused fatal errors when retrying an EntityEnclosingRequest that does not have a body
1085 * Bug: Setting the response body of a request to null after completing a request, not when setting the state of a request to new
1086 * Added multiple inheritance to service description commands
1087 * Added an ApiCommandInterface and added `getParamNames()` and `hasParam()`
1088 * Removed the default 2mb size cutoff from the Md5ValidatorPlugin so that it now defaults to validating everything
1089 * Changed CurlMulti::perform to pass a smaller timeout to CurlMulti::executeHandles
1091 ## 2.8.2 - 2012-07-24
1093 * Bug: Query string values set to 0 are no longer dropped from the query string
1094 * Bug: A Collection object is no longer created each time a call is made to `Guzzle\Service\Command\AbstractCommand::getRequestHeaders()`
1095 * Bug: `+` is now treated as an encoded space when parsing query strings
1096 * QueryString and Collection performance improvements
1097 * Allowing dot notation for class paths in filters attribute of a service descriptions
1099 ## 2.8.1 - 2012-07-16
1101 * Loosening Event Dispatcher dependency
1102 * POST redirects can now be customized using CURLOPT_POSTREDIR
1104 ## 2.8.0 - 2012-07-15
1106 * BC: Guzzle\Http\Query
1107 * Query strings with empty variables will always show an equal sign unless the variable is set to QueryString::BLANK (e.g. ?acl= vs ?acl)
1108 * Changed isEncodingValues() and isEncodingFields() to isUrlEncoding()
1109 * Changed setEncodeValues(bool) and setEncodeFields(bool) to useUrlEncoding(bool)
1110 * Changed the aggregation functions of QueryString to be static methods
1111 * Can now use fromString() with querystrings that have a leading ?
1112 * cURL configuration values can be specified in service descriptions using `curl.` prefixed parameters
1113 * Content-Length is set to 0 before emitting the request.before_send event when sending an empty request body
1114 * Cookies are no longer URL decoded by default
1115 * Bug: URI template variables set to null are no longer expanded
1117 ## 2.7.2 - 2012-07-02
1119 * BC: Moving things to get ready for subtree splits. Moving Inflection into Common. Moving Guzzle\Http\Parser to Guzzle\Parser.
1120 * BC: Removing Guzzle\Common\Batch\Batch::count() and replacing it with isEmpty()
1121 * CachePlugin now allows for a custom request parameter function to check if a request can be cached
1122 * Bug fix: CachePlugin now only caches GET and HEAD requests by default
1123 * Bug fix: Using header glue when transferring headers over the wire
1124 * Allowing deeply nested arrays for composite variables in URI templates
1125 * Batch divisors can now return iterators or arrays
1127 ## 2.7.1 - 2012-06-26
1129 * Minor patch to update version number in UA string
1130 * Updating build process
1132 ## 2.7.0 - 2012-06-25
1134 * BC: Inflection classes moved to Guzzle\Inflection. No longer static methods. Can now inject custom inflectors into classes.
1135 * BC: Removed magic setX methods from commands
1136 * BC: Magic methods mapped to service description commands are now inflected in the command factory rather than the client __call() method
1137 * Verbose cURL options are no longer enabled by default. Set curl.debug to true on a client to enable.
1138 * Bug: Now allowing colons in a response start-line (e.g. HTTP/1.1 503 Service Unavailable: Back-end server is at capacity)
1139 * Guzzle\Service\Resource\ResourceIteratorApplyBatched now internally uses the Guzzle\Common\Batch namespace
1140 * Added Guzzle\Service\Plugin namespace and a PluginCollectionPlugin
1141 * Added the ability to set POST fields and files in a service description
1142 * Guzzle\Http\EntityBody::factory() now accepts objects with a __toString() method
1143 * Adding a command.before_prepare event to clients
1144 * Added BatchClosureTransfer and BatchClosureDivisor
1145 * BatchTransferException now includes references to the batch divisor and transfer strategies
1146 * Fixed some tests so that they pass more reliably
1147 * Added Guzzle\Common\Log\ArrayLogAdapter
1149 ## 2.6.6 - 2012-06-10
1151 * BC: Removing Guzzle\Http\Plugin\BatchQueuePlugin
1152 * BC: Removing Guzzle\Service\Command\CommandSet
1153 * Adding generic batching system (replaces the batch queue plugin and command set)
1154 * Updating ZF cache and log adapters and now using ZF's composer repository
1155 * Bug: Setting the name of each ApiParam when creating through an ApiCommand
1156 * Adding result_type, result_doc, deprecated, and doc_url to service descriptions
1157 * Bug: Changed the default cookie header casing back to 'Cookie'
1159 ## 2.6.5 - 2012-06-03
1161 * BC: Renaming Guzzle\Http\Message\RequestInterface::getResourceUri() to getResource()
1162 * BC: Removing unused AUTH_BASIC and AUTH_DIGEST constants from
1163 * BC: Guzzle\Http\Cookie is now used to manage Set-Cookie data, not Cookie data
1164 * BC: Renaming methods in the CookieJarInterface
1165 * Moving almost all cookie logic out of the CookiePlugin and into the Cookie or CookieJar implementations
1166 * Making the default glue for HTTP headers ';' instead of ','
1167 * Adding a removeValue to Guzzle\Http\Message\Header
1168 * Adding getCookies() to request interface.
1169 * Making it easier to add event subscribers to HasDispatcherInterface classes. Can now directly call addSubscriber()
1171 ## 2.6.4 - 2012-05-30
1173 * BC: Cleaning up how POST files are stored in EntityEnclosingRequest objects. Adding PostFile class.
1174 * BC: Moving ApiCommand specific functionality from the Inspector and on to the ApiCommand
1175 * Bug: Fixing magic method command calls on clients
1176 * Bug: Email constraint only validates strings
1177 * Bug: Aggregate POST fields when POST files are present in curl handle
1178 * Bug: Fixing default User-Agent header
1179 * Bug: Only appending or prepending parameters in commands if they are specified
1180 * Bug: Not requiring response reason phrases or status codes to match a predefined list of codes
1181 * Allowing the use of dot notation for class namespaces when using instance_of constraint
1182 * Added any_match validation constraint
1183 * Added an AsyncPlugin
1184 * Passing request object to the calculateWait method of the ExponentialBackoffPlugin
1185 * Allowing the result of a command object to be changed
1186 * Parsing location and type sub values when instantiating a service description rather than over and over at runtime
1188 ## 2.6.3 - 2012-05-23
1190 * [BC] Guzzle\Common\FromConfigInterface no longer requires any config options.
1191 * [BC] Refactoring how POST files are stored on an EntityEnclosingRequest. They are now separate from POST fields.
1192 * You can now use an array of data when creating PUT request bodies in the request factory.
1193 * Removing the requirement that HTTPS requests needed a Cache-Control: public directive to be cacheable.
1194 * [Http] Adding support for Content-Type in multipart POST uploads per upload
1195 * [Http] Added support for uploading multiple files using the same name (foo[0], foo[1])
1196 * Adding more POST data operations for easier manipulation of POST data.
1197 * You can now set empty POST fields.
1198 * The body of a request is only shown on EntityEnclosingRequest objects that do not use POST files.
1199 * Split the Guzzle\Service\Inspector::validateConfig method into two methods. One to initialize when a command is created, and one to validate.
1202 ## 2.6.2 - 2012-05-19
1204 * [Http] Better handling of nested scope requests in CurlMulti. Requests are now always prepares in the send() method rather than the addRequest() method.
1206 ## 2.6.1 - 2012-05-19
1208 * [BC] Removing 'path' support in service descriptions. Use 'uri'.
1209 * [BC] Guzzle\Service\Inspector::parseDocBlock is now protected. Adding getApiParamsForClass() with cache.
1210 * [BC] Removing Guzzle\Common\NullObject. Use https://github.com/mtdowling/NullObject if you need it.
1211 * [BC] Removing Guzzle\Common\XmlElement.
1212 * All commands, both dynamic and concrete, have ApiCommand objects.
1213 * Adding a fix for CurlMulti so that if all of the connections encounter some sort of curl error, then the loop exits.
1214 * Adding checks to EntityEnclosingRequest so that empty POST files and fields are ignored.
1215 * Making the method signature of Guzzle\Service\Builder\ServiceBuilder::factory more flexible.
1217 ## 2.6.0 - 2012-05-15
1219 * [BC] Moving Guzzle\Service\Builder to Guzzle\Service\Builder\ServiceBuilder
1220 * [BC] Executing a Command returns the result of the command rather than the command
1221 * [BC] Moving all HTTP parsing logic to Guzzle\Http\Parsers. Allows for faster C implementations if needed.
1222 * [BC] Changing the Guzzle\Http\Message\Response::setProtocol() method to accept a protocol and version in separate args.
1223 * [BC] Moving ResourceIterator* to Guzzle\Service\Resource
1224 * [BC] Completely refactored ResourceIterators to iterate over a cloned command object
1225 * [BC] Moved Guzzle\Http\UriTemplate to Guzzle\Http\Parser\UriTemplate\UriTemplate
1226 * [BC] Guzzle\Guzzle is now deprecated
1227 * Moving Guzzle\Common\Guzzle::inject to Guzzle\Common\Collection::inject
1228 * Adding Guzzle\Version class to give version information about Guzzle
1229 * Adding Guzzle\Http\Utils class to provide getDefaultUserAgent() and getHttpDate()
1230 * Adding Guzzle\Curl\CurlVersion to manage caching curl_version() data
1231 * ServiceDescription and ServiceBuilder are now cacheable using similar configs
1232 * Changing the format of XML and JSON service builder configs. Backwards compatible.
1233 * Cleaned up Cookie parsing
1234 * Trimming the default Guzzle User-Agent header
1235 * Adding a setOnComplete() method to Commands that is called when a command completes
1236 * Keeping track of requests that were mocked in the MockPlugin
1237 * Fixed a caching bug in the CacheAdapterFactory
1238 * Inspector objects can be injected into a Command object
1239 * Refactoring a lot of code and tests to be case insensitive when dealing with headers
1240 * Adding Guzzle\Http\Message\HeaderComparison for easy comparison of HTTP headers using a DSL
1241 * Adding the ability to set global option overrides to service builder configs
1242 * Adding the ability to include other service builder config files from within XML and JSON files
1243 * Moving the parseQuery method out of Url and on to QueryString::fromString() as a static factory method.
1245 ## 2.5.0 - 2012-05-08
1247 * Major performance improvements
1248 * [BC] Simplifying Guzzle\Common\Collection. Please check to see if you are using features that are now deprecated.
1249 * [BC] Using a custom validation system that allows a flyweight implementation for much faster validation. No longer using Symfony2 Validation component.
1250 * [BC] No longer supporting "{{ }}" for injecting into command or UriTemplates. Use "{}"
1251 * Added the ability to passed parameters to all requests created by a client
1252 * Added callback functionality to the ExponentialBackoffPlugin
1253 * Using microtime in ExponentialBackoffPlugin to allow more granular backoff strategies.
1254 * Rewinding request stream bodies when retrying requests
1255 * Exception is thrown when JSON response body cannot be decoded
1256 * Added configurable magic method calls to clients and commands. This is off by default.
1257 * Fixed a defect that added a hash to every parsed URL part
1258 * Fixed duplicate none generation for OauthPlugin.
1259 * Emitting an event each time a client is generated by a ServiceBuilder
1260 * Using an ApiParams object instead of a Collection for parameters of an ApiCommand
1261 * cache.* request parameters should be renamed to params.cache.*
1262 * Added the ability to set arbitrary curl options on requests (disable_wire, progress, etc.). See CurlHandle.
1263 * Added the ability to disable type validation of service descriptions
1264 * ServiceDescriptions and ServiceBuilders are now Serializable