dispatch-rider 2.1.0 → 2.2.0

data/lib/dispatch-rider/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Configuration
     attr_accessor(
@@ -22,7 +24,7 @@ module DispatchRider
       @subscriber = DispatchRider::Subscriber
       @log_formatter = DispatchRider::Logging::TextFormatter.new
       @additional_info_injector = -> (data) { data }
-      @logger = Logger.new(STDERR)
+      @logger = Logger.new($stderr)
       @debug = false
 
       @callbacks.around(:dispatch_message) do |job, message|

data/lib/dispatch-rider/debug.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Debug
-    PUBLISHER_MESSAGE_GUID = 'test-mode-not-random-guid'.freeze
+    PUBLISHER_MESSAGE_GUID = 'test-mode-not-random-guid'
   end
 end

data/lib/dispatch-rider/demultiplexer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The demultiplexer in the reactor pattern is implemented in this class.
 # The object needs to be initiated with a queue and a dispatcher.
 # Demultiplexer#start defines an event loop which pops items from the queue
@@ -17,13 +19,13 @@ module DispatchRider
 
     def start
       do_loop do
-        begin
-          sleep 1
-          handle_next_queue_item
-        rescue => exception
-          error_handler.call(Message.new(subject: "TopLevelError", body: {}), exception)
-          throw :done
-        end
+
+        sleep 1
+        handle_next_queue_item
+      rescue => exception
+        error_handler.call(Message.new(subject: "TopLevelError", body: {}), exception)
+        throw :done
+
       end
       self
     end
@@ -36,12 +38,10 @@ module DispatchRider
     private
 
     def with_current_message(message)
-      begin
-        @current_message = message
-        yield
-      ensure
-        @current_message = nil
-      end
+      @current_message = message
+      yield
+    ensure
+      @current_message = nil
     end
 
     # This needs to return true/false based on the success of the jobs!
@@ -74,12 +74,10 @@ module DispatchRider
     end
 
     def handle_message_error(message, exception)
-      begin
-        error_handler.call(message, exception)
-      rescue => error_handler_exception # the error handler crashed
-        Logging::LifecycleLogger.log_error_handler_fail message, error_handler_exception
-        raise error_handler_exception
-      end
+      error_handler.call(message, exception)
+    rescue => error_handler_exception # the error handler crashed
+      Logging::LifecycleLogger.log_error_handler_fail message, error_handler_exception
+      raise error_handler_exception
     end
 
     def logger

data/lib/dispatch-rider/dispatcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class is responsible for dispatching the messages to the appropriate handler.
 # The handlers must be registered with the dispatcher.
 # Tha handlers need to be modules that implement the process method.

data/lib/dispatch-rider/error_handlers.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module DispatchRider
   # This is the default error handler for dispatch rider.
   # It simply re-raises the exception.
   module DefaultErrorHandler
-    def self.call(message, exception)
+    def self.call(_message, exception)
       raise exception
     end
   end

data/lib/dispatch-rider/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file contains all the error classes for this gem.
 module DispatchRider
   # The base error class of the gem

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

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Handlers
     class Base
       include NamedProcess
       extend InheritanceTracking
-      
+
       class << self
-        def set_default_retry( amount ) 
+        def set_default_retry( amount )
           define_method(:retry_timeout) do
             amount
           end
         end
       end
-      
+
       attr_reader :raw_message
 
       def do_process(raw_message)
@@ -20,24 +22,24 @@ module DispatchRider
           process(raw_message.body)
         end
       rescue Exception => e
-        self.retry if self.retry_on_failure?
+        self.retry if retry_on_failure?
         raise e
       end
 
       def process(message)
         raise NotImplementedError, "Method 'process' not overridden in subclass!"
       end
-      
+
       protected
-      
+
       def extend_timeout(timeout)
         raw_message.extend_timeout(timeout)
       end
-      
+
       def return_to_queue
         raw_message.return_to_queue
       end
-      
+
       def retry
         timeout = retry_timeout
         case timeout
@@ -47,9 +49,9 @@ module DispatchRider
           extend_timeout(timeout)
         end
       end
-      
+
       def retry_on_failure?
-        self.respond_to? :retry_timeout
+        respond_to? :retry_timeout
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This module tracks which classes inherit from the class that includes
 # the module, and provides an accessor to it.
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Handlers
     module NamedProcess

data/lib/dispatch-rider/handlers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Handlers
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined? Appsignal
   ::Appsignal.logger.info('Loading Dispatch Rider integration')
 
@@ -13,7 +15,7 @@ if defined? Appsignal
             method: 'handle',
             attempts: message.receive_count,
             queue: message.queue_name,
-            queue_time: (Time.now.to_f - message.sent_at.to_f) * 1000,
+            queue_time: (Time.now.to_f - message.sent_at.to_f) * 1000
           ) do
             job.call
           end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 # JSON Log Formatter

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class LifecycleLogger

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Text Log Formatter
 module DispatchRider
   module Logging

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     class Translator

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
     # Translates a message into a loggable hash based on its result.

