dispatch-rider 2.0.0 → 2.2.0

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
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is a rudementary queue service that uses file system instead of
 # Aws::SQS or SimpleQueue. It addresses SimpleQueue's inability to be used
 # by only one application instance while avoiding the cost of setting up Aws::SQS.
@@ -8,12 +10,10 @@ module DispatchRider
     require "dispatch-rider/queue_services/file_system/fs_received_message"
     class FileSystem < Base
       def assign_storage(attrs)
-        begin
           path = attrs.fetch(:path)
           Queue.new(path)
-        rescue IndexError
+      rescue IndexError
           raise RecordInvalid.new(self, ["Path can not be blank"])
-        end
       end
 
       def insert(item)
@@ -23,7 +23,7 @@ module DispatchRider
       def raw_head
         queue.pop
       end
-      
+
       def received_message_for(raw_item)
          FsReceivedMessage.new(construct_message_from(raw_item), raw_item, queue)
       end
@@ -31,18 +31,14 @@ module DispatchRider
       def construct_message_from(item)
         deserialize(item.read)
       end
-      
-      def put_back(item)
-        queue.put_back(item)
-      end
+
+      delegate :put_back, to: :queue
 
       def delete(item)
         queue.remove item
       end
 
-      def size
-        queue.size
-      end
+      delegate :size, to: :queue
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'delegate'
 
 module DispatchRider
@@ -13,7 +15,7 @@ module DispatchRider
       end
 
       def guid
-        self.body['guid']
+        body['guid']
       end
 
       def extend_timeout(time)

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This is a simple implementation of an in memory queue using an array.
 module DispatchRider
   module QueueServices
     class Simple < Base
-      def assign_storage(attrs)
+      def assign_storage(_attrs)
         []
       end
 
@@ -18,13 +20,9 @@ module DispatchRider
         deserialize(item)
       end
 
-      def delete(item)
-        queue.delete(item)
-      end
+      delegate :delete, to: :queue
 
-      def size
-        queue.size
-      end
+      delegate :size, to: :queue
     end
   end
 end

data/lib/dispatch-rider/queue_services.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is the base class for the registrars.
 #  It defines the interface that other registrars inherit.
 #  This is an abstract class.
@@ -28,11 +30,9 @@ module DispatchRider
       end
 
       def fetch(name)
-        begin
-          store.fetch(name.to_sym)
-        rescue IndexError
-          raise NotRegistered, name
-        end
+        store.fetch(name.to_sym)
+      rescue IndexError
+        raise NotRegistered, name
       end
     end
   end

data/lib/dispatch-rider/registrars/file_system_channel.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This is the registrar for FileSystem channels, basically storing paths
 
 module DispatchRider
   module Registrars
     class FileSystemChannel < Base
-      def value(name, options = {})
+      def value(_name, options = {})
         File.expand_path(options[:path])
       end
     end

data/lib/dispatch-rider/registrars/handler.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This is the registrar for the handlers.
 module DispatchRider
   module Registrars
     class Handler < Base
-      def value(name, options = {})
+      def value(name, _options = {})
         name.to_s.camelize.constantize
       end
     end

data/lib/dispatch-rider/registrars/notification_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This registrar handles the registration of various notification services.
 module DispatchRider
   module Registrars

data/lib/dispatch-rider/registrars/publishing_destination.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 module DispatchRider
   module Registrars
     class PublishingDestination < Base
-      def value(name, options = {})
+      def value(_name, options = {})
         ::OpenStruct.new(:service => options[:service], :channel => options[:channel])
       end
     end

data/lib/dispatch-rider/registrars/queue_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This si the registrar for queue services.
 module DispatchRider
   module Registrars

data/lib/dispatch-rider/registrars/sns_channel.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This is the registrar for the Aws SNS channels.
 module DispatchRider
   module Registrars
     class SnsChannel < Base
-      def value(name, options = {})
+      def value(_name, options = {})
         "arn:aws:sns:#{options[:region]}:#{options[:account]}:#{options[:topic]}"
       end
     end

data/lib/dispatch-rider/registrars.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The namespace that holds the registrars
 module DispatchRider
   module Registrars

data/lib/dispatch-rider/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class Runner
     include Callbacks::Support

data/lib/dispatch-rider/scheduled_job/migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   module ScheduledJob::Migration
     def create_scheduled_jobs_table

data/lib/dispatch-rider/scheduled_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_record"
 
 # @note: Later this could be pulled out to its own gem and included depending on what ORM the user
@@ -50,9 +52,7 @@ module DispatchRider
       destroy # once published
     end
 
-    private
-
-    delegate :publisher, to: :"self.class"
+    delegate :publisher, to: :'self.class'
   end
 end
 

data/lib/dispatch-rider/subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class takes care of the subscribing side of the messaging system.
 module DispatchRider
   class Subscriber

data/lib/dispatch-rider/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # This file specifies the current version of the gem.
 module DispatchRider
-  VERSION = '2.0.0'
+  VERSION = '2.2.0'
 end

data/lib/dispatch-rider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Top level namespace of the gem
 require "dispatch-rider/version"
 
@@ -22,7 +24,7 @@ module DispatchRider
     def configuration
       @configuration ||= Configuration.new
     end
-    alias_method :config, :configuration
+    alias config configuration
 
     def clear_configuration!
       @configuration = nil

data/lib/generators/dispatch_rider/install/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DispatchRider
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.expand_path("../templates", __FILE__)

data/lib/generators/dispatch_rider/install/templates/script/dispatch_rider

@@ -1,4 +1,5 @@
 #!env ruby
+# frozen_string_literal: true
 
 raise "this script is meant to be ran from inside of a Rails.root" unless File.exist?("config/environment.rb")
 

data/lib/generators/dispatch_rider/job/dispatch_job_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class DispatchJob < Rails::Generators::Base
   class Publisher < Rails::Generators::Base
     source_root File.expand_path('../templates/publisher', __FILE__)

data/spec/factories/messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :message, class: 'DispatchRider::Message' do
     subject { 'sample_handler' }
@@ -5,7 +7,8 @@ FactoryBot.define do
       {
         'key' => 'value',
         'guid' => DispatchRider::Debug::PUBLISHER_MESSAGE_GUID,
-      }}
+      }
+    }
     initialize_with {  DispatchRider::Message.new(attributes) }
   end
 end

data/spec/fixtures/handlers/another_test_handler.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class AnotherTestHandler < DispatchRider::Handlers::Base
 end

data/spec/fixtures/handlers/test_handler.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class TestHandler < DispatchRider::Handlers::Base
 end

data/spec/integration/logging_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe "Logging" do

data/spec/lib/dispatch-rider/airbrake_error_handler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe DispatchRider::AirbrakeErrorHandler do
@@ -12,7 +14,7 @@ describe DispatchRider::AirbrakeErrorHandler do
         controller: "DispatchRider",
         action: "TestMessage",
         parameters: { subject: "TestMessage", body: "foo" },
-        cgi_data: anything,
+        cgi_data: anything
       ]
       expect(Airbrake).to receive(:notify).with(*args)
 

data/spec/lib/dispatch-rider/callbacks/access_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Callbacks::Access do

data/spec/lib/dispatch-rider/callbacks/storage_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Callbacks::Storage do

data/spec/lib/dispatch-rider/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Configuration do
@@ -33,7 +35,7 @@ describe DispatchRider::Configuration do
   end
 
   describe "#handlers" do
-    before :each do
+    before do
       subject.handler_path = "./spec/fixtures/handlers"
     end
 

data/spec/lib/dispatch-rider/default_error_handler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe DispatchRider::DefaultErrorHandler do

data/spec/lib/dispatch-rider/demultiplexer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Demultiplexer, nodb: true do
@@ -7,7 +9,7 @@ describe DispatchRider::Demultiplexer, nodb: true do
     end
   end
 
-  subject(:demultiplexer) { DispatchRider::Demultiplexer.new(queue, dispatcher, error_handler) }
+  subject(:demultiplexer) { described_class.new(queue, dispatcher, error_handler) }
 
   let(:dispatcher) do
     dispatcher = DispatchRider::Dispatcher.new
@@ -62,7 +64,7 @@ describe DispatchRider::Demultiplexer, nodb: true do
       # THIS ALSO TESTS THAT THE JOB IS NOT RUN MULTIPLE TIMES
       # IF THIS FAILS, BE CAREFUL NOT TO INTRODUCE BUGS
       it "should call the correct handler" do
-        expect_any_instance_of(TestHandler).to receive(:process).with(message.body).at_least(1).times
+        expect_any_instance_of(TestHandler).to receive(:process).with(message.body).at_least(:once)
         demultiplexer_thread.run
         sleep 0.01 # give it a chance to process the job async before killing the demux
       end

data/spec/lib/dispatch-rider/dispatcher_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Dispatcher, :nodb => true do
@@ -30,16 +32,17 @@ describe DispatchRider::Dispatcher, :nodb => true do
       before do
         allow(DispatchRider.config).to receive(:callbacks) { storage }
         storage.around(:dispatch_message) do |block, message|
-          begin
-            dummy.before
-            dummy.log(message)
-            block.call
-          ensure
-            dummy.after
-          end
+
+          dummy.before
+          dummy.log(message)
+          block.call
+        ensure
+          dummy.after
+
         end
         subject.register('handle_something')
       end
+
       example do
         expect(dummy).to receive(:before).once
         expect(dummy).to receive(:after).once
@@ -51,7 +54,7 @@ describe DispatchRider::Dispatcher, :nodb => true do
     end
 
     context "when the handler provided in the message is present" do
-      before :each do
+      before do
         subject.register('handle_something')
       end
 
@@ -63,7 +66,7 @@ describe DispatchRider::Dispatcher, :nodb => true do
     context "when the handler returns false" do
       let(:message_subject) { "handler_that_returns_false" }
 
-      before :each do
+      before do
         subject.register('handler_that_returns_false')
       end
 

data/spec/lib/dispatch-rider/handlers/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Handlers::Base do

data/spec/lib/dispatch-rider/handlers/inheritance_tracking_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Handlers::InheritanceTracking do

data/spec/lib/dispatch-rider/logging/json_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Logging::JsonFormatter do

data/spec/lib/dispatch-rider/logging/lifecycle_logger_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Logging::LifecycleLogger, aggregrate_failures: true do
-  subject { DispatchRider::Logging::LifecycleLogger }
+  subject { described_class }
 
   let(:queue) { double :queue }
   let(:item) { double :item }

data/spec/lib/dispatch-rider/logging/text_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Logging::TextFormatter do

data/spec/lib/dispatch-rider/logging/translator_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Logging::Translator do

data/spec/lib/dispatch-rider/message_spec.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::Message do
-  subject(:message) { DispatchRider::Message.new(subject: 'test', body: 'test_handler') }
+  subject(:message) { described_class.new(subject: 'test', body: 'test_handler') }
 
   describe "#initialize" do
     context "when all the required attributes are passed" do
       context "when the attributes hash has keys as strings" do
-        subject(:message) { DispatchRider::Message.new('subject' => 'test', 'body' => 'test_handler') }
+        subject(:message) { described_class.new('subject' => 'test', 'body' => 'test_handler') }
 
         it "should initiate a new message" do
           expect(message.subject).to eq('test')
@@ -24,7 +26,7 @@ describe DispatchRider::Message do
 
     context "when all the required attributes are not passed" do
       it "should raise an exception" do
-        expect { DispatchRider::Message.new({}) }.to raise_exception(DispatchRider::RecordInvalid)
+        expect { described_class.new({}) }.to raise_exception(DispatchRider::RecordInvalid)
       end
     end
   end
@@ -46,13 +48,13 @@ describe DispatchRider::Message do
   describe "#==" do
     context "when 2 messages have the same attribute values" do
       it "should return true" do
-        expect(message).to eq(DispatchRider::Message.new(subject: 'test', body: 'test_handler'))
+        expect(message).to eq(described_class.new(subject: 'test', body: 'test_handler'))
       end
     end
 
     context "when 2 messages do not have same attribute values" do
       it "should return false" do
-        expect(message).not_to eq(DispatchRider::Message.new(subject: 'random_test', body: 'test_handler'))
+        expect(message).not_to eq(described_class.new(subject: 'random_test', body: 'test_handler'))
       end
     end
   end

data/spec/lib/dispatch-rider/notification_services/aws_sns_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DispatchRider::NotificationServices::AwsSns do