firehose 0.2.alpha.3 → 0.2.alpha.5

data/firehose.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rack-test"
   s.add_development_dependency "async_rack_test"
   s.add_development_dependency "foreman"
+  s.add_development_dependency "sprockets"
 end

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

@@ -1,6 +1,6 @@
+#= require firehose/json2
 #= require firehose/base
 #= require firehose/transport
-#= require firehose/lib/jquery.cors.headers
 #= require firehose/long_poll
 #= require firehose/web_socket
 #= require firehose/consumer

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

@@ -24,7 +24,7 @@ class Firehose.Consumer
     # 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)
+      JSON.parse(body)
 
     # Hang on to these config for when we connect.
     @config = config
@@ -34,7 +34,7 @@ class Firehose.Consumer
   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 
+    # 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

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

@@ -0,0 +1,487 @@
+/*
+    json2.js
+    2011-10-19
+
+    Public Domain.
+
+    NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
+
+    See http://www.JSON.org/js.html
+
+
+    This code should be minified before deployment.
+    See http://javascript.crockford.com/jsmin.html
+
+    USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
+    NOT CONTROL.
+
+
+    This file creates a global JSON object containing two methods: stringify
+    and parse.
+
+        JSON.stringify(value, replacer, space)
+            value       any JavaScript value, usually an object or array.
+
+            replacer    an optional parameter that determines how object
+                        values are stringified for objects. It can be a
+                        function or an array of strings.
+
+            space       an optional parameter that specifies the indentation
+                        of nested structures. If it is omitted, the text will
+                        be packed without extra whitespace. If it is a number,
+                        it will specify the number of spaces to indent at each
+                        level. If it is a string (such as '\t' or ' '),
+                        it contains the characters used to indent at each level.
+
+            This method produces a JSON text from a JavaScript value.
+
+            When an object value is found, if the object contains a toJSON
+            method, its toJSON method will be called and the result will be
+            stringified. A toJSON method does not serialize: it returns the
+            value represented by the name/value pair that should be serialized,
+            or undefined if nothing should be serialized. The toJSON method
+            will be passed the key associated with the value, and this will be
+            bound to the value
+
+            For example, this would serialize Dates as ISO strings.
+
+                Date.prototype.toJSON = function (key) {
+                    function f(n) {
+                        // Format integers to have at least two digits.
+                        return n < 10 ? '0' + n : n;
+                    }
+
+                    return this.getUTCFullYear()   + '-' +
+                         f(this.getUTCMonth() + 1) + '-' +
+                         f(this.getUTCDate())      + 'T' +
+                         f(this.getUTCHours())     + ':' +
+                         f(this.getUTCMinutes())   + ':' +
+                         f(this.getUTCSeconds())   + 'Z';
+                };
+
+            You can provide an optional replacer method. It will be passed the
+            key and value of each member, with this bound to the containing
+            object. The value that is returned from your method will be
+            serialized. If your method returns undefined, then the member will
+            be excluded from the serialization.
+
+            If the replacer parameter is an array of strings, then it will be
+            used to select the members to be serialized. It filters the results
+            such that only members with keys listed in the replacer array are
+            stringified.
+
+            Values that do not have JSON representations, such as undefined or
+            functions, will not be serialized. Such values in objects will be
+            dropped; in arrays they will be replaced with null. You can use
+            a replacer function to replace those with JSON values.
+            JSON.stringify(undefined) returns undefined.
+
+            The optional space parameter produces a stringification of the
+            value that is filled with line breaks and indentation to make it
+            easier to read.
+
+            If the space parameter is a non-empty string, then that string will
+            be used for indentation. If the space parameter is a number, then
+            the indentation will be that many spaces.
+
+            Example:
+
+            text = JSON.stringify(['e', {pluribus: 'unum'}]);
+            // text is '["e",{"pluribus":"unum"}]'
+
+
+            text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t');
+            // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'
+
+            text = JSON.stringify([new Date()], function (key, value) {
+                return this[key] instanceof Date ?
+                    'Date(' + this[key] + ')' : value;
+            });
+            // text is '["Date(---current time---)"]'
+
+
+        JSON.parse(text, reviver)
+            This method parses a JSON text to produce an object or array.
+            It can throw a SyntaxError exception.
+
+            The optional reviver parameter is a function that can filter and
+            transform the results. It receives each of the keys and values,
+            and its return value is used instead of the original value.
+            If it returns what it received, then the structure is not modified.
+            If it returns undefined then the member is deleted.
+
+            Example:
+
+            // Parse the text. Values that look like ISO date strings will
+            // be converted to Date objects.
+
+            myData = JSON.parse(text, function (key, value) {
+                var a;
+                if (typeof value === 'string') {
+                    a =
+/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
+                    if (a) {
+                        return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4],
+                            +a[5], +a[6]));
+                    }
+                }
+                return value;
+            });
+
+            myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) {
+                var d;
+                if (typeof value === 'string' &&
+                        value.slice(0, 5) === 'Date(' &&
+                        value.slice(-1) === ')') {
+                    d = new Date(value.slice(5, -1));
+                    if (d) {
+                        return d;
+                    }
+                }
+                return value;
+            });
+
+
+    This is a reference implementation. You are free to copy, modify, or
+    redistribute.
+*/
+
+/*jslint evil: true, regexp: true */
+
+/*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply,
+    call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
+    getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
+    lastIndex, length, parse, prototype, push, replace, slice, stringify,
+    test, toJSON, toString, valueOf
+*/
+
+
+// Create a JSON object only if one does not already exist. We create the
+// methods in a closure to avoid creating global variables.
+
+var JSON;
+if (!JSON) {
+    JSON = {};
+}
+
+(function () {
+    'use strict';
+
+    function f(n) {
+        // Format integers to have at least two digits.
+        return n < 10 ? '0' + n : n;
+    }
+
+    if (typeof Date.prototype.toJSON !== 'function') {
+
+        Date.prototype.toJSON = function (key) {
+
+            return isFinite(this.valueOf())
+                ? this.getUTCFullYear()     + '-' +
+                    f(this.getUTCMonth() + 1) + '-' +
+                    f(this.getUTCDate())      + 'T' +
+                    f(this.getUTCHours())     + ':' +
+                    f(this.getUTCMinutes())   + ':' +
+                    f(this.getUTCSeconds())   + 'Z'
+                : null;
+        };
+
+        String.prototype.toJSON      =
+            Number.prototype.toJSON  =
+            Boolean.prototype.toJSON = function (key) {
+                return this.valueOf();
+            };
+    }
+
+    var cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
+        escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
+        gap,
+        indent,
+        meta = {    // table of character substitutions
+            '\b': '\\b',
+            '\t': '\\t',
+            '\n': '\\n',
+            '\f': '\\f',
+            '\r': '\\r',
+            '"' : '\\"',
+            '\\': '\\\\'
+        },
+        rep;
+
+
+    function quote(string) {
+
+// If the string contains no control characters, no quote characters, and no
+// backslash characters, then we can safely slap some quotes around it.
+// Otherwise we must also replace the offending characters with safe escape
+// sequences.
+
+        escapable.lastIndex = 0;
+        return escapable.test(string) ? '"' + string.replace(escapable, function (a) {
+            var c = meta[a];
+            return typeof c === 'string'
+                ? c
+                : '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
+        }) + '"' : '"' + string + '"';
+    }
+
+
+    function str(key, holder) {
+
+// Produce a string from holder[key].
+
+        var i,          // The loop counter.
+            k,          // The member key.
+            v,          // The member value.
+            length,
+            mind = gap,
+            partial,
+            value = holder[key];
+
+// If the value has a toJSON method, call it to obtain a replacement value.
+
+        if (value && typeof value === 'object' &&
+                typeof value.toJSON === 'function') {
+            value = value.toJSON(key);
+        }
+
+// If we were called with a replacer function, then call the replacer to
+// obtain a replacement value.
+
+        if (typeof rep === 'function') {
+            value = rep.call(holder, key, value);
+        }
+
+// What happens next depends on the value's type.
+
+        switch (typeof value) {
+        case 'string':
+            return quote(value);
+
+        case 'number':
+
+// JSON numbers must be finite. Encode non-finite numbers as null.
+
+            return isFinite(value) ? String(value) : 'null';
+
+        case 'boolean':
+        case 'null':
+
+// If the value is a boolean or null, convert it to a string. Note:
+// typeof null does not produce 'null'. The case is included here in
+// the remote chance that this gets fixed someday.
+
+            return String(value);
+
+// If the type is 'object', we might be dealing with an object or an array or
+// null.
+
+        case 'object':
+
+// Due to a specification blunder in ECMAScript, typeof null is 'object',
+// so watch out for that case.
+
+            if (!value) {
+                return 'null';
+            }
+
+// Make an array to hold the partial results of stringifying this object value.
+
+            gap += indent;
+            partial = [];
+
+// Is the value an array?
+
+            if (Object.prototype.toString.apply(value) === '[object Array]') {
+
+// The value is an array. Stringify every element. Use null as a placeholder
+// for non-JSON values.
+
+                length = value.length;
+                for (i = 0; i < length; i += 1) {
+                    partial[i] = str(i, value) || 'null';
+                }
+
+// Join all of the elements together, separated with commas, and wrap them in
+// brackets.
+
+                v = partial.length === 0
+                    ? '[]'
+                    : gap
+                    ? '[\n' + gap + partial.join(',\n' + gap) + '\n' + mind + ']'
+                    : '[' + partial.join(',') + ']';
+                gap = mind;
+                return v;
+            }
+
+// If the replacer is an array, use it to select the members to be stringified.
+
+            if (rep && typeof rep === 'object') {
+                length = rep.length;
+                for (i = 0; i < length; i += 1) {
+                    if (typeof rep[i] === 'string') {
+                        k = rep[i];
+                        v = str(k, value);
+                        if (v) {
+                            partial.push(quote(k) + (gap ? ': ' : ':') + v);
+                        }
+                    }
+                }
+            } else {
+
+// Otherwise, iterate through all of the keys in the object.
+
+                for (k in value) {
+                    if (Object.prototype.hasOwnProperty.call(value, k)) {
+                        v = str(k, value);
+                        if (v) {
+                            partial.push(quote(k) + (gap ? ': ' : ':') + v);
+                        }
+                    }
+                }
+            }
+
+// Join all of the member texts together, separated with commas,
+// and wrap them in braces.
+
+            v = partial.length === 0
+                ? '{}'
+                : gap
+                ? '{\n' + gap + partial.join(',\n' + gap) + '\n' + mind + '}'
+                : '{' + partial.join(',') + '}';
+            gap = mind;
+            return v;
+        }
+    }
+
+// If the JSON object does not yet have a stringify method, give it one.
+
+    if (typeof JSON.stringify !== 'function') {
+        JSON.stringify = function (value, replacer, space) {
+
+// The stringify method takes a value and an optional replacer, and an optional
+// space parameter, and returns a JSON text. The replacer can be a function
+// that can replace values, or an array of strings that will select the keys.
+// A default replacer method can be provided. Use of the space parameter can
+// produce text that is more easily readable.
+
+            var i;
+            gap = '';
+            indent = '';
+
+// If the space parameter is a number, make an indent string containing that
+// many spaces.
+
+            if (typeof space === 'number') {
+                for (i = 0; i < space; i += 1) {
+                    indent += ' ';
+                }
+
+// If the space parameter is a string, it will be used as the indent string.
+
+            } else if (typeof space === 'string') {
+                indent = space;
+            }
+
+// If there is a replacer, it must be a function or an array.
+// Otherwise, throw an error.
+
+            rep = replacer;
+            if (replacer && typeof replacer !== 'function' &&
+                    (typeof replacer !== 'object' ||
+                    typeof replacer.length !== 'number')) {
+                throw new Error('JSON.stringify');
+            }
+
+// Make a fake root object containing our value under the key of ''.
+// Return the result of stringifying the value.
+
+            return str('', {'': value});
+        };
+    }
+
+
+// If the JSON object does not yet have a parse method, give it one.
+
+    if (typeof JSON.parse !== 'function') {
+        JSON.parse = function (text, reviver) {
+
+// The parse method takes a text and an optional reviver function, and returns
+// a JavaScript value if the text is a valid JSON text.
+
+            var j;
+
+            function walk(holder, key) {
+
+// The walk method is used to recursively walk the resulting structure so
+// that modifications can be made.
+
+                var k, v, value = holder[key];
+                if (value && typeof value === 'object') {
+                    for (k in value) {
+                        if (Object.prototype.hasOwnProperty.call(value, k)) {
+                            v = walk(value, k);
+                            if (v !== undefined) {
+                                value[k] = v;
+                            } else {
+                                delete value[k];
+                            }
+                        }
+                    }
+                }
+                return reviver.call(holder, key, value);
+            }
+
+
+// Parsing happens in four stages. In the first stage, we replace certain
+// Unicode characters with escape sequences. JavaScript handles many characters
+// incorrectly, either silently deleting them, or treating them as line endings.
+
+            text = String(text);
+            cx.lastIndex = 0;
+            if (cx.test(text)) {
+                text = text.replace(cx, function (a) {
+                    return '\\u' +
+                        ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
+                });
+            }
+
+// In the second stage, we run the text against regular expressions that look
+// for non-JSON patterns. We are especially concerned with '()' and 'new'
+// because they can cause invocation, and '=' because it can cause mutation.
+// But just to be safe, we want to reject all unexpected forms.
+
+// We split the second stage into 4 regexp operations in order to work around
+// crippling inefficiencies in IE's and Safari's regexp engines. First we
+// replace the JSON backslash pairs with '@' (a non-JSON character). Second, we
+// replace all simple value tokens with ']' characters. Third, we delete all
+// open brackets that follow a colon or comma or that begin the text. Finally,
+// we look to see that the remaining characters are only whitespace or ']' or
+// ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval.
+
+            if (/^[\],:{}\s]*$/
+                    .test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@')
+                        .replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']')
+                        .replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) {
+
+// In the third stage we use the eval function to compile the text into a
+// JavaScript structure. The '{' operator is subject to a syntactic ambiguity
+// in JavaScript: it can begin a block or an object literal. We wrap the text
+// in parens to eliminate the ambiguity.
+
+                j = eval('(' + text + ')');
+
+// In the optional fourth stage, we recursively walk the new structure, passing
+// each name/value pair to a reviver function for possible transformation.
+
+                return typeof reviver === 'function'
+                    ? walk({'': j}, '')
+                    : j;
+            }
+
+// If the text is not JSON parseable, then a SyntaxError is thrown.
+
+            throw new SyntaxError('JSON.parse');
+        };
+    }
+}());

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

@@ -7,7 +7,8 @@ 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 || Firehose.LongPoll.ieSupported()
+    if xhr = $.ajaxSettings.xhr()
+      "withCredentials" of xhr || Firehose.LongPoll.ieSupported()
 
   constructor: (args) ->
     super args
@@ -26,7 +27,7 @@ class Firehose.LongPoll extends Firehose.Transport
     @_okInterval = 0
 
     @_isConnected = false
-   
+
   connect: (delay = 0) =>
     unless @_isConnected
       @_isConnected = true
@@ -41,12 +42,34 @@ class Firehose.LongPoll extends Firehose.Transport
     data.last_message_sequence = @_lastMessageSequence
     # TODO: Some of these options will be deprecated in jQurey 1.8
     #       See: http://api.jquery.com/jQuery.ajax/#jqXHR
+
     $.ajax @config.longPoll.url,
       crossDomain: true
       data: data
       timeout: @_timeout
       success: @_success
       error: @_error
+      xhr: ->
+        # TODO - This while `xrh` attr is a stupid hack to deal with CORS short-comings in jQuery in Firefox.
+        # This ticket can be viewed at http://bugs.jquery.com/ticket/10338. Once jQuery is 
+        # upgraded to this version, we can probably remove this, but be sure you test the 
+        # crap out of Firefox!
+        #
+        # Its also worth noting that I had to localize this monkey-patch to the Firehose.LongPoll
+        # consumer because a previous global patch on jQuery.ajaxSettings.xhr was breaking regular IE7
+        # loading. I figured its better to localize this anyway to solve that problem and loading order issues.
+        xhr = jQuery.ajaxSettings.xhr()
+        getAllResponseHeaders = xhr.getAllResponseHeaders
+        xhr.getAllResponseHeaders = ->
+          allHeaders = getAllResponseHeaders.call(xhr)
+          return allHeaders if allHeaders
+          allHeaders = ""
+          for headerName in [ "Cache-Control", "Content-Language", "Content-Type", "Expires", "Last-Modified", "Pragma" ]
+            do (headerName) ->
+              allHeaders += headerName + ": " + xhr.getResponseHeader(headerName) + "\n"  if xhr.getResponseHeader(headerName)
+          allHeaders
+        xhr
+
       complete: (jqXhr) =>
         # Get the last sequence from the server if specified.
         if jqXhr.status == 200
@@ -62,7 +85,7 @@ class Firehose.LongPoll extends Firehose.Transport
     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 this case
@@ -86,7 +109,7 @@ class Firehose.LongPoll extends Firehose.Transport
   _error: (jqXhr, status, error) =>
     @_isConnected = false
     @config.disconnected()
-    
+
     # Ping the server to make sure this isn't a network connectivity error
     setTimeout @_ping, @_retryDelay + @_lagTime
 

data/lib/firehose.rb

@@ -1,19 +1,25 @@
-ENV['RACK_ENV'] ||= 'development'
+ENV['RACK_ENV'] ||= 'development' # TODO - Lets not rock out envs like its 1999.
 
 require 'firehose/version'
 require 'em-hiredis' # TODO Move this into a Redis module so that we can auto-load it. Lots of the CLI tools don't need this.
 require 'firehose/logging'
-require 'firehose/rails' if defined?(::Rails::Engine) # TODO Detect Sprockets instead of the jankin Rails::Engine test.
+
+# TODO - Figure if we need to have an if/else for Rails::Engine loading and Firehose::Assets::Sprockets.auto_detect
+require 'firehose/rails' if defined?(::Rails::Engine)
 
 module Firehose
   autoload :Subscriber,   'firehose/subscriber'
   autoload :Publisher,    'firehose/publisher'
   autoload :Producer,     'firehose/producer' # TODO Move this into the Firehose::Client namespace.
   autoload :Default,      'firehose/default'
+  autoload :Assets,       'firehose/assets'
   autoload :Rack,         'firehose/rack'
   autoload :CLI,          'firehose/cli'
   autoload :Client,       'firehose/client'
   autoload :Server,       'firehose/server'
   autoload :Channel,      'firehose/channel'
   autoload :SwfPolicyRequest, 'firehose/swf_policy_request'
-end
+end
+
+# Detect if Sprockets is loaded. If it is, lets configure Firehose to use it!
+Firehose::Assets::Sprockets.auto_detect

data/lib/firehose/assets.rb

@@ -0,0 +1,24 @@
+module Firehose
+  # Deal with bundling Sprocket assets into environments (like Rails or Sprockets)
+  module Assets
+    def self.path(*segs)
+      File.join File.expand_path('../../assets', __FILE__), segs
+    end
+
+    module Sprockets
+      # Drop flash and javascript paths to Firehose assets into a sprockets environment.
+      def self.configure(env)
+        env.append_path Firehose::Assets.path('flash')
+        env.append_path Firehose::Assets.path('javascripts')
+        env
+      end
+
+      # Try to automatically configure Sprockets if its detected in the project.
+      def self.auto_detect
+        if defined? ::Sprockets and ::Sprockets.respond_to? :append_path
+          Firehose::Assets::Sprockets.configure ::Sprockets
+        end
+      end
+    end
+  end
+end

data/lib/firehose/cli.rb

@@ -41,26 +41,29 @@ module Firehose
     end
 
     desc "publish URI [PAYLOAD]", "Publish messages to a resource."
+    method_option :ttl, :type => :numeric, :aliases => '-t'
+    method_option :times, :type => :numeric, :aliases => '-n', :default => 1
     method_option :interval, :type => :numeric, :aliases => '-i'
-    method_option :times, :type => :numeric, :aliases => '-n'
+
     def publish(uri, payload=nil)
       payload     ||= $stdin.read
       client      = Firehose::Producer.new(uri)
       path        = URI.parse(uri).path
       times       = options[:times]
+      ttl         = options[:ttl]
 
       EM.run do
         # TODO I think this can be cleaned up so the top-level if/else can be ditched.
         if interval = options[:interval]
           # Publish messages at a forced interval.
-          EM.add_periodic_timer interval do 
-            client.publish(payload).to(path)
+          EM.add_periodic_timer interval do
+            client.publish(payload).to(path, :ttl => ttl)
             EM.stop if times && (times-=1).zero?
           end
         else
           # Publish messages as soon as the last message was published.
           worker = Proc.new do
-            client.publish(payload).to(path)
+            client.publish(payload).to(path, :ttl => ttl)
             times && (times-=1).zero? ? EM.stop : worker.call
           end
           worker.call

data/lib/firehose/producer.rb

@@ -20,8 +20,8 @@ module Firehose
         self
       end
 
-      def to(channel, &callback)
-        @producer.put(@message, channel, &callback)
+      def to(channel, opts={}, &callback)
+        @producer.put(@message, channel, opts, &callback)
       end
     end
 
@@ -39,11 +39,14 @@ module Firehose
     end
 
     # Publish the message via HTTP.
-    def put(message, channel, &block)
+    def put(message, channel, opts, &block)
+      ttl = opts[:ttl]
+
       response = conn.put do |req|
         req.options[:timeout] = Timeout
         req.path = channel
         req.body = message
+        req.headers['Cache-Control'] = "max-age=#{ttl.to_i}" if ttl
       end
       response.on_complete do
         case response.status

data/lib/firehose/publisher.rb

@@ -4,7 +4,10 @@ module Firehose
     TTL = 60*60*24  # 1 day of time, yay!
     PAYLOAD_DELIMITER = "\n"
 
-    def publish(channel_key, message)
+    def publish(channel_key, message, opts={})
+      # How long should we hang on to the resource once is published?
+      ttl = (opts[:ttl] || TTL).to_i
+
       # TODO hi-redis isn't that awesome... we have to setup an errback per even for wrong
       # commands because of the lack of a method_missing whitelist. Perhaps implement a whitelist in
       # em-hiredis or us a diff lib?
@@ -22,10 +25,10 @@ module Firehose
                    end
                    local sequence = current_sequence + 1
                    redis.call('set', KEYS[1], sequence)
-                   redis.call('expire', KEYS[1], #{TTL})
+                   redis.call('expire', KEYS[1], #{ttl})
                    redis.call('lpush', KEYS[2], "#{lua_escape(message)}")
                    redis.call('ltrim', KEYS[2], 0, #{MAX_MESSAGES - 1})
-                   redis.call('expire', KEYS[2], #{TTL})
+                   redis.call('expire', KEYS[2], #{ttl})
                    redis.call('publish', KEYS[3], "#{lua_escape(channel_key + PAYLOAD_DELIMITER)}" .. sequence .. "#{lua_escape(PAYLOAD_DELIMITER + message)}")
                    return sequence
                   ), 3, sequence_key, list_key, key(:channel_updates)).

data/lib/firehose/rack/publisher_app.rb

@@ -7,12 +7,26 @@ module Firehose
         req     = env['parsed_request'] ||= ::Rack::Request.new(env)
         path    = req.path
         method  = req.request_method
+        cache_control = {}
+
+        # Parse out cache control directives from the Cache-Control header.
+        if cache_control_header = env['HTTP_CACHE_CONTROL']
+          cache_control = cache_control_header.split(',').map(&:strip).inject({}) do |memo, directive|
+            key, value = directive.split('=')
+            memo[key.downcase] = value
+            memo
+          end
+        end
+
+        # Read the max-age directive from the cache so that we can set a TTL on the redis key. This will
+        # prevent stale content from being served up to the client.
+        ttl = cache_control['max-age']
 
         if method == 'PUT'
           EM.next_tick do
             body = env['rack.input'].read
-            Firehose.logger.debug "HTTP published `#{body}` to `#{path}`"
-            publisher.publish(path, body).callback do
+            Firehose.logger.debug "HTTP published #{body.inspect} to #{path.inspect} with ttl #{ttl.inspect}"
+            publisher.publish(path, body, :ttl => ttl).callback do
               env['async.callback'].call [202, {'Content-Type' => 'text/plain', 'Content-Length' => '0'}, []]
               env['async.callback'].call response(202, '', 'Content-Type' => 'text/plain')
             end.errback do |e|
@@ -30,8 +44,7 @@ module Firehose
         end
       end
 
-
-      private
+    private
       def publisher
         @publisher ||= Firehose::Publisher.new
       end

data/lib/firehose/version.rb

@@ -1,4 +1,4 @@
 module Firehose
-  VERSION = "0.2.alpha.3"
-  CODENAME = "Timeout!"
+  VERSION = "0.2.alpha.5"
+  CODENAME = "Time To Live (it up?)"
 end

data/spec/lib/assets_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'sprockets'
+
+describe Firehose::Assets do
+  describe ".path" do
+    it "should have root path" do
+      Firehose::Assets.path('poop').should == File.expand_path('../../../lib/assets/poop', __FILE__)
+    end
+
+    it "should accept folders" do
+      Firehose::Assets.path('poop').should == File.join(Firehose::Assets.path, 'poop')
+    end
+  end
+
+  describe "Sprockets.configure" do
+    it "should configure environment" do
+      env = Firehose::Assets::Sprockets.configure Sprockets::Environment.new
+      env.paths.should include(Firehose::Assets.path('flash'),  Firehose::Assets.path('javascripts'))
+    end
+  end
+end

data/spec/lib/producer_spec.rb

@@ -21,6 +21,14 @@ describe Firehose::Producer do
     WebMock.should have_requested(:put, url).with { |req| req.body == message }
   end
 
+  it "should publish message to channel with expiry headers" do
+    publish_stub.to_return(:body => "", :status => 202)
+    ttl = 20
+
+    Firehose::Producer.new.publish(message).to(channel, :ttl => ttl)
+    WebMock.should have_requested(:put, url).with { |req| req.body == message and req.headers['Cache-Control'] == "max-age=#{ttl}" }
+  end
+
   describe "connection error handling" do
     it "should raise PublishError if not 201" do
       publish_stub.to_return(:body => "", :status => 500)

data/spec/lib/publisher_spec.rb

@@ -28,7 +28,6 @@ describe Firehose::Publisher do
       end
     end
 
-
     "\"'\r\t\n!@\#$%^&*()[]\v\f\a\b\e{}/=?+\\|".each_char do |char|
       it "should publish messages with the '#{char.inspect}' character" do
         msg = [char, message, char].join
@@ -69,14 +68,17 @@ describe Firehose::Publisher do
     end
 
     it "should set expirery on sequence and list keys" do
+      ttl = 78 # Why 78? Why not!
+
       em do
-        publisher.publish(channel_key, message).callback do
+        publisher.publish(channel_key, message, :ttl => 78).callback do
           # Allow for 1 second of slippage/delay
-          redis_exec('TTL', "firehose:#{channel_key}:sequence").should > (Firehose::Publisher::TTL - 1)
-          redis_exec('TTL', "firehose:#{channel_key}:list").should > (Firehose::Publisher::TTL - 1)
+          redis_exec('TTL', "firehose:#{channel_key}:sequence").should > (ttl- 1)
+          redis_exec('TTL', "firehose:#{channel_key}:list").should > (ttl - 1)
           em.stop
         end
       end
     end
+
   end
 end

data/spec/lib/rack/publisher_app_spec.rb

@@ -22,5 +22,13 @@ describe Firehose::Rack::PublisherApp, :type => :request do
       aput path, :body => "some nice little message"
       last_response.headers['Content-Length'].should == '0'
     end
+
+    it "should parse Cache-Control max-age" do
+      body = "howdy dude!"
+      ttl = '92'
+
+      Firehose::Publisher.any_instance.stub(:publish).with(path, body, :ttl => ttl).and_return(deferrable)
+      aput path, body, 'HTTP_CACHE_CONTROL' => 'max-age=92'
+    end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 0.2.alpha.3
+  version: 0.2.alpha.5
   prerelease: 4
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70273542312980 !ruby/object:Gem::Requirement
+  requirement: &70227705301260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.0.rc
   type: :runtime
   prerelease: false
-  version_requirements: *70273542312980
+  version_requirements: *70227705301260
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &70273542312560 !ruby/object:Gem::Requirement
+  requirement: &70227705300800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70273542312560
+  version_requirements: *70227705300800
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70273542312100 !ruby/object:Gem::Requirement
+  requirement: &70227705300260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70273542312100
+  version_requirements: *70227705300260
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70273542311680 !ruby/object:Gem::Requirement
+  requirement: &70227705299800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70273542311680
+  version_requirements: *70227705299800
 - !ruby/object:Gem::Dependency
   name: faye-websocket
-  requirement: &70273542311260 !ruby/object:Gem::Requirement
+  requirement: &70227705299260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70273542311260
+  version_requirements: *70227705299260
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70273542310760 !ruby/object:Gem::Requirement
+  requirement: &70227705298620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -78,10 +78,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70273542310760
+  version_requirements: *70227705298620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70273542310340 !ruby/object:Gem::Requirement
+  requirement: &70227705297680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542310340
+  version_requirements: *70227705297680
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70273542309880 !ruby/object:Gem::Requirement
+  requirement: &70227705340680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542309880
+  version_requirements: *70227705340680
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70273542309460 !ruby/object:Gem::Requirement
+  requirement: &70227705340080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542309460
+  version_requirements: *70227705340080
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70273542309040 !ruby/object:Gem::Requirement
+  requirement: &70227705339180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -122,10 +122,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542309040
+  version_requirements: *70227705339180
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: &70273542308620 !ruby/object:Gem::Requirement
+  requirement: &70227705338480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +133,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542308620
+  version_requirements: *70227705338480
 - !ruby/object:Gem::Dependency
   name: rainbows
-  requirement: &70273542308200 !ruby/object:Gem::Requirement
+  requirement: &70227705337780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542308200
+  version_requirements: *70227705337780
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70273542307780 !ruby/object:Gem::Requirement
+  requirement: &70227705337360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -155,10 +155,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542307780
+  version_requirements: *70227705337360
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70273542307360 !ruby/object:Gem::Requirement
+  requirement: &70227705336940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542307360
+  version_requirements: *70227705336940
 - !ruby/object:Gem::Dependency
   name: async_rack_test
-  requirement: &70273542306940 !ruby/object:Gem::Requirement
+  requirement: &70227705336480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542306940
+  version_requirements: *70227705336480
 - !ruby/object:Gem::Dependency
   name: foreman
-  requirement: &70273542306520 !ruby/object:Gem::Requirement
+  requirement: &70227705336020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,7 +188,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273542306520
+  version_requirements: *70227705336020
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: &70227705335600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227705335600
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
@@ -216,13 +227,14 @@ files:
 - lib/assets/javascripts/firehose.js.coffee
 - lib/assets/javascripts/firehose/base.js.coffee
 - lib/assets/javascripts/firehose/consumer.js.coffee
-- lib/assets/javascripts/firehose/lib/jquery.cors.headers.js.coffee
+- lib/assets/javascripts/firehose/json2.js
 - lib/assets/javascripts/firehose/lib/swfobject.js
 - lib/assets/javascripts/firehose/lib/web_socket.js
 - 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/assets.rb
 - lib/firehose/channel.rb
 - lib/firehose/cli.rb
 - lib/firehose/client.rb
@@ -245,6 +257,7 @@ files:
 - spec/integrations/rainbows_spec.rb
 - spec/integrations/shared_examples.rb
 - spec/integrations/thin_spec.rb
+- spec/lib/assets_spec.rb
 - spec/lib/broker_spec.rb
 - spec/lib/channel_spec.rb
 - spec/lib/client_spec.rb
@@ -286,6 +299,7 @@ test_files:
 - spec/integrations/rainbows_spec.rb
 - spec/integrations/shared_examples.rb
 - spec/integrations/thin_spec.rb
+- spec/lib/assets_spec.rb
 - spec/lib/broker_spec.rb
 - spec/lib/channel_spec.rb
 - spec/lib/client_spec.rb

data/lib/assets/javascripts/firehose/lib/jquery.cors.headers.js.coffee

@@ -1,16 +0,0 @@
-_super = jQuery.ajaxSettings.xhr
-
-jQuery.ajaxSettings.xhr = ->
-  xhr = _super()
-  getAllResponseHeaders = xhr.getAllResponseHeaders
-  xhr.getAllResponseHeaders = ->
-    allHeaders = getAllResponseHeaders.call(xhr)
-    return allHeaders if allHeaders
-
-    allHeaders = ""
-    for headerName in [ "Cache-Control", "Content-Language", "Content-Type", "Expires", "Last-Modified", "Pragma" ]
-      do (headerName) ->
-        allHeaders += headerName + ": " + xhr.getResponseHeader(headerName) + "\n"  if xhr.getResponseHeader(headerName)
-
-    allHeaders
-  xhr