bunny_exchanges_manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faca8ad660523c11f6eaac9717e1dcbc6fdc8c3b
+  data.tar.gz: 6d83b196164c1d72d18eb74566c4ef2e75d4be69
+SHA512:
+  metadata.gz: 857cba4b80f663d1a3e7eb344456de7cea463b78a5135249247edf3b75706ef39877c83bb89db5eb13f65526da047e0e9f71d582d5c8b8e2ad38edaa0f546c21
+  data.tar.gz: 672c90b51c55a8da17838b9023e8f3a40c0f0c0353b90d34e4740bcd1377990859d6d6019e8a262040d211578498390806a2571b9fff6194649124d9a0592856

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bunny_exchanges_manager.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 jcabotc
+
+MIT License
+
+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,64 @@
+# BunnyExchangesManager
+
+This gem provides a way to create and keep RabbitMQ exchanges using Bunny,
+and keep them to be used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bunny_exchanges_manager'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bunny_exchanges_manager
+
+## Usage
+
+To use `BunnyExchanges` you must define the configuration of each exchange in the
+YAML config file.
+
+By default the path to the configuration file is `config/exchanges.yml`, but you
+can provide a specific path with:
+```ruby
+BunnyExchanges.configure do |config|
+  config.path = "my/custom/path"
+end
+```
+
+### The configuration file
+
+In the configuration file you have to name and define all your exchanges:
+```yml
+an_action:
+  name: the.exchange.name
+  type: fanout
+  durable: false
+  auto_delete: true
+  arguments:
+    one_argument: 1
+    another_argument: "2"
+
+another_action:
+  name: another.exchange.name
+  type: topic
+```
+
+### Get exchanges
+
+To get a configured exchange:
+```ruby
+BunnyExchanges.get(:an_action) # => #<Bunny::Exchange:...>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bunny_exchanges_manager/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bunny_exchanges_manager.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bunny_exchanges/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bunny_exchanges_manager"
+  spec.version       = BunnyExchanges::VERSION
+  spec.authors       = ["jcabotc"]
+  spec.email         = ["jcabot@gmail.com"]
+  spec.summary       = %q{A gem to initialize RabbitMQ exchanges using Bunny on ruby applications}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bunny"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+end

data/lib/bunny_exchanges/configuration.rb

@@ -0,0 +1,58 @@
+require 'yaml'
+
+module BunnyExchanges
+  # It stores the exchanges configuration.
+  class Configuration
+    DEFAULT_EXCHANGES_PATH = "config/exchanges.yml"
+    DEFAULT_RABBITMQ_PATH  = "config/rabbitmq.yml"
+
+    # Sets the path of the exchanges configuration file.
+    #
+    # @param [String] a path.
+    attr_writer :exchanges_path
+
+    # Sets the path of the rabbitmq configuration file.
+    #
+    # @param [String] a path.
+    attr_writer :rabbitmq_path
+
+    # Sets the ENV. If it is set, the rabbitmq configuration
+    # for that env is taken, otherwise it gets the rabbitmq config file
+    # contents directly.
+    #
+    # @param [String] the env.
+    attr_writer :env
+
+    # Constructor.
+    def initialize
+      @exchanges_path = DEFAULT_EXCHANGES_PATH
+      @rabbitmq_path  = DEFAULT_RABBITMQ_PATH
+    end
+
+    # Loads the configuration YAML file contents.
+    #
+    # @return [Hash] the exchanges configuration.
+    def exchanges
+      @exchanges ||= YAML.load_file(exchanges_path)
+    end
+
+    # Loads the configuration YAML file contents for the environment if given.
+    #
+    # @return [Hash] the rabbitmq configuration.
+    def rabbitmq
+      @rabbitmq ||= if env
+                      rabbitmq_contents.fetch(env)
+                    else
+                      rabbitmq_contents
+                    end
+    end
+
+  private
+
+    def rabbitmq_contents
+      YAML.load_file(rabbitmq_path)
+    end
+
+    attr_reader :env, :exchanges_path, :rabbitmq_path
+  end
+end

data/lib/bunny_exchanges/manager.rb

@@ -0,0 +1,65 @@
+require 'bunny'
+
+module BunnyExchanges
+  # The required exchange is not defined.
+  UndefinedExchange = Class.new(StandardError)
+
+  # Class keeps all configured exchanges through the same connection and channel.
+  class Manager
+    # Constructor.
+    #
+    # @param [BunnyExchanges::Configuration] the exchanges configuration.
+    def initialize config = BunnyExchanges.configuration
+      @config    = config
+      @exchanges = {}
+    end
+
+    # Gets or builds the required exchange.
+    #
+    # @param [Symbol] the action name.
+    # @return [Bunny::Exchange] the required bunny exchange.
+    # @raise [BunnyExchanges::Manager::UndefinedExchange] when the exchange is not defined.
+    def get action
+      exchanges[action.to_sym] ||= begin
+        name, options = params_for(action)
+
+        channel.exchange(name, options)
+      end
+    end
+
+  private
+
+    attr_reader :exchanges, :config
+
+    def params_for action
+      options = options_for(action)
+      name    = options.delete(:name)
+
+      [name, options]
+    end
+
+    def options_for action
+      config_for(action).reduce({}) do |hash, (option, value)|
+        hash.merge! option.to_sym => value
+      end
+    end
+
+    def config_for action
+      config.exchanges.fetch(action.to_s) { raise_undefined(action) }
+    end
+
+    def channel
+      @channel ||= begin
+        conn = Bunny.new(config.rabbitmq)
+        conn.start
+
+        conn.create_channel
+      end
+    end
+
+    def raise_undefined action
+      raise BunnyExchanges::UndefinedExchange,
+        "No exchange is defined for action #{action}."
+    end
+  end
+end

data/lib/bunny_exchanges/version.rb

@@ -0,0 +1,3 @@
+module BunnyExchanges
+  VERSION = "0.0.1"
+end

data/lib/bunny_exchanges.rb

@@ -0,0 +1,39 @@
+require "bunny_exchanges/version"
+
+require "bunny_exchanges/configuration"
+require "bunny_exchanges/manager"
+
+module BunnyExchanges
+  # BunnyExchanges configuration
+  #
+  # @return [Configuration] the current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # A helper to configure BunnyExchanges
+  #
+  # @yield [configuration] Configures tenantify
+  def self.configure
+    yield configuration
+  end
+
+  # Delegates `#get` to the current manager.
+  # Returns the required exchange.
+  #
+  # @param [Symbol, String] the action name
+  # @return [Bunny::Exchange] the required exchange.
+  # @raise [BunnyExchanges::UndefinedExchange] when the required example is not defined.
+  # @see Tenant.using
+  def self.get action
+    manager.get(action)
+  end
+
+  # The current instance of {BunnyExchanges::Manager}.
+  #
+  # @return [BunnyExchanges::Manager] the manager with the current configuration.
+  # @see Tenant.using
+  def self.manager
+    @manager ||= Manager.new(configuration)
+  end
+end

