hutch 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5623aace290058a93c0c71c86f5de6f55ef7c689
-  data.tar.gz: 671e8f47f98013006f1a8de4cc07ea6e3dc8e036
+  metadata.gz: eeb23a1408742881e2fe57465b1ac93ff5f291c7
+  data.tar.gz: a690db26520da645ce2727d70f06757e1db9e161
 SHA512:
-  metadata.gz: 0c88548d9ebfaa4edffccfe90269231653709c2e4689d5b7f6063c5985c83f316ab4884c0fe8076b4e1325ff9f34ff97d3d0c876be6c7e758a7b5bc7ca1703c2
-  data.tar.gz: afb238ab42b8b4a7bc853202920cced777249c03606e40db6b80ef3dea71d00e1b20306a57bc831864981375837a15565723123132f354abdb030f1fb4a8c7ff
+  metadata.gz: 578a80bc3746ceb989bd569f0bbf838f7ceffeae97628fd06705d03a6d10c8945f3916184466ad397ce7f2052df0e1677602f85d5fa8074e5181fb8639ab4662
+  data.tar.gz: d03df05f440e75a3620ce885d004af204fb0adcdf255ba250429d797c9bf02d0dd7d6abf006ef9d1a04e7bf2316de14156c8c6d5dd28b016693ac19b70c4e344

data/.gitignore

@@ -1,2 +1,3 @@
 .bundle
 hutch-*.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.2.0 - September 16, 2013
+
+- Support for connecting to RabbitMQ with TLS/SSL. There are two new
+  configuration options : `mq-tls` and `mq-api-ssl`.
+- JSON message parsing errors are now handled properly.
+
+## 0.1.1 - September 9, 2013
+
+- Relax Bunny dependency specification
+
+## 0.1.0 - September 9, 2013
+
+- Initial release
+

data/README.md

@@ -4,6 +4,44 @@ Hutch is a Ruby library for enabling asynchronous inter-service communication
 in a service-oriented architecture, using RabbitMQ.
 
 
