faye_tracking 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03b77bd441cd1b040c107dae67ed6c01fdfae790
-  data.tar.gz: 5b3a8a50c73fd8de5fdb28cf3176aafe3bf29c53
+  metadata.gz: 3d632c5493a22f757f2b0303fb47f84d12066440
+  data.tar.gz: 54cc0a7362c2276f0c99e94f4514275583cae9df
 SHA512:
-  metadata.gz: 5a2f72a7ccda879cbbb21e5bc1b69e5e07df92cfaa126d8d4e439dfd3ae3036d11f6e212d74d3b4ff6466d1a467e41ab9273fd55e8fd3199143ec912cba9545f
-  data.tar.gz: 62ee8a2c0d8ab1b09728717357a072fdefcd7936facca921429c6361741870c3c5e13634a0946707e1e853be69f94f73eef57e80b5958933001c7463f7c5e11e
+  metadata.gz: b0cd9f00bf48fa591079ea9e68ed6bff1e2a0b5c97207e1cf56288e7542b34da86788300f60bbe5e0f7ae6e3f1296c52f553adcc15691ebf2587ec5f3d2a142f
+  data.tar.gz: 194aea886aae0dd094017530891aad132676342e4b03978506bf35b57273032506868480e33e6b1a8ee7a7d9f6ae26ac9d7a6e37b54e94ace15a8d2f20800bd0

data/lib/faye_tracking.rb

@@ -24,6 +24,14 @@ module FayeTracking
       tracker.users_in_channel(channel)
     end
 
+    def user_with_client_id(client_id)
+      tracker.user_with_client_id(client_id)
+    end
+
+    def remove_from_channel(channel, client)
+      tracker.remove(channel, client)
+    end
+
     def reset_store
       redis.keys('*').each {|k| redis.del k}
     end
@@ -64,6 +72,6 @@ end
 
 require "faye_tracking/faye_extension"
 require "faye_tracking/tracker"
-require "faye_tracking/store/abstract_key_list"
-require "faye_tracking/store/adapter/redis_key_list"
-require "faye_tracking/store/adapter/namespaced_key_list"
+require "faye_tracking/abstract_key_list"
+require "faye_tracking/redis_key_list"
+require "faye_tracking/namespaced_key_list"

data/lib/faye_tracking/faye_extension.rb

@@ -17,17 +17,16 @@ module FayeTracking
       FayeTracking.logger.debug "received incoming message: #{message}"
 
       unless message['error']
-        subs_channel  = message['subscription']
-        client_id     = message['clientId']
+        subs_channel = message['subscription']
+        client_id    = message['clientId']
+        run_subscribe_callbacks = false
 
         case message['channel']
         when '/meta/subscribe'
           ext = message['ext']
           if app_client_id = ext['faye_tracking_client_id']
             @tracker.add(subs_channel, client_id, app_client_id)
-            FayeTracking.run_on_subscribe_callbacks(
-              client_id, app_client_id, subs_channel
-            )
+            run_subscribe_callbacks = true
           else
             error_message = "missing ext['faye_tracking_client_id']"
             FayeTracking.logger.error "error with message: #{error_message}"
@@ -36,13 +35,16 @@ module FayeTracking
         when '/meta/unsubscribe'
           # This is not reliable, more robust way to detect unsubscribe event.
           # see: http://faye.jcoglan.com/ruby/monitoring.html
-          @tracker.remove(subs_channel, client_id)
-        when '/meta/disconnect'
-          @tracker.remove_all(client_id)
         end
       end
 
       callback.call(message)
+
+      if run_subscribe_callbacks
+        FayeTracking.run_on_subscribe_callbacks(
+          client_id, app_client_id, subs_channel
+        )
+      end
     end
   end
 end

data/lib/faye_tracking/tracker.rb

@@ -14,6 +14,10 @@ module FayeTracking
       @client_id_to_users.add(client_id, user)
     end
 
+    def user_with_client_id(client_id)
+      @client_id_to_users.members(client_id).first
+    end
+
     def remove(channel, client_id)
       @channel_to_client_ids.remove(channel, client_id)
       @client_id_to_channels.remove(client_id, channel)

data/lib/faye_tracking/version.rb

