queues-rabbit 0.1.0.beta → 0.1.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58e40e8dbe25821bf98ecb4991f7a60cc1eb6407a2d7c7c31aacd3a195d4235
-  data.tar.gz: 3d847b462ae575169df2060898d9b70eb9fb27f5413ee655d6a8e982d8ebf30c
+  metadata.gz: 4ecb7575f981fcc564af562d2938d6cbf15d1b02f382b87aea516fb5e78b1c0f
+  data.tar.gz: 7a22c34478ecc86039a727085af54e71944f241caf032450ce8f593ffa20ce8b
 SHA512:
-  metadata.gz: 2c4f8024b9af1b1996a71336a33e74dbb7936b5d5d59cb90aeb2cf97f80cb1584eef8d020cede67c1a41537eb61ba3de22443f5558fd2544e08585889051d109
-  data.tar.gz: 7194a44edf4b2e0168fb346bd8803419e1ad647c824cde2b097a199eeef16e67f8f7e8b2c646cc1c8fffb755ed1bbbd7b76d3f1c7d36d5be8cf4f1631871383a
+  metadata.gz: 890ac13fa7258b55eb6a20a8d4eb64c6dffa42b847772ebe141ce77c1c1560f4086e8aa23f22250b0e72529d18cb99b25b2ed7f590bbeb6e4849fb8ea6a2b43a
+  data.tar.gz: afb3f5467d0af7f99ed3336e62ec7eaac6b500573605fa0b1a26e2b0f7db8930feedc66436c1b4c08cb8369b3b8fa18e2b80d9d51419200660b83f39a43649f1

data/README.md

@@ -108,7 +108,7 @@ module Rabbits
   class Schema < ::Queues::Rabbit::Schema
     queue Rabbits::Queues::MyQueueOne
     exchange Rabbits::Queues::MyExchangeOne
-    
+
     queue Rabbits::Queues::MyQueueTwo
     exchange Rabbits::Queues::MyExchangeTwo
   end
@@ -131,7 +131,7 @@ module Rabbits
             durable: true,
             prefetch: 1,
             arguments: {}
-      
+
       # ...
     end
   end
@@ -144,12 +144,14 @@ The `queue` method allows you to define the RabbitMQ queue parameters.
 - **auto_ack:** When false messages have to be manually acknowledged (or rejected)
 - **auto_delete:** If true, the queue will be deleted when the last consumer stops consuming.
 - **durable:** If true, the queue will survive broker restarts, messages in the queue will only survive if they are published as persistent.
-- **prefetch:** Specify how many messages to prefetch for consumers (with no_ack is false)
+- **prefetch:** Specify how many messages to prefetch.
 - **arguments:** Custom arguments, such as queue-ttl etc.
 
-Params **durable**, **auto_delete** and **arguments** are optional, default values are:
-- **durable:** true
+Params **auto_ack**, **auto_delete**, **durable**, **prefetch** and **arguments** are optional, default values are:
+- **auto_ack:** true
 - **auto_delete:** false
