shoryuken 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9bd900d75c3f095c8097f8e11bba2f062c12645
-  data.tar.gz: 8ee013cdcd282b9feb0561c489cf6650f52d7724
+  metadata.gz: f62098d7fa2041d2ae1cfd8a4cfedd0e09766bbb
+  data.tar.gz: 38445deab5aeb3a08310d105264338d64e5d835d
 SHA512:
-  metadata.gz: 9aa41d1fd13eaa44fad88398309b6e27c09b672ed8a0d37a1f2860610378ebe68088e31badf7764f7599d444418ad5695138ac073f77a78dd41eab47ac48a36c
-  data.tar.gz: a84b8c0ce92cf30e794e8dfd5de5648f3446d256bb2a74f48718d74bc7bdea359140c704f83440b3837281d56da4cb40b664ae9d6e5347a4560a721015457995
+  metadata.gz: 7ac1f46247119f055a0ed55494d7e39f687520197790458effdb8b23323cf9cb8d54ba64ce5107e8e53285522c7083dc90298afc2b202589945b80c51d5c1835
+  data.tar.gz: 6c2997f79ad3822134fa0a2f5be6563e3b382ac17134a7afcdaf812c78719f56f657c430ee7b3b4880f0ca9022f3e17514f9e7e1a835a71283e65fa169e6d36d

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [v2.0.2] - 2015-10-22
+
+- Fix warnings that are triggered in some cases with the raise_error matcher
+ - [#144](https://github.com/phstc/shoryuken/pull/144)
+
+- Add lifecycle event registration support
+ - [#141](https://github.com/phstc/shoryuken/pull/141)
+
+- Allow passing array of messages to send_messages
+ - [#140](https://github.com/phstc/shoryuken/pull/140)
+
+- Fix Active Job queue prefixing in Rails apps
+ - [#139](https://github.com/phstc/shoryuken/pull/139)
+
+- Enable override the default queue with a :queue option
+ - [#147](https://github.com/phstc/shoryuken/pull/147)
+
 ## [v2.0.1] - 2015-10-09
 
 - Bump aws-sdk to ~> 2
@@ -13,4 +30,4 @@
 
 - README updates
   - [#122](https://github.com/phstc/shoryuken/pull/122)
-  - [#120](https://github.com/phstc/shoryuken/pull/120)
+  - [#120](https://github.com/phstc/shoryuken/pull/120)

data/lib/shoryuken.rb

@@ -26,7 +26,12 @@ module Shoryuken
     queues: [],
     aws: {},
     delay: 0,
-    timeout: 8
+    timeout: 8,
+    lifecycle_events: {
+      startup: [],
+      quiet: [],
+      shutdown: [],
+    }
   }
 
   @@queues = []
@@ -112,6 +117,20 @@ module Shoryuken
       @stop_callback = block
     end
 
+    # Register a block to run at a point in the Shoryuken lifecycle.
+    # :startup, :quiet or :shutdown are valid events.
+    #
+    #   Shoryuken.configure_server do |config|
+    #     config.on(:shutdown) do
+    #       puts "Goodbye cruel world!"
+    #     end
+    #   end
+    def on(event, &block)
+      raise ArgumentError, "Symbols only please: #{event}" unless event.is_a?(Symbol)
+      raise ArgumentError, "Invalid event name: #{event}" unless options[:lifecycle_events].key?(event)
+      options[:lifecycle_events][event] << block
+    end
+
     attr_reader :aws_initialization_callback,
                 :start_callback,
                 :stop_callback

data/lib/shoryuken/cli.rb

@@ -45,6 +45,8 @@ module Shoryuken
         callback.call
       end
 
+      fire_event(:startup)
+
       begin
         launcher.run
 
@@ -173,7 +175,7 @@ module Shoryuken
         logger.info { 'Received USR1, will soft shutdown down' }
 
         launcher.stop
-
+        fire_event(:quiet, true)
         exit 0
       when 'TTIN'
         Thread.list.each do |thread|

data/lib/shoryuken/environment_loader.rb

@@ -113,7 +113,7 @@ module Shoryuken
     end
 
     def prefix_active_job_queue_names
-      return unless @options[:rails]
+      return unless defined? ::ActiveJob
       return unless Shoryuken.active_job_queue_name_prefixing
 
       queue_name_prefix = ::ActiveJob::Base.queue_name_prefix

data/lib/shoryuken/manager.rb

@@ -37,6 +37,8 @@ module Shoryuken
           callback.call
         end
 
+        fire_event(:shutdown, true)
+
         @fetcher.terminate if @fetcher.alive?
 
         logger.info { "Shutting down #{@ready.size} quiet workers" }

data/lib/shoryuken/queue.rb

@@ -42,7 +42,9 @@ module Shoryuken
     def sanitize_messages!(options)
       options = case
                 when options.is_a?(Array)
-                  { entries: options.map.with_index { |m, index| { id: index.to_s, message_body: m } } }
+                  { 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

data/lib/shoryuken/util.rb

@@ -12,6 +12,20 @@ module Shoryuken
       Shoryuken.logger
     end
 
+    def fire_event(event, reverse = false)
+      logger.debug { "Firing '#{event}' lifecycle event" }
+      arr = Shoryuken.options[:lifecycle_events][event]
+      arr.reverse! if reverse
+      arr.each do |block|
+        begin
+          block.call
+        rescue => ex
+          logger.warn(event: event)
+          logger.warn "#{ex.class.name}: #{ex.message}"
+        end
+      end
+    end
+
     def elapsed(started_at)
       # elapsed in ms
       (Time.now - started_at) * 1000

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/lib/shoryuken/worker.rb

@@ -6,7 +6,6 @@ module Shoryuken
 
     module ClassMethods
       def perform_async(body, options = {})
-        options ||= {}
         options[:message_attributes] ||= {}
         options[:message_attributes]['shoryuken_class'] = {
           string_value: self.to_s,
@@ -15,7 +14,9 @@ module Shoryuken
 
         options[:message_body] = body
 
-        Shoryuken::Client.queues(get_shoryuken_options['queue']).send_message(options)
+        queue = options.delete(:queue) || get_shoryuken_options['queue']
+
+        Shoryuken::Client.queues(queue).send_message(options)
       end
 
       def perform_in(interval, body, options = {})

data/spec/shoryuken/middleware/server/auto_delete_spec.rb

@@ -55,8 +55,8 @@ describe Shoryuken::Middleware::Server::AutoDelete do
       expect(sqs_queue).to_not receive(:delete_messages)
 
       expect {
-        subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise }
-      }.to raise_error
+        subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise 'Error' }
+      }.to raise_error(RuntimeError, 'Error')
     end
   end
 end

data/spec/shoryuken/middleware/server/exponential_backoff_retry_spec.rb

@@ -25,7 +25,9 @@ describe Shoryuken::Middleware::Server::ExponentialBackoffRetry do
     it 'does not retry the job by default' do
       expect(sqs_msg).not_to receive(:change_visibility)
 
-      expect { subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise } }.to raise_error
+      expect {
+        subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise 'Error' }
+      }.to raise_error(RuntimeError, 'Error')
     end
 
     it 'does not retry the job if :retry_intervals is empty' do
@@ -33,7 +35,9 @@ describe Shoryuken::Middleware::Server::ExponentialBackoffRetry do
 
       expect(sqs_msg).not_to receive(:change_visibility)
 
-      expect { subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise } }.to raise_error
+      expect {
+        subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise 'Error' }
+      }.to raise_error(RuntimeError, 'Error')
     end
 
     it 'retries the job if :retry_intervals is non-empty' do

data/spec/shoryuken/middleware/server/timing_spec.rb

@@ -54,8 +54,8 @@ describe Shoryuken::Middleware::Server::Timing do
       end
 
       expect {
-        subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise }
-      }.to raise_error
+        subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) { raise 'Error' }
+      }.to raise_error(RuntimeError, 'Error')
     end
   end
 end

data/spec/shoryuken/processor_spec.rb

@@ -299,7 +299,7 @@ describe Shoryuken::Processor do
       it 'does not extend the message invisibility' do
         expect(sqs_msg).to receive(:visibility_timeout=).never
         expect_any_instance_of(TestWorker).to receive(:perform).and_raise 'worker failed'
-        expect { subject.process(queue, sqs_msg) }.to raise_error
+        expect { subject.process(queue, sqs_msg) }.to raise_error(RuntimeError, 'worker failed')
       end
     end
   end

data/spec/shoryuken/queue_spec.rb

@@ -77,6 +77,22 @@ describe Shoryuken::Queue do
       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' }
+        }
+      ])
+    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' }]))
 

data/spec/shoryuken/worker_spec.rb

@@ -79,6 +79,23 @@ describe 'Shoryuken::Worker' do
 
       TestWorker.perform_async('delayed message', delay_seconds: 60)
     end
+
+    it 'accepts an `queue` option' do
+      new_queue = 'some_different_queue'
+
+      expect(Shoryuken::Client).to receive(:queues).with(new_queue).and_return(sqs_queue)
+
+      expect(sqs_queue).to receive(:send_message).with(
+        message_attributes: {
+          'shoryuken_class' => {
+            string_value: TestWorker.to_s,
+            data_type: 'String'
+          }
+        },
+        message_body: 'delayed message')
+
+      TestWorker.perform_async('delayed message', queue: new_queue)
+    end
   end
 
   describe '.shoryuken_options' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoryuken
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler