wisper-sidekiq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0b35c819932228defa3d245462af3130c68e0b1
+  data.tar.gz: d2e23253a221af849da6457a0c94f6611c48556c
+SHA512:
+  metadata.gz: 9bff0b75ae7ee15e2596c3efc27ac386b7ac5ac62590cf70c24d465d0717ab7cbdcbcfb344763114fc534ed904228ba3fcc73538d592ee40a3c0c377cc0f6626
+  data.tar.gz: 32c654e236dc7ee0c00808ab258c0885f22e9eb99a45db7ae72b230160f96325b5674f3604ed0a722cc6952d9bb8d0a0abcd7760629d946f07305093d9fdcd1e

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: rspec spec
+bundler_args: --without=extras
+rvm:
+  - '2.0.0'
+  - '2.1.2'
+  - jruby
+  - rbx-2
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'coveralls', require: false
+
+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,36 @@
+# 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.
+
+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.
+
+## 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,21 @@
+require 'wisper'
+require 'sidekiq'
+
+require 'wisper/sidekiq/version'
+
+module Wisper
+  class SidekiqBroadcaster
+    def broadcast(subscriber, publisher, event, args)
+      subscriber.delay.public_send(event, *args)
+    end
+
+    def self.register
+      Wisper.configure do |config|
+        config.broadcaster :sidekiq, SidekiqBroadcaster.new
+        config.broadcaster :async,   SidekiqBroadcaster.new
+      end
+    end
+  end
+end
+
+Wisper::SidekiqBroadcaster.register

data/lib/wisper/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module Sidekiq
+    VERSION = "0.0.1"
+  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

data/spec/configuration_spec.rb

@@ -0,0 +1,13 @@
+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 async broadcaster' do
+    expect(configuration.broadcasters[:async]).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,37 @@
+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
+
+  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

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'coveralls'
+Coveralls.wear!
+
+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 = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/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          = "wisper-sidekiq"
+  spec.version       = Wisper::Sidekiq::VERSION
+  spec.authors       = ["Kris Leech"]
+  spec.email         = ["kris.leech@gmail.com"]
+  spec.summary       = 'Async publishing for Wisper using Sidekiq'
+  spec.description   = 'Async publishing for Wisper using Sidekiq'
+  spec.homepage      = "https://github.com/krisleech/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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: wisper-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-06 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:
+- kris.leech@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
+- spec/configuration_spec.rb
+- spec/dummy_app/app.rb
+- spec/dummy_app/subscriber.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- wisper-sidekiq.gemspec
+homepage: https://github.com/krisleech/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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+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/subscriber.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb