hutch 0.21.0-java → 0.25.0-java

data/spec/hutch/worker_spec.rb

@@ -7,7 +7,19 @@ describe Hutch::Worker do
                           get_serializer: nil) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
-  subject(:worker) { Hutch::Worker.new(broker, consumers) }
+  let(:setup_procs) { Array.new(2) { Proc.new {} } }
+  subject(:worker) { Hutch::Worker.new(broker, consumers, setup_procs) }
+
+  describe ".#run" do
+    it "calls each setup proc" do
+      setup_procs.each { |prc| expect(prc).to receive(:call) }
+      allow(worker).to receive(:setup_queues)
+      allow(Hutch::Waiter).to receive(:wait_until_signaled)
+      allow(broker).to receive(:stop)
+
+      worker.run
+    end
+  end
 
   describe '#setup_queues' do
     it 'sets up queues for each of the consumers' do
@@ -20,7 +32,6 @@ describe Hutch::Worker do
 
   describe '#setup_queue' do
     let(:queue) { double('Queue', bind: nil, subscribe: nil) }
-    before { allow(worker).to receive_messages(consumer_queue: queue) }
     before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
 
     it 'creates a queue' do
@@ -34,9 +45,27 @@ describe Hutch::Worker do
     end
 
     it 'sets up a subscription' do
-      expect(queue).to receive(:subscribe).with(manual_ack: true)
+      expect(queue).to receive(:subscribe).with(consumer_tag: %r(^hutch\-.{36}$), manual_ack: true)
       worker.setup_queue(consumer)
     end
+
+    context 'with a configured consumer tag prefix' do
+      before { Hutch::Config.set(:consumer_tag_prefix, 'appname') }
+
+      it 'sets up a subscription with the configured tag prefix' do
+        expect(queue).to receive(:subscribe).with(consumer_tag: %r(^appname\-.{36}$), manual_ack: true)
+        worker.setup_queue(consumer)
+      end
+    end
+
+    context 'with a configured consumer tag prefix that is too long' do
+      let(:maximum_size) { 255 - SecureRandom.uuid.size - 1 }
+      before { Hutch::Config.set(:consumer_tag_prefix, 'a'.*(maximum_size + 1)) }
+
+      it 'raises an error' do
+        expect { worker.setup_queue(consumer) }.to raise_error(/Tag must be 255 bytes long at most/)
+      end
+    end
   end
 
   describe '#handle_message' do
@@ -68,7 +97,7 @@ describe Hutch::Worker do
       it 'requeues the message' do
         allow(consumer_instance).to receive(:process).and_raise('failed')
         requeuer = double
