bunny_events 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985592caa9bd8cc75584a5b75fd9867a46ed0335dbf5f40e488ceac4e1f1cf77
-  data.tar.gz: 349a76a616f41608a04f90cc33b5d5ed470712844347ef4797e110c5d138b576
+  metadata.gz: ccc318c6413bcd031b944955322d4901090c15b77faf52929726e04ead11b3b3
+  data.tar.gz: 5a36d2c86cde7e3f1e49f2b443b9e527be434dfe32d80398b9ff5b264c54ffe7
 SHA512:
-  metadata.gz: 0c48c7c19a3862fa90f21282db47273328e9355066dcb405bfa63c1b10ea3d3bd0595c6daee5a17cf44cfcda8d0c31b66354121348ec05c0682ec22765327416
-  data.tar.gz: 1c2b972049aa3e951bce82a13cdffde5a501525cfeeb8b031959dbecd03f24817a09ab4069581d52a269836f3ff5105e5b42623b09257e2390b1f3f3424b4232
+  metadata.gz: a3d92376e744871359def061da97f575edfabfc926d8762100c3a7ff430651950251b59bf2e95df3959192bd4d7071d9b2a291d0605b72c0d3fc329d804b7aef
+  data.tar.gz: c6cd4c92ee2aee2e4c31cabd94c3dcfb7988c1097e49a0308d3acc0e8887f4dbeaf0dca3d491526bb555554fb41afdd658f0d17dcfb4be65204ba847cd4d8a99

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false

data/Gemfile

@@ -1,9 +1,10 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-gem "bunny", ">= 2.14.0"
+gem 'bunny', '>= 2.14.0'
 gem 'bunny-mock'
-gem 'coveralls', require: false
+gem 'coveralls', require: false
+gem 'rubocop'

data/Gemfile.lock

@@ -8,6 +8,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     amq-protocol (2.3.0)
+    ast (2.4.0)
     bunny (2.14.2)
       amq-protocol (~> 2.3, >= 2.3.0)
     bunny-mock (1.7.0)
@@ -20,7 +21,12 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.2)
+    jaro_winkler (1.5.3)
     json (2.2.0)
