jackhammer 1.3.7 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d56a6f3d2a1f7ca03feba155032f34598ac37ebe0a33f909beaf8a4925bb351b
-  data.tar.gz: 6e2858cc50c7b9139b4b506f64fb9d4c339ac29ce5fbf5b84f8fb42e52c0305c
+  metadata.gz: 4aa6bdf41e8005dbbfbcdc2bacfc4fae0a8e182cb35b62fea8d961ba350ef600
+  data.tar.gz: 7ce9c945039c1e09b4cec7406c6c1e767f5bc91baf76ace5a9dcdca940f7991b
 SHA512:
-  metadata.gz: 02304a35a6234347fac7ea7257b601accada9293c21620569968da7df1f4831d6c36e350c0c5e94872939cce27c43b179fcdaa6fc1b285e4fbef6c8e40e60836
-  data.tar.gz: 4ea19a99767048e119846b2a024e2c06e060cd79794dda955865d08b7153eebd03c709f63ce0e8c7e050e5b962db45488b8d91113e11a9e2327d33ba71d72dcb
+  metadata.gz: e6ace137b8bac8709c3c38cf7fe0109cda7a13e4fe59d4900bb059f9b1403c445eb67419375a9d1c7c438c84d8d55949bb59291f53aa9982f9658364f43a6283
+  data.tar.gz: b2d6807b73211b09db3db88bc02de9d2d0509a4451c4b1fc252d92e98eb5b864038c25f3482169fe0325d58b820a5a659c16efea077bf32c668a9fafd2f90ec5

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
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: hmarr/auto-approve-action@v2.0.0
-      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      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,29 @@
+name: automerge
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - synchronize
+      - opened
+      - edited
+      - ready_for_review
+      - reopened
+      - unlocked
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.11.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    jackhammer (1.3.7)
+    jackhammer (1.4.0)
       bunny (~> 2.14)
 
 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.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -20,7 +20,7 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     amq-protocol (2.3.2)
     ast (2.4.1)
-    bunny (2.16.1)
+    bunny (2.17.0)
       amq-protocol (~> 2.3, >= 2.3.1)
     bunny-mock (1.7.0)
       bunny (>= 1.7)
@@ -31,17 +31,17 @@ GEM
       concurrent-ruby (~> 1.0)
     minitest (5.14.2)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.2)
     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-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -50,19 +50,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.90.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 0.6.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-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)

data/README.md

@@ -90,6 +90,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 +164,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/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

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/middleware_collection.rb

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

@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackhammer
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.4.0
 platform: ruby
 authors:
 - Scott Serok
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - scott@renofi.com
 executables:
@@ -164,6 +164,7 @@ files:
 - ".github/ISSUE_TEMPLATE/story.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -181,6 +182,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,7 +196,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/renofi/jackhammer
   source_code_uri: https://github.com/renofi/jackhammer
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -209,8 +211,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Jackhammer is an opinionated facade over RabbitMQ Bunny
 test_files: []