Fedmsg

======

Bug fixes
---------

* Fix a bug in the configuration validation for ``crl_cache_expiry`` and
``ca_cert_cache_expiry`` (`500 <https://github.com/fedora-infra/fedmsg/pull/500>`_).

Developer improvements
----------------------

* Fix tests using the ``ca_cert_cache`` configuration as it is deprecated
(`498 <https://github.com/fedora-infra/fedmsg/pull/498>`_).

* Adjust the internal ``_consume`` API for fedmsg consumers to return the
Return any return value from the parent class's ``_consume``
(`507 <https://github.com/fedora-infra/fedmsg/pull/507>`_).

Contributors
------------

Thanks to all the contributors for this release:

* Sijis Aviles
* Ralph Bean
* Jeremy Cline

======

Deprecations
------------

* Using URLs for the CA and CRL settings (``ca_cert_location`` and ``crl_location``
respectively) is now deprecated and will be removed in a future release. Please
use filesystem paths instead.

Features
--------

* Allow the CA and CRL configuration options to be file paths
(`484 <https://github.com/fedora-infra/fedmsg/pull/484>`_).

* All configuration settings now have defaults and validators
(`488 <https://github.com/fedora-infra/fedmsg/pull/488>`_).

* Strengthen "legacy protection" in fedmsg.meta by catching KeyErrors
(`493 <https://github.com/fedora-infra/fedmsg/pull/493>`_).


Bug fixes
---------

* Remove the duplicate dependency on ``cryptography`` from the main install
requires (`486 <https://github.com/fedora-infra/fedmsg/pull/486>`_).

* Adjust the x509 signing API to return text instead of bytes
(`495 <https://github.com/fedora-infra/fedmsg/issues/495>`_).

Development improvements
------------------------

* Alter how the tests determine if cryptography is available to work better
with old versions of pyOpenSSL
(`482 <https://github.com/fedora-infra/fedmsg/pull/482>`_).

=====

Bug fixes
---------

* Fix an issue where messages replayed from datagrepper always failed signature
validation despite having valid signatures
(`477 <https://github.com/fedora-infra/fedmsg/pull/477>`_).

* Fix a Python 3 incompatibility where the downloading the certificate revocation
list crashed when attempting to write the file
(`478 <https://github.com/fedora-infra/fedmsg/pull/478>`_).


Development improvements
------------------------

* Several loggers now use their full module path as their logger name rather
than just "fedmsg" (`479 <https://github.com/fedora-infra/fedmsg/pull/479>`_).

Many thanks to all our contributors for this release:

* Jeremy Cline
* Chaitanya Kukde

=====

Backwards incompatible changes
------------------------------

* The ``--daemon`` option for all fedmsg commands that was deprecated in 0.19.0
has been removed. We recommend using your operating system's init system instead.
`systemd unit files <https://github.com/fedora-infra/fedmsg/tree/1.0.0/initsys>`_
are available in the git repository (`470 <https://github.com/fedora-infra/fedmsg/pull/470>`_).

* Python 2.6 is no longer supported (`469 <https://github.com/fedora-infra/fedmsg/pull/469>`_).


Features
--------

* Python 3.4+ is now supported. In order to use x509 certificates to sign and verify messages,
you will need `cryptography v1.6+ <https://cryptography.io/en/latest/>`_
and `pyOpenSSL v16.1+ <https://pyopenssl.org/en/stable/>`_. These can be installed with pip
via ``pip install fedmsg[crypto_ng]`` (`449
<https://github.com/fedora-infra/fedmsg/pull/449>`_).

* The fedmsg documentation has been re-organized (`453
<https://github.com/fedora-infra/fedmsg/pull/453>`_).


Development Improvements
------------------------

* The m2crypto unit tests were being skipped when the cryptography library was missing.
This is no longer the case
(`446 <https://github.com/fedora-infra/fedmsg/pull/446>`_).

* All usage of the nose library has been removed from the tests and the dependency on nose
has been removed (`448 <https://github.com/fedora-infra/fedmsg/pull/448>`_).

* ``click`` has been added as a test dependency (`452
<https://github.com/fedora-infra/fedmsg/pull/452>`_).

* Test coverage increased from 54.72% to 58.82%

* Several improvements to the tox.ini file (`458
<https://github.com/fedora-infra/fedmsg/pull/458>`_).

Many thanks to all our contributors for this release:

* Lumír 'Frenzy' Balhar
* Ralph Bean
* Jeremy Cline
* Chenxiong Qi

in 0.19.0.

Bug fixes
---------

* Fix an issue where messages failed validation because the message certificate
and signature were unicode objects (`456
<https://github.com/fedora-infra/fedmsg/pull/456>`_).

* Fix an issue where message bodies were not deserialized from JSON before being
passed to a consumer because the message bodies were unicode objects (`464
<https://github.com/fedora-infra/fedmsg/pull/464>`_).

* Fix an issue where messages never got passed to the consumer because the
message pre-processing caused an unhandled exception (`462
<https://github.com/fedora-infra/fedmsg/pull/462>`_).


Many thanks to the contributors for this release:

* Kamil Páral
* Jeremy Cline
* Patrick Uiterwijk
* Ralph Bean
* Ricky Elrod

======

Deprecations
------------

* The ``--daemon`` option has been deprecated for all fedmsg commands and will be
removed in a future release. We recommend using your operating system's init
system instead. `systemd units and SysV init scripts
<https://github.com/fedora-infra/fedmsg/tree/0.19.0/initsys>`_ are available in
the git repository (`434 <https://github.com/fedora-infra/fedmsg/pull/434>`_).


Features
--------

* A new command, ``fedmsg-signing-relay``, has been added that signs messages prior
to relaying them (`409 <https://github.com/fedora-infra/fedmsg/pull/409>`_).

* A new command, ``fedmsg-check``, can be used to check whether or not the expected
fedmsg producers and consumers are running
(`416 <https://github.com/fedora-infra/fedmsg/pull/416>`_).

* If the message contains a ``headers`` key, these are placed in the message body
(`437 <https://github.com/fedora-infra/fedmsg/pull/437>`_).

* It is now possible to use `cryptography <https://cryptography.io/>`_ and
`pyOpenSSL <https://pyopenssl.org/>`_ rather than m2crypto
(`421 <https://github.com/fedora-infra/fedmsg/pull/421>`_).

* The ircbot's URL shortener service is now configurable
(`430 <https://github.com/fedora-infra/fedmsg/pull/430>`_).


Bug fixes
---------

* Fix an issue where an ``AttributeError`` wasn't actually raised when calling
``fedmsg.publish`` before initializing the Moksha hub and using a non-ZeroMQ
publishing mechanism (`412 <https://github.com/fedora-infra/fedmsg/pull/412>`_).

* The default configuration was missing the ``topic_prefix`` key
(`431 <https://github.com/fedora-infra/fedmsg/pull/431>`_).


Development Improvements
------------------------

* fedmsg is now PEP-8 compliant (
`414 <https://github.com/fedora-infra/fedmsg/pull/414>`_,
`421 <https://github.com/fedora-infra/fedmsg/pull/421>`_,
`422 <https://github.com/fedora-infra/fedmsg/pull/422>`_).

* `Tox <https://tox.readthedocs.io/en/latest/>`_ is used to enforce PEP-8, build
the documentation, and run the tests with multiple versions of Python
(`417 <https://github.com/fedora-infra/fedmsg/pull/417>`_).

* The test suite is now run with `pytest <https://docs.pytest.org/>`_ rather than nose.
(`417 <https://github.com/fedora-infra/fedmsg/pull/417>`_).

* Code coverage history is now tracked with
`codecov.io <https://codecov.io/gh/fedora-infra/fedmsg/>`_.

Many thanks to all our contributors for this release:

* Elan Ruusamäe
* Pravin Chaudhary
* Ralph Bean
* Jeremy Cline