+    parallel (1.17.0)
+    parser (2.6.4.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -35,6 +41,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -44,6 +58,7 @@ GEM
       tins (~> 1.0)
     thor (0.20.3)
     tins (1.21.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -56,6 +71,7 @@ DEPENDENCIES
   coveralls
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -2,6 +2,8 @@
 
 [![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)
 
+<p><img height="200" width="200" src="https://s3-us-west-2.amazonaws.com/s.cdpn.io/3333883/bunny_events_logo.png" /></p>
+
 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 using Bunny directly, this gem allows an application to define "Event Definitions" which can be defined and published

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "bunny_events"
+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.
@@ -10,5 +10,5 @@ require "bunny_events"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/example

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "bunny_events"
-require "bunny_event"
+require 'bundler/setup'
+require 'bunny_events'
+require 'bunny_event'
 
 # 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.
@@ -11,50 +11,47 @@ require "bunny_event"
 # require "pry"
 # Pry.start
 
-p "Defining DummyEvent"
+p 'Defining DummyEvent'
 class DummyEvent
   include BunnyEvent
 
-  event_options :exchange => "test_exchange",
-                :exchange_opts => {
-                    :type => :direct
+  event_options exchange: 'test_exchange',
+                exchange_opts: {
+                  type: :direct
                 },
-                :queues =>
-                    {
-                        :some_queue => {
-                            :opts => {
-                              :durable => true
-                            },
-                            :routing_key => ""
-                        }
-                    }
-
+                queues: {
+                  some_queue: {
+                    opts: {
+                      durable: true
+                    },
+                    routing_key: ''
+                  }
+                }
 
   def initialize(msg)
     @message = "My test message is #{msg}"
   end
-
 end
 
-p "Publishing event"
+p 'Publishing event'
 
 bunny_events = BunnyEvents.new
-bunny = 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"
+bunny_events.publish DummyEvent.new 'test'
 
-p "deleting exchane"
-p bunny.exchange_exists? "test_exchange"
+p 'deleting exchane'
+p bunny.exchange_exists? 'test_exchange'
 
-x = bunny_events.channels["DummyEvent"].exchange "test_exchange"
+x = bunny_events.channels['DummyEvent'].exchange 'test_exchange'
 x.delete
 
-p "Does exchange exist?"
-p bunny.exchange_exists? "test_exchange"
+p 'Does exchange exist?'
+p bunny.exchange_exists? 'test_exchange'
 
-bunny_events.publish DummyEvent.new "test"
+bunny_events.publish DummyEvent.new 'test'
 
-p bunny.exchange_exists? "test_exchange"
+p bunny.exchange_exists? 'test_exchange'
 
-p "end"
+p 'end'

data/bunny_events.gemspec

@@ -1,44 +1,43 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "bunny_events/version"
+require 'bunny_events/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bunny_events"
+  spec.name          = 'bunny_events'
   spec.version       = BunnyEvent::VERSION
-  spec.authors       = ["Dean Lovett"]
-  spec.email         = ["dean.lovett@nexusmods.com"]
+  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"
+  spec.summary       = 'A simple gem to define events for messages queues '
+  spec.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'
+  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"
+    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."
+    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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "bunny", ">= 2.14.0"
+  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"
-  spec.add_development_dependency "bunny-mock"
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bunny-mock'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/bunny_event.rb

@@ -3,11 +3,9 @@ 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
@@ -30,4 +28,4 @@ module Exceptions
   class InvalidBunnyConnection < StandardError; end
   class InvalidBunnyEvent < StandardError; end
   class InvalidExchange < StandardError; end
-end
+end

data/lib/bunny_events/version.rb

@@ -1,3 +1,3 @@
 module BunnyEvent
-  VERSION = "0.3.0"
+  VERSION = '0.3.1'.freeze
 end

data/lib/bunny_events.rb

@@ -1,7 +1,6 @@
 require 'bunny'
 
 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
@@ -9,9 +8,9 @@ class BunnyEvents
   attr_accessor :initialized_events
 
   @@defaults = {
-      :exchange => "",
-      :exchange_type => :direct,
-      :routing_key => "message_queue_event"
+    exchange: '',
+    exchange_type: :direct,
+    routing_key: 'message_queue_event'
   }
 
   # Initialise the BunnyEvents system by accepting a bunny connection.
@@ -23,10 +22,9 @@ class BunnyEvents
   # bunny_events.init BunnyMock.new.start
   #
   def init(bunny_connection)
-
     # Ensure the bunny_connection is valid
     if bunny_connection.nil? || !bunny_connection.respond_to?(:connected?)
-      raise Exceptions::InvalidBunnyConnection.new
+      raise Exceptions::InvalidBunnyConnection
     end
 
     @channels = {}
@@ -34,7 +32,6 @@ class BunnyEvents
     @initialized_exchanges = {}
 
     @bunny_connection = bunny_connection
-
   end
 
   def connected?
@@ -43,14 +40,11 @@ class BunnyEvents
 
   # Public message. message should be an instance of BaseMessage (or a class with BaseMessage included)
   def publish(message, routing_key = nil)
-
     unless message.class.included_modules.include?(BunnyEvent)
-      raise Exceptions::InvalidBunnyEvent.new
+      raise Exceptions::InvalidBunnyEvent
     end
 
-    unless connected?
-      raise Exceptions::InvalidBunnyConnection.new
-    end
+    raise Exceptions::InvalidBunnyConnection unless connected?
 
     # get the options defined by the message queue event class
     opts = @@defaults.merge message.class.options
@@ -63,17 +57,15 @@ class BunnyEvents
     channel = @channels[message.class.name]
 
     #  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 !@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
+      x = if !opts[:exchange].nil? && !opts[:exchange].empty?
+            channel.exchange(opts[:exchange], opts[:exchange_opts] || {})
+          else
+            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
+      handle_queue_definitions channel, x, opts[:queues] unless opts[:queues].nil?
 
       # ensure this event's creation params are not processed again
       @initialized_exchanges[message.class.name] ||= x
@@ -83,27 +75,28 @@ class BunnyEvents
 
     # ensure exchange is not null
     if x.nil? || !@bunny_connection.exchange_exists?(opts[:exchange])
-      raise Exceptions::InvalidExchange.new
+      raise Exceptions::InvalidExchange
     end
 
     # publish message along with the optional routing key
-    x.publish message.message, :routing_key => routing_key || opts[: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] || {}
-
-        # 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
+
+  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] || {}
+
+      # 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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunny_events
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dean Lovett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bunny-mock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bunny-mock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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
@@ -91,6 +91,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock