hutch 1.4.0 → 2.0.0

data/spec/integration/publish_consume_spec.rb

@@ -3,7 +3,6 @@ require 'hutch/broker'
 require 'hutch/worker'
 require 'hutch/consumer'
 require 'securerandom'
-require 'timeout'
 
 describe 'publishing and consuming messages', rabbitmq: true, adapter: :bunny do
   let(:exchange_name) { "hutch.test.#{SecureRandom.hex(4)}" }
@@ -41,7 +40,7 @@ describe 'publishing and consuming messages', rabbitmq: true, adapter: :bunny do
 
     broker.publish(routing_key, { test: 'data' })
 
-    Timeout.timeout(5) { sleep 0.1 until received.any? }
+    await_condition(15, 'message consumption') { received.any? }
 
     expect(received.first).to eq('test' => 'data')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Harry Marr
 - Michael Klishin
 bindir: bin
 cert_chain: []
-date: 2026-04-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !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.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -79,24 +65,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rspec"
-- ".yardopts"
-- AGENTS.md
 - CHANGELOG.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/ci/before_build.sh
 - bin/ci/before_build_docker.sh
 - bin/ci/install_on_debian.sh
 - bin/hutch
-- examples/consumer.rb
-- examples/producer.rb
-- hutch.gemspec
 - lib/hutch.rb
 - lib/hutch/acknowledgements/base.rb
 - lib/hutch/acknowledgements/nack_on_all_failures.rb
@@ -115,7 +90,6 @@ files:
 - lib/hutch/error_handlers/logger.rb
 - lib/hutch/error_handlers/rollbar.rb
 - lib/hutch/error_handlers/sentry.rb
-- lib/hutch/error_handlers/sentry_raven.rb
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
 - lib/hutch/message.rb
@@ -140,7 +114,6 @@ files:
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
 - spec/hutch/error_handlers/rollbar_spec.rb
-- spec/hutch/error_handlers/sentry_raven_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
@@ -151,7 +124,6 @@ files:
 - spec/hutch_spec.rb
 - spec/integration/channel_recovery_spec.rb
 - spec/integration/publish_consume_spec.rb
-- spec/spec_helper.rb
 - templates/default/class/html/settings.erb
 - templates/default/class/setup.rb
 - templates/default/fulldoc/html/css/hutch.css
@@ -172,14 +144,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Opinionated asynchronous inter-service communication using RabbitMQ
 test_files:
@@ -192,7 +164,6 @@ test_files:
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
 - spec/hutch/error_handlers/rollbar_spec.rb
-- spec/hutch/error_handlers/sentry_raven_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
@@ -203,4 +174,3 @@ test_files:
 - spec/hutch_spec.rb
 - spec/integration/channel_recovery_spec.rb
 - spec/integration/publish_consume_spec.rb
-- spec/spec_helper.rb

data/.github/workflows/test.yml

@@ -1,74 +0,0 @@
-name: CI
-
-concurrency:
-  group: ${{ github.ref }}
-  cancel-in-progress: true
-
-on:
-  push:
-    branches:
-      - "main"
-  pull_request:
-    branches:
-      - "main"
-  workflow_dispatch:
-
-jobs:
-  test:
-    name: RabbitMQ ${{ matrix.rabbitmq }}, Ruby ${{ matrix.ruby }}
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - "4.0"
-          - "3.4"
-          - "3.3"
-          - "3.2"
-          - "3.1"
-          - "3.0"
-        rabbitmq:
-          - "4.2"
-          - "4.1"
-          - "4.0"
-          - "3.13"
-
-    env:
-      CI: true
-
-    services:
-      rabbitmq:
-        image: rabbitmq:${{ matrix.rabbitmq }}-management
-        ports:
-          - 5672:5672
-          - 15672:15672
-        options: --name rabbitmq
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Wait for RabbitMQ to start
-        run: sleep 10
-
-      - name: Set up RabbitMQ
-        run: ./bin/ci/before_build_docker.sh
-
-      - name: Run tests
-        run: bundle exec rspec spec
-
-  test_all:
-    if: ${{ always() }}
-    runs-on: ubuntu-latest
-    name: Test (matrix)
-    needs: test
-    steps:
-      - name: Check test matrix status
-        if: ${{ needs.test.result != 'success' }}
-        run: exit 1

data/.gitignore

