freddy 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2496631f882b6eb9b44c6249eea9426415a6af2
-  data.tar.gz: 9eed09d9bce769a4fe87799b9517c26f0a606d0e
+  metadata.gz: e94ba387f99174d17ab66ed7caacbcc342a11a5f
+  data.tar.gz: debfccbc498a8262ad843b7f3dcb9af9e5e1dc12
 SHA512:
-  metadata.gz: 18e9eedeb5afdd6fbd2ae9256871e11e04b2850a086648c7584a3478e570c2720bdd39c9b24441c026994b2cf0f7708bb010c115690ba8422e0db70c9859d2a9
-  data.tar.gz: 2578e475defeb9b2ca3fe194f9bdf0881ebc0b7c10c74f3cce216f2b92d5cddef428ec12617db9308dc472894dbeb804ef798a38c05a5ceeec5503a6955b2f6d
+  metadata.gz: 0c9c4661349d96dd99ec104c5e3737cdb8f818beaf3c49f4450efadead9db70c1b6ab6493b9e93f08e142ac0bf32d5d5ccebe5e73bf2ed1a223c85ed9828a6b5
+  data.tar.gz: d2024c91c580911db393ddaca913db397f72a1bc7961256dd53451609840c12f8c1ef618d1c02861ed4801752658ae756364b60b239772fdac34c21eb3ad0625

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 pkg
 .tags
 .tags1
+coverage

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
   - 2.1.0
-  - jruby-9.0.0.0
+  - jruby-9.0.4.0
+addons:
+  code_climate:
+    repo_token: 1f3842b985fdeff6a36168165d491ca5f444667e9381a85c899a61706a9dd285
 services:
   - rabbitmq
 before_script:

data/Gemfile

@@ -1,8 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-group :test, :development do
-  gem 'rspec'
-  gem 'pry'
-end
+gem 'rspec'
+gem 'pry'
+gem 'codeclimate-test-reporter'
 
 gemspec

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/salemove/freddy.svg?branch=master)](https://travis-ci.org/salemove/freddy)
 [![Code Climate](https://codeclimate.com/github/salemove/freddy/badges/gpa.svg)](https://codeclimate.com/github/salemove/freddy)
+[![Test Coverage](https://codeclimate.com/github/salemove/freddy/badges/coverage.svg)](https://codeclimate.com/github/salemove/freddy/coverage)
 
 ## Setup
 

data/freddy.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   else
     spec.name          = "freddy"
   end
-  spec.version       = '0.5.3'
+  spec.version       = '0.5.5'
   spec.authors       = ["Urmas Talimaa"]
   spec.email         = ["urmas.talimaa@gmail.com"]
   spec.description   = %q{Messaging API}

data/lib/freddy/adapters/bunny_adapter.rb

@@ -45,26 +45,13 @@ class Freddy
         end
       end
 
-      class Queue
-        def initialize(queue)
-          @queue = queue
-        end
-
+      class Queue < Shared::Queue
         def subscribe(&block)
           @queue.subscribe do |info, properties, payload|
             parsed_payload = Payload.parse(payload)
             block.call(Delivery.new(parsed_payload, properties, info.routing_key))
           end
         end
-
-        def bind(*args)
-          @queue.bind(*args)
-          self
-        end
-
-        def name
-          @queue.name
-        end
       end
     end
   end

data/lib/freddy/adapters/march_hare_adapter.rb

@@ -44,26 +44,13 @@ class Freddy
         end
       end
 
-      class Queue
-        def initialize(queue)
-          @queue = queue
-        end
-
+      class Queue < Shared::Queue
         def subscribe(&block)
           @queue.subscribe do |meta, payload|
             parsed_payload = Payload.parse(payload)
             block.call(Delivery.new(parsed_payload, meta, meta.routing_key))
           end
         end
-
-        def bind(*args)
-          @queue.bind(*args)
-          self
-        end
-
-        def name
-          @queue.name
-        end
       end
     end
   end

data/lib/freddy/adapters.rb

@@ -9,5 +9,22 @@ class Freddy
         BunnyAdapter
       end
     end
+
+    module Shared
+      class Queue
+        def initialize(queue)
+          @queue = queue
+        end
+
+        def bind(*args)
+          @queue.bind(*args)
+          self
+        end
+
+        def name
+          @queue.name
+        end
+      end
+    end
   end
 end

data/lib/freddy/consumers/respond_to_consumer.rb

@@ -6,14 +6,14 @@ class Freddy
         @logger = logger
       end
 
-      def consume(destination, channel, handler_factory, &block)
+      def consume(destination, channel, handler_adapter_factory, &block)
         consumer = consume_from_destination(destination, channel) do |delivery|
-          log_receive_event(destination, delivery)
+          Consumers.log_receive_event(@logger, destination, delivery)
 
-          handler = handler_factory.build(delivery.type, destination)
+          adapter = handler_adapter_factory.for(delivery)
 
-          msg_handler = MessageHandler.new(handler, delivery)
-          handler.handle_message delivery.payload, msg_handler, &block
+          msg_handler = MessageHandler.new(adapter, delivery)
+          block.call(delivery.payload, msg_handler)
         end
 
         ResponderHandler.new(consumer, @consume_thread_pool)
@@ -32,14 +32,6 @@ class Freddy
           block.call(delivery)
         end
       end
-
-      def log_receive_event(destination, delivery)
-        if defined?(Logasm) && @logger.is_a?(Logasm)
-          @logger.debug "Received message", queue: destination, payload: delivery.payload, correlation_id: delivery.correlation_id
-        else
-          @logger.debug "Received message on #{destination} with payload #{delivery.payload} with correlation_id #{delivery.correlation_id}"
-        end
-      end
     end
   end
 end

data/lib/freddy/consumers/response_consumer.rb

@@ -18,18 +18,10 @@ class Freddy
 
       def process_message(queue, delivery, &block)
         @dedicated_thread_pool.process do
-          log_receive_event(queue.name, delivery)
+          Consumers.log_receive_event(@logger, queue.name, delivery)
           block.call(delivery)
         end
       end
-
-      def log_receive_event(queue_name, delivery)
-        if defined?(Logasm) && @logger.is_a?(Logasm)
-          @logger.debug "Received message", queue: queue_name, payload: delivery.payload, correlation_id: delivery.correlation_id
-        else
-          @logger.debug "Received message on #{queue_name} with payload #{delivery.payload} with correlation_id #{delivery.correlation_id}"
-        end
-      end
     end
   end
 end

data/lib/freddy/consumers/tap_into_consumer.rb

@@ -1,7 +1,8 @@
 class Freddy
   module Consumers
     class TapIntoConsumer
-      def initialize(consume_thread_pool)
+      def initialize(consume_thread_pool, logger)
+        @logger = logger
         @consume_thread_pool = consume_thread_pool
       end
 
@@ -9,7 +10,7 @@ class Freddy
         queue = create_queue(pattern, channel)
 
         consumer = queue.subscribe do |delivery|
-          process_message(delivery, &block)
+          process_message(queue, delivery, &block)
         end
 
         ResponderHandler.new(consumer, @consume_thread_pool)
@@ -25,8 +26,9 @@ class Freddy
           .bind(topic_exchange, routing_key: pattern)
       end
 
-      def process_message(delivery, &block)
+      def process_message(queue, delivery, &block)
         @consume_thread_pool.process do
+          Consumers.log_receive_event(@logger, queue.name, delivery)
           block.call delivery.payload, delivery.routing_key
         end
       end

data/lib/freddy/consumers.rb

@@ -1 +1,13 @@
+class Freddy
+  module Consumers
+    def self.log_receive_event(logger, queue_name, delivery)
+      if defined?(Logasm) && logger.is_a?(Logasm)
+        logger.debug "Received message", queue: queue_name, payload: delivery.payload, correlation_id: delivery.correlation_id
+      else
+        logger.debug "Received message on #{queue_name} with payload #{delivery.payload} with correlation_id #{delivery.correlation_id}"
+      end
+    end
+  end
+end
+
 Dir[File.dirname(__FILE__) + '/consumers/*.rb'].each(&method(:require))

data/lib/freddy/message_handler.rb

@@ -1,19 +1,16 @@
 class Freddy
   class MessageHandler
-    attr_reader :correlation_id
-
     def initialize(adapter, delivery)
       @adapter = adapter
       @delivery = delivery
-      @correlation_id = @delivery.correlation_id
     end
 
     def success(response = nil)
-      @adapter.success(@delivery.reply_to, response)
+      @adapter.success(@delivery, response)
     end
 
-    def error(error = {error: "Couldn't process message"})
-      @adapter.error(@delivery.reply_to, error)
+    def error(response = {error: "Couldn't process message"})
+      @adapter.error(@delivery, response)
     end
   end
 end

data/lib/freddy/message_handler_adapaters.rb

@@ -0,0 +1,50 @@
+class Freddy
+  module MessageHandlerAdapters
+    class Factory
+      def initialize(producer)
+        @no_op_handler = NoOpHandler.new
+        @request_handler = RequestHandler.new(producer)
+      end
+
+      def for(delivery)
+        if delivery.type == 'request'
+          @request_handler
+        else
+          @no_op_handler
+        end
+      end
+    end
+
+    class NoOpHandler
+      def success(*)
+        # NOP
+      end
+
+      def error(*)
+        # NOP
+      end
+    end
+
+    class RequestHandler
+      def initialize(producer)
+        @producer = producer
+      end
+
+      def success(delivery, response)
+        send_response(delivery, response, type: 'success')
+      end
+
+      def error(delivery, response)
+        send_response(delivery, response, type: 'error')
+      end
+
+      private
+
+      def send_response(delivery, response, opts = {})
+        @producer.produce delivery.reply_to.force_encoding('utf-8'), response, {
+          correlation_id: delivery.correlation_id
+        }.merge(opts)
+      end
+    end
+  end
+end

data/lib/freddy/producers/send_and_wait_response_producer.rb

@@ -87,11 +87,6 @@ class Freddy
         @logger.debug "Got response for request to #{request[:destination]} "\
                       "with correlation_id #{delivery.correlation_id}"
         request[:callback].call(delivery.payload, delivery)
-      rescue => e
-        @logger.error "Exception occured while handling the response of "\
-                      "request made to #{request[:destination]} with "\
-                      "correlation_id #{correlation_id}: #{Utils.format_exception(e)}"
-        Utils.notify_exception(e, destination: request[:destination], correlation_id: correlation_id)
       end
     end
   end

data/lib/freddy/sync_response_container.rb

@@ -5,12 +5,13 @@ class Freddy
   class SyncResponseContainer
     def initialize
       @mutex = Mutex.new
+      @resource = ConditionVariable.new
     end
 
     def call(response, delivery)
       @response = response
       @delivery = delivery
-      @mutex.synchronize { @waiting.wakeup }
+      @mutex.synchronize { @resource.signal }
     end
 
     def on_timeout(&block)
@@ -18,10 +19,7 @@ class Freddy
     end
 
     def wait_for_response(timeout)
-      @mutex.synchronize do
-        @waiting = Thread.current
-        @mutex.sleep(timeout)
-      end
+      @mutex.synchronize { @resource.wait(@mutex, timeout) }
 
       if !defined?(@response)
         @on_timeout.call

data/lib/freddy/utils.rb

@@ -1,12 +1,10 @@
 class Freddy
   class Utils
     def self.format_exception(exception)
-      backtrace = exception.backtrace.map do |x|
-        x.match(/^(.+?):(\d+)(|:in `(.+)')$/);
-        [$1, $2, $4]
-      end.join("\n")
+      message = exception.message
+      backtrace = exception.backtrace.join("\n")
 
-      "#{exception.exception}\n#{backtrace}"
+      "#{message}\n#{backtrace}"
     end
 
     def self.notify(name, message, parameters={})

data/lib/freddy.rb

@@ -34,7 +34,7 @@ class Freddy
     @connection = connection
     @logger = logger
 
-    @tap_into_consumer = Consumers::TapIntoConsumer.new(consume_thread_pool)
+    @tap_into_consumer = Consumers::TapIntoConsumer.new(consume_thread_pool, @logger)
     @respond_to_consumer = Consumers::RespondToConsumer.new(consume_thread_pool, @logger)
 
     @send_and_forget_producer = Producers::SendAndForgetProducer.new(
@@ -75,9 +75,11 @@ class Freddy
 
     channel = @connection.create_channel
     producer = Producers::ReplyProducer.new(channel, @logger)
-    handler_factory = MessageHandlers::Factory.new(producer, @logger)
+    handler_adapter_factory = MessageHandlerAdapters::Factory.new(producer)
 
-    @respond_to_consumer.consume(destination, channel, handler_factory, &callback)
+    @respond_to_consumer.consume(
+      destination, channel, handler_adapter_factory, &callback
+    )
   end
 
   # Listens for messages without consuming them

data/spec/freddy/consumers_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Freddy::Consumers do
+  describe '.log_receive_event' do
+    subject { described_class.log_receive_event(logger, queue_name, delivery) }
+
+    let(:queue_name) { 'salemove' }
+    let(:delivery) do
+      instance_double(Freddy::Delivery,
+        payload: {key: 'value'},
+        correlation_id: 'a1b2'
+      )
+    end
+
+    context 'when configured with logasm logger' do
+      let(:logger) { logasm_class.new }
+      let(:logasm_class) { Class.new }
+
+      before do
+        stub_const('::Logasm', logasm_class)
+      end
+
+      it 'logs the received event' do
+        expect(logger).to receive(:debug).with('Received message',
+          queue: 'salemove', payload: {key: 'value'}, correlation_id: 'a1b2'
+        )
+
+        subject
+      end
+    end
+
+    context 'when configured with regular logger' do
+      let(:logger) { Logger.new('/dev/null') }
+
+      it 'logs the received event' do
+        expect(logger).to receive(:debug)
+          .with('Received message on salemove with payload {:key=>"value"} with correlation_id a1b2')
+
+        subject
+      end
+    end
+  end
+end

data/spec/freddy/message_handler_spec.rb

@@ -4,12 +4,11 @@ describe Freddy::MessageHandler do
   subject(:handler) { described_class.new(adapter, delivery) }
 
   let(:adapter) { double }
-  let(:delivery) { double(reply_to: reply_to, correlation_id: 'abc') }
-  let(:reply_to) { double }
+  let(:delivery) { double }
 
   describe '#success' do
     it 'delegates to the adapter' do
-      expect(adapter).to receive(:success).with(reply_to, x: 'y')
+      expect(adapter).to receive(:success).with(delivery, x: 'y')
 
       subject.success(x: 'y')
     end
@@ -17,7 +16,7 @@ describe Freddy::MessageHandler do
 
   describe '#error' do
     it 'delegates to the adapter' do
-      expect(adapter).to receive(:error).with(reply_to, error: 'text')
+      expect(adapter).to receive(:error).with(delivery, error: 'text')
 
       subject.error(error: 'text')
     end

data/spec/freddy/sync_response_container_spec.rb

@@ -37,4 +37,20 @@ describe Freddy::SyncResponseContainer do
       }.to raise_error(StandardError, 'unexpected nil value for response')
     end
   end
+
+  describe '#wait_for_response' do
+    let(:timeout) { 2 }
+    let(:response) { {msg: 'response'} }
+    let(:delivery) { OpenStruct.new(type: 'success') }
+
+    context 'when called after #call' do
+      before do
+        container.call(response, delivery)
+      end
+
+      it 'returns response' do
+        expect(container.wait_for_response(timeout)).to eq(response)
+      end
+    end
+  end
 end

data/spec/freddy/utils_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Freddy::Utils do
+  describe '.format_exception' do
+    subject { described_class.format_exception(exception) }
+
+    let(:exception) { double(backtrace: backtrace, message: message) }
+    let(:message)   { 'format exception test' }
+    let(:backtrace) { ['line1', 'line2', 'line3'] }
+
+    it 'format the exception' do
+      should eq "format exception test\n" \
+        "line1\n" \
+        "line2\n" \
+        'line3'
+    end
+  end
+
+  describe '.notify' do
+    subject { described_class.notify(error_class, error_message, parameters) }
+
+    let(:env_attributes) { double }
+    let(:error_class)    { double }
+    let(:error_message)  { double }
+    let(:parameters)     { double }
+
+    context 'when Airbrake is defined' do
+      let(:airbrake) { double }
+
+      before do
+        allow(ENV).to receive(:to_hash) { env_attributes }
+        stub_const('::Airbrake', airbrake)
+      end
+
+      it 'notifies airbrake' do
+        expect(airbrake).to receive(:notify_or_ignore).with(
+          error_class: error_class,
+          error_message: error_message,
+          cgi_data: env_attributes,
+          parameters: parameters
+        )
+
+        subject
+      end
+    end
+
+    context 'when Airbrake is not defined' do
+      it 'does nothing' do
+        should eq(nil)
+      end
+    end
+  end
+
+  describe '.notify_exception' do
+    subject { described_class.notify_exception(exception, {a: 'b'}) }
+
+    let(:exception) { double }
+
+    context 'when Airbrake is defined' do
+      let(:airbrake) { double }
+
+      before do
+        stub_const('::Airbrake', airbrake)
+      end
+
+      it 'notifies airbrake' do
+        expect(airbrake).to receive(:notify_or_ignore) do |ex, content|
+          expect(ex).to eq(exception)
+          expect(content[:cgi_data]).to be_instance_of(Hash)
+          expect(content[:parameters]).to eq(a: 'b')
+        end
+
+        subject
+      end
+    end
+
+    context 'when Airbrake is not defined' do
+      it 'does nothing' do
+        should eq(nil)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,16 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'codeclimate-test-reporter'
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ])
+  add_filter '/spec/'
+end
+
 require 'pry'
 require 'securerandom'
 require 'freddy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freddy
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - Urmas Talimaa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,7 +124,7 @@ files:
 - lib/freddy/error_response.rb
 - lib/freddy/invalid_request_error.rb
 - lib/freddy/message_handler.rb
-- lib/freddy/message_handlers.rb
+- lib/freddy/message_handler_adapaters.rb
 - lib/freddy/payload.rb
 - lib/freddy/producers.rb
 - lib/freddy/producers/reply_producer.rb
@@ -136,11 +136,13 @@ files:
 - lib/freddy/timeout_error.rb
 - lib/freddy/utils.rb
 - spec/freddy/consumers/respond_to_consumer_spec.rb
+- spec/freddy/consumers_spec.rb
 - spec/freddy/error_response_spec.rb
 - spec/freddy/freddy_spec.rb
 - spec/freddy/message_handler_spec.rb
 - spec/freddy/responder_handler_spec.rb
 - spec/freddy/sync_response_container_spec.rb
+- spec/freddy/utils_spec.rb
 - spec/integration/concurrency_spec.rb
 - spec/integration/logging_spec.rb
 - spec/integration/reply_spec.rb
@@ -171,11 +173,13 @@ specification_version: 4
 summary: API for inter-application messaging supporting acknowledgements and request-response
 test_files:
 - spec/freddy/consumers/respond_to_consumer_spec.rb
+- spec/freddy/consumers_spec.rb
 - spec/freddy/error_response_spec.rb
 - spec/freddy/freddy_spec.rb
 - spec/freddy/message_handler_spec.rb
 - spec/freddy/responder_handler_spec.rb
 - spec/freddy/sync_response_container_spec.rb
+- spec/freddy/utils_spec.rb
 - spec/integration/concurrency_spec.rb
 - spec/integration/logging_spec.rb
 - spec/integration/reply_spec.rb

data/lib/freddy/message_handlers.rb

@@ -1,77 +0,0 @@
-class Freddy
-  module MessageHandlers
-    class Factory
-      def initialize(producer, logger)
-        @producer = producer
-        @logger = logger
-      end
-
-      def build(type, destination)
-        if type == 'request'
-          RequestHandler.new(@producer, destination, @logger)
-        else
-          StandardMessageHandler.new(destination, @logger)
-        end
-      end
-    end
-
-    class StandardMessageHandler
-      def initialize(destination, logger)
-        @destination = destination
-        @logger = logger
-      end
-
-      def handle_message(payload, msg_handler, &block)
-        block.call payload, msg_handler
-      rescue Exception => e
-        @logger.error "Exception occured while processing message from #{Utils.format_exception(e)}"
-        Utils.notify_exception(e, destination: @destination)
-      end
-
-      def success(*)
-        # NOP
-      end
-
-      def error(*)
-        # NOP
-      end
-    end
-
-    class RequestHandler
-      def initialize(producer, destination, logger)
-        @producer = producer
-        @logger = logger
-        @destination = destination
-      end
-
-      def handle_message(payload, msg_handler, &block)
-        @correlation_id = msg_handler.correlation_id
-
-        if !@correlation_id
-          @logger.error "Received request without correlation_id"
-        else
-          block.call payload, msg_handler
-        end
-      rescue Exception => e
-        @logger.error "Exception occured while handling the request with correlation_id #{@correlation_id}: #{Utils.format_exception(e)}"
-        Utils.notify_exception(e, correlation_id: @correlation_id, destination: @destination)
-      end
-
-      def success(reply_to, response)
-        send_response(reply_to, response, type: 'success')
-      end
-
-      def error(reply_to, response)
-        send_response(reply_to, response, type: 'error')
-      end
-
-      private
-
-      def send_response(reply_to, response, opts = {})
-        @producer.produce reply_to.force_encoding('utf-8'), response, {
-          correlation_id: @correlation_id
-        }.merge(opts)
-      end
-    end
-  end
-end