hutch 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae290b72e28ca5ca72f8014fe5688e35b4c31716
-  data.tar.gz: 2a817eece4ab761d6558255395e123d5cea19ea0
+  metadata.gz: c5b96423188a88e607bf694005618e1c13bc6ce1
+  data.tar.gz: 97955f0060eea500cbd6cc49c3c393adccfaf8a6
 SHA512:
-  metadata.gz: b929abefa84452c0b5a74fc2dcfc5f2918fb752d80f97b77e97cf4d0fbfad99e119cd09f3251f17edf1450ee7ccc063a76efaa9e31d318526aabf5a147779b84
-  data.tar.gz: c5c04b649c3ea2333ff86273d7d17a1d843a02e782bd981d19ef2ea4025286761b4b96fd8200026ce2f503108d588c0aa61f204997632f02ac467ac5fa4633c3
+  metadata.gz: d161d2cf60136e26356a18f7a6f552fd11361bce6258132ce9dc807d219290f1fa67fda7f801fb58cacd542c224a93b4941c473aaa4c5ee3b43446632ab03c96
+  data.tar.gz: 7d2c9d3f0524a9583e76c853823a1527a9d516d7a2cf368aa061412442930e09d5a2b7855c915d4ab3e1ca8c39b2a82f0a864a6e51d558a420e1a9efd3d96cc1

data/CHANGELOG.md