@@ -1,3 +1,3 @@
 module FayeTracking
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/faye_tracking/tracker_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe FayeTracking::Tracker do
+  let(:tracker)   { described_class.new(FayeTracking.redis) }
+  let(:channel)   { 'room' }
+  let(:client_id) { 'abcdefg123456' }
+  let(:user_id)   { 'user_1' }
+
+  before(:each) do
+    FayeTracking.reset_store
+  end
+
+  describe '#remove' do
+    before do
+      tracker.add(channel, client_id, user_id)
+      expect(tracker.users_in_channel(channel)).to_not be_empty
+    end
+
+    it 'removes a user from a channel' do
+      tracker.remove channel, client_id
+      expect(tracker.users_in_channel(channel)).to be_empty
+    end
+
+    it 'does not raise error when removing a non-existing user' do
+      expect {
+        tracker.remove channel, 'invalid_user'
+      }.to_not raise_error
+    end
+  end
+end

data/spec/faye_tracking_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 describe FayeTracking do
+  let(:client_id)         { 'abcdefg123456' }
+  let(:another_client_id) { 'anotherclient' }
+
   before(:each) do
     FayeTracking.reset_store
   end
 
-  let(:client_id)         { 'rpy799jnfeq' }
-  let(:another_client_id) { '651w533ncba' }
-
   def faye_run(meta_action, subscription, client_id, user)
     message = { "channel"  => meta_action, "clientId" => client_id }
     message["subscription"] = subscription                 if subscription
@@ -45,70 +45,37 @@ describe FayeTracking do
         expect(described_class.users_in_channel('room')).to \
           match_array(['user_1', 'user_2'])
       end
+
+      it 'associate client_id with user' do
+        faye_subscribe 'room', client_id, 'user_2'
+        expect(described_class.user_with_client_id(client_id)).to eq('user_2')
+      end
     end
 
     describe 'customize subscribe block' do
       it 'can set a customize subscribe block' do
         result = nil
-        FayeTracking.on_subscribe do |client_id, user_id, channel|
+        described_class.on_subscribe do |client_id, user_id, channel|
           result = [client_id, user_id, channel]
         end
         faye_subscribe 'room', client_id, 'user_1'
         expect(result).to eq([client_id, 'user_1', 'room'])
-        FayeTracking.reset_on_subscribe_callbacks
+        described_class.reset_on_subscribe_callbacks
       end
     end
   end
 
-  context 'unsubscribing a channel' do
-    before do
-      faye_subscribe 'room', client_id, 'user_1'
-    end
-
-    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.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
-    end
-
-    it 'does not raise error when removing a non-existing user' do
-      expect {
-        faye_unsubscribe 'room', 'user_2'
-      }.to_not raise_error
-    end
-  end
-
-  describe 'subscribing/unsubscribing same users with different clientIds' do
-    before do
+  describe 'subscribing same user with different clientIds' do
+    it 'user able to have multiple client ids' 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
+      described_class.remove_from_channel 'room', client_id
       expect(described_class.user_in_channel?('user_1', 'room')).to be_truthy
 
-      faye_unsubscribe 'room', another_client_id
+      described_class.remove_from_channel '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'
-      faye_subscribe 'room2', client_id, 'user_1'
-      faye_subscribe 'room1', another_client_id, 'user_2'
-    end
-
-    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.users_in_channel('room1')).to eq(['user_2'])
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faye_tracking
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Lin He
@@ -95,12 +95,13 @@ files:
 - Rakefile
 - faye_tracking.gemspec
 - lib/faye_tracking.rb
+- lib/faye_tracking/abstract_key_list.rb
 - lib/faye_tracking/faye_extension.rb
-- lib/faye_tracking/store/abstract_key_list.rb
-- lib/faye_tracking/store/adapter/namespaced_key_list.rb
-- lib/faye_tracking/store/adapter/redis_key_list.rb
+- lib/faye_tracking/namespaced_key_list.rb
+- lib/faye_tracking/redis_key_list.rb
 - lib/faye_tracking/tracker.rb
 - lib/faye_tracking/version.rb
+- spec/faye_tracking/tracker_spec.rb
 - spec/faye_tracking_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/he9lin/faye_tracking
@@ -128,6 +129,7 @@ signing_key:
 specification_version: 4
 summary: Faye extension for tracking user subscriptions
 test_files:
+- spec/faye_tracking/tracker_spec.rb
 - spec/faye_tracking_spec.rb
 - spec/spec_helper.rb
 has_rdoc: