websocket-rails 0.4.6 → 0.4.7

data/CHANGELOG.md

@@ -1,7 +1,21 @@
 # WebsocketRails Change Log
 
+## Version 0.4.7
+
+June 6 2013
+
+* Fix observer system - Thanks to @pitr
+* 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
+* Only log event data if it is a Hash or String to drastically reduce
+the log file size. - Thanks to @florianguenther
+
 ## Version 0.4.6
 
+May 9 2013
+
 * Manually load the Faye::WebSocket Thin adapter to support the latest
 version of the Faye::WebSocket gem. - Thanks to @Traxmaxx
 

data/README.md

@@ -4,6 +4,11 @@
 
 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.
 
+**Find us on IRC #websocket-rails**
+
+Stop by #websocket-rails if you would like to chat or have any
+questions.
+
 ## Recent Updates
 
 Check out the [CHANGELOG](https://github.com/DanKnox/websocket-rails/blob/master/CHANGELOG.md) to find out what's new.

data/lib/websocket-rails.rb

@@ -74,10 +74,10 @@ class WebsocketRails::EventRoutingError < StandardError
 
   def to_json
     super({
-      error: "EventRoutingError",
-      event: event.name,
-      method: method,
-      reason: "Controller #{controller.class} does not respond to #{method}"
+      :error => "EventRoutingError",
+      :event => event.name,
+      :method => method,
+      :reason => "Controller #{controller.class} does not respond to #{method}"
     })
   end
 

data/lib/websocket_rails/base_controller.rb

@@ -21,7 +21,7 @@ module WebsocketRails
     # Tell Rails that BaseController and children can be reloaded when in
     # the Development environment.
     def self.inherited(controller)
-      unloadable controller
+      unloadable controller unless controller.name == "WebsocketRails::InternalController"
     end
 
     # Add observers to specific events or the controller in general. This functionality is similar
@@ -41,16 +41,16 @@ module WebsocketRails
     #     puts 'new_message has fired!'
     #   }
     def self.observe(event = nil, &block)
+      # Stores the observer Procs for the current controller. See {observe} for details.
+      @observers ||= Hash.new {|h,k| h[k] = Array.new}
+
       if event
-        @@observers[event] << block
+        @observers[event] << block
       else
-        @@observers[:general] << block
+        @observers[:general] << block
       end
     end
 
-    # Stores the observer Procs for the current controller. See {observe} for details.
-    @@observers = Hash.new {|h,k| h[k] = Array.new}
-
     # Provides direct access to the connection object for the client that
     # initiated the event that is currently being executed.
     def connection
@@ -154,10 +154,14 @@ module WebsocketRails
     # first and event specific observers are executed last. Each will be executed in the order that
     # they have been defined. This method is executed by the {Dispatcher}.
     def execute_observers(event)
-      @@observers[:general].each do |observer|
+      observers = self.class.instance_variable_get(:@observers)
+
+      return unless observers
+
+      observers[:general].each do |observer|
         instance_eval( &observer )
       end
-      @@observers[event].each do |observer|
+      observers[event].each do |observer|
         instance_eval( &observer )
       end
     end

data/lib/websocket_rails/connection_adapters.rb

@@ -109,7 +109,7 @@ module WebsocketRails
       end
 
       def inspect
-        "#<Connnection::#{id}>"
+        "#<Connection::#{id}>"
       end
 
       def to_s

data/lib/websocket_rails/dispatcher.rb

@@ -51,9 +51,7 @@ module WebsocketRails
             log_event(event) do
               controller = controller_factory.new_for_event(event, controller_class)
 
-              if controller.respond_to?(:execute_observers)
-                controller.send(:execute_observers, event.name)
-              end
+              controller.send(:execute_observers, event.name)
 
               if controller.respond_to?(method)
                 controller.send(method)

data/lib/websocket_rails/logging.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash'
 require 'bigdecimal'
 require 'bigdecimal/util'
 
@@ -6,6 +7,12 @@ module WebsocketRails
   module Logging
     # Logging module heavily influenced by Travis-Support library
 
+    LOGGABLE_DATA = [
+      String,
+      Hash,
+      ActiveSupport::HashWithIndifferentAccess
+    ]
+
     ANSI = {
       :red    => 31,
       :green  => 32,
@@ -45,7 +52,7 @@ module WebsocketRails
     def log_event_start(event)
       message = "Started Event: #{event.encoded_name}\n"
       message << "#{colorize(:cyan, "Name:")} #{event.encoded_name}\n"
-      message << "#{colorize(:cyan, "Data:")} #{event.data.inspect}\n"
+      message << "#{colorize(:cyan, "Data:")} #{event.data.inspect}\n" if log_data?(event)
       message << "#{colorize(:cyan, "Connection:")} #{event.connection}\n\n"
       info message
     end
@@ -73,6 +80,10 @@ module WebsocketRails
       end
     end
 
+    def log_data?(event)
+      LOGGABLE_DATA.include?(event.data.class)
+    end
+
     def log_exception(exception)
       logger.error(wrap(:error, self, "#{exception.class.name}: #{exception.message}"))
       exception.backtrace.each { |line| logger.error(wrap(:error, self, line)) } if exception.backtrace

data/lib/websocket_rails/synchronization.rb

@@ -59,6 +59,7 @@ module WebsocketRails
               event = Event.new_from_json(encoded_event, nil)
               next if event.server_token == server_token
 
+              event.server_token = server_token if event.server_token.nil?
               WebsocketRails[event.channel].trigger_event(event)
             end
           end

data/lib/websocket_rails/version.rb

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

data/spec/dummy/log/test.log

@@ -129,3 +129,27 @@ 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
+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
+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
+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/upload_event.js

@@ -0,0 +1,56 @@
+(function() {
+  var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; },
+    __hasProp = {}.hasOwnProperty,
+    __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
+
+  WebSocketRails.UploadEvent = (function(_super) {
+
+    __extends(UploadEvent, _super);
+
+    function UploadEvent(eventName, file, data, connectionId, successCallback, failureCallback, _conn) {
+      this.file = file;
+      this.successCallback = successCallback;
+      this.failureCallback = failureCallback;
+      this._conn = _conn;
+      this.storeBinaryData = __bind(this.storeBinaryData, this);
+
+      this.attributes = __bind(this.attributes, this);
+
+      UploadEvent.__super__.constructor.call(this, [eventName, data, connectionId], this.successCallback, this.failureCallback);
+      this.fileReader = new FileReader;
+      this.fileReader.onloadend = this.storeBinaryData;
+      this.fileReader.readAsArrayBuffer(this.file);
+    }
+
+    UploadEvent.prototype.isFileUpload = function() {
+      return true;
+    };
+
+    UploadEvent.prototype.attributes = function() {
+      return {
+        id: this.id,
+        channel: this.channel,
+        data: this.data,
+        upload_event: true,
+        raw_file_data: {
+          filename: this.file.name,
+          file_size: this.file.size,
+          type: this.file.type,
+          array_buffer: this.bufferView
+        }
+      };
+    };
+
+    UploadEvent.prototype.storeBinaryData = function(event) {
+      this.arrayBuffer = event.target.result;
+      this.bufferView = new Uint8Array(this.arrayBuffer);
+      window.buffer = this.bufferView;
+      console.log(this.arrayBuffer);
+      return this._conn.trigger(this);
+    };
+
+    return UploadEvent;
+
+  })(WebSocketRails.Event);
+
+}).call(this);

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

@@ -0,0 +1,55 @@
+(function() {
+  var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+
+  window.FileReader = (function() {
+
+    function FileReader() {
+      this.readAsArrayBuffer = __bind(this.readAsArrayBuffer, this);
+
+    }
+
+    FileReader.prototype.readAsArrayBuffer = function(file) {
+      return this.onloadend({
+        target: {
+          result: 'xyz'
+        }
+      });
+    };
+
+    return FileReader;
+
+  })();
+
+  describe('WebSocketRails.UploadEvent', function() {
+    beforeEach(function() {
+      this.file = {
+        name: 'test_file.jpg',
+        size: 4321,
+        type: 'image/jpeg'
+      };
+      this.conn = {
+        trigger: function(event) {
+          return this.called = true;
+        }
+      };
+      return this.event = new WebSocketRails.UploadEvent('test_upload', this.file, {}, 12345, {}, {}, this.conn);
+    });
+    it('should call the triggerCallback function after extracting the binary data', function() {
+      return expect(this.conn.called).toEqual(true);
+    });
+    describe('.isFileUpload()', function() {
+      return it('should be true', function() {
+        return expect(this.event.isFileUpload()).toEqual(true);
+      });
+    });
+    return describe('.attributes()', function() {
+      return it('should include the raw_file_data', function() {
+        expect(this.event.attributes().raw_file_data.filename).toEqual('test_file.jpg');
+        expect(this.event.attributes().raw_file_data.file_size).toEqual(4321);
+        expect(this.event.attributes().raw_file_data.type).toEqual('image/jpeg');
+        return expect(this.event.attributes().raw_file_data.array_buffer).toEqual('xyz');
+      });
+    });
+  });
+
+}).call(this);

data/spec/unit/logging_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require "ostruct"
 
 module WebsocketRails
   describe Logging do
@@ -97,6 +98,23 @@ module WebsocketRails
       end
     end
 
+    describe "#log_data?" do
+      before do
+        @hash_event = Event.new(:log_test, :data => {test: true})
+        @string_event = Event.new(:log_test, :data => "message")
+        @object_event = Event.new(:log_test, :data => OpenStruct.new)
+      end
+
+      it "returns true if data is an allowed type" do
+        object.log_data?(@hash_event).should == true
+        object.log_data?(@string_event).should == true
+      end
+
+      it "returns false if the data is not an allows type" do
+        object.log_data?(@object_event).should == false
+      end
+    end
+
     describe "#log_event?" do
       context "with an internal event" do
         before do

data/spec/unit/synchronization_spec.rb

@@ -47,6 +47,20 @@ module WebsocketRails
       #  redis = @redis
       #  EM.next_tick { redis.publish "websocket_rails.events", event.serialize }
       #end
+      it "should set server_token to stop circular publishing" do
+        event = Event.new(:redis_event, :channel => 'synchrony', :data => 'hello from another process')
+        if event.server_token.nil?
+          event.server_token = subject.server_token
+        end
+        event.server_token.should == subject.server_token
+      end
+      it "should not set server_token if it is present" do
+        event = Event.new(:redis_event, :channel => 'synchrony', :data => 'hello from another process', :server_token => '1234')
+        if event.server_token.nil?
+          event.server_token = subject.server_token
+        end
+        event.server_token.should == '1234'
+      end
     end
 
     describe "#generate_unique_token" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -259,10 +259,12 @@ files:
 - spec/javascripts/generated/assets/channel.js
 - spec/javascripts/generated/assets/event.js
 - spec/javascripts/generated/assets/http_connection.js
+- spec/javascripts/generated/assets/upload_event.js
 - spec/javascripts/generated/assets/websocket_connection.js
 - spec/javascripts/generated/assets/websocket_rails.js
 - spec/javascripts/generated/specs/channel_spec.js
 - spec/javascripts/generated/specs/event_spec.js
+- spec/javascripts/generated/specs/upload_event_spec.js
 - spec/javascripts/generated/specs/websocket_connection_spec.js
 - spec/javascripts/generated/specs/websocket_rails_spec.js
 - spec/javascripts/support/jasmine.yml
@@ -300,7 +302,7 @@ files:
 - CHANGELOG.md
 homepage: http://danknox.github.com/websocket-rails/
 licenses: []
-post_install_message: ! "  Welcome to WebsocketRails v0.4.6!\n\n  There have been
+post_install_message: ! "  Welcome to WebsocketRails v0.4.7!\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 +316,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 555826924645304718
+      hash: -1865655959983006042
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -323,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 555826924645304718
+      hash: -1865655959983006042
 requirements: []
 rubyforge_project: websocket-rails
 rubygems_version: 1.8.25