firehose 0.0.8 → 0.0.9

data/Procfile

@@ -1 +1 @@
-firehose: firehose start
+firehose: firehose server

data/README.md

@@ -31,7 +31,7 @@ $ gem install firehose
 Now fire up the server.
 
 ```ruby
-$ firehose start
+$ firehose server
 >> Thin web server (v1.3.1 codename Triple Espresso)
 >> Maximum connections set to 1024
 >> Listening on 127.0.0.1:7478, CTRL+C to stop
@@ -72,27 +72,23 @@ Firehose doesn't just stop at curl; it has a full-featured JavaScript client tha
 Still have the server running? Copy and paste the code below into Firebug or the WebKit console.
 
 ```javascript
-new Firehose.Client()
-  .url({
-    websocket: 'ws://localhost:7478/hello',
-    longpoll:  'http://localhost:7478/hello'
-  })
-  .params({
-    cid: '024023948234'
-  })
-  .options({
-    timeout: 5000
-  })
-  .message(function(msg){
+new Firehose.Client({
+  message: function(msg){
     console.log(msg);
-  })
-  .connected(function(){
-    console.log('Howdy friend!');
-  })
-  .disconnected(function(){
-    console.log('Bu bye.');
-  })
-  .connect()
+  },
+  connected: function(){
+    console.log("Great Scotts!! We're connected!");
+  },
+  disconnected: function(){
+    console.log("Well shucks, we're not connected anymore");
+  },
+  error: function(){
+    console.log("Well then, something went horribly wrong.");
+  },
+  // Note that we do NOT specify a protocol here because we don't
+  // know that yet.
+  uri: '//localhost:7478/hello'
+}).connect();
 ```
 
 Then publish another message.

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

@@ -1,8 +1,45 @@
 class Firehose.Client
-  constructor: (args) ->
-    @transports = ['WebSocket', 'LongPoll']
+  # Transports that are available to Firehose.
+  @transports: ['WebSocket', 'LongPoll']
 
+  # Generate a random client_id.
+  @nextClientId: ->
+    Math.floor((Math.random()*99999999999)+1)
+
+  constructor: (config={}) ->
+    # The clientId is used by the server to remember messages between requests. In a production environment,
+    # this should probably be some combination of "user_id-rand". Why the rand? Because a user may have multiple
+    # tabs open to the application, and each tab needs a different channel on the server.
+    config.clientId    ||= Firehose.Client.nextClientId()
+    # List of transport stragies we have to use.
+    config.transports   ||= Firehose.Client.transports
+    # Empty handler for messages.
+    config.message      ||= ->
+    # Empty handler for error handling.
+    config.error        ||= ->
+    # Empty handler for when we establish a connection.
+    config.connected    ||= ->
+    # Empty handler for when we're disconnected.
+    config.disconnected ||= ->
+    # Additional options.
+    config.options      ||= {}
+    # URL that we'll connect to.
+    config.uri          ||= undefined
+    # Params that we'll tack on to the URL. We include a clientId in here for kicks.
+    config.params       ||= { cid: config.clientId }
+    # Do stuff before we send the message into config.message. The sensible
+    # default on the webs is to parse JSON.
+    config.parse ||= (body) ->
+      $.parseJSON(body)
+    
+    # Hang on to these config for when we connect.
+    @config = config
+    # Make sure we return ourself out of the constructor so we can chain.
+    this
+
+  connect: =>
     # Figure out what transport is supported and return it.
-    for transport in @transports
+    # TODO if the initial connection fails, try the next transport mmmkay?
+    for transport in @config.transports
       if transport = Firehose[transport]
-        return new transport(args) if transport.supported()
+        return new transport(@config).connect() if transport.supported()

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

@@ -5,22 +5,28 @@ class Firehose.LongPoll extends Firehose.Transport
 
   @supported: =>
     # IE 8+, FF 3.5+, Chrome 4+, Safari 4+, Opera 12+, iOS 3.2+, Android 2.1+
-    $.support.cors || LongPoll.ieSupported()
+    $.support.cors || Firehose.LongPoll.ieSupported()
 
   constructor: (args) ->
     super args
 
+    # Configrations specifically for web sockets
+    @config.longPoll ||= {}
+    # Protocol schema we should use for talking to WS server.
+    @config.longPoll.url ||= "http:#{@config.uri}"
+
     # We use the lag time to make the client live longer than the server.
     @_lagTime = 5000
-    @_timeout = @options.timeout + @_lagTime
-    @_dataType = "json"
+    @_timeout = @config.options.timeout + @_lagTime
     @_offlineTimer
     @_okInterval = 0
 
     @registerIETransport()
 
   registerIETransport: =>
-    if LongPoll.ieSupported()
+    if Firehose.LongPoll.ieSupported()
+      # TODO - Ask Steel what this is for. Looks like some kind of polygot fill, but I want
+      # to take the 'json' transport out and do that myself.
       $.ajaxTransport 'json', (options, orignalOptions, jqXhr) ->
         xdr = null
         send: (_, callback) ->
@@ -44,15 +50,14 @@ class Firehose.LongPoll extends Firehose.Transport
       $.support.cors = true;
     
   connect: (delay = 0) =>
-    @onConnected()
+    @config.connected()
     super(delay)
 
   _request: =>
-    $.ajax @url["longpoll"], 
+    $.ajax @config.longPoll.url,
       crossDomain: true
       cache: false
-      dataType: @_dataType
-      data: @params
+      data: @config.params
       timeout: @_timeout
       success: @_success
       error: @_error
@@ -67,13 +72,13 @@ class Firehose.LongPoll extends Firehose.Transport
       # in thise case
       @connect(@_okInterval)
     else
-      @onMessage(data)
+      @config.message(@config.parse(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)
+    @config.disconnected()
+    @_offlineTimer = setTimeout(@config.connected, @_retryDelay + @_lagTime)
+    @connect(@_retryDelay)

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

@@ -1,21 +1,15 @@
 class Firehose.Transport
-  # Class method to determine whether transport is supported by the current browser
+  # Class method to determine whether transport is supported by the current browser. Note that while
+  # the transport may be supported by the browser, its possible that the network connection won't 
+  # succeed. That should be accounted for during the initial connecting to the server.
   @supported: =>
     false
 
-  constructor: (args) ->
-    @_errorInterval = 5000 
+  constructor: (config={}) ->
+    @config = config
+    @_retryDelay = 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
+  # Lets rock'n'roll! Connect to the server.
   connect: (delay = 0) =>
     setTimeout =>
       @_request()
@@ -28,13 +22,13 @@ class Firehose.Transport
   # Default error handler
   _error: (event) =>
     # Lets try to connect again with delay
-    @onDisconnected()
-    @connect(@_errorInterval)
+    @config.disconnected()
+    @connect(@_retryDelay)
 
   # Default connection established handler
   _open: (event) =>
-    @onConnected()
+    @config.connected()
 
   # Default connection closed handler
   _close: (event) =>
-    @onDisconnected()
+    @config.disconnected()

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

@@ -10,24 +10,28 @@ class Firehose.WebSocket extends Firehose.Transport
   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
+    # Configrations specifically for web sockets
+    @config.webSocket ||= {}
+    # Protocol schema we should use for talking to WS server.
+    @config.webSocket.url ||= "ws:#{@config.uri}?#{$.param(@config.params)}"
+    # Path of the swf WebSocket that we use in non-WS flash browsers.
+    @config.webSocket.swf_path ||= "/flash/firehose/WebSocketMain.swf"
+
+    # Set flash socket path for the WS SWF polyfill.
+    WebSocket.__swfLocation = @config.webSocket.swf_path
+
+    # 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 = new window.WebSocket(@config.webSocket.url)
     @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)
+    @config.message(@config.parse(event.data))
 
   _close: (event) =>
     if !event || (event and !event.wasClean)
@@ -44,5 +48,5 @@ class Firehose.WebSocket extends Firehose.Transport
       @socket.onmessage = null
       @socket.close()
       delete(@socket)
-
+    
     super

data/lib/firehose/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'thin'
 
 module Firehose
   class CLI < Thor
@@ -6,12 +7,9 @@ module Firehose
     method_option :port, :type => :numeric, :default => 7474, :required => true, :aliases => '-p'
     method_option :host, :type => :string, :default => '0.0.0.0', :required => true, :aliases => '-h'
     def server
-      require 'thin'
-
       server = Thin::Server.new(options[:host], options[:port]) do
         run Firehose::Rack::App.new
       end
-
       server.start!
     end
   end

data/lib/firehose/rack.rb

@@ -10,19 +10,50 @@ module Firehose
         cid     = req.params['cid']
         path    = req.path
         method  = req.request_method
+        timeout = 30
+        cors_headers  = {
+          'Access-Control-Allow-Origin'     => env['HTTP_ORIGIN'],
+          'Access-Control-Allow-Methods'    => 'GET',
+          'Access-Control-Max-Age'          => '1728000'
+        }
 
         case method
         # GET is how clients subscribe to the queue. When a messages comes in, we flush out a response,
         # close down the requeust, and the client then reconnects.
         when 'GET'
+          p [:subscribed, cid, path]
+
           EM.next_tick do
+            # Setup a subscription with a client id. We haven't subscribed yet here.
             subscription = Firehose::Subscription.new(cid)
+
+            # Setup a timeout timer to tell clients that time out that everything is OK
+            # and they should come back for more
+            timer = EM.add_timer(timeout) do
+              # We send a 204 OK to tell the client to reconnect.
+              env['async.callback'].call [204, cors_headers, []]
+              p [:timeout]
+            end
+
+            # Ok, now subscribe to the subscription.
             subscription.subscribe path do |payload|
               subscription.unsubscribe
-              env['async.callback'].call([200, {}, [payload]])
+              subscription = nil # Set this to nil so that our heart beat timer doesn't try to double unsub.
+              EM.cancel_timer timer # Turn off the heart beat so we don't execute any of that business.
+              env['async.callback'].call [200, cors_headers, [payload]]
+            end
+
+            # Unsubscribe from the subscription if its still open and something bad happened
+            # or the heart beat triggered before we could finish.
+            env['async.close'].callback do
+              if subscription
+                subscription.unsubscribe
+                p [:close_unsubscription]
+              end
             end
           end
 
+          # Tell the web server that this will be an async response.
           Firehose::Rack::AsyncResponse
 
         # PUT is how we throw messages on to the fan-out queue.
@@ -33,7 +64,7 @@ module Firehose
 
           [202, {}, []]
         else
-          [501, {}, ["#{method} not supported."]]
+          [501, {'Content-Type' => 'text/plain'}, ["#{method} not supported."]]
         end
       end
     end

data/lib/firehose/version.rb

@@ -1,4 +1,4 @@
 module Firehose
-  VERSION = "0.0.8"
-  CODENAME = "Trickle"
+  VERSION = "0.0.9"
+  CODENAME = "Garden Hose"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70270938629600 !ruby/object:Gem::Requirement
+  requirement: &70248633218840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0.beta
   type: :runtime
   prerelease: false
-  version_requirements: *70270938629600
+  version_requirements: *70248633218840
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70270938629080 !ruby/object:Gem::Requirement
+  requirement: &70248633201380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70270938629080
+  version_requirements: *70248633201380
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70270938628700 !ruby/object:Gem::Requirement
+  requirement: &70248633200480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270938628700
+  version_requirements: *70248633200480
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70270938628240 !ruby/object:Gem::Requirement
+  requirement: &70248633199280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270938628240
+  version_requirements: *70248633199280
 - !ruby/object:Gem::Dependency
   name: websocket-rack
-  requirement: &70270938627800 !ruby/object:Gem::Requirement
+  requirement: &70248633198520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270938627800
+  version_requirements: *70248633198520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70270938627240 !ruby/object:Gem::Requirement
+  requirement: &70248633197580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270938627240
+  version_requirements: *70248633197580
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70270938626720 !ruby/object:Gem::Requirement
+  requirement: &70248633196960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270938626720
+  version_requirements: *70248633196960
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70270938626240 !ruby/object:Gem::Requirement
+  requirement: &70248633195800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270938626240
+  version_requirements: *70248633195800
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70270938625660 !ruby/object:Gem::Requirement
+  requirement: &70248633195200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270938625660
+  version_requirements: *70248633195200
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70270938624920 !ruby/object:Gem::Requirement
+  requirement: &70248633178620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *70270938624920
+  version_requirements: *70248633178620
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: &70270938624500 !ruby/object:Gem::Requirement
+  requirement: &70248633177760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +132,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270938624500
+  version_requirements: *70248633177760
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
@@ -166,7 +166,6 @@ files:
 - lib/firehose/publisher.rb
 - lib/firehose/rack.rb
 - lib/firehose/subscription.rb
-- lib/firehose/thin.rb
 - lib/firehose/version.rb
 - spec/integrations/amqp_resources_spec.rb
 - spec/integrations/thin_spec.rb

data/lib/firehose/thin.rb

@@ -1,7 +0,0 @@
-require 'thin'
-require 'thin/websockets'
-
-module Firehose
-  module Thin
-  end
-end