-        allow(requeuer).to receive(:handle).ordered { |delivery_info, properties, broker, e|
+        allow(requeuer).to receive(:handle) { |delivery_info, properties, broker, e|
           broker.requeue delivery_info.delivery_tag
           true
         }

data/spec/spec_helper.rb

@@ -13,8 +13,10 @@ require 'raven'
 require 'hutch'
 require 'logger'
 
+# set logger to be a null logger
+Hutch::Logging.logger = Logger.new(File::NULL)
+
 RSpec.configure do |config|
-  config.before(:all) { Hutch::Config.log_level = Logger::FATAL }
   config.raise_errors_for_deprecations!
 
   if defined?(JRUBY_VERSION)
@@ -22,6 +24,10 @@ RSpec.configure do |config|
   else
     config.filter_run_excluding adapter: :march_hare
   end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
 end
 
 # Constants (classes, etc) defined within a block passed to this method
@@ -34,7 +40,3 @@ ensure
     Object.send(:remove_const, constant)
   end
 end
-
-def deep_copy(obj)
-  Marshal.load(Marshal.dump(obj))
-end

data/spec/tracers/opbeat_spec.rb

@@ -0,0 +1,44 @@
+require 'hutch/message'
+require 'hutch/serializers/identity'
+require 'hutch/tracers'
+
+RSpec.describe Hutch::Tracers::Opbeat do
+  let(:consumer) { double('the-consumer') }
+
+  subject(:tracer) { described_class.new(consumer) }
+
+  let(:message) do
+    Hutch::Message.new(double('the-delivery-info', routing_key: 'foo.bar',
+                                                   exchange: 'foo'),
+                       double('the-properties', message_id: 'the-id',
+                                                timestamp: 'the-time'),
+                       double('the-payload', to_s: 'the-body'),
+                       Hutch::Serializers::Identity)
+  end
+
+  it 'formats messages as extra information' do
+    expected_extra = {
+      body: 'the-body',
+      message_id: 'the-id',
+      timestamp: 'the-time',
+      routing_key: 'foo.bar'
+    }
+    expect(Opbeat).to receive(:transaction).with(anything,
+                                           'messaging.hutch',
+                                           extra: expected_extra) {
+                                             double('done-callback', done: true)
+                                           }
+
+    tracer.handle(message)
+  end
+
+  it 'presents consumer class name as Opbeat tracing signature' do
+    expect(Opbeat).to receive(:transaction).with(consumer.class.name,
+                                           'messaging.hutch',
+                                           anything) {
+                                             double('done-callback', done: true)
+                                           }
+
+    tracer.handle(message)
+  end
+end

data/templates/default/class/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.push :settings
+end

data/templates/default/fulldoc/html/css/hutch.css

@@ -0,0 +1,13 @@
+.settings {
+  border-spacing: 2.5rem;
+  border-collapse: collapse;
+}
+
+.settings thead th {
+  text-align: left;
+}
+
+.settings thead th,
+.settings tbody td {
+  padding: .5em 1em;
+}

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,7 @@
+def init
+  super
+end
+
+def stylesheets
+  super + %w(css/hutch.css)
+end

data/templates/default/method_details/html/settings.erb

@@ -0,0 +1,5 @@
+<% if object['custom_field'] %>
+<p>
+  <%= object['custom_field'] %>
+</p>
+<% end %>

data/templates/default/method_details/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.last.place(:settings).after(:source)
+end

data/templates/default/module/html/settings.erb

@@ -0,0 +1,40 @@
+<% if object['setting_rows'] %>
+  <h2>
+    Configuration
+  </h2>
+
+  <div class="tags">
+    <table border="1" class="settings">
+      <thead>
+        <tr>
+          <th>
+            Setting name
+          </th>
+          <th>
+            Default value
+          </th>
+          <th>
+            Type
+          </th>
+          <th>
+            ENV variable
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+      </thead>
+      <tbody>
+      <% for setting in object['setting_rows'] %>
+        <tr>
+          <td><tt><%= resolve_links "{Hutch::Config##{setting[:name]} #{setting[:name]}}" %></tt></td>
+          <td><%= setting[:default_value] %></td>
+          <td><%= setting[:type] %></td>
+          <td><tt>HUTCH_<%= setting[:name].upcase %></tt></td>
+          <td><%= html_markup_markdown setting[:first_line_of_description] %></td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/templates/default/module/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.place(:settings).before(:children)
+end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.25.0
 platform: java
 authors:
 - Harry Marr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 3.0.0
   name: march_hare
   prerelease: false
   type: :runtime
@@ -23,7 +23,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.2
+        version: '1.12'
   name: multi_json
   prerelease: false
   type: :runtime
@@ -51,13 +51,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.2
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   name: activesupport
   prerelease: false
   type: :runtime
@@ -65,36 +68,12 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  name: rspec
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  name: simplecov
-  prerelease: false
-  type: :development
-  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 using RabbitMQ.
+        version: '6'
+description: Hutch is a Ruby library for enabling asynchronous inter-service communication
+  using RabbitMQ.
 email:
 - developers@gocardless.com
 executables:
@@ -103,7 +82,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -126,19 +107,26 @@ files:
 - lib/hutch/consumer.rb
 - lib/hutch/error_handlers.rb
 - lib/hutch/error_handlers/airbrake.rb
+- lib/hutch/error_handlers/base.rb
 - lib/hutch/error_handlers/honeybadger.rb
 - lib/hutch/error_handlers/logger.rb
+- lib/hutch/error_handlers/opbeat.rb
 - lib/hutch/error_handlers/sentry.rb
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
 - lib/hutch/message.rb
+- lib/hutch/publisher.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
+- lib/hutch/tracers/opbeat.rb
 - lib/hutch/version.rb
+- lib/hutch/waiter.rb
 - lib/hutch/worker.rb
+- lib/yard-settings/handler.rb
+- lib/yard-settings/yard-settings.rb
 - spec/hutch/broker_spec.rb
 - spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
@@ -146,13 +134,25 @@ files:
 - 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/opbeat_spec.rb
 - 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/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
+- spec/tracers/opbeat_spec.rb
+- templates/default/class/html/settings.erb
+- templates/default/class/setup.rb
+- templates/default/fulldoc/html/css/hutch.css
+- templates/default/layout/html/setup.rb
+- templates/default/method_details/html/settings.erb
+- templates/default/method_details/setup.rb
+- templates/default/method_details/text/settings.erb
+- templates/default/module/html/settings.erb
+- templates/default/module/setup.rb
 homepage: https://github.com/gocardless/hutch
 licenses:
 - MIT
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
@@ -185,10 +185,13 @@ test_files:
 - 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/opbeat_spec.rb
 - 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/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
+- spec/tracers/opbeat_spec.rb