rasti-web-broadcaster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5ea9872ad3ad27ea065c433a32b300353bf158f
+  data.tar.gz: c617495332f8606763045bfa2215dbb15b87af31
+SHA512:
+  metadata.gz: bb1500dd98e5a7f7bd2237778152091081460517a7fe6d9099557b9a9f16ed44703f277429e38d9eeaa3a5a6772abee95c3325710e2c21bda03a7bb8a991f3ba
+  data.tar.gz: b387a4fc765699f4cb866e2338ecdcce9ee2114d74cafae042a7b88e6ac38b865ace9ac9ec0267aa6601a6c9cc01ff416087070f9fe87c401db681ffdfbcfce2

data/.coveralls.yml

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

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+rasti-web-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 rasti-web-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,79 @@
+# Rasti::Web::Broadcaster
+
+[![Gem Version](https://badge.fury.io/rb/rasti-web-broadcaster.svg)](https://rubygems.org/gems/rasti-web-broadcaster)
+[![Build Status](https://travis-ci.org/gabynaiman/rasti-web-broadcaster.svg?branch=master)](https://travis-ci.org/gabynaiman/rasti-web-broadcaster)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/rasti-web-broadcaster/badge.svg?branch=master)](https://coveralls.io/r/gabynaiman/rasti-web-broadcaster?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/rasti-web-broadcaster.svg)](https://codeclimate.com/github/gabynaiman/rasti-web-broadcaster)
+[![Dependency Status](https://gemnasium.com/gabynaiman/rasti-web-broadcaster.svg)](https://gemnasium.com/gabynaiman/rasti-web-broadcaster)
+
+Enable server sent events with rack middleware implemented over Faye and Broadcaster (Redis Pub/Sub)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rasti-web-broadcaster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rasti-web-broadcaster
+
+## Usage
+
+### Configuration
+```ruby
+Rasti::Web::Broadcaster.configure do |config|
+  config.id = 'AppName'
+  config.redis_url = "redis://#{ENV['REDIS_HOST']}:#{ENV['REDIS_PORT']}"
+  config.logger = Logger.new "/log/#{ENV['RACK_ENV']}.log"
+end
+```
+
+### Rack middleware
+```ruby
+use Rasti::Web::Broadcaster
+```
+
+### Publishing events from the web
+```ruby
+Rasti::Web::Broadcaster.publish channel_id, data:  'hello'      # string or json
+                                            event: 'eventName', # optional
+                                            id:    1234         # optional
+```
+
+### Publishing events from external processes
+```ruby
+require 'broadcaster'
+
+broadcaster = Broadcaster.new id: 'AppName', redis_url: "redis://#{ENV['REDIS_HOST']}:#{ENV['REDIS_PORT']}"
+
+broadcaster.publish channel_id, data: 'hello'
+```
+
+### Client subscription (browser)
+```javascript
+const events = new EventSource('/channel');
+
+events.addEventListener('open', e => console.info('Started streaming')); 
+
+events.addEventListener('error', e => console.warn(e)); 
+
+events.onmessage = e => console.debug(e.data)
+
+events.addEventListener('eventName', e => console.debug(e.data));
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/rasti-web-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,24 @@
+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 default: :spec
+
+desc 'Pry console'
+task :console do
+  require 'rasti-web-broadcaster'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/lib/rasti/web/broadcaster/safe_event_machine.rb

@@ -0,0 +1,5 @@
+if RUBY_ENGINE == 'jruby'
+  EventMachine.define_singleton_method :signal_loopbreak do 
+    @em.signalLoopbreak if @em
+  end
+end

data/lib/rasti/web/broadcaster/version.rb

@@ -0,0 +1,7 @@
+module Rasti
+  module Web
+    class Broadcaster
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/rasti/web/broadcaster.rb

@@ -0,0 +1,65 @@
+require 'faye/websocket'
+require 'broadcaster'
+require 'class_config'
+
+require_relative 'broadcaster/safe_event_machine'
+require_relative 'broadcaster/version'
+
+module Rasti
+  module Web
+    class Broadcaster
+
+      extend ClassConfig
+
+      attr_config :id,        'rasti.web.broadcaster'
+      attr_config :redis_url, 'redis://localhost:6379'
+      attr_config :logger,    Logger.new(STDOUT)
+
+      class << self
+
+        extend Forwardable
+
+        def_delegators :broadcaster, :subscribe, 
+                                     :unsubscribe, 
+                                     :publish
+
+        private
+
+        def broadcaster
+          @broadcaster ||= ::Broadcaster.new configuration
+        end
+
+      end
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if Faye::EventSource.eventsource? env
+          event_source = Faye::EventSource.new env
+          channel = env['PATH_INFO'][1..-1]
+
+          subscription_id = self.class.subscribe channel do |message|
+            event_source.send message[:data], event: message[:event], 
+                                              id:    message[:id]
+          end
+
+          event_source.on :close do
+            self.class.unsubscribe subscription_id
+            event_source = nil
+          end
+
+          event_source.rack_response
+        else
+          app.call env
+        end
+      end
+
+      private
+
+      attr_reader :app
+
+    end
+  end
+end

data/lib/rasti-web-broadcaster.rb

@@ -0,0 +1 @@
+require_relative 'rasti/web/broadcaster'

data/rasti-web-broadcaster.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rasti/web/broadcaster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rasti-web-broadcaster'
+  spec.version       = Rasti::Web::Broadcaster::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+  spec.summary       = 'Rack middleware for server sent events'
+  spec.description   = 'Enable server sent events with rack middleware implemented over Faye and Broadcaster (Redis Pub/Sub)'
+  spec.homepage      = 'https://github.com/gabynaiman/rasti-web-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_runtime_dependency 'faye-websocket', '~> 0.10'
+  spec.add_runtime_dependency 'broadcaster', '~> 0.1'
+  spec.add_runtime_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'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+
+  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
+
+  if RUBY_VERSION < '2.2.2'
+    spec.add_development_dependency 'rack', '< 2'
+  end
+end

data/spec/coverage_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.start

data/spec/middleware_spec.rb

@@ -0,0 +1,79 @@
+require 'minitest_helper'
+
+describe Rasti::Web::Broadcaster do
+
+  def event_headers
+    event = []
+    event << 'HTTP/1.1 200 OK'
+    event << 'Content-Type: text/event-stream'
+    event << 'Cache-Control: no-cache, no-store'
+    event << 'Connection: close'
+    event << ''
+    event << 'retry: 5000'
+    event << ''
+    event << ''
+    event.join("\r\n")
+  end
+
+  def event_for(options)
+    event = []
+    event << "event: #{options[:event]}" if options[:event]
+    event << "id: #{options[:id]}" if options[:id]
+    event << "data: #{options[:data]}"
+    event << ''
+    event << ''
+    event.join("\r\n")
+  end
+
+  def wait_for(&block)
+    Timeout.timeout(3) do
+      while !block.call
+        sleep 0.001
+      end
+    end
+  end
+
+  let(:app) { Rasti::Web::Broadcaster.new ->(env) { [200, {}, ['hello']] } }
+
+  it 'Handle events' do
+    env = Rack::MockRequest.env_for '/channel_1', 'HTTP_ACCEPT' => 'text/event-stream',
+                                                  'HTTP_HOST'   => 'localhost'
+
+    event_source = nil
+    events = []
+    
+    env['async.callback'] = proc do |(status, headers, body)|
+      event_source = body.instance_variable_get(:@socket_object)
+      body.each { |e| events << e }
+    end
+    
+    Rasti::Web::Broadcaster.publish 'channel_1', data: 'message 0'
+
+    app.call env
+
+    Rasti::Web::Broadcaster.publish 'channel_1', data: 'message 1', event: 'event_1', id: 1
+    Rasti::Web::Broadcaster.publish 'channel_2', data: 'message 2'
+    Rasti::Web::Broadcaster.publish 'channel_1', data: 'message 3'
+
+    wait_for { events.count == 3 }
+
+    event_source.close
+
+    events.must_equal [
+      event_headers,
+      event_for(data: 'message 1', event: 'event_1', id: 1), 
+      event_for(data: 'message 3')
+    ]
+  end
+
+  it 'Ignore normal request' do
+    env = Rack::MockRequest.env_for '/resource/123'
+
+    status, headers, body = app.call env
+
+    status.must_equal 200
+    headers.must_be_empty
+    body.must_equal ['hello']
+  end
+
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,8 @@
+require 'coverage_helper'
+require 'minitest/autorun'
+require 'minitest/colorin'
+require 'pry-nav'
+require 'rasti-web-broadcaster'
+require 'rack/test'
+
+Rasti::Web::Broadcaster.logger.level = Logger::ERROR

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: rasti-web-broadcaster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: broadcaster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+description: Enable server sent events with rack middleware implemented over Faye
+  and Broadcaster (Redis Pub/Sub)
+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
+- lib/rasti-web-broadcaster.rb
+- lib/rasti/web/broadcaster.rb
+- lib/rasti/web/broadcaster/safe_event_machine.rb
+- lib/rasti/web/broadcaster/version.rb
+- rasti-web-broadcaster.gemspec
+- spec/coverage_helper.rb
+- spec/middleware_spec.rb
+- spec/minitest_helper.rb
+homepage: https://github.com/gabynaiman/rasti-web-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: Rack middleware for server sent events
+test_files:
+- spec/coverage_helper.rb
+- spec/middleware_spec.rb
+- spec/minitest_helper.rb