dispatch-rider 1.9.0 → 2.0.0

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

@@ -10,24 +10,25 @@ module DispatchRider
       class VisibilityTimeoutExceeded < RuntimeError; end
 
       def assign_storage(attrs)
-        begin
-          sqs = AWS::SQS.new(logger: nil, region: attrs[:region])
-          if attrs[:name]
-            sqs.queues.named(attrs[:name])
-          elsif attrs[:url]
-            sqs.queues[attrs[:url]]
-          else
-            raise RecordInvalid.new(self, ["Either name or url have to be specified"])
-          end
-        rescue NameError
-          raise AdapterNotFoundError.new(self.class.name, 'aws-sdk')
+        sqs = Aws::SQS::Client.new(logger: nil)
+        if attrs[:name].present?
+          url = sqs.list_queues({queue_name_prefix: attrs[:name]}).queue_urls.first
+          set_visibility_timeout(sqs,url)
+          Aws::SQS::Queue.new(url: url, client: sqs)
+        elsif attrs[:url].present?
+          set_visibility_timeout(sqs,attrs[:url])
+          Aws::SQS::Queue.new(url: attrs[:url], client: sqs)
+        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
-        raw_item = queue.receive_message
+        raw_item = queue.receive_messages({max_number_of_messages: 1}).first
         if raw_item.present?
-          obj = SqsReceivedMessage.new(construct_message_from(raw_item), raw_item, queue)
+          obj = SqsReceivedMessage.new(construct_message_from(raw_item), raw_item, queue, visibility_timeout)
 
           visibility_timeout_shield(obj) do
             raise AbortExecution, "false received from handler" unless yield(obj)
@@ -56,18 +57,25 @@ module DispatchRider
         queue.approximate_number_of_messages
       end
 
+      attr_reader :visibility_timeout
+
       private
 
+      def set_visibility_timeout(client,url)
+        resp = client.get_queue_attributes(queue_url: url, attribute_names: ["VisibilityTimeout"])
+        @visibility_timeout = resp.attributes["VisibilityTimeout"]
+      end
+
       def visibility_timeout_shield(message)
-        begin
-          yield
-        ensure
-          duration = Time.now - message.start_time
-          timeout = message.total_timeout
-          raise VisibilityTimeoutExceeded, "message: #{message.subject}, #{message.body.inspect} took #{duration} seconds while the timeout was #{timeout}" if duration > timeout
+        yield
+      ensure
+        duration = Time.now - message.start_time
+        timeout = message.total_timeout
+        if duration > timeout
+          message = "message: #{message.subject}, #{message.body.inspect} took #{duration} seconds while the timeout was #{timeout}"
+          raise VisibilityTimeoutExceeded, message
         end
       end
-
     end
   end
 end

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

@@ -28,7 +28,6 @@ module DispatchRider
         def queue_name
           File.basename(File.dirname(@item.path))
         end
-
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # 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.
+# 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.
 # This is ideal to be used in development mode between multiple applications.
 module DispatchRider
   module QueueServices

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

@@ -3,7 +3,6 @@ require 'delegate'
 module DispatchRider
   module QueueServices
     class ReceivedMessage < ::SimpleDelegator
-
       #Item is the raw message item as returned by the queue implementor
       #it's contents will depend on the queue being used
       attr_reader :item
@@ -36,7 +35,6 @@ module DispatchRider
       def queue_name
         raise NotImplementedError
       end
-
     end
   end
 end

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

@@ -15,7 +15,7 @@ module DispatchRider
         store[name.to_sym] = value(name, options)
         self
       rescue NameError
-        raise NotFound.new(name)
+        raise NotFound, name
       end
 
       def value(name, options = {})
@@ -31,7 +31,7 @@ module DispatchRider
         begin
           store.fetch(name.to_sym)
         rescue IndexError
-          raise NotRegistered.new(name)
+          raise NotRegistered, name
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# This is the registrar for the AWS SNS channels.
+# This is the registrar for the Aws SNS channels.
 module DispatchRider
   module Registrars
     class SnsChannel < Base

data/lib/dispatch-rider/runner.rb

@@ -44,6 +44,5 @@ module DispatchRider
       @subscriber.register_queue(kind, info)
       @subscriber.setup_demultiplexer(kind, config.error_handler)
     end
