websocket-rails 0.4.8 → 0.4.9

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # WebsocketRails Change Log
 
+## Version 0.4.9
+
+July 9 2013
+
+* Updated JavaScript client to properly keep track of the connection state.
+* Added .connection_stale() function to the JavaScript client for easily checking connection state.
+
 ## Version 0.4.8
 
 July 6 2013

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

@@ -26,6 +26,7 @@ class WebSocketRails.HttpConnection
     @last_pos      = 0
     @message_queue = []
     @_conn.onreadystatechange = @parse_stream
+    @_conn.addEventListener("load", @connectionClosed, false)
     @_conn.open "GET", @_url, true
     @_conn.send()
 
@@ -59,3 +60,8 @@ class WebSocketRails.HttpConnection
         event.connection_id = @dispatcher.connection_id
       @trigger event
     @message_queue = []
+
+  connectionClosed: (event) =>
+    close_event = new WebSocketRails.Event(['connection_closed', event])
+    @dispatcher.state = 'disconnected'
+    @dispatcher.dispatch close_event

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

@@ -23,10 +23,12 @@ class WebSocketRails.WebSocketConnection
 
   on_close: (event) =>
     close_event = new WebSocketRails.Event(['connection_closed', event])
+    @dispatcher.state = 'disconnected'
     @dispatcher.dispatch close_event
 
   on_error: (event) =>
     error_event = new WebSocketRails.Event(['connection_error', event])
+    @dispatcher.state = 'disconnected'
     @dispatcher.dispatch error_event
 
   flush_queue: =>

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

@@ -16,7 +16,7 @@ Listening for new events from the server
     console.log(data.user_name);
   });
 ###
-class window.WebSocketRails
+class @WebSocketRails
   constructor: (@url, @use_websockets = true) ->
     @state     = 'connecting'
     @callbacks = {}
@@ -102,3 +102,6 @@ class window.WebSocketRails
   pong: =>
     pong = new WebSocketRails.Event( ['websocket_rails.pong',{},@connection_id] )
     @_conn.trigger pong
+
+  connection_stale: =>
+    @state != 'connected'

data/lib/websocket_rails/version.rb

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

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

@@ -41,6 +41,7 @@
     function HttpConnection(url, dispatcher) {
       this.url = url;
       this.dispatcher = dispatcher;
+      this.connectionClosed = __bind(this.connectionClosed, this);
       this.flush_queue = __bind(this.flush_queue, this);
       this.trigger = __bind(this.trigger, this);
       this.parse_stream = __bind(this.parse_stream, this);
@@ -50,6 +51,7 @@
       this.last_pos = 0;
       this.message_queue = [];
       this._conn.onreadystatechange = this.parse_stream;
+      this._conn.addEventListener("load", this.connectionClosed, false);
       this._conn.open("GET", this._url, true);
       this._conn.send();
     }
@@ -97,6 +99,13 @@
       return this.message_queue = [];
     };
 
+    HttpConnection.prototype.connectionClosed = function(event) {
+      var close_event;
+      close_event = new WebSocketRails.Event(['connection_closed', event]);
+      this.dispatcher.state = 'disconnected';
+      return this.dispatcher.dispatch(close_event);
+    };
+
     return HttpConnection;
 
   })();

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

@@ -42,12 +42,14 @@ WebSocket Interface for the WebSocketRails client.
     WebSocketConnection.prototype.on_close = function(event) {
       var close_event;
       close_event = new WebSocketRails.Event(['connection_closed', event]);
+      this.dispatcher.state = 'disconnected';
       return this.dispatcher.dispatch(close_event);
     };
 
     WebSocketConnection.prototype.on_error = function(event) {
       var error_event;
       error_event = new WebSocketRails.Event(['connection_error', event]);
+      this.dispatcher.state = 'disconnected';
       return this.dispatcher.dispatch(error_event);
     };
 

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

@@ -21,10 +21,11 @@ Listening for new events from the server
 (function() {
   var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 
-  window.WebSocketRails = (function() {
+  this.WebSocketRails = (function() {
     function WebSocketRails(url, use_websockets) {
       this.url = url;
       this.use_websockets = use_websockets != null ? use_websockets : true;
+      this.connection_stale = __bind(this.connection_stale, this);
       this.pong = __bind(this.pong, this);
       this.supports_websockets = __bind(this.supports_websockets, this);
       this.dispatch_channel = __bind(this.dispatch_channel, this);
@@ -169,6 +170,10 @@ Listening for new events from the server
       return this._conn.trigger(pong);
     };
 
+    WebSocketRails.prototype.connection_stale = function() {
+      return this.state !== 'connected';
+    };
+
     return WebSocketRails;
 
   })();

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

@@ -81,21 +81,27 @@
       });
     });
     describe('.on_close', function() {
-      return it('should dispatch the connection_closed event and pass the original event', function() {
+      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);
+        this.connection.on_close(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();
       });
+      return it('sets the connection state on the dispatcher to disconnected', function() {
+        var close_event;
+        close_event = new WebSocketRails.Event(['connection_closed', {}]);
+        this.connection.on_close(close_event);
+        return expect(this.dispatcher.state).toEqual('disconnected');
+      });
     });
     describe('.on_error', function() {
-      return it('should dispatch the connection_error event and pass the original event', function() {
+      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]);
@@ -107,6 +113,12 @@
         expect(lastCall.data).toEqual(event.data);
         return dispatcher.restore();
       });
+      return it('sets the connection state on the dispatcher to disconnected', function() {
+        var close_event;
+        close_event = new WebSocketRails.Event(['connection_closed', {}]);
+        this.connection.on_error(close_event);
+        return expect(this.dispatcher.state).toEqual('disconnected');
+      });
     });
     return describe('.flush_queue', function() {
       beforeEach(function() {

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

@@ -178,6 +178,20 @@
         });
       });
     });
+    describe('.connection_stale', function() {
+      describe('when state is connected', function() {
+        return it('should return false', function() {
+          this.dispatcher.state = 'connected';
+          return expect(this.dispatcher.connection_stale()).toEqual(false);
+        });
+      });
+      return describe('when state is disconnected', function() {
+        return it('should return true', function() {
+          this.dispatcher.state = 'disconnected';
+          return expect(this.dispatcher.connection_stale()).toEqual(true);
+        });
+      });
+    });
     return describe('working with channels', function() {
       beforeEach(function() {
         return WebSocketRails.Channel = function(name, dispatcher, is_private) {

data/spec/javascripts/websocket_rails/websocket_connection_spec.coffee

@@ -9,10 +9,10 @@ describe 'WebsocketRails.WebSocketConnection:', ->
       @url  = url
       @send = -> true
     @dispatcher = dispatcher
-    @connection = new WebSocketRails.WebSocketConnection('localhost:3000/websocket',dispatcher)
+    @connection = new WebSocketRails.WebSocketConnection('localhost:3000/websocket', dispatcher)
 
   describe 'constructor', ->
-    
+
     it 'should set the onmessage event on the WebSocket object to this.on_message', ->
       expect(@connection._conn.onmessage).toEqual @connection.on_message
 
@@ -61,19 +61,24 @@ describe 'WebsocketRails.WebSocketConnection:', ->
 
   describe '.on_close', ->
     it 'should dispatch the connection_closed event and pass the original event', ->
-
       event = new WebSocketRails.Event ['event','message']
       close_event = new WebSocketRails.Event(['connection_closed', event ])
       sinon.spy @dispatcher, 'dispatch'
-      @connection.on_close event
+      @connection.on_close close_event
 
       dispatcher = @dispatcher.dispatch
       lastCall = dispatcher.lastCall.args[0]
       expect(dispatcher.calledOnce).toBe(true)
       expect(lastCall.data).toEqual event.data
-      
+
       dispatcher.restore()
 
+    it 'sets the connection state on the dispatcher to disconnected', ->
+      close_event = new WebSocketRails.Event(['connection_closed', {} ])
+      @connection.on_close close_event
+
+      expect(@dispatcher.state).toEqual('disconnected')
+
   describe '.on_error', ->
     it 'should dispatch the connection_error event and pass the original event', ->
 
@@ -86,16 +91,22 @@ describe 'WebsocketRails.WebSocketConnection:', ->
       lastCall = dispatcher.lastCall.args[0]
       expect(dispatcher.calledOnce).toBe(true)
       expect(lastCall.data).toEqual event.data
-      
+
       dispatcher.restore()
 
+    it 'sets the connection state on the dispatcher to disconnected', ->
+      close_event = new WebSocketRails.Event(['connection_closed', {} ])
+      @connection.on_error close_event
+
+      expect(@dispatcher.state).toEqual('disconnected')
+
   describe '.flush_queue', ->
     beforeEach ->
       @event = new WebSocketRails.Event ['event','message']
       @connection.message_queue.push @event
       @connection._conn =
         send: -> true
-    
+
     it 'should send out all of the messages in the queue', ->
       mock_connection = sinon.mock @connection._conn
       mock_connection.expects('send').once().withArgs @event.serialize()

data/spec/javascripts/websocket_rails/websocket_rails_spec.coffee

@@ -134,6 +134,17 @@ describe 'WebSocketRails:', ->
         event = new WebSocketRails.Event ['websocket_rails.subscribe', {channel: 'awesome'}, 123]
         expect(con_trigger.called).toEqual true
 
+  describe '.connection_stale', ->
+    describe 'when state is connected', ->
+      it 'should return false', ->
+        @dispatcher.state = 'connected'
+        expect(@dispatcher.connection_stale()).toEqual false
+
+    describe 'when state is disconnected', ->
+      it 'should return true', ->
+        @dispatcher.state = 'disconnected'
+        expect(@dispatcher.connection_stale()).toEqual true
+
   describe 'working with channels', ->
     beforeEach ->
       WebSocketRails.Channel = (@name,@dispatcher,@is_private) ->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-06 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -301,7 +301,7 @@ files:
 - CHANGELOG.md
 homepage: http://danknox.github.com/websocket-rails/
 licenses: []
-post_install_message: Welcome to WebsocketRails v0.4.8!
+post_install_message: Welcome to WebsocketRails v0.4.9!
 rdoc_options: []
 require_paths:
 - lib
@@ -313,7 +313,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1588461271210117573
+      hash: -2441396343706207267
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -322,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1588461271210117573
+      hash: -2441396343706207267
 requirements: []
 rubyforge_project: websocket-rails
 rubygems_version: 1.8.25