shoryuken 2.0.11 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9859d893c7542fbdac0224f68e55a8b49f0fd984
-  data.tar.gz: d3e5419d74c6766c95c4b8ad20333bdced3cfd57
+  metadata.gz: 2708ff803215783c123f043eb85cd5ee2581dc63
+  data.tar.gz: ac1a9753af6e5b482624c37cfe8f3df6af27ae06
 SHA512:
-  metadata.gz: cb5725e4def20f4c82a785db1c8a055ba59892979608ce95855888bfbd321c5310f491284a2d6ef319e7bc1b3c1f186d91e376cc6b35faef600c26d4fa453325
-  data.tar.gz: 15274a15cd3dc7f067d4ae54a40921b90b703e09e2002ed32049ce41f6dd1261629de3b3fa842656d574455f01b13e4558536997c93d4f5ebd05880f1c80b9e2
+  metadata.gz: 8f5e83670ab44a2eb84010d1187fcd2dfa699cf6d8ad944ff1e03a36574bd5f3508169799799ee03eec0b00c4e075e664d17334542e842ca5e7d9a46e09a2a81
+  data.tar.gz: 613cec158423dde7e53518a25d02a1418a4e7fc0b4e73b94fe70b9450f03e01364986bc5df5f347a782d2d2034dd3a800eece93bd806246fd59df81158c185c0

data/.codeclimate.yml

@@ -0,0 +1,23 @@
+---
+engines:
+  brakeman:
+    enabled: true
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+# exclude_paths:
+# - "**/vendor/**/*"
+# - "*/spec/**/*"

data/.travis.yml

@@ -1,13 +1,8 @@
 language: ruby
 rvm:
-  # - 1.9.3
-  # - 1.9.2
   - 2.0.0
   - 2.1.0
   - 2.2.0
-  # - ruby-head
-  # - jruby-19mode
-  # - jruby-head
 
 notifications:
   email:
@@ -17,3 +12,5 @@ notifications:
 script: SPEC_ALL=true bundle exec rspec spec
 before_install:
  - gem update bundler
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [v2.0.11] - 2016-07-02
+
+- Same as 2.0.10. Unfortunately 2.0.10 was removed `yanked` by mistake from RubyGems.
+ - [#b255bc3] https://github.com/phstc/shoryuken/commit/b255bc3
+
 ## [v2.0.10] - 2016-06-09
 
 - Fix manager #225

data/Gemfile

@@ -5,5 +5,6 @@ gemspec
 
 group :test do
   gem 'codeclimate-test-reporter', require: nil
+  gem 'simplecov'
   gem 'multi_xml'
 end

data/Rakefile

@@ -10,7 +10,7 @@ end
 desc 'Open Shoryuken pry console'
 task :console do
   require 'pry'
-  require 'celluloid'
+  require 'celluloid/current'
   require 'shoryuken'
 
   config_file = File.join File.expand_path('..', __FILE__), 'shoryuken.yml'

data/examples/default_worker.rb

@@ -4,17 +4,6 @@ class DefaultWorker
   shoryuken_options queue: 'default', auto_delete: true
 
   def perform(sqs_msg, body)
-    puts "DefaultWorker: '#{body}'"
-  end
-end
-
-# multiple workers for the same queue
-class DefaultWorker2
-  include Shoryuken::Worker
-
-  shoryuken_options queue: 'default', auto_delete: true
-
-  def perform(sqs_msg, body)
-    puts "DefaultWorker2: '#{body}'"
+    Shoryuken.logger.info("Received message: '#{body}'")
   end
 end

data/lib/shoryuken.rb

@@ -6,6 +6,7 @@ require 'shoryuken/version'
 require 'shoryuken/core_ext'
 require 'shoryuken/util'
 require 'shoryuken/logging'
+require 'shoryuken/aws_config'
 require 'shoryuken/environment_loader'
 require 'shoryuken/queue'
 require 'shoryuken/message'
@@ -72,6 +73,12 @@ module Shoryuken
       @@active_job_queue_name_prefixing = prefixing
     end
 
+    ##
+    # Configuration for Shoryuken server, use like:
+    #
+    #   Shoryuken.configure_server do |config|
+    #     config.aws = { :sqs_endpoint => '...', :access_key_id: '...', :secret_access_key: '...', region: '...' }
+    #   end
     def configure_server
       yield self if server?
     end
@@ -82,8 +89,14 @@ module Shoryuken
       @server_chain
     end
 
+    ##
+    # Configuration for Shoryuken client, use like:
+    #
+    #   Shoryuken.configure_client do |config|
+    #     config.aws = { :sqs_endpoint => '...', :access_key_id: '...', :secret_access_key: '...', region: '...' }
+    #   end
     def configure_client
-      yield self
+      yield self unless server?
     end
 
     def client_middleware
@@ -118,6 +131,10 @@ module Shoryuken
       @stop_callback = block
     end
 
+    def aws=(hash)
+      Shoryuken::AwsConfig.setup(hash)
+    end
+
     # Register a block to run at a point in the Shoryuken lifecycle.
     # :startup, :quiet or :shutdown are valid events.
     #

data/lib/shoryuken/aws_config.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module Shoryuken
+  class AwsConfig
+    class << self
+      attr_writer :options
+
+      def options
+        @options ||= {}
+      end
+
+      def setup(hash)
+        # aws-sdk tries to load the credentials from the ENV variables: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
+        # when not explicit supplied
+        return if hash.empty?
+
+        self.options = hash
+
+        shoryuken_keys = %w(
+          account_id
+          sns_endpoint
+          sqs_endpoint
+          receive_message
+        ).map(&:to_sym)
+
+        @aws_options = hash.reject do |k, _|
+          shoryuken_keys.include?(k)
+        end
+
+        # assume credentials based authentication
+        credentials = Aws::Credentials.new(
+          @aws_options.delete(:access_key_id),
+          @aws_options.delete(:secret_access_key)
+        )
+
+        # but only if the configuration options have valid values
+        @aws_options.merge!(credentials: credentials) if credentials.set?
+
+        if (callback = Shoryuken.aws_initialization_callback)
+          Shoryuken.logger.info { 'Calling Shoryuken.on_aws_initialization block' }
+          callback.call(@aws_options)
+        end
+      end
+
+      def sns
+        Aws::SNS::Client.new(aws_client_options(:sns_endpoint))
+      end
+
+      def sqs
+        Aws::SQS::Client.new(aws_client_options(:sqs_endpoint))
+      end
+
+      private
+
+      def aws_client_options(service_endpoint_key)
+        environment_endpoint = ENV["AWS_#{service_endpoint_key.to_s.upcase}"]
+        explicit_endpoint = options[service_endpoint_key] || environment_endpoint
+        endpoint = {}.tap do |hash|
+          hash[:endpoint] = explicit_endpoint unless explicit_endpoint.to_s.empty?
+        end
+        @aws_options.to_h.merge(endpoint)
+      end
+    end
+  end
+end

data/lib/shoryuken/cli.rb

@@ -31,10 +31,15 @@ module Shoryuken
 
       options = parse_cli_args(args)
 
-      daemonize(options)
-      write_pid(options)
+      loader = EnvironmentLoader.setup_options(options)
 
-      EnvironmentLoader.load(options)
+      # When cli args exist, override options in config file
+      Shoryuken.options.merge!(options)
+
+      daemonize(Shoryuken.options)
+      write_pid(Shoryuken.options)
+
+      loader.load
 
       load_celluloid
 
@@ -64,7 +69,7 @@ module Shoryuken
     private
 
     def load_celluloid
-      require 'celluloid/autostart'
+      require 'celluloid/current'
       Celluloid.logger = (Shoryuken.options[:verbose] ? Shoryuken.logger : nil)
 
       require 'shoryuken/manager'

data/lib/shoryuken/client.rb

@@ -9,7 +9,7 @@ module Shoryuken
       end
 
       def sns
-        @sns ||= Aws::SNS::Client.new(aws_client_options(:sns_endpoint))
+        @sns ||= Shoryuken::AwsConfig.sns
       end
 
       def sns_arn
@@ -17,7 +17,7 @@ module Shoryuken
       end
 
       def sqs
-        @sqs ||= Aws::SQS::Client.new(aws_client_options(:sqs_endpoint))
+        @sqs ||= Shoryuken::AwsConfig.sqs
       end
 
       def topics(name)
@@ -26,16 +26,6 @@ module Shoryuken
 
       attr_accessor :account_id
       attr_writer :sns, :sqs, :sqs_resource, :sns_arn
-
-      private
-
-      def aws_client_options(service_endpoint_key)
-        environment_endpoint = ENV["AWS_#{service_endpoint_key.to_s.upcase}"]
-        explicit_endpoint = Shoryuken.options[:aws][service_endpoint_key] || environment_endpoint
-        options = {}
-        options[:endpoint] = explicit_endpoint unless explicit_endpoint.to_s.empty?
-        options
-      end
     end
   end
 end

data/lib/shoryuken/environment_loader.rb

@@ -2,23 +2,29 @@ module Shoryuken
   class EnvironmentLoader
     attr_reader :options
 
-    def self.load(options)
-      new(options).load
+    def self.setup_options(options)
+      instance = new(options)
+      instance.setup_options
+      instance
     end
 
     def self.load_for_rails_console
-      load(config_file: (Rails.root + 'config' + 'shoryuken.yml'))
+      instance = setup_options(config_file: (Rails.root + 'config' + 'shoryuken.yml'))
+      instance.load
     end
 
     def initialize(options)
       @options = options
     end
 
-    def load
-      load_rails if options[:rails]
+    def setup_options
       initialize_options
       initialize_logger
       merge_cli_defined_queues
+    end
+
+    def load
+      load_rails if options[:rails]
       prefix_active_job_queue_names
       parse_queues
       require_workers
@@ -43,35 +49,12 @@ module Shoryuken
       YAML.load(ERB.new(IO.read(path)).result).deep_symbolize_keys
     end
 
+    # DEPRECATED: Please use configure_server and configure_client in
+    # https://github.com/phstc/shoryuken/blob/a81637d577b36c5cf245882733ea91a335b6602f/lib/shoryuken.rb#L82
+    # Please delete this method afert next release (v2.0.12 or later)
     def initialize_aws
-      # aws-sdk tries to load the credentials from the ENV variables: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
-      # when not explicit supplied
-      return if Shoryuken.options[:aws].empty?
-
-      shoryuken_keys = %w(
-        account_id
-        sns_endpoint
-        sqs_endpoint
-        receive_message).map(&:to_sym)
-
-      aws_options = Shoryuken.options[:aws].reject do |k, v|
-        shoryuken_keys.include?(k)
-      end
-
-      # assume credentials based authentication
-      credentials = Aws::Credentials.new(
-        aws_options.delete(:access_key_id),
-        aws_options.delete(:secret_access_key))
-
-      # but only if the configuration options have valid values
-      aws_options = aws_options.merge(credentials: credentials) if credentials.set?
-
-      if (callback = Shoryuken.aws_initialization_callback)
-        Shoryuken.logger.info { 'Calling Shoryuken.on_aws_initialization block' }
-        callback.call(aws_options)
-      end
-
-      Aws.config = aws_options
+      Shoryuken.logger.warn { "[DEPRECATION] aws in shoryuken.yml is deprecated. Please use configure_server and configure_client in your initializer"} unless Shoryuken.options[:aws].nil?
+      Shoryuken::AwsConfig.setup(Shoryuken.options[:aws])
     end
 
     def initialize_logger
@@ -153,7 +136,15 @@ module Shoryuken
     end
 
     def require_workers
-      require Shoryuken.options[:require] if Shoryuken.options[:require]
+      required = Shoryuken.options[:require]
+
+      return unless required
+
+      if File.directory?(required)
+        Dir[File.join(required, '**', '*.rb')].each(&method(:require))
+      else
+        require required
+      end
     end
 
     def validate_queues

data/lib/shoryuken/fetcher.rb

@@ -13,7 +13,7 @@ module Shoryuken
       # AWS limits the batch size by 10
       limit = limit > FETCH_LIMIT ? FETCH_LIMIT : limit
 
-      options = (Shoryuken.options[:aws][:receive_message] || {}).dup
+      options = (Shoryuken::AwsConfig.options[:receive_message] || {}).dup
       options[:max_number_of_messages] = limit
       options[:message_attribute_names] = %w(All)
       options[:attribute_names] = %w(All)
@@ -32,7 +32,7 @@ module Shoryuken
           limit = batch ? FETCH_LIMIT : available_processors
 
           if (sqs_msgs = Array(receive_messages(queue, limit))).any?
-            logger.info { "Found #{sqs_msgs.size} messages for '#{queue}'" }
+            logger.debug { "Found #{sqs_msgs.size} messages for '#{queue}'" }
 
             if batch
               @manager.async.assign(queue, patch_sqs_msgs!(sqs_msgs))

data/lib/shoryuken/launcher.rb

@@ -36,7 +36,7 @@ module Shoryuken
 
     def actor_died(actor, reason)
       return if @done
-      logger.warn { 'Shoryuken died due to the following error, cannot recover, process exiting' }
+      logger.warn { "Shoryuken died due to the following error, cannot recover, process exiting: #{reason}" }
       exit 1
     end
   end

data/lib/shoryuken/manager.rb

@@ -77,7 +77,7 @@ module Shoryuken
 
     def processor_died(processor, reason)
       watchdog("Manager#processor_died died") do
-        logger.error { "Process died, reason: #{reason}" unless reason.to_s.empty? }
+        logger.error { "Process died, reason: #{reason}" }
 
         @threads.delete(processor.object_id)
         @busy.delete processor
@@ -134,8 +134,7 @@ module Shoryuken
       if @ready.empty?
         logger.debug { 'Pausing fetcher, because all processors are busy' }
 
-        after(1) { dispatch }
-
+        dispatch_later
         return
       end
 
@@ -154,6 +153,13 @@ module Shoryuken
 
     private
 
+    def dispatch_later
+      @_dispatch_timer ||= after(1) do
+        @_dispatch_timer = nil
+        dispatch
+      end
+    end
+
     def build_processor
       processor = Processor.new_link(current_actor)
       processor.proxy_id = processor.object_id
@@ -196,7 +202,7 @@ module Shoryuken
       # get/remove the first queue in the list
       queue = @queues.shift
 
-      unless defined?(::ActiveJob) ||  !Shoryuken.worker_registry.workers(queue).empty?
+      unless defined?(::ActiveJob) || !Shoryuken.worker_registry.workers(queue).empty?
         # when no worker registered pause the queue to avoid endless recursion
         logger.debug { "Pausing '#{queue}' for #{Shoryuken.options[:delay].to_f} seconds, because no workers registered" }
 

data/lib/shoryuken/middleware/server/auto_extend_visibility.rb

@@ -1,4 +1,4 @@
-require 'celluloid' unless defined?(Celluloid)
+require 'celluloid/current' unless defined?(Celluloid)
 
 module Shoryuken
   module Middleware
@@ -7,11 +7,14 @@ module Shoryuken
         EXTEND_UPFRONT_SECONDS = 5
 
         def call(worker, queue, sqs_msg, body)
-          timer = auto_visibility_timer(queue, sqs_msg, worker.class)
+          timer = auto_visibility_timer(worker, queue, sqs_msg, body)
           begin
             yield
           ensure
-            timer.cancel if timer
+            if timer
+              timer.cancel
+              @visibility_extender.terminate
+            end
           end
         end
 
@@ -21,31 +24,32 @@ module Shoryuken
           include Celluloid
           include Util
 
-          def auto_extend(queue, sqs_msg, worker_class)
+          def auto_extend(worker, queue, sqs_msg, body)
             queue_visibility_timeout = Shoryuken::Client.queues(queue).visibility_timeout
 
             every(queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do
               begin
                 logger.debug do
-                  "Extending message #{worker_name(worker_class, sqs_msg)}/#{queue}/#{sqs_msg.message_id}  " \
-                               "visibility timeout by #{queue_visibility_timeout}s."
+                  "Extending message #{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id} " \
+                  "visibility timeout by #{queue_visibility_timeout}s."
                 end
 
                 sqs_msg.change_visibility(visibility_timeout: queue_visibility_timeout)
               rescue => e
                 logger.error do
-                  "Could not auto extend the message #{worker_class}/#{queue}/#{sqs_msg.message_id} " \
-                               "visibility timeout. Error: #{e.message}"
+                  'Could not auto extend the message ' \
+                  "#{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id} " \
+                  "visibility timeout. Error: #{e.message}"
                 end
               end
             end
           end
         end
 
-        def auto_visibility_timer(queue, sqs_msg, worker_class)
-          return unless worker_class.auto_visibility_timeout?
-          @visibility_extender ||= MessageVisibilityExtender.new_link
-          @visibility_extender.auto_extend(queue, sqs_msg, worker_class)
+        def auto_visibility_timer(worker, queue, sqs_msg, body)
+          return unless worker.class.auto_visibility_timeout?
+          @visibility_extender = MessageVisibilityExtender.new_link
+          @visibility_extender.auto_extend(worker, queue, sqs_msg, body)
         end
       end
     end

data/lib/shoryuken/middleware/server/exponential_backoff_retry.rb

@@ -20,9 +20,7 @@ module Shoryuken
         private
 
         def handle_failure(sqs_msg, started_at, retry_intervals)
-          attempts = sqs_msg.attributes['ApproximateReceiveCount']
-
-          return unless attempts
+          return unless attempts = sqs_msg.attributes['ApproximateReceiveCount']
 
           attempts = attempts.to_i - 1
 

data/lib/shoryuken/queue.rb

@@ -1,22 +1,21 @@
 module Shoryuken
   class Queue
+    FIFO_ATTR               = 'FifoQueue'
+    MESSAGE_GROUP_ID        = 'ShoryukenMessage'
+    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'
+
     attr_accessor :name, :client, :url
 
     def initialize(client, name)
       self.name   = name
       self.client = client
-      begin
-        self.url = client.get_queue_url(queue_name: name).queue_url
-      rescue Aws::SQS::Errors::NonExistentQueue => e
-        raise e, "The specified queue '#{name}' does not exist"
-      end
+      self.url    = client.get_queue_url(queue_name: name).queue_url
+    rescue Aws::SQS::Errors::NonExistentQueue => e
+      raise e, "The specified queue '#{name}' does not exist."
     end
 
     def visibility_timeout
-      client.get_queue_attributes(
-        queue_url: url,
-        attribute_names: ['VisibilityTimeout']
-      ).attributes['VisibilityTimeout'].to_i
+      queue_attributes.attributes[VISIBILITY_TIMEOUT_ATTR].to_i
     end
 
     def delete_messages(options)
@@ -41,49 +40,50 @@ module Shoryuken
         map { |m| Message.new(client, self, m) }
     end
 
+    def fifo?
+      @_fifo ||= queue_attributes.attributes[FIFO_ATTR] == 'true'
+    end
+
     private
 
+    def queue_attributes
+      # Note: Retrieving all queue attributes as requesting `FifoQueue` on non-FIFO queue raises error.
+      # See issue: https://github.com/aws/aws-sdk-ruby/issues/1350
+      client.get_queue_attributes(queue_url: url, attribute_names: ['All'])
+    end
+
     def sanitize_messages!(options)
-      options = case
-                when options.is_a?(Array)
-                  { entries: options.map.with_index do |m, index|
-                    { id: index.to_s }.merge(m.is_a?(Hash) ? m : { message_body: m })
-                  end }
-                when options.is_a?(Hash)
-                  options
-                end
+      if options.is_a?(Array)
+        entries = options.map.with_index do |m, index|
+          { id: index.to_s }.merge(m.is_a?(Hash) ? m : { message_body: m })
+        end
 
-      validate_messages!(options)
+        options = { entries: entries }
+      end
+
+      options[:entries].each(&method(:sanitize_message!))
 
       options
     end
 
-    def sanitize_message!(options)
-      options = case
-                when options.is_a?(String)
-                  # send_message('message')
-                  { message_body: options }
-                when options.is_a?(Hash)
-                  options
-                end
+    def add_fifo_attributes!(options)
+      return unless fifo?
 
-      validate_message!(options)
+      options[:message_group_id]         ||= MESSAGE_GROUP_ID
+      options[:message_deduplication_id] ||= Digest::SHA256.hexdigest(options[:message_body].to_s)
 
       options
     end
 
-    def validate_messages!(options)
-      options[:entries].map { |m| validate_message!(m) }
-    end
+    def sanitize_message!(options)
+      options = { message_body: options } if options.is_a?(String)
 
-    def validate_message!(options)
-      body = options[:message_body]
-      if body.is_a?(Hash)
+      if (body = options[:message_body]).is_a?(Hash)
         options[:message_body] = JSON.dump(body)
-      elsif !body.is_a?(String)
-        fail ArgumentError, "The message body must be a String and you passed a #{body.class}"
       end
 
+      add_fifo_attributes!(options)
+
       options
     end
   end

data/lib/shoryuken/util.rb

@@ -42,7 +42,9 @@ module Shoryuken
           && !sqs_msg.is_a?(Array) \
           && sqs_msg.message_attributes \
           && sqs_msg.message_attributes['shoryuken_class'] \
-          && sqs_msg.message_attributes['shoryuken_class'][:string_value] == ActiveJob::QueueAdapters::ShoryukenAdapter::JobWrapper.to_s
+          && sqs_msg.message_attributes['shoryuken_class'][:string_value] \
+          == ActiveJob::QueueAdapters::ShoryukenAdapter::JobWrapper.to_s \
+          && body
 
         "ActiveJob/#{body['job_class']}"
       else

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '2.0.11'
+  VERSION = '2.1.0'
 end

data/spec/shoryuken/cli_spec.rb

@@ -5,7 +5,7 @@ require 'shoryuken/launcher'
 RSpec.describe Shoryuken::CLI do
   let(:cli) { Shoryuken::CLI.instance }
 
-  before(:each) do
+  before do
     # make sure we do not bail
     allow(cli).to receive(:exit)
 
@@ -32,7 +32,7 @@ RSpec.describe Shoryuken::CLI do
       cli.run(['--daemon', '--logfile', '/dev/null'])
     end
 
-    it 'does NOT daemonize with --daemon --logfile' do
+    it 'does NOT daemonize with --logfile' do
       expect(Process).to_not receive(:daemon)
       cli.run(['--logfile', '/dev/null'])
     end

data/spec/shoryuken/client_spec.rb

@@ -26,6 +26,7 @@ describe Shoryuken::Client do
       ENV['AWS_SNS_ENDPOINT'] = sns_endpoint
       ENV['AWS_REGION'] = 'us-east-1'
       Shoryuken.options[:aws] = {}
+      Shoryuken::AwsConfig.options = {}
     end
 
     it 'will use config file settings if set' do
@@ -57,6 +58,7 @@ describe Shoryuken::Client do
 
   def load_config_file_by_file_name(file_name)
     path_name = file_name ? File.join(File.expand_path('../../..', __FILE__), 'spec', file_name) : nil
-    Shoryuken::EnvironmentLoader.load(config_file: path_name)
+    loader = Shoryuken::EnvironmentLoader.setup_options(config_file: path_name)
+    loader.load
   end
 end

data/spec/shoryuken/queue_spec.rb

@@ -2,13 +2,21 @@ require 'spec_helper'
 
 describe Shoryuken::Queue do
   let(:credentials) { Aws::Credentials.new('access_key_id', 'secret_access_key') }
-  let(:sqs)         { Aws::SQS::Client.new(stub_responses: true, credentials: credentials) }
-  let(:queue_name)  { 'shoryuken' }
-  let(:queue_url)   { 'https://eu-west-1.amazonaws.com:6059/123456789012/shoryuken' }
+  let(:sqs) { Aws::SQS::Client.new(stub_responses: true, credentials: credentials) }
+  let(:queue_name) { 'shoryuken' }
+  let(:queue_url) { 'https://eu-west-1.amazonaws.com:6059/123456789012/shoryuken' }
 
   subject { described_class.new(sqs, queue_name) }
+  before {
+    # Required as Aws::SQS::Client.get_queue_url returns 'String' when responses are stubbed,
+    # which is not accepted by Aws::SQS::Client.get_queue_attributes for :queue_name parameter.
+    allow(subject).to receive(:url).and_return(queue_url)
+  }
 
   describe '#send_message' do
+    before {
+      allow(subject).to receive(:fifo?).and_return(false)
+    }
     it 'accepts SQS request parameters' do
       # https://docs.aws.amazon.com/sdkforruby/api/Aws/SQS/Client.html#send_message-instance_method
       expect(sqs).to receive(:send_message).with(hash_including(message_body: 'msg1'))
@@ -22,95 +30,134 @@ describe Shoryuken::Queue do
       subject.send_message('msg1')
     end
 
-    context 'when body is invalid' do
-      it 'raises ArgumentError for nil' do
-        expect {
-          subject.send_message(message_body: nil)
-        }.to raise_error(ArgumentError, 'The message body must be a String and you passed a NilClass')
-      end
-
-      it 'raises ArgumentError for Fixnum' do
-        expect {
-          subject.send_message(message_body: 1)
-        }.to raise_error(ArgumentError, 'The message body must be a String and you passed a Fixnum')
-      end
+    context 'when a client middleware' do
+      class MyClientMiddleware
+        def call(options)
+          options[:message_body] = 'changed'
 
-      context 'when a client middleware' do
-        class MyClientMiddleware
-          def call(options)
-            options[:message_body] = 'changed'
-
-            yield
-          end
+          yield
         end
+      end
 
-        before do
-          Shoryuken.configure_client do |config|
-            config.client_middleware do |chain|
-              chain.add MyClientMiddleware
-            end
+      before do
+        allow(Shoryuken).to receive(:server?).and_return(false)
+        Shoryuken.configure_client do |config|
+          config.client_middleware do |chain|
+            chain.add MyClientMiddleware
           end
         end
+      end
 
-        after do
-          Shoryuken.configure_client do |config|
-            config.client_middleware do |chain|
-              chain.remove MyClientMiddleware
-            end
+      after do
+        Shoryuken.configure_client do |config|
+          config.client_middleware do |chain|
+            chain.remove MyClientMiddleware
           end
         end
+      end
 
-        it 'invokes MyClientMiddleware' do
-          expect(sqs).to receive(:send_message).with(hash_including(message_body: 'changed'))
+      it 'invokes MyClientMiddleware' do
+        expect(sqs).to receive(:send_message).with(hash_including(message_body: 'changed'))
 
-          subject.send_message(message_body: 'original')
-        end
+        subject.send_message(message_body: 'original')
       end
     end
   end
 
   describe '#send_messages' do
+    before {
+      allow(subject).to receive(:fifo?).and_return(false)
+    }
     it 'accepts SQS request parameters' do
       # https://docs.aws.amazon.com/sdkforruby/api/Aws/SQS/Client.html#send_message_batch-instance_method
-      expect(sqs).to receive(:send_message_batch).with(hash_including(entries: [{ id: '0', message_body: 'msg1'}, { id: '1', message_body: 'msg2' }]))
+      expect(sqs).to receive(:send_message_batch).with(hash_including(entries: [{id: '0', message_body: 'msg1'}, {id: '1', message_body: 'msg2'}]))
 
-      subject.send_messages(entries: [{ id: '0', message_body: 'msg1'}, { id: '1', message_body: 'msg2' }])
+      subject.send_messages(entries: [{id: '0', message_body: 'msg1'}, {id: '1', message_body: 'msg2'}])
     end
 
     it 'accepts an array of messages' do
-      expect(sqs).to receive(:send_message_batch).with(hash_including(entries: [{ id: '0', message_body: 'msg1', delay_seconds: 1, message_attributes: { attr: 'attr1' } }, { id: '1', message_body: 'msg2', delay_seconds: 1, message_attributes: { attr: 'attr2' } }]))
-
-      subject.send_messages([
-        {
-          message_body: 'msg1',
-          delay_seconds: 1,
-          message_attributes: { attr: 'attr1' }
-        }, {
-          message_body: 'msg2',
-          delay_seconds: 1,
-          message_attributes: { attr: 'attr2' }
-        }
-      ])
+      options = { entries: [{ id: '0',
+                              message_body: 'msg1',
+                              delay_seconds: 1,
+                              message_attributes: { attr: 'attr1' } },
+                            { id: '1',
+                              message_body: 'msg2',
+                              delay_seconds: 1,
+                              message_attributes: { attr: 'attr2' } }] }
+
+      expect(sqs).to receive(:send_message_batch).with(hash_including(options))
+
+      subject.send_messages([{ message_body:       'msg1',
+                               delay_seconds:      1,
+                               message_attributes: { attr: 'attr1' }
+                             }, {
+                               message_body:       'msg2',
+                               delay_seconds:      1,
+                               message_attributes: { attr: 'attr2' }
+                             }])
+    end
+
+    context 'when FIFO' do
+      before do
+        allow(subject).to receive(:fifo?).and_return(true)
+      end
+
+      context 'and message_group_id and message_deduplication_id are absent' do
+        it 'sets default values' do
+          expect(sqs).to receive(:send_message_batch) do |arg|
+            first_entry = arg[:entries].first
+
+            expect(first_entry[:message_group_id]).to eq described_class::MESSAGE_GROUP_ID
+            expect(first_entry[:message_deduplication_id]).to be
+          end
+
+          subject.send_messages([{ message_body: 'msg1', message_attributes: { attr: 'attr1' } }])
+        end
+      end
+
+      context 'and message_group_id and message_deduplication_id are present' do
+        it 'preserves existing values' do
+          expect(sqs).to receive(:send_message_batch) do |arg|
+            first_entry = arg[:entries].first
+
+            expect(first_entry[:message_group_id]).to eq 'my group'
+            expect(first_entry[:message_deduplication_id]).to eq 'my id'
+          end
+
+          subject.send_messages([{ message_body: 'msg1',
+                                   message_attributes: { attr: 'attr1' },
+                                   message_group_id: 'my group',
+                                   message_deduplication_id: 'my id' }])
+        end
+      end
     end
 
     it 'accepts an array of string' do
-      expect(sqs).to receive(:send_message_batch).with(hash_including(entries: [{ id: '0', message_body: 'msg1'}, { id: '1', message_body: 'msg2' }]))
+      expect(sqs).to receive(:send_message_batch).with(hash_including(entries: [{ id: '0', message_body: 'msg1' }, { id: '1', message_body: 'msg2' }]))
 
       subject.send_messages(%w(msg1 msg2))
     end
+  end
+
+  describe '#fifo?' do
+    before do
+      attribute_response = double 'Aws::SQS::Types::GetQueueAttributesResponse'
+
+      allow(attribute_response).to receive(:attributes).and_return('FifoQueue' => fifo.to_s, 'ContentBasedDeduplication' => 'true')
+      allow(subject).to receive(:url).and_return(queue_url)
+      allow(sqs).to receive(:get_queue_attributes).with(queue_url: queue_url, attribute_names: ['All']).and_return(attribute_response)
+    end
 
-    context 'when body is invalid' do
-      it 'raises ArgumentError for nil' do
-        expect {
-          subject.send_messages(entries: [message_body: nil])
-        }.to raise_error(ArgumentError, 'The message body must be a String and you passed a NilClass')
-      end
+    context 'when queue is FIFO' do
+      let(:fifo) { true }
 
-      it 'raises ArgumentError for Fixnum' do
-        expect {
-          subject.send_messages(entries: [message_body: 1])
-        }.to raise_error(ArgumentError, 'The message body must be a String and you passed a Fixnum')
-      end
+      it { expect(subject.fifo?).to be }
+    end
+
+    context 'when queue is not FIFO' do
+      let(:fifo) { false }
+
+      it { expect(subject.fifo?).to_not be }
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'pry-byebug'
-require 'celluloid'
+require 'celluloid/current'
 require 'shoryuken'
 require 'json'
 require 'multi_xml'
@@ -10,13 +10,13 @@ require 'dotenv'
 Dotenv.load
 
 if ENV['CODECLIMATE_REPO_TOKEN']
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
+  require 'simplecov'
+  SimpleCov.start
 end
 
 config_file = File.join(File.expand_path('../..', __FILE__), 'spec', 'shoryuken.yml')
 
-Shoryuken::EnvironmentLoader.load(config_file: config_file)
+Shoryuken::EnvironmentLoader.setup_options(config_file: config_file)
 
 Shoryuken.logger.level = Logger::UNKNOWN
 Celluloid.logger.level = Logger::UNKNOWN
@@ -57,6 +57,9 @@ RSpec.configure do |config|
     Shoryuken.options[:concurrency] = 1
     Shoryuken.options[:delay]       = 1
     Shoryuken.options[:timeout]     = 1
+    Shoryuken.options[:daemon]      = nil
+    Shoryuken.options[:logfile]     = nil
+
     Shoryuken.options[:aws].delete(:receive_message)
 
     TestWorker.get_shoryuken_options.clear

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shoryuken
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.1.0
 platform: ruby
 authors:
 - Pablo Cantero
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,20 +132,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/shoryuken
 - examples/bootstrap_queues.rb
 - examples/default_worker.rb
 - lib/shoryuken.rb
+- lib/shoryuken/aws_config.rb
 - lib/shoryuken/cli.rb
 - lib/shoryuken/client.rb
 - lib/shoryuken/core_ext.rb

data/.hound.yml

@@ -1,6 +0,0 @@
-ruby:
-  enabled: true
-  config_file: .rubocop.yml
-
-java_script:
-  enabled: true