jackhammer 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3233e5bc59da2462018ba8fce8316c164a98b67de74febd54adb5eb947ea791
-  data.tar.gz: 1cc3cc86e29fd9f053b35be5ccfb5b3e60c0a6513f049d39c7c725fdf2cc103d
+  metadata.gz: 485b5598534853da9cc94ce3402e8e81e1f261820208f04d4f343783cf82e231
+  data.tar.gz: e8ae165eb429b89065c8cb3630457bffc15d1be6a9e59826d52466f2a28b19dd
 SHA512:
-  metadata.gz: d35d51ed2ed012671cd41035f417e161d5ecdb1c44a01e6c27c0c880e967de30d5c04900a517cddceb93987e7f4ad091e07e11a1b62a09f6893d70d2a8f86c88
-  data.tar.gz: 85720d119ebbde35fbb0f05fb57058f7afe8251f7942891ccfd8765503cd022cb2ea3a376ac73cb978dda66dc16358b9462884e1589d46e218d41b3346065dc3
+  metadata.gz: b505c5468529bb070b6fd193a460a0252134886059b22858961f54af1932e56fb6096fe9f4fe966e32c76856cb85aad8451fa2aaf22d6c93f97f5d4722b8a92f
+  data.tar.gz: 35afe310870caf60d6a505c9f5839f4043014f7c651166d129116dfa012da4f54f92dd8718ca7ab74f42e9c9f0442e136331134739597e5cecd155698ca126bc

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to track an issue that has been identified
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Mutation/Query**
+
+**URL and HTTP method (for non-GQL):**
+
+**Sentry or Logs URL:**
+
+**User/authentication details**
+Impacted user name or service account
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/story.md

@@ -0,0 +1,22 @@
+---
+name: New story
+about: Add a new story for implementation
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the solution**
+A clear and concise description of what you want to happen.
+When will this feature be done?
+
+**Describe the users**
+Who are we building this feature for?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+Link to any applicable documents describing the feature.
+
+**Designs**
+Link to any applicable designs on Invision.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Description
+<!--- 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). -->

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

@@ -0,0 +1,16 @@
+# automatically approve PRs submitted by Dependabot
+# 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
+
+on:
+  pull_request
+
+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]'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.travis.yml

@@ -3,8 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5
   - 2.6
+  - 2.7
 before_install: gem install bundler
 script:
-  - bundle exec rake
+  - bundle exec rake spec
+  - bundle exec rake rubocop

data/Gemfile.lock

@@ -1,55 +1,82 @@
 PATH
   remote: .
   specs:
-    jackhammer (1.3.0)
+    jackhammer (1.3.5)
       bunny (~> 2.14)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    amq-protocol (2.3.0)
-    ast (2.4.0)
-    bunny (2.14.3)
-      amq-protocol (~> 2.3, >= 2.3.0)
+    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)
+      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.2)
+    ast (2.4.1)
+    bunny (2.15.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
     bunny-mock (1.7.0)
       bunny (>= 1.7)
-    byebug (11.1.1)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.4)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      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.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.88.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.0)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   bundler
   bunny-mock
   byebug
@@ -58,6 +85,7 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rspec
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,10 +1,9 @@
+[![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)
-[![GitHub issues](https://img.shields.io/github/issues/renofi/jackhammer)](https://github.com/renofi/jackhammer/issues)
-[![GitHub license](https://img.shields.io/github/license/renofi/jackhammer)](https://github.com/RenoFi/jackhammer/blob/master/LICENSE.txt)
 
-# Jackhammer
+# jackhammer
 
-Jackhammer is an opinionated, configurable facade over the RabbitMQ Bunny
+`jackhammer` is an opinionated, configurable facade over the RabbitMQ Bunny
 module.
 
 ## Installation
@@ -180,7 +179,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/renofi
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Jackhammer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/renofi/jackhammer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/jackhammer.gemspec

@@ -3,27 +3,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jackhammer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'jackhammer'
-  spec.version       = Jackhammer::VERSION
-  spec.authors       = ['Scott Serok']
-  spec.email         = ['scott@renofi.com']
+  spec.name = 'jackhammer'
+  spec.version = Jackhammer::VERSION
+  spec.authors = ['Scott Serok']
+  spec.email = ['scott@renofi.com']
 
-  spec.summary       = 'Jackhammer is an opinionated facade over RabbitMQ Bunny'
-  spec.homepage      = 'https://github.com/renofi/jackhammer'
-  spec.license       = 'MIT'
+  spec.summary = 'Jackhammer is an opinionated facade over RabbitMQ Bunny'
+  spec.homepage = 'https://github.com/renofi/jackhammer'
+  spec.license = 'MIT'
 
-  spec.metadata['homepage_uri']     = spec.homepage
-  spec.metadata['source_code_uri']  = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'bunny', '~> 2.14'
 
+  spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'bunny-mock'
   spec.add_development_dependency 'byebug'
@@ -31,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
 end

data/lib/jackhammer.rb

@@ -38,7 +38,7 @@ module Jackhammer
       @topics ||= TopicManager.topics
     end
 
-    def publish_options(options = {}, time: Time.now.utc)
+    def publish_options(options = {}, time = Time.now.utc)
       configuration.publish_options.dup.merge(options).tap do |opts|
         opts[:timestamp] = time.to_i
         opts[:app_id] ||= configuration.app_name

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

@@ -15,6 +15,8 @@ module Jackhammer
       else
         handler.call message
       end
+    ensure
+      ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
     end
   end
 end

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,70 @@
+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
+      @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))
+        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/version.rb

@@ -1,3 +1,3 @@
 module Jackhammer
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.3.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackhammer
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - Scott Serok
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - scott@renofi.com
@@ -131,10 +159,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".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"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -145,11 +177,13 @@ 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/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
@@ -175,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Jackhammer is an opinionated facade over RabbitMQ Bunny

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at scott@renofi.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/