+- **durable:** true
+- **prefetch:** 1
 - **arguments:** {}
 
 (Remember to register the queue class to the Schema, more details [here](#schema))
@@ -168,7 +170,7 @@ module Rabbits
             durable: true,
             prefetch: 1,
             arguments: {}
-      
+
       def consume(message)
         # do something with the message
       end
@@ -195,7 +197,7 @@ module Rabbits
     class MyQueue < ::Queues::Rabbit::Queue
       queue 'my.queue',
             auto_ack: false,
-      
+
       def consume(message)
         puts message.body
         message.ack
@@ -315,9 +317,9 @@ module Rabbits
             durable: true,
             prefetch: 1,
             arguments: {}
-      
+
       bind Rabbits::Exchanges::MyExchange, 'my.binding.key', arguments: {}
-      
+
       # ...
     end
   end
@@ -363,7 +365,7 @@ module Rabbits
                               durable: true,
                               internal: false,
                               arguments: {}
-      
+
       bind Rabbits::Exchanges::MyExchangeTwo, 'my.binding.key', arguments: {}
     end
   end
@@ -443,6 +445,15 @@ A good way to implement queues subscription is to use [Rails runners](https://gu
 rails runner -e production "Rabbits::Queues::MyQueue.subscribe"
 ```
 
+If you are running the queues in development mode, there could be some problems due to the Rails lazy loading. To solve this issue, you can add the following lines to `config/environments/development.rb`:
+
+```Ruby
+config.eager_load_paths += Dir["app/queues/**/*.rb"]
+ActiveSupport::Reloader.to_prepare do
+  Dir["app/queues/**/*.rb"].each { |f| require_dependency("#{Dir.pwd}/#{f}") }
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/LapoElisacci/queues-rabbit.

data/lib/generators/templates/queue.rb

@@ -7,7 +7,7 @@ module Rabbits
             auto_ack: false,    # Optional
             auto_delete: false, # Optional
             durable: true,      # Optional
-            prefetch: 1,        # Optional
+            prefetch: 1,        # Optional (it must be >= batch_size if batch_subscribe is called)
             arguments: {}       # Optional
 
       def consume(message)
@@ -16,6 +16,15 @@ module Rabbits
       rescue
         message.reject(requeue: false)
       end
+
+      def batch_consume(messages)
+        puts "Received #{messages.size} messages"
+        # do something with the messages
+        messages.each(&:ack)
+        puts "Acked #{messages.size} messages"
+      rescue
+        messages.each { |msg| msg.reject(requeue: false) }
+      end
     end
   end
 end

data/lib/queues/rabbit/client.rb

@@ -2,6 +2,9 @@
 
 module Queues
   module Rabbit
+    #
+    # AMQP::Client wrapper class
+    #
     class Client < AMQP::Client; end
   end
 end

data/lib/queues/rabbit/exchange.rb

@@ -6,6 +6,15 @@ module Queues
       class << self
         attr_accessor :arguments, :auto_delete, :durable, :internal, :name, :schema, :type
 
+        #
+        # Bind an Exchange to another Exchange
+        #
+        # @param [String] exchange Exchange name
+        # @param [String] binding_key Exchange binding key
+        # @param [Hash] arguments Message headers to match on (only relevant for header exchanges)
+        #
+        # @return [Boolean] True if bounded, false otherwise
+        #
         def bind(exchange, binding_key, arguments: {})
           exchange = exchange < Queues::Rabbit::Exchange ? exchange.name : exchange
           exchange_instance.bind(exchange, binding_key, arguments: arguments)
@@ -15,6 +24,11 @@ module Queues
           false
         end
 
+        #
+        # Delete an Exchange from RabbitMQ
+        #
+        # @return [Boolean] True if deleted, false otherwise
+        #
         def delete
           exchange_instance.delete
           true
@@ -23,6 +37,18 @@ module Queues
           false
         end
 
+        #
+        # Declare an Exchange
+        #
+        # @param [String] name Exchange name
+        # @param [String] type Exchange type
+        # @param [Hash] arguments Exchange custom arguments
+        # @param [Boolean] auto_delete If true, the exchange will be deleted when the last queue/exchange gets unbounded.
+        # @param [Boolean] durable If true, the exchange will persist between broker restarts, also a required for persistent messages.
+        # @param [Boolean] internal If true, the messages can't be pushed directly to the exchange.
+        #
+        # @return [Queues::Rabbit::Exchange] Exchange class
+        #
         def exchange(name, type, arguments: {}, auto_delete: false, durable: true, internal: false)
           self.arguments = arguments
           self.auto_delete = auto_delete
@@ -34,16 +60,8 @@ module Queues
           self
         end
 
-        def exchange_instance
-          @@exchange_instance ||= schema.client_instance.exchange(name, type, arguments: arguments, auto_delete: auto_delete, durable: durable, internal: internal)
-        end
-
-        def logger
-          @@logger ||= Queues::Rabbit::Logger.new(name, Queues::Rabbit.log_level)
-        end
-
         #
-        # <Description>
+        # Publish a message to the Exchange
         #
         # @param [String] body                                 The message body, can be a string or either a byte array
         # @param [String] routing_key                          The routing key to route the message to bounded queues
@@ -74,6 +92,15 @@ module Queues
           false
         end
 
+        #
+        # Unbind the Exchange from another Exchange
+        #
+        # @param [String] exchange The exchange name to unbind
+        # @param [String] binding_key The exchange binding key
+        # @param [Hash] arguments Message headers to match on (only relevant for header exchanges)
+        #
+        # @return [Boolean] True if unbound, false otherwise
+        #
         def unbind(exchange, binding_key, arguments: {})
           exchange = exchange < Queues::Rabbit::Exchange ? exchange.name : exchange
           exchange_instance.unbind(exchange, binding_key, arguments: arguments)
@@ -82,6 +109,26 @@ module Queues
           logger.error_with_report "Unable to unbind '#{name}' to '#{exchange}' with key '#{binding_key}' and arguments: '#{arguments}': #{e.message}."
           false
         end
+
+        private
+
+          #
+          # Return the Exchange instance
+          #
+          # @return [AMQP::Client::Exchange] Exchange instance
+          #
+          def exchange_instance
+            @@exchange_instance ||= schema.client_instance.exchange(name, type, arguments: arguments, auto_delete: auto_delete, durable: durable, internal: internal)
+          end
+
+          #
+          # Return the logger instance
+          #
+          # @return [Queues::Rabbit::Logger] Logger instance
+          #
+          def logger
+            @@logger ||= Queues::Rabbit::Logger.new(name, Queues::Rabbit.log_level)
+          end
       end
     end
   end

data/lib/queues/rabbit/logger.rb

@@ -12,11 +12,22 @@ module Queues
         @std.level = ::Logger::INFO
       end
 
+      #
+      # Log an error with attached report string.
+      #
+      # @param [String] message Message to log
+      #
       def error_with_report(message)
         @logger.error { message }
         @logger.error { 'Please report to https://github.com/LapoElisacci/queues-rabbit if needed.' }
       end
 
+      #
+      # Log the passed message to STDOUT
+      #
+      # @param [String] message Message to log
+      # @param [Symbol] level Log level
+      #
       def stdout(message, level = :info)
         @std.send(level, message)
       end

data/lib/queues/rabbit/message.rb

@@ -2,6 +2,9 @@
 
 module Queues
   module Rabbit
+    #
+    # AMQP::Client::Message wrapper class
+    #
     class Message < AMQP::Client::Message
       def initialize(message)
         message.instance_variables.each do |variable|

data/lib/queues/rabbit/queue.rb

@@ -6,6 +6,15 @@ module Queues
       class << self
         attr_accessor :arguments, :auto_delete, :durable, :name, :no_ack, :prefetch, :schema
 
+        #
+        # Bind a Queue to an Exchange
+        #
+        # @param [String] exchange Exchange name
+        # @param [String] binding_key Exchange binding key
+        # @param [Hash] arguments Message headers to match on (only relevant for header exchanges)
+        #
+        # @return [Boolean] True if bounded, false otherwise
+        #
         def bind(exchange, binding_key, arguments: {})
           exchange = exchange < Queues::Rabbit::Exchange ? exchange.name : exchange
           queue_instance.bind(exchange, binding_key, arguments: arguments)
@@ -15,6 +24,19 @@ module Queues
           false
         end
 
+        def consume(_message)
+          raise NoMethodError.new("Method #{__method__} must be defined to subscribe a queue!")
+        end
+
+        def batch_consume(_messages)
+          raise NoMethodError.new("Method #{__method__} must be defined to batch-subscribe a queue!")
+        end
+
+        #
+        # Delete a Queue from RabbitMQ
+        #
+        # @return [Boolean] True if delete, false otherwise
+        #
         def delete
           queue_instance.delete
           true
@@ -23,10 +45,18 @@ module Queues
           false
         end
 
-        def logger
-          @@logger ||= Queues::Rabbit::Logger.new(name, Queues::Rabbit.log_level)
-        end
-
+        #
+        # Declare a Queue
+        #
+        # @param [String] name Queue name
+        # @param [Hash] arguments Custom arguments, such as queue-ttl etc.
+        # @param [Boolean] auto_ack When false messages have to be manually acknowledged (or rejected)
+        # @param [Boolean] auto_delete If true, the queue will be deleted when the last consumer stops consuming.
+        # @param [Boolean] durable If true, the queue will survive broker restarts, messages in the queue will only survive if they are published as persistent.
+        # @param [Integer] prefetch Specify how many messages to prefetch
+        #
+        # @return [Queues::Rabbit::Queue] Queue class
+        #
         def queue(name, arguments: {}, auto_ack: true, auto_delete: false, durable: true, prefetch: 1)
           self.arguments = arguments
           self.auto_delete = auto_delete
@@ -37,12 +67,8 @@ module Queues
           self
         end
 
-        def queue_instance
-          @@queue_instance ||= schema.client_instance.queue(name, arguments: arguments, auto_delete: auto_delete, durable: durable)
-        end
-
         #
-        # <Description>
+        # Publish a message to the Queue
         #
         # @param [String] body                                The message body, can be a string or either a byte array
         # @param [Hash] properties Request properties
@@ -62,7 +88,7 @@ module Queues
         # @option properties [String] :type                    Can indicate what kind of message this is
         # @option properties [String] :user_id                 Used to identify the user that published the message
         #
-        # @return [Boolean] true if published, false otherwise
+        # @return [Boolean] True if published, false otherwise
         #
         def publish(body, **properties)
           queue_instance.publish(body, **properties)
@@ -72,6 +98,11 @@ module Queues
           false
         end
 
+        #
+        # Purge / Empty a queue from RabbitMQ
+        #
+        # @return [Boolean] True if purged, false otherwise
+        #
         def purge
           queue_instance.purge
           true
@@ -80,6 +111,9 @@ module Queues
           false
         end
 
+        #
+        # Subscribe to a Queue
+        #
         def subscribe
           logger.info { "Subscribing to queue #{name}" }
           consumer = new
@@ -99,6 +133,61 @@ module Queues
           false
         end
 
+        #
+        # Subscribe to the queue with a batch reading.
+        # This method will block.
+        #
+        # @param [Integer] batch_size Batch size
+        # @param [ActiveSupport::Duration] batch_timeout Batch timeout, that the time interval in which the batch will be emptied even if not full.
+        #
+        # @return [FalseClass] if errors
+        #
+        def batch_subscribe(batch_size:, batch_timeout:)
+          raise StandardError.new('Batch size must be a positive integer') if batch_size.to_i <= 0
+          raise StandardError.new("Batch size must be less or equal than prefetch: got batch_size=#{batch_size} and prefetch=#{prefetch}") if batch_size > prefetch
+
+          logger.info "Subscribing to queue #{name} with a batch size #{batch_size}"
+          consumer = new
+          batch = []
+          # Batched subscribe must be performed only by one thread
+          # Auto-acking is done manually, otherwise batching is not possible
+          queue_instance.subscribe(worker_threads: 1, no_ack: false, prefetch: prefetch) do |message|
+            if message.properties.type == 'timeout'
+              message.ack  # Remove the timeout message from the queue
+              min_batch_size = 0
+            else
+              batch << Queues::Rabbit::Message.new(message)
+              min_batch_size = batch_size
+            end
+            if batch.size > 0 && batch.size >= min_batch_size
+              batch.each(&:ack) if no_ack
+              consumer.batch_consume(batch)
+              batch = []
+            end
+          rescue Exception => e
+            logger.error { e.message }
+            logger.stdout e.message, :error
+          end
+
+          loop do
+            logger.stdout "Connection to #{name} alive."
+            sleep batch_timeout
+            queue_instance.publish('', type: 'timeout', persistent: false, espiration: 3.seconds)
+          end
+        rescue Exception => e
+          logger.error_with_report "Unable to connect to #{name}: #{e.message}."
+          false
+        end
+
+        #
+        # Unbind a Queue from an Exchange
+        #
+        # @param [String] exchange Exchange name
+        # @param [String] binding_key Exchange binding key
+        # @param [Hash] arguments Message headers to match on (only relevant for header exchanges)
+        #
+        # @return [Boolean] True if unbounded, false otherwise.
+        #
         def unbind(exchange, binding_key, arguments: {})
           exchange = exchange < Queues::Rabbit::Exchange ? exchange.name : exchange
           queue_instance.unbind(exhange, binding_key, arguments: arguments)
@@ -107,10 +196,26 @@ module Queues
           logger.error_with_report "Unable to unbind '#{name}' to '#{exchange}' with key '#{binding_key}' and arguments: '#{arguments}': #{e.message}."
           false
         end
-      end
 
-      def consume(_message)
-        raise NoMethodError.new("Method #{__method__} must be defined to subscribe a queue!")
+        private
+
+          #
+          # Return the logger instance
+          #
+          # @return [Queues::Rabbit::Logger] Logger instance
+          #
+          def logger
+            @@logger ||= Queues::Rabbit::Logger.new(name, Queues::Rabbit.log_level)
+          end
+
+          #
+          # Return the Queue instance
+          #
+          # @return [AMQP::Client::Client] Queue instance
+          #
+          def queue_instance
+            @@queue_instance ||= schema.client_instance.queue(name, arguments: arguments, auto_delete: auto_delete, durable: durable)
+          end
       end
     end
   end

data/lib/queues/rabbit/schema.rb

@@ -3,20 +3,34 @@
 module Queues
   module Rabbit
     class Schema
-      include ActiveModel::Model
       class << self
         attr_accessor :client, :exchanges, :queues
 
+        #
+        # Return the client instance
+        #
+        # @return [AMQP::Client] Client instance
+        #
         def client_instance
           @@client_instance ||= client.start
         end
 
+        #
+        # Register an Exchange
+        #
+        # @param [Queues::Rabbit::Exchange] klass Exchange class to register
+        #
         def exchange(klass)
           self.exchanges ||= []
           self.exchanges << klass
           klass.schema = self
         end
 
+        #
+        # Register a Queue
+        #
+        # @param [Queues::Rabbit::Queue] klass Queue class to register
+        #
         def queue(klass)
           self.queues ||= []
           self.queues << klass

data/lib/queues/rabbit/version.rb

@@ -2,6 +2,6 @@
 
 module Queues
   module Rabbit
-    VERSION = '0.1.0.beta'
+    VERSION = '0.1.0.beta.1'
   end
 end

data/lib/queues/rabbit.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_model'
 require 'active_support'
 require 'amqp-client'
 require 'logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queues-rabbit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.0.beta.1
 platform: ruby
 authors:
 - Lapo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp-client
@@ -38,7 +38,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.0.beta
-description: ''
+description: The gem allows you to integrate RabbitMQ into a Rails application in
+  a Ruby Style fashion.
 email:
 - lapoelisacci@gmail.com
 executables: []
@@ -91,5 +92,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: RabbitMQ Driver for Rails Queues
+summary: A Rails implementation of RabbitMQ
 test_files: []