Fedora-messaging

Dependency Changes

* Drop official Python 3.4 and 3.5 support
* Bump the pika requirement to 1.0.1+

API Changes

* Move all APIs to use the Twisted-managed connection. There are a few minor changes here which slightly change the APIs:
1. Publishing now raises a PublishTimeout when the timeout is reached (30 seconds by default).
2. Previously, the Twisted consume API did not validate arguments like the synchronous version did, so it now raises a ValueError on invalid arguments instead of crashing in some undefined way.
3. Calling publish from the Twisted reactor thread now raises an exception instead of blocking the reactor thread.

Features

* The fedora-messaging cli now has 2 new sub-commands: publish and record. (PR43)
* Log the failure traceback on connection ready failures.

Bug Fixes

* Fix an issue where reconnection to the server would fail. (208)
* Don't declare exchanges when consuming. (171)
* Fix Twisted legacy logging (it does not accept format parameters).
* Handle ConnectionLost errors in the v2 Factory.

Development Changes

* Many Twisted-related tests were added.
* Include tests for sample schema package.
* Update the dumps and loads functions for a new message format.

Documentation Improvements

* Document that logging is only set up for consumers.
* Update the six intersphinx URL to fix the docs build.
* Add the "conf" and "DEFAULTS" variables to the API documentation.
* Update example config: extra properties, logging.
* Document a quick way to setup logging.
* Document the sent-at header in messages.
* Create a quick-start guide.
* Clarify queues are only deleted if unused.
* Wire-format: improve message properties documentation.
* Note the addition client properties in the config docs.

Contributors

Many thanks to the contributors of bug reports, pull requests, and pull request
reviews for this release:

* Aurélien Bompard
* Adam Williamson
* dvejmz
* Jeremy Cline
* Randy Barlow
* Shraddha Agrawal
* Sebastian Wojciechowski

==================

Bug Fixes
---------

* Fix variable substitution in log messages. (200)
* Add MANIFEST.in and include tests for sample schema package. (197)


Documentation Improvements
--------------------------

* Document the sent-at header in messages. (199)
* Create a quick-start guide. (196)


Contributors
------------
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:

* Adam Williamson
* Aurélien Bompard
* Jeremy Cline
* Shraddha Agrawal

Bug Fixes

- Don't declare exchanges when consuming using the synchronous
`fedora_messaging.api.consume` API, which was causing consuming to
fail from the Fedora broker
([PR\191](https://github.com/fedora-infra/fedora-messaging/pull/191))

Documentation Improvements

- Document some additional app properties and add a note about setting
up logging in the fedora.toml and stg.fedora.toml configuration
files
([PR\188](https://github.com/fedora-infra/fedora-messaging/pull/188))
- Document how to setup logging in the consuming snippets so any
problems are logged to stdout
([PR\192](https://github.com/fedora-infra/fedora-messaging/pull/192))
- Document that logging is only set up for consumers
([\181](https://github.com/fedora-infra/fedora-messaging/issues/181))
- Document the `fedora_messaging.config.conf` and
`fedora_messaging.config.DEFAULTS` variables in the API
documentation
([\182](https://github.com/fedora-infra/fedora-messaging/issues/182))

Contributors

Many thanks to the contributors of bug reports, pull requests, and pull
request reviews for this release:

- Randy Barlow
- Aurélien Bompard
- Jeremy Cline
- Adam Williamson

Features

- "fedora-messaging consume" now accepts a "--callback-file" argument
which will load a callback function from an arbitrary Python file.
Previously, it was required that the callback be in the Python path
([\159](https://github.com/fedora-infra/fedora-messaging/issues/159)).

Bug Fixes

- Fix a bug where publishes that failed due to certain connection
errors were not retried
([\175](https://github.com/fedora-infra/fedora-messaging/issues/175)).
- Fix a bug where AMQP protocol errors did not reset the connection
used for publishing messages. This would result in publishes always
failing with a ConnectionError
([\178](https://github.com/fedora-infra/fedora-messaging/pull/178)).

Documentation Improvements

- Document the `body` attribute on the `Message` class
([\164](https://github.com/fedora-infra/fedora-messaging/issues/164)).
- Clearly document what properties message schema classes should
override
([\166](https://github.com/fedora-infra/fedora-messaging/issues/166)).
- Re-organize the consumer documentation to make the consuming API
clearer
([\168](https://github.com/fedora-infra/fedora-messaging/issues/168)).

Contributors

Many thanks to the contributors of bug reports, pull requests, and pull
request reviews for this release:

- Randy Barlow
- Aurélien Bompard
- Jeremy Cline
- Dusty Mabe

Bug Fixes

- Fix a bug in publishing where if the broker closed the connection, the client would not properly dispose of the connection object and publishing would fail forever ([PR\157](https://github.com/fedora-infra/fedora-messaging/pull/157)).
- Fix a bug in the `fedora_messaging.api.twisted_consume` function where if the user did not have permissions to read from the specified queue which had already been declared, the Deferred that was returned never fired. It now errors back with a `fedora_messaging.exceptions.PermissionException` ([PR\160](https://github.com/fedora-infra/fedora-messaging/pull/160)).

Development Changes

- Stop pinning pytest to 4.0 or less as the incompatibility with pytest-twisted has been resolved ([PR\158](https://github.com/fedora-infra/fedora-messaging/pull/158)).

Other Changes

- Include commands to connect to the Fedora broker in the documentation ([PR\154](https://github.com/fedora-infra/fedora-messaging/pull/154)).

Contributors

Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:

- Aurélien Bompard
- Jeremy Cline

Dependency Changes

- Twisted is no longer an optional dependency: fedora-messaging requires Twisted 12.2 or greater.

Features

- A new API, `fedora_messaging.api.twisted_consume`, has been added to support consuming using the popular async framework Twisted. The fedora-messaging command-line interface has been switched to use this API. As a result, Twisted 12.2+ is now a dependency of fedora-messsaging. Users of this new API are not affected by [Issue \130](https://github.com/fedora-infra/fedora-messaging/issues/130) ([PR\#139](https://github.com/fedora-infra/fedora-messaging/pull/139)).

Bug Fixes

- Only prepend the topic\_prefix on outgoing messages. Previously, the topic prefix was incorrectly applied to incoming messages ([\143](https://github.com/fedora-infra/fedora-messaging/issues/143)).

Documentation

- Add a note to the tutorial on how to instal the library and RabbitMQ in containers ([PR\141](https://github.com/fedora-infra/fedora-messaging/pull/141)).
- Document how to access the Fedora message broker from outside the Fedora infrastructure VPN. Users of fedmsg can now migrate to fedora-messaging for consumers outside Fedora's infrastructure ([PR\149](https://github.com/fedora-infra/fedora-messaging/pull/149)).

Contributors

Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:

- Aurélien Bompard
- Jeremy Cline
- Shraddha Agrawal