data/lib/dispatch-rider/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module Logging
   end

data/lib/dispatch-rider/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class represents a message. All other objects dela with passing around instances of this class.
 # A message must have a subject and a body. The subject represents the handlers name and the body represents
 # the payload of the process method in the handler.
@@ -27,6 +29,7 @@ module DispatchRider
 
     def ==(other)
       return false unless other.respond_to? :attributes
+
       attributes == other.attributes
     end
   end

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

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sns'
+
 # This is a basic implementation of the Notification service using Amazon SNS.
 # The expected usage is as follows :
 #   notification_service = DispatchRider::NotificationServices::AwsSns.new
@@ -7,8 +11,6 @@ module DispatchRider
     class AwsSns < Base
       def notifier_builder
         Aws::SNS::Client
-      rescue NameError
-        raise AdapterNotFoundError.new(self.class.name, 'aws-sdk')
       end
 
       def channel_registrar_builder
@@ -22,7 +24,7 @@ module DispatchRider
       # 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)
+        arn = fetch(name)
         # in v1, the Topic object was fetched from API, in v3 it's basically just an arn wrapper
         Aws::SNS::Topic.new(arn)
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This base class provides an interface that we can implement
 # to generate a wrapper around a notification service.
 # The expected usage is as follows :

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this represents a FileSystem queue channel (or basically a folder)
 
 module DispatchRider

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is abstraction around a notifier service for FileSystem based queue services
 
 module DispatchRider

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this is a basic notification service which uses a filesystem folder to handle notifications
 
 module DispatchRider
@@ -12,7 +14,7 @@ module DispatchRider
       end
 
       def channel(name)
-        notifier.channel(self.fetch(name))
+        notifier.channel(fetch(name))
       end
     end
   end

data/lib/dispatch-rider/notification_services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The namespace that holds the notification services services
 module DispatchRider
   module NotificationServices

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 module DispatchRider

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Publisher::Configuration::Destination
     def initialize(name, attributes={})
@@ -12,10 +14,10 @@ module DispatchRider
     attr_reader :name, :service, :channel, :options
 
     def ==(other)
-      self.name == other.name &&
-        self.service == other.service &&
-        self.channel == other.channel &&
-        self.options == other.options
+      name == other.name &&
+        service == other.service &&
+        channel == other.channel &&
+        options == other.options
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Publisher::Configuration::NotificationService
     def initialize(name, options)
@@ -8,8 +10,8 @@ module DispatchRider
     attr_reader :name, :options
 
     def ==(other)
-      self.name == other.name &&
-        self.options == other.options
+      name == other.name &&
+        options == other.options
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Publisher::Configuration
     def initialize(configuration_hash = {})

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Publisher
     module ConfigurationReader

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Publisher
     module ConfigurationSupport
       def configuration
         @configuration ||= Configuration.new
       end
