websocket-rails 0.4.3 → 0.4.4

data/CHANGELOG.md

@@ -1,25 +1,37 @@
 # WebsocketRails Change Log
 
-March 12 2013
+## Version 0.4.4
+
+April 28 2013
+
+* Remove existing subscribers from a channel when making it private to
+eliminate the potential for malicious users to eavesdrop on private
+channels. Addresses issue #72.
+* Prevent the server from crashing when receiving an uploaded file.
+Addresses issue #68.
+* Allow custom routes for the WebSocket server. Users of are
+no longer forced to use the `/websocket` route. - Thanks to @Cominch
 
 ## Version 0.4.3
 
+March 12 2013
+
 * Change the log output in Channel#trigger_event. Fixes issue #61.
 * Cancel the ping timer when removing disconnecting a Connection.
 * Fix uninitialized constant WebsocketRails::Internal controller error.
 
-March 1 2013
-
 ## Version 0.4.2
 
+March 1 2013
+
 * Check to make sure ActiveRecord is defined before calling
 ActiveRecord::RecordInvalid in Dispatcher. Fixes issue #54. - Thanks to
 @nessche
 
-February 28 2013
-
 ## Version 0.4.1
 
+February 28 2013
+
 * Fix bug in ControllerFactory#reload! that prevented the handling of
 internal events when running in the Development environment. Fixes issue #50. - Thanks to @nessche
 
@@ -32,10 +44,10 @@ Addresses issue #51. - Thanks to @ngauthier
 the Rails version and adds the correct path for the routes file. Fixes
 issue #49. - Thanks to @sgerrand
 
-February 27 2013
-
 ## Version 0.4.0
 
+February 27 2013
+
 __There have been a few breaking changes in the public API since the
 last release. Please review the list below and consult the Wiki for more
 information regarding the usage of the new features.__

data/README.md