@@ -1,10 +0,0 @@
-.bundle
-hutch-*.gem
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-.idea
-coverage
-.yardoc
-doc
-gemfiles/Gemfile.*.lock

data/.rspec

@@ -1 +0,0 @@
---order random

data/.yardopts

@@ -1,5 +0,0 @@
---load "./lib/yard-settings/yard-settings.rb"
---title "Hutch API docs"
--
-README.md
-

data/AGENTS.md

@@ -1,127 +0,0 @@
-# Instructions for AI Agents
-
-## Overview
-
-Hutch is a Ruby library for enabling asynchronous inter-service communication
-using RabbitMQ. It provides a conventions-based framework for consumers and
-producers using topic exchanges.
-
-Its key dependencies are [Bunny](https://github.com/ruby-amqp/bunny) (MRI Ruby)
-or [March Hare](https://github.com/ruby-amqp/march_hare) (JRuby), two RabbitMQ clients that use AMQP 0-9-1.
-
-On top, Hutch uses [carrot-top](https://github.com/change/carrot-top) for the RabbitMQ HTTP API,
-and [ActiveSupport](https://github.com/rails/rails/tree/main/activesupport) from Ruby on Rails.
-
-## Target Ruby Version
-
-This library targets Ruby 3.0 and later versions
-For JRuby, the supported series are 9.x and 10.x.
-
-## Build and Test
-
-```bash
-bundle install
-
-bundle exec rspec spec
-```
-
-To run tests use `rspec` directly (not Rake).
-
-## Key Files
-
-### Core
-
- * `lib/hutch.rb`: top-level module, global consumer registry, a connection singleton
- * `lib/hutch/broker.rb`: RabbitMQ connection and channel lifecycle, topology declaration, [delivery acknowledgements](https://www.rabbitmq.com/docs/confirms), [publisher confirms](https://www.rabbitmq.com/docs/confirms), [TLS](https://www.rabbitmq.com/docs/ssl), HTTP API client
- * `lib/hutch/worker.rb`: the main consumer loop: topology and consumer setup, delivery dispatch, error handling
- * `lib/hutch/consumer.rb`: `Hutch::Consumer` module included by consumer classes; DSL: `consume`, `queue_name`, `lazy_queue`, `quorum_queue`, `arguments`, `queue_options`, `serializer`
- * `lib/hutch/publisher.rb`: message serialization, routing, publisher confirms
- * `lib/hutch/message.rb`: message wrapper (delivery_info, properties, payload)
- * `lib/hutch/config.rb`: configuration with 3-tier precedence (defaults < ENV `HUTCH_*` < config file < explicit set)
- * `lib/hutch/cli.rb`: CLI (based on `OptionParser`), Rails app detection, consumer loading, daemonization
- * `lib/hutch/exceptions.rb`: `ConnectionError`, `AuthenticationError`, `WorkerSetupError`, `PublishError`
- * `lib/hutch/logging.rb`: configurable logger with `HutchFormatter`
- * `lib/hutch/waiter.rb`: signal handling (`SIGINT`, `SIGTERM`, `SIGQUIT` for shutdown; `SIGUSR2` for thread dumps)
- * `lib/hutch/version.rb`: the `Hutch::VERSION` constant
-
-### Adapters
-
- * `lib/hutch/adapter.rb`: runtime adapter selector (Bunny on MRI, March Hare on JRuby)
- * `lib/hutch/adapters/bunny.rb`: Bunny adapter
- * `lib/hutch/adapters/march_hare.rb`: March Hare adapter
-
-### Serializers
-
- * `lib/hutch/serializers/json.rb`: JSON serialization via `multi_json`
- * `lib/hutch/serializers/identity.rb`: pass-through (no-op) serializer
-
-### Error Handlers
-
- * `lib/hutch/error_handlers/base.rb`: base class
- * `lib/hutch/error_handlers/logger.rb`: logs errors (default)
- * `lib/hutch/error_handlers/sentry.rb`: sentry-ruby integration
- * `lib/hutch/error_handlers/sentry_raven.rb`: legacy sentry-raven integration
- * `lib/hutch/error_handlers/honeybadger.rb`: Honeybadger
- * `lib/hutch/error_handlers/airbrake.rb`: Airbrake
- * `lib/hutch/error_handlers/rollbar.rb`: Rollbar
- * `lib/hutch/error_handlers/bugsnag.rb`: Bugsnag
-
-### Tracers
-
- * `lib/hutch/tracers/null_tracer.rb`: no-op (default)
- * `lib/hutch/tracers/newrelic.rb`: NewRelic APM
- * `lib/hutch/tracers/datadog.rb`: Datadog tracing
-
-### Acknowledgement Strategies
-
- * `lib/hutch/acknowledgements/base.rb`: base interface (a chain of responsibility)
- * `lib/hutch/acknowledgements/nack_on_all_failures.rb`: the default fallback
-
-## Test Suite
-
-The test suite uses RSpec:
-
-```bash
-bundle exec rspec spec
-```
-
-Test files mirror the `lib/hutch/` structure under `spec/hutch/`. Tests are filtered
-by adapter at runtime: Bunny specs are excluded on JRuby, March Hare specs on MRI.
-
-## Comments
-
- * Only add important comments that express the non-obvious intent, both in tests and in the implementation
- * Keep the comments short
- * Pay attention to the grammar of your comments, including punctuation, full stops, articles, and so on
-
-## Change Log
-
-If asked to perform change log updates, consult and modify `CHANGELOG.md` and stick to its
-existing writing style.
-
-## Releases
-
-### How to Roll (Produce) a New Release
-
-Suppose the current development version in `CHANGELOG.md` has
-a `## X.Y.0 (in development)` section at the top.
-
-To produce a new release:
-
- 1. Update `CHANGELOG.md`: replace `(in development)` with today's date, e.g. `(Mar 30, 2026)`. Make sure all notable changes since the previous release are listed
- 2. Update the version in `lib/hutch/version.rb` to match (remove the `.pre` suffix)
- 3. Commit with the message `X.Y.0` (just the version number, nothing else)
- 4. Tag the commit: `git tag vX.Y.0`
- 5. Bump the dev version: add a new `## X.(Y+1).0 (in development)` section to `CHANGELOG.md` with `No changes yet.` underneath, and update `lib/hutch/version.rb` to the next dev version with a `.pre` suffix
- 6. Commit with the message `Bump dev version`
- 7. Push: `git push && git push origin vX.(Y+1).0`
-
-## Git Instructions
-
- * Do not commit changes automatically without an explicit permission to do so
- * Never add yourself to the list of commit co-authors
- * Never mention yourself in commit messages in any way (no "Generated by", no AI tool links, etc)
-
-## Style Guide
-
- * Never add full stops to Markdown list items

data/Gemfile

@@ -1,35 +0,0 @@
-source 'https://rubygems.org'
-
-ruby '>= 3.0.0'
-
-gemspec
-
-group :development do
-  gem "rake"
-  gem "guard", "~> 2.14", platform: :mri
-  gem "guard-rspec", "~> 4.7", platform: :mri
-
-  gem "yard", "~> 0.9"
-  gem 'kramdown', "> 0", platform: :jruby
-  gem "redcarpet", "> 0", platform: :mri
-  gem "github-markup", "> 0"
-end
-
-group :development, :test do
-  gem "rspec", "~> 3.12"
-  gem "simplecov", "~> 0.21"
-
-  gem "sentry-raven"
-  gem "sentry-ruby"
-  gem "honeybadger"
-  gem "newrelic_rpm"
-  gem "datadog"
-  gem "airbrake", "~> 13.0"
-  gem "rollbar"
-  gem "bugsnag"
-end
-
-group :development, :darwin do
-  gem "rb-fsevent", "~> 0.11.2"
-  gem "growl", "~> 1.0.3"
-end

data/Guardfile

@@ -1,14 +0,0 @@
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/Rakefile

@@ -1,21 +0,0 @@
-require 'rspec/core/rake_task'
-
-desc "Run an IRB session with Hutch pre-loaded"
-task :console do
-  exec "irb -I lib -r hutch"
-end
-
-desc "Run the test suite"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = FileList['spec/**/*_spec.rb']
-  t.rspec_opts = %w(--color --format doc)
-end
-
-task default: :spec
-
-#
-# Re-generate API docs
-#
-require 'yard'
-require 'yard/rake/yardoc_task'
-YARD::Rake::YardocTask.new

data/examples/consumer.rb

@@ -1,13 +0,0 @@
-require 'hutch'
-
-class TestConsumer
-  include Hutch::Consumer
-  consume 'hutch.test'
-
-  def process(message)
-    puts "TestConsumer got a message: #{message}"
-    puts "Processing..."
-    sleep(1)
-    puts "Done"
-  end
-end

data/examples/producer.rb

@@ -1,10 +0,0 @@
-require 'hutch'
-
-Hutch.connect
-loop do
-  print "Press return to send test message..."
-  gets
-  Hutch.publish('hutch.test', subject: 'test message')
-  puts "Send message with routing key 'hutch.test'"
-end
-

data/hutch.gemspec

@@ -1,27 +0,0 @@
-require File.expand_path('../lib/hutch/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  if defined?(JRUBY_VERSION)
-    gem.platform = 'java'
-    gem.add_runtime_dependency 'march_hare', '>= 4.7.0'
-  else
-    gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '>= 3.1', '< 4.0'
-  end
-  gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
-  gem.add_runtime_dependency 'multi_json', '~> 1.15'
-  gem.add_runtime_dependency 'activesupport', '>= 4.2'
-
-  gem.name = 'hutch'
-  gem.summary = 'Opinionated asynchronous inter-service communication using RabbitMQ'
-  gem.description = 'Hutch is a Ruby library for enabling asynchronous inter-service communication using RabbitMQ'
-  gem.version = Hutch::VERSION.dup
-  gem.required_ruby_version = '>= 3.0'
-  gem.authors = ['Harry Marr', 'Michael Klishin']
-  gem.homepage = 'https://github.com/ruby-amqp/hutch'
-  gem.require_paths = ['lib']
-  gem.license = 'MIT'
-  gem.executables = ['hutch']
-  gem.files = `git ls-files`.split("\n")
-  gem.test_files = `git ls-files -- spec/*`.split("\n")
-end

data/lib/hutch/error_handlers/sentry_raven.rb

@@ -1,34 +0,0 @@
-require 'hutch/logging'
-require 'raven'
-require 'hutch/error_handlers/base'
-
-module Hutch
-  module ErrorHandlers
-    class SentryRaven < Base
-
-      def initialize
-        unless Raven.respond_to?(:capture_exception)
-          raise "The Hutch Sentry error handler requires Raven >= 0.4.0"
-        end
-
-        warn "[DEPRECATION] Hutch::ErrorHandlers::SentryRaven is deprecated and will be removed in Hutch 2.0. " \
-             "Use Hutch::ErrorHandlers::Sentry (backed by the sentry-ruby gem) instead." \
-      end
-
-      def handle(properties, payload, consumer, ex)
-        message_id = properties.message_id
-        prefix = "message(#{message_id || '-'}):"
-        logger.error "#{prefix} Logging event to Sentry"
-        logger.error "#{prefix} #{ex.class} - #{ex.message}"
-        Raven.capture_exception(ex, extra: { payload: payload })
-      end
-
-      def handle_setup_exception(ex)
-        logger.error "Logging setup exception to Sentry"
-        logger.error "#{ex.class} - #{ex.message}"
-        Raven.capture_exception(ex)
-      end
-
-    end
-  end
-end

data/spec/hutch/error_handlers/sentry_raven_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe Hutch::ErrorHandlers::SentryRaven do
-  let(:error_handler) { Hutch::ErrorHandlers::SentryRaven.new }
-
-  describe '#handle' do
-    let(:properties) { Struct.new(:message_id).new("1") }
-    let(:payload) { "{}" }
-    let(:error) do
-      begin
-        raise "Stuff went wrong"
-      rescue RuntimeError => err
-        err
-      end
-    end
-
-    it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error, {extra: { payload: payload }})
-      error_handler.handle(properties, payload, double, error)
-    end
-  end
-
-  describe '#handle_setup_exception' do
-    let(:error) do
-      begin
-        raise "Stuff went wrong during setup"
-      rescue RuntimeError => err
-        err
-      end
-    end
-
-    it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error)
-      error_handler.handle_setup_exception(error)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,42 +0,0 @@
-require 'simplecov'
-if ENV['TRAVIS']
-  require 'coveralls'
-  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-end
-
-SimpleCov.start do
-  add_filter '/spec/'
-  add_filter '/.bundle/'
-end
-
-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.raise_errors_for_deprecations!
-
-  if defined?(JRUBY_VERSION)
-    config.filter_run_excluding adapter: :bunny
-  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
-# will be removed from the global namespace after the block as run.
-def isolate_constants
-  existing_constants = Object.constants
-  yield
-ensure
-  (Object.constants - existing_constants).each do |constant|
-    Object.send(:remove_const, constant)
-  end
-end