wisper-sidekiq 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f0b35c819932228defa3d245462af3130c68e0b1
-  data.tar.gz: d2e23253a221af849da6457a0c94f6611c48556c
+SHA256:
+  metadata.gz: d4a87b1984ea51dd3c4dbe8dbc50938a440512819d96c0c4b374cf1a83bfe2b9
+  data.tar.gz: 63f801ae2bb5cf886d0e42ccad8b48e1932087fbd04d3c15e0ca0642b8860855
 SHA512:
-  metadata.gz: 9bff0b75ae7ee15e2596c3efc27ac386b7ac5ac62590cf70c24d465d0717ab7cbdcbcfb344763114fc534ed904228ba3fcc73538d592ee40a3c0c377cc0f6626
-  data.tar.gz: 32c654e236dc7ee0c00808ab258c0885f22e9eb99a45db7ae72b230160f96325b5674f3604ed0a722cc6952d9bb8d0a0abcd7760629d946f07305093d9fdcd1e
+  metadata.gz: 5127870825c7c90e0f73c68d109a4aa5948915d71294d3a53e2ceb9f7b31e6aba0b26b416a079404614f506e5220591690fafd29592fe656b2aced565f52d7d9
+  data.tar.gz: 1b9096f56361e21c2afc69dee9a30a1bab88ca43a49aefe410bbcd2a70c57538131e822126e3944e15fe2299264aee5bb330ca5d4b37d85643ea56534598d988

data/.gitignore

@@ -1,3 +1,4 @@
+*.log
 *.gem
 *.rbc
 .bundle
@@ -20,3 +21,6 @@ tmp
 *.o
 *.a
 mkmf.log
+.ruby-version
+.ruby-gemset
+.idea

data/.travis.yml

@@ -1,10 +1,16 @@
 language: ruby
-script: rspec spec
+sudo: false
+cache: bundler
+script: bundle exec rspec
 bundler_args: --without=extras
-rvm:
-  - '2.0.0'
-  - '2.1.2'
-  - jruby
-  - rbx-2
+before_script:
+  - bundle exec sidekiq -r ./spec/dummy_app/app.rb -L /tmp/sidekiq.log &
+  - sleep 1
 services:
   - redis-server
+rvm:
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - jruby-9.1.17.0

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [Unreleased]
+
+## [1.1.0] - 28/Sept/2018
+
+- fixes: `NoMethodError: undefined method `set' for
+  Wisper::SidekiqBroadcaster::Worker:Class` when using Sidekiq 2.x and 3.x.
+
+## [1.0.0] - 28/Sept/2018
+
+### Added
+- sidekiq 5 compatibility (closes [#11](https://github.com/krisleech/wisper-sidekiq/issues/11))
+- support for optional `sidekiq_options` per subscriber class (closes [#15](https://github.com/krisleech/wisper-sidekiq/issues/15))
+
+## [0.0.1] - 06-10-2014
+
+### Added
+- Initial release

data/Gemfile

@@ -7,7 +7,9 @@ gem 'rake'
 gem 'rspec'
 gem 'coveralls', require: false
 
+gem 'psych', platforms: :rbx
+
 group :extras do
   gem 'rerun'
-  gem 'pry'
+  gem 'pry-byebug'
 end

data/README.md

@@ -23,6 +23,15 @@ publisher.subscribe(MyListener, async: true)
 The listener must be a class (or module), not an object. This is because Sidekiq
 can not reconstruct the state of an object. However a class is easily reconstructed.
 
+Additionally, you should also ensure that your methods used to handle events under `MyListener` are all declared as class methods:
+
+```ruby
+class MyListener
+  def self.event_name
+  end
+end
+```
+
 When publshing 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.
@@ -30,6 +39,24 @@ use its id instead.
 See the [Sidekiq best practices](https://github.com/mperham/sidekiq/wiki/Best-Practices)
 for more information.
 
+### Passing down sidekiq options
+
+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.
+
+## Compatibility
+
+The same Ruby versions as Sidekiq are offically supported, but it should work
+with any 2.x syntax Ruby including JRuby and Rubinius.
+
+See the [build status](https://travis-ci.org/krisleech/wisper-sidekiq) for details.
+
+## Running Specs
+
+```
+scripts/sidekiq
+bundle exec rspec
+```
+
 ## Contributing
 
 To run sidekiq use `scripts/sidekiq`. This wraps sidekiq in [rerun](https://github.com/alexch/rerun) 

data/lib/wisper/sidekiq.rb

@@ -1,12 +1,22 @@
+require 'yaml'
 require 'wisper'
 require 'sidekiq'
-
 require 'wisper/sidekiq/version'
 
 module Wisper
+
+  # based on Sidekiq 4.x #delay method, which is not enabled by default in Sidekiq 5.x
+  # https://github.com/mperham/sidekiq/blob/4.x/lib/sidekiq/extensions/generic_proxy.rb
+  # https://github.com/mperham/sidekiq/blob/4.x/lib/sidekiq/extensions/class_methods.rb
+
   class SidekiqBroadcaster
-    def broadcast(subscriber, publisher, event, args)
-      subscriber.delay.public_send(event, *args)
+    class Worker
+      include ::Sidekiq::Worker
+
+      def perform(yml)
+        (subscriber, event, args) = ::YAML.load(yml)
+        subscriber.public_send(event, *args)
+      end
     end
 
     def self.register
@@ -15,6 +25,17 @@ module Wisper
         config.broadcaster :async,   SidekiqBroadcaster.new
       end
     end
+
+    def broadcast(subscriber, publisher, event, args)
+      options = sidekiq_options(subscriber)
+      Worker.set(options).perform_async(::YAML.dump([subscriber, event, args]))
+    end
+
+    private
+
+    def sidekiq_options(subscriber)
+      subscriber.respond_to?(:sidekiq_options) ? subscriber.sidekiq_options : {}
+    end
   end
 end
 

data/lib/wisper/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Wisper
   module Sidekiq
-    VERSION = "0.0.1"
+    VERSION = "1.1.0"
   end
 end

data/scripts/sidekiq

@@ -2,4 +2,4 @@
 
 set -e
 
-bundle exec rerun --dir spec/dummy_app/ -- bundle exec sidekiq -r ./spec/dummy_app/app.rb
+bundle exec rerun --dir spec/dummy_app/ -- bundle exec sidekiq -r ./spec/dummy_app/app.rb -L ./spec/dummy_app/logs/sidekiq.log

data/spec/dummy_app/app.rb

@@ -1,3 +1,4 @@
 # This is loaded by Sidekiq
 
+require 'wisper/sidekiq'
 require_relative 'subscriber'

data/spec/dummy_app/subscriber.rb

@@ -2,6 +2,7 @@ class Subscriber
   def self.it_happened(message)
     File.open('/tmp/shared', 'w') do |file|
       file.puts "pid: #{Process.pid}"
+      file.puts message.inspect
     end
   end
 end

data/spec/integration_spec.rb

@@ -9,12 +9,22 @@ RSpec.describe 'integration tests:' do
       include Wisper::Publisher
 
       def run
-        broadcast(:it_happened, 'hello, world')
+        broadcast(:it_happened, { hello: 'world' })
       end
     end.new
   end
+  let(:shared_content) { File.read('/tmp/shared') }
+
+  def ensure_sidekiq_was_running
+    Timeout.timeout(10) do
+      while !File.exist?('/tmp/shared')
+        sleep(0.1)
+      end
+    end
+  end
 
   before do
+    Sidekiq::Testing.disable!
     Sidekiq::Queue.new.clear
     Sidekiq::RetrySet.new.clear
     File.delete('/tmp/shared') if File.exist?('/tmp/shared')
@@ -22,16 +32,17 @@ RSpec.describe 'integration tests:' do
 
   it 'performs event in a different process' do
     publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
-
     publisher.run
+    ensure_sidekiq_was_running
 
-    Timeout.timeout(10) do
-      while !File.exist?('/tmp/shared')
-        sleep(0.1)
-      end
-    end
+    expect(shared_content).not_to include("pid: #{Process.pid}\n")
+  end
+
+  it 'performs event' do
+    publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
+    publisher.run
+    ensure_sidekiq_was_running
 
-    shared_content = File.read('/tmp/shared')
-    expect(shared_content).not_to eq "pid: #{Process.pid}\n"
+    expect(shared_content).to include('{:hello=>"world"}')
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,15 @@
 require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+require 'pry' unless ENV['CI']
+require 'sidekiq/testing'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+
+SimpleCov.start { add_filter 'spec/dummy_app' }
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  YAML::ENGINE.yamler = 'psych'
+end
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -21,7 +31,7 @@ RSpec.configure do |config|
     config.default_formatter = 'doc'
   end
 
-  config.profile_examples = 10
+  config.profile_examples = 0
 
   config.order = :random
 

data/spec/wisper/sidekiq_broadcaster_spec.rb

@@ -0,0 +1,60 @@
+require 'wisper/sidekiq'
+
+RSpec.describe Wisper::SidekiqBroadcaster do
+  class PublisherUnderTest
+    include Wisper::Publisher
+
+    def run
+      broadcast(:it_happened)
+    end
+  end
+
+  class RegularSubscriberUnderTest
+    def self.it_happened(*_)
+    end
+  end
+
+  class CustomizedSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_options
+      { queue: "my_queue" }
+    end
+  end
+
+  let(:publisher) { PublisherUnderTest.new }
+
+  before { Sidekiq::Testing.fake! }
+  after { Sidekiq::Testing.disable! }
+
+  describe '#broadcast' do
+    it 'schedules a sidekiq job' do
+      publisher.subscribe(RegularSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["default"], :size).by(1)
+    end
+
+    it 'can respect custom sidekiq_options' do
+      publisher.subscribe(CustomizedSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["my_queue"], :size).by(1)
+    end
+
+    context 'when provides subscriber with args' do
+      let(:subscriber) { RegularSubscriberUnderTest }
+      let(:event) { 'it_happened' }
+      let(:args) { [1,2,3] }
+
+      subject(:broadcast_event) { described_class.new.broadcast(subscriber, nil, event, args) }
+
+      it 'subscriber receives event with corrects args' do
+        expect(RegularSubscriberUnderTest).to receive(event).with(*args)
+
+        Sidekiq::Testing.inline! { broadcast_event }
+      end
+    end
+  end
+end

data/wisper-sidekiq.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'wisper'
-  spec.add_dependency 'sidekiq'
+  spec.add_dependency 'sidekiq', '~>4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wisper-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -28,16 +28,16 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 description: Async publishing for Wisper using Sidekiq
 email:
 - kris.leech@gmail.com
@@ -48,6 +48,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,9 +58,11 @@ files:
 - scripts/sidekiq
 - spec/configuration_spec.rb
 - spec/dummy_app/app.rb
+- spec/dummy_app/logs/.gitkeep
 - spec/dummy_app/subscriber.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
+- spec/wisper/sidekiq_broadcaster_spec.rb
 - wisper-sidekiq.gemspec
 homepage: https://github.com/krisleech/wisper-sidekiq
 licenses:
@@ -81,13 +84,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Async publishing for Wisper using Sidekiq
 test_files:
 - spec/configuration_spec.rb
 - spec/dummy_app/app.rb
+- spec/dummy_app/logs/.gitkeep
 - spec/dummy_app/subscriber.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
+- spec/wisper/sidekiq_broadcaster_spec.rb