sprockets.mixins.http/docs/history.rst
2022-03-07 18:04:25 -05:00

158 lines
6.4 KiB
ReStructuredText

Version History
===============
`2.6.0`_ Mar 07 2022
--------------------
- Add support for ``Content-Type`` suffixes (ex. ``a/b+json``, ``x/y+msgpack``)
- Fix exception when ``self.correlation_id`` is ``None``
`2.5.0`_ Sep 16 2021
--------------------
- Change ``HTTPResponse.links`` to return empty list when ``Link`` header is not present
- Move ``X-Retry-Attempt`` header insertion into
:meth:`~sprockets.mixins.http.HTTPClientMixin._http_req_modify_for_retry`
hook. This is also needed for using the client with OAuth 1 servers.
`2.4.1`_ Nov 30 2020
--------------------
- Make request retry timeout configurable
- Apply retry sleeping to all retried attempts
- Use an exponential backoff if ``Retry-After`` header is absent
- Add ``retry_timeout`` parameter to
:meth:`~sprockets.mixins.http.HTTPClientMixin.http_fetch`
`2.4.0`_ Nov 3 2020
-------------------
- Fix serialization of empty request bodies.
- Rate limit 503s as well as 423s and 429s.
- Advertise & test support for Python 3.8 and 3.9.
`2.3.3`_ Apr 8 2020
-------------------
- Pass keyword parameters through to the underlying HTTPClient fetch method.
This enables niceties like streaming callback support
`2.3.1`_ Apr 7, 2020
--------------------
- Address `#27`_ by using the shortest appropriate timeout
.. _#27: https://github.com/sprockets/sprockets.mixins.http/issues/27
`2.3.0`_ Dec 9, 2019
--------------------
- Added an option to control response body transformation for errors, i.e. HTTP
status code >= 400. By default, a JSON or otherwise structured response body
will be reduced down to its error ``message``. That can be overridden by
setting ``simplify_error_response`` to False.
- Fix compile-time setting of default argument values in ``http_fetch``.
`2.2.1`_ Sep 20, 2019
---------------------
- Remove the lrucache on response body due to a bug in behavior
`2.2.0`_ Aug 29, 2019
---------------------
- Add handling of ``tornado.httpclient.HTTPTimeoutError`` and
``tornado.httpclient.HTTPStreamClosedError`` exceptions
- Fix documentation builds
- Update documentation links to readthedocs.io
`2.1.0`_ May 7, 2019
--------------------
- Cast the ``url`` parameter of ``http_fetch`` to a string.
Allows for native use of URL abstractions like `yarl <https://yarl.readthedocs.io/en/latest/>`_.
`2.0.1`_ Apr 1, 2019
--------------------
- Fix a bug with the rejected consumer User-Agent behavior
`2.0.0`_ Apr 1, 2019
--------------------
- Refactor the HTTPResponse to a stand-alone class
- Add ``history`` attribute of the response with all response objects
- Add ``links`` attribute of the response with the parsed link header if set
- Add ``exceptions`` attribute with stack of exceptions returned as responses
- Add ``dont_retry`` as argument to ``http_fetch`` method
- Change logging level in a few places to a more appropriate level
- Add support for rejected consumers when auto-creating the ``User-Agent`` header
- Add the netloc of a request to the log entry created when rate limited
- Use RequestHandler.settings instead of RequestHandler.application.settings
when auto-creating the ``User-Agent`` header for a Tornado request handler
- Add test coverage of the Warning response header behavior
`1.1.1`_ Jan 9, 2019
--------------------
- Fix failure when response lacks Content-Type header
`1.1.0`_ Oct 11, 2018
---------------------
- Add logging of response ``Warning`` headers
`1.0.9`_ Aug 7, 2018
--------------------
- Add support for Python 3.6 and 3.7
- Add support for Tornado < 6
`1.0.8`_ Feb 7, 2018
--------------------
- Add ``max_redirects`` keyword param
- Add ``validate_cert`` keyword param
- Fix log records always using default number of attempts
`1.0.7`_ Oct 19, 2017
---------------------
- Change the hard pin requirement on umsgpack
`1.0.6`_ Aug 16, 2017
---------------------
- Add ``max_http_attempts`` keyword param
`1.0.5`_ Aug 7, 2017
--------------------
- Add support for allow_nonstandard_methods and max_clients
`1.0.4`_ May 12, 2017
---------------------
- Add support for passing the user_agent parameter per request
`1.0.3`_ Apr 28, 2017
---------------------
- Fix the installer
`1.0.2`_ Apr 26, 2017
---------------------
- Documentation Updates
`1.0.1`_ Apr 26, 2017
---------------------
- Default Accept headers include both msgpack and json
`1.0.0`_ Apr 26, 2017
---------------------
- Initial Version
.. _Next Release: https://github.com/sprockets/sprockets.mixins.http/compare/2.6.0...master
.. _2.6.0: https://github.com/sprockets/sprockets.mixins.http/compare/2.5.0...2.6.0
.. _2.5.0: https://github.com/sprockets/sprockets.mixins.http/compare/2.4.1...2.5.0
.. _2.4.1: https://github.com/sprockets/sprockets.mixins.http/compare/2.4.0...2.4.1
.. _2.4.0: https://github.com/sprockets/sprockets.mixins.http/compare/2.3.3...2.4.0
.. _2.3.3: https://github.com/sprockets/sprockets.mixins.http/compare/2.3.1...2.3.3
.. _2.3.1: https://github.com/sprockets/sprockets.mixins.http/compare/2.3.0...2.3.1
.. _2.3.0: https://github.com/sprockets/sprockets.mixins.http/compare/2.2.1...2.3.0
.. _2.2.1: https://github.com/sprockets/sprockets.mixins.http/compare/2.2.0...2.2.1
.. _2.2.0: https://github.com/sprockets/sprockets.mixins.http/compare/2.1.0...2.2.0
.. _2.1.0: https://github.com/sprockets/sprockets.mixins.http/compare/2.0.1...2.1.0
.. _2.0.1: https://github.com/sprockets/sprockets.mixins.http/compare/2.0.0...2.0.1
.. _2.0.0: https://github.com/sprockets/sprockets.mixins.http/compare/1.1.1...2.0.0
.. _1.1.1: https://github.com/sprockets/sprockets.mixins.http/compare/1.1.0...1.1.1
.. _1.1.0: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.9...1.1.0
.. _1.0.9: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.8...1.0.9
.. _1.0.8: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.7...1.0.8
.. _1.0.7: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.6...1.0.7
.. _1.0.6: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.5...1.0.6
.. _1.0.5: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.4...1.0.5
.. _1.0.4: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.3...1.0.4
.. _1.0.3: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.2...1.0.3
.. _1.0.2: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.1...1.0.2
.. _1.0.1: https://github.com/sprockets/sprockets.mixins.http/compare/1.0.0...1.0.1
.. _1.0.0: https://github.com/sprockets/sprockets.mixins.http/compare/2fc5bad...1.0.0