Merge pull request #58 from gmr/consolidate-consumers

Consolidate consumer classes and add Avro support

Author: gmr

docs/api.md

@@ -6,12 +6,6 @@ The primary base classes for building message consumers.
 
 ::: rejected.consumer.Consumer
 
-::: rejected.consumer.PublishingConsumer
-
-::: rejected.consumer.SmartConsumer
-
-::: rejected.consumer.SmartPublishingConsumer
-
 ## Exceptions
 
 ::: rejected.consumer.ConsumerException

docs/api_consumer.rst

@@ -5,8 +5,3 @@ Consumer
    :members:
    :inherited-members:
    :exclude-members: execute, log_exception, on_confirmation, require_setting, set_channel
-
-.. autoclass:: rejected.consumer.PublishingConsumer
-   :members:
-   :inherited-members:
-   :exclude-members: execute, log_exception, on_confirmation, require_setting, set_channel

docs/api_smart_consumer.rst

@@ -2,20 +2,18 @@
 
 Consumer API
 ============
-The :py:class:`Consumer <rejected.consumer.Consumer>` and
-:py:class:`SmartConsumer <rejected.consumer.SmartConsumer>` classes to extend
+The :py:class:`Consumer <rejected.consumer.Consumer>` class to extend
 for consumer applications.
 
-While the :py:class:`Consumer <rejected.consumer.Consumer>` class provides all
-the structure required for implementing a rejected consumer,
-the :py:class:`SmartConsumer <rejected.consumer.SmartConsumer>` adds
-functionality designed to make writing consumers even easier. When messages
-are received by consumers extending :py:class:`SmartConsumer <rejected.consumer.SmartConsumer>`,
-if the message's ``content_type`` property contains one of the supported mime-types,
-the message body will automatically be deserialized, making the deserialized
-message body available via the ``body`` attribute. Additionally, should one of
-the supported ``content_encoding`` types (``gzip`` or ``bzip2``) be specified in the
-message's property, it will automatically be decoded.
+The :py:class:`Consumer <rejected.consumer.Consumer>` class provides all
+the structure required for implementing a rejected consumer, including
+automatic deserialization of message bodies based on the message's
+``content_type`` property. When messages are received, if the message's
+``content_type`` property contains one of the supported mime-types, the message
+body will automatically be deserialized, making the deserialized message body
+available via the ``body`` attribute. Additionally, should one of the supported
+``content_encoding`` types (``gzip`` or ``bzip2``) be specified in the message's
+property, it will automatically be decoded.
 
 Message Type Validation
 -----------------------
@@ -51,7 +49,6 @@ Consumer Classes
    :maxdepth: 1
 
    api_consumer
-   api_smart_consumer
 
 Exceptions
 ----------

docs/consumer.rst

@@ -66,12 +66,12 @@ __version__ = '1.0.0'
 LOGGER = logging.getLogger(__name__)
 
 
-class ExampleConsumer(consumer.PublishingConsumer):
+class ExampleConsumer(consumer.Consumer):
 
     def process(self):
         LOGGER.info(self.body)
-        self.publish('new-exchange', 'routing-key', {}, self.body)
+        self.publish_message('new-exchange', 'routing-key', {}, self.body)
 ```
 
-Note that the previous example extends `rejected.consumer.PublishingConsumer`
-instead of `rejected.consumer.Consumer`.
+Note that `consumer.Consumer` supports publishing directly — there is no need
+to extend a separate `PublishingConsumer` class.

docs/consumer_howto.md

@@ -9,7 +9,7 @@
 __version__ = '1.0.0'
 
 
-class ExampleConsumer(consumer.SmartConsumer):
+class ExampleConsumer(consumer.Consumer):
     def process(self):
         self.logger.info('Message: %r', self.body)
         action = random.randint(0, 100)

examples.py

@@ -37,6 +37,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+avro = ["fastavro>=1.7", "requests>=2.28"]
 html = ["beautifulsoup4"]
 msgpack = ["u-msgpack-python"]
 sentry = ["sentry-sdk>=2,<3"]

pyproject.toml

@@ -10,13 +10,11 @@
 logging.getLogger(__name__).addHandler(logging.NullHandler())
 
 from rejected.consumer import (  # noqa: E402
+    AVRO_DATUM_MIME_TYPE,
     Consumer,
     ConsumerException,
     MessageException,
     ProcessingException,
-    PublishingConsumer,
-    SmartConsumer,
-    SmartPublishingConsumer,
 )
 
 __author__ = 'Gavin M. Roy <gavinmroy@gmail.com>'
@@ -27,13 +25,11 @@
     __version__ = 'unknown'
 
 __all__ = [
+    'AVRO_DATUM_MIME_TYPE',
     'Consumer',
     'ConsumerException',
     'MessageException',
     'ProcessingException',
-    'PublishingConsumer',
-    'SmartConsumer',
-    'SmartPublishingConsumer',
     '__author__',
     '__since__',
     '__version__',

rejected/__init__.py

@@ -59,6 +59,7 @@ class ConsumerConfig(pydantic.BaseModel):
     qos_prefetch: int = 1
     max_errors: int = 5
     error_exchange: str | None = None
+    schema_uri_format: str | None = None
     sentry_dsn: str | None = None
     drop_exchange: str | None = None
     drop_invalid_messages: bool | None = None