-      alias_method :config, :configuration
+      alias config configuration
 
       def configure(configuration_hash = {})
         if block_given?

data/lib/dispatch-rider/publisher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/hash/indifferent_access"
 require_relative "publisher/configuration_support"
 
@@ -78,13 +80,12 @@ module DispatchRider
       end
 
       def services_and_channels_map(destinations)
-        destinations.reduce({}) do |result, destination|
+        destinations.each_with_object({}) do |destination, result|
           if result.has_key?(destination.service)
             result[destination.service] << destination.channel
           else
             result[destination.service] = [destination.channel]
           end
-          result
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module QueueServices
     class AwsSqs < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module QueueServices
     class AwsSqs < Base
@@ -14,10 +16,10 @@ module DispatchRider
         # 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)
-          item.visibility_timeout = timeout
-          if timeout > 0
-            @total_timeout = timeout + (Time.now - start_time).to_i
-          end
+          item.change_visibility({
+            visibility_timeout: timeout # required
+          })
+          @total_timeout = timeout + (Time.now - start_time).to_i if timeout > 0
         end
 
         # We effectively return the item to the queue by setting

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

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+
 # This queue service is based on aws sqs.
 # To make this queue service work, one would need the aws sqs gem to be installed.
 module DispatchRider
@@ -21,8 +25,6 @@ module DispatchRider
         else
           raise RecordInvalid.new(self, ["Either name or url have to be specified"])
         end
-      rescue NameError
-        raise AdapterNotFoundError.new(self.class.name, 'aws-sdk')
       end
 
       def pop
@@ -32,6 +34,7 @@ module DispatchRider
 
           visibility_timeout_shield(obj) do
             raise AbortExecution, "false received from handler" unless yield(obj)
+
             obj
           end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is the base class that provides the template for all queue services.
 # The child classes must implement the following methods to become a concrete class :
 # assign_storage, insert, raw_head, construct_message_from, delete and size.
@@ -27,12 +29,11 @@ module DispatchRider
         raise NotImplementedError
       end
 
-      
       #If you pass a block into pop it will wrap the deletion of the message with it's handling
-      def pop(&block)
+      def pop
         received = head
         if received
-          block.call(received) && delete(received.item)
+          yield(received) && delete(received.item)
           received
         end
       end
@@ -41,7 +42,7 @@ module DispatchRider
         raw_item = raw_head
         raw_item && received_message_for(raw_item)
       end
-      
+
       def received_message_for(raw_item)
          QueueServices::ReceivedMessage.new(construct_message_from(raw_item), raw_item)
       end

data/lib/dispatch-rider/queue_services/file_system/fs_received_message.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module QueueServices
     class FileSystem < Base
       class FsReceivedMessage < ReceivedMessage
         attr_reader :queue
-        
+
         def initialize(message, item, queue)
           @queue = queue
           super(message, item)
         end
-        
+
         def extend_timeout(timeout)
           #file system doesn't support timeouts on items, so we ignore this.
         end
-        
+
         def return_to_queue
           queue.put_back(item)
         end

data/lib/dispatch-rider/queue_services/file_system/queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is a queue implementation for the queue service based on file systems
 module DispatchRider
   module QueueServices
@@ -10,13 +12,14 @@ module DispatchRider
 
         def add(item)
           name_base = "#{@path}/#{Time.now.to_f}"
-          File.open("#{name_base}.inprogress", "w"){ |f| f.write(item) }
+          File.write("#{name_base}.inprogress", item)
           FileUtils.mv("#{name_base}.inprogress", "#{name_base}.ready")
         end
 
         def pop
           file_path = next_item(10)
           return nil unless file_path
+
           file_path_inflight = file_path.gsub(/\.ready$/, '.inflight')
           FileUtils.mv(file_path, file_path_inflight)
           File.new(file_path_inflight)
@@ -32,9 +35,7 @@ module DispatchRider
           File.unlink(item.path)
         end
 
-        def size
-          file_paths.size
-        end
+        delegate :size, to: :file_paths
 
         private