basquiat 1.1.1

data/lib/basquiat/support/hash_refinements.rb

@@ -0,0 +1,24 @@
+module Basquiat
+  module HashRefinements
+    refine Hash do
+      def deep_merge(other_hash)
+        other_hash.each_pair do |key, value|
+          current = self[key]
+          if current.is_a?(Hash) && value.is_a?(Hash)
+            current.deep_merge(value)
+          else
+            self[key] = value
+          end
+        end
+      end
+
+      def symbolize_keys
+        each_with_object({}) do |(key, value), new_hash|
+          new_key = key.to_sym rescue key
+          new_value = (value.is_a? Hash) ? value.symbolize_keys : value
+          new_hash[new_key] = new_value
+        end
+      end
+    end
+  end
+end

data/lib/basquiat/support/json.rb

@@ -0,0 +1,13 @@
+module Basquiat
+  module Json
+    def self.encode(object)
+      MultiJson.dump(object)
+    end
+
+    def self.decode(object)
+      MultiJson.load(object, symbolize_keys: true)
+    rescue MultiJson::ParseError
+      {}
+    end
+  end
+end

data/lib/basquiat/support.rb

@@ -0,0 +1,3 @@
+require 'basquiat/support/hash_refinements'
+require 'basquiat/support/configuration'
+require 'basquiat/support/json'

data/lib/basquiat/version.rb

@@ -0,0 +1,4 @@
+# Version file
+module Basquiat
+  VERSION = '1.1.1'
+end

data/lib/basquiat.rb

@@ -0,0 +1,27 @@
+require 'multi_json'
+require 'naught'
+require 'yaml'
+
+require 'basquiat/support'
+require 'basquiat/adapters'
+require 'basquiat/version'
+require 'basquiat/interfaces/base'
+
+# Overall namespace And config class
+module Basquiat
+  class << self
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end
+
+require_relative 'basquiat/rails/railtie.rb' if defined?(Rails)

data/spec/lib/adapters/base_adapter_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+# Sample class used for testing
+class SampleAdapter
+  include Basquiat::Adapters::Base
+end
+
+describe Basquiat::Adapters::Base do
+  subject { SampleAdapter.new }
+  it_behaves_like 'a Basquiat::Adapter'
+end

data/spec/lib/adapters/rabbitmq_adapter_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'basquiat/adapters/rabbitmq_adapter'
+
+describe Basquiat::Adapters::RabbitMq do
+  subject { Basquiat::Adapters::RabbitMq.new }
+
+  it_behaves_like 'a Basquiat::Adapter'
+
+  let(:base_options) do
+    { servers: [{ host: ENV.fetch('BASQUIAT_RABBITMQ_1_PORT_5672_TCP_ADDR') { 'localhost' },
+                  port: ENV.fetch('BASQUIAT_RABBITMQ_1_PORT_5672_TCP_PORT') { 5672 } }] }
+  end
+
+  before(:each) do
+    subject.adapter_options(base_options)
+  end
+
+  after(:each) do
+    remove_queues_and_exchanges
+  end
+
+  context 'failover' do
+    let(:failover_settings) do
+      base_options[:servers].unshift({ host: 'localhost', port: 1234 })
+      base_options.merge(failover: { default_timeout: 0.2, max_retries: 2 })
+    end
+
+    it 'tries a reconnection after a few seconds' do
+      subject.adapter_options(servers:  [host: 'localhost', port: 1234],
+                              failover: { default_timeout: 0.2, max_retries: 1 })
+      expect { subject.connect }.to raise_exception(Bunny::TCPConnectionFailed)
+    end
+
+    it 'uses another server after all retries on a single one' do
+      subject.adapter_options(failover_settings)
+      expect { subject.connect }.to_not raise_error
+      expect(subject.connection_uri).to match(/5672/)
+    end
+  end
+
+  it '#connected?' do
+    expect(subject.connected?).to be_nil
+    subject.connect
+    expect(subject.connected?).to_not be_nil
+  end
+
+  context 'publisher' do
+    it '#publish [enqueue a message]' do
+      expect do
+        subject.publish('messages.welcome', data: 'A Nice Welcome Message')
+      end.to_not raise_error
+    end
+  end
+
+  context 'listener' do
+    it '#subscribe_to some event' do
+      message_received = ''
+      subject.subscribe_to('some.event', lambda do |msg|
+                                         msg[:data].upcase!
+                                         message_received = msg
+                                       end)
+      subject.listen(block: false)
+
+      subject.publish('some.event', data: 'coisa')
+      sleep 0.1 # Wait for the listening thread.
+
+      expect(message_received).to eq(data: 'COISA')
+    end
+  end
+
+  def remove_queues_and_exchanges
+    subject.send(:queue).delete
+    subject.send(:exchange).delete
+  rescue Bunny::TCPConnectionFailed
+    true
+  ensure
+    subject.send(:disconnect)
+  end
+end

data/spec/lib/adapters/test_adapter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Basquiat::Adapters::Test do
+  subject { Basquiat::Adapters::Test.new }
+  it_behaves_like 'a Basquiat::Adapter'
+
+  context 'publisher' do
+    it '#publish [enqueue a message]' do
+      expect do
+        subject.publish('messages.welcome', value: 'A Nice Welcome Message')
+      end.to change { subject.events('messages.welcome').size }.by(1)
+      expect(subject.events('messages.welcome')[0]).to match(/A Nice Welcome Message/)
+    end
+  end
+
+  context 'listener' do
+    before(:each) do
+      subject.publish('some.event', data: 'some message')
+    end
+
+    it '#subscribe_to some event' do
+      subject.subscribe_to('some.event', ->(msg) { msg.values.map(&:upcase) })
+      expect(subject.listen).to eq(['SOME MESSAGE'])
+    end
+
+    it '#subscribe_to multiple events' do
+      subject.instance_eval <<-METHCALL
+        subscribe_to('some.event', ->(msg) { publish 'some.other', data: msg.values.first.upcase; msg })
+      METHCALL
+      subject.subscribe_to('some.other', ->(msg) { msg.values.first.downcase })
+      expect(subject.listen).to eq(data: 'some message')
+      expect(subject.events('some.other')[0]).to match(/SOME MESSAGE/)
+      expect(subject.listen).to eq('some message')
+    end
+  end
+
+  describe '#clean' do
+    context 'when no event has been published' do
+
+      it 'should have no event registered' do
+        Basquiat::Adapters::Test.clean
+
+        expect(Basquiat::Adapters::Test.events).to be_empty
+      end
+    end
+
+    context 'when some events have been published' do
+      before do
+        subject.publish('some.message', value: 'A Nice Welcome Message')
+        subject.publish('some.message', value: 'A Nasty Welcome Message')
+        subject.publish('other.message', value: 'A Random Welcome Message')
+      end
+
+      it 'should have no event registered' do
+        Basquiat::Adapters::Test.clean
+
+        expect(Basquiat::Adapters::Test.events).to be_empty
+      end
+    end
+  end
+end

data/spec/lib/basquiat_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Basquiat do
+  after(:all) do
+    Basquiat.configure do |config|
+      config.config_file = File.expand_path('../../support/basquiat.yml', __FILE__)
+    end
+  end
+
+  it 'should have a version number' do
+    expect(Basquiat::VERSION).not_to be_nil
+  end
+
+  it '#configure yields to a block' do
+    expect { |block| Basquiat.configure(&block) }.to yield_control
+  end
+
+  it '#configuration' do
+    expect(Basquiat.configuration).to be_a Basquiat::Configuration
+  end
+
+  it '#reset' do
+    config = Basquiat.configuration
+    Basquiat.reset
+    expect(Basquiat.configuration).not_to equal(config)
+  end
+end

