wisper-sidekiq 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb37a450ee5d55ff37de43045cd8353fc06b7d67efe5897e64d3030b46ab7928
-  data.tar.gz: f260f1226757bb161ac085c335eebed6fc3769439cd9b5cb65cb2e3f183c8ffc
+  metadata.gz: c1c3632db962602de97c98913fb5148c6c4e6c461360663f5f06a839c9aea465
+  data.tar.gz: 10c3e25b504ca1760b62742102ac435c3407020cd02b675644e6fa3e2a08ea6f
 SHA512:
-  metadata.gz: 3fa35e0482ac3c97176af2544573667a564254c84ace2d85cd6053ec5f44c898d79d741c3665dba67c91d9d82162b8e6b70ea7c8811fc8e9ee3ba07ac40efbb1
-  data.tar.gz: 65052d9323080e139c55f481edc9e8be0647468466198260e6fd9ea71d411c59c1d266c75238e24d6985c55088aa1355367c91a878986b9939deb6cc6a501ad6
+  metadata.gz: cc4efae8cbd60c7bbbb23d3091607538e0b0208d2e7ad430d25cb232a29b6a8abef73fe7eb32ca0382aaca00d97d8ce77a5f5749a12ac10bcd8c6ff7e1ef8d2a
+  data.tar.gz: eb59410050d965537b3113289edb6c9796745c6e0b70161a756f89d6eaf734cabbf34ac2f80edf83beb45b28d0271832aa3ae94513836de4c437295ec2dd8761

data/.gitignore

@@ -23,4 +23,5 @@ tmp
 mkmf.log
 .ruby-version
 .ruby-gemset
-.idea
+.idea
+.gs

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.3.0] - 25/Nov/2019
+
+- Add the ability to pass `sidekiq_schedule_options` options in order to schedule jobs to be run in the future
+
 ## [1.2.0]
 
 - fixes: gemspec does not allow sidekiq 5.x to be used

data/Gemfile

@@ -7,6 +7,8 @@ gem 'rake'
 gem 'rspec'
 gem 'coveralls', require: false
 
+gem 'redis', '<= 4.0.3' if RUBY_VERSION < '2.3'
+
 gem 'psych', platforms: :rbx
 
 group :extras do

data/README.md

@@ -10,8 +10,16 @@ publishing using [Sidekiq](https://github.com/mperham/sidekiq).
 
 ## Installation
 
+### Sidekiq 5+
+
 ```ruby
-gem 'wisper-sidekiq'
+gem 'wisper-sidekiq', '~> 1.0'
+```
+
+### Sidekiq 4-
+
+```ruby
+gem 'wisper-sidekiq', '~> 0.0'
 ```
 
 ## Usage
@@ -32,7 +40,7 @@ class MyListener
 end
 ```
 
-When publshing events the arguments must be simple as they need to be
+When publishing events the arguments must be simple as they need to be
 serialized. For example instead of sending an `ActiveRecord` model as an argument
 use its id instead.
 
@@ -43,6 +51,40 @@ for more information.
 
 In order to define custom [sidekiq_options](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) you can add `sidekiq_options` class method in your subscriber definition - those options will be passed to Sidekiq's `set` method just before scheduling the asynchronous worker.
 
+### Passing down schedule options
+
+In order be able to schedule jobs to be run in the future following [Scheduled Jobs](https://github.com/mperham/sidekiq/wiki/Scheduled-Jobs) you can add `sidekiq_schedule_options` class method in your subscriber definition - those options will be passed to Sidekiq's `perform_in` method when the worker is called.
+
+This feature is not as powerfull as Sidekiq's API that allows you to set this on every job enqueue, in this case you're able to set this for the hole listener class like:
+```ruby
+class MyListener
+  #...
+
+  def self.sidekiq_schedule_options
+    { perform_in: 5 }
+  end
+
+  #...
+end
+```
+Or you can set this per event (method called on the listener), like so:
+```ruby
+class MyListener
+  #...
+
+  def self.sidekiq_schedule_options
+    { event_name: { perform_in: 5 } }
+  end
+
+  def self.event_name
+    #...
+  end
+
+  #...
+end
+```
+In both cases there is also available the `perform_at` option.
+
 ## Compatibility
 
 The same Ruby versions as Sidekiq are offically supported, but it should work
@@ -59,5 +101,5 @@ bundle exec rspec
 
 ## Contributing
 
-To run sidekiq use `scripts/sidekiq`. This wraps sidekiq in [rerun](https://github.com/alexch/rerun) 
+To run sidekiq use `scripts/sidekiq`. This wraps sidekiq in [rerun](https://github.com/alexch/rerun)
 which will restart sidekiq when `specs/dummy_app` changes.

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-

data/lib/wisper/sidekiq.rb

@@ -28,7 +28,12 @@ module Wisper
 
     def broadcast(subscriber, publisher, event, args)
       options = sidekiq_options(subscriber)
-      Worker.set(options).perform_async(::YAML.dump([subscriber, event, args]))
+      schedule_options = sidekiq_schedule_options(subscriber, event)
+
+      Worker.set(options).perform_in(
+        schedule_options.fetch(:delay, 0),
+        ::YAML.dump([subscriber, event, args])
+      )
     end
 
     private
@@ -36,6 +41,24 @@ module Wisper
     def sidekiq_options(subscriber)
       subscriber.respond_to?(:sidekiq_options) ? subscriber.sidekiq_options : {}
     end
+
+    def sidekiq_schedule_options(subscriber, event)
+      return {} unless subscriber.respond_to?(:sidekiq_schedule_options)
+
+      options = subscriber.sidekiq_schedule_options
+
+      if options.has_key?(event.to_sym)
+        delay_option(options[event.to_sym])
+      else
+        delay_option(options)
+      end
+    end
+
+    def delay_option(options)
+      return {} unless options.key?(:perform_in) || options.key?(:perform_at)
+
+      { delay: options[:perform_in] || options[:perform_at] }
+    end
   end
 end
 

data/lib/wisper/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Wisper
   module Sidekiq
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

data/spec/wisper/sidekiq_broadcaster_spec.rb

@@ -23,6 +23,60 @@ RSpec.describe Wisper::SidekiqBroadcaster do
     end
   end
 
+  class CustomizedScheduleInJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_in: 5 }
+    end
+  end
+
+  class CustomizedEventScheduleInJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { it_happened: { perform_in: 5 } }
+    end
+  end
+
+  class CustomizedScheduleAtJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_at: Time.now + 5 }
+    end
+  end
+
+  class CustomizedEventScheduleAtJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { it_happened: { perform_at: Time.now + 5 } }
+    end
+  end
+
+  class CustomizedBadScheduleInJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_in: 'not a number', delay: 5 }
+    end
+  end
+
+  class CustomizedBadDefaultScheduleInWithEventScheduleAtJobSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_schedule_options
+      { perform_in: 'not a number', delay: 5, it_happened: { perform_at: Time.now + 5 } }
+    end
+  end
+
   let(:publisher) { PublisherUnderTest.new }
 
   before { Sidekiq::Testing.fake! }
@@ -36,6 +90,38 @@ RSpec.describe Wisper::SidekiqBroadcaster do
         .to change(Sidekiq::Queues["default"], :size).by(1)
     end
 
+    it 'schedules to run in some time a sidekiq job' do
+      publisher.subscribe(CustomizedScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'schedules to run in some time a sidekiq job for an event' do
+      publisher.subscribe(CustomizedEventScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'schedules to run at some time a sidekiq job' do
+      publisher.subscribe(CustomizedEventScheduleAtJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
+    it 'schedules to run at some time a sidekiq job for an event' do
+      publisher.subscribe(CustomizedEventScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      # In order to look into Sidekiq::ScheduledSet we need to hit redis
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
     it 'can respect custom sidekiq_options' do
       publisher.subscribe(CustomizedSubscriberUnderTest, async: described_class.new)
 
@@ -43,6 +129,22 @@ RSpec.describe Wisper::SidekiqBroadcaster do
         .to change(Sidekiq::Queues["my_queue"], :size).by(1)
     end
 
+    it 'schedules a sidekiq job with bad sidekiq_schedule_options' do
+      publisher.subscribe(CustomizedBadScheduleInJobSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["default"], :size).by(1)
+      expect { publisher.run }
+        .not_to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }
+    end
+
+    it 'schedules a sidekiq job with bad sidekiq_schedule_options' do
+      publisher.subscribe(CustomizedBadDefaultScheduleInWithEventScheduleAtJobSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change { Sidekiq::Queues["default"].select{|job| job.key?('at')}.size }.by(1)
+    end
+
     context 'when provides subscriber with args' do
       let(:subscriber) { RegularSubscriberUnderTest }
       let(:event) { 'it_happened' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wisper-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Async publishing for Wisper using Sidekiq