firehose 1.2.8 → 1.2.9

data/.gitignore

@@ -3,8 +3,8 @@
 .DS_Store
 *.swp
 .env
-Gemfile.lock
 log/*
 pkg/*
+tmp
 *.sublime-project
 *.sublime-workspace

data/Gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: .
+  specs:
+    firehose (1.2.9)
+      em-hiredis (>= 0.2.0)
+      em-http-request (>= 1.0.0)
+      eventmachine (>= 1.0.0)
+      faraday
+      faye-websocket
+      json
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    async_rack_test (0.0.4)
+    coderay (1.0.9)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.3)
+    cookiejar (0.3.0)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    daemons (1.1.9)
+    diff-lcs (1.2.4)
+    dotenv (0.9.0)
+    em-hiredis (0.2.1)
+      hiredis (~> 0.4.0)
+    em-http-request (1.1.1)
+      addressable (>= 2.3.4)
+      cookiejar
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0.beta.2)
+    em-socksify (0.3.0)
+      eventmachine (>= 1.0.0.beta.4)
+    eventmachine (1.0.3)
+    execjs (2.0.2)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faye-websocket (0.7.0)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.3.0)
+    ffi (1.9.0)
+    foreman (0.63.0)
+      dotenv (>= 0.7)
+      thor (>= 0.13.6)
+    formatador (0.2.4)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-coffeescript (1.3.4)
+      coffee-script (>= 2.2.0)
+      guard (>= 1.1.0)
+    guard-rspec (3.1.0)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    hike (1.2.3)
+    hiredis (0.4.5)
+    http_parser.rb (0.6.0.beta.2)
+    json (1.8.1)
+    kgio (2.8.1)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rainbows (4.4.3)
+      kgio (~> 2.5)
+      rack (~> 1.1)
+      unicorn (~> 4.1)
+    raindrops (0.12.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    slop (3.4.6)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thin (1.6.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.5.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    unicorn (4.6.3)
+      kgio (~> 2.6)
+      rack
+      raindrops (~> 0.7)
+    webmock (1.15.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    websocket-driver (0.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  async_rack_test
+  firehose!
+  foreman
+  guard-bundler
+  guard-coffeescript
+  guard-rspec
+  rack-test
+  rainbows (~> 4.4.3)
+  rake
+  rspec
+  sprockets
+  thin
+  webmock

data/README.md

@@ -118,6 +118,40 @@ firehose.publish(json).to("/my/messages/path")
 
 Firehose can be configured via environmental variables. Take a look at the [`.env.sample`](./.env.sample) file for more info.
 
+## Rack Configuration
+
+There are two rack applications that are included with Firehose: `Firehose::Rack::Producer` which a client can `PUT` HTTP request with message payloads to publish information on Firehose and the `Firehose::Rack::Consumer` application which a client connects to via HTT long polling or WebSockets to consume a message.
+
+### Consumer Configuration
+
+```ruby
+# Kitchen-sink rack configuration file example
+require 'firehose'
+
+consumer = Firehose::Rack::Consumer.new do |app|
+  # Configure how long the server should wait before send the client a 204
+  # with a request to reconnect. Typically browsers time-out the client connection
+  # after 30 seconds, so we set the `Firehose.Consumer` JS client to 25, and the
+  # server to 20 to make sure latency or timing doesn't cause any problems.
+  app.http_long_poll.timeout = 20
+end
+
+run consumer
+```
+
+### Publisher Configuration
+
+```ruby
+# Kitchen-sink rack configuration file example
+require 'firehose'
+
+# There's nothing to configure with the Publisher, but its possible that
+# you might include rack middleware authorization mechanisms here to control
+# who can publish to Firehose.
+
+run Firehose::Rack::Publisher.new
+```
+
 ## Sprockets
 
 Using Sprockets is the recommended method of including the included client-side assets in a web page.

data/config/rainbows.rb

@@ -14,8 +14,4 @@ end
 # the rest of the Unicorn configuration...
 worker_processes [ENV['WORKER_PROCESSES'].to_i, 1].max # Default to 1
 working_directory ENV['WORKING_DIRECTORY'] if ENV['WORKING_DIRECTORY']
-logger Firehose.logger
-
-after_fork do |server, worker|
-  require 'firehose/patches/rainbows'
-end if ENV['RACK_ENV'] == 'development'
+logger Firehose.logger

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

@@ -16,10 +16,10 @@ class Firehose.LongPoll extends Firehose.Transport
   constructor: (args) ->
     super args
 
-    @config.ssl              ?= false
-    # Configrations specifically for web sockets
+    @config.ssl ?= false
+
+    # Configrations specifically for long polling
     @config.longPoll         ||= {}
-    # Protocol schema we should use for talking to WS server.
     @config.longPoll.url     ||= "#{@_protocol()}:#{@config.uri}"
     # How many ms should we wait before timing out the AJAX connection?
     @config.longPoll.timeout ||= 25000
@@ -30,8 +30,9 @@ class Firehose.LongPoll extends Firehose.Transport
     @_okInterval      = 0
     @_stopRequestLoop = false
 
+  # Protocol schema we should use for talking to firehose server.
   _protocol: =>
-    if @config.ssl then 'https' else 'http'
+    if @config.ssl then "https" else "http"
 
   _request: =>
     return if @_stopRequestLoop

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

@@ -18,7 +18,7 @@ class Firehose.WebSocket extends Firehose.Transport
     # Run this is a try/catch block because IE10 inside of a .NET control
     # complains about security zones.
     try
-      @socket = new window.WebSocket "ws:#{@config.uri}?#{$.param @config.params}"
+      @socket = new window.WebSocket "#{@_protocol()}:#{@config.uri}?#{$.param @config.params}"
       @socket.onopen    = @_open
       @socket.onclose   = @_close
       @socket.onerror   = @_error
@@ -26,6 +26,10 @@ class Firehose.WebSocket extends Firehose.Transport
     catch err
       console?.log(err)
 
+  # Protocol schema we should use for talking to firehose server.
+  _protocol: =>
+    if @config.ssl then "wss" else "ws"
+
   _open: =>
     sendPing @socket
 

data/lib/firehose.rb

@@ -13,7 +13,6 @@ module Firehose
   autoload :Assets,       'firehose/assets'
   autoload :Rack,         'firehose/rack'
   autoload :CLI,          'firehose/cli'
-  autoload :SwfPolicyRequest, 'firehose/swf_policy_request'
 
   # Default URI for the Firehose server. Consider the port "well-known" and bindable from other apps.
   URI = URI.parse("//0.0.0.0:7474").freeze

data/lib/firehose/rack/app.rb

@@ -4,6 +4,10 @@ module Firehose
     # which talks directly to the Redis server. Also dispatches between HTTP and WebSocket
     # transport handlers depending on the clients' request.
     class App
+      def initialize
+        yield self if block_given?
+      end
+
       def call(env)
         # Cache the parsed request so we don't need to re-parse it when we pass
         # control onto another app.
@@ -25,15 +29,18 @@ module Firehose
         end
       end
 
+      # The consumer pulls messages off of the backend and passes messages to the 
+      # connected HTTP or WebSocket client. This can be configured from the initialization
+      # method of the rack app.
+      def consumer
+        @consumer ||= Consumer.new
+      end
+
       private
       def publisher
         @publisher ||= Publisher.new
       end
 
-      def consumer
-        @consumer ||= Consumer.new
-      end
-
       def ping
         @ping ||= Ping.new
       end

data/lib/firehose/rack/consumer.rb

@@ -1,4 +1,3 @@
-require 'faye/websocket'
 require 'json'
 
 module Firehose
@@ -7,157 +6,34 @@ module Firehose
     # binds that to the Firehose::Server::Subscription class, which is bound to a channel that
     # gets published to.
     class Consumer
+      # Rack consumer transports
+      autoload :HttpLongPoll, 'firehose/rack/consumer/http_long_poll'
+      autoload :WebSocket,    'firehose/rack/consumer/web_socket'
+
+      # Let the client configure the consumer on initialization.
+      def initialize
+        yield self if block_given?
+      end
+
       def call(env)
         websocket_request?(env) ? websocket.call(env) : http_long_poll.call(env)
       end
 
-      private
+      # Memoized instance of web socket that can be configured from the rack app.
       def websocket
-        WebSocket.new
+        @web_socket ||= WebSocket.new
       end
 
+      # Memoized instance of http long poll handler that can be configured from the rack app.
       def http_long_poll
         @http_long_poll ||= HttpLongPoll.new
       end
 
+      private
+      # Determine if the incoming request is a websocket request.
       def websocket_request?(env)
-        Faye::WebSocket.websocket?(env)
-      end
-
-      class HttpLongPoll
-        include Firehose::Rack::Helpers
-
-        # How long should we wait before closing out the consuming clients web connection
-        # for long polling? Most browsers timeout after a connection has been idle for 30s.
-        TIMEOUT = 20
-
-        def call(env)
-          req     = env['parsed_request'] ||= ::Rack::Request.new(env)
-          path    = req.path
-          method  = req.request_method
-          # Get the Last Message Sequence from the query string.
-          # Ideally we'd use an HTTP header, but android devices don't let us
-          # set any HTTP headers for CORS requests.
-          last_sequence = req.params['last_message_sequence'].to_i
-
-          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'
-            Firehose.logger.debug "HTTP GET with last_sequence #{last_sequence} for path #{path} with query #{env["QUERY_STRING"].inspect} and params #{req.params.inspect}"
-            EM.next_tick do
-
-              if last_sequence < 0
-                env['async.callback'].call response(400, "The last_message_sequence parameter may not be less than zero", response_headers(env))
-              else
-                Server::Channel.new(path).next_message(last_sequence, :timeout => TIMEOUT).callback do |message, sequence|
-                  env['async.callback'].call response(200, wrap_frame(message, sequence), response_headers(env))
-                end.errback do |e|
-                  if e == :timeout
-                    env['async.callback'].call response(204, '', response_headers(env))
-                  else
-                    Firehose.logger.error "Unexpected error when trying to GET last_sequence #{last_sequence} for path #{path}: #{e.inspect}"
-                    env['async.callback'].call response(500, 'Unexpected error', response_headers(env))
-                  end
-                end
-              end
-
-            end
-
-            # Tell the web server that this will be an async response.
-            ASYNC_RESPONSE
-
-          else
-            Firehose.logger.debug "HTTP #{method} not supported"
-            response(501, "#{method} not supported.")
-          end
-        end
-
-
-        private
-
-        def wrap_frame(message, last_sequence)
-          JSON.generate :message => message, :last_sequence => last_sequence
-        end
-
-        # If the request is a CORS request, return those headers, otherwise don't worry 'bout it
-        def response_headers(env)
-          cors_origin(env) ? cors_headers(env) : {}
-        end
-
-        def cors_origin(env)
-          env['HTTP_ORIGIN']
-        end
-
-        def cors_headers(env)
-          # TODO seperate out CORS logic as an async middleware with a Goliath web server.
-          {'Access-Control-Allow-Origin' => cors_origin(env)}
-        end
+        Firehose::Rack::Consumer::WebSocket.request?(env)
       end
-
-
-      # It _may_ be more memory efficient if we used the same instance of
-      # this class (or if we even just used a lambda) for every connection.
-      class WebSocket
-        def call(env)
-          req   = ::Rack::Request.new env
-          @ws   = Faye::WebSocket.new env
-          @path = req.path
-          @ws.onopen    = method :handle_open
-          @ws.onclose   = method :handle_close
-          @ws.onerror   = method :handle_error
-          @ws.onmessage = method :handle_message
-          return @ws.rack_response
-        end
-
-        private
-        def subscribe(last_sequence)
-          @subscribed = true
-          @channel    = Server::Channel.new @path
-          @deferrable = @channel.next_message last_sequence
-          @deferrable.callback do |message, sequence|
-            Firehose.logger.debug "WS sent `#{message}` to `#{@path}` with sequence `#{sequence}`"
-            @ws.send self.class.wrap_frame(message, last_sequence)
-            subscribe sequence
-          end
-          @deferrable.errback do |e|
-            EM.next_tick { raise e.inspect } unless e == :disconnect
-          end
-        end
-
-        def handle_message(event)
-          msg = JSON.parse(event.data, :symbolize_names => true) rescue {}
-          seq = msg[:message_sequence]
-          if msg[:ping] == 'PING'
-            Firehose.logger.debug "WS ping received, sending pong"
-            @ws.send JSON.generate :pong => 'PONG'
-          elsif !@subscribed && seq.kind_of?(Integer)
-            Firehose.logger.debug "Subscribing at message_sequence #{seq}"
-            subscribe seq
-          end
-        end
-
-        def handle_open(event)
-          Firehose.logger.debug "WebSocket subscribed to `#{@path}`. Waiting for message_sequence..."
-        end
-
-        def handle_close(event)
-          if @deferrable
-            @deferrable.fail :disconnect
-            @channel.unsubscribe(@deferrable) if @channel
-          end
-          Firehose.logger.debug "WS connection `#{@path}` closing. Code: #{event.code.inspect}; Reason #{event.reason.inspect}"
-        end
-
-        def handle_error(event)
-          Firehose.logger.error "WS connection `#{@path}` error. Message: `#{event.message.inspect}`; Data: `#{event.data.inspect}`"
-        end
-
-        def self.wrap_frame(message, last_sequence)
-          JSON.generate :message => message, :last_sequence => last_sequence
-        end
-      end
-
     end
   end
 end

data/lib/firehose/rack/consumer/http_long_poll.rb

@@ -0,0 +1,86 @@
+require 'json'
+
+module Firehose
+  module Rack
+    class Consumer
+      class HttpLongPoll
+        include Firehose::Rack::Helpers
+
+        # How long should we wait before closing out the consuming clients web connection
+        # for long polling? Most browsers timeout after a connection has been idle for 30s.
+        TIMEOUT = 20
+
+        # Configures the timeout for the 
+        attr_accessor :timeout
+
+        def initialize(timeout=TIMEOUT)
+          @timeout = timeout
+          yield self if block_given?
+        end
+
+        def call(env)
+          req     = env['parsed_request'] ||= ::Rack::Request.new(env)
+          path    = req.path
+          method  = req.request_method
+          # Get the Last Message Sequence from the query string.
+          # Ideally we'd use an HTTP header, but android devices don't let us
+          # set any HTTP headers for CORS requests.
+          last_sequence = req.params['last_message_sequence'].to_i
+
+          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'
+            Firehose.logger.debug "HTTP GET with last_sequence #{last_sequence} for path #{path} with query #{env["QUERY_STRING"].inspect} and params #{req.params.inspect}"
+            EM.next_tick do
+
+              if last_sequence < 0
+                env['async.callback'].call response(400, "The last_message_sequence parameter may not be less than zero", response_headers(env))
+              else
+                Server::Channel.new(path).next_message(last_sequence, :timeout => timeout).callback do |message, sequence|
+                  env['async.callback'].call response(200, wrap_frame(message, sequence), response_headers(env))
+                end.errback do |e|
+                  if e == :timeout
+                    env['async.callback'].call response(204, '', response_headers(env))
+                  else
+                    Firehose.logger.error "Unexpected error when trying to GET last_sequence #{last_sequence} for path #{path}: #{e.inspect}"
+                    env['async.callback'].call response(500, 'Unexpected error', response_headers(env))
+                  end
+                end
+              end
+
+            end
+
+            # Tell the web server that this will be an async response.
+            ASYNC_RESPONSE
+
+          else
+            Firehose.logger.debug "HTTP #{method} not supported"
+            response(501, "#{method} not supported.")
+          end
+        end
+
+
+        private
+
+        def wrap_frame(message, last_sequence)
+          JSON.generate :message => message, :last_sequence => last_sequence
+        end
+
+        # If the request is a CORS request, return those headers, otherwise don't worry 'bout it
+        def response_headers(env)
+          cors_origin(env) ? cors_headers(env) : {}
+        end
+
+        def cors_origin(env)
+          env['HTTP_ORIGIN']
+        end
+
+        def cors_headers(env)
+          # TODO seperate out CORS logic as an async middleware with a Goliath web server.
+          {'Access-Control-Allow-Origin' => cors_origin(env)}
+        end
+      end
+    end
+  end
+end

data/lib/firehose/rack/consumer/web_socket.rb

@@ -0,0 +1,95 @@
+require 'faye/websocket'
+require 'json'
+
+module Firehose
+  module Rack
+    class Consumer
+      class WebSocket
+        # Setup a handler for the websocket connection.
+        def call(env)
+          ws = Faye::WebSocket.new(env)
+          Handler.new(ws)
+          ws.rack_response
+        end
+
+        # Determine if the rack request is a WebSocket request.
+        def self.request?(env)
+          Faye::WebSocket.websocket?(env)
+        end
+
+        # Manages connection state for the web socket that's connected
+        # by the Consumer::WebSocket class. Deals with message sequence,
+        # connection, failures, and subscription state.
+        class Handler
+          def initialize(ws)
+            @ws = ws
+            @req = ::Rack::Request.new ws.env
+            # Setup the event handlers from this class.
+            @ws.onopen    = method :open
+            @ws.onclose   = method :close
+            @ws.onerror   = method :error
+            @ws.onmessage = method :message
+          end
+
+          # Subscribe the client to the channel on the server. Asks for
+          # the last sequence for clients that reconnect. 
+          def subscribe(last_sequence)
+            @subscribed = true
+            @channel    = Server::Channel.new @req.path
+            @deferrable = @channel.next_message last_sequence
+            @deferrable.callback do |message, sequence|
+              Firehose.logger.debug "WS sent `#{message}` to `#{@req.path}` with sequence `#{sequence}`"
+              @ws.send self.class.wrap_frame(message, last_sequence)
+              subscribe sequence
+            end
+            @deferrable.errback do |e|
+              EM.next_tick { raise e.inspect } unless e == :disconnect
+            end
+          end
+
+          # Manages messages sent from the connect client to the server. This is mostly
+          # used to handle heart-beats that are designed to prevent the WebSocket connection
+          # from timing out from inactivity.
+          def message(event)
+            msg = JSON.parse(event.data, :symbolize_names => true) rescue {}
+            seq = msg[:message_sequence]
+            if msg[:ping] == 'PING'
+              Firehose.logger.debug "WS ping received, sending pong"
+              @ws.send JSON.generate :pong => 'PONG'
+            elsif !@subscribed && seq.kind_of?(Integer)
+              Firehose.logger.debug "Subscribing at message_sequence #{seq}"
+              subscribe seq
+            end
+          end
+
+          # Log a message that the client has connected. 
+          def open(event)
+            Firehose.logger.debug "WebSocket subscribed to `#{@req.path}`. Waiting for message_sequence..."
+          end
+
+          # Log a message that hte client has disconnected and reset the state for the class. Clean
+          # up the subscribers to the channels.
+          def close(event)
+            if @deferrable
+              @deferrable.fail :disconnect
+              @channel.unsubscribe(@deferrable) if @channel
+            end
+            Firehose.logger.debug "WS connection `#{@req.path}` closing. Code: #{event.code.inspect}; Reason #{event.reason.inspect}"
+          end
+
+          # Log errors if a socket fails. `close` will fire after this to clean up any
+          # remaining connectons.
+          def error(event)
+            Firehose.logger.error "WS connection `#{@req.path}` error. Message: `#{event.message.inspect}`; Data: `#{event.data.inspect}`"
+          end
+
+          # Wrap a message in a sequence so that the client can record this and give us 
+          # the sequence when it reconnects.
+          def self.wrap_frame(message, last_sequence)
+            JSON.generate :message => message, :last_sequence => last_sequence
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firehose/server/app.rb

@@ -36,7 +36,6 @@ module Firehose
       # Boot the Firehose server with the Thin app server.
       def start_thin
         require 'thin'
-        require 'firehose/patches/thin' if ENV['RACK_ENV'] == 'development'
 
         Faye::WebSocket.load_adapter('thin')
 

data/lib/firehose/server/channel.rb

@@ -31,7 +31,7 @@ module Firehose
           redis.lrange(list_key, 0, Server::Publisher::MAX_MESSAGES).
             errback {|e| deferrable.fail e }
         redis.exec.callback do |(sequence, message_list)|
-          Firehose.logger.debug "exec returened: `#{sequence}` and `#{message_list.inspect}`"
+          Firehose.logger.debug "exec returned: `#{sequence}` and `#{message_list.inspect}`"
           sequence = sequence.to_i
 
           if sequence.nil? || (diff = sequence - last_sequence) <= 0
@@ -77,4 +77,4 @@ module Firehose
       end
     end
   end
-end
+end

data/lib/firehose/version.rb

@@ -1,4 +1,4 @@
 module Firehose
-  VERSION  = "1.2.8"
-  CODENAME = "Straight Stream"
+  VERSION  = "1.2.9"
+  CODENAME = "Configurable Carl"
 end

data/spec/lib/client/consumer_spec.rb

@@ -1,9 +1,13 @@
 require 'spec_helper'
 
 describe Firehose::Client::Consumer::WebSocket do
-  it "should be tested" # probably inside of the integrations
+  context "transport" do
+    # Transport for Firehose::Client::App class is tested via the spec/integrations suite.
+  end
 end
 
 describe Firehose::Client::Consumer::HttpLongPoll do
-  it "should be tested" # probably inside of the integrations
+  context "transport" do
+    # Transport for Firehose::Client::App class is tested via the spec/integrations suite.
+  end
 end

data/spec/lib/rack/consumer/http_long_poll_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Firehose::Rack::Consumer::HttpLongPoll do
+  context "transport" do
+    # Transport for Firehose::Rack::App class is tested via the spec/integrations suite.
+  end
+  context "configuration" do
+    it "should have #timeout" do
+      Firehose::Rack::Consumer::HttpLongPoll.new(200).timeout.should == 200
+    end
+  end
+end

data/spec/lib/rack/consumer_spec.rb

@@ -8,4 +8,12 @@ describe Firehose::Rack::Consumer, :type => :request do
 
   it "should have Content-Length on OPTIONS request"
   it "should have Content-Length on GET request"
+
+  context "configuration" do
+    let(:app) { Firehose::Rack::Consumer }
+
+    it "should configure long polling timeout" do
+      app.new{ |a| a.http_long_poll.timeout = 300 }.http_long_poll.timeout.should == 300
+    end
+  end
 end

data/spec/lib/server/app_spec.rb

@@ -1 +1,15 @@
-# The Firehose::Server::App class is tested via the spec/integrations suite.
+require 'spec_helper'
+
+describe Firehose::Rack::App do
+  context "transport" do
+    # Transport for Firehose::Rack::App class is tested via the spec/integrations suite.
+  end
+
+  context "configuration" do
+    let(:app) { Firehose::Rack::App }
+
+    it "should configure long polling timeout" do
+      app.new{ |a| a.consumer.http_long_poll.timeout = 300 }.consumer.http_long_poll.timeout.should == 300
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 -07:00
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915795260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,15 +25,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *70105915795260
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915830300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -40,15 +36,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.2.0
+  version_requirements: *70105915830300
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915829500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,15 +47,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915829500
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915828480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -72,15 +58,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915828480
 - !ruby/object:Gem::Dependency
   name: faye-websocket
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915827560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,15 +69,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915827560
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915826680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -104,15 +80,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *70105915826680
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915826240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,15 +91,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915826240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915825720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -136,15 +102,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915825720
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915824960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -152,15 +113,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915824960
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915839000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -168,15 +124,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915839000
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915838200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -184,15 +135,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915838200
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915837780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -200,15 +146,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915837780
 - !ruby/object:Gem::Dependency
   name: rainbows
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915837100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -216,15 +157,10 @@ dependencies:
         version: 4.4.3
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.4.3
+  version_requirements: *70105915837100
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915836480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -232,15 +168,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915836480
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915835820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -248,15 +179,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915835820
 - !ruby/object:Gem::Dependency
   name: async_rack_test
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915835180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -264,15 +190,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915835180
 - !ruby/object:Gem::Dependency
   name: foreman
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915834620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -280,15 +201,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915834620
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915834200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -296,15 +212,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915834200
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70105915833780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -312,12 +223,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70105915833780
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
@@ -336,6 +242,7 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - Procfile
 - README.md
@@ -358,12 +265,11 @@ files:
 - lib/firehose/client/consumer.rb
 - lib/firehose/client/producer.rb
 - lib/firehose/logging.rb
-- lib/firehose/patches/rainbows.rb
-- lib/firehose/patches/swf_policy_request.rb
-- lib/firehose/patches/thin.rb
 - lib/firehose/rack.rb
 - lib/firehose/rack/app.rb
 - lib/firehose/rack/consumer.rb
+- lib/firehose/rack/consumer/http_long_poll.rb
+- lib/firehose/rack/consumer/web_socket.rb
 - lib/firehose/rack/ping.rb
 - lib/firehose/rack/publisher.rb
 - lib/firehose/rails.rb
@@ -381,6 +287,7 @@ files:
 - spec/lib/client/consumer_spec.rb
 - spec/lib/client/producer_spec.rb
 - spec/lib/firehose_spec.rb
+- spec/lib/rack/consumer/http_long_poll_spec.rb
 - spec/lib/rack/consumer_spec.rb
 - spec/lib/rack/ping_spec.rb
 - spec/lib/rack/publisher_spec.rb
@@ -389,6 +296,7 @@ files:
 - spec/lib/server/publisher_spec.rb
 - spec/lib/server/subscriber_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://firehose.io/
 licenses: []
 post_install_message: 
@@ -401,21 +309,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1688305656129984284
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1688305656129984284
 requirements: []
 rubyforge_project: firehose
-rubygems_version: 1.8.23
+rubygems_version: 1.3.9.5
 signing_key: 
 specification_version: 3
 summary: Build realtime Ruby web applications
@@ -428,6 +330,7 @@ test_files:
 - spec/lib/client/consumer_spec.rb
 - spec/lib/client/producer_spec.rb
 - spec/lib/firehose_spec.rb
+- spec/lib/rack/consumer/http_long_poll_spec.rb
 - spec/lib/rack/consumer_spec.rb
 - spec/lib/rack/ping_spec.rb
 - spec/lib/rack/publisher_spec.rb

data/lib/firehose/patches/rainbows.rb

@@ -1,35 +0,0 @@
-# This file file monkeypatches Rainbows! to return a proper SWF policy file.
-# Enable this with something like this in your config/rainbows.rb file:
-#
-#     after_fork do |server, worker|
-#       require 'firehose/patches/rainbows'
-#     end if ENV['RACK_ENV'] == 'development'
-#
-# You should only use this in development. It has not been well tested in a
-# production environment.
-#
-# NOTE: This only works if you are using Rainbows! with EventMachine.
-#
-# Some helpful links:
-# http://unicorn.bogomips.org/Unicorn/Configurator.html
-# http://www.adobe.com/devnet/flashplayer/articles/socket_policy_files.html
-# http://blog.vokle.com/index.php/2009/06/10/dealing-with-adobe-and-serving-socket-policy-servers-via-nginx-and-10-lines-of-code/
-
-require 'firehose/patches/swf_policy_request'
-require 'rainbows'
-
-# Ensure the class already exists so we are overwriting it.
-Rainbows::EventMachine::Client
-
-class Rainbows::EventMachine::Client
-  include Firehose::Patches::SwfPolicyRequest
-  alias_method :receive_data_without_swf_policy, :receive_data
-  # Borrowed from: https://github.com/igrigorik/em-websocket/blob/3e7f7d7760cc23b9d1d34fc1c17bab4423b5d11a/lib/em-websocket/connection.rb#L104
-  def receive_data(data)
-    if handle_swf_policy_request(data)
-      return false
-    else
-      receive_data_without_swf_policy(data)
-    end
-  end
-end

data/lib/firehose/patches/swf_policy_request.rb

@@ -1,26 +0,0 @@
-module Firehose
-  module Patches
-    # Helpers for making Firehose work with Macromedia Flash Sockets. Since this doesn't use "normal" HTTP, we
-    # have to monkey patch both Rainbows and Thin to recognize when a request is for a SWF policy.
-    module SwfPolicyRequest
-      # Borrowed from: https://github.com/igrigorik/em-websocket/blob/3e7f7d7760cc23b9d1d34fc1c17bab4423b5d11a/lib/em-websocket/connection.rb#L104
-      def handle_swf_policy_request(data)
-        if data =~ /\A<policy-file-request\s*\/>/
-          Firehose.logger.debug "Received SWF Policy request: #{data.inspect}"
-          send_data policy
-          close_connection_after_writing
-          true
-        end
-      end
-
-      def policy
-        <<-EOS
-  <?xml version="1.0"?>
-  <cross-domain-policy>
-    <allow-access-from domain="*" to-ports="*"/>
-  </cross-domain-policy>
-        EOS
-      end
-    end
-  end
-end

data/lib/firehose/patches/thin.rb

@@ -1,27 +0,0 @@
-# This file file monkeypatches Thin to return a proper SWF policy file.
-#
-# You should only use this in development. It has not been well tested in a
-# production environment.
-#
-# NOTE: This only works if you are using Thin with EventMachine.
-#
-# Some helpful links:
-# http://www.adobe.com/devnet/flashplayer/articles/socket_policy_files.html
-# http://blog.vokle.com/index.php/2009/06/10/dealing-with-adobe-and-serving-socket-policy-servers-via-nginx-and-10-lines-of-code/
-
-require 'firehose/patches/swf_policy_request'
-require 'thin'
-# Ensure the class already exists so we are overwriting it.
-Thin::Connection
-
-class Thin::Connection
-  include Firehose::Patches::SwfPolicyRequest
-  alias_method :receive_data_without_swf_policy, :receive_data
-  def receive_data(data)
-    if handle_swf_policy_request(data)
-      return false
-    else
-      receive_data_without_swf_policy(data)
-    end
-  end
-end