hutch 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74721c392b797963bf268ff65d638b888e11d43307446ed63bd3de14e36aa97e
-  data.tar.gz: 1ddb6053bd164c0332650169415ae9a20daa9724039be7765cc90aade1e0f304
+  metadata.gz: 9725ddb3e39e305bad95abd6c8605c1d9828691904bb2ae31430fd22d88bd180
+  data.tar.gz: db1d87d81de0f89c84b1ec387c66443aa9ead6be2d71b50b6cee32e9146dd080
 SHA512:
-  metadata.gz: e690481212eeca9499f491b34c39e9f8e4f883f617063a5123bf1471e87b7f7251c52e0c92b103fe73dfa8db1859ad5feca76b6f0694ff68554191e66621f209
-  data.tar.gz: 043c203877a230f2d50c023a005ce84c7a7fc764c2b6ce3d452ab8aa143fa4175e4ba4bd54a4e2e611839360b2ec292d28c03ec338c92bbaa3b84e34b8a644f0
+  metadata.gz: 296138c5cb4c08340f4a72bb8d30009402272f9843efffd0dc1d647328ca1531d188fd3b5a9a15f891f4a8447dbf5f72a7a583aa702f1c999fc557c1ab4ac024
+  data.tar.gz: 2c0406261d2535d5e5d00037e20e29f5cb781e337732491cf36195231e5d647b75c0d96d74c0861afa36cfb24575a0e2b34ce06f59693a98b84342cf1d52ad95

data/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    services:
+      rabbitmq:
+        image: rabbitmq:3-management
+        ports:
+          - 5672:5672
+          - 15672:15672
+        options: --name rabbitmq
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['jruby-9.2.19.0', 'jruby-9.3.0.0', 'jruby-head']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Set up RabbitMQ
+      run: |
+        until sudo lsof -i:5672; do echo "Waiting for RabbitMQ to start..."; sleep 1; done
+        ./bin/ci/before_build_docker.sh
+    - name: Run tests
+      run: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.1 (March 18th, 2022)
+### Dependency Bump
+
+Hutch now allows ActiveSupport 7.x.
+
+
 ## 1.1.0 (July 26th, 2021)
 
 ### Bugsnag Error Handler
