jackhammer 1.3.7 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d56a6f3d2a1f7ca03feba155032f34598ac37ebe0a33f909beaf8a4925bb351b
-  data.tar.gz: 6e2858cc50c7b9139b4b506f64fb9d4c339ac29ce5fbf5b84f8fb42e52c0305c
+  metadata.gz: 78ec1dce5b7eb73a3b8137bd2a075c18d4dc56c9068cbae2447d55e5e4645f91
+  data.tar.gz: c006744c74e10460cf3e73717f9c9d8b6a5cacc1dcf965ed36e31b3034fa2249
 SHA512:
-  metadata.gz: 02304a35a6234347fac7ea7257b601accada9293c21620569968da7df1f4831d6c36e350c0c5e94872939cce27c43b179fcdaa6fc1b285e4fbef6c8e40e60836
-  data.tar.gz: 4ea19a99767048e119846b2a024e2c06e060cd79794dda955865d08b7153eebd03c709f63ce0e8c7e050e5b962db45488b8d91113e11a9e2327d33ba71d72dcb
+  metadata.gz: 9132d9d33f46257e18ac9c690f335b1b2c301d5301287d7c205cc67b926b22568cafda175d92f48fea963498b04526ea86f51fa8bd6fc521635f6d59edace64d
+  data.tar.gz: 1f64927a24801ac652539da84d01a8d77994bb30959c0d10ee5dc09c5eca9c4083cb3ca065fd037e4cd8c5e290f4046eb0c7d89b816b7c81bf40186b7db224d0

data/.bundler-version

@@ -0,0 +1 @@
+2.2.32

data/.dependabot/config.yml

@@ -3,9 +3,14 @@ version: 1
 update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
-    update_schedule: "monthly"
+    update_schedule: "daily"
     commit_message:
       prefix: "[dependabot]"
     allowed_updates:
       - match:
-          update_type: "all"
+          dependency_type: "all"
+          update_type: "security"
+    automerged_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "security:patch"

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +1,6 @@
-## Description
+## Description, motivation and context
 <!--- Describe your changes in detail -->
-
-## Related issue(s)
-<!--- GH issue number -->
-
-## Motivation and Context
 <!--- Why is this change required? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
 
-## How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-
-## Screenshots (if appropriate):
-<!--- Please add any screenshots of the feature. -->
-
-## Related PRs
-<!--- Please add links to any related PRs (backend, component packages, etc). -->
+## Related issue(s) or PR(s)
+<!--- GH issue number -->

data/.github/workflows/auto-approve.yml

@@ -1,7 +1,7 @@
-# automatically approve PRs submitted by Dependabot
+# automatically approve PRs submitted by Dependabot or Renofidev
 # this will allow Dependabot to automatically merge dependency update PRs where CI passes
 # from: https://github.com/hmarr/auto-approve-action
-name: Auto approve Dependabot PRs
+name: Auto approve dependency upgrades PRs
 
 on:
   pull_request
@@ -10,7 +10,7 @@ jobs:
   auto-approve:
     runs-on: ubuntu-latest
     steps:
-    - uses: hmarr/auto-approve-action@v2.0.0
-      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+    - uses: hmarr/auto-approve-action@v2
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
       with:
         github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,19 @@
+name: automerge
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.12.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    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: Run tests
+      run: bundle exec rake ci

data/Gemfile.lock

@@ -1,79 +1,88 @@
 PATH
   remote: .
   specs:
-    jackhammer (1.3.7)
-      bunny (~> 2.14)
+    jackhammer (1.5.1)
+      bunny (~> 2.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     amq-protocol (2.3.2)
-    ast (2.4.1)
-    bunny (2.16.1)
+    ast (2.4.2)
+    bunny (2.19.0)
       amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
     bunny-mock (1.7.0)
       bunny (>= 1.7)
     byebug (11.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.5)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.6)
+    rbtree (0.4.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.90.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
-    rubocop-rspec (1.43.2)
-      rubocop (~> 0.87)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    set (1.0.2)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
-  ruby
+  aarch64-linux-musl
+  x86_64-darwin-18
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   activerecord
@@ -84,8 +93,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
   rubocop-rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.29

data/README.md

@@ -1,5 +1,10 @@
 [![Gem Version](https://badge.fury.io/rb/jackhammer.svg)](https://rubygems.org/gems/jackhammer)
-[![Build Status](https://travis-ci.org/RenoFi/jackhammer.svg?branch=master)](https://travis-ci.org/RenoFi/jackhammer)
+[![Build Status](https://github.com/RenoFi/jackhammer/actions/workflows/ci.yml/badge.svg)](https://github.com/RenoFi/jackhammer/actions/workflows/ci.yml?query=branch%3Amain)
+
+## !!! NO LONGER MAINTANED !!!
+
+RenoFi moved to Google Pub/Sub and doesn't use rabbitmmq/jackhammer anymore.
+
 
 # jackhammer
 
@@ -90,6 +95,8 @@ module MyApp
       config.publish_options    = { mandatory: true, persistent: true }
       config.yaml_config        = "config/jackhammer.yml"
       config.app_name           = "my_app"
+      config.client_middleware.use MyClientMiddleware, some_arg: 1, other_arg: 2
+      config.server_middleware.use MyServerMiddleware
     end
   end
 end
@@ -162,10 +169,47 @@ The intent of the options might not be obvious by looking at the name.
   overridden by passing the same options as arguments in your code).
 - **yaml_config** defines the file location of the Topic Exchange YAML
   configuration file.
+- **client_middleware** defines hooks that will be executed prior to publishing a message to a topic
+- **server_middleware** defines hooks that will be executed prior to running the message handler
 
 You can find defaults specified in the Jackhammer::Configuration class
 constructor.
 
+### Middleware
+
+Middleware allows you to hook into message publishing (client) and handling (server).
+
+It can be used to transform the passed in arguments before passing them along or to halt the execution completely.
+The execution will be halted if the middleware instance does not yield.
+
+#### Example client middleware
+
+```ruby
+class MyClientMiddleware
+  def initialize(name)
+    @name = name
+  end
+  
+  def call(message, options)
+    options[:headers][:hello] = @name
+
+    yield message, options
+  end
+end
+```
+
+#### Example server middleware
+
+```ruby
+class MyServerMiddleware
+  def call(handler:, delivery_info:, properties:, content:)
+    puts "Hello, #{properties[:headers]['name']}!"
+
+    yield handler: handler, delivery_info: delivery_info, properties: properties, content: content
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -5,4 +5,5 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
+task ci: %i[spec rubocop]
 task default: %i[spec rubocop:auto_correct]

data/jackhammer.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
@@ -22,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.0.0'
 
-  spec.add_dependency 'bunny', '~> 2.14'
+  spec.add_dependency 'bunny', '~> 2.17'
 
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'
@@ -33,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
 end

data/lib/jackhammer/configuration.rb

@@ -2,6 +2,7 @@ module Jackhammer
   class Configuration
     attr_accessor(
       :app_name,
+      :client_middleware,
       :connection_options,
       :connection_url,
       :environment,
@@ -9,6 +10,7 @@ module Jackhammer
       :logger,
       :publish_options,
       :server,
+      :server_middleware,
       :yaml_config
     )
 
@@ -20,6 +22,8 @@ module Jackhammer
       @logger = Logger.new IO::NULL
       @publish_options = { mandatory: true, persistent: true }
       @yaml_config = './config/jackhammer.yml'
+      @client_middleware = MiddlewareCollection.new
+      @server_middleware = MiddlewareCollection.new
     end
 
     def self.instance

data/lib/jackhammer/configuration_validator.rb

@@ -9,10 +9,13 @@ module Jackhammer
     def validate
       validate_environment_defined
       return if errors.any?
+
       validate_topic_exchange_defined
       return if errors.any?
+
       validate_queues_defined
       return if errors.any?
+
       validate_handlers_defined
     end
 

data/lib/jackhammer/middleware_collection.rb

@@ -0,0 +1,29 @@
+module Jackhammer
+  class MiddlewareCollection
+    def initialize
+      @entries = []
+    end
+
+    def use(klass, *args, **kwargs, &block)
+      @entries << Entry.new(klass: klass, args: args, kwargs: kwargs, block: block)
+    end
+
+    def call(*args, **kwargs, &block)
+      call_chain = @entries.map(&:instantiate) + [block]
+
+      traverse = proc do |*procargs, **prockwargs|
+        call_chain.shift.call(*procargs, **prockwargs, &traverse) unless call_chain.empty?
+      end
+
+      traverse.call(*args, **kwargs)
+    end
+
+    Entry = Struct.new(:klass, :args, :kwargs, :block, keyword_init: true) do
+      def instantiate
+        return klass unless klass.respond_to?(:new)
+
+        klass.new(*args, **kwargs, &block)
+      end
+    end
+  end
+end

data/lib/jackhammer/queue.rb

@@ -13,7 +13,15 @@ module Jackhammer
       queue.subscribe do |delivery_info, properties, content|
         Log.info { [delivery_info.inspect, properties.inspect].join(' || ') }
         Log.debug { content }
-        handler_object.call content
+
+        Jackhammer.server_middleware.call(
+          handler: handler_object,
+          delivery_info: delivery_info,
+          properties: properties,
+          content: content
+        ) do |**args|
+          args.fetch(:handler).call args.fetch(:content)
+        end
       rescue StandardError => e
         Log.error e
         Jackhammer.configuration.exception_adapter.call e

data/lib/jackhammer/topic.rb

@@ -3,8 +3,8 @@ module Jackhammer
     QUEUE_NAME_KEY = 'queue_name'.freeze
     ROUTING_KEY_KEY = 'routing_key'.freeze
 
-    def initialize(name:, options:, queue_config:)
-      @topic = Jackhammer.channel.topic name, options
+    def initialize(name:, queue_config:, options: {})
+      @topic = Jackhammer.channel.topic(name, options)
       @queue_config = normalize_queue_config(queue_config)
     end
 
@@ -15,7 +15,9 @@ module Jackhammer
     # We're expecting the client to specify at least the routing_key in options
     # for each message published.
     def publish(message, options)
-      topic.publish message, Jackhammer.publish_options(options)
+      Jackhammer.client_middleware.call(message, Jackhammer.publish_options(options)) do |msg, opts|
+        topic.publish msg, opts
+      end
     end
 
     def queues

data/lib/jackhammer/topic_manager.rb

@@ -5,6 +5,7 @@ module Jackhammer
         result = {}
         Jackhammer.configuration.yaml.each do |topic, topic_config|
           fail(InvalidConfigError, "Topic config is invalid") unless topic_config.is_a?(Hash)
+
           queues = topic_config.delete 'queues'
           result[topic.to_sym] = Topic.new(name: topic, options: topic_config, queue_config: queues)
         end

data/lib/jackhammer/version.rb

@@ -1,3 +1,3 @@
 module Jackhammer
-  VERSION = '1.3.7'.freeze
+  VERSION = '1.5.1'.freeze
 end

data/lib/jackhammer.rb

@@ -7,6 +7,7 @@ require 'jackhammer/exceptions'
 require 'jackhammer/log'
 require 'jackhammer/configuration'
 require 'jackhammer/message_receiver'
+require 'jackhammer/middleware_collection'
 require 'jackhammer/queue_name'
 require 'jackhammer/queue'
 require 'jackhammer/topic'
@@ -46,5 +47,13 @@ module Jackhammer
         opts[:headers][:time] ||= time.iso8601
       end
     end
+
+    def client_middleware
+      configuration.client_middleware
+    end
+
+    def server_middleware
+      configuration.server_middleware
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackhammer
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.5.1
 platform: ruby
 authors:
 - Scott Serok
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -158,15 +158,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-version"
 - ".dependabot/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/ISSUE_TEMPLATE/story.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -181,6 +183,7 @@ files:
 - lib/jackhammer/exceptions.rb
 - lib/jackhammer/log.rb
 - lib/jackhammer/message_receiver.rb
+- lib/jackhammer/middleware_collection.rb
 - lib/jackhammer/queue.rb
 - lib/jackhammer/queue_name.rb
 - lib/jackhammer/rake_task.rb
@@ -194,6 +197,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/renofi/jackhammer
   source_code_uri: https://github.com/renofi/jackhammer
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -202,14 +206,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.23
 signing_key:
 specification_version: 4
 summary: Jackhammer is an opinionated facade over RabbitMQ Bunny

data/.travis.yml

@@ -1,11 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-  - 2.7
-before_install: gem install bundler
-script:
-  - bundle exec rake spec
-  - bundle exec rake rubocop