hutch 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9725ddb3e39e305bad95abd6c8605c1d9828691904bb2ae31430fd22d88bd180
-  data.tar.gz: db1d87d81de0f89c84b1ec387c66443aa9ead6be2d71b50b6cee32e9146dd080
+  metadata.gz: 9c376d628987a9352a8ff9e49cd48ae0c12364cc3f9393185e8c811ff3052213
+  data.tar.gz: 3aa07c8285817c1fefa10b7dc2b65e3fccf0b62ffbaf7a89e4b09f9a6db67035
 SHA512:
-  metadata.gz: 296138c5cb4c08340f4a72bb8d30009402272f9843efffd0dc1d647328ca1531d188fd3b5a9a15f891f4a8447dbf5f72a7a583aa702f1c999fc557c1ab4ac024
-  data.tar.gz: 2c0406261d2535d5e5d00037e20e29f5cb781e337732491cf36195231e5d647b75c0d96d74c0861afa36cfb24575a0e2b34ce06f59693a98b84342cf1d52ad95
+  metadata.gz: 0c0ba8155050290ebe63628ce10f9fdbd93e4ec483ce8e465564f9635913082d662f2b9f05ca3227f5ad6f5d9c773e9e9653abfbc867f816db0ddf589093d388
+  data.tar.gz: 2ef54abbde9959378b15d1e60062b62ae0b55e8299029fa4fade407f6f9006b6df327f547dc2ba771638fa8d1e512860f0a78f4dc1fe145b337afb4d4000ea64

data/.github/workflows/test.yml

@@ -1,10 +1,13 @@
 name: Test
 
+concurrency: 
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ master ]
 
 jobs:
   test:
@@ -22,10 +25,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['jruby-9.2.19.0', 'jruby-9.3.0.0', 'jruby-head']
+        ruby-version: 
+          - 2.7
+          - 3.0
+          - 3.1
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - 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):
@@ -40,3 +46,12 @@ jobs:
         ./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/Gemfile

@@ -24,7 +24,7 @@ group :development, :test do
   gem "honeybadger"
   gem "coveralls", "~> 0.8.15", require: false
   gem "newrelic_rpm"
-  gem "ddtrace"
+  gem "ddtrace", "~> 0.54.2"
   gem "airbrake", "~> 10.0"
   gem "rollbar"
   gem "bugsnag"

data/lib/hutch/broker.rb

@@ -174,8 +174,8 @@ module Hutch
     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, **options)
+        queue_name = namespace.present? ? "#{namespace}:#{name}" : name
+        channel.queue(queue_name, **options)
       end
     end
 
@@ -287,6 +287,7 @@ module Hutch
         params[:host]               = @config[:mq_host]
         params[:port]               = @config[:mq_port]
         params[:vhost]              = @config[:mq_vhost].presence || Hutch::Adapter::DEFAULT_VHOST
+        params[:auth_mechanism]     = @config[:mq_auth_mechanism]
         params[:username]           = @config[:mq_username]
         params[:password]           = @config[:mq_password]
         params[:tls]                = @config[:mq_tls]

data/lib/hutch/cli.rb

@@ -65,7 +65,7 @@ module Hutch
           return false
         ensure
           # Clean up load path
-          $LOAD_PATH.pop
+          $LOAD_PATH.delete('.')
         end
       end
     end

data/lib/hutch/config.rb

@@ -63,6 +63,9 @@ module Hutch
     # RabbitMQ password
     string_setting :mq_password, 'guest'
 
+    # RabbitMQ Auth Mechanism
+    string_setting :mq_auth_mechanism, 'PLAIN'
+
     # RabbitMQ URI (takes precedence over MQ username, password, host, port and vhost settings)
     string_setting :uri, nil
 
@@ -222,7 +225,12 @@ module Hutch
     end
 
     def self.to_bool(value)
-      !(value.nil? || value == '' || value =~ /^(false|f|no|n|0)$/i || value == false)
+      case value
+      when nil, false, '', /^(false|f|no|n|0)$/i
+        false
+      else
+        true
+      end
     end
 
     def self.is_num(attr)

data/lib/hutch/consumer.rb

@@ -13,13 +13,19 @@ module Hutch
     end
 
     def reject!
+      @message_rejected = true
       broker.reject(delivery_info.delivery_tag)
     end
 
     def requeue!
+      @message_rejected = true
       broker.requeue(delivery_info.delivery_tag)
     end
 
+    def message_rejected?
+      !!@message_rejected
+    end
+
     def logger
       Hutch::Logging.logger
     end

data/lib/hutch/error_handlers/sentry.rb

@@ -11,7 +11,7 @@ module Hutch
         logger.error "#{prefix} Logging event to Sentry"
         logger.error "#{prefix} #{ex.class} - #{ex.message}"
         ::Sentry.configure_scope do |scope|
-          scope.set_context("payload", payload)
+          scope.set_context("payload", JSON.parse(payload))
         end
         ::Sentry.capture_exception(ex)
       end

data/lib/hutch/version.rb

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

data/lib/hutch/worker.rb

@@ -71,7 +71,7 @@ module Hutch
       message = Message.new(delivery_info, properties, payload, serializer)
       consumer_instance = consumer.new.tap { |c| c.broker, c.delivery_info = @broker, delivery_info }
       with_tracing(consumer_instance).handle(message)
