firehose 1.2.20 → 1.3.6

data/karma.config.coffee

@@ -0,0 +1,89 @@
+# Karma configuration
+# Generated on Mon Jul 07 2014 12:32:37 GMT-0700 (PDT)
+module.exports = (config) ->
+  config.set
+    # base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: ""
+
+    # frameworks to use
+    # available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: [
+      "sprockets-mincer"
+      "jasmine"
+    ]
+
+    # list of files / patterns to load in the browser
+    files: []
+
+    # list of files to exclude
+    exclude: []
+
+    # preprocess matching files before serving them to the browser
+    # available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors:
+      "**/*.coffee": ["coffee"]
+
+    # test results reporter to use
+    # possible values: 'dots', 'progress'
+    # available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ["progress", "dots"]
+
+    # web server port
+    port: 9876
+
+    # enable / disable colors in the output (reporters and logs)
+    colors: true
+
+    # level of logging
+    # possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO
+
+    # enable / disable watching file and executing tests whenever any file changes
+    autoWatch: true
+
+    # start these browsers
+    # available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: ["Chrome", "PhantomJS"]
+
+    # Continuous Integration mode
+    # if true, Karma captures browsers, runs the tests and exits
+    singleRun: false
+
+    plugins: [
+      "karma-jasmine"
+      "karma-chrome-launcher"
+      "karma-coffee-preprocessor"
+      "karma-sprockets-mincer"
+      "karma-phantomjs-launcher"
+      "karma-junit-reporter"
+    ]
+
+    sprocketsPaths: [
+      "lib/assets/javascripts"
+      "spec/javascripts"
+    ]
+
+    sprocketsBundles: [
+      "support/spec_helper.coffee"
+      "firehose.js.coffee"
+    ]
+
+    # The spec files to run and watch changes for
+    files: [
+      'spec/javascripts/**/*_spec.coffee'
+    ]
+
+    junitReporter: {
+      outputFile: 'tmp/spec-results.xml',
+      suite: ''
+    }
+
+    coffeePreprocessor:
+      # options passed to the coffee compiler
+      options:
+        bare: true
+        sourceMap: false
+
+      # transforming the filenames
+      transformPath: (path) ->
+        path.replace /\.js\.coffee$/, ".js"

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

@@ -1,3 +1,2 @@
 #= require firehose/core
-#= require firehose/version
-#= require vendor/json2
+#= require firehose/version

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

@@ -18,19 +18,35 @@ 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        ||= JSON.parse
+
+    @_isConnected = false
+    origConnected = @config.connected
+    @config.connected = =>
+      @_isConnected = true
+      origConnected()
+
     # Make sure we return ourself out of the constructor so we can chain.
     this
 
+  connected: =>
+    @_isConnected
+
+  websocketTransport: (config) =>
+    new Firehose.WebSocket(config)
+
+  longpollTransport: (config) =>
+    new Firehose.LongPoll(config)
+
   connect: (delay=0) =>
     promise = @_connectPromise()
 
     @config.connectionVerified = @_upgradeTransport
     if Firehose.WebSocket.supported()
       @upgradeTimeout = setTimeout =>
-        ws = new Firehose.WebSocket @config
+        ws = @websocketTransport(@config)
         ws.connect delay
       , 500
-    @transport = new Firehose.LongPoll @config
+    @transport = @longpollTransport(@config)
     @transport.connect delay
 
     promise

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

@@ -2,4 +2,5 @@
 #= require ./transport
 #= require ./long_poll
 #= require ./web_socket
-#= require ./consumer
+#= require ./consumer
+#= require ./multiplexed_consumer

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

@@ -25,10 +25,11 @@ class Firehose.LongPoll extends Firehose.Transport
     @config.longPoll.timeout ||= 25000
     # 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.longPoll.timeout + @_lagTime
-    @_okInterval      = @config.okInterval || 0
-    @_stopRequestLoop = false
+    @_lagTime                  = 5000
+    @_timeout                  = @config.longPoll.timeout + @_lagTime
+    @_okInterval               = @config.okInterval || 0
+    @_stopRequestLoop          = false
+    @_lastMessageSequence      = 0
 
   # Protocol schema we should use for talking to firehose server.
   _protocol: =>
@@ -39,7 +40,7 @@ class Firehose.LongPoll extends Firehose.Transport
     # Set the Last Message Sequence in a query string.
     # Ideally we'd use an HTTP header, but android devices don't let us
     # set any HTTP headers for CORS requests.
-    data = @config.params
+    data = @_requestParams()
     data.last_message_sequence = @_lastMessageSequence
     # TODO: Some of these options will be deprecated in jQuery 1.8
     #       See: http://api.jquery.com/jQuery.ajax/#jqXHR
@@ -53,6 +54,9 @@ class Firehose.LongPoll extends Firehose.Transport
       error:        @_error
       cache:        false
 