@@ -11,6 +11,13 @@ Check out the [CHANGELOG](https://github.com/DanKnox/websocket-rails/blob/master
 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.
+
 ## Overview
 
 Start treating client side events as first class citizens inside your

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

@@ -21,11 +21,12 @@ class WebSocketRails.HttpConnection
     xmlhttp
 
   constructor: (@url, @dispatcher) ->
+    @_url          = @url
     @_conn         = @createXMLHttpObject()
     @last_pos      = 0
     @message_queue = []
     @_conn.onreadystatechange = @parse_stream
-    @_conn.open "GET", "/websocket", true
+    @_conn.open "GET", @_url, true
     @_conn.send()
 
   parse_stream: =>
@@ -43,7 +44,7 @@ class WebSocketRails.HttpConnection
       @post_data @dispatcher.connection_id, event.serialize()
 
   post_data: (connection_id, payload) ->
-    $.ajax "/websocket",
+    $.ajax @_url,
       type: 'POST'
       data:
         client_id: connection_id

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

@@ -2,7 +2,7 @@
 WebsocketRails JavaScript Client
 
 Setting up the dispatcher:
-  var dispatcher = new WebSocketRails('localhost:3000');
+  var dispatcher = new WebSocketRails('localhost:3000/websocket');
   dispatcher.on_open = function() {
     // trigger a server event immediately after opening connection
     dispatcher.trigger('new_user',{user_name: 'guest'});

data/lib/generators/websocket_rails/install/templates/events.rb

@@ -7,7 +7,7 @@ WebsocketRails.setup do |config|
 
   # Uncomment to change the default log file path.
   # config.log_path = "#{Rails.root}/log/websocket_rails.log"
-  
+
   # Set to true if you wish to log the internal websocket_rails events
   # such as the keepalive `websocket_rails.ping` event.
   # config.log_internal_events = false
@@ -26,6 +26,12 @@ WebsocketRails.setup do |config|
   # Will not be used unless standalone or synchronization mode
   # is enabled.
   # config.redis_options = {:host => 'localhost', :port => '6379'}
+
+  # By default, all subscribers in to a channel will be removed
+  # when that channel is made private. If you don't wish active
+  # subscribers to be removed from a previously public channel
+  # when making it private, set the following to true.
+  # config.keep_subscribers_when_private = false
 end
 
 WebsocketRails::EventMap.describe do

data/lib/websocket_rails/channel.rb

@@ -3,6 +3,8 @@ module WebsocketRails
 
     include Logging
 
+    delegate :config, :to => WebsocketRails
+
     attr_reader :name, :subscribers
 
     def initialize(channel_name)
@@ -38,6 +40,9 @@ module WebsocketRails
     end
 
     def make_private
+      unless config.keep_subscribers_when_private?
+        @subscribers.clear
+      end
       @private = true
     end
 

data/lib/websocket_rails/configuration.rb

@@ -1,6 +1,14 @@
 module WebsocketRails
   class Configuration
 
+    def keep_subscribers_when_private?
+      @keep_subscribers_when_private ||= false
+    end
+
+    def keep_subscribers_when_private=(value)
+      @keep_subscribers_when_private = value
+    end
+
     def route_block=(routes)
       @event_routes = routes
     end

data/lib/websocket_rails/event.rb

@@ -58,6 +58,9 @@ module WebsocketRails
   # :channel =>
   # The name of the channel that this event is destined for.
   class Event
+
+    class UnknownDataType < StandardError; end;
+
     extend Logging
 
     def self.log_header
@@ -65,10 +68,22 @@ module WebsocketRails
     end
 
     def self.new_from_json(encoded_data, connection)
-      event_name, data = JSON.parse encoded_data
-      data = data.merge(:connection => connection).with_indifferent_access
-      Event.new event_name, data
-    rescue JSON::ParserError => ex
+      case encoded_data
+      when String
+        event_name, data = JSON.parse encoded_data
+        data = data.merge(:connection => connection).with_indifferent_access
+        Event.new event_name, data
+        # when Array
+        # TODO: Handle file
+        #File.open("/tmp/test#{rand(100)}.jpg", "wb") do |file|
+        #  encoded_data.each do |byte|
+        #    file << byte.chr
+        #  end
+        #end
+      else
+        raise UnknownDataType
+      end
+    rescue JSON::ParserError, UnknownDataType => ex
       warn "Invalid Event Received: #{ex}"
       debug "Event Data: #{encoded_data}"
       log_exception(ex)

data/lib/websocket_rails/version.rb

@@ -1,3 +1,3 @@
 module WebsocketRails
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/spec/dummy/log/test.log

@@ -1139,3 +1139,5 @@ Connecting to database specified by database.yml
 Connecting to database specified by database.yml
 Connecting to database specified by database.yml
 Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml

data/spec/unit/channel_spec.rb

@@ -57,6 +57,10 @@ module WebsocketRails
     end
 
     context "private channels" do
+      before do
+        subject.subscribers << connection
+      end
+
       it "should be public by default" do
         subject.instance_variable_get(:@private).should_not be_true
       end
@@ -66,6 +70,26 @@ module WebsocketRails
           subject.make_private
           subject.instance_variable_get(:@private).should be_true
         end
+
+        context "when Configuration#keep_subscribers_when_private? is false" do
+          it "should clear any existing subscribers in the channel" do
+            subject.subscribers.count.should == 1
+            subject.make_private
+            subject.subscribers.count.should == 0
+          end
+        end
+
+        context "when Configuration#keep_subscribers_when_private? is true" do
+          before do
+            WebsocketRails.config.keep_subscribers_when_private = true
+          end
+
+          it "should leave the existing subscribers in the channel" do
+            subject.subscribers.count.should == 1
+            subject.make_private
+            subject.subscribers.count.should == 1
+          end
+        end
       end
 
       describe "#is_private?" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -300,7 +300,7 @@ files:
 - CHANGELOG.md
 homepage: http://danknox.github.com/websocket-rails/
 licenses: []
-post_install_message: ! "  Welcome to WebsocketRails v0.4.3!\n\n  There have been
+post_install_message: ! "  Welcome to WebsocketRails v0.4.4!\n\n  There have been
   a few significant changes in the public\n  API, so if you are upgrading please be
   sure to read the\n  CHANGELOG located at:\n\n  http://github.com/DanKnox/websocket-rails/CHANGELOG.md\n"
 rdoc_options: []
@@ -314,7 +314,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1144546358314647981
+      hash: 4427836168917747429
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -323,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1144546358314647981
+      hash: 4427836168917747429
 requirements: []
 rubyforge_project: websocket-rails
 rubygems_version: 1.8.25