rabbitmq-actors 2.0.0

data/lib/rabbitmq/actors/patterns/topics/topic_consumer.rb

@@ -0,0 +1,105 @@
+require_relative '../../base/consumer'
+
+module RabbitMQ
+  module Actors
+    # A consumer of messages from RabbitMQ based on exchange and routing key matching patterns.
+    # @abstract Subclass and override #perform to define your customized topic worker class.
+    #
+    # @example
+    #   class SpainTennisListener < RabbitMQ::Actors::TopicConsumer
+    #     def initialize
+    #       super(topic_name:      'sports',
+    #             binding_keys:    '#.tennis.#.spain.#',
+    #             logger:          Rails.logger,
+    #             on_cancellation: ->{ ActiveRecord::Base.connection.close })
+    #     end
+    #
+    #     private
+    #
+    #     def perform(**task)
+    #       match_data = JSON.parse(task[:body])
+    #       process_tennis_match(match_data)
+    #     end
+    #
+    #     def process_tennis_match(data)
+    #       ...
+    #     end
+    #   end
+    #
+    #   class AmericaSoccerListener < RabbitMQ::Actors::TopicConsumer
+    #     def initialize
+    #       super(exchange_name:   'sports',
+    #             binding_keys:    '#.soccer.#.america.#',
+    #             logger:          Rails.logger,
+    #             on_cancellation: ->{ ActiveRecord::Base.connection.close })
+    #     end
+    #
+    #     private
+    #
+    #     def perform(**task)
+    #       match_data = JSON.parse(task[:body])
+    #       process_soccer_match(match_data)
+    #     end
+    #
+    #     def process_soccer_match(data)
+    #       ...
+    #     end
+    #   end
+    #
+    #   RabbitMQ::Server.url = 'amqp://localhost'
+    #
+    #   SpainTennisListener.new.start!
+    #   AmericaSoccerListener.new.start!
+    #
+    class TopicConsumer < Base::Consumer
+      # @!attribute [r] topic_name
+      #   @return [Bunny::Exchange] the topic exchange where to get messages from.
+      attr_reader :topic_name
+
+      # @!attribute [r] binding_keys
+      #   @return [String, Array] the routing key patterns this worker is interested in.
+      attr_reader :binding_keys
+
+      # @param :topic_name   [String] name of the topic exchange this worker will receive messages.
+      # @param :binding_keys [String, Array] routing key patterns this worker is interested in.
+      #   Default to all: '#'
+      # @option opts [Proc] :on_cancellation to be executed before the worker is terminated
+      # @option opts [Logger] :logger the logger where to output info about this agent's activity.
+      # Rest of options required by your subclass.
+      def initialize(topic_name:, binding_keys: '#', **opts)
+        super(opts.merge(topic_name: topic_name, binding_keys: binding_keys))
+      end
+
+      private
+
+      # Set topic exchange_name and binding_keys this worker is bound to.
+      # @see #initialize for the list of options that can be received.
+      def pre_initialize(**opts)
+        @topic_name   = opts[:topic_name]
+        @binding_keys = Array(opts[:binding_keys])
+        super
+      end
+
+      # Bind this worker's queue to the topic exchange and to the given binding_key patterns
+      # @see #initialize for the list of options that can be received.
+      def post_initialize(**opts)
+        bind_queue_to_exchange_routing_keys
+        super
+      end
+
+      # The durable RabbitMQ topic exchange from where messages are received
+      # @return [Bunny::Exchange]
+      def exchange
+        @exchange ||= channel.topic(topic_name, durable: true)
+      end
+
+      # Bind this worker's listening queue to the topic exchange and receive only messages with routing key
+      # matching the patterns in binding_keys.
+      def bind_queue_to_exchange_routing_keys
+        binding_keys.each do |key|
+          queue.bind(exchange, routing_key: key)
+        end
+      end
+    end
+  end
+end

data/lib/rabbitmq/actors/patterns/topics/topic_producer.rb

