hutch 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2432ba126d871fbe57468e88a39c6d589a01aa2f
-  data.tar.gz: 865526ad5d702eaaea80ee000b6e8ef879b5ac18
+  metadata.gz: 5a5e2b2315f71a38d34043446034950e26c63612
+  data.tar.gz: 24f650b6681c6c7c18e5a9a067666155edae4d2d
 SHA512:
-  metadata.gz: 87d496756e3df55679391977995de5eb836a949cd80ca0ecafb7d99966512c736be01307e72976cad95fb122fcd048c51154a7456c9cfec7b1e4d2080ef9c20f
-  data.tar.gz: 5b8f3e3fd23af0451da805d64f90ff8afc5b8ee0be93c04a4fec7be45598c32fc2ad96d59442d660974f8b3d18e47f2e507aa6988b369207721173e5e1812877
+  metadata.gz: ffdefefec637a9ad46fb00207a74c78210fcc167c0dbfe6c34a91da32ec5499ea67c07f12a68af1ac0ea7e9d23a9df7b33690a9c68d9a4b765897533fcc37d18
+  data.tar.gz: ac34de5ef0600b31a6f3614de06508cca2c47406371a9137f43458a2533996cac906a47825c45230b5bb887633dbc15b2c859fb1bae477b77149c221e5b6f198

data/CHANGELOG.md

@@ -1,6 +1,85 @@
-## 0.7.0 — unreleased
+## 0.8.0 — unreleased
 
