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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ecb7575f981fcc564af562d2938d6cbf15d1b02f382b87aea516fb5e78b1c0f
-  data.tar.gz: 7a22c34478ecc86039a727085af54e71944f241caf032450ce8f593ffa20ce8b
+  metadata.gz: c930c4cfd93c6105dd18aa21506ec445a4474fda860b42c8efc8b591a612bd97
+  data.tar.gz: 386851ffc9733ecaab369562ad12b46dc5a53744b27d169dd5d52369174def7f
 SHA512:
-  metadata.gz: 890ac13fa7258b55eb6a20a8d4eb64c6dffa42b847772ebe141ce77c1c1560f4086e8aa23f22250b0e72529d18cb99b25b2ed7f590bbeb6e4849fb8ea6a2b43a
-  data.tar.gz: afb3f5467d0af7f99ed3336e62ec7eaac6b500573605fa0b1a26e2b0f7db8930feedc66436c1b4c08cb8369b3b8fa18e2b80d9d51419200660b83f39a43649f1
+  metadata.gz: 513a088c0cb63c77e629a1f68d84c10978a28f646d564b0d71e6d6a478b3ead1d7cdebd06679b711dd296a06943cdad6d6e6bfe01a37e86db5a4d468b4b49186
+  data.tar.gz: d90d46e6e55fb2499c33bd8bb5d37a30306d4c8e1a938a481e44769efd04e7d856a685311a77a0738546c7fc85ad8c16cf924874f405d0275f90c26819f76d89

data/CHANGELOG.md

@@ -1,3 +1,5 @@
-## [0.1.0.beta] - 2022-03-01
+## [Unreleased]
 
-- Initial beta release
+## [0.1.0] - 2022-02-25
+
+- Initial release

data/README.md

