jackhammer 1.3.4 → 1.5.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38bd9a7e8b2be82da0c8751c93a24c77b40a580de54b40041479e7585487d160
-  data.tar.gz: 06b2c035650f92b9bf48297107457d99820bd54bb80f97a63463b462cc52e320
+  metadata.gz: fe3c95c59d65b18dc571d1ed7d3a20b64ee124573167059c931ebc88201453d8
+  data.tar.gz: 39f7e8b0a4fc0217074fd39c2fc118abbfd411a5f1500b27e419f1cd13d2c599
 SHA512:
-  metadata.gz: 380993eadd3d1fc75491dda76684bed6192c9b5761b838d681f81258c844413ee70a07a2a1594a67374c45958e3c6fe3eeaf8cc54657e3ce652421e039910b42
-  data.tar.gz: 18cd2e224c838c1efaad1c80720792af77e68efd1c52b962d272e7824401398ee81ef3acae8eb92c69947b6a25728023b95eb6064381e5cd8c5e43306b1f5e73
+  metadata.gz: 2777a62d62fd0f1f0c6fba1e50734666378c124a1ff8b31b5daefc4c6f7ee5f29ab2dcc03eafe1baca09f84a6abe95624bc306b8da4918edd577354f4684c6fc
+  data.tar.gz: e173c65281312be2d6af359d9714de1a849d0bc9f43489a48b76b25dcf6ff9373b6e6c5fb0487de3c8aa041b86770d159d7be2ba04dff12bf489f4d1e19cd439

data/.bundler-version

@@ -0,0 +1 @@
+2.2.21

data/.dependabot/config.yml

@@ -3,16 +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: "development"
-          update_type: "all"
-      - match:
-          dependency_type: "production"
-          update_type: "all"
+          dependency_type: "all"
+          update_type: "security:patch"

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,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/.travis.yml

@@ -5,6 +5,7 @@ cache: bundler
 rvm:
   - 2.6
   - 2.7
+  - 3.0
 before_install: gem install bundler
 script:
   - bundle exec rake spec

data/Gemfile.lock

@@ -1,77 +1,86 @@
 PATH
   remote: .
   specs:
-    jackhammer (1.3.4)
-      bunny (~> 2.14)
+    jackhammer (1.5.0.rc)
+      bunny (~> 2.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activerecord (6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activesupport (6.0.3.1)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    amq-protocol (2.3.1)
-    ast (2.4.0)
-    bunny (2.15.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    amq-protocol (2.3.2)
+    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.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.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.4)
+    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.84.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-performance (1.6.0)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    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.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    set (1.0.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   activerecord
@@ -82,8 +91,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
   rubocop-rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

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/Rakefile

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

data/jackhammer.gemspec

@@ -22,7 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bunny', '~> 2.14'
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_dependency 'bunny', '~> 2.17'
 
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'
@@ -31,6 +33,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.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/cli.rb

@@ -5,7 +5,7 @@ module Jackhammer
     attr_reader :logger, :opts
 
     def initialize(options = {})
-      @logger = Logger.new STDERR
+      @logger = Logger.new $stderr
       @opts = { require: './config/environment' }.merge(options)
     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

@@ -0,0 +1,60 @@
+module Jackhammer
+  class ConfigurationValidator
+    attr_accessor :config_yaml, :environment, :errors
+
+    def initialize
+      @errors = []
+    end
+
+    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
+
+    def validate_environment_defined
+      return if config_yaml[environment]
+
+      add_error("Environment '#{environment}' is not defined")
+    end
+
+    def validate_topic_exchange_defined
+      return if config_yaml[environment].keys.any?
+
+      add_error("Environment '#{environment}' does not define a topic exchange")
+    end
+
+    def validate_queues_defined
+      topics = config_yaml[environment].keys
+      topics.each do |topic|
+        begin
+          next if config_yaml[environment][topic]['queues']
+        rescue StandardError
+          false
+        end
+
+        add_error("Topic '#{topic}' does not define any queues")
+      end
+    end
+
+    def validate_handlers_defined
+      config_yaml[environment].each do |exchange_name, exchange_config|
+        exchange_config['queues'].each do |qconfig|
+          Object.const_get(qconfig['handler'])
+        rescue NameError
+          add_error("Uninitialized constant #{qconfig['handler']}")
+        end
+      end
+    end
+
+    private
+
+    def add_error(str)
+      @errors << str
+    end
+  end
+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/queue_name.rb

@@ -7,7 +7,7 @@ module Jackhammer
     def self.from_routing_key(routing_key)
       fail(InvalidConfigError, "app_name must be set to determine queue_name from routing_key") if app_name.to_s.empty?
 
-      "#{app_name}_#{routing_key}_q".gsub(/[^\w]+/, '_').gsub(/[_]+/, '_')
+      "#{app_name}_#{routing_key}_q".gsub(/[^\w]+/, '_').squeeze('_')
     end
   end
 end

data/lib/jackhammer/rake_task.rb

@@ -0,0 +1,71 @@
+require 'rake'
+require 'rake/tasklib'
+require 'yaml'
+require 'jackhammer/configuration_validator'
+
+module Jackhammer
+  class RakeTask < ::Rake::TaskLib
+    # Name of test task. (default is :jackhammer)
+    attr_accessor :name
+
+    # File path of the configuration file. (default is ./config/jackhammer.yml)
+    attr_accessor :path
+
+    # Description of the test task. (default is 'Validate Jackhammer
+    # configuration')
+    attr_accessor :description
+
+    # Task prerequisites.
+    attr_accessor :deps
+
+    # Specifies the environment to inspect. (default is 'production')
+    attr_accessor :env
+
+    def initialize
+      super
+      @name = :jackhammer
+      @env = 'production'
+      @path = './config/jackhammer.yml'
+      @description = 'Validate Jackhammer configuration'
+      @deps = []
+      yield self if block_given?
+      if @name.is_a?(Hash)
+        @deps = @name.values.first
+        @name = @name.keys.first
+      end
+      define
+    end
+
+    def define
+      desc @description
+      task @name => Array(deps) do
+        validator = ConfigurationValidator.new
+        validator.config_yaml = YAML.safe_load(File.read(@path), [], [], true)
+        validator.environment = env
+        validator.validate
+        print_results validator.errors
+      end
+    end
+
+    private
+
+    def print_results(errors)
+      puts "Jackhammer configuration #{path}\n"
+      if errors.any?
+        puts red("Problems identified: #{errors.size}\n")
+        errors.each { |error| puts red(error) }
+        exit 1
+      else
+        puts green('OK')
+      end
+    end
+
+    def red(text)
+      "\e[1;31m#{text}\e[0m"
+    end
+
+    def green(text)
+      "\e[1;32m#{text}\e[0m"
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module Jackhammer
-  VERSION = '1.3.4'.freeze
+  VERSION = '1.5.0.rc'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackhammer
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.5.0.rc
 platform: ruby
 authors:
 - Scott Serok
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2021-07-06 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:
     - - ">="
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - scott@renofi.com
 executables:
@@ -158,12 +158,14 @@ 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"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -177,11 +179,14 @@ files:
 - lib/jackhammer.rb
 - lib/jackhammer/cli.rb
 - lib/jackhammer/configuration.rb
+- lib/jackhammer/configuration_validator.rb
 - 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
 - lib/jackhammer/server.rb
 - lib/jackhammer/topic.rb
 - lib/jackhammer/topic_manager.rb
@@ -192,7 +197,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
@@ -200,15 +205,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Jackhammer is an opinionated facade over RabbitMQ Bunny
 test_files: []