hutch 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c16188d79e67f6645279e39fc3a628d70ebb2468
-  data.tar.gz: c82d50ef75cda6ac8482e66a561c9db6175166ec
+  metadata.gz: 3c92582d4268b9d9623c60f4b2588d4afc244c17
+  data.tar.gz: f783601d90dd7031c90c6a6372eb6f2b6b4ef2e4
 SHA512:
-  metadata.gz: 8d264879570aa9a3b7493ac5fdf9aa9739780073a6b6649cec0d9bced34a1558e677bc2f17c543cd9cdaab493d43e82d68da275668d16d74b42c61af7447990d
-  data.tar.gz: 6eb7f683f37389a6263bc8de520dc34084007d1cafe1ba11f6510be37bc02c3f05827dd9cbc1f4552570c8d1f81c7fd972ccc691a65ae09acd9c12f18cd797c0
+  metadata.gz: e40a52fafa102ec87c2df5e885dcffd48a0a6786b08cd4c133122e4da85a2a614aeca75513fbd4f3d464409b6d8189c8585ea4b9d456f893e44b97957ffcba0a
+  data.tar.gz: 19f8a9dc63bf258f9b0211f49f9b21a509266a1f09eb2d3e3865d3acc2d2eb13a6fdc5d4c682accbaf98ec6d4794f1775d28156723a62e88be2b68c651e4d8bc

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+## 0.14.0 — (unreleased)
+
+### Configurable Socket Timeouts
+
+Socket read and write timeouts are now configurable using
+the `read_timeout` and `write_timeout` options, respectively.
+
+Contributed by Chris Barton.
+
+
+### Logged Messages as Serialised as JSON
+
+...as opposed to Ruby object printing.
+
+Contributed by Andrew Morton.
+
+
+### Configurable Heartbeat
+
+Config now supports a new option: `:heartbeat`, which is passed
+on to Bunny.
+
+Contributed by Simon Taranto.
+
+
+### HoneyBadger Error Handler
+
+Contributed by Daniel Farrell.
+
+
+### Hutch.connected? Now Returns Up-to-Date Value
+
+`Hutch.connected?` no longer relies on an ivar and always returns
+an up-to-date value.
+
+Contributed by Pierre-Louis Gottfrois.
+
+
 ## 0.13.0 — Dec 5th, 2014
 
 ### HTTP API Can Be Disabled for Consumers

data/Gemfile

@@ -10,6 +10,7 @@ end
 
 group :development, :test do
   gem "sentry-raven"
+  gem "honeybadger"
   gem "coveralls", require: false
 end
 

data/README.md

@@ -242,12 +242,15 @@ Known configuration parameters are:
  * `force_publisher_confirms`: enables publisher confirms, forces `Hutch::Broker#wait_for_confirms` for every publish. **This is the safest option which also offers the lowest throughput**.
  * `log_level`: log level used by the standard Ruby logger (default: `Logger::INFO`)
  * `mq_exchange`: exchange to use for publishing (default: `hutch`)
+ * `heartbeat`: [RabbitMQ heartbeat timeout](http://rabbitmq.com/heartbeats.html) (default: `30`)
+ * `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`)
 
 
 ## Supported RabbitMQ Versions
 
-Hutch requires RabbitMQ 2.x or later. 3.x releases
-are recommended.
+Hutch requires RabbitMQ 3.3 or later.
 
 ---
 

data/hutch.gemspec

@@ -1,7 +1,7 @@
 require File.expand_path('../lib/hutch/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_runtime_dependency 'bunny', '>= 1.6.1'
+  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_development_dependency 'rspec', '~> 3.0'

data/lib/hutch.rb

@@ -35,15 +35,11 @@ module Hutch
     unless connected?
       @broker = Hutch::Broker.new(config)
       @broker.connect(options)
-      @connected = true
     end
   end
 
   def self.disconnect
-    if @broker
-      @broker.disconnect
-      @connected = false
-    end
+    @broker.disconnect if @broker
   end
 
   def self.broker
@@ -51,7 +47,9 @@ module Hutch
   end
 
   def self.connected?
-    @connected
+    return false unless broker
+    return false unless broker.connection
+    broker.connection.open?
   end
 
   def self.publish(*args)

data/lib/hutch/broker.rb

@@ -77,15 +77,22 @@ module Hutch
       tls                = @config[:mq_tls]
       tls_key            = @config[:mq_tls_key]
       tls_cert           = @config[:mq_tls_cert]
+      heartbeat          = @config[:heartbeat]
       connection_timeout = @config[:connection_timeout]
+      read_timeout       = @config[:read_timeout]
+      write_timeout      = @config[:write_timeout]
+
       protocol           = tls ? "amqps://" : "amqp://"
       sanitized_uri      = "#{protocol}#{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,
                               username: username, password: password,
-                              heartbeat: 30, automatically_recover: true,
-                              network_recovery_interval: 1, connection_timeout: connection_timeout)
+                              heartbeat: heartbeat, automatically_recover: true,
+                              network_recovery_interval: 1,
+                              connection_timeout: connection_timeout,
+                              read_timeout: read_timeout,
+                              write_timeout: write_timeout)
 
       with_bunny_connection_handler(sanitized_uri) do
         @connection.start
@@ -215,9 +222,9 @@ module Hutch
       }
       properties[:message_id] ||= generate_id
 
-      logger.info("publishing message '#{message.inspect}' to #{routing_key}")
-
-      response = @exchange.publish(JSON.dump(message), {persistent: true}.
+      json = JSON.dump(message)
+      logger.info("publishing message '#{json}' to #{routing_key}")
+      response = @exchange.publish(json, {persistent: true}.
         merge(properties).
         merge(global_properties).
         merge(non_overridable_properties))
@@ -241,7 +248,7 @@ module Hutch
     private
 
     def raise_publish_error(reason, routing_key, message)
-      msg = "Unable to publish - #{reason}. Message: #{message.inspect}, Routing key: #{routing_key}."
+      msg = "unable to publish - #{reason}. Message: #{JSON.dump(message)}, Routing key: #{routing_key}."
       logger.error(msg)
       raise PublishError, msg
     end

data/lib/hutch/config.rb

@@ -21,6 +21,7 @@ module Hutch
         mq_api_host: 'localhost',
         mq_api_port: 15672,
         mq_api_ssl: false,
+        heartbeat: 30,
         # placeholder, allows specifying connection parameters
         # as a URI.
         uri: nil,
@@ -40,6 +41,8 @@ module Hutch
         force_publisher_confirms: false,
         # Heroku needs > 10. MK.
         connection_timeout: 11,
+        read_timeout: 11,
+        write_timeout: 11,
         enable_http_api_use: true
       }.merge(params)
     end

data/lib/hutch/error_handlers.rb

@@ -1,6 +1,7 @@
 module Hutch
   module ErrorHandlers
-    autoload :Logger, 'hutch/error_handlers/logger'
-    autoload :Sentry, 'hutch/error_handlers/sentry'
+    autoload :Logger,      'hutch/error_handlers/logger'
+    autoload :Sentry,      'hutch/error_handlers/sentry'
+    autoload :Honeybadger, 'hutch/error_handlers/honeybadger'
   end
 end

data/lib/hutch/error_handlers/honeybadger.rb

@@ -0,0 +1,28 @@
+require 'hutch/logging'
+require 'honeybadger'
+
+module Hutch
+  module ErrorHandlers
+    class Honeybadger
+      include Logging
+
+      def handle(message_id, payload, consumer, ex)
+        prefix = "message(#{message_id || '-'}): "
+        logger.error prefix + "Logging event to Honeybadger"
+        logger.error prefix + "#{ex.class} - #{ex.message}"
+        ::Honeybadger.notify_or_ignore(
+          :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
+          }
+        )
+      end
+    end
+  end
+end

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end
 

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_spec.rb

@@ -27,11 +27,6 @@ describe Hutch do
         action
       end
 
-      it 'sets @connect' do
-        action
-
-        expect(Hutch.connected?).to be_truthy
-      end
     end
 
     context 'connected' do
@@ -44,6 +39,39 @@ describe Hutch do
     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' } }] }

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        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: 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
@@ -89,8 +89,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -108,6 +108,7 @@ files:
 - lib/hutch/config.rb
 - lib/hutch/consumer.rb
 - lib/hutch/error_handlers.rb
+- lib/hutch/error_handlers/honeybadger.rb
 - lib/hutch/error_handlers/logger.rb
 - lib/hutch/error_handlers/sentry.rb
 - lib/hutch/exceptions.rb
@@ -119,6 +120,7 @@ files:
 - spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_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
@@ -136,17 +138,17 @@ 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
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
@@ -155,6 +157,7 @@ test_files:
 - spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_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