@@ -0,0 +1,64 @@
+require_relative '../../base/producer'
+
+module RabbitMQ
+  module Actors
+    # A producer of messages routed to all the queues bound to the message's routing_key via matching patterns
+    #
+    # @example
+    #   RabbitMQ::Server.url = 'amqp://localhost'
+    #
+    #   publisher = RabbitMQ::Actors::TopicProducer.new(topic_name: 'weather', logger: Rails.logger)
+    #   message   = { temperature: 20, rain: 30%, wind: 'NorthEast' }.to_json
+    #   publisher.publish(message, message_id: '1234837633', content_type: "application/json", routing_key: 'Europe.Spain.Madrid')
+    #
+    class TopicProducer < Base::Producer
+      # @!attribute [r] topic_name
+      #   @return [Bunny::Exchange] the topic exchange where to publish messages.
+      attr_reader :topic_name
+
+      # @param :topic_name [String] name of the topic exchange where to send messages to.
+      # @option opts [String] :reply_queue_name the name of the queue where a consumer should reply.
+      # @option opts [Logger] :logger the logger where to output info about this agent's activity.
+      def initialize(topic_name:, **opts)
+        super(opts.merge(topic_name: topic_name))
+      end
+
+      # Send a message to the RabbitMQ server.
+      # @param message [String] the message body to be sent.
+      # @param :message_id [String] user-defined id for replies to refer to this message using :correlation_id
+      # @param :routing_key [String] send the message only to queues bound to this exchange and matching this routing_key
+      # @see Bunny::Exchange#publish for extra options:
+      # @option opts [Boolean] :persistent Should the message be persisted to disk?. Default true.
+      # @option opts [Boolean] :mandatory Should the message be returned if it cannot be routed to any queue?
+      # @option opts [Integer] :timestamp A timestamp associated with this message
+      # @option opts [Integer] :expiration Expiration time after which the message will be deleted
+      # @option opts [String]  :type Message type, e.g. what type of event or command this message represents. Can be any string
+      # @option opts [String]  :reply_to Queue name other apps should send the response to. Default to
+      #   replay_queue_name if it was defined at creation time.
+      # @option opts [String]  :content_type Message content type (e.g. application/json)
+      # @option opts [String]  :content_encoding Message content encoding (e.g. gzip)
+      # @option opts [String]  :correlation_id Message correlated to this one, e.g. what request this message is a reply for
+      # @option opts [Integer] :priority Message priority, 0 to 9. Not used by RabbitMQ, only applications
+      # @option opts [String]  :user_id Optional user ID. Verified by RabbitMQ against the actual connection username
+      # @option opts [String]  :app_id Optional application ID
+      def publish(message, message_id:, routing_key:, **opts)
+        super(message, opts.merge(message_id: message_id, routing_key: routing_key))
+      end
+
+      private
+
+      # Sets the exchange name to connect to.
+      # @see #initialize for the list of options that can be received.
+      def pre_initialize(**opts)
+        @topic_name = opts[:topic_name]
+        super
+      end
+
+      # The durable RabbitMQ topic exchange where to publish messages.
+      # @return [Bunny::Exchange]
+      def exchange
+        @exchange ||= channel.topic(topic_name, durable: true)
+      end
+    end
+  end
+end

data/lib/rabbitmq/actors/testing.rb

@@ -0,0 +1,8 @@
+module RabbitMQ
+  module Actors
+    module Testing
+    end
+  end
+end
+
+require_relative 'testing/rspec' if defined?(RSpec)

data/lib/rabbitmq/actors/testing/rspec.rb

@@ -0,0 +1,8 @@
+if RSpec.respond_to?(:configure)
+  require_relative 'rspec/stub'
+
+  RSpec.configure do |config|
+    config.extend  RabbitMQ::Actors::Testing::Rspec::Stub
+    config.include RabbitMQ::Actors::Testing::Rspec::Stub
+  end
+end

data/lib/rabbitmq/actors/testing/rspec/stub.rb

@@ -0,0 +1,52 @@
+module RabbitMQ
+  module Actors
+    module Testing
+      module Rspec
+
+        module Stub
+          # This is a macro available in your rspec tests to stub the RabbitMQ server
+          # and Bunny objects associated to it.
+          #
+          # describe MyListener do
+          #   stub_rabbitmq!
+          #
+          #   context "..."  do
+          #     ...
+          #   end
+          # end
+          def stub_rabbitmq!
+            let(:default_exchange) { double(publish: :published, on_return: :on_returned, type: :direct) }
+            let(:channel)          { double(prefetch: true, ack: true, default_exchange: default_exchange, close: true) }
+            let(:connection)       { double(create_channel: channel).as_null_object }
+
+            before do
+              allow(channel).to receive(:queue) do |name, durable:, auto_delete:, exclusive:|
+                double(name: name, durable: durable.present?, durable?: durable.present?,
+                       auto_delete: auto_delete.present?, auto_delete?: auto_delete.present?,
+                       exclusive: exclusive.present?, exclusive?: exclusive.present?, bind: :bound)
+              end
+
+              allow(channel).to receive(:direct) do |name|
+                double(name: name, publish: :published, type: :direct)
+              end
+
+              allow(channel).to receive(:fanout) do |name|
+                double(name: name, publish: :published, type: :fanout)
+              end
+
+              allow(channel).to receive(:topic) do |name|
+                double(name: name, publish: :published, type: :topic)
+              end
+
+              allow(channel).to receive(:headers) do |name|
+                double(name: name, publish: :published, type: :headers)
+              end
+
+              allow(RabbitMQ::Server).to receive(:connection) { connection }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rabbitmq/actors/version.rb