data/spec/bunny_exchanges/configuration/test_exchanges_configuration.yml

@@ -0,0 +1,13 @@
+action_1:
+  name: an.exchange.name
+  type: fanout
+  durable: true
+  auto_delete: false
+  arguments:
+    one: 1
+    two: second
+action_2:
+  name: the.name
+action_3:
+  name: another
+  type: topic

data/spec/bunny_exchanges/configuration/test_rabbitmq_configuration.yml

@@ -0,0 +1,5 @@
+development:
+  host: development_host
+
+test:
+  host: test_host

data/spec/bunny_exchanges/configuration_spec.rb

@@ -0,0 +1,73 @@
+require 'bunny_exchanges/configuration'
+
+RSpec.describe BunnyExchanges::Configuration do
+
+  subject { described_class.new }
+
+  describe '#exchanges_path= and #exchanges' do
+    let :config_file do
+      File.expand_path("../configuration/test_exchanges_configuration.yml" ,__FILE__)
+    end
+
+    let :expected_exchanges do
+      {
+        "action_1" => {
+          "name" => "an.exchange.name",
+          "type" => "fanout",
+          "durable" => true,
+          "auto_delete" => false,
+          "arguments" => {
+            "one" => 1,
+            "two" => "second"
+          }
+        },
+        "action_2" => {
+          "name" => "the.name"
+        },
+        "action_3" => {
+          "name" => "another",
+          "type" => "topic"
+        }
+      }
+    end
+
+    it 'parses the exchanges config from a yaml file' do
+      subject.exchanges_path = config_file
+
+      expect(subject.exchanges).to eq expected_exchanges
+    end
+  end
+
+  describe '#rabbitmq_path= and #rabbitmq' do
+    let :config_file do
+      File.expand_path("../configuration/test_rabbitmq_configuration.yml" ,__FILE__)
+    end
+
+    context 'without environment' do
+      let :expected_rabbitmq do
+        {
+          "development" => {"host" => "development_host"},
+          "test"        => {"host" => "test_host"}
+        }
+      end
+
+      it 'parses the rabbitmq config from a yaml file' do
+        subject.rabbitmq_path = config_file
+
+        expect(subject.rabbitmq).to eq expected_rabbitmq
+      end
+    end
+
+    context 'with environment' do
+      let(:expected_rabbitmq) { { "host" => "test_host" } }
+
+      it 'parses the rabbitmq config from a yaml file' do
+        subject.rabbitmq_path = config_file
+        subject.env           = "test"
+
+        expect(subject.rabbitmq).to eq expected_rabbitmq
+      end
+    end
+  end
+
+end