@@ -1,4 +1,29 @@
-## 0.18.0 — (unreleased)
+## 0.19.0 — (unreleased)
+
+### Pluggable Serialisers
+
+Hutch now supports pluggable serialisers: see `Hutch::Serializer::JSON` for
+an example. Serialiser is configured via Hutch config as a Ruby
+class.
+
+Contributed by Dmitry Galinsky.
+
+
+### multi_json Update
+
+Hutch now depends on multi_json `1.11.x`.
+
+### Bunny Update
+
+Bunny is updated to [2.2.0](http://blog.rubyrabbitmq.info/blog/2015/09/06/bunny-2-dot-2-0-is-released/).
+
+### More Bunny SSL Options
+
+`:mq_tls_ca_certificates` and `:mq_verify_peer` options will now be passed on to Bunny as `:tls_ca_certificates` and `:verify_peer` respectively.
+
+Contributed by Kennon Ballou.
+
+## 0.18.0 — August 16th, 2015
 
 ### JRuby Support (Using March Hare)
 

data/README.md

@@ -289,6 +289,8 @@ Known configuration parameters are:
  * `mq_tls`: should TLS be used? (default: `false`)
  * `mq_tls_cert`: path to client TLS certificate (public key)
  * `mq_tls_key`: path to client TLS private key
+ * `mq_tls_ca_certificates`: array of paths to CA keys (if not specified to Hutch, will default to Bunny defaults which are system-dependent)
+ * `mq_verify_peer`: should SSL certificate be verified? (default: `true`)
  * `require_paths`: array of paths to require
  * `autoload_rails`: should Hutch command line runner try to automatically load Rails environment files?
  * `daemonise`: should Hutch runner process daemonise?

data/hutch.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |gem|
     gem.add_runtime_dependency 'march_hare', '>= 2.11.0'
   else
     gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '>= 1.7.0'
+    gem.add_runtime_dependency 'bunny', '>= 2.2.0'
   end
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
-  gem.add_runtime_dependency 'multi_json', '~> 1.5'
+  gem.add_runtime_dependency 'multi_json', '~> 1.11.2'
   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

@@ -3,6 +3,8 @@ require 'hutch/consumer'
 require 'hutch/worker'
 require 'hutch/broker'
 require 'hutch/logging'
+require 'hutch/serializers/identity'
+require 'hutch/serializers/json'
 require 'hutch/config'
 require 'hutch/message'
 require 'hutch/cli'

data/lib/hutch/broker.rb

@@ -195,19 +195,30 @@ module Hutch
       @channel.nack(delivery_tag, false, false)
     end
 
-    def publish(routing_key, message, properties = {})
+    def publish(routing_key, message, properties = {}, options = {})
       ensure_connection!(routing_key, message)
 
+      serializer = options[:serializer] || @config[:serializer]
+
       non_overridable_properties = {
-        routing_key: routing_key,
-        timestamp: @connection.current_timestamp,
-        content_type: 'application/json'
+        routing_key:  routing_key,
+        timestamp:    @connection.current_timestamp,
+        content_type: serializer.content_type,
+      }
+      properties[:message_id]   ||= generate_id
+
+      payload = serializer.encode(message)
+      logger.info {
+        spec =
+          if serializer.binary?
+            "#{payload.bytesize} bytes message"
+          else
+            "message '#{payload}'"
+          end
+        "publishing #{spec} to #{routing_key}"
       }
-      properties[:message_id] ||= generate_id
 
-      json = JSON.dump(message)
-      logger.info("publishing message '#{json}' to #{routing_key}")
-      response = @exchange.publish(json, {persistent: true}.
+      response = @exchange.publish(payload, {persistent: true}.
         merge(properties).
         merge(global_properties).
         merge(non_overridable_properties))
@@ -269,6 +280,10 @@ module Hutch
         params[:tls]                = @config[:mq_tls]
         params[:tls_key]            = @config[:mq_tls_key]
         params[:tls_cert]           = @config[:mq_tls_cert]
+        params[:verify_peer]        = @config[:mq_verify_peer]
+        if @config[:mq_tls_ca_certificates]
+          params[:tls_ca_certificates] = @config[:mq_tls_ca_certificates]
+        end
         params[:heartbeat]          = @config[:heartbeat]
         params[:connection_timeout] = @config[:connection_timeout]
         params[:read_timeout]       = @config[:read_timeout]
@@ -354,5 +369,6 @@ module Hutch
     def global_properties
       Hutch.global_properties.respond_to?(:call) ? Hutch.global_properties.call : Hutch.global_properties
     end
+
   end
 end

data/lib/hutch/config.rb

@@ -17,6 +17,8 @@ module Hutch
         mq_tls: false,
         mq_tls_cert: nil,
         mq_tls_key: nil,
+        mq_tls_ca_certificates: nil,
+        mq_verify_peer: true,
         mq_username: 'guest',
         mq_password: 'guest',
         mq_api_host: 'localhost',
@@ -53,6 +55,8 @@ module Hutch
         client_logger: nil,
 
         consumer_pool_size: 1,
+
+        serializer: Hutch::Serializers::JSON,
       }.merge(params)
     end
 

data/lib/hutch/consumer.rb

@@ -19,7 +19,7 @@ module Hutch
     def requeue!
       broker.requeue(delivery_info.delivery_tag)
     end
-    
+
     def logger
       Hutch::Logging.logger
     end
@@ -41,6 +41,11 @@ module Hutch
         @arguments = arguments
       end
 
+      # Set custom serializer class, override global value
+      def serializer(name)
+        @serializer = name
+      end
+
       # The RabbitMQ queue name for the consumer. This is derived from the
       # fully-qualified class name. Module separators are replaced with single
       # colons, camelcased class names are converted to snake case.
@@ -60,6 +65,10 @@ module Hutch
       def routing_keys
         @routing_keys ||= Set.new
       end
+
+      def get_serializer
+        @serializer
+      end
     end
   end
 end

data/lib/hutch/message.rb

@@ -1,6 +1,4 @@
-require 'multi_json'
 require 'forwardable'
-require 'active_support/core_ext/hash/indifferent_access'
 
 module Hutch
   class Message
@@ -8,11 +6,11 @@ module Hutch
 
     attr_reader :delivery_info, :properties, :payload
 
-    def initialize(delivery_info, properties, payload)
+    def initialize(delivery_info, properties, payload, serializer)
       @delivery_info = delivery_info
       @properties    = properties
       @payload       = payload
-      @body          = MultiJson.load(payload).with_indifferent_access
+      @body          = serializer.decode(payload)
     end
 
     def_delegator :@body, :[]

data/lib/hutch/serializers/identity.rb

@@ -0,0 +1,19 @@
+module Hutch
+  module Serializers
+    class Identity
+
+      def self.encode(payload)
+        payload
+      end
+
+      def self.decode(payload)
+        payload
+      end
+
+      def self.binary? ; false ; end
+
+      def self.content_type ; nil ; end
+
+    end
+  end
+end

data/lib/hutch/serializers/json.rb

@@ -0,0 +1,22 @@
+require 'multi_json'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Hutch
+  module Serializers
+    class JSON
+
+      def self.encode(payload)
+        ::JSON.dump(payload)
+      end
+
+      def self.decode(payload)
+        ::MultiJson.load(payload).with_indifferent_access
+      end
+
+      def self.binary? ; false ; end
+
+      def self.content_type ; 'application/json' ; end
+
+    end
+  end
+end

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.18.0'.freeze
+  VERSION = '0.19.0'.freeze
 end
 

data/lib/hutch/worker.rb

@@ -102,14 +102,18 @@ module Hutch
     # Called internally when a new messages comes in from RabbitMQ. Responsible
     # for wrapping up the message and passing it to the consumer.
     def handle_message(consumer, delivery_info, properties, payload)
-      logger.info("message(#{properties.message_id || '-'}): " +
-                  "routing key: #{delivery_info.routing_key}, " +
-                  "consumer: #{consumer}, " +
-                  "payload: #{payload}")
-
       broker = @broker
       begin
-        message = Message.new(delivery_info, properties, payload)
+        serializer = consumer.get_serializer || Hutch::Config[:serializer]
+        logger.info {
+          spec   = serializer.binary? ? "#{payload.bytesize} bytes" : "#{payload}"
+          "message(#{properties.message_id || '-'}): " +
+          "routing key: #{delivery_info.routing_key}, " +
+          "consumer: #{consumer}, " +
+          "payload: #{spec}"
+        }
+
+        message = Message.new(delivery_info, properties, payload, serializer)
         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)