-
   end
 end

data/lib/dispatch-rider/version.rb

@@ -1,4 +1,4 @@
 # This file specifies the current version of the gem.
 module DispatchRider
-  VERSION = '1.9.0'
+  VERSION = '2.0.0'
 end

data/lib/dispatch-rider.rb

@@ -5,6 +5,8 @@ require "active_support/hash_with_indifferent_access"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/inflector"
 require "active_support/json"
+# Local testing fails without this
+#require "active_support/isolated_execution_state"
 require "active_support/core_ext/array/conversions"
 require "active_model"
 

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

@@ -1,12 +1,10 @@
 module DispatchRider
   class InstallGenerator < ::Rails::Generators::Base
-
     source_root File.expand_path("../templates", __FILE__)
 
     def create_scripts
       copy_file "script/dispatch_rider", "script/dispatch_rider"
       chmod 'script/dispatch_rider', 0755
     end
-
   end
 end

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

@@ -1,5 +1,4 @@
 class DispatchJob < Rails::Generators::Base
-
   class Publisher < Rails::Generators::Base
     source_root File.expand_path('../templates/publisher', __FILE__)
     argument :handler_name, type: :string, required: true
@@ -56,5 +55,4 @@ class DispatchJob < Rails::Generators::Base
   hook_for :handler do |handler|
     invoke handler, [handler_name]
   end
-
 end

data/spec/factories/messages.rb

@@ -1,10 +1,11 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :message, class: 'DispatchRider::Message' do
-    subject 'sample_handler'
-    body(
-      'key' => 'value',
-      'guid' => DispatchRider::Debug::PUBLISHER_MESSAGE_GUID,
-    )
+    subject { 'sample_handler' }
+    body {
+      {
+        'key' => 'value',
+        'guid' => DispatchRider::Debug::PUBLISHER_MESSAGE_GUID,
+      }}
     initialize_with {  DispatchRider::Message.new(attributes) }
   end
 end

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

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe DispatchRider::Callbacks::Access do
   describe "#invoke" do
+    subject { described_class.new(storage) }
+
     let(:callback_a1) { proc { |x| x.call } }
     let(:callback_a2) { proc { |x| x.call } }
     let(:callback_a3) { proc { |x| x.call } }
@@ -13,8 +15,6 @@ describe DispatchRider::Callbacks::Access do
     let(:storage) { DispatchRider::Callbacks::Storage.new }
     let(:action) { proc {} }
 
-    subject { described_class.new(storage) }
-
     before do
       callbacks_a.each do |cb|
         storage.around :event1, cb

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

@@ -15,7 +15,7 @@ describe DispatchRider::Callbacks::Storage do
           log << :aafter
         end
         subject.for(:initialize).first[actual]
-        expect(log).to eq [:abefore, :actual, :aafter]
+        expect(log).to eq %i[abefore actual aafter]
       end
     end
 
@@ -23,7 +23,7 @@ describe DispatchRider::Callbacks::Storage do
       example do
         subject.before(:initialize) { log << :before }
         subject.for(:initialize).first[actual]
-        expect(log).to eq [:before, :actual]
+        expect(log).to eq %i[before actual]
       end
     end
 
@@ -31,7 +31,7 @@ describe DispatchRider::Callbacks::Storage do
       example do
         subject.after(:initialize) { log << :after }
         subject.for(:initialize).first[actual]
-        expect(log).to eq [:actual, :after]
+        expect(log).to eq %i[actual after]
       end
     end
   end

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

@@ -54,7 +54,7 @@ describe DispatchRider::Configuration do
   describe "#logger" do
 
     describe "default" do
-      example { expect(subject.logger).to be_kind_of(Logger) }
+      example { expect(subject.logger).to be_a(Logger) }
     end
 
     example { expect(subject).to respond_to(:logger) }

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

@@ -4,6 +4,7 @@ describe DispatchRider::DefaultErrorHandler do
 
   describe ".call" do
     let(:exception) { Exception.new("Something went terribly wrong") }
+
     example do
       expect {
         described_class.call("Error", exception)

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

@@ -7,6 +7,8 @@ describe DispatchRider::Demultiplexer, nodb: true do
     end
   end
 
+  subject(:demultiplexer) { DispatchRider::Demultiplexer.new(queue, dispatcher, error_handler) }
+
   let(:dispatcher) do
     dispatcher = DispatchRider::Dispatcher.new
     dispatcher.register(:test_handler)
@@ -30,8 +32,6 @@ describe DispatchRider::Demultiplexer, nodb: true do
 
   let(:error_handler) { ->(_message, exception) { raise exception } }
 
-  subject(:demultiplexer) { DispatchRider::Demultiplexer.new(queue, dispatcher, error_handler) }
-
   describe "#initialize" do
     it "should assign the queue" do
       expect(demultiplexer.queue).to be_empty

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

@@ -5,7 +5,7 @@ describe DispatchRider::NotificationServices::AwsSns do
 
   describe "#notifier_builder" do
     it "returns the notifier builder" do
-      expect(subject.notifier_builder).to eq(AWS::SNS)
+      expect(subject.notifier_builder).to eq(Aws::SNS::Client)
     end
   end
 
@@ -21,12 +21,12 @@ describe DispatchRider::NotificationServices::AwsSns do
 
     # @note: This is tested this way cause you don't really wanna post a message to the actual service.
     it "publishes the message to the channels" do
-      expect(channel).to receive(:publish).with(kind_of String) do |serialized_message|
+      expect(channel).to receive(:publish).with(kind_of Hash) do |serialized_message|
                            expected = {
                              "subject" => "test_handler",
                              "body" => { "bar" => "baz" }
                            }
-                           expect(JSON.parse(serialized_message)).to eq(expected)
+                           expect(JSON.parse(serialized_message[:message])).to eq(expected)
                          end
 
       subject.publish_to_channel(channel, message: message)

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

@@ -1,11 +1,15 @@
 require 'spec_helper'
 
 describe DispatchRider::NotificationServices::Base do
+  subject do
+    DispatchRider::NotificationServices::Base.new(topics: {})
+  end
+
   let :channel do
     channel = OpenStruct.new
     class << channel
       def publish(msg)
-        throw :published, JSON.parse(msg)["body"]["bar"]
+        throw :published, JSON.parse(msg[:message])["body"]["bar"]
       end
     end
     channel
@@ -20,10 +24,6 @@ describe DispatchRider::NotificationServices::Base do
     end
   end
 
-  subject do
-    DispatchRider::NotificationServices::Base.new(topics: {})
-  end
-
   describe "#initialize" do
     it "assigns the notifier" do
       expect(subject.notifier).to respond_to(:topics)
@@ -60,8 +60,8 @@ describe DispatchRider::NotificationServices::Base do
 
     # @note: This is tested this way cause you don't really wanna post a message to the actual service.
     it "publishes the message to the channels" do
-      expect(channel).to receive(:publish).with(kind_of String) { |serialized_message|
-                           parsed_message = JSON.parse(serialized_message)
+      expect(channel).to receive(:publish).with(kind_of Hash) { |serialized_message|
+                           parsed_message = JSON.parse(serialized_message[:message])
                            expect(parsed_message).to eq(expected_message)
                          }
 

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

@@ -1,25 +1,26 @@
 require 'spec_helper'
 
 describe DispatchRider::NotificationServices::FileSystem::Channel do
+  subject { described_class.new(path) }
+
   let(:path) { File.expand_path("tmp/test/channel") }
   let(:published_message) { File.new(Dir["#{path}/*.ready"].first).read }
 
   before { FileUtils.mkdir_p(path) }
-  after { FileUtils.rm_rf(path) }
 
-  subject { described_class.new(path) }
+  after { FileUtils.rm_rf(path) }
 
   describe "#publish" do
     let(:message) { { subject: "foo", body: "bar" }.to_json }
 
     it "adds a file to the path folder" do
       expect {
-        subject.publish(message)
+        subject.publish(message: message)
       }.to change { Dir["#{path}/*"].length }.by(1)
     end
 
     it "writes the message to the file" do
-      subject.publish(message)
+      subject.publish(message: message)
 
       expect(published_message).to eq(message)
     end

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe DispatchRider::Publisher::Base do
 
   class DummyPublisher < DispatchRider::Publisher::Base
-    destinations [:sns_message_queue, :file_system_queue]
+    destinations %i[sns_message_queue file_system_queue]
     subject "Loud Cheering"
 
     def self.publish(cheer)
@@ -38,7 +38,7 @@ describe DispatchRider::Publisher::Base do
     context "in a derived class with publish implemented" do
       let(:message) do
         {
-          destinations: [:sns_message_queue, :file_system_queue],
+          destinations: %i[sns_message_queue file_system_queue],
           message: {
             subject: "Loud Cheering",
             body: {

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

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe DispatchRider::Publisher::Configuration::Destination do
+  subject { described_class.new("employee", attributes) }
   let(:attributes) do
     {
       "service" => "aws_sns",
@@ -17,8 +18,6 @@ describe DispatchRider::Publisher::Configuration::Destination do
     }
   end
 
-  subject { described_class.new("employee", attributes) }
-
   describe "#name" do
     describe '#name' do
       subject { super().name }

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

@@ -2,14 +2,13 @@ require 'spec_helper'
 
 describe DispatchRider::Publisher::Configuration::NotificationService do
 
+  subject { described_class.new("file_system", options) }
   let(:options) do
     {
       "default_folder" => "/tmp/dispatch_rider"
     }
   end
 
-  subject { described_class.new("file_system", options) }
-
   describe "#name" do
     describe '#name' do
       subject { super().name }

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

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe DispatchRider::Publisher::Configuration do
 
+  subject { described_class.new(configuration_hash) }
+
   let(:configuration_hash) do
     {
       "notification_services" => {
@@ -31,8 +33,6 @@ describe DispatchRider::Publisher::Configuration do
     }
   end
 
-  subject { described_class.new(configuration_hash) }
-
   describe "#notification services" do
     let(:file_system) do
       DispatchRider::Publisher::Configuration::NotificationService.new(

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

@@ -45,7 +45,7 @@ describe DispatchRider::Publisher do
     it "registers a notification service" do
       subject.register_notification_service(:aws_sns)
       result = subject.notification_service_registrar.fetch(:aws_sns)
-      expect(result.notifier).to respond_to(:topics)
+      expect(result.notifier).to respond_to(:list_topics)
       expect(result.channel_registrar.store).to be_empty
     end
 
@@ -146,6 +146,7 @@ describe DispatchRider::Publisher do
         }
 
         before { DispatchRider.config.callbacks.for(:publish) << publish_callback }
+
         after { DispatchRider.config.callbacks.for(:publish).delete publish_callback }
 
         example do

data/spec/lib/dispatch-rider/queue_services/aws_sqs_spec.rb

@@ -2,25 +2,21 @@ require 'spec_helper'
 
 describe DispatchRider::QueueServices::AwsSqs do
 
-  let(:visibility_timeout) { 100 }
-
-  let(:fake_response) do
-    AWS::SQS::Client.new.stub_for(:get_queue_url).tap { |response|
-      response.data[:queue_url] = "the.queue.url"
-      response.data[:attributes] = { "VisibilityTimeout" => visibility_timeout }
-    }
+  subject(:aws_sqs_queue) do
+    DispatchRider::QueueServices::AwsSqs.new(:name => "normal_priority")
   end
 
-  before do
-    AWS.config(stub_requests: true)
-    allow_any_instance_of(AWS::SQS::Client).to receive(:client_request).and_return(fake_response)
-  end
+  let(:visibility_timeout) { 100 }
 
-  subject(:aws_sqs_queue) do
-    DispatchRider::QueueServices::AwsSqs.new(:name => "normal_priority")
+  before do
+    allow_any_instance_of(Aws::SQS::Client).to receive(:list_queues).and_return(OpenStruct.new({queue_urls:["the.queue.url"]}))
+    allow_any_instance_of(Aws::SQS::Client).to receive(:get_queue_attributes).and_return(
+      OpenStruct.new({attributes:{"VisibilityTimeout"=>visibility_timeout}})
+    )
   end
 
   describe "#assign_storage" do
+
     context "when the aws gem is installed" do
 
       context "when the name of the queue is passed in the options" do
@@ -65,20 +61,18 @@ describe DispatchRider::QueueServices::AwsSqs do
       end
 
       let(:response_message) do
-        {
-          message_id: 12345,
+        OpenStruct.new({
+          message_id: "12345",
           md5_of_body: "mmmddd555",
           body: { subject: "foo", body: { bar: "baz" } }.to_json,
           receipt_handle: "HANDLE",
           attributes: response_attributes,
-        }
+          visibility_timeout: visibility_timeout
+        })
       end
 
-      before :each do
-        response = AWS::SQS::Client.new.stub_for(:receive_message)
-        response.data[:messages] = [response_message]
-        allow_any_instance_of(AWS::SQS::Client::V20121105).to receive(:receive_message).and_return(response)
-        allow_any_instance_of(AWS::SQS::Queue).to receive(:verify_receive_message_checksum).and_return([])
+      before do
+        allow_any_instance_of(Aws::SQS::Queue).to receive(:receive_messages).and_return(OpenStruct.new({first: response_message }))
       end
 
       context "when the block runs faster than the timeout" do
@@ -95,7 +89,7 @@ describe DispatchRider::QueueServices::AwsSqs do
 
         it "should raise" do
           expect {
-            aws_sqs_queue.pop do |message|
+            aws_sqs_queue.pop do |_message|
               sleep(1.1)
             end
           }.to raise_exception(/message: foo,.+ took .+ seconds while the timeout was 1/)
@@ -106,7 +100,7 @@ describe DispatchRider::QueueServices::AwsSqs do
 
     context "when the sqs queue is empty" do
       before :each do
-        allow(aws_sqs_queue.queue).to receive(:receive_message).and_return(nil)
+        allow_any_instance_of(Aws::SQS::Queue).to receive(:receive_messages).and_return(OpenStruct.new({first: nil }))
       end
 
       it "should not yield" do
@@ -129,25 +123,21 @@ describe DispatchRider::QueueServices::AwsSqs do
     end
 
     let(:response_message) do
-      {
+      OpenStruct.new({
         message_id: 12345,
         md5_of_body: "mmmddd555",
         body: { subject: "foo", body: { bar: "baz" } }.to_json,
         receipt_handle: "HANDLE",
         attributes: response_attributes,
-      }
+        visibility_timeout: visibility_timeout
+      })
     end
 
-    before :each do
-      response = AWS::SQS::Client.new.stub_for(:receive_message)
-      response.data[:messages] = [response_message]
-      allow_any_instance_of(AWS::SQS::Client::V20121105).to receive(:receive_message).and_return(response)
-      allow_any_instance_of(AWS::SQS::Queue).to receive(:verify_receive_message_checksum).and_return([])
+    before do
+      allow_any_instance_of(Aws::SQS::Queue).to receive(:receive_messages).and_return(OpenStruct.new({first: response_message }))
     end
 
     it "should set the visibility timeout when extend is called" do
-      expect_any_instance_of(AWS::SQS::ReceivedMessage).to receive(:visibility_timeout=).with(10)
-      expect_any_instance_of(AWS::SQS::ReceivedMessage).to receive(:visibility_timeout=).with(0)
       aws_sqs_queue.pop do |message|
         message.extend_timeout(10)
         expect(message.total_timeout).to eq(10)
@@ -158,7 +148,7 @@ describe DispatchRider::QueueServices::AwsSqs do
   end
 
   describe "#construct_message_from" do
-    context "when the item is directly published to AWS::SQS" do
+    context "when the item is directly published to Aws::SQS" do
       let(:sqs_message) { OpenStruct.new(body: { 'subject' => 'foo', 'body' => 'bar' }.to_json) }
 
       it "should return a message" do
@@ -168,7 +158,7 @@ describe DispatchRider::QueueServices::AwsSqs do
       end
     end
 
-    context "when the item is published through AWS::SNS" do
+    context "when the item is published through Aws::SNS" do
       let(:sqs_message) do
         message = { 'subject' => 'foo', 'body' => 'bar' }
         body = { "Type" => "Notification", "Message" => message.to_json }.to_json

data/spec/lib/dispatch-rider/queue_services/file_system_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe DispatchRider::QueueServices::FileSystem do
-  let(:queue_path) { "tmp/queue" }
-
   subject(:file_system_queue) do
     DispatchRider::QueueServices::FileSystem.new(:path => queue_path)
   end
 
+  let(:queue_path) { "tmp/queue" }
+
   before { file_system_queue.send(:queue).send(:file_paths).each { |file| File.unlink(file) } }
 
   describe "#assign_storage" do