jugglite 0.0.1.alpha → 0.0.2.alpha

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode

data/CHANGELOG

@@ -0,0 +1,11 @@
+= 0.0.3 / Not Yet Released
+
+ * TODO: add support for Remy's Polyfill
+
+= 0.0.2.alpha / 2012-11-04
+
+ * standalone binary supports some thin commandline options
+
+= 0.0.1.alpha / 2012-11-15
+
+ * Initial gem release

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jugglite.gemspec
 gemspec
+
+group :test do
+  gem 'rake'
+end

data/README.md

@@ -1,6 +1,8 @@
 # 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.
+[![Build Status](https://secure.travis-ci.org/andruby/jugglite.png?branch=master)](https://travis-ci.org/andruby/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. It uses [Redis](http://www.redis.io) for publish/subscribe and [Thin](http://code.macournoyer.com/thin/) + [EventMachine](https://github.com/eventmachine/eventmachine) to run an evented server that can handle 10K+ concurrent connections.
 
 ## Installation
 
@@ -16,16 +18,72 @@ Or install it yourself as:
 
     $ gem install jugglite
 
-## Usage
+## Server Usage
+
+I use jugglite as rack middleware in development and as a standalone cluster in production behind nginx.
+
+### Stand-alone binary
 
 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`
+You can run the binary from any terminal like this (these options are the defaults):
+
+`jugglite --address 0.0.0.0 --port 3000 --max-conns 1024`
+
+### As rack middleware
+
+Add it to your `config.ru` file:
+`use Juglite::App, path: '/stream'` (use the `path` option )
+
+### As a cluster behind Nginx reverse proxy
+
+NOTE: because the html5 SSE implementation requires the connection to have the same hostname and port, you'll need to add a reverse proxy in front of your app and jugglite.
+
+TODO with Foreman?
+
+## Client Usage
+
+Use the browser's native [Server-Sent Events](http://www.html5rocks.com/en/tutorials/eventsource/basics/) implementation:
+
+```javascript
+  es = new EventSource('/stream?channel=yourchannelname');
+
+  es.addEventListener('message', function(e) {
+    // Do something with the data
+    console.log(e.data);
+    // If you JSON encoded the message
+    msg = jQuery.parseJSON(e.data);
+    }, false);
+
+  es.onopen = function(e) {
+    // Connection was opened.
+  };
+
+  es.onerror = function(e) {
+    if (e.readyState == EventSource.CLOSED) {
+      // Connection was closed.
+    } else {
+      // Some other error?
+    };
+  };
+```
+
+To support older browsers, use [Remy's](http://html5doctor.com/server-sent-events/) excellent [Pollyfill](https://github.com/remy/polyfills/blob/master/EventSource.js). It does revert to ajax long polling for browsers without a native EventSource implementation. Supports almost every old browser (even IE7).
+
+## Sending messages
+
+Use your favorite Redis client to simply publish messages to the channel your clients are subscribing to:
+
+```ruby
+redis = Redis.new
+redis.publish('yourchannelname', 'This is a message')
+# You may want to JSON encode your data
+redis.publish('yourchannelname', {hello: 'world', number: 47}.to_json)
+```
 
-TODO: Foreman & multiple processes
+## Performance
 
-TODO: Behind nginx so the client connects on one port
+It's been tested on a local machine with the `spec/benchmark/max_connections.rb` spec up to 16K concurrent connections.
 
 ## Contributing
 

data/bin/jugglite

@@ -1,15 +1,20 @@
 #!/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
+# You may use (almost) all options you would pass to thin
+# eg: --max-conns NUM (might require a higher system "ulimit -n" setting)
+# --port PORT
+# --address HOST
+options = Thin::Runner.new(ARGV).options
+thin = Thin::Server.new(Jugglite::App.new, options[:port], options[:address], options)
+
+# Need to increase the descriptor-table for EventMachine
+if options[:max_conns]
+  new_size = EM.set_descriptor_table_size( options[:max_conns].to_i )
+  STDERR.puts "New descriptor-table size is #{new_size}"
+  EM.epoll
+  EM.kqueue
+  thin.maximum_connections = options[:max_conns] # Need to do this manually because it gets overriden on thin/server.rb:123
+end
 
-STDERR.puts "Starting server at #{host}:#{port}"
-Thin::Server.start(host, port, Jugglite::App.new)
+thin.start!

data/lib/jugglite/app.rb

@@ -16,7 +16,6 @@ module Jugglite
         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 }
@@ -26,6 +25,7 @@ module Jugglite
       if @app.nil? || (env["PATH_INFO"] == @options[:path])
         handle_stream(env)
       else
+        # Running as middleware and path did not match so pass it along
         @app.call(env)
       end
     end

data/lib/jugglite/deferrable_body.rb

@@ -10,7 +10,7 @@ module Jugglite
       @queue.push(body)
     end
 
-    def each &blk
+    def each(&blk)
       @body_callback = blk
       processor = proc { |item|
         @body_callback.call(item)

data/lib/jugglite/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jugglite
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.2.alpha
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
@@ -85,6 +85,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md