dispatch-rider 1.9.0 → 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [v2.0.0](https://github.com/payrollhero/dispatch-rider/tree/v2.0.0) (2022-09-20)
+[Full Changelog](https://github.com/payrollhero/dispatch-rider/compare/v1.9.0...v2.0.0)
+
+* Tests now run via Github actions
+* Requires Ruby 2.6.5 at the very minimum
+* Requires Rails 5.2 at the very minimum
+* Supports both Aws SDK 1.x and 3.x
+* aws-sdk-sqs and aws-sdk-sns are marked as optional, but strongly recommended.
+* Security Update Rails (CVE-2022-32224): Automatically set the active-record config DispatchRider::ScheduledJob model.
+* Tests are validated against rails 5.2.x, 6.0.x, 6.1.x and 7.0.x
+* Started addressing some of the style issue and tech debt via rubocop-challenger automated PR
+
 ## [v1.9.0](https://github.com/payrollhero/dispatch-rider/tree/v1.9.0) (2019-11-11)
 [Full Changelog](https://github.com/payrollhero/dispatch-rider/compare/v1.8.6...v1.9.0)
 

data/README.md

@@ -7,9 +7,9 @@ handling the messages.
 
 ### Build status
 
-[![Build Status](https://travis-ci.org/payrollhero/dispatch-rider.png?branch=master)](https://travis-ci.org/payrollhero/dispatch-rider)
+[![build](https://github.com/payrollhero/dispatch-rider/actions/workflows/build.yml/badge.svg)](https://github.com/payrollhero/dispatch-rider/actions/workflows/build.yml)
+[![Coverage Status](https://coveralls.io/repos/github/payrollhero/dispatch-rider/badge.svg)](https://coveralls.io/github/payrollhero/dispatch-rider)
 [![Code Climate](https://codeclimate.com/github/payrollhero/dispatch-rider.png)](https://codeclimate.com/github/payrollhero/dispatch-rider)
-[![Dependency Status](https://gemnasium.com/payrollhero/dispatch-rider.png)](https://gemnasium.com/payrollhero/dispatch-rider)
 
 
 ## Installation

data/dispatch-rider.gemspec

@@ -28,36 +28,42 @@ Gem::Specification.new do |gem|
     "Dane Natoli",
     "Piotr Banasik",
     "Ronald Maravilla",
+    "Mathieu Jobin",
   ]
   gem.email = [
-    "piotr@payrollhero.com",
-    "rmaravilla@payrollhero.com",
+    "mathieu@payrollhero.com",
   ]
   gem.homepage = 'https://github.com/payrollhero/dispatch-rider'
   gem.files = `git ls-files`.split($/)
   gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
-  gem.required_ruby_version = '>= 2.1.8'
+  gem.required_ruby_version = '>= 2.6.5'
 
 
-  gem.add_runtime_dependency 'activesupport', '>= 3.2.0'
-  gem.add_runtime_dependency 'activemodel', '>= 3.2.0'
-  gem.add_runtime_dependency 'activerecord', '>= 3.2.0'
+  gem.add_runtime_dependency 'activesupport', '>= 5.2.0'
+  gem.add_runtime_dependency 'activemodel', '>= 5.2.0'
+  gem.add_runtime_dependency 'activerecord', '>= 5.2.0'
   gem.add_runtime_dependency 'daemons', '~> 1.2'
   gem.add_runtime_dependency 'retriable', '~> 3.1', '>= 3.1.2'
   # appsignal is an optional runtime dependency,
   # I am marking it as development for those that don't need it
   gem.add_development_dependency 'appsignal', '~> 1.0'
 
-  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'aws-sdk-sqs', '~> 1.30'
+  gem.add_development_dependency 'aws-sdk-sns', '~> 1.30'
+  gem.add_development_dependency 'bundler', '< 3.0'
+  gem.add_development_dependency 'coveralls_reborn', '~> 0.25'
+  gem.add_development_dependency 'simplecov-lcov'
+  gem.add_development_dependency 'debug'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'rubygems-tasks'
   gem.add_development_dependency 'github_changelog_generator'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'rspec', '~> 3.3'
-  gem.add_development_dependency 'factory_girl'
-  gem.add_development_dependency 'aws-sdk', '~> 1'
-  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'factory_bot'
+
+  # static analysis gems
+  gem.add_development_dependency 'rubocop_challenger'
 end

data/gemfiles/Gemfile-5-2

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.2.6'
+gem 'aws-sdk-sns'
+gem 'aws-sdk-sqs'
+gem 'aws-sdk-v1', github: 'payrollhero/aws-sdk-ruby', branch: 'v1-require-json-2.6' if ENV['AWS_SDK_VER'] == 'v1'

data/gemfiles/Gemfile-6-0

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.0.4'
+gem 'aws-sdk-sns'
+gem 'aws-sdk-sqs'
+gem 'aws-sdk-v1', github: 'payrollhero/aws-sdk-ruby', branch: 'v1-require-json-2.6' if ENV['AWS_SDK_VER'] == 'v1'

data/gemfiles/Gemfile-6-1

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.1.4'
+gem 'aws-sdk-sns'
+gem 'aws-sdk-sqs'
+gem 'aws-sdk-v1', github: 'payrollhero/aws-sdk-ruby', branch: 'v1-require-json-2.6' if ENV['AWS_SDK_VER'] == 'v1'

data/gemfiles/Gemfile-7-0

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 7.0.3'
+gem 'aws-sdk-sns'
+gem 'aws-sdk-sqs'
+gem 'aws-sdk-v1', github: 'payrollhero/aws-sdk-ruby', branch: 'v1-require-json-2.6' if ENV['AWS_SDK_VER'] == 'v1'

data/lib/dispatch-rider/callbacks/access.rb

@@ -21,7 +21,6 @@ module DispatchRider
 
         block_with_callbacks.call
       end
-
     end
   end
 end

data/lib/dispatch-rider/callbacks/storage.rb

@@ -2,7 +2,6 @@ module DispatchRider
   module Callbacks
     # Storage for callbacks.
     class Storage
-
       def initialize
         @callbacks = Hash.new { |storage, key| storage[key] = [] }
       end
@@ -41,7 +40,6 @@ module DispatchRider
       def for(event)
         @callbacks[event]
       end
-
     end
   end
 end

data/lib/dispatch-rider/callbacks/support.rb

@@ -2,13 +2,11 @@ module DispatchRider
   module Callbacks
     # Adds callback support to an object.
     module Support
-
       private
 
       def callbacks
         @callbacks ||= Callbacks::Access.new DispatchRider.config.callbacks
       end
-
     end
   end
 end

data/lib/dispatch-rider/command.rb

@@ -4,7 +4,6 @@ require 'optparse'
 
 module DispatchRider
   class Command
-
     def initialize(options = {})
       @app_home = Pathname.new(Dir.getwd)
       @options = {
@@ -51,6 +50,5 @@ module DispatchRider
       end
       @opts = opts.parse!(args)
     end
-
   end
 end

data/lib/dispatch-rider/demultiplexer.rb

@@ -85,6 +85,5 @@ module DispatchRider
     def logger
       DispatchRider.config.logger
     end
-
   end
 end

data/lib/dispatch-rider/dispatcher.rb

@@ -25,7 +25,5 @@ module DispatchRider
       end
       true # success => true (delete message)
     end
-
-
   end
 end

data/lib/dispatch-rider/error_handlers.rb

@@ -1,5 +1,4 @@
 module DispatchRider
-
   # This is the default error handler for dispatch rider.
   # It simply re-raises the exception.
   module DefaultErrorHandler

data/lib/dispatch-rider/handlers/inheritance_tracking.rb

@@ -4,7 +4,6 @@
 module DispatchRider
   module Handlers
     module InheritanceTracking
-
       def inherited(subclass)
         subclasses << subclass
         super
@@ -13,7 +12,6 @@ module DispatchRider
       def subclasses
         @subclasses ||= Set.new
       end
-
     end
   end
 end

data/lib/dispatch-rider/handlers/named_process.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   module Handlers
     module NamedProcess
-
       def with_named_process(message)
         original_program_name = $0
         begin
@@ -11,7 +10,6 @@ module DispatchRider
           $0 = original_program_name
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/integrations/appsignal.rb

@@ -4,7 +4,6 @@ if defined? Appsignal
   module DispatchRider
     module Integrations
       module Appsignal
-
         def self.wrap_message(job, message)
           ::Appsignal.start
 
@@ -21,7 +20,6 @@ if defined? Appsignal
 
           ::Appsignal.stop
         end
-
       end
     end
   end

data/lib/dispatch-rider/logging/json_formatter.rb

@@ -4,11 +4,9 @@ require 'json'
 module DispatchRider
   module Logging
     class JsonFormatter
-
       def format(data)
         data.to_json
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/lifecycle_logger.rb

@@ -89,7 +89,6 @@ module DispatchRider
         when :start, :stop, :complete, :success then :info
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/text_formatter.rb

@@ -2,7 +2,6 @@
 module DispatchRider
   module Logging
     class TextFormatter
-
       def format(data)
         case data[:phase]
         when :complete
@@ -14,7 +13,7 @@ module DispatchRider
         when :success
           "Succeeded execution of: #{message_info_fragment(data)}"
         when :stop
-          "Got stop #{data[:reason] ? '(' + data[:reason] + ')' : '' } while executing: #{message_info_fragment(data)}"
+          "Got stop #{data[:reason] ? '(' + data[:reason] + ')' : ''} while executing: #{message_info_fragment(data)}"
         when :error_handler_fail
           "Failed error handling of: #{exception_info_fragment(data)}"
         else
@@ -42,7 +41,6 @@ module DispatchRider
       def format_duration(duration)
         '%.2f' % [duration]
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/base_translator.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   module Logging
     class Translator
-
       class BaseTranslator
         def initialize(message, **)
           @message = message
@@ -38,7 +37,6 @@ module DispatchRider
           message_info_fragment(message).merge exception_details
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/complete_translator.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   module Logging
     class Translator
-
       class CompleteTranslator < BaseTranslator
         def initialize(message, duration:)
           super(message)
@@ -12,7 +11,6 @@ module DispatchRider
           message_info_fragment(@message).merge duration: @duration
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/error_handler_fail_translator.rb

@@ -1,10 +1,8 @@
 module DispatchRider
   module Logging
     class Translator
-
       class ErrorHandlerFailTranslator < FailTranslator
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/fail_translator.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   module Logging
     class Translator
-
       class FailTranslator < BaseTranslator
         def initialize(message, exception:)
           super(message)
@@ -12,7 +11,6 @@ module DispatchRider
           exception_info_fragment(@message, @exception)
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/start_translator.rb

@@ -1,13 +1,11 @@
 module DispatchRider
   module Logging
     class Translator
-
       class StartTranslator < BaseTranslator
         def translate
           message_info_fragment(@message)
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/stop_translator.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   module Logging
     class Translator
-
       class StopTranslator < BaseTranslator
         def initialize(message, reason:)
           super(message)
@@ -12,7 +11,6 @@ module DispatchRider
           message_info_fragment(@message).merge reason: @reason
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator/success_translator.rb

@@ -1,10 +1,8 @@
 module DispatchRider
   module Logging
     class Translator
-
       class SuccessTranslator < StartTranslator
       end
-
     end
   end
 end

data/lib/dispatch-rider/logging/translator.rb

@@ -1,6 +1,5 @@
 module DispatchRider
   module Logging
-
     # Translates a message into a loggable hash based on its result.
     class Translator
       def self.translate(message, kind, **args)
@@ -13,7 +12,6 @@ module DispatchRider
         const_get("#{kind}_translator".classify)
       end
     end
-
   end
 end
 

data/lib/dispatch-rider/logging.rb

@@ -1,6 +1,5 @@
 module DispatchRider
   module Logging
-
   end
 end
 

data/lib/dispatch-rider/notification_services/aws_sns.rb

@@ -6,7 +6,7 @@ module DispatchRider
   module NotificationServices
     class AwsSns < Base
       def notifier_builder
-        AWS::SNS
+        Aws::SNS::Client
       rescue NameError
         raise AdapterNotFoundError.new(self.class.name, 'aws-sdk')
       end
@@ -16,15 +16,15 @@ module DispatchRider
       end
 
       def publish_to_channel(channel, message:)
-        Retriable.retriable(tries: 10, on: AWS::Errors::MissingCredentialsError) { super }
+        Retriable.retriable(tries: 10, on: Aws::Errors::MissingCredentialsError) { super }
       end
 
       # not really happy with this, but the notification service registrar system is way too rigid to do this cleaner
       # since you only can have one notifier for the whole service, but you need to create a new one for each region
       def channel(name)
         arn = self.fetch(name)
-        region = arn.split(':')[3]
-        notifier_builder.new(region: region).topics[arn]
+        # in v1, the Topic object was fetched from API, in v3 it's basically just an arn wrapper
+        Aws::SNS::Topic.new(arn)
       end
     end
   end

data/lib/dispatch-rider/notification_services/base.rb

@@ -41,7 +41,7 @@ module DispatchRider
       end
 
       def publish_to_channel(channel, message:)
-        channel.publish(serialize(message))
+        channel.publish(message: serialize(message))
       end
 
       private

data/lib/dispatch-rider/notification_services/file_system/channel.rb

@@ -3,13 +3,12 @@
 module DispatchRider
   module NotificationServices
     class FileSystem::Channel
-
       def initialize(path)
         @file_system_queue = DispatchRider::QueueServices::FileSystem::Queue.new(path)
       end
 
       def publish(message)
-        @file_system_queue.add(message)
+        @file_system_queue.add(message[:message])
       end
     end
   end

data/lib/dispatch-rider/notification_services/file_system/notifier.rb

@@ -3,7 +3,6 @@
 module DispatchRider
   module NotificationServices
     class FileSystem::Notifier
-
       def initialize(options)
         # nothing to do here
       end
@@ -11,7 +10,6 @@ module DispatchRider
       def channel(path)
         FileSystem::Channel.new(path)
       end
-
     end
   end
 end

data/lib/dispatch-rider/publisher/configuration/destination.rb

@@ -1,6 +1,5 @@
 module DispatchRider
   class Publisher::Configuration::Destination
-
     def initialize(name, attributes={})
       @name = name
 
@@ -18,6 +17,5 @@ module DispatchRider
         self.channel == other.channel &&
         self.options == other.options
     end
-
   end
 end

data/lib/dispatch-rider/publisher/configuration/notification_service.rb

@@ -1,6 +1,5 @@
 module DispatchRider
   class Publisher::Configuration::NotificationService
-
     def initialize(name, options)
       @name = name
       @options = options
@@ -12,6 +11,5 @@ module DispatchRider
       self.name == other.name &&
         self.options == other.options
     end
-
   end
 end

data/lib/dispatch-rider/publisher/configuration.rb

@@ -1,6 +1,5 @@
 module DispatchRider
   class Publisher::Configuration
-
     def initialize(configuration_hash = {})
       @notification_services = []
       @destinations = []
@@ -41,7 +40,6 @@ module DispatchRider
         @destinations << Destination.new(name, options)
       end
     end
-
   end
 end
 

data/lib/dispatch-rider/publisher/configuration_reader.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   class Publisher
     module ConfigurationReader
-
       class << self
         def load_config(configuration, publisher)
           configure_notification_services(configuration.notification_services, publisher)
@@ -21,9 +20,7 @@ module DispatchRider
             publisher.register_destination(destination.name, destination.service, destination.channel, destination.options)
           end
         end
-
       end
-
     end
   end
 end

data/lib/dispatch-rider/publisher/configuration_support.rb

@@ -1,7 +1,6 @@
 module DispatchRider
   class Publisher
     module ConfigurationSupport
-
       def configuration
         @configuration ||= Configuration.new
       end
@@ -14,7 +13,6 @@ module DispatchRider
           configuration.parse(configuration_hash)
         end
       end
-
     end
   end
 end

data/lib/dispatch-rider/queue_services/aws_sqs/sqs_received_message.rb

@@ -3,14 +3,14 @@ module DispatchRider
     class AwsSqs < Base
       class SqsReceivedMessage < ReceivedMessage
         attr_reader :total_timeout, :start_time
-        
-        def initialize(message, raw_item, queue)
+
+        def initialize(message, raw_item, queue, queue_visibility_timeout)
           @queue = queue
-          @total_timeout = queue.visibility_timeout
+          @total_timeout = queue_visibility_timeout.to_i
           @start_time = Time.now
           super(message, raw_item)
         end
-        
+
         # NOTE: Setting the visibility timeout resets the timeout to NOW and makes it visibility timeout this time
         # Essentially resetting the timer on this message
         def extend_timeout(timeout)
@@ -19,7 +19,7 @@ module DispatchRider
             @total_timeout = timeout + (Time.now - start_time).to_i
           end
         end
-        
+
         # We effectively return the item to the queue by setting
         # the visibility timeout to zero.  The item
         # should become immediately visible.
@@ -38,9 +38,8 @@ module DispatchRider
         end
 
         def queue_name
-          @queue.arn.split(':').last
+          @item.queue_arn.split(':').last
         end
-
       end
     end
   end