+## Project Maturity
+
+Hutch is a relatively young project that was extracted from production systems.
+
+
+
+## Installation & Bundler Dependency
+
+### Most Recent Release
+
+[![Gem Version](https://badge.fury.io/rb/hutch.png)](http://badge.fury.io/rb/hutch)
+
+### With Rubygems
+
+To install with RubyGems:
+
+```
+gem install hutch
+```
+
+### Bundler Dependency
+
+To use in a project managed with Bundler:
+
+``` ruby
+gem "hutch", "~> 0.1.1"
+```
+
+## Overview
+
+Hutch is a conventions-based framework for writing services that communicate
+over RabbitMQ. Hutch is opinionated: it uses topic exchanges for message
+distribution and makes some assumptions about how consumers and publishers
+should work.
+
+Hutch uses [Bunny](http://rubybunny.info) under the hood.
+
+
 ## Defining Consumers
 
 Consumers receive messages from a RabbitMQ queue. That queue may be bound to
@@ -96,6 +134,7 @@ possible, this should be used, rather than directly interfacing with RabbitMQ
 libraries.
 
 ```ruby
+Hutch.connect
 Hutch.publish('routing.key', subject: 'payment', action: 'received')
 ```
 
@@ -131,6 +170,12 @@ AMQP.connect(host: config[:host]) do |connection|
 end
 ```
 
+## Supported RabbitMQ Versions
+
+Hutch requires RabbitMQ 2.x or later. 3.x releases
+are recommended.
+
+
 [pc-issue]: https://github.com/ruby-amqp/amqp/issues/92
 [pc-gist]: https://gist.github.com/3042381
 

data/lib/hutch/broker.rb

@@ -36,11 +36,12 @@ module Hutch
     def set_up_amqp_connection
       host, port, vhost = @config[:mq_host], @config[:mq_port]
       username, password = @config[:mq_username], @config[:mq_password]
-      vhost = @config[:mq_vhost]
+      vhost, tls = @config[:mq_vhost], @config[:mq_tls]
+      protocol = tls ? "amqps://" : "amqp://"
       uri = "#{username}:#{password}@#{host}:#{port}/#{vhost.sub(/^\//, '')}"
-      logger.info "connecting to rabbitmq (amqp://#{uri})"
+      logger.info "connecting to rabbitmq (#{protocol}#{uri})"
 
-      @connection = Bunny.new(host: host, port: port, vhost: vhost,
+      @connection = Bunny.new(host: host, port: port, vhost: vhost, tls: tls,
                               username: username, password: password,
                               heartbeat: 1, automatically_recover: true,
                               network_recovery_interval: 1)
@@ -54,7 +55,7 @@ module Hutch
       @exchange = @channel.topic(exchange_name, durable: true)
     rescue Bunny::TCPConnectionFailed => ex
       logger.error "amqp connection error: #{ex.message.downcase}"
-      uri = "amqp://#{host}:#{port}"
+      uri = "#{protocol}#{host}:#{port}"
       raise ConnectionError.new("couldn't connect to rabbitmq at #{uri}")
     rescue Bunny::PreconditionFailed => ex
       logger.error ex.message
@@ -69,12 +70,15 @@ module Hutch
     def set_up_api_connection
       host, port = @config[:mq_api_host], @config[:mq_api_port]
       username, password = @config[:mq_username], @config[:mq_password]
+      ssl = @config[:mq_api_ssl]
 
-      management_uri = "http://#{username}:#{password}@#{host}:#{port}/"
+      protocol = ssl ? "https://" : "http://"
+      management_uri = "#{protocol}#{username}:#{password}@#{host}:#{port}/"
       logger.info "connecting to rabbitmq management api (#{management_uri})"
 
       @api_client = CarrotTop.new(host: host, port: port,
-                                  user: username, password: password)
+                                  user: username, password: password,
+                                  ssl: ssl)
       @api_client.exchanges
     rescue Errno::ECONNREFUSED => ex
       logger.error "api connection error: #{ex.message.downcase}"

data/lib/hutch/cli.rb

@@ -96,6 +96,10 @@ module Hutch
           Hutch::Config.mq_port = port
         end
 
+        opts.on('--mq-tls', 'Set the RabbitMQ connection to use TLS') do |tls|
+          Hutch::Config.mq_tls = tls
+        end
+
         opts.on('--mq-exchange EXCHANGE',
                 'Set the RabbitMQ exchange') do |exchange|
           Hutch::Config.mq_exchange = exchange
@@ -123,6 +127,10 @@ module Hutch
           Hutch::Config.mq_api_port = port
         end
 
+        opts.on('--mq-api-ssl', 'Set the RabbitMQ API connection to use SSL') do |api_ssl|
+          Hutch::Config.mq_api_ssl = api_ssl
+        end
+
         opts.on('--require PATH', 'Require a Rails app or path') do |path|
           Hutch::Config.require_paths << path
         end

data/lib/hutch/config.rb

@@ -10,10 +10,12 @@ module Hutch
         mq_port: 5672,
         mq_exchange: 'hutch',  # TODO: should this be required?
         mq_vhost: '/',
+        mq_ssl: false,
         mq_username: 'guest',
         mq_password: 'guest',
         mq_api_host: 'localhost',
         mq_api_port: 15672,
+        mq_api_ssl: false,
         log_level: Logger::INFO,
         require_paths: [],
         error_handlers: [Hutch::ErrorHandlers::Logger.new]

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end
 

data/lib/hutch/worker.rb

@@ -84,13 +84,13 @@ module Hutch
                   "consumer: #{consumer}, " +
                   "payload: #{payload}")
 
-      message = Message.new(delivery_info, properties, payload)
       broker = @broker
       begin
+        message = Message.new(delivery_info, properties, payload)
         consumer.new.process(message)
         broker.ack(delivery_info.delivery_tag)
       rescue StandardError => ex
-        handle_error(message.message_id, consumer, ex)
+        handle_error(properties.message_id, consumer, ex)
         broker.ack(delivery_info.delivery_tag)
       end
     end

data/spec/hutch/worker_spec.rb

@@ -75,6 +75,22 @@ describe Hutch::Worker do
         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|
+          backend.should_receive(:handle)
+        end
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+
+      it 'acknowledges the message' do
+        broker.should_receive(:ack).with(delivery_info.delivery_tag)
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -76,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - README.md