session_countdown 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+README.html
+*.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kevin Swope
+
+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.rdoc

@@ -0,0 +1,149 @@
+
+= session_countdown
+
+
+A Ruby on Rails plugin that puts a countdown timer on the session
+object.
+
+  session.countdown_run(30.minutes)
+  session.countdown_running? # => true
+  session.countdown_expire
+  session.countdown_running? # => false
+  session.countdown_expired? # => true
+  session.countdown_restart
+  session.countdown_running? # => true
+
+=== But why?!?
+
+Sometimes I need to build my own custom rails authentication systems
+rather than use plugins such as Authlogic, Devise or
+restful_authentication.
+
+There is always a "timer" in my custom authentication contraptions,
+and there is always a session object lurking when I'm dealing with
+authentication stuff, so why not combine the two?
+
+== API
+
+
+<i>Note that except for countdown_run() and countdown_running?() all
+the public methods will throw a NoCountdown exception if called on a
+non-existent countdown timer.</i>
+
+
+Start a countdown timer
+
+   session.countdown_run(seconds, name = :default)
+
+<i>You can have multiple countdown timers if you name them.  The
+default countdown timer is named "default".</i>
+
+Check if a countdown timer exists and is currently running
+
+   session.countdown_running?(name = :default)
+
+Expire early
+
+   session.countdown_expire(name = :default)
+
+Restart, using the duration supplied to countdown_run
+
+   session.countdown_restart(name = :default)
+
+Check if expired
+
+   session.countdown_expired?(name = :default)
+
+<i>countdown_expired? is not the reverse of countdown_running?
+because only works on an existing countdown, otherwise it will throw a
+NoCountdown exception.  Its use will reveal only if an existing
+countdown is expired.  The statement !countdown_running?  can't tell
+you if the countdown has expired because it will return true if there
+was no countdown in the first place.</i>
+
+Remaining time in seconds
+
+   session.countdown_count(name = :default)
+
+
+= Synopsis
+
+=== In application_controller.rb
+
+  before_filter :authorize
+
+
+  def authorize
+    if session.countdown_running?
+      session.countdown_restart # give user more time
+    else
+      session[:original_uri] = request.request_uri
+      flash[:notice] = session.countdown_expired? ? "Login Expired" : "Please login"
+      redirect_to :login
+    end
+  end
+
+
+=== In any controller
+
+  def login
+    user = User.find_by_email(params[:email)
+    if user && user.password_matches?(params[:password])
+      session.countdown_run(1.hour)
+      redirect_to :controller => :private
+    else
+      flash.now[:notice] = "Sorry, email/password wrong"
+      render :index
+    end
+
+  end
+
+  def logout
+    session.countdown_expire
+    flash[:notice] = "You are now logged out"
+    redirect_to :index
+  end
+
+
+=== In user model
+
+  def before_save
+    if self.password_changed?
+      self.salt = SecureRandom.hex(10)
+      self.password = Digest::MD5.hexdigest(self.salt + self.password)
+    end
+  end
+
+  def password_matches?(password_to_match)
+    self.password == Digest::MD5.hexdigest(self.salt + password_to_match)
+  end
+
+
+=== Note: Remember me
+
+If you want an "remember me" feature you need to do two things.
+
+Set timer for far future when user checks "remember me"
+
+  session.countdown_run(1.year)
+
+Tell rails to serve up a persistent cookie instead of session cookie,
+probably in application_controller.rb
+
+  ActionController::Base.session_options[:expire_after] = 1.year
+
+=== Persistent vs session cookies
+
+There are two types of browser cookies: ones with expiration dates and
+ones without.  When a cookie doesnt have an expiration date it's a
+<i>session</i> cookie and will be deleted when the browser quits.  If
+the cookie has an expiration date it's a <i>persistent</i> cookie
+(a.k.a. domain cookie) and will be valid until that date.
+
+"Remember me" could work fine with only session cookies, provided the
+user never quits the browser, but users expect "remember me" to never
+expire their login <i>and</i> to persist across browser quits.  It
+also makes sense to set a far future expiration date or the cookie
+will eventually expire before the login does.
+
+

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    summary = "A Ruby on Rails plugin that puts a countdown timer on the session object"
+    gem.name = "session_countdown"
+    gem.summary = summary
+    gem.description = summary
+    gem.email = "gems-kevdev@snkmail.com"
+    gem.homepage = "http://github.com/kswope/session_countdown"
+    gem.authors = ["Kevin Swope"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "build README.html from README.doc (for previewing in browser)"
+task :readme do
+  system "rdoc README.rdoc --one-file > README.html"
+end
+
+task :default => :test
+task :test => [:test_rails2x, :test_rails3x]
+
+task :test_rails2x do |t|
+  chdir "test/rails2x_root" do
+    system "rake"
+  end
+end
+
+task :test_rails3x do |t|
+  chdir "test/rails3x_root" do
+    system "rake"
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/session_countdown.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'action_controller'
+
+
+class NoCountdown < Exception; end
+
+module SessionCountdown
+
+  @@default_name = "default"
+
+  def countdown_run(delta, name = @@default_name)
+    self[get_zero_key(name)] = Time.now + delta
+    self[get_zero_delta_key(name)] = delta # save for reset
+  end
+
+  def countdown_running?(name = @@default_name)
+    self[get_zero_key(name)] && self[get_zero_key(name)] > Time.now
+  end
+
+  # sanity check for existing countdown for some methods
+  def method_missing(method, *args)
+    check_countdown_exists(*args) # reason for this method_missing()
+    method = "_#{method}"
+    respond_to?(method) ? send(method, *args) : raise(NoMethodError)
+  end
+
+  ## these methods all require a sanity check for existing countdown
+
+  def _countdown_expire(name = @@default_name)
+    self[get_zero_key(name)] = Time.now
+  end
+
+  def _countdown_expired?(name = @@default_name)
+    ! countdown_running?(name)
+  end
+
+  def _countdown_restart(name = @@default_name)
+    self[get_zero_key(name)] = Time.now + self[get_zero_delta_key(name)]
+  end
+
+  def _countdown_count(name = @@default_name)
+    remaining = (self[get_zero_key(name)] - Time.now)
+    (remaining > 0) ? remaining : 0
+  end
+
+
+  private #~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*
+
+
+  def get_zero_key(name)
+    "session_countdown:#{name}"
+  end
+
+  def get_zero_delta_key(name)
+    "session_countdown:#{name}_delta"
+  end
+
+  def check_countdown_exists(name = @@default_name)
+    unless self[get_zero_key(name)]
+      raise NoCountdown, "no session countdown named '#{name}'"
+    end
+  end
+
+end
+
+
+if Rails::VERSION::MAJOR == 2
+
+  class ActionController::Session::AbstractStore::SessionHash
+    include SessionCountdown
+  end
+
+else
+
+  class ActionDispatch::Session::AbstractStore::SessionHash
+    include SessionCountdown
+  end
+
+end
+

data/session_countdown.gemspec

@@ -0,0 +1,141 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{session_countdown}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Swope"]
+  s.date = %q{2010-08-05}
+  s.description = %q{A Ruby on Rails plugin that puts a countdown timer on the session object}
+  s.email = %q{gems-kevdev@snkmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/session_countdown.rb",
+     "session_countdown.gemspec",
+     "test/common/test_controller_test.rb",
+     "test/rails2x_root/Rakefile",
+     "test/rails2x_root/app/controllers/application_controller.rb",
+     "test/rails2x_root/app/controllers/test_controller.rb",
+     "test/rails2x_root/app/helpers/application_helper.rb",
+     "test/rails2x_root/app/helpers/test_helper.rb",
+     "test/rails2x_root/config/boot.rb",
+     "test/rails2x_root/config/database.yml",
+     "test/rails2x_root/config/environment.rb",
+     "test/rails2x_root/config/environments/development.rb",
+     "test/rails2x_root/config/environments/production.rb",
+     "test/rails2x_root/config/environments/test.rb",
+     "test/rails2x_root/config/initializers/backtrace_silencers.rb",
+     "test/rails2x_root/config/initializers/cookie_verification_secret.rb",
+     "test/rails2x_root/config/initializers/inflections.rb",
+     "test/rails2x_root/config/initializers/mime_types.rb",
+     "test/rails2x_root/config/initializers/new_rails_defaults.rb",
+     "test/rails2x_root/config/initializers/session_store.rb",
+     "test/rails2x_root/config/locales/en.yml",
+     "test/rails2x_root/config/routes.rb",
+     "test/rails2x_root/script/about",
+     "test/rails2x_root/script/console",
+     "test/rails2x_root/script/dbconsole",
+     "test/rails2x_root/script/destroy",
+     "test/rails2x_root/script/generate",
+     "test/rails2x_root/script/performance/benchmarker",
+     "test/rails2x_root/script/performance/profiler",
+     "test/rails2x_root/script/plugin",
+     "test/rails2x_root/script/runner",
+     "test/rails2x_root/script/server",
+     "test/rails2x_root/test/functional/test_controller_test.rb",
+     "test/rails2x_root/test/test_helper.rb",
+     "test/rails3x_root/Gemfile",
+     "test/rails3x_root/Gemfile.lock",
+     "test/rails3x_root/Rakefile",
+     "test/rails3x_root/app/controllers/application_controller.rb",
+     "test/rails3x_root/app/controllers/test_controller.rb",
+     "test/rails3x_root/app/helpers/application_helper.rb",
+     "test/rails3x_root/app/helpers/test_helper.rb",
+     "test/rails3x_root/app/views/layouts/application.html.erb",
+     "test/rails3x_root/config.ru",
+     "test/rails3x_root/config/application.rb",
+     "test/rails3x_root/config/boot.rb",
+     "test/rails3x_root/config/environment.rb",
+     "test/rails3x_root/config/environments/development.rb",
+     "test/rails3x_root/config/environments/production.rb",
+     "test/rails3x_root/config/environments/test.rb",
+     "test/rails3x_root/config/initializers/backtrace_silencers.rb",
+     "test/rails3x_root/config/initializers/inflections.rb",
+     "test/rails3x_root/config/initializers/mime_types.rb",
+     "test/rails3x_root/config/initializers/secret_token.rb",
+     "test/rails3x_root/config/initializers/session_store.rb",
+     "test/rails3x_root/config/locales/en.yml",
+     "test/rails3x_root/config/routes.rb",
+     "test/rails3x_root/script/rails",
+     "test/rails3x_root/test/functional/test_controller_test.rb",
+     "test/rails3x_root/test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kswope/session_countdown}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby on Rails plugin that puts a countdown timer on the session object}
+  s.test_files = [
+    "test/common/test_controller_test.rb",
+     "test/rails2x_root/app/controllers/application_controller.rb",
+     "test/rails2x_root/app/controllers/test_controller.rb",
+     "test/rails2x_root/app/helpers/application_helper.rb",
+     "test/rails2x_root/app/helpers/test_helper.rb",
+     "test/rails2x_root/config/boot.rb",
+     "test/rails2x_root/config/environment.rb",
+     "test/rails2x_root/config/environments/development.rb",
+     "test/rails2x_root/config/environments/production.rb",
+     "test/rails2x_root/config/environments/test.rb",
+     "test/rails2x_root/config/initializers/backtrace_silencers.rb",
+     "test/rails2x_root/config/initializers/cookie_verification_secret.rb",
+     "test/rails2x_root/config/initializers/inflections.rb",
+     "test/rails2x_root/config/initializers/mime_types.rb",
+     "test/rails2x_root/config/initializers/new_rails_defaults.rb",
+     "test/rails2x_root/config/initializers/session_store.rb",
+     "test/rails2x_root/config/routes.rb",
+     "test/rails2x_root/test/functional/test_controller_test.rb",
+     "test/rails2x_root/test/test_helper.rb",
+     "test/rails3x_root/app/controllers/application_controller.rb",
+     "test/rails3x_root/app/controllers/test_controller.rb",
+     "test/rails3x_root/app/helpers/application_helper.rb",
+     "test/rails3x_root/app/helpers/test_helper.rb",
+     "test/rails3x_root/config/application.rb",
+     "test/rails3x_root/config/boot.rb",
+     "test/rails3x_root/config/environment.rb",
+     "test/rails3x_root/config/environments/development.rb",
+     "test/rails3x_root/config/environments/production.rb",
+     "test/rails3x_root/config/environments/test.rb",
+     "test/rails3x_root/config/initializers/backtrace_silencers.rb",
+     "test/rails3x_root/config/initializers/inflections.rb",
+     "test/rails3x_root/config/initializers/mime_types.rb",
+     "test/rails3x_root/config/initializers/secret_token.rb",
+     "test/rails3x_root/config/initializers/session_store.rb",
+     "test/rails3x_root/config/routes.rb",
+     "test/rails3x_root/test/functional/test_controller_test.rb",
+     "test/rails3x_root/test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/common/test_controller_test.rb

@@ -0,0 +1,150 @@
+require 'test_helper'
+require 'timecop'
+
+class TestControllerTest < ActionController::TestCase
+
+
+  test "single default" do
+
+    assert ! session.countdown_running?
+
+    session.countdown_run(1.minute)
+    assert session.countdown_running?
+    assert ! session.countdown_expired?
+
+    session.countdown_expire
+
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
+
+    session.countdown_restart
+    assert ! session.countdown_expired?
+    assert session.countdown_running?
+
+  end
+
+
+  test "mixed names" do
+
+    ## start up two counters
+
+    session.countdown_run(1.minute)
+    session.countdown_run(1.minute, :admin)
+
+    ## expire default counter
+
+    assert session.countdown_running?
+    session.countdown_expire
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
+
+    ## expire admin counter
+
+    assert session.countdown_running?(:admin)
+    session.countdown_expire(:admin)
+    assert ! session.countdown_running?(:admin)
+    assert session.countdown_expired?(:admin)
+
+    ## mixing calls to both timers
+
+    session.countdown_run(1.minute)
+    assert session.countdown_running?()
+    assert ! session.countdown_running?(:admin)
+    session.countdown_expire
+    assert session.countdown_expired?(:admin)
+    session.countdown_restart(:admin)
+    assert session.countdown_running?(:admin)
+    assert ! session.countdown_expired?(:admin)
+    assert ! session.countdown_running?()
+
+  end
+
+
+  test "expiring and resetting" do
+
+    session.countdown_run(1.minute)
+    assert session.countdown_running?
+    assert ! session.countdown_expired?
+
+    Timecop.travel(1.minute)
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
+
+    session.countdown_restart
+    assert session.countdown_running?
+
+    Timecop.return
+
+  end
+
+
+  test "named expiring and resetting" do
+
+    session.countdown_run(1.minute, :admin)
+    assert session.countdown_running?(:admin)
+    assert ! session.countdown_expired?(:admin)
+
+    Timecop.travel(1.minute)
+    assert ! session.countdown_running?(:admin)
+    assert session.countdown_expired?(:admin)
+
+    session.countdown_restart(:admin)
+    assert session.countdown_running?(:admin)
+
+    Timecop.return
+
+  end
+
+
+  test "unstable state" do
+
+    ## all public methods except countdown_run and countdown_running?
+    ## require an existing countdown
+
+    assert_raise(NoCountdown) { session.countdown_expire }
+    assert_raise(NoCountdown) { session.countdown_restart }
+    assert_raise(NoCountdown) { session.countdown_expired? }
+    assert_raise(NoCountdown) { session.countdown_count }
+
+    ## try with named countdown
+
+    assert_raise(NoCountdown) { session.countdown_expire(:admin) }
+    assert_raise(NoCountdown) { session.countdown_restart(:admin) }
+    assert_raise(NoCountdown) { session.countdown_expired?(:admin) }
+    assert_raise(NoCountdown) { session.countdown_count(:admin) }
+
+  end
+
+
+  test "countdown_count" do
+
+    session.countdown_run(1.minute)
+    assert session.countdown_count < 1.minute
+    assert session.countdown_count > (1.minute - 1)
+    Timecop.travel(30.seconds)
+    assert session.countdown_count < 30
+    Timecop.travel(1.minute)
+    assert session.countdown_count == 0
+
+    session.countdown_restart
+    assert session.countdown_count > (1.minute - 1)
+
+    Timecop.return
+
+  end
+
+
+  # copied from README, mostly checking spelling
+  test "rdoc example" do
+
+    session.countdown_run(30.minutes)
+    session.countdown_running? # => true
+    session.countdown_expire
+    session.countdown_running? # => false
+    session.countdown_expired? # => true
+    session.countdown_restart
+    session.countdown_running? # => true
+
+  end
+
+end

data/test/rails2x_root/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/rails2x_root/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/test/rails2x_root/app/controllers/test_controller.rb

@@ -0,0 +1,2 @@
+class TestController < ApplicationController
+end

data/test/rails2x_root/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/rails2x_root/app/helpers/test_helper.rb

@@ -0,0 +1,2 @@
+module TestHelper
+end