-- [Global properties can now be specified](https://github.com/gocardless/hutch/pull/62) for publishing
+### Uncaught Exceptions Result in Rejected Messages
+
+Uncaught exceptions in consumers now result in Hutch rejecting
+messages (deliveries) using `basic.nack`. This way they are [dead lettered](http://www.rabbitmq.com/dlx.html).
+
+Contributed by Garrett Johnson.
+
+### Missing Require
+
+`hutch/consumer.rb` no longer fails to load with the
+apps that do not `require "set"`.
+
+### Relaxed Queue Namespace Validation
+
+Namespaces now can include any characters that are valid in RabbitMQ
+queue names.
+
+Contributed by Garrett Johnson.
+
+### basic.qos Configuration
+
+It is now possible to configure `basic.qos` (aka channel prefetch) setting
+used by Hutch using the `:channel_prefetch` config key.
+
+### Passwords No Longer Logged
+
+Hutch now elides passwords from logs.
+
+
+## 0.7.0 — January 14, 2014
+
+### Optional HTTP API Use
+
+It is now possible to make Hutch [not use RabbitMQ HTTP
+API](https://github.com/gocardless/hutch/pull/69) (e.g. when the
+RabbitMQ management plugin that provides it is not available).
+
+
+### Extra Arguments for Hutch::Broker#publish
+
+Extra options [passed to `Hutch::Broker#publish` will now be propagated](https://github.com/gocardless/hutch/pull/61).
+
+
+### Content-Type for Messages
+
+Messages published with Hutch now have content type set
+to `application/json`.
+
+
+### Greater Heartbeat Interval
+
+Hutch now uses heartbeat interval of 30, so heartbeats won't interfere with transfers
+of large messages over high latency networks (e.g. between AWS availability regions).
+
+
+### Custom Queue Names
+
+It is now possible to [specify an optional queue name](https://github.com/gocardless/hutch/pull/49):
+
+``` ruby
+class FailedPaymentConsumer
+  include Hutch::Consumer
+  consume 'gc.ps.payment.failed'
+  queue_name 'failed_payments'
+
+  def process(message)
+    mark_payment_as_failed(message[:id])
+  end
+end
+```
+
+### Global Properties for Publishers
+
+[Global properties can now be specified](https://github.com/gocardless/hutch/pull/62) for publishing:
+
+``` ruby
+Hutch.global_properties = proc {
+  { app_id: 'api', headers: { request_id: RequestId.request_id } }
+}
+```
 
 ## 0.6.0 - November 4, 2013
 

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.1.0'
+  gem.add_runtime_dependency 'bunny', '~> 1.1.2'
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
   gem.add_runtime_dependency 'multi_json', '~> 1.5'
   gem.add_development_dependency 'rspec', '~> 2.12.0'

data/lib/hutch/broker.rb

@@ -55,9 +55,8 @@ module Hutch
       tls_key  = @config[:mq_tls_cert]
       tls_cert = @config[:mq_tls_key]
       protocol = tls ? "amqps://" : "amqp://"
-      uri      = "#{username}:#{password}@#{host}:#{port}/#{vhost.sub(/^\//, '')}"
-      sanitized_uri = "#{protocol}#{host}:#{port}"
-      logger.info "connecting to rabbitmq (#{protocol}#{uri})"
+      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,
@@ -74,14 +73,16 @@ module Hutch
 
     def open_channel!
       logger.info 'opening rabbitmq channel'
-      @channel = connection.create_channel
+      @channel = connection.create_channel.tap do |ch|
+        ch.prefetch(@config[:channel_prefetch]) if @config[:channel_prefetch]
+      end
     end
 
     # Set up the connection to the RabbitMQ management API. Unfortunately, this
     # is necessary to do a few things that are impossible over AMQP. E.g.
     # listing queues and bindings.
     def set_up_api_connection
-      logger.info "connecting to rabbitmq management api (#{api_config.management_uri})"
+      logger.info "connecting to rabbitmq HTTP API (#{api_config.sanitized_uri})"
 
       with_authentication_error_handler do
         with_connection_error_handler do
@@ -96,7 +97,7 @@ module Hutch
     # Create / get a durable queue and apply namespace if it exists.
     def queue(name)
       with_bunny_precondition_handler('queue') do
-        namespace = @config[:namespace].to_s.downcase.gsub(/\W|:/, "")
+        namespace = @config[:namespace].to_s.downcase.gsub(/[^-_:\.\w]/, "")
         name = name.prepend(namespace + ":") unless namespace.empty?
         channel.queue(name, durable: true)
       end
@@ -151,6 +152,10 @@ module Hutch
       @channel.ack(delivery_tag, false)
     end
 
+    def nack(delivery_tag)
+      @channel.nack(delivery_tag, false, false)
+    end
+
     def publish(routing_key, message, properties = {})
       ensure_connection!(routing_key, message)
 
@@ -189,16 +194,16 @@ module Hutch
         config.password = @config[:mq_password]
         config.ssl = @config[:mq_api_ssl]
         config.protocol = config.ssl ? "https://" : "http://"
-        config.management_uri = "#{config.protocol}#{config.username}:#{config.password}@#{config.host}:#{config.port}/"
+        config.sanitized_uri = "#{config.protocol}#{config.username}@#{config.host}:#{config.port}/"
       end
     end
 
     def with_authentication_error_handler
       yield
     rescue Net::HTTPServerException => ex
-      logger.error "api connection error: #{ex.message.downcase}"
+      logger.error "HTTP API connection error: #{ex.message.downcase}"
       if ex.response.code == '401'
-        raise AuthenticationError.new('invalid api credentials')
+        raise AuthenticationError.new('invalid HTTP API credentials')
       else
         raise
       end
@@ -207,15 +212,15 @@ module Hutch
     def with_connection_error_handler
       yield
     rescue Errno::ECONNREFUSED => ex
-      logger.error "api connection error: #{ex.message.downcase}"
-      raise ConnectionError.new("couldn't connect to api at #{api_config.management_uri}")
+      logger.error "HTTP API connection error: #{ex.message.downcase}"
+      raise ConnectionError.new("couldn't connect to HTTP API at #{api_config.sanitized_uri}")
     end
 
     def with_bunny_precondition_handler(item)
       yield
     rescue Bunny::PreconditionFailed => ex
       logger.error ex.message
-      s = "RabbitMQ responded with Precondition Failed when creating this #{item}. " +
+      s = "RabbitMQ responded with 406 Precondition Failed when creating this #{item}. " +
           "Perhaps it is being redeclared with non-matching attributes"
       raise WorkerSetupError.new(s)
     end

data/lib/hutch/config.rb

@@ -25,7 +25,8 @@ module Hutch
         require_paths: [],
         autoload_rails: true,
         error_handlers: [Hutch::ErrorHandlers::Logger.new],
-        namespace: nil
+        namespace: nil,
+        channel_prefetch: 0
       }
     end
 

data/lib/hutch/consumer.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Hutch
   # Include this module in a class to register it as a consumer. Consumers
   # gain a class method called `consume`, which should be used to register

data/lib/hutch/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.8.0'.freeze
 end
 

data/lib/hutch/worker.rb

@@ -85,7 +85,7 @@ module Hutch
         broker.ack(delivery_info.delivery_tag)
       rescue StandardError => ex
         handle_error(properties.message_id, consumer, ex)
-        broker.ack(delivery_info.delivery_tag)
+        broker.nack(delivery_info.delivery_tag)
       end
     end
 
@@ -97,8 +97,7 @@ module Hutch
 
     def consumers=(val)
       if val.empty?
-        logger.warn 'no consumer loaded, ensure there\'s' +
-                    'no configuration issue'
+        logger.warn "no consumer loaded, ensure there's no configuration issue"
       end
       @consumers = val
     end

data/spec/hutch/broker_spec.rb

@@ -58,6 +58,17 @@ describe Hutch::Broker do
 
       specify { set_up_amqp_connection.should raise_error }
     end
+
+    context 'with channel_prefetch set' do
+      let(:prefetch_value) { 1 }
+      before { config[:channel_prefetch] = prefetch_value }
+      after  { broker.disconnect }
+
+      it "set's channel's prefetch" do
+        Bunny::Channel.any_instance.should_receive(:prefetch).with(prefetch_value)
+        broker.set_up_amqp_connection
+      end
+    end
   end
 
   describe '#set_up_api_connection', rabbitmq: true do
@@ -82,8 +93,8 @@ describe Hutch::Broker do
     before { broker.stub(:channel) { channel } }
 
     it 'applies a global namespace' do
-      config[:namespace] = 'service'
-      broker.channel.should_receive(:queue).with { |*args| args.first == 'service:test' }
+      config[:namespace] = 'mirror-all.service'
+      broker.channel.should_receive(:queue).with { |*args| args.first == 'mirror-all.service:test' }
       broker.queue('test')
     end
   end
@@ -108,7 +119,7 @@ describe Hutch::Broker do
   end
 
   describe '#bind_queue' do
-    
+
     around { |example| broker.connect { example.run } }
 
     let(:routing_keys) { %w( a b c ) }

data/spec/hutch/worker_spec.rb

@@ -47,6 +47,7 @@ describe Hutch::Worker do
     let(:properties) { double('Properties', message_id: nil) }
     before { consumer.stub(new: consumer_instance) }
     before { broker.stub(:ack) }
+    before { broker.stub(:nack) }
 
     it 'passes the message to the consumer' do
       consumer_instance.should_receive(:process).
@@ -70,8 +71,8 @@ describe Hutch::Worker do
         worker.handle_message(consumer, delivery_info, properties, payload)
       end
 
-      it 'acknowledges the message' do
-        broker.should_receive(:ack).with(delivery_info.delivery_tag)
+      it 'rejects the message' do
+        broker.should_receive(:nack).with(delivery_info.delivery_tag)
         worker.handle_message(consumer, delivery_info, properties, payload)
       end
     end
@@ -86,8 +87,8 @@ describe Hutch::Worker do
         worker.handle_message(consumer, delivery_info, properties, payload)
       end
 
-      it 'acknowledges the message' do
-        broker.should_receive(:ack).with(delivery_info.delivery_tag)
+      it 'rejects the message' do
+        broker.should_receive(:nack).with(delivery_info.delivery_tag)
         worker.handle_message(consumer, delivery_info, properties, payload)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement