faye_tracking 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b5bc32dcffabad6cf234874363c19f599f77a77
-  data.tar.gz: d500ca536492f5d71582271df6a5ebf132ea9286
+  metadata.gz: 59510a6d0b8840e8d1a023e7688cce9e7dcba4b2
+  data.tar.gz: a2eccf51d9d9ae29d31154ac8debffba9368cdc0
 SHA512:
-  metadata.gz: ebb45db8cc27a4d6be278fba007a62bfa8d40379b43373d67a5bdeb0af2995b4e173008d4579e7d3bc9b85f765145bb00b758b3be61c6ee17a9a7546e95f8417
-  data.tar.gz: c87e4dad1e31060b9199a840210d5faef242c9381f16168908c65aae1bf6cf22712155a149aba1fa4c775bdaf9ddce462a51fe3eb8b6c8e9808456baf5cd6181
+  metadata.gz: 98eceda9db22c158a7d46ce1b8998a68b6462304af15ff2a6d61535fee17993666d475d32f16446d97d45680a831c7222cc6023b59556df886addd34a77ffbe3
+  data.tar.gz: be8768b99523474637524d1e24fff8ad4c3e9dd2c05e9dfdf650715d6910db308fe78aa19687b3da910f7ece8055c34194718441eb68f80a5ad2457e3fddedc5

data/README.md

@@ -37,7 +37,7 @@ end
 
 client.add_extension(FayeTracking.faye_extension)
 
-FayeTracking.all_users_in_channel('/chat/1')
+FayeTracking.users_in_channel('/chat/1')
 FayeTracking.user_in_any_channel?('/user_1')
 FayeTracking.user_in_channel?('/user_1', '/chat/1')
 ```
@@ -54,7 +54,7 @@ FayeTrackingExtension =
       message.ext.faye_tracking_client_id = subscription.user_id
     callback(message)
 
-PrivatePub.extensions = [PrivatePubClientIdExtension]
+PrivatePub.extensions = [FayeTrackingExtension]
 
 # To subscribe to a channel
 subscription["user_id"] = user_id
@@ -62,6 +62,12 @@ PrivatePub.sign(subscription)
 PrivatePub.subscribe(subscription.channel, callback)
 ```
 
