dkastner-hutch 0.17.1

data/spec/hutch/error_handlers/honeybadger_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Honeybadger do
+  let(:error_handler) { Hutch::ErrorHandlers::Honeybadger.new }
+
+  describe '#handle' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Honeybadger" do
+      message_id = "1"
+      payload = "{}"
+      consumer = double
+      ex = error
+      message = {
+        :error_class => ex.class.name,
+          :error_message => "#{ ex.class.name }: #{ ex.message }",
+          :backtrace => ex.backtrace,
+          :context => {
+            :message_id => message_id,
+            :consumer => consumer
+          },
+          :parameters => {
+            :payload => payload
+          }
+      }
+      expect(::Honeybadger).to receive(:notify_or_ignore).with(message)
+      error_handler.handle(message_id, payload, consumer, ex)
+    end
+  end
+end

data/spec/hutch/error_handlers/logger_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Logger do
+  let(:error_handler) { Hutch::ErrorHandlers::Logger.new }
+
+  describe '#handle' do
+    let(:error) { double(message: "Stuff went wrong", class: "RuntimeError",
+                       backtrace: ["line 1", "line 2"]) }
+
+    it "logs three separate lines" do
+      expect(Hutch::Logging.logger).to receive(:error).exactly(3).times
+      error_handler.handle("1", "{}", double, error)
+    end
+  end
+end

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Sentry do
+  let(:error_handler) { Hutch::ErrorHandlers::Sentry.new }
+
+  describe '#handle' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Sentry" do
+      expect(Raven).to receive(:capture_exception).with(error)
+      error_handler.handle("1", "{}", double, error)
+    end
+  end
+end

data/spec/hutch/logger_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Hutch::Logging do
+  let(:dummy_object) do
+    class DummyObject
+      include Hutch::Logging
+    end
+  end
+
+  describe '#logger' do
+    context 'with the default logger' do
+      subject { Hutch::Logging.logger }
+
+      it { is_expected.to be_instance_of(Logger) }
+    end
+
+    context 'with a custom logger' do
+      let(:dummy_logger) { double("Dummy logger", warn: true, info: true) }
+      after { Hutch::Logging.setup_logger }
+
+      it "users the custom logger" do
+        Hutch::Logging.logger = dummy_logger
+        expect(Hutch::Logging.logger).to eq(dummy_logger)
+      end
+    end
+  end
+end
+

data/spec/hutch/message_spec.rb

@@ -0,0 +1,38 @@
+require 'hutch/message'
+
+describe Hutch::Message do
+  let(:delivery_info) { double('Delivery Info') }
+  let(:props) { double('Properties') }
+  let(:body) {{ foo: 'bar' }.with_indifferent_access}
+  let(:json_body) { MultiJson.dump(body) }
+  subject(:message) { Hutch::Message.new(delivery_info, props, json_body) }
+
+  describe '#body' do
+    subject { super().body }
+    it { is_expected.to eq(body) }
+  end
+
+  describe '[]' do
+    subject { message[:foo] }
+    it { is_expected.to eq('bar') }
+  end
+
+  [:message_id, :timestamp].each do |method|
+    describe method.to_s do
+      it 'delegates to @properties' do
+        expect(props).to receive(method)
+        message.send(method)
+      end
+    end
+  end
+
+  [:routing_key, :exchange].each do |method|
+    describe method.to_s do
+      it 'delegates to @delivery_info' do
+        expect(delivery_info).to receive(method)
+        message.send(method)
+      end
+    end
+  end
+end
+

data/spec/hutch/worker_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'hutch/worker'
+
+describe Hutch::Worker do
+  let(:consumer) { double('Consumer', routing_keys: %w( a b c ),
+                          get_queue_name: 'consumer', get_arguments: {}) }
+  let(:consumers) { [consumer, double('Consumer')] }
+  let(:broker) { Hutch::Broker.new }
+  subject(:worker) { Hutch::Worker.new(broker, consumers) }
+
+  describe '#setup_queues' do
+    it 'sets up queues for each of the consumers' do
+      consumers.each do |consumer|
+        expect(worker).to receive(:setup_queue).with(consumer)
+      end
+      worker.setup_queues
+    end
+  end
+
+  describe '#setup_queue' do
+    let(:queue) { double('Queue', bind: nil, subscribe: nil) }
+    before { allow(worker).to receive_messages(consumer_queue: queue) }
+    before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
+
+    it 'creates a queue' do
+      expect(broker).to receive(:queue).with(consumer.get_queue_name, consumer.get_arguments).and_return(queue)
+      worker.setup_queue(consumer)
+    end
+
+    it 'binds the queue to each of the routing keys' do
+      expect(broker).to receive(:bind_queue).with(queue, %w( a b c ))
+      worker.setup_queue(consumer)
+    end
+
+    it 'sets up a subscription' do
+      expect(queue).to receive(:subscribe).with(manual_ack: true)
+      worker.setup_queue(consumer)
+    end
+  end
+
+  describe '#handle_message' do
+    let(:payload) { '{}' }
+    let(:consumer_instance) { double('Consumer instance') }
+    let(:delivery_info) { double('Delivery Info', routing_key: '',
+                                 delivery_tag: 'dt') }
+    let(:properties) { double('Properties', message_id: nil) }
+    before { allow(consumer).to receive_messages(new: consumer_instance) }
+    before { allow(broker).to receive(:ack) }
+    before { allow(broker).to receive(:nack) }
+    before { allow(consumer_instance).to receive(:broker=) }
+    before { allow(consumer_instance).to receive(:delivery_info=) }
+
+    it 'passes the message to the consumer' do
+      expect(consumer_instance).to receive(:process).
+                        with(an_instance_of(Hutch::Message))
+      worker.handle_message(consumer, delivery_info, properties, payload)
+    end
+
+    it 'acknowledges the message' do
+      allow(consumer_instance).to receive(:process)
+      expect(broker).to receive(:ack).with(delivery_info.delivery_tag)
+      worker.handle_message(consumer, delivery_info, properties, payload)
+    end
+
+    context 'when the consumer raises an exception' do
+      before { allow(consumer_instance).to receive(:process).and_raise('a consumer error') }
+
+      it 'logs the error' do
+        Hutch::Config[:error_handlers].each do |backend|
+          expect(backend).to receive(:handle)
+        end
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+
+      it 'rejects the message' do
+        expect(broker).to receive(:nack).with(delivery_info.delivery_tag)
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+    end
+
+    context "when the payload is not valid json" do
+      let(:payload) { "Not Valid JSON" }
+
+      it 'logs the error' do
+        Hutch::Config[:error_handlers].each do |backend|
+          expect(backend).to receive(:handle)
+        end
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+
+      it 'rejects the message' do
+        expect(broker).to receive(:nack).with(delivery_info.delivery_tag)
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+    end
+  end
+end
+

data/spec/hutch_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Hutch do
+  describe '.register_consumer' do
+    let(:consumer_a) { double('Consumer') }
+    let(:consumer_b) { double('Consumer') }
+
+    it 'saves the consumers in the global consumer list' do
+      Hutch.register_consumer(consumer_a)
+      Hutch.register_consumer(consumer_b)
+      expect(Hutch.consumers).to include consumer_a
+      expect(Hutch.consumers).to include consumer_b
+    end
+  end
+
+  describe '.connect' do
+    context 'not connected' do
+      let(:options) { double 'options' }
+      let(:config)  { double 'config' }
+      let(:broker)  { double 'broker' }
+      let(:action)  { Hutch.connect(options, config) }
+
+      it 'passes options and config' do
+        expect(Hutch::Broker).to receive(:new).with(config).and_return broker
+        expect(broker).to receive(:connect).with options
+
+        action
+      end
+
+    end
+
+    context 'connected' do
+      before { allow(Hutch).to receive(:connected?).and_return true }
+
+      it 'does not reconnect' do
+        expect(Hutch::Broker).not_to receive :new
+        Hutch.connect
+      end
+    end
+  end
+
+  describe '.connected?' do
+    subject(:connected?) { Hutch.connected? }
+
+    before { allow(Hutch).to receive(:broker).and_return(broker) }
+
+    context 'without a broker' do
+      let(:broker) { nil }
+
+      it { expect(connected?).to be_falsey }
+    end
+
+    context 'without a connection' do
+      let(:connection) { nil }
+      let(:broker) { double(:broker, connection: connection) }
+
+      it { expect(connected?).to be_falsey }
+    end
+
+    context 'with a closed connection' do
+      let(:connection) { double(:connection, open?: false) }
+      let(:broker) { double(:broker, connection: connection) }
+
+      it { expect(connected?).to be_falsey }
+    end
+
+    context 'with an opened connection' do
+      let(:connection) { double(:connection, open?: true) }
+      let(:broker) { double(:broker, connection: connection) }
+
+      it { expect(connected?).to be_truthy }
+    end
+  end
+
+  describe '#publish' do
+    let(:broker) { double(Hutch::Broker) }
+    let(:args) { ['test.key', 'message', { headers: { foo: 'bar' } }] }
+
+    before { allow(Hutch).to receive(:broker).and_return(broker) }
+
+    it 'delegates to Hutch::Broker#publish' do
+      expect(broker).to receive(:publish).with(*args)
+      Hutch.publish(*args)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'simplecov'
+if ENV['TRAVIS']
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/.bundle/'
+end
+
+require 'raven'
+require 'hutch'
+require 'logger'
+
+RSpec.configure do |config|
+  config.before(:all) { Hutch::Config.log_level = Logger::FATAL }
+  config.raise_errors_for_deprecations!
+end
+
+# Constants (classes, etc) defined within a block passed to this method
+# will be removed from the global namespace after the block as run.
+def isolate_constants
+  existing_constants = Object.constants
+  yield
+ensure
+  (Object.constants - existing_constants).each do |constant|
+    Object.send(:remove_const, constant)
+  end
+end
+
+def deep_copy(obj)
+  Marshal.load(Marshal.dump(obj))
+end
+

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: dkastner-hutch
+version: !ruby/object:Gem::Version
+  version: 0.17.1
+platform: ruby
+authors:
+- Harry Marr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: carrot-top
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: Hutch is a Ruby library for enabling asynchronous inter-service communication
+  using RabbitMQ.
+email:
+- developers@gocardless.com
+executables:
+- hutch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/hutch
+- circle.yml
+- examples/consumer.rb
+- examples/producer.rb
+- hutch.gemspec
+- lib/hutch.rb
+- lib/hutch/broker.rb
+- lib/hutch/cli.rb
+- lib/hutch/config.rb
+- lib/hutch/consumer.rb
+- lib/hutch/error_handlers.rb
+- lib/hutch/error_handlers/airbrake.rb
+- lib/hutch/error_handlers/honeybadger.rb
+- lib/hutch/error_handlers/logger.rb
+- lib/hutch/error_handlers/sentry.rb
+- lib/hutch/exceptions.rb
+- lib/hutch/logging.rb
+- lib/hutch/message.rb
+- lib/hutch/tracers.rb
+- lib/hutch/tracers/newrelic.rb
+- lib/hutch/tracers/null_tracer.rb
+- lib/hutch/version.rb
+- lib/hutch/worker.rb
+- spec/hutch/broker_spec.rb
+- spec/hutch/cli_spec.rb
+- spec/hutch/config_spec.rb
+- spec/hutch/consumer_spec.rb
+- spec/hutch/error_handlers/airbrake_spec.rb
+- spec/hutch/error_handlers/honeybadger_spec.rb
+- spec/hutch/error_handlers/logger_spec.rb
+- spec/hutch/error_handlers/sentry_spec.rb
+- spec/hutch/logger_spec.rb
+- spec/hutch/message_spec.rb
+- spec/hutch/worker_spec.rb
+- spec/hutch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/hutch
+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: Easy inter-service communication using RabbitMQ.
+test_files:
+- spec/hutch/broker_spec.rb
+- spec/hutch/cli_spec.rb
+- spec/hutch/config_spec.rb
+- spec/hutch/consumer_spec.rb
+- spec/hutch/error_handlers/airbrake_spec.rb
+- spec/hutch/error_handlers/honeybadger_spec.rb
+- spec/hutch/error_handlers/logger_spec.rb
+- spec/hutch/error_handlers/sentry_spec.rb
+- spec/hutch/logger_spec.rb
+- spec/hutch/message_spec.rb
+- spec/hutch/worker_spec.rb
+- spec/hutch_spec.rb
+- spec/spec_helper.rb