websocket-rails 0.5.0 → 0.6.0

data/lib/websocket_rails/version.rb

@@ -1,3 +1,3 @@
 module WebsocketRails
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/dummy/config/environments/test.rb

@@ -7,8 +7,7 @@ Dummy::Application.configure do
   # and recreated between test runs.  Don't rely on the data there!
   config.cache_classes = true
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  config.eager_load = true
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true

data/spec/dummy/db/migrate/20130902222552_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20130902222552) do
+
+  create_table "users", force: true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/spec/dummy/log/development.log

@@ -0,0 +1,17 @@
+   (1.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to CreateUsers (20130902222552)
+   (0.0ms)  begin transaction
+   (0.3ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "email" varchar(255), "created_at" datetime, "updated_at" datetime) 
+  SQL (1.4ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20130902222552"]]
+   (0.9ms)  commit transaction
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (1.0ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "email" varchar(255), "created_at" datetime, "updated_at" datetime) 
+   (1.0ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.8ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (0.8ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130902222552')
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"

data/spec/integration/connection_manager_spec.rb

@@ -111,7 +111,7 @@ module WebsocketRails
     end
 
     context "WebSocket Adapter" do
-      let(:socket) { @server.connections.first }
+      let(:socket) { @server.connections.first[1] }
 
       before do
         ::Faye::WebSocket.stub(:websocket?).and_return(true)
@@ -122,7 +122,7 @@ module WebsocketRails
     end
 
     describe "HTTP Adapter" do
-      let(:socket) { @server.connections.first }
+      let(:socket) { @server.connections.first[1] }
 
       before do
         @server = ConnectionManager.new

data/spec/unit/connection_adapters_spec.rb

@@ -18,8 +18,15 @@ module WebsocketRails
     end
 
     context ".establish_connection" do
+      before do
+        connection_manager = double(ConnectionManager)
+        connection_manager.stub(:connections).and_return({})
+        @dispatcher = double(Dispatcher).as_null_object
+        @dispatcher.stub(:connection_manager).and_return(connection_manager)
+      end
+
       it "should return the correct connection adapter instance" do
-        adapter = ConnectionAdapters.establish_connection( mock_request, double('Dispatcher').as_null_object )
+        adapter = ConnectionAdapters.establish_connection(mock_request, @dispatcher)
         adapter.class.should == ConnectionAdapters::Test
       end
     end
@@ -28,11 +35,18 @@ module WebsocketRails
 
   module ConnectionAdapters
     describe Base do
-      let(:dispatcher) { double('Dispatcher').as_null_object }
-      let(:channel_manager) { double('ChannelManager').as_null_object }
-      let(:event) { double('Event').as_null_object }
-      before  { Event.stub(:new_from_json).and_return(event) }
-      subject { Base.new( mock_request, dispatcher ) }
+      let(:connection_manager) { double(ConnectionManager).as_null_object }
+      let(:dispatcher) { double(Dispatcher).as_null_object }
+      let(:channel_manager) { double(ChannelManager).as_null_object }
+      let(:event) { double(Event).as_null_object }
+
+      before do
+        connection_manager.stub(:connections).and_return({})
+        dispatcher.stub(:connection_manager).and_return(connection_manager)
+        Event.stub(:new_from_json).and_return(event)
+      end
+
+      subject { Base.new(mock_request, dispatcher) }
 
       context "new adapter" do
         it "should register itself in the adapters array when inherited" do
@@ -44,17 +58,17 @@ module WebsocketRails
           subject.data_store.should be_a DataStore::Connection
         end
 
-        before do
-          WebsocketRails.config.stub(:user_identifier).and_return(:name)
-          WebsocketRails::DelegationController.any_instance
-            .stub_chain(:current_user, :name)
-            .and_return('Frank')
-          subject
-        end
+        #before do
+        #  WebsocketRails.config.stub(:user_identifier).and_return(:name)
+        #  WebsocketRails::DelegationController.any_instance
+        #    .stub_chain(:current_user, :name)
+        #    .and_return('Frank')
+        #  subject
+        #end
 
-        it "adds itself to the UserManager Hash" do
-          WebsocketRails.users['Frank'].should == subject
-        end
+        #it "adds itself to the UserManager Hash" do
+        #  WebsocketRails.users['Frank'].should == subject
+        #end
       end
 
       describe "#on_open" do
@@ -81,11 +95,6 @@ module WebsocketRails
           dispatcher.should_receive(:dispatch).with(on_close_event)
           subject.on_close("data")
         end
-
-        it "removes itself from the global UserMnaager" do
-          subject.on_close
-          WebsocketRails.users[subject.id].nil?.should == true
-        end
       end
 
       describe "#on_error" do
@@ -137,45 +146,72 @@ module WebsocketRails
         end
       end
 
-      describe "#enqueue" do
-        it "should add the event to the queue" do
-          subject.enqueue 'event'
-          subject.queue.queue.should == ['event']
+      describe "#user_connection?" do
+        context "when a user is signed in" do
+          before do
+            subject.stub(:user_identifier).and_return("Jimbo Jones")
+          end
+
+          it "returns true" do
+            subject.user_connection?.should == true
+          end
+        end
+
+        context "when a user is signed out" do
+          before do
+            subject.stub(:user_identifier).and_return(nil)
+          end
+
+          it "returns true" do
+            subject.user_connection?.should == false
+          end
         end
       end
 
-      describe "#trigger" do
-=begin
-        it "should add the event to the queue" do
-          pending
-          subject.stub(:flush)
-          subject.should_receive(:enqueue).with('event')
-          subject.trigger 'event'
+      describe "#user" do
+        it "provides access to the current_user object" do
+          user = double('User')
+          subject.stub(:user_identifier).and_return true
+          subject.stub_chain(:controller_delegate, :current_user).and_return user
+          subject.user.should == user
         end
+      end
 
-        it "should flush the queue" do
-          subject.should_receive(:flush)
-          subject.trigger 'event'
+      describe "#enqueue" do
+        it "should add the event to the queue" do
+          subject.enqueue 'event'
+          subject.queue.queue.should == ['event']
         end
-=end
       end
 
       describe "#flush" do
         before do
-          event = double('event')
-          event.stub!(:serialize).and_return("['event']")
-          3.times { subject.enqueue event }
+          event = Event.new(:queued_event, data: 'test')
+          2.times { subject.enqueue event }
         end
 
         it "should serialize all events into one array" do
-          serialized_array = "[['event'],['event'],['event']]"
-          subject.should_receive(:send).with(serialized_array)
+          serialized_array = <<-EOF.strip_heredoc
+            [["queued_event",{"id":null,"channel":null,"user_id":null,"data":"test","success":null,"result":null,"server_token":null}],
+            ["queued_event",{"id":null,"channel":null,"user_id":null,"data":"test","success":null,"result":null,"server_token":null}]]
+          EOF
+
+          subject.should_receive(:send).with(serialized_array.gsub(/\n/,'').strip)
           subject.flush
         end
       end
 
+      describe "#trigger" do
+        it "passes a serialized event to the connections #send method" do
+          event.stub(:serialize).and_return('test')
+          subject.should_receive(:send).with "[test]"
+          subject.trigger event
+        end
+      end
+
       describe "#close_connection" do
         before do
+          subject.stub(:user_identifier).and_return(1)
           @connection_manager = double('connection_manager').as_null_object
           subject.stub_chain(:dispatcher, :connection_manager).and_return(@connection_manager)
         end

data/spec/unit/connection_manager_spec.rb

@@ -17,13 +17,13 @@ module WebsocketRails
 
     before(:each) do
       ConnectionAdapters::Base.any_instance.stub(:send)
-      @mock_socket = ConnectionAdapters::Base.new(mock_request,dispatcher)
+      @mock_socket = ConnectionAdapters::Base.new(mock_request, dispatcher)
       ConnectionAdapters.stub(:establish_connection).and_return(@mock_socket)
     end
 
     describe "#initialize" do
-      it "should create an empty connections array" do
-        subject.connections.should be_a Array
+      it "should create an empty connections hash" do
+        subject.connections.should be_a Hash
       end
 
       it "should create a new dispatcher instance" do
@@ -36,20 +36,44 @@ module WebsocketRails
         expect { open_connection }.to change { connections.count }.by(1)
       end
 
-      it "should store the new connection in the @connections array" do
+      it "should store the new connection in the @connections Hash" do
         open_connection
-        connections.include?(@mock_socket).should be_true
+        connections[@mock_socket.id].should == @mock_socket
       end
 
       it "should return an Async Rack response" do
         open_connection.should == [ -1, {}, [] ]
       end
+
+      before do
+        SecureRandom.stub(:hex).and_return(1, 2)
+      end
+
+      it "gives the new connection a unique ID" do
+        @mock_socket.should_receive(:id=).with(1)
+        open_connection
+        @mock_socket.should_receive(:id=).with(2)
+        open_connection
+      end
+
+      context "user connections" do
+        before do
+          @mock_socket.stub(:user_connection?).and_return true
+          @mock_socket.stub(:user_identifier).and_return "El Jefe"
+          open_connection
+        end
+
+        it "stores the connection in the UserManager" do
+          WebsocketRails.users["El Jefe"].connections.first.should == @mock_socket
+        end
+      end
     end
 
     context "new POST event" do
       before(:each) do
-        @mock_http = ConnectionAdapters::Http.new(mock_request,dispatcher)
-        app.connections << @mock_http
+        @mock_http = ConnectionAdapters::Http.new(mock_request, dispatcher)
+        @mock_http.id = 1
+        app.connections[@mock_http.id] = @mock_http
       end
 
       it "should receive the new event for the correct connection" do
@@ -60,7 +84,7 @@ module WebsocketRails
 
     context "open connections" do
       before(:each) do
-        ConnectionAdapters.stub(:establish_connection).and_return(@mock_socket,ConnectionAdapters::Base.new(mock_request,dispatcher))
+        ConnectionAdapters.stub(:establish_connection).and_return(@mock_socket, ConnectionAdapters::Base.new(mock_request, dispatcher))
         4.times { open_connection }
       end
 
@@ -81,7 +105,7 @@ module WebsocketRails
       context "when closing" do
         it "should remove the connection object from the @connections array" do
           @mock_socket.on_close
-          connections.include?(@mock_socket).should be_false
+          connections.has_key?(@mock_socket.id).should be_false
         end
 
         it "should decrement the connection count by one" do
@@ -95,6 +119,18 @@ module WebsocketRails
           end
           @mock_socket.on_close
         end
+
+        context "user connections" do
+          before do
+            @mock_socket.stub(:user_connection?).and_return true
+            @mock_socket.stub(:user_identifier).and_return "El Jefe"
+          end
+
+          it "deletes the connection from the UserManager" do
+            @mock_socket.on_close
+            WebsocketRails.users["El Jefe"].class.should == UserManager::MissingConnection
+          end
+        end
       end
 
     end

data/spec/unit/synchronization_spec.rb

@@ -1,18 +1,8 @@
 require "spec_helper"
 require "eventmachine"
+require "ostruct"
 
 module WebsocketRails
-    #class Synchronization
-    #  def test_block(channel, &block)
-    #    # do nothing beyatch
-    #    block.call
-    #  end
-
-    #  def synchronize!
-    #    test_block("something") { raise "FTW!" }
-    #  end
-    #end
-
   describe Synchronization do
 
     around(:each) do |example|
@@ -59,7 +49,7 @@ module WebsocketRails
 
       context "when dispatching user events" do
         before do
-          @event = Event.new(:channel_event, :user_id => :username, :data => 'hello channel one')
+          @event = Event.new(:channel_event, :user_id => "username", :data => 'hello channel one')
         end
 
         context "and the user is not connected to this server" do
@@ -71,18 +61,18 @@ module WebsocketRails
         context "and the user is connected to this server" do
           before do
             @connection = double('Connection')
-            WebsocketRails.users[:username] = @connection
+            WebsocketRails.users["username"] = @connection
           end
 
           it "triggers the event on the correct user" do
-            WebsocketRails.users[:username].should_receive(:trigger).with @event
+            WebsocketRails.users["username"].should_receive(:trigger).with @event
             subject.trigger_incoming @event
           end
         end
       end
     end
 
-    describe "#generate_unique_token" do
+    describe "#generate_server_token" do
       before do
         SecureRandom.stub(:urlsafe_base64).and_return(1, 2, 3)
       end
@@ -91,14 +81,14 @@ module WebsocketRails
         @redis.del "websocket_rails.active_servers"
       end
 
-      it "should generate a unique token" do
+      it "should generate a unique server token" do
         SecureRandom.should_receive(:urlsafe_base64).at_least(1).times
-        subject.generate_unique_token
+        subject.generate_server_token
       end
 
       it "should generate another id if the current id is already registered" do
         @redis.sadd "websocket_rails.active_servers", 1
-        token = subject.generate_unique_token
+        token = subject.generate_server_token
         token.should == 2
       end
     end
@@ -117,5 +107,44 @@ module WebsocketRails
       end
     end
 
+    describe "#register_user" do
+      before do
+        @connection = double('Connection')
+        @user = User.new
+        @user.attributes.update(name: 'Frank The Tank', email: 'frank@tank.com')
+        @user.instance_variable_set(:@new_record, false)
+        @user.instance_variable_set(:@destroyed, false)
+        @connection.stub(:user_identifier).and_return 'Frank The Tank'
+        @connection.stub(:user).and_return @user
+      end
+
+      it "stores the serialized user object in redis" do
+        @user.persisted?.should == true
+        Redis.any_instance.should_receive(:hset).with("websocket_rails.users", @connection.user_identifier, @user.as_json.to_json)
+        Synchronization.register_user(@connection)
+      end
+    end
+
+    describe "#destroy_user" do
+      it "stores the serialized user object in redis" do
+        Redis.any_instance.should_receive(:hdel).with("websocket_rails.users", 'user_id')
+        Synchronization.destroy_user('user_id')
+      end
+    end
+
+    describe "#find_user" do
+      it "retrieves the serialized user object in redis" do
+        Redis.any_instance.should_receive(:hget).with("websocket_rails.users", 'test')
+        Synchronization.find_user('test')
+      end
+    end
+
+    describe "#all_users" do
+      it "retrieves the entire serialized users hash redis" do
+        Redis.any_instance.should_receive(:hgetall).with("websocket_rails.users")
+        Synchronization.all_users
+      end
+    end
+
   end
 end