hutch 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4edfb298acf9e73fb226a3708e76d7e99ad345e3
-  data.tar.gz: d17eb84b63b21b42501570196abe6ef57ca94cde
+  metadata.gz: 0a8fca35975c1fa959a90ec608e978fe3f6c523b
+  data.tar.gz: b8b8df85e625956eb974403d37180dfecfff03b4
 SHA512:
-  metadata.gz: 99ba07374f0f8bcf407ef537ea0a8342cb4368cf323c0f41deee27a37e1b6cf156dc6a72645bf2ecc6181219a0723c9c6795035d7ac3cc46ad4783f936edd516
-  data.tar.gz: 8a6abf7f30f6dcb3c88d968deba3115389b6a043293a75609ff5e441c94da55ac3c31d81dad4049f52710ac12bff59d4643f878ee40bac143d35b3070edf8c84
+  metadata.gz: f0043f3e29a151a24b38cd18f3f4d8737c37ce77b99001d4fcac6f533904a7eeabdc478bf9b3cd7ac51385ba1da4d97327c71434bbf8ea6fdc026bd4b0431a52
+  data.tar.gz: cde750774fa801338a7e54103566eeaff7cd91c6e930c3251fa4f5521ee3599ac19599ab066ca9581f6ee7919d0e769b70818c6337029644ae97d3f3e0cc3672

data/.travis.yml

@@ -3,6 +3,5 @@ rvm:
   - "2.2"
   - "2.1"
   - "2.0"
-  - "1.9.3"
 services:
   - rabbitmq

data/CHANGELOG.md

@@ -1,4 +1,33 @@
-## 0.15.0 — (unreleased)
+## 0.16.0 — July 19th, 2015
+
+### Support amqps URIs
+
+Hutch now automatically enables TLS and changes default port
+when URI scheme is `amqps`.
+
+Contributed by Carl Hörberg.
+
+### Hash With Indifferent Access
+
+Hutch now uses `HashWithIndifferentAccess` internally
+to reduce use of symbols (which are not garbage collected
+by widely used Ruby versions).
+
+Contributed by Teodor Pripoae.
+
+
+## 0.15.0 — May 5th, 2015
+
+### Airbrake Error Handler
+
+Contributed by Nate Salisbury.
+
+### Ruby 1.9 Support Dropped
+
+Ruby 1.9 is no longer supported by Hutch (and soon Bunny 2.0).
+1.9 is also no longer maintained by the Ruby core team.
+
+### Custom Arguments per Consumers
 
 Allow to set custom arguments per consumers by using the `arguments` setter.
 Arguments are usually used by rabbitmq plugins or to set queue policies. You can
