ears 0.11.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 288afca56e18d5cd8add5e50155a37d243daf862079893c2e2aa54728b5ce6dc
-  data.tar.gz: 7e961cf4efaf97fd72c79a8ff8fd49f2536decc6728a1f8d8ddb176b42de5ff3
+  metadata.gz: ba8ffc55e16ec7c7f0b7e3327b25aaf287feba34cc527d93d40d5b59bb4a1976
+  data.tar.gz: cacc33604f6299450735d16a376d583ffea86f27cc04e6108eab92473ae2ac50
 SHA512:
-  metadata.gz: afee5b7d9069bfda962b20776cbb38e0d9b0a416461cb9a41a7eae3c3aa1531d6e29dedebcd7210d1295b17ff9b1bce17fcf0d91bc516d3ff302f067f2f23461
-  data.tar.gz: f595da01d69259e73d497aef6dee354d202d6bb413fb4e4dba240b1060fc6794352f4f43c16f6bc12f53ef553bbdce025bff5867ecfc2d6c770cdc73169fc09c
+  metadata.gz: aa791974d982def87dfff26bc03819e5cd9c12d25440a055a3c9ce3bb5ebf8c6b36d00f31f93b3b37d5f0702ce4d5831e47f86e24abea9efde01b6d40e8f9482
+  data.tar.gz: df472e7514f6308e4436f0e475ea0dbcbf1e5e3219d87a3bc7adddb9ea74ee198088f9d565db61925cad3865f24fa25d6d1ff9db7b85bc84122fb0d934c1dbac

data/.rspec

@@ -1 +1,2 @@
 --require spec_helper
+--format doc

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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
+
 ## 0.11.2 (2023-10-25)
 
 - Add documentation generation via yard

data/Gemfile

@@ -2,13 +2,13 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development, :test do
-  gem 'prettier'
+group :test do
+  gem 'prettier', require: false
   gem 'rake'
-  gem 'redcarpet'
   gem 'rspec'
-  gem 'rubocop'
-  gem 'rubocop-rake'
-  gem 'rubocop-rspec'
-  gem 'yard'
+  gem 'rubocop', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'simplecov'
+  gem 'yard', require: false
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.11.2)
+    ears (0.13.0)
       bunny (~> 2.22.0)
       multi_json
 
@@ -15,6 +15,7 @@ GEM
       amq-protocol (~> 2.3, >= 2.3.1)
       sorted_set (~> 1, >= 1.0.2)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     haml (6.1.2)
       temple (>= 0.8.2)
       thor
@@ -36,7 +37,6 @@ GEM
     rake (13.0.6)
     rbs (3.1.3)
     rbtree (0.4.6)
-    redcarpet (3.6.0)
     regexp_parser (2.8.1)
     rexml (3.2.6)
     rspec (3.12.0)
@@ -78,6 +78,12 @@ GEM
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     set (1.0.3)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
@@ -101,6 +107,7 @@ PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
   arm64-darwin-22
+  ruby
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-darwin-22
@@ -110,11 +117,11 @@ DEPENDENCIES
   ears!
   prettier
   rake
-  redcarpet
   rspec
   rubocop
   rubocop-rake
   rubocop-rspec
+  simplecov
   yard
 
 BUNDLED WITH

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/Rakefile

@@ -2,13 +2,23 @@
 
 require 'rake/clean'
 require 'bundler/gem_tasks'
+require 'rubocop'
+require 'rubocop/rake_task'
 require 'rspec/core/rake_task'
 require 'yard'
 
 CLEAN << '.yardoc'
-CLOBBER << 'doc'
+CLOBBER << 'doc' << 'coverage'
 
 RSpec::Core::RakeTask.new(:spec)
 YARD::Rake::YardocTask.new { |t| t.stats_options = %w[--list-undoc] }
 
-task default: :spec
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.formatters = ['simple']
+  task.fail_on_error = true
+end
+
+desc 'Run Prettier'
+task(:prettier) { sh 'npm run lint' }
+
+task default: %i[spec rubocop prettier]

data/lib/ears/consumer.rb

@@ -27,6 +27,29 @@ module Ears
       middlewares << middleware.new(opts)
     end
 
+    # Configures the consumer, setting queue, exchange and other options to be used by
+    # the add_consumer method.
+    #
+    # @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 [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_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)
+    end
+
     # The method that is called when a message from the queue is received.
     # Keep in mind that the parameters received can be altered by middlewares!
     #
@@ -101,5 +124,32 @@ module Ears
         raise InvalidReturnError, result
       end
     end
+
+    class << self
+      attr_reader :queue,
+                  :exchange,
+                  :routing_keys,
+                  :queue_options,
+                  :durable_exchange,
+                  :exchange_type
+
+      private
+
+      def queue_options_from(opts:)
+        {
+          durable: opts.fetch(:durable_queue, true),
+          retry_queue: opts.fetch(:retry_queue, false),
+          retry_delay: opts.fetch(:retry_delay, 5000),
+          error_queue: opts.fetch(:error_queue, false),
+        }
+      end
+
+      attr_writer :queue,
+                  :exchange,
+                  :routing_keys,
+                  :queue_options,
+                  :durable_exchange,
+                  :exchange_type
+    end
   end
 end

data/lib/ears/middlewares/max_retries.rb

@@ -15,6 +15,7 @@ module Ears
 
       def call(delivery_info, metadata, payload, app)
         return handle_exceeded(payload) if retries_exceeded?(metadata)
+
         app.call(delivery_info, metadata, payload)
       end
 

data/lib/ears/setup.rb

@@ -58,8 +58,34 @@ module Ears
       end
     end
 
+    # Sets up consumers, including bindings to exchanges and queues.
+    #
+    # @param [Array<Class<Ears::Consumer>>] consumer_classes An array of subclasses of {Ears::Consumer} that call {Ears::Consumer#configure} in their class definition.
+    def setup_consumers(*consumer_classes)
+      consumer_classes.each { |consumer_class| setup_consumer(consumer_class) }
+    end
+
     private
 
+    def setup_consumer(consumer_class)
+      exchange =
+        exchange(
+          consumer_class.exchange,
+          consumer_class.exchange_type,
+          durable: consumer_class.durable_exchange,
+        )
+      configured_queue =
+        queue(consumer_class.queue, consumer_class.queue_options)
+      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.11.2'
+  VERSION = '0.13.0'
 end

data/lib/ears.rb

@@ -8,7 +8,6 @@ require 'ears/version'
 module Ears
   class << self
     # The global configuration for Ears.
-    #
     # @return [Ears::Configuration]
     def configuration
       @configuration ||= Ears::Configuration.new
@@ -48,6 +47,11 @@ module Ears
       Ears::Setup.new.instance_eval(&block)
     end
 
+    # Quick setup your consumers (including exchanges and queues).
+    def setup_consumers(*consumer_classes)
+      Ears::Setup.new.setup_consumers(*consumer_classes)
+    end
+
     # Blocks the calling thread until +SIGTERM+ or +SIGINT+ is received.
     # Used to keep the process alive while processing messages.
     def run!
@@ -74,9 +78,7 @@ module Ears
 
     # Used internally for testing.
     def reset!
-      @connection = nil
-      @configuration = nil
-      Thread.current[:ears_channel] = nil
+      @configuration = @connection = Thread.current[:ears_channel] = nil
     end
 
     private

metadata

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