bunny_events 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a636e6dfacc607d7b8c4c85de42c882b3e6486c38901ef0cf94c645ac7c47e87
+  data.tar.gz: b49ffde771cb39c7e2404603d4eb913154d1fcfdedae36b14fd400f71e2778af
+SHA512:
+  metadata.gz: a96296e85bd6c27d9ebbd6d19c9f81a8da8b1307a97d0c0d0c03f8be939a6f34f7fdf40dcdf82f6871682916ba681e97bcf4bed20c32046c982f1825bec87a82
+  data.tar.gz: edbf92c0720199995875b668dbafec22f8a0b55782457625ff834ba8751eac45151a92a73e5b299d0df79a3e60827480eea3327ed07b011ff05bdc1a921eff8c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,9 @@
+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'

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    bunny_events (0.1.1)
+      bunny (>= 2.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.3.0)
+    bunny (2.14.2)
+      amq-protocol (~> 2.3, >= 2.3.0)
+    bunny-mock (1.7.0)
+      bunny (>= 1.7)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  bunny (>= 2.14.0)
+  bunny-mock
+  bunny_events!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dean
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# Bunny Events
+
+[![Gem Version](https://badge.fury.io/rb/message_queue_event.svg)](https://badge.fury.io/rb/message_queue_event)
+
+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
+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)
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bunny_events'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bunny_events
+
+## Usage
+
+### Defining an event
+
+To produce an event to the message queue, we must first define an event. In `app/events/my_test_event.rb`
+
+```ruby
+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
+
+  # We can define what the message payload looks like here.
+  def initialize(msg)
+    @message = "My test message is #{msg}"
+  end
+end
+
+```
+
+### Changing the message payload
+
+We can change the payload in the `initialize` method, allowing us complete control over what data is used to create the message.
+
+```ruby
+  def initialize(user, page)
+    @message = {
+        :user_id => user.id,
+        :user_name => user.name,
+        :page => page.url,
+        :timestamp => Time.now.to_i
+    }.to_json
+  end
+```
+
+This ensures complete control over how your application produces a message, enabling your application to utilise JSON, AVRO, or just plain old strings.
+
+### Publish event
+
+Publishing the event requires the use of the BunnyEvents class
+
+```ruby
+  # Create event, passing in whatever data is needed
+  event = MyTestEvent.new "This is a test event"
+  
+  # Use the BunnyEvents system to publish this event
+  BunnyEvents.publish event
+```
+
+### Full example with initialisation
+
+```ruby
+
+# 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
+   
+# Event definitions are defined in classes, in rails, we generally use app/messages
+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,
+               :bindings => {
+                   :queue_1 => {
+                       :routing_key => ""
+                   },
+                   :queue_2 => {
+                       :routing_key => ""
+                   },
+               }
+
+ # We can define what the message payload looks like here.
+ def initialize(msg)
+   @message = "My test message is #{msg}"
+ end
+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
+```
+
+## Development
+
+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.
+
+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 tags, 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/Nexus-Mods/message_queue_event.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bunny_events"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/bunny_event.rb

@@ -0,0 +1,32 @@
+require 'bunny_events'
+
+# Module that can be included into a ruby class to create a definition of a BunnyEvent. These events can then be published
+# via the BunnyEvents system.
+module BunnyEvent
+
+  attr_accessor :message
+
+  module ClassMethods
+
+    # Class method to allow the setting of event options in the message definitions
+    def event_options(options)
+      @options = options
+    end
+
+    # Class method for retreiving the data via the `MyMessage.class.options`
+    def options
+      @options
+    end
+  end
+
+  class << self
+    def included(base)
+      base.extend ClassMethods
+    end
+  end
+end
+
+module Exceptions
+  class InvalidBunnyConnection < StandardError; end
+  class InvalidBunnyEvent < StandardError; end
+end

data/lib/bunny_events/version.rb

@@ -0,0 +1,3 @@
+module BunnyEvent
+  VERSION = "0.1.1"
+end

data/lib/bunny_events.rb

@@ -0,0 +1,84 @@
+require 'bunny'
+
+class BunnyEvents
+
+  class << self
+    # Class instance variables, for:
+    # - keeping track of all our active channels (one for each type of event)
+    # -  our active connection to bunny (one for the whole application)
+    attr_accessor :channels, :bunny_connection
+  end
+
+  @@defaults = {
+      :exchange => "",
+      :exchange_type => :direct,
+      :routing_key => "message_queue_event"
+  }
+
+  # Initialise the BunnyEvents system by accepting a bunny connection.
+  #
+  # Example:
+  #
+  # This can also accept bunnymock for testing
+  # BunnyEvents.init BunnyMock.new.start
+  #
+  def self.init(bunny_connection)
+
+    # Ensure the bunny_connection is valid
+    if bunny_connection.nil? || !bunny_connection.respond_to?(:connected?)
+      raise Exceptions::InvalidBunnyConnection.new
+    end
+
+    @bunny_connection = bunny_connection
+
+  end
+
+  def self.connected?
+    @bunny_connection&.connected? || false
+  end
+
+  # Public message. message should be an instance of BaseMessage (or a class with BaseMessage included)
+  def self.publish(message)
+
+    unless message.class.included_modules.include?(BunnyEvent)
+      raise Exceptions::InvalidBunnyEvent.new
+    end
+
+    unless connected?
+      throw "Not connected"
+    end
+
+    # If there are no channels, or this message's key does not appear in our channel list, create a new channel
+    if @channels.nil?
+      @channels = {}
+    end
+
+    # get the options defined by the message queue event class
+    opts = @@defaults.merge message.class.options
+
+    # Use the class name to determine which channel to use
+    unless @channels.key?(message.class.name)
+      @channels[message.class.name] = @bunny_connection.create_channel
+    end
+
+    channel = @channels[message.class.name]
+
+    # If our message 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], {:type => opts[:exchange_type] || :direct})
+    else
+      x = channel.default_exchange
+    end
+
+    # if your event was sent with queue bindings, ensure to create the queue and bindings
+    if !opts[:bindings].nil?
+      opts[:bindings].each do |q, binding|
+        queue = channel.queue q.to_s
+        queue.bind x, routing_key: binding[:routing_key]
+      end
+    end
+
+    x.publish message.message, :routing_key => opts[:routing_key]
+
+  end
+end

data/message_queue_event.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bunny_events/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bunny_events"
+  spec.version       = BunnyEvent::VERSION
+  spec.authors       = ["Dean Lovett"]
+  spec.email         = ["dean.lovett@nexusmods.com"]
+
+  spec.summary       = %q{A simple gem to define events for messages queues }
+  spec.description   = %q{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}
+  spec.homepage      = "https://www.nexusmods.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Nexus-Mods"
+    spec.metadata["changelog_uri"] = "https://github.com/Nexus-Mods"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "bunny", ">= 2.14.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: bunny_events
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dean Lovett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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
+email:
+- dean.lovett@nexusmods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/bunny_event.rb
+- lib/bunny_events.rb
+- lib/bunny_events/version.rb
+- message_queue_event.gemspec
+homepage: https://www.nexusmods.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.nexusmods.com
+  source_code_uri: https://github.com/Nexus-Mods
+  changelog_uri: https://github.com/Nexus-Mods
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple gem to define events for messages queues
+test_files: []