+  _requestParams: =>
+    @config.params
+
   stop: =>
     @_stopRequestLoop = true
     if @_lastRequest?
@@ -71,7 +75,7 @@ class Firehose.LongPoll extends Firehose.Transport
       # Of course, IE's XDomainRequest doesn't support non-200 success codes.
       try
         {message, last_sequence} = JSON.parse jqXhr.responseText
-        @_lastMessageSequence    = last_sequence
+        @_lastMessageSequence    = last_sequence || 0
         @config.message @config.parse message
       catch e
     @connect @_okInterval
@@ -81,11 +85,11 @@ class Firehose.LongPoll extends Firehose.Transport
     # jQuery CORS doesn't support timeouts and there is no way to access xhr2 object
     # directly so we can't manually set a timeout.
     @_lastPingRequest = $.ajax
-      url:          @config.longPoll.url
+      url:          @config.uri
       method:       'HEAD'
       crossDomain:  true
       firehose:     true
-      data:         @config.params
+      data:         @_requestParams()
       success:      =>
         if @_needToNotifyOfReconnect
           @_needToNotifyOfReconnect = false
@@ -147,3 +151,60 @@ if $?.browser?.msie and parseInt($.browser.version, 10) in [8, 9]
             xdr.onerror = jQuery.noop()
             xdr.abort()
       }
+
+class Firehose.MultiplexedLongPoll extends Firehose.LongPoll
+  constructor: (args) ->
+    super args
+    @_lastMessageSequence = {}
+
+  subscribe: (channel, opts) =>
+    # nothing to be done
+
+  unsubscribe: (channelNames...) =>
+    # same here
+
+  _request: =>
+    return if @_stopRequestLoop
+    data = @_subscriptions()
+
+    @_lastRequest = $.ajax
+      url:          @config.uri
+      firehose:     true
+      crossDomain:  true
+      method:       "POST"
+      data:         data
+      dataType:     "json"
+      timeout:      @_timeout
+      success:      @_success
+      error:        @_error
+      cache:        false
+
+  _updateLastMessageSequences: =>
+    for channel, opts of @config.channels
+      if seq = @_lastMessageSequence[channel]
+        opts.last_sequence = seq
+      else
+        unless opts.last_sequence
+          opts.last_sequence = 0
+
+  _subscriptions: =>
+    @_updateLastMessageSequences()
+    subs = {}
+    for channel, opts of @config.channels
+      subs[channel] = opts.last_sequence || 0
+    JSON.stringify(subs)
+
+  _success: (data, status, jqXhr) =>
+    if @_needToNotifyOfReconnect or not @_succeeded
+      @_needToNotifyOfReconnect = false
+      @_open data
+    return if @_stopRequestLoop
+    if jqXhr.status is 200
+      # Of course, IE's XDomainRequest doesn't support non-200 success codes.
+      try
+        message = JSON.parse jqXhr.responseText
+        @_lastMessageSequence ||= {}
+        @_lastMessageSequence[message.channel] = message.last_sequence
+        @config.message message
+      catch e
+    @connect @_okInterval

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

@@ -0,0 +1,74 @@
+Firehose.multiplexChannel = "channels@firehose"
+
+class Firehose.MultiplexedConsumer extends Firehose.Consumer
+  @subscriptionQuery: (config) ->
+    {
+      subscribe: [
+        "#{channel}!#{opts.last_sequence || 0}" for channel, opts of config.channels
+      ].join(",")
+    }
+
+  @normalizeChannels: (config) ->
+    for chan, opts of config.channels
+      if chan[0] != "/"
+        delete config.channels[chan]
+        config.channels["/" + chan] = opts
+
+  @normalizeChannel: (channel) ->
+    if channel[0] != "/"
+      return "/" + channel
+    else
+      return channel
+
+  constructor: (@config = {}) ->
+    @messageHandlers = {}
+    @config.message ||= @message
+    @config.channels ||= {}
+    @config.uri += Firehose.multiplexChannel
+
+    @_updateSubscriptions()
+
+    for channel, opts of @config.channels
+      @_addSubscriptionHandler(channel, opts)
+
+    super(@config)
+
+  websocketTransport: (config) =>
+    new Firehose.MultiplexedWebSocket(config)
+
+  longpollTransport: (config) =>
+    new Firehose.MultiplexedLongPoll(config)
+
+  message: (msg) =>
+    if handler = @messageHandlers[msg.channel]
+      handler(@config.parse msg.message)
+
+  _addSubscriptionHandler: (channel, opts) =>
+    if opts.message
+      @messageHandlers[channel] = opts.message
+
+  _removeSubscriptionHandler: (channelNames...) =>
+    for chan in channelNames
+      delete @messageHandlers[chan]
+
+  _updateSubscriptions: =>
+    Firehose.MultiplexedConsumer.normalizeChannels(@config)
+
+  subscribe: (channel, opts = {}) =>
+    channel = Firehose.MultiplexedConsumer.normalizeChannel(channel)
+    @config.channels[channel] = opts
+
+    @_updateSubscriptions()
+    @_addSubscriptionHandler(channel, opts)
+    @transport.subscribe(channel, opts)
+
+  unsubscribe: (channelNames...) =>
+    return unless @connected()
+
+    for channel in channelNames
+      channel = Firehose.MultiplexedConsumer.normalizeChannel(channel)
+      delete @config.channels[channel]
+
+    @_updateSubscriptions()
+    @_removeSubscriptionHandler(channelNames...)
+    @transport.unsubscribe(channelNames...)

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

