jugglite 0.0.1.alpha

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 andruby
+
+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,40 @@
+# Jugglite
+
+Jugglite is a replacement for the incredible [Juggernaut](https://github.com/maccman/juggernaut) by Maccman. It uses [Server Sent Events](http://www.html5rocks.com/en/tutorials/eventsource/basics/) to push events from your application to the client's browser.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jugglite'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jugglite
+
+## Usage
+
+Jugglite comes with a binary. This binary runs a thin server that listens on redis for application messages and passes it along to all connected clients.
+
+You can run the binary from any terminal
+`jugglite`
+
+TODO: Foreman & multiple processes
+
+TODO: Behind nginx so the client connects on one port
+
+## 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
+
+## License
+
+Jugglite is licensed under the [MIT license](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/jugglite

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+host = ENV['HOST'] || '127.0.0.1'
+port = (ENV['PORT'] || 3000).to_i
+file_descriptors = (ENV['FD_SIZE'] || 202400).to_i
+
+require 'jugglite'
+
+new_size = EM.set_descriptor_table_size( file_descriptors )
+STDERR.puts "New descriptor-table size is #{new_size}"
+EM.epoll
+EM.kqueue
+
+STDERR.puts "Starting server at #{host}:#{port}"
+Thin::Server.start(host, port, Jugglite::App.new)

data/jugglite.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jugglite/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jugglite"
+  gem.version       = Jugglite::VERSION
+  gem.authors       = ["andruby"]
+  gem.email         = ["andrew@bedesign.be"]
+  gem.description   = %q{Lightweight SSE server}
+  gem.summary       = %q{Server Sent Events server written in rack on top of thin inspired by Juggernaut for real time push}
+  gem.homepage      = "http://github.com/andruby/jugglite"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('thin')
+  gem.add_dependency('em-hiredis')
+  gem.add_development_dependency('redis')
+  gem.add_development_dependency('rspec')
+end

data/lib/jugglite/app.rb

@@ -0,0 +1,119 @@
+require 'set'
+require 'em-hiredis'
+
+module Jugglite
+  # Let's go for plain Rack y'all
+  class App
+    AsyncResponse = [-1, {}, []].freeze
+    Headers = {'Content-Type' => 'text/event-stream;charset=utf-8'}
+
+    # Options include:
+    # +path+ : the URI path to listen to ('/stream')
+    # +keepalive_timeout+ : the timeout in seconds between keepalive comments
+    def initialize(app = nil, options = {})
+      @app = app
+      @options = {
+        path: '/stream',
+        keepalive_timeout: 20
+      }.merge(options)
+      STDERR.puts "Registered Jugglite to listen to #{@options[:path]}"
+      @subscription_map = {}
+      EventMachine::next_tick { setup_redis }
+      EventMachine::next_tick { setup_keepalive }
+    end
+
+    def call(env)
+      if @app.nil? || (env["PATH_INFO"] == @options[:path])
+        handle_stream(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+    def handle_stream(env)
+      request = Rack::Request.new(env)
+      connection = SseConnection.new(request)
+
+      # Get the headers out there, let the client know we're alive...
+      EventMachine::next_tick do
+        register_connection(connection)
+        # Calling thin's Connection.post_process([status, headers, body])
+        # This is how you start a response to the client asynchronously
+        env['async.callback'].call [200, Headers, connection.body]
+        connection.comment("registered to channels: #{channels_for_request(request).to_a.join(', ')}")
+      end
+
+      connection.callback { unregister_connection(connection) }
+      connection.errback { unregister_connection(connection) }
+
+      # Needed for crappy Rack::Lint
+      throw :async
+
+      # Returning a status of -1 keeps the connection open
+      # You need to use env['async.callback'].call to send the status, headers & body later
+      AsyncResponse
+    end
+
+    def setup_redis
+      @redis_channels = Set.new
+      @async_redis = EM::Hiredis.connect
+      @async_redis.on(:message) do |channel, message|
+        expedite_incoming_message(channel, message)
+      end
+    end
+
+    def setup_keepalive
+      EventMachine::add_periodic_timer(@options[:keepalive_timeout]) do
+        count = @subscription_map.count
+        @subscription_map.each_key do |connection|
+          connection.keepalive(count)
+        end
+      end
+    end
+
+    def channels_for_request(request)
+      # TODO: Sanitize? Check signature?
+      channel = Array(request.params["channel"])
+      Set.new(channel)
+    end
+
+    def register_connection(connection)
+      requested_channels = channels_for_request(connection.request)
+      subscribe_to_new_channels(requested_channels - @redis_channels)
+      @subscription_map[connection] = requested_channels
+    end
+
+    def unregister_connection(connection)
+      @subscription_map.delete(connection)
+    end
+
+    def subscribe_to_new_channels(channels)
+      channels.each do |channel|
+        puts "Listening to channel: #{channel}"
+        @async_redis.subscribe(channel)
+        @redis_channels << channel
+      end
+    end
+
+    def expedite_incoming_message(channel, message)
+      no_connection_listening = true
+      # Select upfront and use EM::Iterator
+      @subscription_map.each do |connection, channels|
+        if channels.include?(channel)
+          connection.write message
+          no_connection_listening = false
+        end
+      end
+      # We stop listening to a channel whenever a message comes in from a channel
+      # which has no associated connections
+      # Why? Because clients will disconnect and connect all the time when they load new pages
+      # But we don't want to subscribe and unsubscribe from redis all the time.
+      if no_connection_listening
+        puts "Stop listening to channel: #{channel}"
+        @async_redis.unsubscribe(channel)
+        @redis_channels.delete(channel)
+      end
+    end
+  end
+end

data/lib/jugglite/deferrable_body.rb

@@ -0,0 +1,22 @@
+module Jugglite
+  class DeferrableBody
+    include EventMachine::Deferrable
+
+    def initialize
+      @queue = EM::Queue.new
+    end
+
+    def write(body)
+      @queue.push(body)
+    end
+
+    def each &blk
+      @body_callback = blk
+      processor = proc { |item|
+        @body_callback.call(item)
+        @queue.pop(&processor)
+      }
+      @queue.pop(&processor)
+    end
+  end
+end

data/lib/jugglite/sse_connection.rb

@@ -0,0 +1,42 @@
+module Jugglite
+  class SseConnection
+    attr_reader :body, :request
+
+    def initialize(request)
+      @request = request
+      @body = DeferrableBody.new
+    end
+
+    def write(message, options = {})
+      buffer = ""
+      options.each do |k, v|
+        buffer << "#{k}: #{v}\n"
+      end
+      message.each_line do |line|
+        buffer << "data: #{line.strip}\n"
+      end
+      @body.write(buffer << "\n")
+    end
+
+    def keepalive(extra=nil)
+      # From http://dev.w3.org/html5/eventsource/#notes
+      comment("keepalive #{extra}")
+    end
+
+    def comment(comment)
+      @body.write(": #{comment}\n")
+    end
+
+    def close
+      @body.succeed
+    end
+
+    def callback(&block)
+      @body.callback(&block)
+    end
+
+    def errback(&block)
+      @body.errback(&block)
+    end
+  end
+end

data/lib/jugglite/version.rb

@@ -0,0 +1,3 @@
+module Jugglite
+  VERSION = "0.0.1.alpha"
+end

data/lib/jugglite.rb

@@ -0,0 +1,5 @@
+require "thin"
+require "jugglite/version"
+require "jugglite/deferrable_body"
+require "jugglite/sse_connection"
+require "jugglite/app"

data/spec/acceptance/stream_and_publish_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'net/http'
+
+# Execute a GET request for +channel+ that reads the body in chunks
+# until the +regexp+ is received or +timeout+ seconds have passed
+def listen_on_channel_until(channel, regexp, timeout = 5)
+  Net::HTTP.start(@host, @port) do |http|
+      request = Net::HTTP::Get.new("/?channel=#{@channel}")
+
+      body = ""
+      http.request(request) do |response|
+        start_time = Time.now
+        response.read_body do |chunk|
+          body << chunk
+          body.should include(": registered to channels: #{@channel}")
+          http.finish
+          break
+        end
+        break
+      end
+    end
+end
+
+describe "Streaming and publishing" do
+  before(:all) do
+    @host = '127.0.0.1'
+    @port = rand(10000)+10000
+    @channel = "randomized:test:#{rand(2**32)}"
+    @app = nil
+    @thread = Thread.new do
+      @app = Thin::Server.new(@host, @port, Jugglite::App.new)
+      @app.start
+    end
+    sleep(0.01) until @app && @app.running?
+  end
+
+  after(:all) do
+    @app.stop!
+    @thread.join
+  end
+
+  it "should keep a GET open" do
+    Net::HTTP.start(@host, @port) do |http|
+      request = Net::HTTP::Get.new("/?channel=#{@channel}")
+
+      body = ""
+      http.request(request) do |response|
+        response.read_body do |chunk|
+          body << chunk
+          body.should include(": registered to channels: #{@channel}")
+          http.finish
+          break
+        end
+        break
+      end
+    end
+  end
+end

data/spec/benchmark/max_connections.rb

@@ -0,0 +1,57 @@
+# Will try to open as many connections as possible
+# at a rate of about 500 new connections per second.
+# Every 2 seconds the script will print out the number of:
+# connections triggered, connections that received headers,
+# connections failed and connections finished.
+
+# Optional env variables and their defaults:
+# HOST: the hostname to connect to (127.0.0.1)
+# PORT: the port to connect to (3000)
+# RATE: the number of connections per second to open (1000)
+# FD_SIZE: try and increase the number of open file descriptors (202400)
+
+# Note: You'll probably need to increase the open file descriptor limit
+# for your platform to reach the limits.
+# On *nix you can use "ulimit -n XXXXX" to set and "ulimit -n" to read the limit
+
+host = ENV['HOST'] || '127.0.0.1'
+port = (ENV['PORT'] || 3000).to_i
+$between_time = 1.0 / (ENV['RATE'] || 2000).to_i
+file_descriptors = (ENV['FD_SIZE'] || 202400).to_i
+$url = "http://#{host}:#{port}/stream"
+
+require 'eventmachine'
+require 'redis'
+require 'em-http-request'
+
+new_size = EM.set_descriptor_table_size(file_descriptors)
+STDERR.puts "New EventMachine descriptor-table size is #{new_size}"
+EM.epoll
+EM.kqueue
+
+$trigger_count = 0
+$headers_count = 0
+$error_count = 0
+$finish_count = 0
+
+def connect_to_stream(counter)
+  http = EventMachine::HttpRequest.new($url, :inactivity_timeout => 30).get
+  http.headers { |hash| $headers_count+= 1 }
+  http.callback { |result| $finish_count+= 1 }
+  http.errback { |obj| $error_count+=1 }
+end
+
+EM.run do
+  launch_timer = EventMachine::add_periodic_timer($between_time) do
+    connect_to_stream($trigger_count+=1)
+  end
+
+  EM::next_tick { $start_time = Time.now } # Set the start time
+
+  monitor_timer = EventMachine::add_periodic_timer(2) do
+    secs_elapsed = (Time.now - $start_time).round
+    print "#{'%4i' % secs_elapsed} triggered: #{'%6i' % $trigger_count}, "
+    print "headered: #{'%6i' % $headers_count}, errors: #{'%6i' % $error_count}, "
+    puts  "finish_count: #{'%6i' % $finish_count}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require_relative '../lib/jugglite'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: jugglite
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- andruby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: rspec
+  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'
+description: Lightweight SSE server
+email:
+- andrew@bedesign.be
+executables:
+- jugglite
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jugglite
+- jugglite.gemspec
+- lib/jugglite.rb
+- lib/jugglite/app.rb
+- lib/jugglite/deferrable_body.rb
+- lib/jugglite/sse_connection.rb
+- lib/jugglite/version.rb
+- spec/acceptance/stream_and_publish_spec.rb
+- spec/benchmark/max_connections.rb
+- spec/spec_helper.rb
+homepage: http://github.com/andruby/jugglite
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Server Sent Events server written in rack on top of thin inspired by Juggernaut
+  for real time push
+test_files:
+- spec/acceptance/stream_and_publish_spec.rb
+- spec/benchmark/max_connections.rb
+- spec/spec_helper.rb
+has_rdoc: