websocket-rails 0.6.2 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f431734036d380cfcb865a9db8dd0cb57a8b0e0
+  data.tar.gz: 5c68a9bd3f5bffd6ba001521f914c7118613e5f3
+SHA512:
+  metadata.gz: 3171366f6a8d400adcfd0b5bcf83baed9abe8d34985122503f49b698002a8842ff5bde5cdd5d4c5b35c39056e01bc8f8a46c812d7cbd4eaa51ffc11c330ffc20
+  data.tar.gz: dd0eddf5584f3a22e2f30fd207c83f7355e0ca5351577aedbf074efa597c278fb117d673d308abcbc9bf904a3ccfd5f9a67c4034df386027b110a218c7a9f151

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # WebsocketRails Change Log
 
+## Version 0.7.0
+
+March 14 2014
+
+* Add verification of parsing results in Event. (Prevents a possible
+  denial of service attack when sending improperly formatted but valid
+  JSON. Thanks to @maharifu
+
+* Support HTTP streaming for Internet Explorer versions 8+ by using
+  XDomainRequest - Thanks to @lkol
+
+* Added a possibility to set channel success and failure callbacks on
+  subscribe. - Thanks to @lkol
+
+* Rescue symbolizing of channel names. fixes #166 - Thanks to @KazW
+
+* Refactor *.coffee files. Add reconnect() method. - Thanks to @jtomaszewski
+
+* Add Channel tokens to prevent unauthorized subscriptions to channels.
+  Thanks - @moaa and @elthariel
+
+* Fixed a bug where a newline was being outputted in the log regardless of log level - Thanks to @markmalek
+
+* Properly handle WSS and WS protocols in the JavaScript client - Thanks
+  to @markee
+
+* Defer #on_open to EM.next_tick. fixes #135 - Thanks to @moaa
+
+* Add subscriber Join/Part events for channels - Thanks to @moaa
+
+* Convert controller's `action_name` to a string to get AbstractController::Callbacks (`before_action`) working properly [fixes #150] - Thanks to @Pitr
+
 ## Version 0.6.2
 
 September 8 2013

data/Gemfile

@@ -2,11 +2,12 @@ source "http://rubygems.org"
 
 gemspec
 
-gem "rspec-rails", ">=2.12.0"
+gem "rspec-rails", ">=2.14.0"
 gem "therubyrhino"
 gem "therubyracer"
 gem "jasmine"
 gem "headless"
+gem "selenium-webdriver"
 gem "coffee-script"
 gem "thin"
 gem "eventmachine"

data/README.md

@@ -1,8 +1,9 @@
 # Websocket-Rails
 
-[![Build Status](https://secure.travis-ci.org/DanKnox/websocket-rails.png)](https://secure.travis-ci.org/DanKnox/websocket-rails)
+[![Build Status](https://travis-ci.org/websocket-rails/websocket-rails.png?branch=master)](https://travis-ci.org/websocket-rails/websocket-rails)
 
-If you haven't done so yet, check out the [Project Page](http://danknox.github.com/websocket-rails/) to get a feel for the project direction. Feedback is very much appreciated. Post an issue on the issue tracker or [shoot us an email](mailto:support@threedotloft.com) to give us your thoughts.
+If you haven't done so yet, check out the [Project
+Page](http://websocket-rails.github.io) to get a feel for the project direction. Feedback is very much appreciated. Post an issue on the issue tracker or [shoot us an email](mailto:support@threedotloft.com) to give us your thoughts.
 
 **Find us on IRC #websocket-rails**
 
@@ -11,17 +12,10 @@ questions.
 
 ## Recent Updates
 
-Check out the [CHANGELOG](https://github.com/DanKnox/websocket-rails/blob/master/CHANGELOG.md) to find out what's new.
+Check out the [CHANGELOG](https://github.com/websocket-rails/websocket-rails/blob/master/CHANGELOG.md) to find out what's new.
 
 As of version 0.2.0, non event machine based web servers such as Phusion
-Passenger are supported through the use of the [Standalone Server Mode](https://github.com/DanKnox/websocket-rails/wiki/Standalone-Server-Mode).
-
-**Note About Development**
-
-I am currently seeking a co-maintainer for this project. My time has
-been limited recently and I have not been as attentive to issues and
-feature requests as I would like. If you are interested in helping out
-please send me an email or post a message on the issue tracker.
+Passenger are supported through the use of the [Standalone Server Mode](https://github.com/websocket-rails/websocket-rails/wiki/Standalone-Server-Mode).
 
 ## Overview
 
@@ -33,23 +27,21 @@ just about any browser with Flash sockets.
 
 ## Installation and Usage Guides
 
-Check out the [Example Application](https://github.com/DanKnox/websocket-rails-Example-Project) for an example implementation.
-
 * [Installation
-  Guide](https://github.com/DanKnox/websocket-rails/wiki/Installation-and-Setup)
+  Guide](https://github.com/websocket-rails/websocket-rails/wiki/Installation-and-Setup)
 * [Event
-  Router](https://github.com/DanKnox/websocket-rails/wiki/The-Event-Router)
-* [WebsocketRails Controllers](https://github.com/DanKnox/websocket-rails/wiki/WebsocketRails Controllers)
+  Router](https://github.com/websocket-rails/websocket-rails/wiki/The-Event-Router)
+* [WebsocketRails Controllers](https://github.com/websocket-rails/websocket-rails/wiki/WebsocketRails Controllers)
 * [Using the JavaScript
-  Client](https://github.com/DanKnox/websocket-rails/wiki/Using-the-JavaScript-Client)
+  Client](https://github.com/websocket-rails/websocket-rails/wiki/Using-the-JavaScript-Client)
 * [Using
-  Channels](https://github.com/DanKnox/websocket-rails/wiki/Working-with-Channels)
-* [Using Private Channels](https://github.com/DanKnox/websocket-rails/wiki/Using-Private-Channels)
+  Channels](https://github.com/websocket-rails/websocket-rails/wiki/Working-with-Channels)
+* [Using Private Channels](https://github.com/websocket-rails/websocket-rails/wiki/Using-Private-Channels)
 * [The
-  DataStore](https://github.com/DanKnox/websocket-rails/wiki/Using-the-DataStore)
-* [Reloading Controllers In Development](https://github.com/DanKnox/websocket-rails/wiki/Reloading-Controllers-In-Development)
-* [Multiple Servers and Background Jobs](https://github.com/DanKnox/websocket-rails/wiki/Multiple-Servers-and-Background-Jobs)
-* [Standalone Server Mode](https://github.com/DanKnox/websocket-rails/wiki/Standalone-Server-Mode)
+  DataStore](https://github.com/websocket-rails/websocket-rails/wiki/Using-the-DataStore)
+* [Reloading Controllers In Development](https://github.com/websocket-rails/websocket-rails/wiki/Reloading-Controllers-In-Development)
+* [Multiple Servers and Background Jobs](https://github.com/websocket-rails/websocket-rails/wiki/Multiple-Servers-and-Background-Jobs)
+* [Standalone Server Mode](https://github.com/websocket-rails/websocket-rails/wiki/Standalone-Server-Mode)
 
 ## Handle Events With Class
 
@@ -211,23 +203,26 @@ WebsocketRails[:secret_posts].make_private
 On the client side, you can use the `dispatcher.subscribe_private()`
 method to subscribe to a private channel.
 
-Read the [Private Channel Wiki](https://github.com/DanKnox/websocket-rails/wiki/Using-Private-Channels) for more information on subscribing to
-private channels from the JavaScript client and handling the
-authorization in your controller.
+Read the [Private Channel Wiki](https://github.com/websocket-rails/websocket-rails/wiki/Using-Private-Channels) for more information on subscribing to private channels from the JavaScript client and handling the authorization in your controller.
 
 ## Credit where credit is due
 
-Big thanks to our
-[contributors](https://github.com/DanKnox/websocket-rails/graphs/contributors)
-who have helped keep this project moving.
+Big thanks to our [contributors](https://github.com/websocket-rails/websocket-rails/graphs/contributors) who have helped keep this project moving.
 
-Special thanks to [@nessche](https://github.com/nessche) who provided the improved routing DSL and
-RSpec matcher suite.
+Special thanks to [@nessche](https://github.com/nessche) who provided the improved routing DSL and RSpec matcher suite.
+
+The `websocket-rails` organization logo was kindly provided by [Uken Games](http://www.uken.com/).
 
 ## Development
 
-This gem is created and maintained by Dan Knox and Kyle Whalen under the MIT License.
+Please check out the [Development Guide](https://github.com/websocket-rails/websocket-rails/wiki/Development) if you are interested in contributing. It should cover everything you need to get up and running.
+
+## Core Team
+
+The current `websocket-rails` core team consists of the following individuals:
 
-Brought to you by:
+* [@DanKnox](https://github.com/DanKnox)
+* [@Pitr](https://github.com/pitr)
+* [@moaa](https://github.com/moaa)
 
-Three Dot Loft LLC
+New contributors and pull requests are always welcome.

data/lib/assets/javascripts/websocket_rails/abstract_connection.js.coffee

@@ -0,0 +1,45 @@
+###
+ Abstract Interface for the WebSocketRails client.
+###
+class WebSocketRails.AbstractConnection
+
+  constructor: (url, @dispatcher) ->
+    @message_queue   = []
+
+  close: ->
+
+  trigger: (event) ->
+    if @dispatcher.state != 'connected'
+      @message_queue.push event
+    else
+      @send_event event
+
+  send_event: (event) ->
+    # Events queued before connecting do not have the correct
+    # connection_id set yet. We need to update it before dispatching.
+    event.connection_id = @connection_id if @connection_id?
+
+    # ...
+    
+  on_close: (event) ->
+    if @dispatcher && @dispatcher._conn == @
+      close_event = new WebSocketRails.Event(['connection_closed', event])
+      @dispatcher.state = 'disconnected'
+      @dispatcher.dispatch close_event
+
+  on_error: (event) ->
+    if @dispatcher && @dispatcher._conn == @
+      error_event = new WebSocketRails.Event(['connection_error', event])
+      @dispatcher.state = 'disconnected'
+      @dispatcher.dispatch error_event
+
+  on_message: (event_data) ->
+    if @dispatcher && @dispatcher._conn == @
+      @dispatcher.new_message event_data
+
+  setConnectionId: (@connection_id) ->
+
+  flush_queue: ->
+    for event in @message_queue
+      @trigger event
+    @message_queue = []

data/lib/assets/javascripts/websocket_rails/channel.js.coffee

@@ -9,39 +9,56 @@ For instance:
 ###
 class WebSocketRails.Channel
 
-  constructor: (@name,@_dispatcher,@is_private) ->
+  constructor: (@name, @_dispatcher, @is_private = false, @on_success, @on_failure) ->
+    @_callbacks = {}
+    @_token = undefined
+    @_queue = []
     if @is_private
       event_name = 'websocket_rails.subscribe_private'
     else
       event_name = 'websocket_rails.subscribe'
 
-    event = new WebSocketRails.Event( [event_name, {data: {channel: @name}},@_dispatcher.connection_id], @_success_launcher, @_failure_launcher)
+    @connection_id = @_dispatcher._conn?.connection_id
+    event = new WebSocketRails.Event( [event_name, {data: {channel: @name}}, @connection_id], @_success_launcher, @_failure_launcher)
     @_dispatcher.trigger_event event
-    @_callbacks = {}
 
-  destroy: () =>
-    event_name = 'websocket_rails.unsubscribe'
-    event =  new WebSocketRails.Event( [event_name, {data: {channel: @name}}, @_dispatcher.connection_id] )
-    @_dispatcher.trigger_event event
+  destroy: ->
+    if @connection_id == @_dispatcher._conn?.connection_id
+      event_name = 'websocket_rails.unsubscribe'
+      event =  new WebSocketRails.Event( [event_name, {data: {channel: @name}}, @connection_id] )
+      @_dispatcher.trigger_event event
     @_callbacks = {}
 
-  bind: (event_name, callback) =>
+  bind: (event_name, callback) ->
     @_callbacks[event_name] ?= []
     @_callbacks[event_name].push callback
 
-  trigger: (event_name, message) =>
-    event = new WebSocketRails.Event( [event_name, {channel: @name, data: message}, @_dispatcher.connection_id] )
-    @_dispatcher.trigger_event event
+  trigger: (event_name, message) ->
+    event = new WebSocketRails.Event( [event_name, {channel: @name, data: message, token: @_token}, @connection_id] )
+    if !@_token
+      @_queue.push event
+    else
+      @_dispatcher.trigger_event event
+
+  dispatch: (event_name, message) ->
+    if event_name == 'websocket_rails.channel_token'
+      @connection_id = @_dispatcher._conn?.connection_id
+      @_token = message['token']
+      @flush_queue()
+    else
+      return unless @_callbacks[event_name]?
+      for callback in @_callbacks[event_name]
+        callback message
 
-  dispatch: (event_name, message) =>
-    return unless @_callbacks[event_name]?
-    for callback in @_callbacks[event_name]
-      callback message
-  
   # using this method because @on_success will not be defined when the constructor is executed
   _success_launcher: (data) =>
     @on_success(data) if @on_success?
-    
+
   # using this method because @on_failure will not be defined when the constructor is executed
   _failure_launcher: (data) =>
     @on_failure(data) if @on_failure?
+
+  flush_queue: ->
+    for event in @_queue
+      @_dispatcher.trigger_event event
+    @_queue = []

data/lib/assets/javascripts/websocket_rails/event.js.coffee

@@ -4,37 +4,39 @@ The Event object stores all the relevant event information.
 
 class WebSocketRails.Event
 
-  constructor: (data,@success_callback,@failure_callback) ->
+  constructor: (data, @success_callback, @failure_callback) ->
     @name    = data[0]
     attr     = data[1]
     if attr?
       @id      = if attr['id']? then attr['id'] else (((1+Math.random())*0x10000)|0)
       @channel = if attr.channel? then attr.channel
       @data    = if attr.data? then attr.data else attr
+      @token   = if attr.token? then attr.token
       @connection_id = data[2]
       if attr.success?
         @result  = true
         @success = attr.success
 
-  is_channel: =>
+  is_channel: ->
     @channel?
 
-  is_result: =>
-    @result == true
+  is_result: ->
+    typeof @result != 'undefined'
 
-  is_ping: =>
+  is_ping: ->
     @name == 'websocket_rails.ping'
 
-  serialize: =>
+  serialize: ->
       JSON.stringify [@name, @attributes()]
 
-  attributes: =>
+  attributes: ->
     id: @id,
     channel: @channel,
     data: @data
+    token: @token
 
-  run_callbacks: (success,data) =>
-    if success == true
-      @success_callback?(data)
+  run_callbacks: (@success, @result) ->
+    if @success == true
+      @success_callback?(@result)
     else
-      @failure_callback?(data)
+      @failure_callback?(@result)

data/lib/assets/javascripts/websocket_rails/http_connection.js.coffee

@@ -1,67 +1,66 @@
 ###
  HTTP Interface for the WebSocketRails client.
 ###
-class WebSocketRails.HttpConnection
-  httpFactories: -> [
+class WebSocketRails.HttpConnection extends WebSocketRails.AbstractConnection
+  connection_type: 'http'
+
+  _httpFactories: -> [
+    -> new XDomainRequest(),
     -> new XMLHttpRequest(),
     -> new ActiveXObject("Msxml2.XMLHTTP"),
     -> new ActiveXObject("Msxml3.XMLHTTP"),
     -> new ActiveXObject("Microsoft.XMLHTTP")
   ]
 
-  createXMLHttpObject: =>
-    xmlhttp   = false
-    factories = @httpFactories()
-    for factory in factories
-      try
-        xmlhttp = factory()
-      catch e
-        continue
-      break
-    xmlhttp
-
-  constructor: (@url, @dispatcher) ->
-    @_url          = @url
-    @_conn         = @createXMLHttpObject()
+  constructor: (url, @dispatcher) ->
+    super
+    @_url          = "http://#{url}"
+    @_conn         = @_createXMLHttpObject()
     @last_pos      = 0
-    @message_queue = []
-    @_conn.onreadystatechange = @parse_stream
-    @_conn.addEventListener("load", @connectionClosed, false)
+    try
+      @_conn.onreadystatechange = => @_parse_stream()
+      @_conn.addEventListener("load", @on_close, false)
+    catch e
+      @_conn.onprogress = => @_parse_stream()
+      @_conn.onload = @on_close
+      # set this as 3 always for parse_stream as the object does not have this property at all
+      @_conn.readyState = 3
     @_conn.open "GET", @_url, true
     @_conn.send()
 
-  parse_stream: =>
-    if @_conn.readyState == 3
-      data         = @_conn.responseText.substring @last_pos
-      @last_pos    = @_conn.responseText.length
-      data = data.replace( /\]\]\[\[/g, "],[" )
-      decoded_data = JSON.parse data
-      @dispatcher.new_message decoded_data
+  close: ->
+    @_conn.abort()
 
-  trigger: (event) =>
-    if @dispatcher.state != 'connected'
-      @message_queue.push event
-    else
-      @post_data @dispatcher.connection_id, event.serialize()
+  send_event: (event) ->
+    super
+    @_post_data event.serialize()
 
-  post_data: (connection_id, payload) ->
+  _post_data: (payload) ->
     $.ajax @_url,
       type: 'POST'
       data:
-        client_id: connection_id
+        client_id: @connection_id
         data: payload
       success: ->
 
-  flush_queue: (connection_id) =>
-    for event in @message_queue
-      # Events queued before connecting do not have the correct
-      # connection_id set yet. We need to update it before dispatching.
-      if connection_id?
-        event.connection_id = @dispatcher.connection_id
-      @trigger event
-    @message_queue = []
+  _createXMLHttpObject: ->
+    xmlhttp   = false
+    factories = @_httpFactories()
+    for factory in factories
+      try
+        xmlhttp = factory()
+      catch e
+        continue
+      break
+    xmlhttp
 
-  connectionClosed: (event) =>
-    close_event = new WebSocketRails.Event(['connection_closed', event])
-    @dispatcher.state = 'disconnected'
-    @dispatcher.dispatch close_event
+  _parse_stream: ->
+    if @_conn.readyState == 3
+      data         = @_conn.responseText.substring @last_pos
+      @last_pos    = @_conn.responseText.length
+      data = data.replace( /\]\]\[\[/g, "],[" )
+      try
+        event_data = JSON.parse data
+        @on_message(event_data)
+      catch e
+        # just ignore if it cannot be parsed, probably whitespace

data/lib/assets/javascripts/websocket_rails/main.js

@@ -1,5 +1,6 @@
 //= require ./websocket_rails
 //= require ./event
+//= require ./abstract_connection
 //= require ./http_connection
 //= require ./websocket_connection
 //= require ./channel