broadcaster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ae6565dba10ebb367ec4454148293dd205c48cb
+  data.tar.gz: fd6102f4293dc93488a2e0a82828b01fe294e821
+SHA512:
+  metadata.gz: e6766995f6d199435b7dcb63aa0cf90d1633d89b61e7d72e3eb2d7e4f8f13ac30163800ae51e0e6db75a57cb0f0fd0204e44f82d9b06bfccb60e5c3e1aaf3ff0
+  data.tar.gz: 8e875c87c94387862f724c57f41bcf7ade8156f117e3bade30680fed816ab7c8c29c44b8ab0d1eb910d0f1bd16551eac20e8deae32d7e477cf01effd8e9aa889

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: DIwiPcMHvmwcB0uOFrsaZ3ftClakHZSCM

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+broadcaster

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.4.0
+  - jruby
+before_install:
+  - gem install bundler
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in broadcaster.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gabriel Naiman
+
+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,72 @@
+# Broadcaster
+
+[![Gem Version](https://badge.fury.io/rb/broadcaster.svg)](https://rubygems.org/gems/broadcaster)
+[![Build Status](https://travis-ci.org/gabynaiman/broadcaster.svg?branch=master)](https://travis-ci.org/gabynaiman/broadcaster)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/broadcaster/badge.svg?branch=master)](https://coveralls.io/r/gabynaiman/broadcaster?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/broadcaster.svg)](https://codeclimate.com/github/gabynaiman/broadcaster)
+[![Dependency Status](https://gemnasium.com/gabynaiman/broadcaster.svg)](https://gemnasium.com/gabynaiman/broadcaster)
+
+Broadcasting based on Redis PubSub
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'broadcaster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install broadcaster
+
+## Usage
+
+```ruby
+broadcaster = Broadcaster.new
+
+subscription_id = broadcaster.subscribe 'channel_1' do |message|
+  puts message
+end
+
+broadcaster.publish 'channel_1', 'text'
+broadcaster.publish 'channel_1', 1
+broadcaster.publish 'channel_1', key: 'value'
+
+broadcaster.unsubscribe subscription_id
+broadcaster.unsubscribe_all
+```
+
+## Global configuration
+
+```ruby
+Broadcaster.configure do |config|
+  config.logger = Logger.new '/file.log'
+  config.redis_url = 'redis://host_name:6379'
+end
+```
+
+## Options
+
+```ruby
+options = {
+  id: 'my_app',                         # Shared broadcaster for multiple processes
+  redis_url: 'redis://host_name:6379',  # Custom redis connection
+  logger: Logger.new('/file.log')       # Custom logger
+}
+
+Broadcaster.new options
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/broadcaster.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+  t.warning = false
+  t.loader = nil if ENV['TEST']
+  ENV['TEST'], ENV['LINE'] = ENV['TEST'].split(':') if ENV['TEST'] && !ENV['LINE']
+  t.options = ''
+  t.options << "--name=/#{ENV['NAME']}/ " if ENV['NAME']
+  t.options << "-l #{ENV['LINE']} " if ENV['LINE'] && ENV['TEST']
+end
+
+task :console do
+  require 'pry'
+  require 'broadcaster'
+  ARGV.clear
+  Pry.start
+end
+
+task default: :spec

data/broadcaster.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'broadcaster'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+  spec.summary       = 'Broadcasting based on Redis PubSub'
+  spec.description   = 'Broadcasting based on Redis PubSub'
+  spec.homepage      = 'https://github.com/gabynaiman/broadcaster'
+  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 'redic',        '~> 1.5'
+  spec.add_dependency 'class_config', '~> 0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-colorin', '~> 0.1'
+  spec.add_development_dependency 'minitest-line', '~> 0.6'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+
+  if RUBY_VERSION < '2'
+    spec.add_development_dependency 'term-ansicolor', '~> 1.3.0'
+    spec.add_development_dependency 'tins', '~> 1.6.0'
+    spec.add_development_dependency 'json', '~> 1.8'
+  end
+end

data/lib/broadcaster.rb

@@ -0,0 +1,88 @@
+require 'redic'
+require 'class_config'
+require 'logger'
+
+class Broadcaster
+
+  extend ClassConfig
+
+  attr_config :redis_url, 'redis://localhost:6379'
+  attr_config :logger, Logger.new(STDOUT)
+
+  attr_reader :id
+
+  def initialize(options={})
+    @id = options.fetch(:id, SecureRandom.uuid)
+    @logger = options.fetch(:logger, Broadcaster.logger)
+    @publisher = Redic.new options.fetch(:redis_url, Broadcaster.redis_url)
+    @subscriber = Redic.new options.fetch(:redis_url, Broadcaster.redis_url)
+    @subscriptions = Hash.new { |h,k| h[k] = {} }
+    @mutex = Mutex.new
+    listen
+  end
+
+  def publish(channel, message)
+    logger.debug(self.class) { "Published | #{scoped(channel)} | #{message}" }
+    publisher.call 'PUBLISH', scoped(channel), Marshal.dump(message)
+  end
+
+  def subscribe(channel, callable=nil, &block)
+    mutex.synchronize do
+      SecureRandom.uuid.tap do |subscription_id|
+        logger.debug(self.class) { "Subscribed | #{scoped(channel)} | #{subscription_id}" }
+        subscriptions[scoped(channel)][subscription_id] = callable || block
+      end
+    end
+  end
+
+  def unsubscribe(subscription_id)
+    mutex.synchronize do
+      channel, _ = subscriptions.detect { |k,v| v.key? subscription_id }
+      if channel
+        logger.debug(self.class) { "Unsubscribed | #{channel} | #{subscription_id}" }
+        block = subscriptions[channel].delete subscription_id
+        subscriptions.delete_if { |k,v| v.empty? }
+        block
+      end
+    end
+  end
+
+  def unsubscribe_all
+    mutex.synchronize do
+      logger.debug(self.class) { 'Unsubscribed all' }
+      subscriptions.clear
+    end
+  end
+
+  private
+
+  attr_reader :publisher, :subscriber, :subscriptions, :mutex, :logger
+
+  def scoped(channel)
+    "#{id}:#{channel}"
+  end
+
+  def listen
+    logger.debug(self.class) { 'Start listening' }
+    subscriber.call 'PSUBSCRIBE', scoped('*')
+
+    Thread.new do
+      loop do
+        notification = subscriber.client.read
+        channel = notification[2]
+        message = Marshal.load notification[3]
+        logger.debug(self.class) { "Broadcasting (#{subscriptions[channel].count}) | #{channel} | #{message}" }
+        mutex.synchronize do
+          subscriptions[channel].each do |subscription_id, block|
+            begin
+              block.call message
+            rescue => ex
+              logger.error(self.class) { "Failed | #{scoped(channel)} | #{subscription_id} | #{message}\n#{ex.class}: #{ex.message}\n#{ex.backtrace.join("\n")}" }
+            end
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/broadcast_spec.rb

@@ -0,0 +1,145 @@
+require 'minitest_helper'
+
+describe Broadcaster do
+
+  def wait_for(&block)
+    Timeout.timeout(3) do
+      while !block.call
+        sleep 0.001
+      end
+    end
+  end
+  
+  it 'Multiple channels' do
+    broadcaster = Broadcaster.new
+
+    received_messages = Hash.new { |h,k| h[k] = [] }
+
+    %w(channel_1 channel_2).each do |channel|
+      broadcaster.subscribe channel do |message|
+        received_messages[channel] << message
+      end
+    end
+
+    broadcaster.publish 'channel_1', 'message 1'
+    broadcaster.publish 'channel_2', 'message 2'
+    broadcaster.publish 'channel_2', 'message 3'
+    broadcaster.publish 'channel_1', 'message 4'
+
+    wait_for { received_messages.values.flatten.count == 4 }
+
+    received_messages.must_equal 'channel_1' => ['message 1', 'message 4'], 
+                                 'channel_2' => ['message 2', 'message 3']
+  end
+
+  it 'Error handling' do
+    broadcaster = Broadcaster.new
+
+    received_messages = []
+
+    broadcaster.subscribe 'channel_1' do |message|
+      received_messages << (10 / message)
+    end
+
+    broadcaster.publish 'channel_1', 5
+    broadcaster.publish 'channel_1', 0
+    broadcaster.publish 'channel_1', 2
+
+    wait_for { received_messages.count == 2 }
+
+    received_messages.must_equal [2, 5]
+  end
+
+  it 'Unsubscribe' do
+    broadcaster = Broadcaster.new
+
+    received_messages = Hash.new { |h,k| h[k] = [] }
+
+    subscriptions = 2.times.map do |i|
+      broadcaster.subscribe 'channel_1' do |message|
+        received_messages[i] << message 
+      end
+    end
+
+    broadcaster.publish 'channel_1', 'message 1'
+
+    wait_for { received_messages.values.flatten.count == 2 }
+
+    broadcaster.unsubscribe subscriptions[1]
+
+    broadcaster.publish 'channel_1', 'message 2'
+
+    wait_for { received_messages.values.flatten.count == 3 }
+
+    received_messages.must_equal 0 => ['message 1', 'message 2'],
+                                 1 => ['message 1']
+  end
+
+  it 'Unsubscribe all' do
+    broadcaster = Broadcaster.new
+
+    received_messages = []
+
+    2.times.map do
+      broadcaster.subscribe 'channel_1' do |message|
+        received_messages << message 
+      end
+    end
+
+    broadcaster.publish 'channel_1', 'message 1'
+
+    wait_for { received_messages.count == 2 }
+
+    broadcaster.unsubscribe_all
+
+    broadcaster.publish 'channel_1', 'message 2'
+
+    received_messages.must_equal ['message 1', 'message 1']
+  end
+
+  it 'Isolated' do
+    broadcasters = 2.times.map { Broadcaster.new }
+
+    received_messages = Hash.new { |h,k| h[k] = [] }
+
+    broadcasters.each_with_index do |broadcaster, index|
+      broadcaster.subscribe 'channel_1' do |message|
+        received_messages[index] << message
+      end
+    end
+
+    broadcasters[0].publish 'channel_1', 'message 1'
+    broadcasters[1].publish 'channel_1', 'message 2'
+
+    wait_for { received_messages.values.flatten.count == 2 }
+
+    received_messages.must_equal 0 => ['message 1'],
+                                 1 => ['message 2']
+  end
+
+  it 'Shared' do
+    broadcasters = 2.times.map { Broadcaster.new id: 'test' }
+
+    received_messages = Hash.new { |h,k| h[k] = [] }
+
+    broadcasters.each_with_index do |broadcaster, index|
+      broadcaster.subscribe 'channel_1' do |message|
+        received_messages[index] << message
+      end
+    end
+
+    broadcasters[0].publish 'channel_1', 'message 1'
+    broadcasters[1].publish 'channel_1', 'message 2'
+
+    wait_for { received_messages.values.flatten.count == 4 }
+
+    received_messages.must_equal 0 => ['message 1', 'message 2'],
+                                 1 => ['message 1', 'message 2']
+  end
+
+  it 'Custom redis url' do
+    error = proc { Broadcaster.new redis_url: 'redis://invalid_host:6379' }.must_raise StandardError
+    error.message.must_match 'invalid_host'
+  end
+
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.start
+
+require 'broadcaster'
+require 'minitest/autorun'
+require 'minitest/colorin'
+require 'pry-nav'
+require 'timeout'
+
+Broadcaster.configure do |config|
+  config.logger = Logger.new '/dev/null'
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: broadcaster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: class_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Broadcasting based on Redis PubSub
+email:
+- gabynaiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- broadcaster.gemspec
+- lib/broadcaster.rb
+- spec/broadcast_spec.rb
+- spec/minitest_helper.rb
+homepage: https://github.com/gabynaiman/broadcaster
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Broadcasting based on Redis PubSub
+test_files:
+- spec/broadcast_spec.rb
+- spec/minitest_helper.rb