Fedora-messaging

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

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


Development Changes

- Stop pinning pytest to 4.0 or less as the incompatibility with pytest-twisted
has been resolved
(PR 158).


Other Changes

- Include commands to connect to the Fedora broker in the documentation
(PR 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 130 (PR 139).

Bug Fixes

- Only prepend the `topic_prefix` on outgoing messages. Previously, the topic
prefix was incorrectly applied to incoming messages (143).

Documentation

- Add a note to the tutorial on how to instal the library and RabbitMQ in
containers (PR 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. Consult the new documentation at
`fedora-broker` for details (PR 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

Dependency Changes

- Replace the dependency on `pytoml` with `toml`
(132).


Features

- Support passive declarations for locked-down brokers
(136).


Bug Fixes

- Fix a bug in the sample schema pachage
(135).


Development Changes

- Switch to Mergify v2
(129).


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

- Aurélien Bompard
- Jeremy Cline
- Michal Konečný
- Shraddha Agrawal

Features

- The `topic_prefix` configuration value has been added to automatically add
a prefix to the topic of all outgoing messages.
(121)

- Support for Pika 0.13.
(126)

- Add a systemd service file for consumers.


Development Changes

- Use Bandit for security checking.


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

- Aurélien Bompard

API Changes

- The `Message._body` attribute is renamed to `body`, and is now part of the public API.
(PR 119)


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

- Aurélien Bompard
- Jeremy Cline

Features

- The `fedora_messaging.api.consume()` API now accepts a "queues" keyword
which specifies the queues to declare and consume from, and the
"fedora-messaging" CLI makes use of this
(PR 107)

- Utilities were added in the `schema_utils` module to help write the
Python API of your message schemas
(PR 108)

- No long require "--exchange", "--queue-name", and "--routing-key" to all be
specified when using "fedora-messaging consume". If one is not supplied, a
default is chosen. These defaults are documented in the command's manual page
(PR 117)


Bug Fixes

- Fix the "consumer" setting in config.toml.example to point to a real Python path
(PR 104)

- fedora-messaging consume now actually uses the --queue-name and --routing-key
parameter provided to it, and --routing-key can now be specified multiple times
as was documented
(PR 105)

- Fix the equality check on `fedora_messaging.message.Message` objects to
exclude the 'sent-at' header
(PR 109)

- Documentation for consumers indicated any callable object was acceptable to use
as a callback as long as it accepted a single positional argument (the
message). However, the implementation required that the callable be a function
or a class, which it then instantiated. This has been fixed and you may now use
any callable object, such as a method or an instance of a class that implements
`__call__()`
(PR 110)

- Fix an issue where the fedora-messaging CLI would only log if a configuration
file was explicitly supplied
(PR 113)


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

- Aurélien Bompard
- Jeremy Cline
- Sebastian Wojciechowski
- Tomas Tomecek