faye_tracking 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d0123db7eee9e890395eddb139417be75a34c2e
+  data.tar.gz: 7c3500c63e854c2682d09380e186a7964f882bbe
+SHA512:
+  metadata.gz: 7170d0eedd7970a7a40a9cf6d9bca655838d2ee52eae058557da61aa49fe9946124cf4d43633d8ba11987ba253e474425c83762653c143b42ff65c833e606a76
+  data.tar.gz: b125a07324654a66d5201893bec935e04f53d19368af8e9f17ab11cd4d7ed0caeb816261b3f1b651647c6b8b2f62ee1be3c6600553c2759c16adbba4274d4bcf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faye_tracking.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Lin He
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# FayeTracking
+
+A Faye extension for tracking user subscriptions, i.e. can be used for
+checking if a user is online.
+
+## Prerequisites
+
+* Faye
+* Redis
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faye_tracking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faye_tracking
+
+## Usage
+
+```ruby
+FayeTracking.configure do |config|
+  config.redis = Redis.new
+end
+
+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)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/he9lin/faye_tracking/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/faye_tracking.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faye_tracking/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faye_tracking"
+  spec.version       = FayeTracking::VERSION
+  spec.authors       = ["Lin He"]
+  spec.email         = ["he9lin@gmail.com"]
+  spec.summary       = %q{Faye extension for tracking user subscriptions}
+  spec.description   = %q{Faye extension for tracking user subscriptions, i.e. can be used for checking if a user is online.}
+  spec.homepage      = "https://github.com/he9lin/faye_tracking"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "redis", "~> 3.0"
+
+  spec.add_development_dependency "redis-namespace", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/faye_tracking/version.rb

@@ -0,0 +1,3 @@
+module FayeTracking
+  VERSION = "0.0.1"
+end

data/lib/faye_tracking.rb

@@ -0,0 +1,45 @@
+require 'redis'
+require 'redis-namespace'
+require "faye_tracking/version"
+
+module FayeTracking
+  class << self
+    attr_accessor :redis
+
+    def configure(&block)
+      block.call(self)
+    end
+
+    def reset_store
+      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
+
+    def user_in_channel?(user, channel)
+      tracker.user_in_channel?(user, channel)
+    end
+
+    def all_users_in_channel(channel)
+      tracker.users_in_channel(channel)
+    end
+
+    private
+
+    def tracker
+      raise 'redis is not set' unless redis
+      @_tracker ||= Tracker.new(RedisStore.new(redis))
+    end
+  end
+end
+
+require "faye_tracking/faye_extension"
+require "faye_tracking/abstract_store"
+require "faye_tracking/redis_store"
+require "faye_tracking/tracker"

data/spec/faye_tracking/abstract_store.rb

@@ -0,0 +1,23 @@
+module FayeTracking
+  class AbstractStore
+    def add(key, value)
+      raise NotImplementedError
+    end
+
+    def remove(key, value)
+      raise NotImplementedError
+    end
+
+    def member?(key, value)
+      raise NotImplementedError
+    end
+
+    def members(key)
+      raise NotImplementedError
+    end
+
+    def empty?(key)
+      raise NotImplementedError
+    end
+  end
+end

data/spec/faye_tracking/faye_extension.rb

@@ -0,0 +1,27 @@
+module FayeTracking
+  class FayeExtension
+    MONITORED_CHANNELS = [ '/meta/subscribe', '/meta/disconnect' ]
+
+    def initialize(tracker)
+      @tracker = tracker
+    end
+
+    def incoming(message, callback)
+      return callback.call(message) unless MONITORED_CHANNELS.include? message['channel']
+
+      unless message['error']
+        subs_channel  = message['subscription']
+        app_client_id = message['ext']['faye_tracking_client_id']
+
+        case message['channel']
+        when '/meta/subscribe'
+          @tracker.add(subs_channel, app_client_id)
+        when '/meta/disconnect'
+          @tracker.remove(subs_channel, app_client_id)
+        end
+      end
+
+      callback.call(message)
+    end
+  end
+end

data/spec/faye_tracking/faye_extension_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe FayeTracking::FayeExtension do
+end

data/spec/faye_tracking/redis_store.rb

@@ -0,0 +1,27 @@
+module FayeTracking
+  class RedisStore < AbstractStore
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def add(key, value)
+      @redis.sadd key, value
+    end
+
+    def remove(key, value)
+      @redis.srem key, value
+    end
+
+    def member?(key, value)
+      @redis.sismember key, value
+    end
+
+    def members(key)
+      @redis.smembers key
+    end
+
+    def empty?(key)
+      @redis.smembers(key).empty?
+    end
+  end
+end

data/spec/faye_tracking/tracker.rb

@@ -0,0 +1,33 @@
+module FayeTracking
+  class Tracker
+    def initialize(store)
+      @store = store
+    end
+
+    def add(channel, user)
+      @store.add(channel, user)
+      @store.add(user, channel)
+    end
+
+    def remove(channel, user)
+      @store.remove(channel, user)
+      @store.remove(user, channel)
+    end
+
+    def channels_for_user(user)
+      @store.members(user)
+    end
+
+    def users_in_channel(channel)
+      @store.members(channel)
+    end
+
+    def user_in_channel?(user, channel)
+      @store.member?(user, channel)
+    end
+
+    def channel_has_user?(channel, user)
+      @store.member?(channel, user)
+    end
+  end
+end

data/spec/faye_tracking_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe FayeTracking do
+  before(:each) 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
+    FayeTracking.faye_extension.incoming(message, lambda { |m| m })
+  end
+
+  def faye_subscribe(channel, user)
+    faye_run('/meta/subscribe', channel, user)
+  end
+
+  def faye_disconnect(channel, user)
+    faye_run('/meta/disconnect', channel, user)
+  end
+
+  context 'subscribing to a channel' do
+    before do
+      faye_subscribe 'room', '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', '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
+    before do
+      faye_subscribe 'room', 'user_1'
+    end
+
+    it 'removes a user from a subscription channel' do
+      faye_disconnect 'room', 'user_1'
+      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'
+      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'
+      }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path(File.join File.dirname(__FILE__), '..', 'lib')
+
+require 'faye_tracking'
+
+FayeTracking.configure do |config|
+  config.redis = Redis::Namespace.new(:faye_tracking_test, redis: Redis.new)
+end
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: faye_tracking
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lin He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Faye extension for tracking user subscriptions, i.e. can be used for
+  checking if a user is online.
+email:
+- he9lin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faye_tracking.gemspec
+- lib/faye_tracking.rb
+- lib/faye_tracking/version.rb
+- spec/faye_tracking/abstract_store.rb
+- spec/faye_tracking/faye_extension.rb
+- spec/faye_tracking/faye_extension_spec.rb
+- spec/faye_tracking/redis_store.rb
+- spec/faye_tracking/tracker.rb
+- spec/faye_tracking_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/he9lin/faye_tracking
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Faye extension for tracking user subscriptions
+test_files:
+- spec/faye_tracking/abstract_store.rb
+- spec/faye_tracking/faye_extension.rb
+- spec/faye_tracking/faye_extension_spec.rb
+- spec/faye_tracking/redis_store.rb
+- spec/faye_tracking/tracker.rb
+- spec/faye_tracking_spec.rb
+- spec/spec_helper.rb
+has_rdoc: