Merge branch 'master' of https://github.com/DanKnox/websocket-rails

Author: Rory Low

Gemfile.lock

@@ -8,6 +8,7 @@ PATH
       rack
       rails
       redis
+      redis-objects
       thin
 
 GEM
@@ -41,7 +42,7 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    arel (4.0.0)
+    arel (4.0.1)
     atomic (1.1.10)
     atomic (1.1.10-java)
     builder (3.1.4)
@@ -100,7 +101,7 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     method_source (0.8.1)
-    mime-types (1.23)
+    mime-types (1.25)
     minitest (4.7.5)
     multi_json (1.7.7)
     polyglot (0.3.3)
@@ -135,7 +136,9 @@ GEM
       ffi (>= 0.5.0)
     rb-kqueue (0.2.0)
       ffi (>= 0.5.0)
-    redis (3.0.4)
+    redis (3.0.5)
+    redis-objects (0.7.0)
+      redis (>= 3.0.2)
     ref (1.0.5)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
@@ -172,7 +175,7 @@ GEM
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.0.0)
+    sprockets-rails (2.0.1)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (~> 2.8)
@@ -191,7 +194,7 @@ GEM
     thread_safe (0.1.0)
       atomic
     tilt (1.4.1)
-    treetop (1.4.14)
+    treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.37)

lib/websocket_rails/channel.rb

@@ -5,13 +5,12 @@ class Channel
 
     delegate :config, :channel_tokens, :channel_manager, :to => WebsocketRails
 
-    attr_reader :name, :subscribers, :token
+    attr_reader :name, :subscribers
 
     def initialize(channel_name)
       @subscribers = []
       @name        = channel_name
       @private     = false
-      @token       = generate_unique_token
     end
 
     def subscribe(connection)
@@ -39,7 +38,7 @@ def trigger(event_name,data={},options={})
     end
 
     def trigger_event(event)
-      return if event.token != @token
+      return if event.token != token
       info "[#{name}] #{event.data.inspect}"
       send_data event
     end
@@ -55,20 +54,24 @@ def is_private?
       @private
     end
 
+    def token
+      @token ||= channel_tokens[@name] ||= generate_unique_token
+    end
+
     private
 
     def generate_unique_token
       begin
-        token = SecureRandom.urlsafe_base64
-      end while channel_tokens.include?(token)
+        new_token = SecureRandom.uuid
+      end while channel_tokens.values.include?(new_token)
 
-      token
+      new_token
     end
 
     def send_token(connection)
       options = {
         :channel => @name,
-        :data => {:token => @token},
+        :data => {:token => token},
         :connection => connection
       }
       info 'sending token'

lib/websocket_rails/channel_manager.rb

@@ -1,3 +1,5 @@
+require 'redis-objects'
+
 module WebsocketRails
 
   class << self
@@ -18,11 +20,20 @@ def channel_tokens
 
   class ChannelManager
 
-    attr_reader :channels, :channel_tokens
+    attr_reader :channels
 
     def initialize
       @channels = {}.with_indifferent_access
-      @channel_tokens = []
+    end
+
+    def channel_tokens
+      @channel_tokens ||= begin
+        if WebsocketRails.synchronize?
+          ::Redis::HashKey.new('websocket_rails.channel_tokens', Synchronization.redis)
+        else
+          {}
+        end
+      end
     end
 
     def [](channel)

lib/websocket_rails/event.rb

@@ -126,6 +126,7 @@ def as_json
           :data => data,
           :success => success,
           :result => result,
+          :token => token,
           :server_token => server_token
         }
       ]

lib/websocket_rails/synchronization.rb

@@ -33,14 +33,21 @@ def self.shutdown!
       singleton.shutdown!
     end
 
+    def self.redis
+      singleton.redis
+    end
+
     def self.singleton
       @singleton ||= new
     end
 
     include Logging
 
     def redis
-      @redis ||= Redis.new(WebsocketRails.config.redis_options)
+      @redis ||= begin
+        redis_options = WebsocketRails.config.redis_options
+        EM.reactor_running? ? Redis.new(redis_options) : ruby_redis
+      end
     end
 
     def ruby_redis
@@ -52,9 +59,8 @@ def ruby_redis
 
     def publish(event)
       Fiber.new do
-        redis_client = EM.reactor_running? ? redis : ruby_redis
         event.server_token = server_token
-        redis_client.publish "websocket_rails.events", event.serialize
+        redis.publish "websocket_rails.events", event.serialize
       end.resume
     end
 
@@ -157,16 +163,14 @@ def destroy_user(identifier)
 
     def find_user(identifier)
       Fiber.new do
-        redis_client = EM.reactor_running? ? redis : ruby_redis
-        raw_user = redis_client.hget('websocket_rails.users', identifier)
+        raw_user = redis.hget('websocket_rails.users', identifier)
         raw_user ? JSON.parse(raw_user) : nil
       end.resume
     end
 
     def all_users
       Fiber.new do
-        redis_client = EM.reactor_running? ? redis : ruby_redis
-        redis_client.hgetall('websocket_rails.users')
+        redis.hgetall('websocket_rails.users')
       end.resume
     end
 

spec/unit/channel_manager_spec.rb

@@ -15,8 +15,29 @@ module WebsocketRails
     end
   end
 
+  describe ".channel_tokens" do
+    it "should delegate to channel manager" do
+      ChannelManager.any_instance.should_receive(:channel_tokens)
+      WebsocketRails.channel_tokens
+    end
+  end
+
   describe ChannelManager do
 
+    describe "#channel_tokens" do
+      it "should return a Hash-like" do
+        subject.channel_tokens.respond_to? :[]
+        subject.channel_tokens.respond_to? :has_key?
+      end
+
+      it 'is used to store Channel\'s token' do
+        ChannelManager.any_instance.should_receive(:channel_tokens)
+          .at_least(:twice).and_call_original
+        token = Channel.new(:my_new_test_channel).token
+        WebsocketRails.channel_tokens[:my_new_test_channel].should == token
+      end
+    end
+
     describe "#[]" do
       context "accessing a channel" do
         it "should create the channel if it does not exist" do

spec/unit/channel_spec.rb

@@ -128,6 +128,21 @@ module WebsocketRails
           subject.is_private?.should_not be_true
         end
       end
+
+      describe "#token" do
+        it 'is long enough' do
+          subject.token.length.should > 10
+        end
+
+        it 'remains the same between two call' do
+          subject.token.should == subject.token
+        end
+
+        it 'is the same for two channels with the same name' do
+          subject.token.should == Channel.new(subject.name).token
+        end
+      end
+
     end
   end
 end

spec/unit/connection_adapters_spec.rb

@@ -192,8 +192,8 @@ module ConnectionAdapters
 
         it "should serialize all events into one array" do
           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}]]
+            [["queued_event",{"id":null,"channel":null,"user_id":null,"data":"test","success":null,"result":null,"token":null,"server_token":null}],
+            ["queued_event",{"id":null,"channel":null,"user_id":null,"data":"test","success":null,"result":null,"token":null,"server_token":null}]]
           EOF
 
           subject.should_receive(:send).with(serialized_array.gsub(/\n/,'').strip)

spec/unit/event_spec.rb

@@ -6,7 +6,7 @@ module WebsocketRails
     let(:encoded_message_string) { '["new_message",{"id":"1234","data":"this is a message"}]' }
     let(:namespace_encoded_message_string) { '["product.new_message",{"id":"1234","data":"this is a message"}]' }
     let(:namespace_encoded_message) { '["product.new_message",{"id":"1234","data":{"message":"this is a message"}}]' }
-    let(:channel_encoded_message_string) { '["new_message",{"id":"1234","channel":"awesome_channel","user_id":null,"data":"this is a message","success":null,"result":null,"server_token":"1234"}]' }
+    let(:channel_encoded_message_string) { '["new_message",{"id":"1234","channel":"awesome_channel","user_id":null,"data":"this is a message","success":null,"result":null,"token":null,"server_token":"1234"}]' }
     let(:synchronizable_encoded_message) { '["new_message",{"id":"1234","data":{"message":"this is a message"},"server_token":"1234"}]' }
     let(:connection) { double('connection') }
 
@@ -151,6 +151,16 @@ module WebsocketRails
           data[1]['server_token'].should == '1234'
         end
       end
+
+      describe "#as_json" do
+        it "returns a Hash representation of the Event" do
+          hash = { data: { 'test' => 'test'}, channel: :awesome_channel }
+          event = Event.new 'test', hash
+          event.as_json[0].should == :test
+          event.as_json[1][:data].should == hash[:data]
+          event.as_json[1][:channel].should == hash[:channel]
+        end
+      end
     end
 
   end

websocket-rails.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency "redis"
   s.add_dependency "hiredis"
   s.add_dependency "em-synchrony"
+  s.add_dependency "redis-objects"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency 'rspec-matchers-matchers'