ears 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b5be9543cc8c9a75eb078b181786cd85864515064cce8ddb130647e53611700
-  data.tar.gz: 48b47f63a7e90c9e149cb008c6a34c35b9d8f4b8133f43c558906fe1fb5398ec
+  metadata.gz: ba8ffc55e16ec7c7f0b7e3327b25aaf287feba34cc527d93d40d5b59bb4a1976
+  data.tar.gz: cacc33604f6299450735d16a376d583ffea86f27cc04e6108eab92473ae2ac50
 SHA512:
-  metadata.gz: c0e1a9620e0b167921c80e54df06f52fbfff47ea1023d07f8533f888e81443c5583addf46fa3129c32944b534da1595f7b23bff93e457575e72502b1fb7e98c9
-  data.tar.gz: 119f76252574d361b0d339e427203dbd952045afda5d329e6a327d48f5cabdcacb752f04e4ebe4398d86d55ac26314d678f61d925bf79e81d9e11f67b3f4240f
+  metadata.gz: aa791974d982def87dfff26bc03819e5cd9c12d25440a055a3c9ce3bb5ebf8c6b36d00f31f93b3b37d5f0702ce4d5831e47f86e24abea9efde01b6d40e8f9482
+  data.tar.gz: df472e7514f6308e4436f0e475ea0dbcbf1e5e3219d87a3bc7adddb9ea74ee198088f9d565db61925cad3865f24fa25d6d1ff9db7b85bc84122fb0d934c1dbac

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.13.0 (2023-11-07)
+
+- Allow adding multiple routing keys to the consumer configuration, configure method within consumer will only accept `routing_keys` array instead of `routing_key` string
+
 ## 0.12.0 (2023-10-26)
 
 - add new interface to setup consumers including their exchange, queue and binding the queue to the exchange via routing key via `Ears.setup_consumers` and `configure(queue:, exchange:,routing_key:, ...)` for Ears::Consumers subclasses

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.12.0)
+    ears (0.13.0)
       bunny (~> 2.22.0)
       multi_json
 

data/README.md

@@ -39,7 +39,39 @@ end
 
 _Note_: `connection_name` is a mandatory setting!
 
-Next, define your exchanges, queues, and consumers by calling `Ears.setup`.
+Next, you can define your exchanges, queues, and consumers in 2 ways:
+
+#### 1. consumer specific configuration method (recommended)
+
+1. Pass your consumer classes to `Ears.setup`:
+
+```ruby
+Ears.setup do
+  Ears.setup_consumers(Consumer1, Consumer2, ...)
+end
+```
+
+2. Implement your consumers by subclassing `Ears::Consumer`. and call the configure method.
+
+```ruby
+class Consumer1 < Ears::Consumer
+  configure(
+    queue: 'queue_name',
+    exchange: 'exchange',
+    routing_keys: %w[routing_key1 routing_key2],
+    retry_queue: true, # optional configuration, defaults to false, Adds a retry queue
+    error_queue: true, # optional configuration, defaults to false, Adds an error queue
+  )
+  def work(delivery_info, metadata, payload)
+    message = JSON.parse(payload)
+    do_stuff(message)
+
+    ack
+  end
+end
+```
+
+#### 2. Generic configuration method
 
 ```ruby
 Ears.setup do
@@ -57,7 +89,7 @@ Ears.setup do
 end
 ```
 
-Finally, you need to implement `MyConsumer` by subclassing `Ears::Consumer`.
+Finally, you need to implement `MyConsumer` by subclassing `Ears::Consumer`. and call the configure method.
 
 ```ruby
 class MyConsumer < Ears::Consumer
@@ -70,7 +102,9 @@ class MyConsumer < Ears::Consumer
 end
 ```
 
-And, do not forget to run it. Be prepared that unhandled errors will be reraised. So, take care of cleanup work.
+### Run your consumers
+
+Note: Be prepared that unhandled errors will be reraised. So, take care of cleanup work.
 
 ```ruby
 begin
@@ -165,7 +199,24 @@ end
 
 ### Implementing a retrying queue
 
-Sometimes you want to automatically retry processing a message, in case it just failed due to temporary problems. In that case, you can set the `retry_queue` and `retry_delay` parameters when creating the queue.
+Sometimes you want to automatically retry processing a message, in case it just failed due to temporary problems. In that case, you can set the `retry_queue` and `retry_delay` parameters when creating the queue OR pass it to the configure method in your consumer.
+
+```ruby
+class MyConsumer < Ears::Consumer
+  configure(
+    queue: 'queue_name',
+    exchange: 'exchange',
+    routing_keys: %w[routing_key1 routing_key2],
+    retry_queue: true,
+  )
+  def work(delivery_info, metadata, payload)
+    message = JSON.parse(payload)
+    do_stuff(message)
+
+    ack
+  end
+end
+```
 
 ```ruby
 my_queue =
@@ -178,7 +229,24 @@ This will happen indefinitely, so if you want to bail out of this cycle at some
 
 ### Implementing an error queue
 
-You can set the `error_queue` parameter to automatically create an error queue.
+You can set the `error_queue` parameter to automatically create an error queue, or add it to the configure method in your consumer.
+
+```ruby
+class MyConsumer < Ears::Consumer
+  configure(
+    queue: 'queue_name',
+    exchange: 'exchange',
+    routing_keys: %w[routing_key1 routing_key2],
+    error_queue: true,
+  )
+  def work(delivery_info, metadata, payload)
+    message = JSON.parse(payload)
+    do_stuff(message)
+
+    ack
+  end
+end
+```
 
 ```ruby
 my_queue =

data/lib/ears/consumer.rb

@@ -33,17 +33,18 @@ module Ears
     # @param [Hash] opts The options to configure the consumer with.
     # @option opts [String] :queue The name of the queue to consume from.
     # @option opts [String] :exchange The name of the exchange the queue should be bound to.
-    # @option opts [String] :routing_key The routing key used the queue binding.
+    # @option opts [Array] :routing_keys The routing keys used for the queue binding.
     # @option opts [Boolean] :durable_queue (true) Whether the queue should be durable.
     # @option opts [Boolean] :retry_queue (false) Whether a retry queue should be provided.
     # @option opts [Integer] :retry_delay (5000) The delay in milliseconds before retrying a message.
     # @option opts [Boolean] :error_queue (false) Whether an error queue should be provided.
     # @option opts [Boolean] :durable_exchange (true) Whether the exchange should be durable.
     # @option opts [Symbol] :exchange_type (:topic) The type of exchange to use.
+    # @option opts [Integer] :threads (1) The number of threads to use for this consumer.
     def self.configure(opts = {})
       self.queue = opts.fetch(:queue)
       self.exchange = opts.fetch(:exchange)
-      self.routing_key = opts.fetch(:routing_key)
+      self.routing_keys = opts.fetch(:routing_keys)
       self.queue_options = queue_options_from(opts: opts)
       self.durable_exchange = opts.fetch(:durable_exchange, true)
       self.exchange_type = opts.fetch(:exchange_type, :topic)
@@ -127,7 +128,7 @@ module Ears
     class << self
       attr_reader :queue,
                   :exchange,
-                  :routing_key,
+                  :routing_keys,
                   :queue_options,
                   :durable_exchange,
                   :exchange_type
@@ -145,7 +146,7 @@ module Ears
 
       attr_writer :queue,
                   :exchange,
-                  :routing_key,
+                  :routing_keys,
                   :queue_options,
                   :durable_exchange,
                   :exchange_type

data/lib/ears/setup.rb

@@ -76,10 +76,16 @@ module Ears
         )
       configured_queue =
         queue(consumer_class.queue, consumer_class.queue_options)
-      configured_queue.bind(exchange, routing_key: consumer_class.routing_key)
+      bind_queue_to_routing_keys(consumer_class, exchange, configured_queue)
       consumer(configured_queue, consumer_class)
     end
 
+    def bind_queue_to_routing_keys(consumer_class, exchange, configured_queue)
+      consumer_class.routing_keys.each do |routing_key|
+        configured_queue.bind(exchange, routing_key: routing_key)
+      end
+    end
+
     def queue_options(bunny_opts, retry_arguments)
       return bunny_opts unless retry_arguments
 

data/lib/ears/version.rb

@@ -1,3 +1,3 @@
 module Ears
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - InVision AG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny