bunny_events 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f56ddc8106ddffb47e4a21f83c06104ab87591db3c05ca12ffc877d6997560c
-  data.tar.gz: daaddd4f9ae0581e40625e2ffd9146e61f9a1177cf068167974bf190f6ccd7f8
+  metadata.gz: 985592caa9bd8cc75584a5b75fd9867a46ed0335dbf5f40e488ceac4e1f1cf77
+  data.tar.gz: 349a76a616f41608a04f90cc33b5d5ed470712844347ef4797e110c5d138b576
 SHA512:
-  metadata.gz: a51e2605065ccc01876aa5b0b5d6c9aa0d8c3a44ceb1ceece1a68d62986017aed50cdf26f8798cb7ee9a9bf143f7ad8ffbb0f5d8d7e56948c7b22f1a4f9d0b11
-  data.tar.gz: d8b7b89407ee3c87e8af7fd1446284ec6f320467d4cadf72f1a022bc2c491f344a9c8215ac523005a47f3774e318a1160214e09210be5b13e45823051cb4954a
+  metadata.gz: 0c48c7c19a3862fa90f21282db47273328e9355066dcb405bfa63c1b10ea3d3bd0595c6daee5a17cf44cfcda8d0c31b66354121348ec05c0682ec22765327416
+  data.tar.gz: 1c2b972049aa3e951bce82a13cdffde5a501525cfeeb8b031959dbecd03f24817a09ab4069581d52a269836f3ff5105e5b42623b09257e2390b1f3f3424b4232

data/Gemfile

@@ -2,8 +2,8 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in message_queue_event.gemspec
 gemspec
 
 gem "bunny", ">= 2.14.0"
-gem 'bunny-mock'
+gem 'bunny-mock'
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bunny_events (0.1.1)
+    bunny_events (0.2.2)
       bunny (>= 2.14.0)
 
 GEM
@@ -12,7 +12,15 @@ GEM
       amq-protocol (~> 2.3, >= 2.3.0)
     bunny-mock (1.7.0)
       bunny (>= 1.7)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.2.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -27,6 +35,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.21.1)
 
 PLATFORMS
   ruby
@@ -36,6 +53,7 @@ DEPENDENCIES
   bunny (>= 2.14.0)
   bunny-mock
   bunny_events!
+  coveralls
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,10 +1,10 @@
 # Bunny Events
 
-[![Gem Version](https://badge.fury.io/rb/bunny_events.svg)](https://badge.fury.io/rb/bunny_events)
+[![Gem Version](https://badge.fury.io/rb/bunny_events.svg)](https://badge.fury.io/rb/bunny_events) [![Build Status](https://travis-ci.org/Nexus-Mods/bunny_events.svg?branch=master)](https://travis-ci.org/Nexus-Mods/bunny_events) [![Coverage Status](https://coveralls.io/repos/github/Nexus-Mods/bunny_events/badge.svg?branch=master)](https://coveralls.io/github/Nexus-Mods/bunny_events?branch=master)
 
 A simple wrapper gem to aid with producing events to a message queue, using Bunny, in a standardized and uniform way across multiple microservices.
 
-Rather than usin Bunny directly, this gem allows an application to define "Event Definitions" which can be defined and published
+Rather than using Bunny directly, this gem allows an application to define "Event Definitions" which can be defined and published
 in a modular way. This ensures that when you are producing a message, your application logic shouldn't care about how the
 message is produced (E.g. your controller shouldn't care or know anything about what exchange to publish a message to, only the BunnyEvent 
 that has been defined cares)
@@ -14,6 +14,7 @@ Current Features and limitation:
 - Allows a bunny connection to initialise the system
 - Allows the definition of abstract events to be used application-wide
 - Customization of exchange and queue options when producing an event
+- By default, only initialises the exchange and queues on the first publish. This can be overriden with `opts[:always_create_when_publishing]`
 
 ## Installation
 
@@ -30,6 +31,52 @@ And then execute:
 Or install it yourself as:
 
     $ gem install bunny_events
+    
+### Rails Installation
+To initialise the system with Rails, create a new intiailizer:
+
+```ruby
+# config/initializers/bunny-events.rb
+if !Rails.env.test?
+  $BUNNY_EVENTS = BunnyEvents.new
+  $BUNNY_EVENTS.init Bunny.new("amqp://rabbitmq:rabbitmq@rabbit1:5672").start
+end
+```
+
+Events can then be created in app/events:
+
+```ruby
+require 'bunny_event'
+
+class MyTestEvent
+  include BunnyEvent
+
+  # define the event options for queueing this event. Each event type can have different options.
+  event_options :exchange => "test_exchange",
+                :exchange_opts => {
+                    :type => :fanout
+                }
+
+  # We can define what the message payload looks like here.
+  def initialize(msg)
+    @message = "My test message is #{msg}"
+  end
+end
+```
+
+### Rails Testing
+
+To use Bunny Events in tests, you can initialize a new instance of the system before every test (or just a single test) with BunnyMock
+
+```ruby
+before(:each) do
+    @mock = BunnyMock.new.start
+    $BUNNY_EVENTS = BunnyEvents.new
+    $BUNNY_EVENTS.init @mock
+end
+```
+
+Note: This requires the `bunny-mock` gem to be installed in your test environment
 
 ## Usage
 
@@ -38,12 +85,24 @@ Or install it yourself as:
 To produce an event to the message queue, we must first define an event. In `app/events/my_test_event.rb`
 
 ```ruby
+require 'bunny_event'
 class MyTestEvent
   include BunnyEvent
 
   # define the event options for queueing this event. Each event type can have different options.
   event_options :exchange => "test_exchange",
-                :exchange_type => :fanout
+                :exchange_opts => {
+                    :type => :fanout
+                },
+                :queues =>
+                    {
+                        :some_queue => {
+                            :opts => {
+                              :durable => true
+                            },
+                            :routing_key => ""
+                        }
+                    }
 
   # We can define what the message payload looks like here.
   def initialize(msg)
@@ -79,15 +138,37 @@ Publishing the event requires the use of the BunnyEvents class
   event = MyTestEvent.new "This is a test event"
   
   # Use the BunnyEvents system to publish this event
-  BunnyEvents.publish event
+  bunny_events = BunnyEvents.new 
+  bunny_events.init Bunny.new("amqp://rabbitmq:rabbitmq@rabbit1:5672").start
+  bunny_events.publish event
 ```
 
-### Full example with initialisation
+When publishing, a custom routing key can also be used
 
 ```ruby
+bunny_events.publish event, "some_routing_key"
+```
+
+### Configuration
+
+When defining an event, many options can be set via the event_options class method.
 
+- `exchange` - Name of the exchange this event will publish it's messages to
+- `exchange_opts` - Bunny-specific options for creating an exchange. See http://rubybunny.info/articles/exchanges.html for more information.
+- `queues` - A hash of queues to be created and bound to the exchange. Each key consists of the name of the queue and the value is another hash, with the following options:
+   - `opts` - Bunny-specific options fo creating a queue
+   - `routing_key` - Key used for binding this queue to the exchange
+   - `ignore_bind` - Can be used to override the binding. Defaults to `false`. If true, will not bind this queue to the exchange. Is useful when utilising the default exchange.
+- `always_create_when_publishing` - Overrides the queue/exchange creation process to run every time a message is processed. Default: `false`
+- `routing_key` - The default routing key used for all messages pushed for this event. Can be changed when publishing a message E.g. ```bunny_events.publish event, "custom_routing_key"```
+
+### Full example with initialisation
+
+```ruby
+require 'bunny_event'
 # This is done once as part of the configuration step, usually in a rails initializer, or at the start of your application
-BunnyEvents.init Bunny.new("amqp://rabbitmq:rabbitmq@rabbit1:5672").start
+bunny_events = BunnyEvents.new 
+bunny_events.init Bunny.new("amqp://rabbitmq:rabbitmq@rabbit1:5672").start
    
 # Event definitions are defined in classes, in rails, we generally use app/messages
 class MyTestEvent
@@ -116,7 +197,7 @@ end
 
 # When we want to create a new instance of an event, we create and publish the object
 event = MyTestEvent.new "test"
-BunnyEvents.publish event
+bunny_events.publish event
 ```
 
 ## Development
@@ -127,7 +208,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Nexus-Mods/message_queue_event.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Nexus-Mods/bunny_events
 
 ## License
 

data/bin/example

@@ -17,7 +17,7 @@ class DummyEvent
 
   event_options :exchange => "test_exchange",
                 :exchange_opts => {
-                    :type => :fanout
+                    :type => :direct
                 },
                 :queues =>
                     {
@@ -29,6 +29,7 @@ class DummyEvent
                         }
                     }
 
+
   def initialize(msg)
     @message = "My test message is #{msg}"
   end
@@ -36,7 +37,24 @@ class DummyEvent
 end
 
 p "Publishing event"
+
 bunny_events = BunnyEvents.new
-bunny_events.init Bunny.new("amqp://rabbitmq:rabbitmq@localhost:5672").start
+bunny = Bunny.new("amqp://rabbitmq:rabbitmq@localhost:5672").start
+bunny_events.init bunny
+
+bunny_events.publish DummyEvent.new "test"
+
+p "deleting exchane"
+p bunny.exchange_exists? "test_exchange"
+
+x = bunny_events.channels["DummyEvent"].exchange "test_exchange"
+x.delete
+
+p "Does exchange exist?"
+p bunny.exchange_exists? "test_exchange"
+
+bunny_events.publish DummyEvent.new "test"
+
+p bunny.exchange_exists? "test_exchange"
 
-bunny_events.publish DummyEvent.new "test"
+p "end"

data/{message_queue_event.gemspec → bunny_events.gemspec}

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bunny-mock"
 end

data/lib/bunny_event.rb

@@ -29,4 +29,5 @@ end
 module Exceptions
   class InvalidBunnyConnection < StandardError; end
   class InvalidBunnyEvent < StandardError; end
+  class InvalidExchange < StandardError; end
 end

data/lib/bunny_events/version.rb

@@ -1,3 +1,3 @@
 module BunnyEvent
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/bunny_events.rb

@@ -4,6 +4,10 @@ class BunnyEvents
 
   attr_accessor :channels, :bunny_connection
 
+  # Keeps track of which events have been intiailized by this BunnyEvents worker. Used to ensure that the queue and
+  # exchange creation is only performed once.
+  attr_accessor :initialized_events
+
   @@defaults = {
       :exchange => "",
       :exchange_type => :direct,
@@ -27,6 +31,8 @@ class BunnyEvents
 
     @channels = {}
 
+    @initialized_exchanges = {}
+
     @bunny_connection = bunny_connection
 
   end
@@ -36,14 +42,14 @@ class BunnyEvents
   end
 
   # Public message. message should be an instance of BaseMessage (or a class with BaseMessage included)
-  def publish(message)
+  def publish(message, routing_key = nil)
 
     unless message.class.included_modules.include?(BunnyEvent)
       raise Exceptions::InvalidBunnyEvent.new
     end
 
     unless connected?
-      throw "Not connected"
+      raise Exceptions::InvalidBunnyConnection.new
     end
 
     # get the options defined by the message queue event class
@@ -56,28 +62,48 @@ class BunnyEvents
 
     channel = @channels[message.class.name]
 
-    # If the event was sent with an exchange name, create and submit this to the exchange, otherwise, just use the default exchange
-    if !opts[:exchange].nil? && !opts[:exchange].empty?
-      x = channel.exchange(opts[:exchange], opts[:exchange_opts] || {})
-    else
-      x = channel.default_exchange
-    end
+    #  Ensure that the exchange, queue and binding creation is only performed once
+    if (!@initialized_exchanges.key?(message.class.name)) || opts[:always_create_when_publishing]
+      # If the event was sent with an exchange name, create and submit this to the exchange, otherwise, just use the default exchange
+      if !opts[:exchange].nil? && !opts[:exchange].empty?
+        x = channel.exchange(opts[:exchange], opts[:exchange_opts] || {})
+      else
+        x = channel.default_exchange
+      end
+      # if the event was sent with queue definitions, ensure to create the bindings
+      if !opts[:queues].nil?
+        handle_queue_definitions channel, x, opts[:queues]
+      end
 
-    # if the event was sent with queue definitions, ensure to create the bindings
-    if !opts[:queues].nil?
-      handle_queue_definitions channel, x, opts[:queues]
+      # ensure this event's creation params are not processed again
+      @initialized_exchanges[message.class.name] ||= x
     end
 
-    x.publish message.message, :routing_key => opts[:routing_key]
+    x ||= @initialized_exchanges[message.class.name]
 
+    # ensure exchange is not null
+    if x.nil? || !@bunny_connection.exchange_exists?(opts[:exchange])
+      raise Exceptions::InvalidExchange.new
     end
 
+    # publish message along with the optional routing key
+    x.publish message.message, :routing_key => routing_key || opts[:routing_key]
+  end
+
   private
     def handle_queue_definitions (channel, exchange, queues)
       queues.each do |q, opts|
         # Create this queue and bind, if the binding options are present
         queue = channel.queue q.to_s, opts[:opts] || {}
-        queue.bind exchange, :key => opts[:routing_key] || ""
+
+        # if ignore bind isn't set, set to nil
+        ignore_bind = opts[:ignore_bind] || false
+
+        # if we aren't ignoring the binding for this queue, check if it's already bound. We also shouldn't bind directly
+        # to the default queue
+        if !ignore_bind && !queue.bound_to?(exchange) && exchange.name != ""
+          queue.bind exchange, :key => opts[:routing_key] || ""
+        end
       end
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunny_events
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dean Lovett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-02 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bunny-mock
+  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'
 description: This gem allows the use of "Messages" to be defined and published very
   easily, without your models/controllers having to worry about how messages are produced.
   Supports AMQP
@@ -86,10 +100,10 @@ files:
 - bin/console
 - bin/example
 - bin/setup
+- bunny_events.gemspec
 - lib/bunny_event.rb
 - lib/bunny_events.rb
 - lib/bunny_events/version.rb
-- message_queue_event.gemspec
 homepage: https://www.nexusmods.com
 licenses:
 - MIT