@@ -0,0 +1,5 @@
+module RabbitMQ
+  module Actors
+    VERSION = "2.0.0"
+  end
+end

data/lib/rabbitmq/server.rb

@@ -0,0 +1,18 @@
+module RabbitMQ
+  module Server
+
+    # The url to the server
+    mattr_reader :url, instance_accessor: false
+
+    # The bunny connection object to the server
+    mattr_reader :connection, instance_accessor: false
+
+    class << self
+      # Set the url to the server and open a new connection
+      def url=(url)
+        @@url        = url
+        @@connection = Bunny.new(url).start
+      end
+    end
+  end
+end

data/rabbitmq-actors.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rabbitmq/actors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rabbitmq-actors"
+  spec.version       = RabbitMQ::Actors::VERSION
+  spec.authors       = ["Lorenzo Tello"]
+  spec.email         = ["ltello8a@gmail.com"]
+
+  spec.summary       = "Ruby client agents implementing different RabbitMQ producer/consumer patterns."
+  spec.description   = "High level classes (consumers, producers, publishers...) for a Ruby application to use RabbitMQ."
+  spec.homepage      = "https://github.com/ltello/rabbitmq-actors"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler",      "~> 1.13"
+  spec.add_development_dependency "rake"                   # Run scripted tasks
+  spec.add_development_dependency "rspec",        "~> 3.4" # Test framework
+  spec.add_development_dependency "factory_girl", "~> 4.5" # Data factories to be used in tests
+  spec.add_development_dependency "byebug",       "~> 5.0" # Debugger
+  spec.add_development_dependency "simplecov"              # Code coverage analyzer
+
+  spec.add_runtime_dependency "activesupport", "~> 4.2" # Rails ActiveSupport
+  spec.add_runtime_dependency "bunny",         "~> 2.0" # Ruby RabbitMQ client.
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: rabbitmq-actors
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Lorenzo Tello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: High level classes (consumers, producers, publishers...) for a Ruby application
+  to use RabbitMQ.
+email:
+- ltello8a@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rabbitmq/actors.rb
+- lib/rabbitmq/actors/base/agent.rb
+- lib/rabbitmq/actors/base/consumer.rb
+- lib/rabbitmq/actors/base/producer.rb
+- lib/rabbitmq/actors/patterns.rb
+- lib/rabbitmq/actors/patterns/headers/headers_consumer.rb
+- lib/rabbitmq/actors/patterns/headers/headers_producer.rb
+- lib/rabbitmq/actors/patterns/master_workers/master_producer.rb
+- lib/rabbitmq/actors/patterns/master_workers/worker.rb
+- lib/rabbitmq/actors/patterns/publish_subscribe/publisher.rb
+- lib/rabbitmq/actors/patterns/publish_subscribe/subscriber.rb
+- lib/rabbitmq/actors/patterns/routing/routing_consumer.rb
+- lib/rabbitmq/actors/patterns/routing/routing_producer.rb
+- lib/rabbitmq/actors/patterns/topics/topic_consumer.rb
+- lib/rabbitmq/actors/patterns/topics/topic_producer.rb
+- lib/rabbitmq/actors/testing.rb
+- lib/rabbitmq/actors/testing/rspec.rb
+- lib/rabbitmq/actors/testing/rspec/stub.rb
+- lib/rabbitmq/actors/version.rb
+- lib/rabbitmq/server.rb
+- rabbitmq-actors.gemspec
+homepage: https://github.com/ltello/rabbitmq-actors
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby client agents implementing different RabbitMQ producer/consumer patterns.
+test_files: []