faye_tracking 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e65dc0c10240816a421e137aa34bbb0d1a31bf8b
-  data.tar.gz: ff775198df38629943868fd204a592e77cac9e46
+  metadata.gz: 7fcbc653ce1ea17f6709545fd5ac543cee22bfae
+  data.tar.gz: 4ea9bc79243cb02c01cff7a846c65c4165aa0447
 SHA512:
-  metadata.gz: c8c584abc579d57ac7d091462aada28192503edca65eb7371bccd9e130a176a586d86be5ed4904c7949495cf188da93d73aa6fd9f91e9c99dfb64d2e49243268
-  data.tar.gz: 07d9b9f1f3e5adbdc827086cefbfe46a7e344b3deba479a2c2aa9b6eeefead78251c7dd911c02635054601acc98e822be3922a963c003e911dc73caf15985341
+  metadata.gz: 468a983f7595f5d4965d180bb8bfe52145409e0373c1d79c53c5c6acc173cb576022246527696f91f1ab72d798dd789a6ae084a511199b12219c95b145da545a
+  data.tar.gz: 41c937b43b00d5f16ed23bd6a7af702ec9b8457567848836e9e8b57ee0c0e8ef607f5772f847c24db0c0c0989107b81f11b6a2b23445eea63193394138d492d6

data/README.md

@@ -3,6 +3,8 @@
 A Faye extension for tracking user subscriptions, i.e. can be used for
 checking if a user is online.
 
+BUT: http://faye.jcoglan.com/ruby/monitoring.html
+
 ## Prerequisites
 
 * Faye
@@ -26,16 +28,38 @@ Or install it yourself as:
 
 ## Usage
 
+Set it up:
+
 ```ruby
 FayeTracking.configure do |config|
   config.redis = Redis.new
 end
 
+client.add_extension(FayeTracking.faye_extension)
+
 FayeTracking.all_users_in_channel('/chat/1')
 FayeTracking.user_in_any_channel?('/user_1')
 FayeTracking.user_in_channel?('/user_1', '/chat/1')
+```
 
-client.add_extension(FayeTracking.faye_extension)
+Client side: a PrivatePub example using a fork here: https://github.com/he9lin/private_pub, which makes it possible to add client side Faye extensions to PrivatePub javascript.
+
+```coffeescript
+FayeTrackingExtension =
+  outgoing: (message, callback) ->
+    if message.channel == "/meta/subscribe"
+      # Attach the user id to subscription messages
+      subscription = PrivatePub.subscriptions[message.subscription]
+      message.ext ?= {}
+      message.ext.faye_tracking_client_id = subscription.user_id
+    callback(message)
+
+PrivatePub.extensions = [PrivatePubClientIdExtension]
+
+# To subscribe to a channel
+subscription["user_id"] = user_id
+PrivatePub.sign(subscription)
+PrivatePub.subscribe(subscription.channel, callback)
 ```
 
 ## Contributing

data/lib/faye_tracking/faye_extension.rb

@@ -1,6 +1,6 @@
 module FayeTracking
   class FayeExtension
-    MONITORED_CHANNELS = [ '/meta/subscribe', '/meta/disconnect' ]
+    MONITORED_CHANNELS = [ '/meta/subscribe', '/meta/unsubscribe', '/meta/disconnect' ]
 
     def initialize(tracker)
       @tracker = tracker
@@ -9,15 +9,24 @@ module FayeTracking
     def incoming(message, callback)
       return callback.call(message) unless MONITORED_CHANNELS.include? message['channel']
 
+      FayeTracking.logger.debug "received incoming message: #{message}"
+
       unless message['error']
         subs_channel  = message['subscription']
-        app_client_id = message['ext']['faye_tracking_client_id']
+        client_id     = message['clientId']
 
         case message['channel']
         when '/meta/subscribe'
-          @tracker.add(subs_channel, app_client_id)
+          ext = message['ext']
+          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']"
+          end
+        when '/meta/unsubscribe'
+          @tracker.remove(subs_channel, client_id)
         when '/meta/disconnect'
-          @tracker.remove(subs_channel, app_client_id)
+          @tracker.remove_user_from_all_channels(client_id)
         end
       end
 

data/lib/faye_tracking/{abstract_store.rb → store/abstract_key_list.rb}

@@ -1,5 +1,5 @@
 module FayeTracking
-  class AbstractStore
+  class AbstractKeyList
     def add(key, value)
       raise NotImplementedError
     end
@@ -19,5 +19,9 @@ module FayeTracking
     def empty?(key)
       raise NotImplementedError
     end
+
+    def remove_all(key)
+      raise NotImplementedError
+    end
   end
 end

data/lib/faye_tracking/store/abstract_mapping.rb

@@ -0,0 +1,15 @@
+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/{redis_store.rb → store/adapter/redis_key_list.rb}

@@ -1,5 +1,5 @@
 module FayeTracking
-  class RedisStore < AbstractStore
+  class RedisKeyList < AbstractKeyList
     def initialize(redis)
       @redis = redis
     end
@@ -23,5 +23,9 @@ module FayeTracking
     def empty?(key)
       @redis.smembers(key).empty?
     end
+
+    def remove_all(key)
+      @redis.del(key)
+    end
   end
 end

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

@@ -0,0 +1,20 @@
+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

data/lib/faye_tracking/tracker.rb

@@ -1,33 +1,46 @@
 module FayeTracking
   class Tracker
-    def initialize(store)
-      @store = store
+    def initialize(key_list, mapping)
+      @key_list = key_list
+      @mapping = mapping
     end
 
-    def add(channel, user)
-      @store.add(channel, user)
-      @store.add(user, channel)
+    def add(channel, client_id, user)
+      @mapping.set(client_id, user)
+      @key_list.add(channel, user)
+      @key_list.add(user, channel)
     end
 
-    def remove(channel, user)
-      @store.remove(channel, user)
-      @store.remove(user, channel)
+    def remove(channel, client_id)
+      if user = @mapping.get(client_id)
+        @key_list.remove(channel, user)
+        @key_list.remove(user, channel)
+      end
+    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)
+      end
     end
 
     def channels_for_user(user)
-      @store.members(user)
+      @key_list.members(user)
     end
 
     def users_in_channel(channel)
-      @store.members(channel)
+      @key_list.members(channel)
     end
 
     def user_in_channel?(user, channel)
-      @store.member?(user, channel)
+      @key_list.member?(user, channel)
     end
 
     def channel_has_user?(channel, user)
-      @store.member?(channel, user)
+      @key_list.member?(channel, user)
     end
   end
 end

data/lib/faye_tracking/version.rb

@@ -1,3 +1,3 @@
 module FayeTracking
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/faye_tracking.rb

@@ -1,16 +1,20 @@
 require 'redis'
 require 'redis-namespace'
+require 'logger'
 require "faye_tracking/version"
 
 module FayeTracking
+  MAPPING_STORE_NAME = 'client_id_to_user'.freeze
+
   class << self
-    attr_accessor :redis
+    attr_accessor :redis, :logger
 
     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
 
@@ -30,16 +34,26 @@ module FayeTracking
       tracker.users_in_channel(channel)
     end
 
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
     private
 
     def tracker
       raise 'redis is not set' unless redis
-      @_tracker ||= Tracker.new(RedisStore.new(redis))
+      @_tracker ||= begin
+        key_list_store = RedisKeyList.new(redis)
+        mapping_store  = RedisMapping.new(redis)
+        Tracker.new(key_list_store, mapping_store)
+      end
     end
   end
 end
 
 require "faye_tracking/faye_extension"
-require "faye_tracking/abstract_store"
-require "faye_tracking/redis_store"
+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"

data/spec/faye_tracking_spec.rb

@@ -5,24 +5,32 @@ describe FayeTracking do
     FayeTracking.reset_store
   end
 
-  def faye_run(meta_action, channel, user)
-    message = {"channel" => meta_action, "ext" => {}}
-    message["subscription"] = channel
-    message["ext"]["faye_tracking_client_id"] = user
+  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
+    message["ext"] = { "faye_tracking_client_id" => user } if user
+
     FayeTracking.faye_extension.incoming(message, lambda { |m| m })
   end
 
-  def faye_subscribe(channel, user)
-    faye_run('/meta/subscribe', channel, user)
+  def faye_subscribe(channel, client_id, user)
+    faye_run('/meta/subscribe', channel, client_id, user)
+  end
+
+  def faye_unsubscribe(channel, client_id)
+    faye_run('/meta/unsubscribe', channel, client_id, nil)
   end
 
-  def faye_disconnect(channel, user)
-    faye_run('/meta/disconnect', channel, user)
+  def faye_disconnect(client_id)
+    faye_run('/meta/disconnect', nil, client_id, nil)
   end
 
   context 'subscribing to a channel' do
     before do
-      faye_subscribe 'room', 'user_1'
+      faye_subscribe 'room', client_id, 'user_1'
     end
 
     it 'adds user to the subscription channel' do
@@ -32,29 +40,43 @@ describe FayeTracking do
     end
 
     it 'returns all users in a channel' do
-      faye_subscribe 'room', 'user_2'
+      faye_subscribe 'room', client_id, 'user_2'
       expect(described_class.all_users_in_channel('room')).to match_array(['user_1', 'user_2'])
     end
   end
 
-  context 'disconnecting to a channel' do
+  context 'unsubscribing a channel' do
     before do
-      faye_subscribe 'room', 'user_1'
+      faye_subscribe 'room', client_id, 'user_1'
     end
 
     it 'removes a user from a subscription channel' do
-      faye_disconnect 'room', 'user_1'
+      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([])
 
-      faye_subscribe  'room', 'user_2'
+      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_disconnect 'room', 'user_2'
+        faye_unsubscribe 'room', 'user_2'
       }.to_not raise_error
     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.all_users_in_channel('room1')).to eq(['user_2'])
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'faye_tracking'
 
 FayeTracking.configure do |config|
   config.redis = Redis::Namespace.new(:faye_tracking_test, redis: Redis.new)
+  config.logger.level = Logger::INFO
 end
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faye_tracking
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Lin He
@@ -95,9 +95,11 @@ files:
 - Rakefile
 - faye_tracking.gemspec
 - lib/faye_tracking.rb
-- lib/faye_tracking/abstract_store.rb
 - lib/faye_tracking/faye_extension.rb
-- lib/faye_tracking/redis_store.rb
+- lib/faye_tracking/store/abstract_key_list.rb
+- lib/faye_tracking/store/abstract_mapping.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