@@ -1,8 +1,8 @@
-# <img src="https://user-images.githubusercontent.com/50866745/156147715-d3773642-68c0-48c0-92ad-0ccc442ee881.svg" width="48"> Rails-Queues Rabbit
-![](https://img.shields.io/static/v1?label=Language&message=Ruby&color=red)
-![](https://img.shields.io/static/v1?label=Latest&message=0.1.0.beta&color=blue)
+# Queues::Rabbit
 
-A Rails implementation of [RabbitMQ](https://www.rabbitmq.com/)
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/queues/rabbit`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -14,453 +14,25 @@ gem 'queues-rabbit'
 
 And then execute:
 
-```
-bundle install
-```
-
-## Getting Started
-
-The gem gets shipped with a scaffolding generator.
-
-```
-rails generate queues_rabbit
-```
-
-## Table of contents
-
-* [Architecture](#architecture)
-* [Rails Queues](#rails-queues)
-* [Schema](#schema)
-* [Queues](#queues)
-    * [Definition](#queue-definition)
-    * [Subscribing](#subscribing-a-queue)
-    * [Publishing](#publishing-to-queues)
-    * [Purge](#purge-a-queue)
-    * [Delete](#delete-a-queue)
-* [Exchanges](#exchanges)
-    * [Definition](#exchange-definition)
-    * [Queue Binding](#queue-binding)
-    * [Queue Unbinding](#queue-unbinding)
-    * [Exchange Binding](#exchange-binding)
-    * [Exchange Unbinding](#exchange-unbinding)
-    * [Publishing](#publishing-to-an-exchange)
-    * [Delete](#delete-an-exchange)
-* [Logging](#logging)
-* [Usage Tips](#usage-tips)
-
-
-## Architecture
-
-The framework consists of a Schema where you can register your RabbitMQ Queues and Exchanges.
-
-```
-app
-└── queues
-    ├── application_queue.rb
-    └── rabbit
-        ├── exchanges
-        │   └── my_exchange.rb
-        ├── queues
-        │   └── my_queue.rb
-        └── schema.rb
-```
-
-## Rails-Queues
-
-The gem belongs to the [Rails-Queues](https://github.com/LapoElisacci/queues) framework.
-
-To initialize your RabbitMQ schema, add it to the `ApplicationQueue` class.
-
-```Ruby
-class ApplicationQueue < Queues::API
-  rabbit Rabbits::Schema, 'amqp://guest:guest@localhost'
-end
-```
-
-You can have as many RabbitMQ instances to connect to as you want.
-
-Each RabbitMQ instance must be attached to a specific Schema.
-
-```Ruby
-class ApplicationQueue < Queues::API
-  rabbit Rabbits::SchemaOne, 'amqp://guest:guest@localhost1'
-  rabbit Rabbits::SchemaTwo, 'amqp://guest:guest@localhost2'
-end
-```
-
-## Schema
-
-The Schema allows you to regiter both the queues and the exchanges.
-
-```Ruby
-module Rabbits
-  class Schema < ::Queues::Rabbit::Schema
-    queue Rabbits::Queues::MyQueue
-    exchange Rabbits::Queues::MyExchange
-  end
-end
-```
-
-You can register as many queues and exchanges as you need.
-
-```Ruby
-module Rabbits
-  class Schema < ::Queues::Rabbit::Schema
-    queue Rabbits::Queues::MyQueueOne
-    exchange Rabbits::Queues::MyExchangeOne
-
-    queue Rabbits::Queues::MyQueueTwo
-    exchange Rabbits::Queues::MyExchangeTwo
-  end
-end
-```
-
-## Queues
-
-Each queue can be declared by a class that inherits from `Queues::Rabbit::Queue`
-
-### Queue Definition
-
-```Ruby
-module Rabbits
-  module Queues
-    class MyQueue < ::Queues::Rabbit::Queue
-      queue 'my.queue',
-            auto_ack: true,
-            auto_delete: false,
-            durable: true,
-            prefetch: 1,
-            arguments: {}
-
-      # ...
-    end
-  end
-end
-```
-
-The `queue` method allows you to define the RabbitMQ queue parameters.
-
-- The queue name
-- **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.
-- **arguments:** Custom arguments, such as queue-ttl etc.
-
-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:** {}
+    $ bundle install
 
-(Remember to register the queue class to the Schema, more details [here](#schema))
+Or install it yourself as:
 
-### Subscribing a queue
+    $ gem install queues-rabbit
 
-To compute a message when it gets received, define a method called `consume` inside your queue Class, like so:
+## Usage
 
-```Ruby
-module Rabbits
-  module Queues
-    class MyQueue < ::Queues::Rabbit::Queue
-      queue 'my.queue',
-            auto_ack: true,
-            auto_delete: false,
-            durable: true,
-            prefetch: 1,
-            arguments: {}
+TODO: Write usage instructions here
 
-      def consume(message)
-        # do something with the message
-      end
-    end
-  end
-end
-```
-
-The messange param is a `Queues::Rabbit::Message` instance where you can access the following properties:
-
-- **body:** The message body.
-- **consumer_tag:** The RabbitMQ consumer associated tag.
-- **delivery_tag:** The RabbitMQ delivery tag.
-- **exchange:** The exchange name (Empty for default exchange).
-
-The `Queues::Rabbit::Message` also implements a few interesting methods:
-
-- **ack:** Allows you to manually acknoledge the message (When **auto_ack** is set to **false**)
-- **reject:** Allows you to manually reject a message (it accepts an argument **requeue** that if true the message will be put back into the queue)
-
-```Ruby
-module Rabbits
-  module Queues
-    class MyQueue < ::Queues::Rabbit::Queue
-      queue 'my.queue',
-            auto_ack: false,
-
-      def consume(message)
-        puts message.body
-        message.ack
-      rescue
-        message.reject(requeue: false)
-      end
-    end
-  end
-end
-```
+## Development
 
-### WARNING
-
-The **consume** method will get executed inside a separated thread, make sure it's threadsafe!
-
-After defining the **consume** method, to subscribe the queue call the, call the **subscribe** method, like so:
-
-```Ruby
-Rabbits::Queues::MyQueue.subscribe
-```
-
-The method won't return until the connection gets closed.
-Aliveness logs will get printed to **STDOUT**.
-
-### Publishing to queues
-
-To publish a message into a declared queue, call the **publish** method:
-
-```Ruby
-Rabbits::Queues::MyQueue.publish({ foo: 'bar' }.to_json, content_type: 'application/json')
-```
-
-The **publish** method accepts several options, here's the method documentation:
-
-```Ruby
-# @param [String] body                                The message body, can be a string or either a byte array
-# @param [Hash] properties Request properties
-# @option properties [String] :app_id                  Used to identify the app that generated the message
-# @option properties [String] :content_encoding        Content encoding of the body
-# @option properties [String] :content_type            Content type of the body
-# @option properties [Integer] :correlation_id         The correlation id, mostly used used for RPC communication
-# @option properties [Integer] :delivery_mode          2 for persistent messages, all other values are for transient messages
-# @option properties [Integer, String] :expiration     Number of seconds the message will stay in the queue
-# @option properties [Hash<String, Object>] :headers   Custom headers
-# @option properties [Boolean] :mandatory              The message will be returned if the message can't be routed to a queue
-# @option properties [String] :message_id              Can be used to uniquely identify the message, e.g. for deduplication
-# @option properties [Boolean] :persistent             Same as delivery_mode: 2
-# @option properties [Integer] :priority               The message priority (between 0 and 255)
-# @option properties [String] :reply_to                Queue to reply RPC responses to
-# @option properties [Date] :timestamp                 Often used for the time the message was originally generated
-# @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
-#
-def publish(body, **properties)
-```
-
-### Purge a queue
-
-To purge all messages from a defined queue, call the **purge** method, like so:
-
-```Ruby
-Rabbits::Queues::MyQueue.purge
-```
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-### Delete a queue
-
-To delete a queue from RabbitMQ, call the **delete** method, like so:
-
-```Ruby
-Rabbits::Queues::MyQueue.delete
-```
-
-## Exchanges
-
-Just like queues, exchanges must be declared by a class that inherits, this time, from `Queues::Rabbit::Exchange`
-
-### Exchange Definition
-
-```Ruby
-module Rabbits
-  module Exchanges
-    class MyExchange < ::Queues::Rabbit::Exchange
-      exchange 'my.exchange', 'direct',
-                              auto_delete: false,
-                              durable: true,
-                              internal: false,
-                              arguments: {}
-    end
-  end
-end
-```
-
-The `exchange` method allows you to define the exchange parameters.
-
-- The exchange name
-- The exchange type ('direct', 'fanout', 'headers', 'topic' ...)
-- **auto_delete:** If true, the exchange will be deleted when the last queue/exchange gets unbounded.
-- **durable:** If true, the exchange will persist between broker restarts, also a required for persistent messages.
-- **internal:** If true, the messages can't be pushed directly to the exchange.
-- **arguments:** Custom exchange arguments.
-
-(Remember to register the exchange class to the Schema, more details [here](#schema))
-
-### Queue binding
-
-To bind a queue to an exchange, call the **bind** method inside the queue class, like so:
-
-```Ruby
-module Rabbits
-  module Queues
-    class MyQueue < ::Queues::Rabbit::Queue
-      queue 'my.queue',
-            auto_ack: true,
-            auto_delete: false,
-            durable: true,
-            prefetch: 1,
-            arguments: {}
-
-      bind Rabbits::Exchanges::MyExchange, 'my.binding.key', arguments: {}
-
-      # ...
-    end
-  end
-end
-```
-
-You can also statically declare the exchange name, like so:
-
-```Ruby
-bind 'my.exchange', 'my.binding.key', arguments: {}
-```
-
-The `bind` method allows you to define the queue-exchange binding parameters.
-
-- The exchange name
-- The binding key
-- **arguments:** Message headers to match on (only relevant for header exchanges)
-
-### Queue unbinding
-
-To unbind a queue from an exchange call the **unbind** method, like so:
-
-```Ruby
-Rabbits::Queues::MyQueue.unbind(Rabbits::Exchanges::MyExchange, 'my.binding.key', arguments: {})
-```
-
-or
-
-```Ruby
-Rabbits::Queues::MyQueue.unbind('my.exchange', 'my.binding.key', arguments: {})
-```
-
-### Exchange binding
-
-To bind an exchange to another exchange, call the **bind** method inside the exchange class, like so:
-
-```Ruby
-module Rabbits
-  module Exchanges
-    class MyExchange < ::Queues::Rabbit::Exchange
-      exchange 'my.exchange', 'direct',
-                              auto_delete: false,
-                              durable: true,
-                              internal: false,
-                              arguments: {}
-
-      bind Rabbits::Exchanges::MyExchangeTwo, 'my.binding.key', arguments: {}
-    end
-  end
-end
-```
-
-### Exchange unbinding
-
-To unbind an exchange from another exchange call the **unbind** method, like so:
-
-```Ruby
-Rabbits::Exchanges::MyExchange.unbind(Rabbits::Exchanges::MyExchangeTwo, 'my.binding.key', arguments: {})
-```
-
-or
-
-```Ruby
-Rabbits::Exchanges::MyExchange.unbind('my.exchange.two', 'my.binding.key', arguments: {})
-```
-
-### Publishing to an exchange
-
-To publish a message to an exchange call the **publish** method, like so:
-
-```Ruby
-Rabbits::Exchanges::MyExchange.publish('my message', 'my.routing.key', properties: {})
-```
-
-The **publish** method accepts several options, here's the method documentation:
-
-```Ruby
-# @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
-# @param [Hash] properties Request properties
-# @option properties [String] :app_id                  Used to identify the app that generated the message
-# @option properties [String] :content_encoding        Content encoding of the body
-# @option properties [String] :content_type            Content type of the body
-# @option properties [Integer] :correlation_id         The correlation id, mostly used used for RPC communication
-# @option properties [Integer] :delivery_mode          2 for persistent messages, all other values are for transient messages
-# @option properties [Integer, String] :expiration     Number of seconds the message will stay in the queue
-# @option properties [Hash<String, Object>] :headers   Custom headers
-# @option properties [Boolean] :mandatory              The message will be returned if the message can't be routed to a queue
-# @option properties [String] :message_id              Can be used to uniquely identify the message, e.g. for deduplication
-# @option properties [Boolean] :persistent             Same as delivery_mode: 2
-# @option properties [Integer] :priority               The message priority (between 0 and 255)
-# @option properties [String] :reply_to                Queue to reply RPC responses to
-# @option properties [Date] :timestamp                 Often used for the time the message was originally generated
-# @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
-#
-def publish(body, routing_key, **properties)
-```
-
-### Delete an exchange
-
-To delete an exchange from RabbitMQ call the **delete** method, like so:
-
-```Ruby
-Rabbits::Exchanges::MyExchange.delete
-```
-
-## Logging
-
-Queues and Exchanges have a built-in logger.
-
-Each queue and each exchange will have its log file inside the `log` directory. The filename will match the queue/exchange name.
-
-While [consuming messages from a queue](#subscribing-a-queue), logs will also get pushed to `STDOUT`.
-
-## Usage tips
-
-A good way to implement queues subscription is to use [Rails runners](https://guides.rubyonrails.org/command_line.html#bin-rails-runner) to spawn a specific process for each connection.
-
-```Bash
-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
-```
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/LapoElisacci/queues-rabbit.
-
-## Credits
-
-The gem is based on the amazing RabbitMQ client by [cloudamqp](https://github.com/cloudamqp/amqp-client.rb).
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/queues-rabbit.
 
 ## License
 

data/lib/queues/rabbit/version.rb

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

data/lib/queues/rabbit.rb

@@ -1,30 +1,10 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'amqp-client'
-require 'logger'
-
-require_relative 'rabbit/client'
-require_relative 'rabbit/exchange'
-require_relative 'rabbit/logger'
-require_relative 'rabbit/message'
-require_relative 'rabbit/queue'
-require_relative 'rabbit/schema'
-require_relative 'rabbit/version'
+require_relative "rabbit/version"
 
 module Queues
   module Rabbit
     class Error < StandardError; end
-
-    class << self
-      attr_accessor :client, :logger, :log_level, :schema
-
-      def configure(schema_klass, host, log_level: ::Logger::INFO)
-        self.log_level = log_level
-        self.schema = schema_klass
-        schema.client = Queues::Rabbit::Client.new(host)
-        self
-      end
-    end
+    # Your code goes here...
   end
 end

metadata

@@ -1,45 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: queues-rabbit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta.1
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Lapo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: amqp-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: queues
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.0.beta
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.0.beta
-description: The gem allows you to integrate RabbitMQ into a Rails application in
-  a Ruby Style fashion.
+date: 2022-02-25 00:00:00.000000000 Z
+dependencies: []
+description: ''
 email:
 - lapoelisacci@gmail.com
 executables: []
@@ -50,21 +21,10 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/queues_rabbit_generator.rb
-- lib/generators/templates/exchange.rb
-- lib/generators/templates/queue.rb
-- lib/generators/templates/schema.rb
 - lib/queues/rabbit.rb
-- lib/queues/rabbit/client.rb
-- lib/queues/rabbit/exchange.rb
-- lib/queues/rabbit/logger.rb
-- lib/queues/rabbit/message.rb
-- lib/queues/rabbit/queue.rb
-- lib/queues/rabbit/schema.rb
 - lib/queues/rabbit/version.rb
 - sig/queues/rabbit.rbs
 homepage: https://github.com/LapoElisacci/queues.git
@@ -92,5 +52,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: A Rails implementation of RabbitMQ
+summary: RabbitMQ Driver for Rails Queues
 test_files: []

data/Gemfile.lock

@@ -1,201 +0,0 @@
-PATH
-  remote: .
-  specs:
-    queues-rabbit (0.1.0.pre)
-      amqp-client (~> 1)
-      queues (= 0.1.0.beta)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      actionview (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.2.2)
-      actionview (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.2.2)
-      activesupport (= 7.0.2.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.2.2)
-      activesupport (= 7.0.2.2)
-      globalid (>= 0.3.6)
-    activemodel (7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activerecord (7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activestorage (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    amqp-client (1.1.4)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.9)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    digest (3.1.0)
-    erubi (1.10.0)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    io-wait (0.2.1)
-    loofah (2.14.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.15.0)
-    net-imap (0.2.3)
-      digest
-      net-protocol
-      strscan
-    net-pop (0.1.1)
-      digest
-      net-protocol
-      timeout
-    net-protocol (0.1.2)
-      io-wait
-      timeout
-    net-smtp (0.3.1)
-      digest
-      net-protocol
-      timeout
-    nio4r (2.5.8)
-    nokogiri (1.13.3-x86_64-darwin)
-      racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    queues (0.1.0.beta)
-      rails (>= 5)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.2.2)
-      actioncable (= 7.0.2.2)
-      actionmailbox (= 7.0.2.2)
-      actionmailer (= 7.0.2.2)
-      actionpack (= 7.0.2.2)
-      actiontext (= 7.0.2.2)
-      actionview (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      bundler (>= 1.15.0)
-      railties (= 7.0.2.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.25.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    strscan (3.0.1)
-    thor (1.2.1)
-    timeout (0.2.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
-
-PLATFORMS
-  x86_64-darwin-20
-
-DEPENDENCIES
-  queues-rabbit!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-
-BUNDLED WITH
-   2.3.7

data/lib/generators/queues_rabbit_generator.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-# Creates the Queues initializer file for Rails apps.
-#
-# @example Invokation from terminal
-#   rails generate queues_rabbit
-#
-class QueuesRabbitGenerator < Rails::Generators::Base
-  desc "Description:\n  This prepares Rails for RabbitMQ Queues"
-
-  source_root File.expand_path('templates', __dir__)
-
-  desc 'Initialize Rails for RabbitMQ Queues'
-
-  def generate_layout
-    if !File.exist?('app/queues/application_queue.rb')
-      generate 'queues'
-    end
-
-    template 'schema.rb', 'app/queues/rabbits/schema.rb'
-    template 'queue.rb', 'app/queues/rabbits/queues/my_queue.rb'
-    template 'exchange.rb', 'app/queues/rabbits/exchanges/my_exchange.rb'
-  end
-end

data/lib/generators/templates/exchange.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Rabbits
-  module Exchanges
-    class MyExchange < ::Queues::Rabbit::Exchange
-      exchange 'my.exchange', 'direct',           # Required
-                              durable: true,      # Optional
-                              auto_delete: false, # Optional
-                              internal: false,    # Optional
-                              arguments: {}       # Optional
-    end
-  end
-end

data/lib/generators/templates/queue.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Rabbits
-  module Queues
-    class MyQueue < ::Queues::Rabbit::Queue
-      queue 'my.queue',         # Required
-            auto_ack: false,    # Optional
-            auto_delete: false, # Optional
-            durable: true,      # Optional
-            prefetch: 1,        # Optional (it must be >= batch_size if batch_subscribe is called)
-            arguments: {}       # Optional
-
-      def consume(message)
-        # do something with the message
-        message.ack
-      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/generators/templates/schema.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Rabbits
-  class Schema < ::Queues::Rabbit::Schema
-    queue Rabbits::Queues::MyQueue
-    exchange Rabbits::Exchanges::MyExchange
-  end
-end

data/lib/queues/rabbit/client.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Queues
-  module Rabbit
-    #
-    # AMQP::Client wrapper class
-    #
-    class Client < AMQP::Client; end
-  end
-end

data/lib/queues/rabbit/exchange.rb

@@ -1,135 +0,0 @@
-# frozen_string_literal: true
-
-module Queues
-  module Rabbit
-    class Exchange
-      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)
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to bind '#{name}' to '#{exchange}' with key '#{binding_key}' and arguments: '#{arguments}': #{e.message}."
-          false
-        end
-
-        #
-        # Delete an Exchange from RabbitMQ
-        #
-        # @return [Boolean] True if deleted, false otherwise
-        #
-        def delete
-          exchange_instance.delete
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to delete #{name}: #{e.message}."
-          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
-          self.name = name
-          self.durable = durable
-          self.internal = internal
-          self.name = name
-          self.type = type
-          self
-        end
-
-        #
-        # 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
-        # @param [Hash] properties Request properties
-        # @option properties [String] :app_id                  Used to identify the app that generated the message
-        # @option properties [String] :content_encoding        Content encoding of the body
-        # @option properties [String] :content_type            Content type of the body
-        # @option properties [Integer] :correlation_id         The correlation id, mostly used used for RPC communication
-        # @option properties [Integer] :delivery_mode          2 for persistent messages, all other values are for transient messages
-        # @option properties [Integer, String] :expiration     Number of seconds the message will stay in the queue
-        # @option properties [Hash<String, Object>] :headers   Custom headers
-        # @option properties [Boolean] :mandatory              The message will be returned if the message can't be routed to a queue
-        # @option properties [String] :message_id              Can be used to uniquely identify the message, e.g. for deduplication
-        # @option properties [Boolean] :persistent             Same as delivery_mode: 2
-        # @option properties [Integer] :priority               The message priority (between 0 and 255)
-        # @option properties [String] :reply_to                Queue to reply RPC responses to
-        # @option properties [Date] :timestamp                 Often used for the time the message was originally generated
-        # @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
-        #
-        def publish(body, routing_key, **properties)
-          exchange_instance.publish(body, name, routing_key, **properties)
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to publish to #{name}: #{e.message}."
-          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)
-          true
-        rescue Exception => e
-          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
-end

data/lib/queues/rabbit/logger.rb

@@ -1,36 +0,0 @@
-# frozen_string_litteral: true
-
-module Queues
-  module Rabbit
-    class Logger
-      delegate :unknown, :fatal, :error,  :warn, :info, :debug, to: :@logger
-
-      def initialize(name, level)
-        @logger = ::Logger.new("log/#{name}.log")
-        @logger.level = level
-        @std = ::Logger.new(STDOUT)
-        @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
-    end
-  end
-end

data/lib/queues/rabbit/message.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Queues
-  module Rabbit
-    #
-    # AMQP::Client::Message wrapper class
-    #
-    class Message < AMQP::Client::Message
-      def initialize(message)
-        message.instance_variables.each do |variable|
-          instance_variable_set(variable, message.instance_variable_get(variable))
-        end
-      end
-    end
-  end
-end

data/lib/queues/rabbit/queue.rb

@@ -1,222 +0,0 @@
-# frozen_string_literal: true
-
-module Queues
-  module Rabbit
-    class Queue
-      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)
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to bind '#{name}' to '#{exchange}' with key '#{binding_key}' and arguments: '#{arguments}': #{e.message}."
-          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
-        rescue Exception => e
-          logger.error_with_report "Unable to delete #{name}: #{e.message}."
-          false
-        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
-          self.durable = durable
-          self.name = name
-          self.no_ack = auto_ack
-          self.prefetch = prefetch
-          self
-        end
-
-        #
-        # 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
-        # @option properties [String] :app_id                  Used to identify the app that generated the message
-        # @option properties [String] :content_encoding        Content encoding of the body
-        # @option properties [String] :content_type            Content type of the body
-        # @option properties [Integer] :correlation_id         The correlation id, mostly used used for RPC communication
-        # @option properties [Integer] :delivery_mode          2 for persistent messages, all other values are for transient messages
-        # @option properties [Integer, String] :expiration     Number of seconds the message will stay in the queue
-        # @option properties [Hash<String, Object>] :headers   Custom headers
-        # @option properties [Boolean] :mandatory              The message will be returned if the message can't be routed to a queue
-        # @option properties [String] :message_id              Can be used to uniquely identify the message, e.g. for deduplication
-        # @option properties [Boolean] :persistent             Same as delivery_mode: 2
-        # @option properties [Integer] :priority               The message priority (between 0 and 255)
-        # @option properties [String] :reply_to                Queue to reply RPC responses to
-        # @option properties [Date] :timestamp                 Often used for the time the message was originally generated
-        # @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
-        #
-        def publish(body, **properties)
-          queue_instance.publish(body, **properties)
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to publish to #{name}: #{e.message}."
-          false
-        end
-
-        #
-        # Purge / Empty a queue from RabbitMQ
-        #
-        # @return [Boolean] True if purged, false otherwise
-        #
-        def purge
-          queue_instance.purge
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to purge #{name}: #{e.message}."
-          false
-        end
-
-        #
-        # Subscribe to a Queue
-        #
-        def subscribe
-          logger.info { "Subscribing to queue #{name}" }
-          consumer = new
-          queue_instance.subscribe(no_ack: no_ack, prefetch: prefetch) do |message|
-            consumer.consume(Queues::Rabbit::Message.new(message))
-          rescue Exception => e
-            logger.error { e.message }
-            logger.stdout e.message, :error
-          end
-
-          loop do
-            logger.stdout "Connection to #{name} alive."
-            sleep 10
-          end
-        rescue Exception => e
-          logger.error_with_report "Unable to connect to #{name}: #{e.message}."
-          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)
-          true
-        rescue Exception => e
-          logger.error_with_report "Unable to unbind '#{name}' to '#{exchange}' with key '#{binding_key}' and arguments: '#{arguments}': #{e.message}."
-          false
-        end
-
-        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
-end

data/lib/queues/rabbit/schema.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Queues
-  module Rabbit
-    class Schema
-      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
-          klass.schema = self
-        end
-      end
-    end
-  end
-end