data/spec/lib/interfaces/base_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+# Sample class used for testing
+class SampleClass
+  extend Basquiat::Base
+  self.event_adapter = Basquiat::Adapters::Test
+end
+
+describe Basquiat::Base do
+  subject { SampleClass }
+
+  it '.event_adapter' do
+    expect(subject).to respond_to(:event_adapter=)
+  end
+
+  it '.event_source(option_hash)' do
+    expect(subject).to respond_to(:adapter_options)
+  end
+
+  it 'set the adapter options' do
+    subject.adapter_options host: 'localhost', port: 5672, durable: true
+    expect(subject.adapter.options[:port]).to eq(5672)
+    expect(subject.adapter.options[:host]).to eq('localhost')
+    expect(subject.adapter.options[:durable]).to be_truthy
+  end
+
+  it 'delegates disconnect and connected? to the adapter' do
+    expect(subject.adapter).to receive(:connected?)
+    subject.connected?
+
+    expect(subject.adapter).to receive(:disconnect)
+    subject.disconnect
+  end
+
+  context 'using the defaults' do
+    class DefaultClass
+      extend Basquiat::Base
+    end
+
+    subject(:defaults) { DefaultClass }
+
+    it 'has an event_adapter' do
+      expect(defaults.adapter).to be_a(Basquiat::Adapters::Test)
+    end
+
+    it 'publishes to the configured queue and exchanges' do
+      expect do
+        subject.publish('test.message', message: 'useful test message')
+      end.to change { subject.adapter.events('test.message').size }.by(1)
+    end
+  end
+
+  context 'as a Producer' do
+    it '#publish' do
+      expect do
+        subject.publish('test.message', message: 'useful test message')
+      end.to change { subject.adapter.events('test.message').size }.by(1)
+    end
+  end
+
+  context 'as a Consumer' do
+    before(:each) do
+      subject.publish('some.event', 'test message')
+    end
+
+    after(:each) do
+      subject.adapter.events('some.event').clear
+    end
+
+    it 'reads a message from the queue' do
+      subject.subscribe_to 'some.event', ->(msg) { msg }
+      expect do
+        subject.listen(block: false)
+      end.to change { subject.adapter.events('some.event').size }.by(-1)
+    end
+
+    it 'runs the proc for each message' do
+      subject.subscribe_to('some.event', ->(msg) { "#{msg} LAMBDA LAMBDA LAMBDA" })
+      expect(subject.listen(block: false)).to match(/LAMBDA LAMBDA LAMBDA$/)
+    end
+
+    it 'can receive a symbol that will point to a method' do
+      def subject.test_method(msg)
+        msg.scan(/e/)
+      end
+
+      subject.subscribe_to('some.event', :test_method)
+      expect(subject.listen(block: false)).to eq(%w(e e e))
+    end
+  end
+
+  it 'trigger an event after processing a message' do
+    subject.publish('some.event', 'some message')
+    subject.instance_eval <<-METHCALL
+    subscribe_to 'some.event', ->(msg) { publish('other.event', "Redirected \#{msg}") }
+    METHCALL
+    expect { subject.listen(block: false) }.to_not raise_error
+    expect(subject.adapter.events('other.event').size).to eq(1)
+  end
+end

data/spec/lib/support/configuration_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Basquiat::Configuration do
+  subject(:config) { Basquiat::Configuration.new }
+
+  context 'accessors' do
+    it '#environment' do
+      expect(config.environment).to eq(:test)
+    end
+
+    it '#environment=' do
+      config.environment = 'test'
+      expect(config.environment).to eq(:test)
+    end
+
+    it '#queue_name' do
+      expect(config.queue_name).to eq('basquiat.queue')
+    end
+
+    it '#queue_name=' do
+      config.queue_name = 'basquiat.test'
+      expect(config.queue_name).to eq('basquiat.test')
+
+      config.queue_name = nil
+      expect(config.queue_name).to eq('basquiat.queue')
+    end
+
+    it '#exchange_name' do
+      expect(config.exchange_name).to eq('basquiat.exchange')
+    end
+
+    it '#exchange_name=' do
+      config.exchange_name = 'test'
+      expect(config.exchange_name).to eq('test')
+
+      config.exchange_name = nil
+      expect(config.exchange_name).to eq('basquiat.exchange')
+    end
+
+    it '#logger' do
+      expect(config.logger).not_to be_nil
+    end
+
+    it '#logger=' do
+      config.logger = Logger.new('/dev/null')
+      expect(config.logger).to be_a Logger
+    end
+  end
+
+  it '#config_file=' do
+    config.config_file = File.join(File.dirname(__FILE__), '../../support/basquiat.yml')
+
+    expect(config.queue_name).to eq('my.nice_queue')
+    expect(config.exchange_name).to eq('my.test_exchange')
+    expect(config.default_adapter).to eq('Basquiat::Adapters::Test')
+    expect(config.adapter_options).to have_key(:servers)
+  end
+
+  it 'settings provided on the config file have lower precedence' do
+    config.exchange_name = 'super.nice_exchange'
+    config.config_file = File.join(File.dirname(__FILE__), '../../support/basquiat.yml')
+
+    expect(config.exchange_name).to eq('super.nice_exchange')
+  end
+
+  it '#reload_classes' do
+    class MyTest
+      extend Basquiat::Base
+    end
+
+    config.reload_classes
+  end
+end

data/spec/lib/support/hash_refinements_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Basquiat::HashRefinements do
+  using Basquiat::HashRefinements
+
+  subject(:hash) do
+    { 'key' => 1, 'another_key' => 2, 3 => 3, 'array' => [1, 3, 5], 'hash' => { 'inner_key' => 6 } }
+  end
+
+  it '#deep_merge' do
+    hash.deep_merge({ 'hash' => { 'inner_key' => 7, 'other_inner_key' => 10 } })
+    expect(hash['hash']).to have_key('other_inner_key')
+    expect(hash['hash']['inner_key']).to eq(7)
+  end
+
+  it '#symbolize_keys' do
+    symbol_hash = hash.symbolize_keys
+    expect(symbol_hash).to have_key(:array)
+    expect(symbol_hash).to have_key(3)
+    expect(symbol_hash).to have_key(:hash)
+    expect(symbol_hash[:hash]).to have_key(:inner_key)
+  end
+
+end

data/spec/lib/support/json_spec.rb

@@ -0,0 +1,5 @@
+describe Basquiat::Json do
+  it "returns an empty hash if it can't parse the payload" do
+    expect(Basquiat::Json.decode('Idaho Potato')).to eq({})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter { |source| source.lines_of_code <= 3 }
+  add_filter { |source| source.filename =~ /spec/ }
+
+  add_group('Adapters') { |source| source.filename =~ /basquiat\/adapters/ }
+  add_group('Interfaces') { |source| source.filename =~ /basquiat\/interfaces/ }
+  add_group('Support') { |source| source.filename =~ /basquiat\/support/ }
+  add_group('Main Gem File') { |source| source.filename =~ %r{\/lib\/basquiat\.rb$} }
+end
+
+ENV['BASQUIAT_ENV'] = 'test'
+require 'basquiat'
+
+Basquiat.configure do |config|
+  config.config_file = File.expand_path('../support/basquiat.yml', __FILE__)
+end
+
+require 'support/shared_examples/basquiat_adapter_shared_examples'

data/spec/support/basquiat.yml

@@ -0,0 +1,9 @@
+test:
+  exchange_name: 'my.test_exchange'
+  queue_name: 'my.nice_queue'
+  default_adapter: Basquiat::Adapters::Test
+  adapter_options:
+      servers:
+        -
+          host: <%= ENV.fetch('BASQUIAT_RABBITMQ_1_PORT_5672_TCP_ADDR') { 'localhost' } %>
+          port: <%= ENV.fetch('BASQUIAT_RABBITMQ_1_PORT_5672_TCP_PORT') { 5672 } %>

data/spec/support/shared_examples/basquiat_adapter_shared_examples.rb

@@ -0,0 +1,23 @@
+shared_examples_for 'a Basquiat::Adapter' do
+  it '#adapter_options(opts)' do
+    expect(subject).to respond_to(:adapter_options)
+  end
+
+  it '#publish' do
+    expect(subject).to respond_to(:publish)
+  end
+
+  it '#default_options [template for option initialization]' do
+    expect(subject).to respond_to(:default_options)
+  end
+
+  it '#subscribe_to' do
+    expect(subject).to respond_to(:subscribe_to)
+  end
+
+  it 'merges the options with the default ones' do
+    opts = subject.instance_variable_get(:@options)
+    subject.adapter_options(nice_option: '127.0.0.2')
+    expect(opts[:nice_option]).to eq('127.0.0.2')
+  end
+end