firehose 0.0.3 → 0.0.4

data/README.md

@@ -9,26 +9,26 @@
 
 # What is Firehose?
 
-Firehose is both a Rack application and JavasSript library that makes building scalable real-time web applications possible.
+Firehose is both a Rack application and JavasScript library that makes building scalable real-time web applications possible.
 
 # How is it different from socket.io?
 
 socket.io attempts to store connection state per node instance. Firehose makes no attempt to store connection state.
 
-Also, socket.io attempts to abstract a low-latency full-duplex port. Firehose assumes that its impossible to simulate this in older web browsers that don't support WebSockets. As such, Firehose focuses on low-latency server-to-client connections and encourages the use of HTTP transports for client-to-server communications.
+Also, socket.io attempts to abstract a low-latency full-duplex port. Firehose assumes that its impossible to simulate this in older web browsers that don't support WebSockets. As such, Firehose focuses on low-latency server-to-client connections and encourages the use of existing HTTP transports, like POST and PUT, for client-to-server communications.
 
-Finally, firehose attempts to solve data consistency issues and authentication by encourage the use of proxying to the web application.
+Finally, Firehose attempts to solve data consistency issues and authentication by encourage the use of proxying to the web application.
 
 # Getting Started
 
 First, you'll need to install and run RabbitMQ.
 
-```
+```sh
 apt-get install rabbitmq    # Install on Ubuntu
 brew install rabbitmq       # Install on Mac Homebrew
 ```
 
-## The Consumer
+## The Server
 
 The consumer is the web server that your client connects to for real-time updates. Create a config.ru file with the following:
 
@@ -36,21 +36,7 @@ The consumer is the web server that your client connects to for real-time update
 require 'rubygems'
 require 'firehose'
 
-run Firehose::Transport::Dispatcher.new do |config|
-  config.timeout = 20
-  
-  # Extract the consumer ID from the HTTP session. This could be a cookie
-  # query param, or whatever.
-  config.consumer = Proc.new do |env|
-    Firehose::Consumer.new(env['HTTP_CONSUMER_ID'])
-  end
-  
-  # Use the /url/path for the queue channel. You could change this to a query
-  # param, or whatever
-  config.channel = Proc.new do |env|
-    env['PATH_INFO']
-  end
-end
+run Firehose::Rack::App.new
 ```
 
 Now run the config.ru file in a server that supports async Rack callbacks (like thin or rainbows)
@@ -59,32 +45,41 @@ Now run the config.ru file in a server that supports async Rack callbacks (like
 thin -R config.ru -p 4000 start
 ```
 
-## The Producer
+## The Publisher
 
-Lets test the producer! Open two terminal windows. In one window, curl the consumer server:
+Lets test it out! Open two terminal windows. In one window, curl:
 
 ```sh
-curl "http://localhost:4000/"
+curl "http://localhost:4000/hello"
 ```
 
-Then run the following script in another terminal:
+Then run the following in the other terminal:
 
-```ruby
-require 'rubygems'
-require 'firehose'
+```sh
+curl -X PUT -d "Greetings fellow human being..." "http://localhost:4000/hello"
+```
+
+and you should see the message in the other terminal.
 
-Firehose::Producer.new.publish('hi there!').to('/greetings')
+```sh
+Greetings fellow human being...
 ```
 
-## JavaScript Client
+## Yeah, so?
+
+You have a dirt simple HTTP pub-sub feed. You could setup an `after_commit` hook on ActiveRecord to push JSON to an end-point. On the subscription side, you could have a Backbone.js application that picks up the changes and updates the client-side UI.
+
+Holy mackerel! Its a nice, clean, RESTful way to build real-time web applications.
+
+# The JavaScript Client
 
-Then in your browser create a new Firehose Client object as such:
+Firehose doesn't just stop at curl; it has a full-featured JavaScript client that lets you subscribe to channels for live updates.
 
 ```javascript
 new Firehose.Client()
   .url({
-    websocket: 'ws://some_websocket_url.com',
-    longpoll:  'http://some_longpoll_url.com'
+    websocket: 'ws://localhost:5100',
+    longpoll:  'http://localhost:5100'
   })
   .params({
     cid: '024023948234'
@@ -93,13 +88,13 @@ new Firehose.Client()
     timeout: 5000
   })
   .message(function(msg){
-    alert(msg); // Fires when a message is received from the server.
+    console.log(msg); // Fires when a message is received from the server.
   })
   .connected(function(){
-    alert('Howdy friend!');
+    console.log('Howdy friend!');
   })
   .disconnected(function(){
-    alert('Bu bye');
+    console.log('Bu bye');
   })
   .connect()
 ```

data/firehose.gemspec

@@ -5,9 +5,9 @@ require "firehose/version"
 Gem::Specification.new do |s|
   s.name        = "firehose"
   s.version     = Firehose::VERSION
-  s.authors     = ["Brad Gessler"]
-  s.email       = ["brad@bradgessler.com"]
-  s.homepage    = ""
+  s.authors     = ["Brad Gessler", "Steel Fu"]
+  s.email       = ["brad@polleverywhere.com", "steel@polleverywhere.com"]
+  s.homepage    = "http://github.com/polleverywhere/firehose"
   s.summary     = %q{Build realtime Ruby web applications}
   s.description = %q{Firehose is a realtime web application toolkit for building realtime Ruby web applications.}
 

data/lib/assets/javascripts/firehose.js.coffee

@@ -0,0 +1,5 @@
+#= require firehose/base
+#= require firehose/transport
+#= require firehose/long_poll
+#= require firehose/web_socket
+#= require firehose/client

data/lib/assets/javascripts/firehose/base.js.coffee

@@ -0,0 +1 @@
+window.Firehose = {}

data/lib/assets/javascripts/firehose/client.js.coffee

@@ -0,0 +1,9 @@
+class Firehose.Client
+  constructor: (args) ->
+    @transports = ['WebSocket', 'LongPoll']
+    
+    # Detect the first supported transport give it back 
+    transport = _.detect @transports, (transport) ->
+      Firehose[transport].supported()
+    
+    return new Firehose[transport](args)

data/lib/assets/javascripts/firehose/long_poll.js.coffee

@@ -0,0 +1,79 @@
+class Firehose.LongPoll extends Firehose.Transport
+  # CORS is supported in IE 8+
+  @ieSupported: =>
+    $.browser.msie and parseInt($.browser.version) > 7 and window.XDomainRequest
+
+  @supported: =>
+    # IE 8+, FF 3.5+, Chrome 4+, Safari 4+, Opera 12+, iOS 3.2+, Android 2.1+
+    $.support.cors || LongPoll.ieSupported()
+
+  constructor: (args) ->
+    super args
+
+    # We use the lag time to make the client live longer than the server.
+    @_lagTime = 5000
+    @_timeout = @options.timeout + @_lagTime
+    @_dataType = "json"
+    @_offlineTimer
+    @_okInterval = 0
+
+    @registerIETransport()
+
+  registerIETransport: =>
+    if LongPoll.ieSupported()
+      $.ajaxTransport 'json', (options, orignalOptions, jqXhr) ->
+        xdr = null
+        send: (_, callback) ->
+          xdr = new XDomainRequest()
+          xdr.onload = ->
+            statusCode = if xdr.responseText.length > 0 then 200 else 204
+            callback(statusCode, 'success', text: xdr.responseText)
+          
+          xdr.onerror = xdr.ontimeout = ->
+            callback(400, 'failed', text: xdr.responseText)
+
+          xdr.open(options.type, options.url)
+          xdr.send(options.data)
+        
+        abort: ->
+          if xdr
+            xdr.onerror = $.noop()
+            xdr.abort()
+
+      # also, override the support check
+      $.support.cors = true;
+    
+  connect: (delay = 0) =>
+    @onConnected()
+    super(delay)
+
+  _request: =>
+    $.ajax @url["longpoll"], 
+      crossDomain: true
+      cache: false
+      dataType: @_dataType
+      data: @params
+      timeout: @_timeout
+      success: @_success
+      error: @_error
+  
+  _success: (data, status, jqXhr) =>
+    if jqXhr.status == 204
+      # If we get a 204 back, that means the server timed-out and sent back a 204 with a
+      # X-Http-Next-Request header
+      # 
+      # Why did we use a 204 and not a 408? Because FireFox is really stupid about 400 level error
+      # codes and would claims its a 0 error code, which we use for something else. Firefox is IE
+      # in thise case
+      @connect(@_okInterval)
+    else
+      @onMessage(data)
+      @connect(@_okInterval)
+
+  # We need this custom handler to have the connection status
+  # properly displayed
+  _error: (jqXhr, status, error) =>
+    clearTimeout(@_offlineTimer)
+    @onDisconnected()
+    @_offlineTimer = setTimeout(@onConnected, @_errorInterval + @_lagTime)
+    @connect(@_errorInterval)

data/lib/assets/javascripts/firehose/transport.js.coffee

@@ -0,0 +1,40 @@
+class Firehose.Transport
+  # Class method to determine whether transport is supported by the current browser
+  @supported: =>
+    false
+
+  constructor: (args) ->
+    @_errorInterval = 5000 
+
+  # Chainable config
+  connected: (@onConnected) -> this
+  disconnected: (@onDisconnected) -> this
+  message: (@onMessage) -> this
+  error: (@onError) -> this
+  url: (@url) -> this
+  params: (@params) -> this
+  options: (@options) -> this
+
+  # Lets rock'n'roll
+  connect: (delay = 0) =>
+    setTimeout =>
+      @_request()
+    , delay
+    this
+
+  # Sub classes need to implement this method to handle requests
+  _request: =>
+
+  # Default error handler
+  _error: (event) =>
+    # Lets try to connect again with delay
+    @onDisconnected()
+    @connect(@_errorInterval)
+
+  # Default connection established handler
+  _open: (event) =>
+    @onConnected()
+
+  # Default connection closed handler
+  _close: (event) =>
+    @onDisconnected()

data/lib/assets/javascripts/firehose/web_socket.js.coffee

@@ -0,0 +1,48 @@
+class Firehose.WebSocket extends Firehose.Transport
+  @flashSupported: =>
+    $.browser.msie
+
+  @supported: =>
+    # Compatibility reference: http://caniuse.com/websockets
+    # Native websocket support + Flash web socket
+    window.WebSocket || (window["MozWebSocket"] and window.MozWebSocket) || WebSocket.flashSupported()
+
+  constructor: (args) ->
+    super args
+
+    # Set flash socket path.
+    WebSocket.__swfLocation = "/flash/firehose/WebSocketMain.swf"
+    
+    # Mozilla decided to have their own implementation of Web Sockets so detect for that
+    window.WebSocket = window.MozWebSocket if window["MozWebSocket"] and window.MozWebSocket
+
+  _request: =>
+    @socket = new window.WebSocket(@url["websocket"] + "?" + $.param(@params))
+    @socket.onopen = @_open
+    @socket.onclose = @_close
+    @socket.onerror = @_error
+    @socket.onmessage = @_message
+
+  _message: (event) =>
+    try
+      @onMessage($.parseJSON(event.data))
+    catch e # If JSON parsing doesn't work, send the rest of it on through
+      @onMessage(event.data)
+
+  _close: (event) =>
+    if !event || (event and !event.wasClean)
+      # This was not a clean disconnect. An error occurred somewhere
+      # Lets try to reconnect
+      @_error(event)
+
+  _error: (event) =>
+    # Cleanup the current connection
+    if @socket
+      @socket.onopen = null
+      @socket.onclose = null
+      @socket.onerror = null
+      @socket.onmessage = null
+      @socket.close()
+      delete(@socket)
+
+    super

data/lib/firehose/version.rb

@@ -1,3 +1,4 @@
 module Firehose
-  VERSION = "0.0.3"
-end
+  VERSION = "0.0.4"
+  CODENAME = "Trickle"
+end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
 - Brad Gessler
+- Steel Fu
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -13,7 +14,7 @@ date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70282339770020 !ruby/object:Gem::Requirement
+  requirement: &70267687581480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,10 @@ dependencies:
         version: 1.0.0.beta
   type: :runtime
   prerelease: false
-  version_requirements: *70282339770020
+  version_requirements: *70267687581480
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70282339769280 !ruby/object:Gem::Requirement
+  requirement: &70267687580600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +33,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70282339769280
+  version_requirements: *70267687580600
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70282339768720 !ruby/object:Gem::Requirement
+  requirement: &70267687580200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70282339768720
+  version_requirements: *70267687580200
 - !ruby/object:Gem::Dependency
   name: websocket-rack
-  requirement: &70282339768120 !ruby/object:Gem::Requirement
+  requirement: &70267687579660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70282339768120
+  version_requirements: *70267687579660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70282339767660 !ruby/object:Gem::Requirement
+  requirement: &70267687579160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282339767660
+  version_requirements: *70267687579160
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70282339767140 !ruby/object:Gem::Requirement
+  requirement: &70267687578500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282339767140
+  version_requirements: *70267687578500
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70282339766600 !ruby/object:Gem::Requirement
+  requirement: &70267687338120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282339766600
+  version_requirements: *70267687338120
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70282339765920 !ruby/object:Gem::Requirement
+  requirement: &70267687337440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282339765920
+  version_requirements: *70267687337440
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70282339752660 !ruby/object:Gem::Requirement
+  requirement: &70267687336400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282339752660
+  version_requirements: *70267687336400
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70282339751820 !ruby/object:Gem::Requirement
+  requirement: &70267687335300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +121,10 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *70282339751820
+  version_requirements: *70267687335300
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: &70282339750760 !ruby/object:Gem::Requirement
+  requirement: &70267687334360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,11 +132,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282339750760
+  version_requirements: *70267687334360
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
-- brad@bradgessler.com
+- brad@polleverywhere.com
+- steel@polleverywhere.com
 executables:
 - firehose
 - firehose-test
@@ -153,7 +155,13 @@ files:
 - bin/firehose-test
 - config.ru
 - firehose.gemspec
-- lib/assets/flash/WebSocketMain.swf
+- lib/assets/flash/firehose/WebSocketMain.swf
+- lib/assets/javascripts/firehose.js.coffee
+- lib/assets/javascripts/firehose/base.js.coffee
+- lib/assets/javascripts/firehose/client.js.coffee
+- lib/assets/javascripts/firehose/long_poll.js.coffee
+- lib/assets/javascripts/firehose/transport.js.coffee
+- lib/assets/javascripts/firehose/web_socket.js.coffee
 - lib/firehose.rb
 - lib/firehose/goliath.rb
 - lib/firehose/http_publisher.rb
@@ -166,7 +174,7 @@ files:
 - spec/integrations/goliath_spec.rb
 - spec/integrations/thin_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: http://github.com/polleverywhere/firehose
 licenses: []
 post_install_message: 
 rdoc_options: []