@@ -6,6 +35,23 @@ find a list of supported arguments [here](https://www.rabbitmq.com/extensions.ht
 
 Contributed by Pierre-Louis Gottfrois.
 
+### Message Processing Tracers
+
+Allow to track message processing by using the `:tracer` config option,
+the value should be a class (or fully-qualified string name of a class) that
+implements the tracing interface.
+
+A tracer that performs NewRelic instrumentation ships with Hutch
+and requires New Relic gem to be loaded.
+
+Contributed by Mirosław Nagaś.
+
+### Added Logger Method to Consumer Module
+
+Consumers can now call a logger method to write to Hutch's log.
+
+Contributed by Matty Courtney
+
 ## 0.14.0 — Feb 23rd, 2015
 
 ### Configurable Socket Timeouts

data/Gemfile

@@ -12,6 +12,8 @@ group :development, :test do
   gem "sentry-raven"
   gem "honeybadger"
   gem "coveralls", require: false
+  gem "newrelic_rpm"
+  gem "airbrake"
 end
 
 group :development, :darwin do

data/README.md

@@ -93,6 +93,21 @@ end
 
 Custom queue arguments can be found on [this page](https://www.rabbitmq.com/extensions.html).
 
+Consumers can write to Hutch's log by calling the logger method. The logger method returns
+a [Logger object](http://ruby-doc.org/stdlib-2.1.2/libdoc/logger/rdoc/Logger.html).
+
+```ruby
+class FailedPaymentConsumer
+  include Hutch::Consumer
+  consume 'gc.ps.payment.failed'
+  
+  def process(message)
+    logger.info "Marking payment #{message[:id]} as failed"
+    mark_payment_as_failed(message[:id])
+  end
+end
+```
+
 If you are using Hutch with Rails and want to make Hutch log to the Rails
 logger rather than `stdout`, add this to `config/initializers/hutch.rb`
 
@@ -103,6 +118,15 @@ Hutch::Logging.logger = Rails.logger
 See this [RabbitMQ tutorial on topic exchanges](http://www.rabbitmq.com/tutorials/tutorial-five-ruby.html)
 to learn more.
 
+### Message Processing Tracers
+
+Tracers allow you to track message processing.
+
+#### NewRelic
+```ruby
+Hutch::Config.set(:tracer, Hutch::Tracers::NewRelic)
+```
+This will enable NewRelic custom instrumentation. Batteries included! Screenshoots available [here](https://monosnap.com/list/557020a000779174f23467e3).
 
 ## Running Hutch
 
@@ -271,6 +295,7 @@ Known configuration parameters are:
  * `connection_timeout`: Bunny's socket open timeout (default: `11`)
  * `read_timeout`: Bunny's socket read timeout (default: `11`)
  * `write_timemout`: Bunny's socket write timeout (default: `11`)
+ * `tracer`: tracer to use to track message processing
 
 
 ## Supported RabbitMQ Versions

data/hutch.gemspec

@@ -4,6 +4,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'bunny', '>= 1.7.0'
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
   gem.add_runtime_dependency 'multi_json', '~> 1.5'
+  gem.add_runtime_dependency 'activesupport', '>= 3.0'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'simplecov', '~> 0.7.1'
 

data/lib/hutch.rb

@@ -8,6 +8,7 @@ require 'hutch/cli'
 require 'hutch/version'
 require 'hutch/error_handlers'
 require 'hutch/exceptions'
+require 'hutch/tracers'
 
 module Hutch
 

data/lib/hutch/broker.rb

@@ -24,6 +24,12 @@ module Hutch
         logger.info "HTTP API use is disabled"
       end
 
+      if tracing_enabled?
+        logger.info "tracing is enabled using #{@config[:tracer]}"
+      else
+        logger.info "tracing is disabled"
+      end
+
       if block_given?
         begin
           yield
@@ -63,10 +69,12 @@ module Hutch
         @config[:mq_vhost]    = u.path.sub(/^\//, "")
         @config[:mq_username] = u.user
         @config[:mq_password] = u.password
+        @config[:mq_tls]      = u.scheme == "amqps"
       end
 
+      tls                = @config[:mq_tls]
       host               = @config[:mq_host]
-      port               = @config[:mq_port]
+      port               = @config.fetch(:mq_port, (tls ? 5671 : 5672))
       vhost              = if @config[:mq_vhost] && "" != @config[:mq_vhost]
                              @config[:mq_vhost]
                            else
@@ -74,7 +82,6 @@ module Hutch
                            end
       username           = @config[:mq_username]
       password           = @config[:mq_password]
-      tls                = @config[:mq_tls]
       tls_key            = @config[:mq_tls_key]
       tls_cert           = @config[:mq_tls_cert]
       heartbeat          = @config[:heartbeat]
@@ -82,8 +89,8 @@ module Hutch
       read_timeout       = @config[:read_timeout]
       write_timeout      = @config[:write_timeout]
 
-      protocol           = tls ? "amqps://" : "amqp://"
-      sanitized_uri      = "#{protocol}#{username}@#{host}:#{port}/#{vhost.sub(/^\//, '')}"
+      scheme             = tls ? "amqps" : "amqp"
+      sanitized_uri      = "#{scheme}://#{username}@#{host}:#{port}/#{vhost.sub(/^\//, '')}"
       logger.info "connecting to rabbitmq (#{sanitized_uri})"
       @connection = Bunny.new(host: host, port: port, vhost: vhost,
                               tls: tls, tls_key: tls_key, tls_cert: tls_cert,
@@ -140,6 +147,10 @@ module Hutch
       op && cf
     end
 
+    def tracing_enabled?
+      @config[:tracer] && @config[:tracer] != Hutch::Tracers::NullTracer
+    end
+
     # Create / get a durable queue and apply namespace if it exists.
     def queue(name, arguments = {})
       with_bunny_precondition_handler('queue') do

data/lib/hutch/config.rb

@@ -30,6 +30,7 @@ module Hutch
         require_paths: [],
         autoload_rails: true,
         error_handlers: [Hutch::ErrorHandlers::Logger.new],
+        tracer: Hutch::Tracers::NullTracer,
         namespace: nil,
         daemonise: false,
         pidfile: nil,
@@ -84,7 +85,16 @@ module Hutch
 
     def self.load_from_file(file)
       YAML.load(ERB.new(File.read(file)).result).each do |attr, value|
-        Hutch::Config.send("#{attr}=", value)
+        Hutch::Config.send("#{attr}=", convert_value(attr, value))
+      end
+    end
+
+    def self.convert_value(attr, value)
+      case attr
+      when "tracer"
+        Kernel.const_get(value)
+      else
+        value
       end
     end
 

data/lib/hutch/consumer.rb

@@ -19,6 +19,10 @@ module Hutch
     def requeue!
       broker.requeue(delivery_info.delivery_tag)
     end
+    
+    def logger
+      Hutch::Logging.logger
+    end
 
     module ClassMethods
       # Add one or more routing keys to the set of routing keys the consumer

data/lib/hutch/error_handlers.rb

@@ -3,5 +3,6 @@ module Hutch
     autoload :Logger,      'hutch/error_handlers/logger'
     autoload :Sentry,      'hutch/error_handlers/sentry'
     autoload :Honeybadger, 'hutch/error_handlers/honeybadger'
+    autoload :Airbrake,    'hutch/error_handlers/airbrake'
   end
 end

data/lib/hutch/error_handlers/airbrake.rb

@@ -0,0 +1,26 @@
+require 'hutch/logging'
+require 'airbrake'
+
+module Hutch
+  module ErrorHandlers
+    class Airbrake
+      include Logging
+
+      def handle(message_id, payload, consumer, ex)
+        prefix = "message(#{message_id || '-'}): "
+        logger.error prefix + "Logging event to Airbrake"
+        logger.error prefix + "#{ex.class} - #{ex.message}"
+        ::Airbrake.notify_or_ignore(ex, {
+          :error_class => ex.class.name,
+          :error_message => "#{ ex.class.name }: #{ ex.message }",
+          :backtrace => ex.backtrace,
+          :parameters => {
+            :payload => payload,
+            :consumer => consumer,
+          },
+          :cgi_data => ENV.to_hash,
+        })
+      end
+    end
+  end
+end

data/lib/hutch/message.rb

@@ -1,5 +1,6 @@
 require 'multi_json'
 require 'forwardable'
+require 'active_support/core_ext/hash/indifferent_access'
 
 module Hutch
   class Message
@@ -11,7 +12,7 @@ module Hutch
       @delivery_info = delivery_info
       @properties    = properties
       @payload       = payload
-      @body          = MultiJson.load(payload, symbolize_keys: true)
+      @body          = MultiJson.load(payload).with_indifferent_access
     end
 
     def_delegator :@body, :[]

data/lib/hutch/tracers.rb

@@ -0,0 +1,6 @@
+module Hutch
+  module Tracers
+    autoload :NullTracer, 'hutch/tracers/null_tracer'
+    autoload :NewRelic,   'hutch/tracers/newrelic'
+  end
+end

data/lib/hutch/tracers/newrelic.rb

@@ -0,0 +1,19 @@
+require 'newrelic_rpm'
+
+module Hutch
+  module Tracers
+    class NewRelic
+      include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def handle(message)
+        @klass.process(message)
+      end
+
+      add_transaction_tracer :handle, :category => 'OtherTransaction/HutchConsumer', :path => '#{@klass.class.name}'
+    end
+  end
+end

data/lib/hutch/tracers/null_tracer.rb

@@ -0,0 +1,15 @@
+module Hutch
+  module Tracers
+    class NullTracer
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def handle(message)
+        @klass.process(message)
+      end
+
+    end
+  end
+end

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.15.0'.freeze
+  VERSION = '0.16.0'.freeze
 end
 

data/lib/hutch/worker.rb

@@ -81,7 +81,8 @@ module Hutch
       broker = @broker
       begin
         message = Message.new(delivery_info, properties, payload)
-        consumer.new.tap { |c| c.broker, c.delivery_info = @broker, delivery_info }.process(message)
+        consumer_instance = consumer.new.tap { |c| c.broker, c.delivery_info = @broker, delivery_info }
+        with_tracing(consumer_instance).handle(message)
         broker.ack(delivery_info.delivery_tag)
       rescue StandardError => ex
         broker.nack(delivery_info.delivery_tag)
@@ -89,6 +90,10 @@ module Hutch
       end
     end
 
+    def with_tracing(klass)
+      Hutch::Config[:tracer].new(klass)
+    end
+
     def handle_error(message_id, payload, consumer, ex)
       Hutch::Config[:error_handlers].each do |backend|
         backend.handle(message_id, payload, consumer, ex)

data/spec/hutch/error_handlers/airbrake_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Airbrake do
+  let(:error_handler) { Hutch::ErrorHandlers::Airbrake.new }
+
+  describe '#handle' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Airbrake" 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,
+        :parameters => {
+          :payload => payload,
+          :consumer => consumer,
+        },
+        :cgi_data => ENV.to_hash,
+      }
+      expect(::Airbrake).to receive(:notify_or_ignore).with(ex, message)
+      error_handler.handle(message_id, payload, consumer, ex)
+    end
+  end
+end

data/spec/hutch/message_spec.rb

@@ -3,7 +3,7 @@ require 'hutch/message'
 describe Hutch::Message do
   let(:delivery_info) { double('Delivery Info') }
   let(:props) { double('Properties') }
-  let(:body) {{ foo: 'bar' }}
+  let(:body) {{ foo: 'bar' }.with_indifferent_access}
   let(:json_body) { MultiJson.dump(body) }
   subject(:message) { Hutch::Message.new(delivery_info, props, json_body) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !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
@@ -108,18 +122,23 @@ files:
 - 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
@@ -148,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
@@ -157,6 +176,7 @@ test_files:
 - 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
@@ -165,4 +185,3 @@ test_files:
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
-has_rdoc: