RubyGems - session_countdown - Versions diffs - 0.1.0 → 0.2.0 - Mend

session_countdown 0.1.0 → 0.2.0

Files changed (9) hide show

data/README.html +191 -0
data/README.rdoc +17 -15
data/VERSION +1 -1
data/lib/session_countdown.rb +6 -6
data/session_countdown.gemspec +3 -2
data/test/common/test_controller_test.rb +22 -4
data/test/rails2x_root/test/functional/test_controller_test.rb +22 -4
data/test/rails3x_root/test/functional/test_controller_test.rb +22 -4
metadata +6 -4

data/README.html ADDED Viewed

@@ -0,0 +1,191 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <title>RDoc Documentation</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+</head>
+<body>
+<h2>File: README.rdoc</h2>
+<table>
+  <tr><td>Path:</td><td>README.rdoc</td></tr>
+  <tr><td>Modified:</td><td>Fri Aug 06 06:53:51 -0400 2010</td></tr>
+</table>
+<h1>session_countdown</h1>
+<p>
+A Ruby on Rails plugin that puts a countdown timer on the session object.
+</p>
+<pre>
+  session.countdown_run(30.minutes)
+  session.countdown_running? # =&gt; true
+  session.countdown_expire
+  session.countdown_running? # =&gt; false
+  session.countdown_expired? # =&gt; true
+  session.countdown_restart
+  session.countdown_running? # =&gt; true
+</pre>
+<h3>But why?!?</h3>
+<p>
+Sometimes I need to build my own custom rails authentication systems rather
+than use plugins such as Authlogic, Devise or restful_authentication.
+</p>
+<p>
+There is always a &quot;timer&quot; in my custom authentication
+contraptions, and there is always a session object lurking when I&#8216;m
+dealing with authentication stuff, so why not combine the two?
+</p>
+<h2>API</h2>
+<p>
+<em>Note that countdown_expire(), countdown_restart() and countdown_count()
+will throw a NoCountdown exception if called on a non-existent countdown
+timer.</em>
+</p>
+<p>
+Start a countdown timer
+</p>
+<pre>
+   session.countdown_run(seconds, name = :default)
+</pre>
+<p>
+<em>You can have multiple countdown timers if you name them. The default
+countdown timer is named &quot;default&quot;.</em>
+</p>
+<p>
+Check if a countdown timer exists and is currently running
+</p>
+<pre>
+   session.countdown_running?(name = :default)
+</pre>
+<p>
+Expire early (i.e. logout)
+</p>
+<pre>
+   session.countdown_expire(name = :default)
+</pre>
+<p>
+Restart, using the duration supplied to countdown_run
+</p>
+<pre>
+   session.countdown_restart(name = :default)
+</pre>
+<p>
+Check if expired
+</p>
+<pre>
+   session.countdown_expired?(name = :default)
+</pre>
+<p>
+Remaining time in seconds
+</p>
+<pre>
+   session.countdown_count(name = :default)
+</pre>
+<p>
+Understanding timer running, expired, and never started
+</p>
+<pre>
+  countdown_running? == true # timer running
+  countdown_expired? == true # timer expired
+  countdown_running? == false &amp;&amp; countdown_expired? == false # never ran
+</pre>
+<h1>Synopsis</h1>
+<h3>In application_controller.rb</h3>
+<pre>
+  before_filter :authorize
+  def authorize
+    if session.countdown_running?
+      session.countdown_restart # extend user's login
+    else
+      # store attempted access before rudely redirected to login screen
+      session[:original_uri] = request.request_uri # rails3 use request.fullpath
+      if session.countdown_expired?
+        flash[:notice] = &quot;Login Expired&quot;
+      else
+        flash[:notice] = &quot;Please login&quot;
+      end
+      redirect_to :login
+    end
+  end
+</pre>
+<h3>In any controller</h3>
+<pre>
+  def login
+    user = User.find_by_email(params[:email)
+    if user &amp;&amp; user.password_matches?(params[:password])
+      session.countdown_run(1.hour)
+      redirect_to :controller =&gt; :private
+    else
+      flash.now[:notice] = &quot;Sorry, email/password wrong&quot;
+      render :index
+    end
+  end
+  def logout
+    session.countdown_expire
+    flash[:notice] = &quot;You are now logged out&quot;
+    redirect_to :index
+  end
+</pre>
+<h3>In user model</h3>
+<pre>
+  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
+</pre>
+<h3>Note: Remember me</h3>
+<p>
+If you want an &quot;remember me&quot; feature you need to do two things.
+</p>
+<p>
+Set timer for far future when user checks &quot;remember me&quot;
+</p>
+<pre>
+  session.countdown_run(1.year)
+</pre>
+<p>
+Tell rails to serve up a persistent cookie instead of session cookie,
+probably in application_controller.rb
+</p>
+<pre>
+  ActionController::Base.session_options[:expire_after] = 1.year
+</pre>
+<h3>Persistent vs session cookies</h3>
+<p>
+There are two types of browser cookies: ones with expiration dates and ones
+without. When a cookie doesnt have an expiration date it&#8216;s a
+<em>session</em> cookie and will be deleted when the browser quits. If the
+cookie has an expiration date it&#8216;s a <em>persistent</em> cookie
+(a.k.a. domain cookie) and will be valid until that date.
+</p>
+<p>
+&quot;Remember me&quot; could work fine with only session cookies, provided
+the user never quits the browser, but users expect &quot;remember me&quot;
+to never expire their login <em>and</em> 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.
+</p>
+<h2>Classes</h2>
+</body>
+</html>
+Files:   1
+Classes: 0
+Modules: 0
+Methods: 0
+Elapsed: 0.048s

data/README.rdoc CHANGED Viewed

@@ -26,11 +26,10 @@ 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
+<i>Note that countdown_expire(), countdown_restart() and
+countdown_count() will throw a NoCountdown exception if called on a
 non-existent countdown timer.</i>
 Start a countdown timer
    session.countdown_run(seconds, name = :default)
@@ -42,7 +41,7 @@ Check if a countdown timer exists and is currently running
    session.countdown_running?(name = :default)
-Expire early
+Expire early (i.e. logout)
    session.countdown_expire(name = :default)
@@ -54,17 +53,16 @@ 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)
+Understanding timer running, expired, and never started
+  countdown_running? == true # timer running
+  countdown_expired? == true # timer expired
+  countdown_running? == false && countdown_expired? == false # never ran
 = Synopsis
@@ -72,13 +70,17 @@ Remaining time in seconds
   before_filter :authorize
   def authorize
     if session.countdown_running?
-      session.countdown_restart # give user more time
+      session.countdown_restart # extend user's login
     else
-      session[:original_uri] = request.request_uri
-      flash[:notice] = session.countdown_expired? ? "Login Expired" : "Please login"
+      # store attempted access before rudely redirected to login screen
+      session[:original_uri] = request.request_uri # rails3 use request.fullpath
+      if session.countdown_expired?
+        flash[:notice] = "Login Expired"
+      else
+        flash[:notice] = "Please login"
+      end
       redirect_to :login
     end
   end

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.1.0
1	+ 0.2.0

data/lib/session_countdown.rb CHANGED Viewed

@@ -17,9 +17,13 @@ module SessionCountdown
     self[get_zero_key(name)] && self[get_zero_key(name)] > Time.now
   end
+  def countdown_expired?(name = @@default_name)
+    self[get_zero_key(name)] && ! countdown_running?(name)
+  end
   # sanity check for existing countdown for some methods
   def method_missing(method, *args)
-    check_countdown_exists(*args) # reason for this method_missing()
+    insist_countdown_exists(*args) # reason for this method_missing()
     method = "_#{method}"
     respond_to?(method) ? send(method, *args) : raise(NoMethodError)
   end
@@ -30,10 +34,6 @@ module SessionCountdown
     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
@@ -55,7 +55,7 @@ module SessionCountdown
     "session_countdown:#{name}_delta"
   end
-  def check_countdown_exists(name = @@default_name)
+  def insist_countdown_exists(name = @@default_name)
     unless self[get_zero_key(name)]
       raise NoCountdown, "no session countdown named '#{name}'"
     end

data/session_countdown.gemspec CHANGED Viewed

@@ -5,15 +5,16 @@
 Gem::Specification.new do |s|
   s.name = %q{session_countdown}
-  s.version = "0.1.0"
+  s.version = "0.2.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.date = %q{2010-08-06}
   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.html",
      "README.rdoc"
   ]
   s.files = [

data/test/common/test_controller_test.rb CHANGED Viewed

@@ -7,6 +7,7 @@ class TestControllerTest < ActionController::TestCase
   test "single default" do
     assert ! session.countdown_running?
+    assert ! session.countdown_expired?
     session.countdown_run(1.minute)
     assert session.countdown_running?
@@ -23,6 +24,25 @@ class TestControllerTest < ActionController::TestCase
   end
+  test "truth table test" do
+    # with no countdown started these conditions should be met
+    assert ! session.countdown_running?
+    assert ! session.countdown_expired?
+    # with countdown started
+    session.countdown_run(1.minute)
+    assert session.countdown_running?
+    assert ! session.countdown_expired?
+    # with countdown expired
+    session.countdown_expire
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
+  end
   test "mixed names" do
@@ -98,19 +118,17 @@ class TestControllerTest < ActionController::TestCase
   test "unstable state" do
-    ## all public methods except countdown_run and countdown_running?
-    ## require an existing countdown
+    # restart, expire and count require an existing countdown, should
+    # throw exception if there isn't one
     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

data/test/rails2x_root/test/functional/test_controller_test.rb CHANGED Viewed

@@ -7,6 +7,7 @@ class TestControllerTest < ActionController::TestCase
   test "single default" do
     assert ! session.countdown_running?
+    assert ! session.countdown_expired?
     session.countdown_run(1.minute)
     assert session.countdown_running?
@@ -23,6 +24,25 @@ class TestControllerTest < ActionController::TestCase
   end
+  test "truth table test" do
+    # with no countdown started these conditions should be met
+    assert ! session.countdown_running?
+    assert ! session.countdown_expired?
+    # with countdown started
+    session.countdown_run(1.minute)
+    assert session.countdown_running?
+    assert ! session.countdown_expired?
+    # with countdown expired
+    session.countdown_expire
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
+  end
   test "mixed names" do
@@ -98,19 +118,17 @@ class TestControllerTest < ActionController::TestCase
   test "unstable state" do
-    ## all public methods except countdown_run and countdown_running?
-    ## require an existing countdown
+    # restart, expire and count require an existing countdown, should
+    # throw exception if there isn't one
     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

data/test/rails3x_root/test/functional/test_controller_test.rb CHANGED Viewed

@@ -7,6 +7,7 @@ class TestControllerTest < ActionController::TestCase
   test "single default" do
     assert ! session.countdown_running?
+    assert ! session.countdown_expired?
     session.countdown_run(1.minute)
     assert session.countdown_running?
@@ -23,6 +24,25 @@ class TestControllerTest < ActionController::TestCase
   end
+  test "truth table test" do
+    # with no countdown started these conditions should be met
+    assert ! session.countdown_running?
+    assert ! session.countdown_expired?
+    # with countdown started
+    session.countdown_run(1.minute)
+    assert session.countdown_running?
+    assert ! session.countdown_expired?
+    # with countdown expired
+    session.countdown_expire
+    assert ! session.countdown_running?
+    assert session.countdown_expired?
+  end
   test "mixed names" do
@@ -98,19 +118,17 @@ class TestControllerTest < ActionController::TestCase
   test "unstable state" do
-    ## all public methods except countdown_run and countdown_running?
-    ## require an existing countdown
+    # restart, expire and count require an existing countdown, should
+    # throw exception if there isn't one
     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

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: session_countdown
 version: !ruby/object:Gem::Version
-  hash: 27
+  hash: 23
   prerelease: false
   segments:
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Swope
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-08-05 00:00:00 -04:00
+date: 2010-08-06 00:00:00 -04:00
 default_executable:
 dependencies: []
@@ -27,6 +27,7 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
+- README.html
 - README.rdoc
 files:
 - .document
@@ -94,6 +95,7 @@ files:
 - test/rails3x_root/script/rails
 - test/rails3x_root/test/functional/test_controller_test.rb
 - test/rails3x_root/test/test_helper.rb
+- README.html
 has_rdoc: true
 homepage: http://github.com/kswope/session_countdown
 licenses: []