-      @broker.ack(delivery_info.delivery_tag)
+      @broker.ack(delivery_info.delivery_tag) unless consumer_instance.message_rejected?
     rescue => ex
       acknowledge_error(delivery_info, properties, @broker, ex)
       handle_error(properties, payload, consumer, ex)

data/spec/hutch/broker_spec.rb

@@ -119,7 +119,7 @@ describe Hutch::Broker do
 
         it 'utilises TLS' do
           expect(Hutch::Adapter).to receive(:new).with(
-            hash_including(tls: true, port: 5671)
+            hash_including(tls: true)
           ).and_return(instance_double('Hutch::Adapter', start: nil))
 
           broker.open_connection
@@ -245,9 +245,9 @@ describe Hutch::Broker do
     context 'when given invalid details' do
       before { config[:mq_api_host] = 'notarealhost' }
       after  { broker.disconnect }
-      let(:set_up_api_connection) { ->{ broker.set_up_api_connection } }
+      let(:set_up_api_connection) { broker.set_up_api_connection }
 
-      specify { expect(set_up_api_connection).to raise_error(StandardError) }
+      specify { expect { broker.set_up_api_connection }.to raise_error(StandardError) }
     end
   end
 
@@ -262,7 +262,7 @@ describe Hutch::Broker do
         args.first == ''
         args.last == arguments
       end
-      broker.queue('test', arguments: arguments)
+      broker.queue('test'.freeze, arguments: arguments)
     end
   end
 

data/spec/hutch/config_spec.rb

@@ -31,12 +31,10 @@ describe Hutch::Config do
     end
 
     context 'for invalid attributes' do
-      let(:invalid_get) do
-        -> { Hutch::Config.get(:invalid_attr) }
-      end
+      let(:invalid_get) { Hutch::Config.get(:invalid_attr) }
 
       specify do
-        expect(invalid_get).to raise_error Hutch::UnknownAttributeError
+        expect { invalid_get }.to raise_error Hutch::UnknownAttributeError
       end
     end
   end
@@ -65,14 +63,52 @@ describe Hutch::Config do
       end
 
       context 'boolean attributes' do
-        before  { Hutch::Config.set(:autoload_rails, new_value) }
-        subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+        context 'from non-empty string' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
 
-        let(:new_value) { "t" }
+          let(:new_value) { "t" }
 
 
-        specify 'casts values to booleans' do
-          expect(value).to eq true
+          specify 'casts values to booleans' do
+            expect(value).to eq true
+          end
+        end
+
+        context 'from empty string' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { "" }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq false
+          end
+        end
+
+        context 'from boolean' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { true }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq true
+          end
+        end
+
+        context 'from nil' do
+          before  { Hutch::Config.set(:autoload_rails, new_value) }
+          subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+          let(:new_value) { nil }
+
+
+          specify 'casts values to booleans' do
+            expect(value).to eq false
+          end
         end
       end
 
@@ -90,12 +126,10 @@ describe Hutch::Config do
     end
 
     context 'for invalid attributes' do
-      let(:invalid_set) do
-        -> { Hutch::Config.set(:invalid_attr, new_value) }
-      end
+      let(:invalid_set) { Hutch::Config.set(:invalid_attr, new_value) }
 
       specify do
-        expect(invalid_set).to raise_error Hutch::UnknownAttributeError
+        expect { invalid_set }.to raise_error Hutch::UnknownAttributeError
       end
     end
   end
@@ -109,8 +143,8 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_getter) { -> { Hutch::Config.invalid_attr } }
-      specify { expect(invalid_getter).to raise_error NoMethodError }
+      let(:invalid_getter) { Hutch::Config.invalid_attr }
+      specify { expect { invalid_getter }.to raise_error NoMethodError }
     end
 
     context 'for an ENV-overriden value attribute' do
@@ -147,8 +181,8 @@ describe Hutch::Config do
     end
 
     context 'for an invalid attribute' do
-      let(:invalid_setter) { -> { Hutch::Config.invalid_attr = new_value } }
-      specify { expect(invalid_setter).to raise_error NoMethodError }
+      let(:invalid_setter) { Hutch::Config.invalid_attr = new_value }
+      specify { expect { invalid_setter }.to raise_error NoMethodError }
     end
   end
 

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -3,6 +3,14 @@ require 'spec_helper'
 describe Hutch::ErrorHandlers::Sentry do
   let(:error_handler) { Hutch::ErrorHandlers::Sentry.new }
 
+  before do
+    Sentry.init do
+      # initialize Sentry so that the integration acutally works
+      # otherwise, all its methods are going to return early
+      # so it will be impossible to check if it actually works
+    end
+  end
+
   describe '#handle' do
     let(:properties) { OpenStruct.new(message_id: "1") }
     let(:payload) { "{}" }

data/spec/hutch/worker_spec.rb

@@ -83,12 +83,14 @@ describe Hutch::Worker do
     it 'passes the message to the consumer' do
       expect(consumer_instance).to receive(:process).
                         with(an_instance_of(Hutch::Message))
+      expect(consumer_instance).to receive(:message_rejected?).and_return(false)
       worker.handle_message(consumer, delivery_info, properties, payload)
     end
 
     it 'acknowledges the message' do
       allow(consumer_instance).to receive(:process)
       expect(broker).to receive(:ack).with(delivery_info.delivery_tag)
+      expect(consumer_instance).to receive(:message_rejected?).and_return(false)
       worker.handle_message(consumer, delivery_info, properties, payload)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Opinionated asynchronous inter-service communication using RabbitMQ