data/spec/bunny_exchanges/manager_spec.rb

@@ -0,0 +1,56 @@
+require 'bunny_exchanges/manager'
+
+RSpec.describe BunnyExchanges::Manager do
+
+  let :exchanges_config do
+    {
+      "action_1" => {
+        "name" => "an.exchange.name",
+        "type" => "fanout",
+        "durable" => false,
+        "auto_delete" => true,
+        "arguments" => {
+          "one" => 1,
+          "two" => "second"
+        }
+      },
+      "action_2" => {
+        "name" => "the.name"
+      }
+    }
+  end
+
+  let :config do
+    double 'config', :exchanges => exchanges_config,
+                     :rabbitmq  => {}
+  end
+
+  subject { described_class.new config }
+
+  describe '#get' do
+    context 'with a defined exchange' do
+      it 'builds and caches the exchange' do
+        exchange = subject.get(:action_1)
+
+        expect(exchange).to be_a Bunny::Exchange
+
+        expect(exchange.name        ).to eq "an.exchange.name"
+        expect(exchange.type        ).to eq "fanout"
+        expect(exchange.durable?    ).to eq false
+        expect(exchange.auto_delete?).to eq true
+        expect(exchange.arguments   ).to eq "one" => 1, "two" => "second"
+
+        exchange_again = subject.get(:action_1)
+        expect(exchange.object_id).to eq exchange_again.object_id
+      end
+    end
+
+    context 'with an undefined exchange' do
+      it 'raises error' do
+        expect{ subject.get(:action_3) }.
+          to raise_error BunnyExchanges::UndefinedExchange
+      end
+    end
+  end
+
+end

data/spec/integration/configure_and_use.rb

@@ -0,0 +1,20 @@
+require 'bunny_exchanges'
+
+RSpec.describe "configure and use" do
+
+  it 'works properly' do
+    BunnyExchanges.configure do |config|
+      config.exchanges_path = File.expand_path("../test_exchanges_config.yml", __FILE__)
+      config.rabbitmq_path  = File.expand_path("../test_rabbitmq_config.yml", __FILE__)
+      config.env = "test"
+    end
+
+    exchange = BunnyExchanges.get(:the_action)
+
+    expect(exchange).to be_a Bunny::Exchange
+
+    expect(exchange.name).to eq "a.real.exchange"
+    expect(exchange.type).to eq "fanout"
+  end
+
+end

data/spec/integration/test_exchanges_config.yml

@@ -0,0 +1,8 @@
+the_action:
+  name: a.real.exchange
+  type: fanout
+
+another_action:
+  name: another.exchange
+  type: topic
+  durable: true

data/spec/integration/test_rabbitmq_config.yml

@@ -0,0 +1,5 @@
+development:
+  host: localhost
+
+test:
+  host: localhost

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'pry'
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    # Best error messages on chained expectations
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    # Prevents you from stubbing a method that does not exist on a real object
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.order = :random
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: bunny_exchanges_manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jcabotc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: 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'
+description: 
+email:
+- jcabot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bunny_exchanges_manager.gemspec
+- lib/bunny_exchanges.rb
+- lib/bunny_exchanges/configuration.rb
+- lib/bunny_exchanges/manager.rb
+- lib/bunny_exchanges/version.rb
+- spec/bunny_exchanges/configuration/test_exchanges_configuration.yml
+- spec/bunny_exchanges/configuration/test_rabbitmq_configuration.yml
+- spec/bunny_exchanges/configuration_spec.rb
+- spec/bunny_exchanges/manager_spec.rb
+- spec/integration/configure_and_use.rb
+- spec/integration/test_exchanges_config.yml
+- spec/integration/test_rabbitmq_config.yml
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to initialize RabbitMQ exchanges using Bunny on ruby applications
+test_files:
+- spec/bunny_exchanges/configuration/test_exchanges_configuration.yml
+- spec/bunny_exchanges/configuration/test_rabbitmq_configuration.yml
+- spec/bunny_exchanges/configuration_spec.rb
+- spec/bunny_exchanges/manager_spec.rb
+- spec/integration/configure_and_use.rb
+- spec/integration/test_exchanges_config.yml
+- spec/integration/test_rabbitmq_config.yml
+- spec/spec_helper.rb