wwl-websocket-rails 0.7.1

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,202 @@
+(function() {
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var token = $$('meta[name=csrf-token]')[0];
+      if (token) {
+        if (!request.options.requestHeaders) request.options.requestHeaders = {};
+        request.options.requestHeaders['X-CSRF-Token'] = token.readAttribute('content');
+      }
+    }
+  });
+
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM';
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase();
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA';
+    }
+    else return false;
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change');
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback);
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName;
+        }
+      }
+    );
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true);
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault();
+        });
+        form.store('emulated:submit', true);
+      }
+    });
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, textarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true);
+        });
+        input.store('emulated:change', true);
+      }
+    });
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      // serialize the form with respect to the submit button that was pressed
+      params = element.serialize({ submit: element.retrieve('rails:submit-button') });
+      // clear the pressed submit button information
+      element.store('rails:submit-button', null);
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onCreate:   function(response) { element.fire("ajax:create",   response); },
+      onComplete: function(response) { element.fire("ajax:complete", response); },
+      onSuccess:  function(response) { element.fire("ajax:success",  response); },
+      onFailure:  function(response) { element.fire("ajax:failure",  response); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function insertHiddenField(form, name, value) {
+    form.insert(new Element('input', { type: 'hidden', name: name, value: value }));
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    $(element.parentNode).insert(form);
+
+    if (method !== 'post') {
+      insertHiddenField(form, '_method', method);
+    }
+
+    if (csrf_param) {
+      insertHiddenField(form, csrf_param.readAttribute('content'), csrf_token.readAttribute('content'));
+    }
+
+    form.submit();
+  }
+
+  function disableFormElements(form) {
+    form.select('input[type=submit][data-disable-with]').each(function(input) {
+      input.store('rails:original-value', input.getValue());
+      input.setValue(input.readAttribute('data-disable-with')).disable();
+    });
+  }
+  
+  function enableFormElements(form) {
+    form.select('input[type=submit][data-disable-with]').each(function(input) {
+      input.setValue(input.retrieve('rails:original-value')).enable();
+    });
+  }
+
+  function allowAction(element) {
+    var message = element.readAttribute('data-confirm');
+    return !message || confirm(message);
+  }
+
+  document.on('click', 'a[data-confirm], a[data-remote], a[data-method]', function(event, link) {
+    if (!allowAction(link)) {
+      event.stop();
+      return false;
+    }
+
+    if (link.readAttribute('data-remote')) {
+      handleRemote(link);
+      event.stop();
+    } else if (link.readAttribute('data-method')) {
+      handleMethod(link);
+      event.stop();
+    }
+  });
+
+  document.on("click", "form input[type=submit], form button[type=submit], form button:not([type])", function(event, button) {
+    // register the pressed submit button
+    event.findElement('form').store('rails:submit-button', button.name || false);
+  });
+
+  document.on("submit", function(event) {
+    var form = event.findElement();
+
+    if (!allowAction(form)) {
+      event.stop();
+      return false;
+    }
+
+    if (form.readAttribute('data-remote')) {
+      handleRemote(form);
+      event.stop();
+    } else {
+      disableFormElements(form);
+    }
+  });
+
+  document.on('ajax:create', 'form', function(event, form) {
+    if (form == event.findElement()) disableFormElements(form);
+  });
+  
+  document.on('ajax:complete', 'form', function(event, form) {
+    if (form == event.findElement()) enableFormElements(form);
+  });
+})();

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/integration/connection_manager_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'support/mock_web_socket'
+
+module WebsocketRails
+  describe ConnectionManager, "integration test" do
+
+    class ProductController < BaseController
+      def update_list; true; end
+    end
+
+    def define_test_events
+      WebsocketRails.config.route_block = nil
+      WebsocketRails::EventMap.describe do
+        subscribe :client_connected, :to => ChatController, :with_method => :new_user
+        subscribe :change_username, :to => ChatController, :with_method => :change_username
+        subscribe :client_error, :to => ChatController, :with_method => :error_occurred
+        subscribe :client_disconnected, :to => ChatController, :with_method => :delete_user
+
+        subscribe :update_list, :to => ChatController, :with_method => :update_user_list
+
+        namespace :products do
+          subscribe :update_list, :to => ProductController, :with_method => :update_list
+        end
+      end
+    end
+
+    before(:all) do
+      define_test_events
+      if defined?(ConnectionAdapters::Test)
+        ConnectionAdapters.adapters.delete( ConnectionAdapters::Test )
+      end
+    end
+
+    around do |example|
+      EM.run do
+        example.run
+      end
+    end
+
+    after do
+      EM.stop
+    end
+
+    shared_examples "an evented rack server" do
+      context "new connections" do
+        it "should execute the controller action associated with the 'client_connected' event" do
+          ChatController.any_instance.should_receive(:new_user)
+          @server.call( env )
+        end
+      end
+
+      context "active connections" do
+        context "new message from client" do
+          let(:test_message) { ['change_username',{:user_name => 'Joe User'}] }
+          let(:encoded_message) { test_message.to_json }
+
+          it "should execute the controller action associated with the received event" do
+            ChatController.any_instance.should_receive(:change_username)
+            @server.call( env )
+            socket.on_message( encoded_message )
+          end
+        end
+
+        context "new message from client under a namespace" do
+          let(:test_message) { ['products.update_list',{:product => 'x-ray-vision'}] }
+          let(:encoded_message) { test_message.to_json }
+
+          it "should execute the controller action under the correct namespace" do
+            ChatController.any_instance.should_not_receive(:update_user_list)
+            ProductController.any_instance.should_receive(:update_list)
+            @server.call( env )
+            socket.on_message( encoded_message )
+          end
+        end
+
+        context "subscribing to a channel" do
+          let(:channel_message) { ['websocket_rails.subscribe',{:data => {:channel => 'test_chan'}}] }
+          let(:encoded_channel_message) { channel_message.to_json }
+
+          it "should subscribe the connection to the correct channel" do
+            channel = WebsocketRails[:test_chan]
+            @server.call( env )
+            channel.should_receive(:subscribe).with(socket)
+            socket.on_message encoded_channel_message
+          end
+        end
+
+        context "client error" do
+          it "should execute the controller action associated with the 'client_error' event" do
+            ChatController.any_instance.should_receive(:error_occurred)
+            @server.call( env )
+            socket.on_error
+          end
+        end
+
+        context "client disconnects" do
+          it "should execute the controller action associated with the 'client_disconnected' event" do
+            ChatController.any_instance.should_receive(:delete_user)
+            @server.call( env )
+            socket.on_close
+          end
+
+          it "should unsubscribe from channels" do
+            channel = WebsocketRails[:test_chan]
+            @server.call( env )
+            channel.should_receive(:unsubscribe).with(socket)
+            socket.on_close
+          end
+        end
+      end
+    end
+
+    context "WebSocket Adapter" do
+      let(:socket) { @server.connections.first[1] }
+
+      before do
+        ::Faye::WebSocket.stub(:websocket?).and_return(true)
+        @server = ConnectionManager.new
+      end
+
+      it_behaves_like 'an evented rack server'
+    end
+
+    describe "HTTP Adapter" do
+      let(:socket) { @server.connections.first[1] }
+
+      before do
+        @server = ConnectionManager.new
+      end
+
+      it_behaves_like 'an evented rack server'
+    end
+
+  end
+end

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,52 @@
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_dir: spec/javascripts
+src_files:
+    - support/vendor/sinon-1.7.1.js
+    - generated/assets/websocket_rails.js
+    - generated/assets/event.js
+    - generated/assets/abstract_connection.js
+    - generated/assets/http_connection.js
+    - generated/assets/websocket_connection.js
+    - generated/assets/channel.js
+    - generated/specs/helpers.js
+
+spec_dir: spec/javascripts/generated
+spec_files:
+    - specs/event_spec.js
+    - specs/websocket_connection_spec.js
+    - specs/channel_spec.js
+    - specs/websocket_rails_spec.js
+
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:

data/spec/javascripts/support/jasmine_helper.rb

@@ -0,0 +1,38 @@
+#Use this file to set/override Jasmine configuration options
+#You can remove it if you don't need it.
+#This file is loaded *after* jasmine.yml is interpreted.
+#
+#Example: using a different boot file.
+#Jasmine.configure do |config|
+#   config.boot_dir = '/absolute/path/to/boot_dir'
+#   config.boot_files = lambda { ['/absolute/path/to/boot_dir/file.js'] }
+#end
+#
+require 'coffee-script'
+
+puts "Precompiling assets..."
+
+root = File.expand_path("../../../../lib/assets/javascripts/websocket_rails", __FILE__)
+destination_dir = File.expand_path("../../../../spec/javascripts/generated/assets", __FILE__)
+
+glob = File.expand_path("**/*.js.coffee", root)
+
+Dir.glob(glob).each do |srcfile|
+  srcfile = Pathname.new(srcfile)
+  destfile = srcfile.sub(root, destination_dir).sub(".coffee", "")
+  FileUtils.mkdir_p(destfile.dirname)
+  File.open(destfile, "w") {|f| f.write(CoffeeScript.compile(File.new(srcfile)))}
+end
+puts "Compiling jasmine coffee scripts into javascript..."
+root = File.expand_path("../../../../spec/javascripts/websocket_rails", __FILE__)
+destination_dir = File.expand_path("../../generated/specs", __FILE__)
+
+glob = File.expand_path("**/*.coffee", root)
+
+Dir.glob(glob).each do |srcfile|
+  srcfile = Pathname.new(srcfile)
+  destfile = srcfile.sub(root, destination_dir).sub(".coffee", ".js")
+  FileUtils.mkdir_p(destfile.dirname)
+  File.open(destfile, "w") {|f| f.write(CoffeeScript.compile(File.new(srcfile)))}
+end
+