@@ -1,12 +1,14 @@
 class Firehose.Transport
   # Class method to determine whether transport is supported by the current browser. Note that while
-  # the transport may be supported by the browser, its possible that the network connection won't 
+  # the transport may be supported by the browser, its possible that the network connection won't
   # succeed. That should be accounted for during the initial connecting to the server.
   @supported: =>
     false
 
   constructor: (config={}) ->
-    @config      = config
+    @config = config
+    @config.params ||= {}
+
     @_retryDelay = 3000
     @
 

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

@@ -13,11 +13,14 @@ class Firehose.WebSocket extends Firehose.Transport
     @config.webSocket ||= {}
     @config.webSocket.connectionVerified = @config.connectionVerified
 
+  _sendMessage: (message) =>
+    @socket?.send(JSON.stringify message)
+
   _request: =>
-    # Run this is a try/catch block because IE10 inside of a .NET control
+    # Run this in a try/catch block because IE10 inside of a .NET control
     # complains about security zones.
     try
-      @socket = new (if module?.exports? then global else window).WebSocket "#{@_protocol()}:#{@config.uri}?#{$.param @config.params}"
+      @socket = new (if module?.exports? then global else window).WebSocket "#{@_protocol()}:#{@config.uri}?#{$.param @_requestParams()}"
       @socket.onopen    = @_open
       @socket.onclose   = @_close
       @socket.onerror   = @_error
@@ -29,6 +32,9 @@ class Firehose.WebSocket extends Firehose.Transport
   _protocol: =>
     if @config.ssl then "wss" else "ws"
 
+  _requestParams: =>
+    @config.params
+
   _open: =>
     sendPing @socket
 
@@ -43,7 +49,7 @@ class Firehose.WebSocket extends Firehose.Transport
   sendStartingMessageSequence: (message_sequence) =>
     @_lastMessageSequence = message_sequence
     @socket.onmessage     = @_message
-    @socket.send JSON.stringify {message_sequence}
+    @_sendMessage({message_sequence})
     @_needToNotifyOfDisconnect = true
     Firehose.Transport::_open.call @
 
@@ -68,8 +74,10 @@ class Firehose.WebSocket extends Firehose.Transport
     if @_needToNotifyOfDisconnect
       @_needToNotifyOfDisconnect = false
       @config.disconnected()
-    if @_succeeded then @connect @_retryDelay
-    else @config.failed @
+    if @_succeeded
+      @connect @_retryDelay
+    else if @config.failed
+      @config.failed @
 
   _cleanUp: =>
     @_clearKeepalive()
@@ -95,6 +103,44 @@ class Firehose.WebSocket extends Firehose.Transport
       clearTimeout @keepaliveTimeout
       @keepaliveTimeout = null
 
+class Firehose.MultiplexedWebSocket extends Firehose.WebSocket
+  constructor: (args) ->
+    super args
+
+  subscribe: (channel, opts) =>
+    @_sendMessage
+      multiplex_subscribe:
+        channel: channel
+        message_sequence: opts.last_sequence
+
+  unsubscribe: (channelNames...) =>
+    @_sendMessage
+      multiplex_unsubscribe: channelNames
+
+  getLastMessageSequence: =>
+    @_lastMessageSequence or {}
+
+  _open: =>
+    super()
+    for channel, opts of @config.channels
+      if @_lastMessageSequence
+        opts.last_sequence = @_lastMessageSequence[channel]
+
+      unless opts.last_sequence
+        opts.last_sequence = 0
+
+      @subscribe channel, opts
+
+  _message: (event) =>
+    frame = @config.parse event.data
+    @_restartKeepAlive()
+    unless isPong frame
+      try
+        @_lastMessageSequence ||= {}
+        @_lastMessageSequence[frame.channel] = frame.last_sequence
+        @config.message frame
+      catch e
+
 sendPing = (socket) ->
   socket.send JSON.stringify ping: 'PING'
 

data/lib/firehose/cli.rb

@@ -16,7 +16,8 @@ module Firehose
 
     desc "javascript", "Compile the Firehose JavaScript."
     def javascript
-      puts Firehose::Assets::Sprockets.javascript
+      $stderr.puts "DEPRECATION WARNING: Firehose JS assets have been moved to https://github.com/firehoseio/js_client"
+      $stdout.puts Firehose::Assets::Sprockets.javascript
     end
 
     desc "version", "Display the current version."