+## TODO
+
+* <del>Allow one application user to have many Faye `clientId` mappings.</del>
+* Rely on events (instead of extensions) to handle user disconnecting event
+because it's more reliable. (see http://faye.jcoglan.com/ruby/monitoring.html)
+
 ## Contributing
 
 1. Fork it ( https://github.com/he9lin/faye_tracking/fork )

data/lib/faye_tracking.rb

@@ -4,24 +4,14 @@ require 'logger'
 require "faye_tracking/version"
 
 module FayeTracking
-  MAPPING_STORE_NAME = 'client_id_to_user'.freeze
-
   class << self
-    attr_accessor :redis, :logger
+    attr_accessor :logger
+    attr_writer :redis
 
     def configure(&block)
       block.call(self)
     end
 
-    def reset_store
-      raise 'redis is not set' unless redis
-      redis.keys('*').each {|k| redis.del k}
-    end
-
-    def faye_extension
-      @_faye_extension ||= FayeExtension.new(tracker)
-    end
-
     def user_in_any_channel?(user)
       !tracker.channels_for_user(user).empty?
     end
@@ -30,30 +20,34 @@ module FayeTracking
       tracker.user_in_channel?(user, channel)
     end
 
-    def all_users_in_channel(channel)
+    def users_in_channel(channel)
       tracker.users_in_channel(channel)
     end
 
+    def reset_store
+      redis.keys('*').each {|k| redis.del k}
+    end
+
+    def faye_extension
+      @_faye_extension ||= FayeExtension.new(tracker)
+    end
+
     def logger
       @logger ||= Logger.new(STDOUT)
     end
 
-    private
+    def redis
+      @redis || raise('redis is not set')
+    end
 
     def tracker
-      raise 'redis is not set' unless redis
-      @_tracker ||= begin
-        key_list_store = RedisKeyList.new(redis)
-        mapping_store  = RedisMapping.new(redis)
-        Tracker.new(key_list_store, mapping_store)
-      end
+      @_tracker = Tracker.new(redis)
     end
   end
 end
 
 require "faye_tracking/faye_extension"
+require "faye_tracking/tracker"
 require "faye_tracking/store/abstract_key_list"
-require "faye_tracking/store/abstract_mapping"
 require "faye_tracking/store/adapter/redis_key_list"
-require "faye_tracking/store/adapter/redis_mapping"
-require "faye_tracking/tracker"
+require "faye_tracking/store/adapter/namespaced_key_list"

data/lib/faye_tracking/faye_extension.rb

@@ -21,12 +21,14 @@ module FayeTracking
           if app_client_id = ext['faye_tracking_client_id']
             @tracker.add(subs_channel, client_id, app_client_id)
           else
-            message['error'] = "missing ext['faye_tracking_client_id']"
+            error_message = "missing ext['faye_tracking_client_id']"
+            FayeTracking.logger.debug "error with message: #{error_message}"
+            message['error'] = error_message
           end
         when '/meta/unsubscribe'
           @tracker.remove(subs_channel, client_id)
         when '/meta/disconnect'
-          @tracker.remove_user_from_all_channels(client_id)
+          @tracker.remove_all(client_id)
         end
       end
 

data/lib/faye_tracking/store/adapter/namespaced_key_list.rb

@@ -0,0 +1,40 @@
+module FayeTracking
+  class NamespacedKeyList < AbstractKeyList
+    def initialize(ns, key_list)
+      raise ArgumentError, 'namespace param cannot be blank' if ns.nil? || ns.empty?
+      
+      @ns       = ns
+      @key_list = key_list
+    end
+
+    def add(key, value)
+      @key_list.add build_key(key), value
+    end
+
+    def remove(key, value)
+      @key_list.remove build_key(key), value
+    end
+
+    def member?(key, value)
+      @key_list.member? build_key(key), value
+    end
+
+    def members(key)
+      @key_list.members build_key(key)
+    end
+
+    def empty?(key)
+      @key_list.empty? build_key(key)
+    end
+
+    def remove_all(key)
+      @key_list.remove_all build_key(key)
+    end
+
+    private
+
+    def build_key(key)
+      [@ns, key].join(':')
+    end
+  end
+end

data/lib/faye_tracking/tracker.rb

@@ -1,48 +1,71 @@
 module FayeTracking
   class Tracker
-    def initialize(key_list, mapping)
-      @key_list = key_list
-      @mapping = mapping
+    def initialize(redis)
+      @channel_to_client_ids = namespaced_key_list('channel_to_client_ids', redis)
+      @client_id_to_channels = namespaced_key_list('client_id_to_channels', redis)
+      @user_to_client_ids    = namespaced_key_list('user_to_client_ids',    redis)
+      @client_id_to_users    = namespaced_key_list('client_id_to_users',    redis)
     end
 
     def add(channel, client_id, user)
-      @mapping.set(client_id, user)
-      @key_list.add(channel, user)
-      @key_list.add(user, channel)
+      @channel_to_client_ids.add(channel, client_id)
+      @client_id_to_channels.add(client_id, channel)
+      @user_to_client_ids.add(user, client_id)
+      @client_id_to_users.add(client_id, user)
     end
 
     def remove(channel, client_id)
-      if user = @mapping.get(client_id)
-        @key_list.remove(channel, user)
-        @key_list.remove(user, channel)
+      @channel_to_client_ids.remove(channel, client_id)
+      @client_id_to_channels.remove(client_id, channel)
+      @client_id_to_users.members(client_id).each do |user|
+        @user_to_client_ids.remove(user, client_id)
       end
-      @mapping.delete(client_id)
+      @client_id_to_users.remove_all(client_id)
     end
 
-    def remove_user_from_all_channels(client_id)
-      if user = @mapping.get(client_id)
-        channels_for_user(user).each do |channel|
-          @key_list.remove(channel, user)
-        end
-        @key_list.remove_all(user)
+    def remove_all(client_id)
+      @client_id_to_channels.members(client_id).each do |channel|
+        @channel_to_client_ids.remove(channel, client_id)
       end
-      @mapping.delete(client_id)
+      @client_id_to_users.members(client_id).each do |user|
+        @user_to_client_ids.remove(user, client_id)
+      end
+      @client_id_to_users.remove_all(client_id)
+      @client_id_to_channels.remove_all(client_id)
     end
 
     def channels_for_user(user)
-      @key_list.members(user)
+      client_ids = @user_to_client_ids.members(user)
+      client_ids.inject([]) do |acc, client_id|
+        acc += @client_id_to_channels.members(client_id)
+      end.uniq
     end
 
     def users_in_channel(channel)
-      @key_list.members(channel)
+      client_ids = @channel_to_client_ids.members(channel)
+      client_ids.inject([]) do |acc, client_id|
+        acc += @client_id_to_users.members(client_id)
+      end.uniq
     end
 
     def user_in_channel?(user, channel)
-      @key_list.member?(user, channel)
+      client_ids = @user_to_client_ids.members(user)
+      client_ids.any? do |client_id|
+        @channel_to_client_ids.member? channel, client_id
+      end
     end
 
     def channel_has_user?(channel, user)
-      @key_list.member?(channel, user)
+      client_ids = @channel_to_client_ids.members(channel)
+      client_ids.any? do |client_id|
+        @user_to_client_ids.member? user, client_id
+      end
+    end
+
+    private
+
+    def namespaced_key_list(name, redis)
+      NamespacedKeyList.new(name, RedisKeyList.new(redis))
     end
   end
 end

data/lib/faye_tracking/version.rb

@@ -1,3 +1,3 @@
 module FayeTracking
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/faye_tracking_spec.rb

@@ -28,20 +28,22 @@ describe FayeTracking do
     faye_run('/meta/disconnect', nil, client_id, nil)
   end
 
-  context 'subscribing to a channel' do
-    before do
-      faye_subscribe 'room', client_id, 'user_1'
-    end
-
-    it 'adds user to the subscription channel' do
-      expect(described_class.user_in_any_channel?('user_1')).to be_truthy
-      expect(described_class.user_in_channel?('user_1', 'room')).to be_truthy
-      expect(described_class.user_in_channel?('user_2', 'room')).to be_falsey
-    end
-
-    it 'returns all users in a channel' do
-      faye_subscribe 'room', client_id, 'user_2'
-      expect(described_class.all_users_in_channel('room')).to match_array(['user_1', 'user_2'])
+  describe 'subscribing to a channel' do
+    describe 'multiple users' do
+      before do
+        faye_subscribe 'room', client_id, 'user_1'
+      end
+
+      it 'adds user to the subscription channel' do
+        expect(described_class.user_in_any_channel?('user_1')).to be_truthy
+        expect(described_class.user_in_channel?('user_1', 'room')).to be_truthy
+        expect(described_class.user_in_channel?('user_2', 'room')).to be_falsey
+      end
+
+      it 'returns all users in a channel' do
+        faye_subscribe 'room', client_id, 'user_2'
+        expect(described_class.users_in_channel('room')).to match_array(['user_1', 'user_2'])
+      end
     end
   end
 
@@ -53,7 +55,7 @@ describe FayeTracking do
     it 'removes a user from a subscription channel' do
       faye_unsubscribe 'room', client_id
       expect(described_class.user_in_any_channel?('user_1')).to be_falsey
-      expect(described_class.all_users_in_channel('rooom')).to eq([])
+      expect(described_class.users_in_channel('rooom')).to eq([])
 
       faye_subscribe  'room', client_id, 'user_2'
       expect(described_class.user_in_any_channel?('user_2')).to be_truthy
@@ -66,6 +68,23 @@ describe FayeTracking do
     end
   end
 
+  describe 'subscribing/unsubscribing same users with different clientIds' do
+    before do
+      faye_subscribe 'room', client_id, 'user_1'
+      faye_subscribe 'room', another_client_id, 'user_1'
+    end
+
+    it 'user able to have multiple client ids' do
+      expect(described_class.user_in_channel?('user_1', 'room')).to be_truthy
+
+      faye_unsubscribe 'room', client_id
+      expect(described_class.user_in_channel?('user_1', 'room')).to be_truthy
+
+      faye_unsubscribe 'room', another_client_id
+      expect(described_class.user_in_channel?('user_1', 'room')).to be_falsey
+    end
+  end
+
   context 'disconnecting' do
     before do
       faye_subscribe 'room1', client_id, 'user_1'
@@ -76,7 +95,7 @@ describe FayeTracking do
     it 'removes the user from all channels' do
       faye_disconnect(client_id)
       expect(described_class.user_in_any_channel?('user_1')).to be_falsey
-      expect(described_class.all_users_in_channel('room1')).to eq(['user_2'])
+      expect(described_class.users_in_channel('room1')).to eq(['user_2'])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faye_tracking
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Lin He
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,9 +97,8 @@ files:
 - lib/faye_tracking.rb
 - lib/faye_tracking/faye_extension.rb
 - lib/faye_tracking/store/abstract_key_list.rb
-- lib/faye_tracking/store/abstract_mapping.rb
+- lib/faye_tracking/store/adapter/namespaced_key_list.rb
 - lib/faye_tracking/store/adapter/redis_key_list.rb
-- lib/faye_tracking/store/adapter/redis_mapping.rb
 - lib/faye_tracking/tracker.rb
 - lib/faye_tracking/version.rb
 - spec/faye_tracking_spec.rb

data/lib/faye_tracking/store/abstract_mapping.rb

@@ -1,15 +0,0 @@
-module FayeTracking
-  class AbstractMapping
-    def set(key, value)
-      raise NotImplementedError
-    end
-
-    def get(key)
-      raise NotImplementedError
-    end
-
-    def delete(key)
-      raise NotImplementedError
-    end
-  end
-end

data/lib/faye_tracking/store/adapter/redis_mapping.rb

@@ -1,20 +0,0 @@
-module FayeTracking
-  class RedisMapping < AbstractMapping
-    def initialize(redis, name=FayeTracking::MAPPING_STORE_NAME)
-      @name = name
-      @redis = redis
-    end
-
-    def set(key, value)
-      @redis.hset @name, key, value
-    end
-
-    def get(key)
-      @redis.hget @name, key
-    end
-
-    def delete(key)
-      @redis.del @name, key
-    end
-  end
-end