firehose 0.0.9 → 0.0.10

data/.rspec

@@ -1 +1 @@
---colour
+--colour

data/README.md

@@ -65,14 +65,14 @@ You have a dirt simple HTTP pub-sub feed. You could setup an `after_commit` hook
 
 Holy mackerel! Its a nice, clean, RESTful way to build real-time web applications.
 
-# The JavaScript Client
+# The JavaScript Consumer
 
 Firehose doesn't just stop at curl; it has a full-featured JavaScript client that lets you subscribe to channels for live updates.
 
 Still have the server running? Copy and paste the code below into Firebug or the WebKit console.
 
 ```javascript
-new Firehose.Client({
+new Firehose.Consumer({
   message: function(msg){
     console.log(msg);
   },

data/firehose.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Firehose::VERSION
   s.authors     = ["Brad Gessler", "Steel Fu"]
   s.email       = ["brad@polleverywhere.com", "steel@polleverywhere.com"]
-  s.homepage    = "http://github.com/polleverywhere/firehose"
+  s.homepage    = "http://firehose.io/"
   s.summary     = %q{Build realtime Ruby web applications}
   s.description = %q{Firehose is a realtime web application toolkit for building realtime Ruby web applications.}
 
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "thin"
   s.add_runtime_dependency "thor"
   s.add_runtime_dependency "websocket-rack"
+  s.add_runtime_dependency "faraday"
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "rack-test"

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

@@ -2,4 +2,4 @@
 #= require firehose/transport
 #= require firehose/long_poll
 #= require firehose/web_socket
-#= require firehose/client
+#= require firehose/consumer

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

@@ -0,0 +1,61 @@
+class Firehose.Consumer
+  # Transports that are available to Firehose.
+  @transports: [Firehose.WebSocket, Firehose.LongPoll]
+
+  # Generate a random consumer id.
+  @nextConsumerId: ->
+    Math.floor((Math.random()*99999999999)+1)
+
+  constructor: (config = {}) ->
+    # The consumerId 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.consumerId   ||= Firehose.Consumer.nextConsumerId()
+    # List of transport stragies we have to use.
+    config.transports   ||= Firehose.Consumer.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 ||= ->
+    # The initial connection failed. This is probably triggered when a transport, like WebSockets
+    # is supported by the browser, but for whatever reason it can't connect (probably a firewall)
+    config.failed       ||= ->
+      throw "Could not connect"
+    # URL that we'll connect to.
+    config.uri          ||= undefined
+    # Params that we'll tack on to the URL. We include a consumerId in here for kicks.
+    config.params       ||= { cid: config.consumerId }
+    # 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: =>
+    # Get a list of transports that the browser supports
+    supportedTransports = (transport for transport in @config.transports when transport.supported())
+    # Mmmkay, we've got transports supported by the browser, now lets try connecting 
+    # to them and dealing with failed connections that might be caused by firewalls,
+    # or other network connectivity issues.
+    transports = for transport in supportedTransports
+      # Copy the config so we can modify it with a failed callback.
+      config = @config
+      # Map the next transport into the existing transports connectionError
+      # If the connection fails, try the next transport supported by the browser.
+      config.failed = =>
+        # Map the next transport to connect insie of the current transport failures
+        if nextTransport = supportedTransports.pop()
+          new nextTransport(config).connect()
+        else
+          @config.failed() # Call the original fail method passed into the Firehose.Consumer
+      new transport(config)
+    # Fire off the first connection attempt.
+    transports[0].connect()

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

@@ -14,10 +14,14 @@ class Firehose.LongPoll extends Firehose.Transport
     @config.longPoll ||= {}
     # Protocol schema we should use for talking to WS server.
     @config.longPoll.url ||= "http:#{@config.uri}"
+    # How many ms should we wait before timing out the AJAX connection?
+    # TODO why was this set at 0s?
+    @config.longPoll.timeout ||= 0
 
+    # TODO - What is @_lagTime for? Can't we just use the @_timeout value?
     # We use the lag time to make the client live longer than the server.
     @_lagTime = 5000
-    @_timeout = @config.options.timeout + @_lagTime
+    @_timeout = @config.longPoll.timeout + @_lagTime
     @_offlineTimer
     @_okInterval = 0
 
@@ -63,6 +67,10 @@ class Firehose.LongPoll extends Firehose.Transport
       error: @_error
   
   _success: (data, status, jqXhr) =>
+    # TODO we actually want to do this when the thing calls out... mmm right now it takes
+    # up to 30s before we can call this thing.
+    # Call the 'connected' callback if the connection succeeds.
+    @_open(data) unless @_succeeded
     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

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

@@ -21,12 +21,17 @@ class Firehose.Transport
 
   # Default error handler
   _error: (event) =>
-    # Lets try to connect again with delay
-    @config.disconnected()
-    @connect(@_retryDelay)
+    unless @_succeeded
+      # Fail peremantly if the error happens on the first connection.
+      @config.failed(this)
+    else
+      # Lets try to connect again with delay
+      @config.disconnected()
+      @connect(@_retryDelay)
 
   # Default connection established handler
   _open: (event) =>
+    @_succeeded = true
     @config.connected()
 
   # Default connection closed handler

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

@@ -5,7 +5,7 @@ class Firehose.WebSocket extends Firehose.Transport
   @supported: =>
     # Compatibility reference: http://caniuse.com/websockets
     # Native websocket support + Flash web socket
-    window.WebSocket || (window["MozWebSocket"] and window.MozWebSocket) || WebSocket.flashSupported()
+    !!(window.WebSocket || (window["MozWebSocket"] and window.MozWebSocket) || WebSocket.flashSupported())
 
   constructor: (args) ->
     super args

data/lib/firehose/rack.rb

@@ -95,10 +95,18 @@ module Firehose
 
     class App
       def call(env)
-        websocket_request?(env) ? WebSocket.new.call(env) : HttpLongPoll.new.call(env)
+        websocket_request?(env) ? websocket.call(env) : http_long_poll.call(env)
       end
 
     private
+      def websocket
+        @websocket ||= WebSocket.new
+      end
+
+      def http_long_poll
+        @http_long_poll ||= HttpLongPoll.new
+      end
+
       def websocket_request?(env)
         env['HTTP_UPGRADE'] =~ /websocket/i
       end

data/lib/firehose/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2012-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70248633218840 !ruby/object:Gem::Requirement
+  requirement: &70248892020200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0.beta
   type: :runtime
   prerelease: false
-  version_requirements: *70248633218840
+  version_requirements: *70248892020200
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70248633201380 !ruby/object:Gem::Requirement
+  requirement: &70248892017640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70248633201380
+  version_requirements: *70248892017640
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70248633200480 !ruby/object:Gem::Requirement
+  requirement: &70248892031220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70248633200480
+  version_requirements: *70248892031220
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70248633199280 !ruby/object:Gem::Requirement
+  requirement: &70248892024520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70248633199280
+  version_requirements: *70248892024520
 - !ruby/object:Gem::Dependency
   name: websocket-rack
-  requirement: &70248633198520 !ruby/object:Gem::Requirement
+  requirement: &70248892039500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70248633198520
+  version_requirements: *70248892039500
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70248892037240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70248892037240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70248633197580 !ruby/object:Gem::Requirement
+  requirement: &70248892032840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248633197580
+  version_requirements: *70248892032840
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70248633196960 !ruby/object:Gem::Requirement
+  requirement: &70248892042160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248633196960
+  version_requirements: *70248892042160
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70248633195800 !ruby/object:Gem::Requirement
+  requirement: &70248892053200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248633195800
+  version_requirements: *70248892053200
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70248633195200 !ruby/object:Gem::Requirement
+  requirement: &70248892049780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248633195200
+  version_requirements: *70248892049780
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70248633178620 !ruby/object:Gem::Requirement
+  requirement: &70248892059480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +132,10 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *70248633178620
+  version_requirements: *70248892059480
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: &70248633177760 !ruby/object:Gem::Requirement
+  requirement: &70248892071480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +143,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248633177760
+  version_requirements: *70248892071480
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
@@ -156,7 +167,7 @@ files:
 - 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/consumer.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
@@ -170,7 +181,7 @@ files:
 - spec/integrations/amqp_resources_spec.rb
 - spec/integrations/thin_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/polleverywhere/firehose
+homepage: http://firehose.io/
 licenses: []
 post_install_message: 
 rdoc_options: []

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

@@ -1,45 +0,0 @@
-class Firehose.Client
-  # 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.
-    # TODO if the initial connection fails, try the next transport mmmkay?
-    for transport in @config.transports
-      if transport = Firehose[transport]
-        return new transport(@config).connect() if transport.supported()