@@ -6,13 +12,18 @@ Contributed by @ivanhuang1.
 
 GitHub issue: [#362](https://github.com/ruby-amqp/hutch/pull/362)
 
+### Datadog Tracer
+
+Contributed by Karol @Azdaroth Galanciak.
+
+GitHub issue: [#360](https://github.com/ruby-amqp/hutch/pull/360)
+
 ### Updated Sentry Error Handler
 
 Contributed by Karol @Azdaroth Galanciak.
 
 GitHub issue: [#363](https://github.com/ruby-amqp/hutch/pull/363)
 
-
 ### Type Casting for Values Set Using Hutch::Config.set
 
 Values set with `Hutch::Config.set` now have expected setting type casting
@@ -22,6 +33,17 @@ Contributed by Karol @Azdaroth Galanciak.
 
 GitHub issue: [#358](https://github.com/ruby-amqp/hutch/pull/358)
 
+### Wider MultiJson Adoption
+
+Contributed by Ulysse @BuonOmo Buonomo.
+
+GitHub issue: [#356](https://github.com/ruby-amqp/hutch/pull/356)
+
+### README Corrections
+
+Contributed by Johan @johankok Kok.
+
+GitHub issue: [#353](https://github.com/ruby-amqp/hutch/pull/353)
 
 ## 1.0.0 (April 8th, 2020)
 

data/LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2013-2016 GoCardless
-Copyright (c) 2016-2020 Hutch contributors
+Copyright (c) 2016-2021 Hutch contributors
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,7 +1,6 @@
 ![](http://cl.ly/image/3h0q3F3G142K/hutch.png)
 
 [![Gem Version](https://badge.fury.io/rb/hutch.svg)](http://badge.fury.io/rb/hutch)
-[![Build Status](https://travis-ci.org/gocardless/hutch.svg?branch=master)](https://travis-ci.org/gocardless/hutch)
 [![Code Climate](https://codeclimate.com/github/gocardless/hutch.svg)](https://codeclimate.com/github/gocardless/hutch)
 
 Hutch is a Ruby library for enabling asynchronous inter-service communication

data/bin/ci/before_build_docker.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+CTL=${MARCH_HARE_RABBITMQCTL:="docker exec rabbitmq rabbitmqctl"}
+PLUGINS=${MARCH_HARE_RABBITMQ_PLUGINS:="docker exec rabbitmq rabbitmq-plugins"}
+
+$PLUGINS enable rabbitmq_management
+
+sleep 3
+
+# guest:guest has full access to /
+
+$CTL add_vhost /
+# $CTL add_user guest guest # already exists
+$CTL set_permissions -p / guest ".*" ".*" ".*"
+
+# Reduce retention policy for faster publishing of stats
+$CTL eval 'supervisor2:terminate_child(rabbit_mgmt_sup_sup, rabbit_mgmt_sup), application:set_env(rabbitmq_management,       sample_retention_policies, [{global, [{605, 1}]}, {basic, [{605, 1}]}, {detailed, [{10, 1}]}]), rabbit_mgmt_sup_sup:start_child().'
+$CTL eval 'supervisor2:terminate_child(rabbit_mgmt_agent_sup_sup, rabbit_mgmt_agent_sup), application:set_env(rabbitmq_management_agent, sample_retention_policies, [{global, [{605, 1}]}, {basic, [{605, 1}]}, {detailed, [{10, 1}]}]), rabbit_mgmt_agent_sup_sup:start_child().'
+
+sleep 3

data/hutch.gemspec

@@ -6,21 +6,19 @@ Gem::Specification.new do |gem|
     gem.add_runtime_dependency 'march_hare', '>= 3.0.0'
   else
     gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '>= 2.16', '< 3.0'
+    gem.add_runtime_dependency 'bunny', '>= 2.19', '< 3.0'
   end
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
-  gem.add_runtime_dependency 'multi_json', '~> 1.14'
-  gem.add_runtime_dependency 'activesupport', '>= 4.2', '< 7'
+  gem.add_runtime_dependency 'multi_json', '~> 1.15'
+  gem.add_runtime_dependency 'activesupport', '>= 4.2', '< 8'
 
   gem.name = 'hutch'
-  gem.summary = 'Easy inter-service communication using RabbitMQ.'
-  gem.description = 'Hutch is a Ruby library for enabling asynchronous ' \
-                    'inter-service communication using RabbitMQ.'
+  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 = '>= 2.2'
-  gem.authors = ['Harry Marr']
-  gem.email = ['developers@gocardless.com']
-  gem.homepage = 'https://github.com/gocardless/hutch'
+  gem.authors = ['Harry Marr', 'Michael Klishin']
+  gem.homepage = 'https://github.com/ruby-amqp/hutch'
   gem.require_paths = ['lib']
   gem.license = 'MIT'
   gem.executables = ['hutch']

data/lib/hutch/adapters/bunny.rb

@@ -28,6 +28,10 @@ module Hutch
       def current_timestamp
         Time.now.to_i
       end
+
+      def self.new_exchange(ch, exchange_type, exchange_name, exchange_options)
+        Bunny::Exchange.new(ch, exchange_type, exchange_name, exchange_options)
+      end
     end
   end
 end

data/lib/hutch/adapters/march_hare.rb

@@ -32,6 +32,10 @@ module Hutch
       def current_timestamp
         Time.now
       end
+
+      def self.new_exchange(ch, exchange_type, exchange_name, exchange_options)
+        MarchHare::Exchange.new(ch, exchange_name, exchange_options.merge(type: exchange_type))
+      end
     end
   end
 end

data/lib/hutch/broker.rb

@@ -127,7 +127,7 @@ module Hutch
       logger.info "using topic exchange '#{exchange_name}'"
 
       with_bunny_precondition_handler('exchange') do
-        Bunny::Exchange.new(ch, exchange_type, exchange_name, exchange_options)
+        Adapter.new_exchange(ch, exchange_type, exchange_name, exchange_options)
       end
     end
 
@@ -171,11 +171,11 @@ module Hutch
     end
 
     # Create / get a durable queue and apply namespace if it exists.
-    def queue(name, arguments = {})
+    def queue(name, options = {})
       with_bunny_precondition_handler('queue') do
         namespace = @config[:namespace].to_s.downcase.gsub(/[^-_:\.\w]/, "")
         name = name.prepend(namespace + ":") if namespace.present?
-        channel.queue(name, durable: true, arguments: arguments)
+        channel.queue(name, **options)
       end
     end
 

data/lib/hutch/consumer.rb

@@ -65,6 +65,11 @@ module Hutch
         @arguments = arguments
       end
 
+      # Congfiures queue options that will be passed when declaring the queue.
+      def queue_options(options = {})
+        @queue_options = options
+      end
+
       # Set custom serializer class, override global value
       def serializer(name)
         @serializer = name
@@ -91,6 +96,15 @@ module Hutch
         all_arguments
       end
 
+      def get_options
+        default_options = { durable: true }
+
+        all_options = default_options.merge(@queue_options || {})
+        all_options[:arguments] = get_arguments
+
+        all_options
+      end
+
       # Accessor for the consumer's routing key.
       def routing_keys
         @routing_keys ||= Set.new

data/lib/hutch/version.rb

@@ -1,3 +1,3 @@
 module Hutch
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lib/hutch/worker.rb

@@ -47,7 +47,7 @@ module Hutch
     def setup_queue(consumer)
       logger.info "setting up queue: #{consumer.get_queue_name}"
 
-      queue = @broker.queue(consumer.get_queue_name, consumer.get_arguments)
+      queue = @broker.queue(consumer.get_queue_name, consumer.get_options)
       @broker.bind_queue(queue, consumer.routing_keys)
 
       queue.subscribe(consumer_tag: unique_consumer_tag, manual_ack: true) do |*args|

data/spec/hutch/broker_spec.rb

@@ -262,7 +262,7 @@ describe Hutch::Broker do
         args.first == ''
         args.last == arguments
       end
-      broker.queue('test', arguments)
+      broker.queue('test', arguments: arguments)
     end
   end
 

data/spec/hutch/worker_spec.rb

@@ -4,7 +4,7 @@ require 'hutch/worker'
 describe Hutch::Worker do
   let(:consumer) { double('Consumer', routing_keys: %w( a b c ),
                           get_queue_name: 'consumer', get_arguments: {},
-                          get_serializer: nil) }
+                          get_options: {}, get_serializer: nil) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
   let(:setup_procs) { Array.new(2) { Proc.new {} } }
@@ -35,7 +35,7 @@ describe Hutch::Worker do
     before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
 
     it 'creates a queue' do
-      expect(broker).to receive(:queue).with(consumer.get_queue_name, consumer.get_arguments).and_return(queue)
+      expect(broker).to receive(:queue).with(consumer.get_queue_name, consumer.get_options).and_return(queue)
       worker.setup_queue(consumer)
     end
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Harry Marr
+- Michael Klishin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,7 +17,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '2.19'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -26,7 +27,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '2.19'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -50,14 +51,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +68,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,19 +78,18 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 description: Hutch is a Ruby library for enabling asynchronous inter-service communication
-  using RabbitMQ.
+  using RabbitMQ
 email:
-- developers@gocardless.com
 executables:
 - hutch
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -98,6 +98,7 @@ files:
 - 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
@@ -165,7 +166,7 @@ files:
 - templates/default/method_details/text/settings.erb
 - templates/default/module/html/settings.erb
 - templates/default/module/setup.rb
-homepage: https://github.com/gocardless/hutch
+homepage: https://github.com/ruby-amqp/hutch
 licenses:
 - MIT
 metadata: {}
@@ -187,7 +188,7 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Easy inter-service communication using RabbitMQ.
+summary: Opinionated asynchronous inter-service communication using RabbitMQ
 test_files:
 - spec/hutch/broker_spec.rb
 - spec/hutch/cli_spec.rb

data/.travis.yml

@@ -1,23 +0,0 @@
-dist: bionic
-sudo: required
-
-language: ruby
-cache: bundler
-before_install:
-  - gem install bundler
-before_script:
-  - "./bin/ci/install_on_debian.sh"
-  - until sudo lsof -i:5672; do echo "Waiting for RabbitMQ to start..."; sleep 1; done
-  - "./bin/ci/before_build.sh"
-matrix:
-  include:
-    - rvm: "3.0.0"  
-    - rvm: "2.7.1"
-    - rvm: "2.6.6"
-    - rvm: "2.5.8"
-    - rvm: "jruby-9.2.19.0"
-      name: "Latest JRuby"
-    - rvm: "ruby-head"
-  allow_failures:
-    - name: "Latest JRuby"
-    - rvm: ruby-head