spectre-rabbitmq 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb9a0aa9e333b3d5088a6ff5d5f963dccc78e055aac5715aa409e4fe1f4513da
-  data.tar.gz: c7d2516a0bfa90f144dd05bc0c575cc2cbb96bd9a7d97c4230c3b3b6bd31ad78
+  metadata.gz: bb8f90ed30256eef897dff211ff9099b85f8c8dd54edbdb604971e9d8ce2cad8
+  data.tar.gz: 6d3842ddeb977dd9b606c905e62e2dfec42de213fdd69d233ec5bdfc7f1ba31e
 SHA512:
-  metadata.gz: 3e07714fcae49f6f51604dda155e00397099d807a583c94ecbbfd6104b402f1834ef0cdea8385f39e260e432fe0d8433a77ac77510ba6c5e7013ab8791629ad8
-  data.tar.gz: e2a0936817a5ee7dbacf97f381fcbe34c9f8db63d4bc00076e1546167970186c05225e6ce2d71a7291576c9e07b22a315bb54136ebcb38974e002bf7c8971889
+  metadata.gz: 81c74dacf90d7dd9599e4cc4746a0df61b0be48370b396922a912facad97cfa39d54e59ab0c6c8d596f21b282169078dcb31386ebf88727c92a7ba3fa8da272b
+  data.tar.gz: 7989f93e257e70507c02d895a6427ce452aed6cf01cdb27744b73105ad5ffccd212d35a4543f8d9d2bcfe00e880c16f02e31a4d3be3a8430b5e61ac81cfd8c09

data/lib/spectre/rabbitmq.rb

@@ -1,18 +1,21 @@
-require 'spectre'
-require 'spectre/logging'
+require 'logger'
 require 'ostruct'
 require 'bunny'
 
-
 module Spectre
   module RabbitMQ
-    class ActionParamsBase < Spectre::DslClass
+    PROGNAME = 'spectre/rabbitmq'
+
+    class ActionParamsBase
+      include Spectre::Delegate if defined? Spectre::Delegate
+
       attr_reader :config
 
       def initialize config, logger
         @logger = logger
-        @config = config.deep_clone
+        @config = Marshal.load(Marshal.dump(config))
         @config['routing_keys'] = []
+        @config['log_payload'] = true
       end
 
       def exchange name, type: 'topic', durable: false, auto_delete: false
@@ -25,7 +28,7 @@ module Spectre
       end
 
       def topic name, durable: false, auto_delete: false
-        exchange(name, type: 'topic', durable: durable, auto_delete: auto_delete)
+        exchange(name, type: 'topic', durable:, auto_delete:)
       end
 
       def routing_keys *names
@@ -37,13 +40,13 @@ module Spectre
       end
 
       def no_log!
-        @config['no_log'] = true
+        @config['log_payload'] = false
       end
     end
 
     class ConsumeActionParams < ActionParamsBase
       def initialize config, logger
-        super config, logger
+        super
 
         @config['queue'] = {
           'name' => nil,
@@ -54,7 +57,7 @@ module Spectre
         @config['messages'] = 1
       end
 
-      def queue name, durable: false, auto_delete: false, exclusive: false
+      def queue name = '', exclusive: false, durable: false, auto_delete: false
         @config['queue'] = {
           'name' => name,
           'durable' => durable,
@@ -85,11 +88,13 @@ module Spectre
         @config['reply_to'] = receiver
       end
 
-      alias :body :payload
+      alias body payload
     end
 
-    class RabbitMQAction < Spectre::DslClass
-      attr_reader :conn, :action, :threads, :messages
+    class RabbitMQAction
+      include Spectre::Delegate if defined? Spectre::Delegate
+
+      attr_reader :conn, :threads, :messages
 
       def initialize config, logger
         @logger = logger
@@ -133,11 +138,11 @@ module Spectre
         @config['virtual_host'] = vhost
       end
 
-      def consume &block
+      def consume(&)
         params = ConsumeActionParams.new(@config, @logger)
-        params.instance_eval(&block)
+        params.instance_eval(&)
 
-        connect()
+        connect
 
         channel = @conn.create_channel
 
@@ -147,40 +152,45 @@ module Spectre
           params.config['queue']['name'],
           durable: params.config['queue']['durable'],
           auto_delete: params.config['queue']['auto_delete'],
-          exclusive: params.config['queue']['exclusive'],
+          exclusive: params.config['queue']['exclusive']
         )
 
-        @logger.info("declare queue name=#{queue.name} durable=#{params.config['queue']['durable']} auto_delete=#{params.config['queue']['auto_delete']} exclusive=#{params.config['queue']['exclusive']}")
+        @logger.log(Logger::Severity::INFO,
+                    "declare queue name=#{queue.name} " \
+                    "durable=#{params.config['queue']['durable']} " \
+                    "exclusive=#{params.config['queue']['exclusive']} " \
+                    "auto_delete=#{params.config['queue']['auto_delete']}",
+                    PROGNAME)
 
         params.config['routing_keys'].each do |routing_key|
-          queue.bind(exchange, routing_key: routing_key)
-          @logger.info("bind exchange=#{exchange.name} queue=#{queue.name} routing_key=#{routing_key}")
+          queue.bind(exchange, routing_key:)
+
+          @logger.log(
+            Logger::Severity::INFO,
+            "bind exchange=#{exchange.name} queue=#{queue.name} routing_key=#{routing_key}",
+            PROGNAME
+          )
         end
 
         consumer_thread = Thread.new do
-          message_queue = Queue.new
-
-          queue.subscribe do |_delivery_info, properties, payload|
+          queue.subscribe(block: true) do |delivery_info, properties, payload|
             message = OpenStruct.new
             message.payload = payload
             message.correlation_id = properties[:correlation_id]
             message.reply_to = properties[:reply_to]
             message.freeze
 
-            message_queue << message
-          end
-
-          while @messages.count < params.config['messages']
-            message = message_queue.pop
+            log_msg = "get queue=#{queue.name}" \
+                      "\ncorrelation_id: #{message.correlation_id}" \
+                      "\nreply_to: #{message.reply_to}"
 
-            payload_message = message.payload
+            log_msg = "\n#{message.payload}" if params.config['log_payload']
 
-            if params.config['no_log'] == true
-              payload_message = '[...]'
-            end
+            @logger.log(Logger::Severity::INFO, log_msg, PROGNAME)
 
-            @logger.info("get queue=#{queue.name}\ncorrelation_id: #{message.correlation_id}\nreply_to: #{message.reply_to}\n#{payload_message}")
             @messages << message
+
+            delivery_info.consumer.cancel if @messages.count >= (params.config['messages'] || 1)
           end
         end
 
@@ -192,36 +202,35 @@ module Spectre
         end
       end
 
-      def publish &block
+      def publish(&)
         params = PublishActionParams.new(@config, @logger)
-        params.instance_eval(&block)
+        params.instance_eval(&)
 
-        connect()
+        connect
 
         channel = @conn.create_channel
 
         exchange = declare_exchange(channel, params)
 
-        routing_key = params.config['routing_keys'].nil? ? nil : params.config['routing_keys'].first
+        routing_key = params.config['routing_keys']&.first
 
         exchange.publish(
           params.config['payload'],
-          routing_key: routing_key,
+          routing_key:,
           correlation_id: params.config['correlation_id'],
           reply_to: params.config['reply_to']
         )
 
-        payload_message = params.config['payload']
+        log_msg = "publish exchange=#{params.config['exchange']['name']} " \
+                  "routing_key=#{routing_key}"
 
-        if params.config['no_log'] == true
-          payload_message = '[...]'
-        end
+        log_msg += "\n#{params.config['payload']}" if params.config['log_payload']
 
-        @logger.info("publish exchange=#{params.config['exchange']['name']} routing_key=#{routing_key} payload=\"#{payload_message}\"")
+        @logger.log(Logger::Severity::INFO, log_msg, PROGNAME)
       end
 
       def await!
-        @threads.each { |x| x.join }
+        @threads.each(&:join)
       end
 
       private
@@ -229,10 +238,10 @@ module Spectre
       def connect
         return unless @conn.nil?
 
-        vhost = @config['virtual_host']
-        vhost = '/' + vhost unless vhost.start_with? '/'
-
-        @logger.info("connect #{@config['username']}:*****@#{@config['host']}#{vhost} ssl=#{@config['ssl']}")
+        @logger.log(Logger::Severity::INFO,
+                    "connect #{@config['username']}:*****@#{@config['host']}/#{@config['virtual_host']} " \
+                    "ssl=#{@config['ssl']}",
+                    PROGNAME)
 
         @conn = Bunny.new(
           host: @config['host'],
@@ -252,47 +261,40 @@ module Spectre
           params.config['exchange']['type'].to_s,
           params.config['exchange']['name'],
           durable: params.config['exchange']['durable'],
-          auto_delete: params.config['exchange']['auto_delete'],
+          auto_delete: params.config['exchange']['auto_delete']
         )
 
-        @logger.info("declare exchange name=#{exchange.name} type=#{exchange.type} durable=#{params.config['exchange']['durable']} auto_delete=#{params.config['exchange']['auto_delete']}")
+        @logger.log(Logger::Severity::INFO,
+                    "declare exchange name=#{exchange.name} type=#{exchange.type} " \
+                    "durable=#{params.config['exchange']['durable']} " \
+                    "auto_delete=#{params.config['exchange']['auto_delete']}",
+                    PROGNAME)
 
         exchange
       end
     end
 
-    class << self
-      @@config = {}
+    class Client
+      include Spectre::Delegate if defined? Spectre::Delegate
 
-      def rabbitmq name, &block
-        if @@config.key? name
-          config = @@config[name]
-        else
-          config = {
-            'host' => name,
-          }
-        end
+      def initialize config, logger
+        @config = config['rabbitmq'] || {}
+        @logger = logger
+      end
 
-        action = RabbitMQAction.new(config, @@logger)
-        action._evaluate(&block) if block_given?
+      def rabbitmq(name, &)
+        config = @config[name] || {'host' => name }
+
+        action = RabbitMQAction.new(config, @logger)
+        action.instance_eval(&) if block_given?
 
         # Wait for all consumer threads to be finished
-        action.threads.each { |x| x.join }
+        action.threads.each(&:join)
 
         action.conn.close
       end
     end
-
-    Spectre.register do |config|
-      @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/rabbitmq')
-
-      if config.key? 'rabbitmq'
-        config['rabbitmq'].each do |name, cfg|
-          @@config[name] = cfg
-        end
-      end
-    end
-
-    Spectre.delegate :rabbitmq, to: self
   end
+
+  Engine.register(RabbitMQ::Client, :rabbitmq) if defined? Engine
 end

metadata

@@ -1,43 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: spectre-rabbitmq
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Christian Neubauer
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: spectre-core
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.20.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.20.3
+        version: '0'
 description: Adds RabbitMQ functionality to the spectre framework
 email:
 - christian.neubauer@ionos.com
@@ -48,12 +61,11 @@ files:
 - lib/spectre/rabbitmq.rb
 homepage: https://github.com/ionos-spectre/spectre-rabbitmq
 licenses:
-- MIT
+- GPL-3.0-or-later
 metadata:
   homepage_uri: https://github.com/ionos-spectre/spectre-rabbitmq
   source_code_uri: https://github.com/ionos-spectre/spectre-rabbitmq
   changelog_uri: https://github.com/ionos-spectre/spectre-rabbitmq/blob/master/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -61,15 +73,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.6.6
 specification_version: 4
 summary: RabbitMQ module for spectre
 test_files: []