websocket-rails 0.4.7 → 0.4.8

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # WebsocketRails Change Log
 
+## Version 0.4.8
+
+July 6 2013
+
+* Fix error with class reloading in development with Rails 4
+* Added `connection.close!` method to allow for manually disconnecting users from a WebsocketRails controller.
+* Add a way to unsubscribe from channels via the JavaScript client. - Thanks to @Oxynum
+* Fix handling of `on_error` event in the JavaScript client. - Thanks to @imton
+
 ## Version 0.4.7
 
 June 6 2013
@@ -8,9 +17,12 @@ June 6 2013
 * Fix spelling mistake in ConnectionAdapters#inspect - Thanks to
 @bmxpert1
 * Prevent duplicate events from being triggered when events are added
-directly to Redis from an outside process. - Thanks to @DarkSwoop
+directly to Redis from an outside process. - Thanks to @moaa
 * Only log event data if it is a Hash or String to drastically reduce
 the log file size. - Thanks to @florianguenther
+* Fix the intermittent uninitialized constant
+"WebsocketRails::InternalEvents" error in development. - Thanks to
+@DarkSwoop
 
 ## Version 0.4.6
 

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 gem "rspec-rails", ">=2.12.0"
 gem "therubyrhino"
 gem "therubyracer"
-gem "jasmine", ">=1.2.0"
+gem "jasmine"
 gem "headless"
 gem "coffee-script"
 gem "thin"

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

@@ -19,6 +19,12 @@ class WebSocketRails.Channel
     @_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
+    @_callbacks = {}
+
   bind: (event_name, callback) =>
     @_callbacks[event_name] ?= []
     @_callbacks[event_name].push callback

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

@@ -22,11 +22,11 @@ class WebSocketRails.WebSocketConnection
     @dispatcher.new_message data
 
   on_close: (event) =>
-    close_event = new WebSocketRails.Event(['connection_closed',{}])
+    close_event = new WebSocketRails.Event(['connection_closed', event])
     @dispatcher.dispatch close_event
 
   on_error: (event) =>
-    error_event = new WebSocketRails.Event(['connection_error',event?.data])
+    error_event = new WebSocketRails.Event(['connection_error', event])
     @dispatcher.dispatch error_event
 
   flush_queue: =>

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

@@ -87,6 +87,11 @@ class window.WebSocketRails
     else
       @channels[channel_name]
 
+  unsubscribe: (channel_name) =>
+    return unless @channels[channel_name]?
+    @channels[channel_name].destroy()
+    delete @channels[channel_name]
+
   dispatch_channel: (event) =>
     return unless @channels[event.channel]?
     @channels[event.channel].dispatch event.name, event.data

data/lib/websocket_rails/base_controller.rb

@@ -21,7 +21,9 @@ module WebsocketRails
     # Tell Rails that BaseController and children can be reloaded when in
     # the Development environment.
     def self.inherited(controller)
-      unloadable controller unless controller.name == "WebsocketRails::InternalController"
+      unless controller.name == "WebsocketRails::InternalController" || Rails.version =~/^4/
+        unloadable controller
+      end
     end
 
     # Add observers to specific events or the controller in general. This functionality is similar

data/lib/websocket_rails/connection_adapters/http.rb

@@ -31,6 +31,10 @@ module WebsocketRails
         @body.chunk encode_chunk( message )
       end
 
+      def close!
+        @body.close!
+      end
+
       private
 
       def define_deferrable_callbacks

data/lib/websocket_rails/connection_adapters/web_socket.rb

@@ -6,9 +6,9 @@ module WebsocketRails
         Faye::WebSocket.websocket?( env )
       end
 
-      def initialize(request,dispatcher)
+      def initialize(request, dispatcher)
         super
-        @connection = Faye::WebSocket.new( request.env )
+        @connection = Faye::WebSocket.new(request.env)
         @connection.onmessage = method(:on_message)
         @connection.onerror   = method(:on_error)
         @connection.onclose   = method(:on_close)
@@ -24,6 +24,10 @@ module WebsocketRails
         super data
       end
 
+      def close!
+        @connection.close
+      end
+
     end
   end
 end

data/lib/websocket_rails/internal_events.rb

@@ -5,6 +5,7 @@ module WebsocketRails
         namespace :websocket_rails do
           subscribe :pong, :to => InternalController, :with_method => :do_pong
           subscribe :subscribe, :to => InternalController, :with_method => :subscribe_to_channel
+          subscribe :unsubscribe, :to => InternalController, :with_method => :unsubscribe_to_channel
         end
       end
     end
@@ -19,10 +20,16 @@ module WebsocketRails
         WebsocketRails[channel_name].subscribe connection
         trigger_success
       else
-        trigger_failure( { :reason => "channel is private", :hint => "use subscibe_private instead." } )
+        trigger_failure( { :reason => "channel is private", :hint => "use subscribe_private instead." } )
       end
     end
 
+    def unsubscribe_to_channel
+      channel_name = event.data[:channel]
+      WebsocketRails[channel_name].unsubscribe connection
+      trigger_success
+    end
+
     def do_pong
       connection.pong = true
     end

data/lib/websocket_rails/version.rb

@@ -1,3 +1,3 @@
 module WebsocketRails
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

data/spec/dummy/log/test.log

@@ -153,3 +153,6 @@ 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
+Connecting to database specified by database.yml

data/spec/javascripts/generated/assets/channel.js

@@ -1,4 +1,3 @@
-
 /*
 The channel object is returned when you subscribe to a channel.
 
@@ -14,22 +13,17 @@ For instance:
   var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
   WebSocketRails.Channel = (function() {
-
     function Channel(name, _dispatcher, is_private) {
       var event, event_name;
       this.name = name;
       this._dispatcher = _dispatcher;
       this.is_private = is_private;
       this._failure_launcher = __bind(this._failure_launcher, this);
-
       this._success_launcher = __bind(this._success_launcher, this);
-
       this.dispatch = __bind(this.dispatch, this);
-
       this.trigger = __bind(this.trigger, this);
-
       this.bind = __bind(this.bind, this);
-
+      this.destroy = __bind(this.destroy, this);
       if (this.is_private) {
         event_name = 'websocket_rails.subscribe_private';
       } else {
@@ -46,9 +40,23 @@ For instance:
       this._callbacks = {};
     }
 
+    Channel.prototype.destroy = function() {
+      var event, event_name;
+      event_name = 'websocket_rails.unsubscribe';
+      event = new WebSocketRails.Event([
+        event_name, {
+          data: {
+            channel: this.name
+          }
+        }, this._dispatcher.connection_id
+      ]);
+      this._dispatcher.trigger_event(event);
+      return this._callbacks = {};
+    };
+
     Channel.prototype.bind = function(event_name, callback) {
-      var _base, _ref;
-      if ((_ref = (_base = this._callbacks)[event_name]) == null) {
+      var _base;
+      if ((_base = this._callbacks)[event_name] == null) {
         _base[event_name] = [];
       }
       return this._callbacks[event_name].push(callback);

data/spec/javascripts/generated/assets/event.js

@@ -1,4 +1,3 @@
-
 /*
 The Event object stores all the relevant event information.
 */
@@ -8,23 +7,16 @@ The Event object stores all the relevant event information.
   var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
   WebSocketRails.Event = (function() {
-
     function Event(data, success_callback, failure_callback) {
       var attr;
       this.success_callback = success_callback;
       this.failure_callback = failure_callback;
       this.run_callbacks = __bind(this.run_callbacks, this);
-
       this.attributes = __bind(this.attributes, this);
-
       this.serialize = __bind(this.serialize, this);
-
       this.is_ping = __bind(this.is_ping, this);
-
       this.is_result = __bind(this.is_result, this);
-
       this.is_channel = __bind(this.is_channel, this);
-
       this.name = data[0];
       attr = data[1];
       if (attr != null) {

data/spec/javascripts/generated/assets/http_connection.js

@@ -1,4 +1,3 @@
-
 /*
  HTTP Interface for the WebSocketRails client.
 */
@@ -8,7 +7,6 @@
   var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
   WebSocketRails.HttpConnection = (function() {
-
     HttpConnection.prototype.httpFactories = function() {
       return [
         function() {
@@ -24,14 +22,15 @@
     };
 
     HttpConnection.prototype.createXMLHttpObject = function() {
-      var factories, factory, xmlhttp, _i, _len;
+      var e, factories, factory, xmlhttp, _i, _len;
       xmlhttp = false;
       factories = this.httpFactories();
       for (_i = 0, _len = factories.length; _i < _len; _i++) {
         factory = factories[_i];
         try {
           xmlhttp = factory();
-        } catch (e) {
+        } catch (_error) {
+          e = _error;
           continue;
         }
         break;
@@ -43,13 +42,9 @@
       this.url = url;
       this.dispatcher = dispatcher;
       this.flush_queue = __bind(this.flush_queue, this);
-
       this.trigger = __bind(this.trigger, this);
-
       this.parse_stream = __bind(this.parse_stream, this);
-
       this.createXMLHttpObject = __bind(this.createXMLHttpObject, this);
-
       this._url = this.url;
       this._conn = this.createXMLHttpObject();
       this.last_pos = 0;

data/spec/javascripts/generated/assets/websocket_connection.js

@@ -1,4 +1,3 @@
-
 /*
 WebSocket Interface for the WebSocketRails client.
 */
@@ -8,20 +7,14 @@ WebSocket Interface for the WebSocketRails client.
   var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
   WebSocketRails.WebSocketConnection = (function() {
-
     function WebSocketConnection(url, dispatcher) {
       this.url = url;
       this.dispatcher = dispatcher;
       this.flush_queue = __bind(this.flush_queue, this);
-
       this.on_error = __bind(this.on_error, this);
-
       this.on_close = __bind(this.on_close, this);
-
       this.on_message = __bind(this.on_message, this);
-
       this.trigger = __bind(this.trigger, this);
-
       if (!this.url.match(/^wss?:\/\//)) {
         this.url = "ws://" + this.url;
       }
@@ -48,13 +41,13 @@ WebSocket Interface for the WebSocketRails client.
 
     WebSocketConnection.prototype.on_close = function(event) {
       var close_event;
-      close_event = new WebSocketRails.Event(['connection_closed', {}]);
+      close_event = new WebSocketRails.Event(['connection_closed', event]);
       return this.dispatcher.dispatch(close_event);
     };
 
     WebSocketConnection.prototype.on_error = function(event) {
       var error_event;
-      error_event = new WebSocketRails.Event(['connection_error', event != null ? event.data : void 0]);
+      error_event = new WebSocketRails.Event(['connection_error', event]);
       return this.dispatcher.dispatch(error_event);
     };
 

data/spec/javascripts/generated/assets/websocket_rails.js

@@ -1,4 +1,3 @@
-
 /*
 WebsocketRails JavaScript Client
 
@@ -23,32 +22,21 @@ Listening for new events from the server
   var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
   window.WebSocketRails = (function() {
-
     function WebSocketRails(url, use_websockets) {
       this.url = url;
       this.use_websockets = use_websockets != null ? use_websockets : true;
       this.pong = __bind(this.pong, this);
-
       this.supports_websockets = __bind(this.supports_websockets, this);
-
       this.dispatch_channel = __bind(this.dispatch_channel, this);
-
+      this.unsubscribe = __bind(this.unsubscribe, this);
       this.subscribe_private = __bind(this.subscribe_private, this);
-
       this.subscribe = __bind(this.subscribe, this);
-
       this.dispatch = __bind(this.dispatch, this);
-
       this.trigger_event = __bind(this.trigger_event, this);
-
       this.trigger = __bind(this.trigger, this);
-
       this.bind = __bind(this.bind, this);
-
       this.connection_established = __bind(this.connection_established, this);
-
       this.new_message = __bind(this.new_message, this);
-
       this.state = 'connecting';
       this.callbacks = {};
       this.channels = {};
@@ -98,8 +86,8 @@ Listening for new events from the server
     };
 
     WebSocketRails.prototype.bind = function(event_name, callback) {
-      var _base, _ref;
-      if ((_ref = (_base = this.callbacks)[event_name]) == null) {
+      var _base;
+      if ((_base = this.callbacks)[event_name] == null) {
         _base[event_name] = [];
       }
       return this.callbacks[event_name].push(callback);
@@ -113,8 +101,8 @@ Listening for new events from the server
     };
 
     WebSocketRails.prototype.trigger_event = function(event) {
-      var _base, _name, _ref;
-      if ((_ref = (_base = this.queue)[_name = event.id]) == null) {
+      var _base, _name;
+      if ((_base = this.queue)[_name = event.id] == null) {
         _base[_name] = event;
       }
       return this._conn.trigger(event);
@@ -156,6 +144,14 @@ Listening for new events from the server
       }
     };
 
+    WebSocketRails.prototype.unsubscribe = function(channel_name) {
+      if (this.channels[channel_name] == null) {
+        return;
+      }
+      this.channels[channel_name].destroy();
+      return delete this.channels[channel_name];
+    };
+
     WebSocketRails.prototype.dispatch_channel = function(event) {
       if (this.channels[event.channel] == null) {
         return;

data/spec/javascripts/generated/specs/channel_spec.js

@@ -1,5 +1,4 @@
 (function() {
-
   describe('WebSocketRails.Channel:', function() {
     beforeEach(function() {
       this.dispatcher = {

data/spec/javascripts/generated/specs/event_spec.js

@@ -1,5 +1,4 @@
 (function() {
-
   describe('WebSocketRails.Event', function() {
     describe('standard events', function() {
       beforeEach(function() {

data/spec/javascripts/generated/specs/websocket_connection_spec.js

@@ -1,5 +1,4 @@
 (function() {
-
   describe('WebsocketRails.WebSocketConnection:', function() {
     beforeEach(function() {
       var dispatcher;
@@ -18,6 +17,7 @@
           return true;
         };
       };
+      this.dispatcher = dispatcher;
       return this.connection = new WebSocketRails.WebSocketConnection('localhost:3000/websocket', dispatcher);
     });
     describe('constructor', function() {
@@ -81,12 +81,31 @@
       });
     });
     describe('.on_close', function() {
-      return it('should dispatch the connection_closed event', function() {
-        var mock_dispatcher;
-        mock_dispatcher = sinon.mock(this.connection.dispatcher);
-        mock_dispatcher.expects('dispatch').once();
-        this.connection.on_close();
-        return mock_dispatcher.verify();
+      return it('should dispatch the connection_closed event and pass the original event', function() {
+        var close_event, dispatcher, event, lastCall;
+        event = new WebSocketRails.Event(['event', 'message']);
+        close_event = new WebSocketRails.Event(['connection_closed', event]);
+        sinon.spy(this.dispatcher, 'dispatch');
+        this.connection.on_close(event);
+        dispatcher = this.dispatcher.dispatch;
+        lastCall = dispatcher.lastCall.args[0];
+        expect(dispatcher.calledOnce).toBe(true);
+        expect(lastCall.data).toEqual(event.data);
+        return dispatcher.restore();
+      });
+    });
+    describe('.on_error', function() {
+      return it('should dispatch the connection_error event and pass the original event', function() {
+        var dispatcher, error_event, event, lastCall;
+        event = new WebSocketRails.Event(['event', 'message']);
+        error_event = new WebSocketRails.Event(['connection_error', event]);
+        sinon.spy(this.dispatcher, 'dispatch');
+        this.connection.on_error(event);
+        dispatcher = this.dispatcher.dispatch;
+        lastCall = dispatcher.lastCall.args[0];
+        expect(dispatcher.calledOnce).toBe(true);
+        expect(lastCall.data).toEqual(event.data);
+        return dispatcher.restore();
       });
     });
     return describe('.flush_queue', function() {