sinatra-pubsub 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex MacCaw
+
+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,29 @@
+# Sinatra::Pubsub
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-pubsub'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-pubsub
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/examples/app.rb

@@ -0,0 +1,26 @@
+require 'sinatra'
+require 'sinatra/pubsub'
+
+register Sinatra::PubSub
+
+EventMachine.next_tick do
+  EventMachine::PeriodicTimer.new(1) do
+    Sinatra::PubSub.publish_all(type: 'tick')
+  end
+end
+
+get '/' do
+  erb :stream
+end
+
+__END__
+
+@@ stream
+<pre id="log">
+</pre>
+
+<script>
+  // reading
+  var es = new EventSource('/subscribe');
+  es.onmessage = function(e) { log.innerHTML += "\n" + e.data };
+</script>

data/examples/config.ru

@@ -0,0 +1,3 @@
+require File.expand_path('../app', __FILE__)
+
+run Sinatra::Application

data/examples/events.module.coffee

@@ -0,0 +1,60 @@
+Events =
+  on: (event, callback) ->
+    if typeof event isnt 'string'
+      throw new Error('event required')
+
+    if typeof callback isnt 'function'
+      throw new Error('callback required')
+
+    events = event.split(' ')
+    calls  = @hasOwnProperty('events') and @events or= {}
+
+    for name in events
+      calls[name] or= []
+      calls[name].push(callback)
+    this
+
+  isOn: (event, callback) ->
+    list = @hasOwnProperty('events') and @events?[event]
+    list and callback in list
+
+  one: (event, callback) ->
+    if typeof callback isnt 'function'
+      throw new Error('callback required')
+
+    callee = ->
+      @off(event, callee)
+      callback.apply(this, arguments)
+    @on(event, callee)
+
+  trigger: (args...) ->
+    event = args.shift()
+
+    list = @hasOwnProperty('events') and @events?[event]
+    return unless list
+
+    for callback in list
+      if callback.apply(this, args) is false
+        break
+    true
+
+  off: (event, callback) ->
+    unless event
+      @events = {}
+      return this
+
+    list = @events?[event]
+    return this unless list
+
+    unless callback
+      delete @events[event]
+      return this
+
+    for cb, i in list when cb is callback
+      list = list.slice()
+      list.splice(i, 1)
+      @events[event] = list
+      break
+    this
+
+module.exports = Events

data/examples/stream.module.coffee

@@ -0,0 +1,45 @@
+Events = require('events')
+
+class Stream
+  @::[k] = v for k,v of Events
+
+  @open: -> @get()
+
+  @get: ->
+    @stream or= new this
+
+  logPrefix: '[stream]'
+
+  constructor: (@url = @url) ->
+    @source = new EventSource(@url)
+    @source.addEventListener('open',  @open, false)
+    @source.addEventListener('error', @error, false)
+    @source.addEventListener('message', @message, false)
+    @source.addEventListener('setup', @setup, false)
+
+  open: =>
+    @log 'open'
+
+  error: (e) =>
+    @log 'error', e
+
+  message: (e) =>
+    msg = JSON.parse(e.data)
+
+    if msg.options?.except is @id
+      return @log('ignored', msg.type)
+    else
+      @log('message', msg.type, msg.data)
+
+    @trigger('message', msg)
+    @trigger(msg.type, msg.data)
+
+  setup: (e) =>
+    @id = e.data
+    @log('setup', @id)
+    @trigger('setup', @id)
+
+  log: (args...) =>
+    console?.log?(@logPrefix, args...)
+
+module.exports = Stream

data/lib/sinatra/pubsub.rb

@@ -0,0 +1,18 @@
+require 'sinatra/pubsub/version'
+
+module Sinatra
+  module PubSub
+    autoload :Stream, 'sinatra/pubsub/stream'
+    autoload :Redis, 'sinatra/pubsub/redis'
+    autoload :App, 'sinatra/pubsub/app'
+    autoload :Helpers, 'sinatra/pubsub/helpers'
+
+    extend Helpers
+
+    def self.registered(app)
+      app.use App
+      app.helpers Helpers
+      subscribe
+    end
+  end
+end

data/lib/sinatra/pubsub/app.rb

@@ -0,0 +1,20 @@
+module Sinatra
+  module PubSub
+    class App < Sinatra::Base
+      get '/subscribe/?:channel?', :provides => 'text/event-stream' do
+        error 402 unless Stream.enabled?
+
+        stream :keep_open do |out|
+          stream = Stream.new(out)
+
+          if params[:channel]
+            stream.subscribe(params[:channel])
+          end
+
+          out.callback { stream.close! }
+          out.errback {  stream.close! }
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/pubsub/helpers.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Sinatra
+  module PubSub
+    module Helpers extend self
+      def publish(channel, message)
+        Redis.publish(channel, message.to_json)
+      end
+
+      def publish_all(message)
+        publish(:all, message)
+      end
+
+      def subscribe
+        Thread.abort_on_exception = true
+
+        trap('TERM') do
+          Stream.disable!
+          Process.kill('INT', $$)
+        end
+
+        Thread.new do
+          Redis.subscribe
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/pubsub/redis.rb

@@ -0,0 +1,28 @@
+require 'redis'
+
+module Sinatra
+  module PubSub
+    module Redis extend self
+      def subscribe
+        redis = ::Redis.connect
+
+        redis.psubscribe('pubsub', 'pubsub.*') do |on|
+          on.pmessage do |match, channel, message|
+            channel = channel.sub(/\Apubsub\.?/, '')
+            channel = channel.empty? ? :all : channel.to_sym
+            Stream.publish(channel, message)
+          end
+        end
+      end
+
+      def publish(channel, message)
+        redis = ::Redis.connect
+        redis.publish("pubsub.#{channel}", message)
+      end
+
+      def publish_all(message)
+        publish(:all, message)
+      end
+    end
+  end
+end

data/lib/sinatra/pubsub/stream.rb

@@ -0,0 +1,91 @@
+module Sinatra
+  module PubSub
+    class Stream
+      def self.streams
+        @streams ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      def self.enabled?
+        unless defined? @enabled
+          @enabled = true
+        end
+        @enabled
+      end
+
+      def self.disable!
+        @enabled = false
+        streams.values.flatten.each(&:close!)
+      end
+
+      def self.publish(channel, message, options = {})
+        streams = self.streams[channel.to_s]
+
+        if except_id = options[:except]
+          streams = streams.reject {|s| s.id == except_id }
+        end
+
+        streams.each {|c| c.publish(:message, message) }
+      end
+
+      def self.publish_all(message, options = {})
+        publish(:all, message, options)
+      end
+
+      attr_reader :out, :id
+
+      def initialize(out)
+        @id       = SecureRandom.uuid
+        @out      = out
+
+        subscribe :all
+
+        @timer = EventMachine::PeriodicTimer.new(
+          20, method(:keepalive)
+        )
+
+        setup
+      end
+
+      def subscribe(channel)
+        self.class.streams[channel.to_s] << self
+      end
+
+      def close!
+        @timer.cancel
+
+        self.class.streams.each do |channel, streams|
+          streams.delete(self)
+        end
+      end
+
+      def publish(event, message)
+        self << "event: #{event}\n"
+        self << "data: #{message}\n\n"
+      end
+
+      protected
+
+      def <<(data)
+        return close! if out.closed?
+        out << data
+      end
+
+      # Only keep streams alive for so long
+      def keepalive_timeout?
+        @keepalive_count ||= 0
+        @keepalive_count += 1
+        @keepalive_count > 10
+      end
+
+      def keepalive
+        return close! if keepalive_timeout?
+        publish(:keepalive, '')
+      end
+
+      def setup
+        publish(:setup, id)
+        self << "retry: 5000\n"
+      end
+    end
+  end
+end

data/lib/sinatra/pubsub/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module PubSub
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-pubsub.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/pubsub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-pubsub"
+  spec.version       = Sinatra::PubSub::VERSION
+  spec.authors       = ["Alex MacCaw"]
+  spec.email         = ["alex@alexmaccaw.com"]
+  spec.description   = %q{Server Sent Events for Sinatra}
+  spec.summary       = %q{Sinatra PubSub}
+  spec.homepage      = "http://github.com/maccman/sinatra-pubsub"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "thin"
+
+  spec.add_dependency "sinatra", "~> 1.4.3"
+  spec.add_dependency "redis", "~> 3.0.4"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-pubsub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex MacCaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+description: Server Sent Events for Sinatra
+email:
+- alex@alexmaccaw.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/app.rb
+- examples/config.ru
+- examples/events.module.coffee
+- examples/stream.module.coffee
+- lib/sinatra/pubsub.rb
+- lib/sinatra/pubsub/app.rb
+- lib/sinatra/pubsub/helpers.rb
+- lib/sinatra/pubsub/redis.rb
+- lib/sinatra/pubsub/stream.rb
+- lib/sinatra/pubsub/version.rb
+- sinatra-pubsub.gemspec
+homepage: http://github.com/maccman/sinatra-pubsub
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4486996886234436829
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4486996886234436829
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Sinatra PubSub
+test_files: []