siftery-wisper-sidekiq 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6bf2c1b8f6afc160a2a2cf3b75a55e0b1469c9441483c5c4da6bf729f7554e9
+  data.tar.gz: 66e2a22308253a28bd0e9e6575f2f6aeaa3962dd8c9049d4dbb64c71ec907fca
+SHA512:
+  metadata.gz: 683d12a7865981d4f40d6376df6d8d7ead14d853b366724c30909a69fc3116440389c5124af825e8561905e72b7093ef56103e6cc1863e076863027a7c6601da
+  data.tar.gz: d610481429ec855fa991a01abfced5c11c03a2a5dfa6fe58d47629dcd019767e9e04e2748ae738c80e90c4e8180a6f3589262a0cc4c2f58836e8c5f080fea165

data/.gitignore

@@ -0,0 +1,25 @@
+*.log
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_script:
+  - bundle exec sidekiq -r ./spec/dummy_app/app.rb -L /tmp/sidekiq.log &
+  - sleep 1
+script: rspec spec
+bundler_args: --without=extras
+services:
+  - redis-server
+rvm:
+  - '2.4.0'
+  - jruby-9.1.6.0

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'coveralls', require: false
+
+gem 'psych', platforms: :rbx
+
+group :extras do
+  gem 'rerun'
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Leech
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Wisper::Sidekiq
+
+Provides [Wisper](https://github.com/krisleech/wisper) with asynchronous event
+publishing using [Sidekiq](https://github.com/mperham/sidekiq).
+
+[![Gem Version](https://badge.fury.io/rb/wisper-sidekiq.png)](http://badge.fury.io/rb/wisper-sidekiq)
+[![Code Climate](https://codeclimate.com/github/krisleech/wisper-sidekiq.png)](https://codeclimate.com/github/krisleech/wisper-sidekiq)
+[![Build Status](https://travis-ci.org/krisleech/wisper-sidekiq.png?branch=master)](https://travis-ci.org/krisleech/wisper-sidekiq)
+[![Coverage Status](https://coveralls.io/repos/krisleech/wisper-sidekiq/badge.png?branch=master)](https://coveralls.io/r/krisleech/wisper-sidekiq?branch=master)
+
+## Installation
+
+```ruby
+gem 'wisper-sidekiq'
+```
+
+## Usage
+
+```ruby
+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.
+
+See the [Sidekiq best practices](https://github.com/mperham/sidekiq/wiki/Best-Practices)
+for more information.
+
+## Advanced options
+
+You can also customize queue name, retry value and other sidekiq options when registering the listener like the following:
+
+```ruby
+publisher.subscribe(MyListener, async: { queue: 'custom', retry: false })
+```
+
+## 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)
+which will restart sidekiq when `specs/dummy_app` changes.

data/Rakefile

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

data/lib/wisper/sidekiq.rb

@@ -0,0 +1,27 @@
+require 'wisper'
+require 'sidekiq'
+
+require 'wisper/sidekiq/version'
+
+module Wisper
+  class SidekiqBroadcaster
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options == true ? {} : options
+    end
+
+    def broadcast(subscriber, publisher, event, args)
+      subscriber.delay(options).public_send(event, *args)
+    end
+
+    def self.register
+      Wisper.configure do |config|
+        config.broadcaster :sidekiq, Proc.new { |options| SidekiqBroadcaster.new(options) }
+        config.broadcaster :async,   Proc.new { |options| SidekiqBroadcaster.new(options) }
+      end
+    end
+  end
+end
+
+Wisper::SidekiqBroadcaster.register

data/lib/wisper/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module Sidekiq
+    VERSION = "0.0.2"
+  end
+end

data/scripts/sidekiq

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+bundle exec rerun --dir spec/dummy_app/ -- bundle exec sidekiq -r ./spec/dummy_app/app.rb -L ./spec/dummy_app/logs/sidekiq.log

data/siftery-wisper-sidekiq.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/sidekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "siftery-wisper-sidekiq"
+  spec.version       = Wisper::Sidekiq::VERSION
+  spec.authors       = ["Shubham Kumar"]
+  spec.email         = ["shubh2336@gmail.com"]
+  spec.summary       = 'Async publishing for Wisper using Sidekiq'
+  spec.description   = 'Async publishing for Wisper using Sidekiq'
+  spec.homepage      = "https://github.com/shubh2336/wisper-sidekiq"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'wisper'
+  spec.add_dependency 'sidekiq'
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,14 @@
+require 'wisper/sidekiq'
+
+RSpec.describe 'configuration' do
+  let(:configuration) { Wisper.configuration }
+
+  it 'configures sidekiq as a broadcaster' do
+    expect(configuration.broadcasters).to include :sidekiq
+  end
+
+  it 'configures sidekiq as default callable async broadcaster' do
+    expect(configuration.broadcasters[:async]).to be_an_instance_of(Proc)
+    expect(configuration.broadcasters[:async].call).to be_an_instance_of(Wisper::SidekiqBroadcaster)
+  end
+end

data/spec/dummy_app/app.rb

@@ -0,0 +1,3 @@
+# This is loaded by Sidekiq
+
+require_relative 'subscriber'

data/spec/dummy_app/subscriber.rb

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

data/spec/integration_spec.rb

@@ -0,0 +1,58 @@
+require 'wisper/sidekiq'
+
+require_relative 'dummy_app/app'
+require 'sidekiq/api'
+
+RSpec.describe 'integration tests:' do
+  let(:publisher) do
+    Class.new do
+      include Wisper::Publisher
+
+      def run
+        broadcast(:it_happened, 'hello, world')
+      end
+    end.new
+  end
+
+  before do
+    Sidekiq::Queue.new.clear
+    Sidekiq::RetrySet.new.clear
+    File.delete('/tmp/shared') if File.exist?('/tmp/shared')
+  end
+
+  context 'when broadcaster is plain object' do
+    it 'performs event in a different process' do
+      publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
+
+      publisher.run
+
+      Timeout.timeout(10) do
+        while !File.exist?('/tmp/shared')
+          sleep(0.1)
+        end
+      end
+
+      shared_content = File.read('/tmp/shared')
+      expect(shared_content).not_to eq "pid: #{Process.pid}\n"
+    end
+  end
+
+  context 'when broadcaster is async and passes options' do
+    it 'performs event in a different process' do
+      pending('Pending until wisper support for async options is published')
+
+      publisher.subscribe(Subscriber, async: { queue: 'default' })
+
+      publisher.run
+
+      Timeout.timeout(10) do
+        while !File.exist?('/tmp/shared')
+          sleep(0.1)
+        end
+      end
+
+      shared_content = File.read('/tmp/shared')
+      expect(shared_content).not_to eq "pid: #{Process.pid}\n"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'coveralls'
+require 'simplecov'
+
+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|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 0
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: siftery-wisper-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Shubham Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Async publishing for Wisper using Sidekiq
+email:
+- shubh2336@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wisper/sidekiq.rb
+- lib/wisper/sidekiq/version.rb
+- scripts/sidekiq
+- siftery-wisper-sidekiq.gemspec
+- 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
+homepage: https://github.com/shubh2336/wisper-sidekiq
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+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