session_tracker 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p0@session_tracker --create

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2, :all_on_start => false,
+               :all_after_pass => false, :bundler => false,
+               :keep_failed => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -0,0 +1,67 @@
+# SessionTracker
+
+Track active sessions in redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'session_tracker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install session_tracker
+
+## Usage
+
+In your ApplicationController:
+
+    before_filter :track_active_sessions
+
+    def track_active_sessions
+      SessionTracker.new("user", $redis).track(session[:session_id])
+    end
+
+Then to view the current state:
+
+    SessionTracker.new("user", $redis).active_users
+
+If redis is accessible through $redis, you don't have to give it as an argument to SessionTracker.new.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits and license
+
+Inspired by [http://www.lukemelia.com/blog/archives/2010/01/17/redis-in-practice-whos-online/](http://www.lukemelia.com/blog/archives/2010/01/17/redis-in-practice-whos-online/).
+
+By [Joakim Kolsjö](https://github.com/joakimk) under the MIT license:
+
+>  Copyright (c) 2012 Joakim Kolsjö
+>
+>  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/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*.rb'
+end
+
+task :default => :spec

data/lib/session_tracker/version.rb

@@ -0,0 +1,3 @@
+class SessionTracker
+  VERSION = "0.0.1"
+end

data/lib/session_tracker.rb

@@ -0,0 +1,35 @@
+require 'time'
+
+class SessionTracker
+  ONE_HOUR = 60 * 60
+
+  def initialize(type, redis = $redis)
+    @type = type
+    @redis = redis
+  end
+
+  def track(id, time = Time.now)
+    return unless id
+    key = key_for(time)
+    @redis.sadd(key, id)
+    @redis.expire(key, ONE_HOUR - 60)
+  rescue
+    # This is called for every request and is probably not essential for the app
+    # so we don't want to raise errors just because redis is down for a few seconds.
+  end
+
+  def active_users(time = Time.now)
+    @redis.sunion(*keys_for_last_3_minutes(time)).size
+  end
+
+  private
+  
+  def keys_for_last_3_minutes(time)
+    times = 0.upto(2).map { |n| time - (n * 60) }
+    times.map { |t| key_for(t) }
+  end
+
+  def key_for(time)
+    "active_#{@type}_sessions_minute_#{time.strftime("%M")}"
+  end
+end

data/session_tracker.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/session_tracker', __FILE__)
+require File.expand_path('../lib/session_tracker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joakim Kolsjö"]
+  gem.email         = ["joakim.kolsjo@gmail.com"]
+  gem.description   = %q{Track active user sessions in redis}
+  gem.summary       = %q{Track active user sessions in redis}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "session_tracker"
+  gem.require_paths = ["lib"]
+  gem.version       = SessionTracker::VERSION
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+end

data/spec/session_tracker_spec.rb

@@ -0,0 +1,57 @@
+require 'session_tracker'
+
+describe SessionTracker, "track" do
+  
+  let(:redis) { mock.as_null_object }
+
+  it "should store the user in a set for the current minute" do
+    time = Time.parse("15:04")
+    redis.should_receive(:sadd).with("active_customer_sessions_minute_04", "abc123")
+    tracker = SessionTracker.new("customer", redis)
+    tracker.track("abc123", time)
+  end
+
+  it "should expire the set within an hour to prevent it wrapping around" do
+    time = Time.parse("15:59")
+    redis.should_receive(:expire).with("active_customer_sessions_minute_59", 60 * 59)
+    tracker = SessionTracker.new("customer", redis)
+    tracker.track("abc123", time)
+  end
+
+  it "should be able to track different types of sessions" do
+    time = Time.parse("15:04")
+    redis.should_receive(:sadd).with("active_employee_sessions_minute_04", "abc456")
+    tracker = SessionTracker.new("employee", redis)
+    tracker.track("abc456", time)
+  end
+
+  it "should do nothing if the session id is nil" do
+    redis.should_not_receive(:sadd)
+    redis.should_not_receive(:expire)
+    tracker = SessionTracker.new("employee", redis)
+    tracker.track(nil)
+  end
+
+  it "should not raise any errors" do
+    redis.should_receive(:expire).and_raise('fail')
+    tracker = SessionTracker.new("customer", redis)
+    tracker.track("abc123", Time.now)
+  end
+
+end
+
+describe SessionTracker, "active_users" do
+
+  let(:redis) { mock.as_null_object }
+
+  it "should do a union on the last 3 minutes to get a active user count" do
+    time = Time.parse("13:09")
+    redis.should_receive(:sunion).with("active_customer_sessions_minute_09",
+                                       "active_customer_sessions_minute_08",
+                                       "active_customer_sessions_minute_07").
+                                       and_return([ mock, mock ])
+
+    SessionTracker.new("customer", redis).active_users(time).should == 2
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: session_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joakim Kolsjö
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152640440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152640440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152639960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152639960
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2152639540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152639540
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2152639080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152639080
+description: Track active user sessions in redis
+email:
+- joakim.kolsjo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/session_tracker.rb
+- lib/session_tracker/version.rb
+- session_tracker.gemspec
+- spec/session_tracker_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Track active user sessions in redis
+test_files:
+- spec/session_tracker_spec.rb