data/spec/hutch/message_spec.rb

@@ -2,10 +2,10 @@ require 'hutch/message'
 
 describe Hutch::Message do
   let(:delivery_info) { double('Delivery Info') }
-  let(:props) { double('Properties') }
+  let(:props) { double('Properties', content_type: "application/json") }
   let(:body) {{ foo: 'bar' }.with_indifferent_access}
   let(:json_body) { MultiJson.dump(body) }
-  subject(:message) { Hutch::Message.new(delivery_info, props, json_body) }
+  subject(:message) { Hutch::Message.new(delivery_info, props, json_body, Hutch::Config[:serializer]) }
 
   describe '#body' do
     subject { super().body }

data/spec/hutch/serializers/json_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Hutch::Serializers::JSON do
+  let(:subject) { described_class }
+
+  it "encode/decode" do
+    payload = { a: 1, b: 2 }
+    encoded = subject.encode(payload)
+    decoded = subject.decode(encoded)
+
+    expect(encoded).to eq "{\"a\":1,\"b\":2}"
+    expect(decoded).to eq("a" => 1, "b" => 2)
+    expect(decoded[:a]).to eq 1
+    expect(decoded[:b]).to eq 2
+  end
+
+end

data/spec/hutch/worker_spec.rb

@@ -3,7 +3,8 @@ require 'hutch/worker'
 
 describe Hutch::Worker do
   let(:consumer) { double('Consumer', routing_keys: %w( a b c ),
-                          get_queue_name: 'consumer', get_arguments: {}) }
+                          get_queue_name: 'consumer', get_arguments: {},
+                          get_serializer: nil) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
   subject(:worker) { Hutch::Worker.new(broker, consumers) }
@@ -43,7 +44,7 @@ describe Hutch::Worker do
     let(:consumer_instance) { double('Consumer instance') }
     let(:delivery_info) { double('Delivery Info', routing_key: '',
                                  delivery_tag: 'dt') }
-    let(:properties) { double('Properties', message_id: nil) }
+    let(:properties) { double('Properties', message_id: nil, content_type: "application/json") }
     before { allow(consumer).to receive_messages(new: consumer_instance) }
     before { allow(broker).to receive(:ack) }
     before { allow(broker).to receive(:nack) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-16 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,8 @@ files:
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
 - lib/hutch/message.rb
+- lib/hutch/serializers/identity.rb
+- lib/hutch/serializers/json.rb
 - lib/hutch/tracers.rb
 - lib/hutch/tracers/newrelic.rb
 - lib/hutch/tracers/null_tracer.rb
@@ -147,6 +149,7 @@ files:
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
+- spec/hutch/serializers/json_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
@@ -185,6 +188,7 @@ test_files:
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
+- spec/hutch/serializers/json_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb