ixtlan-session-timeout 0.1.0 → 0.1.1

data/lib/ixtlan/sessions/timeout.rb

@@ -27,7 +27,11 @@ module Ixtlan
       protected
       
       def check_session_expiry
-        if !session[:expires_at].nil? and session[:expires_at] < DateTime.now
+puts "- - - -"
+p session[:expires_at].asctime if session[:expires_at]
+p DateTime.now.asctime
+p ( session[:expires_at] && session[:expires_at] < DateTime.now)
+        if session[:expires_at] && session[:expires_at] < DateTime.now
           # Session has expired.
           session_log("session timeout")
           expire_session
@@ -41,7 +45,7 @@ module Ixtlan
       # IP binding is not very useful in the wild since some ISP use 
       # a different IP for each request, i.e. the session uses many IPs
       def check_session_ip_binding
-        if !session[:session_ip].nil? and session[:session_ip] != request.headers['REMOTE_ADDR']
+        if !session[:session_ip].nil? && session[:session_ip] != request.headers['REMOTE_ADDR']
           # client IP has changed
           session_log("IP changed from #{session[:session_ip]} to #{request.headers['REMOTE_ADDR']}")
           expire_session
@@ -87,7 +91,7 @@ module Ixtlan
       end
       
       def session_idle_timeout
-        Rails.configuration.idle_session_timeout
+        Rails.configuration.session_idle_timeout
       end
     end
   end

data/spec/timeout_spec.rb

@@ -0,0 +1,142 @@
+require 'ixtlan/sessions/timeout'
+require 'logger'
+require 'date'
+
+class Controller
+  
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def session
+    @session ||= {}
+  end
+
+  def request
+    self
+  end
+
+  def headers
+    @header ||= {}
+  end
+
+  def respond_to(&block)
+    block.call(self)
+  end
+
+  def format
+    self
+  end
+
+  def html(&block)
+    block.call(self)
+  end
+
+  def xml(&block)
+    block.call(self)
+  end
+
+  def head(status)
+    @status = status
+  end
+
+  def redirect_to(loc)
+    @location = loc
+  end
+  
+end
+
+class Rails
+  
+  def self.configuration
+    self
+  end
+
+  def self.session_idle_timeout(val = nil)
+    @val = MyDate.new(val) if val
+    @val
+  end
+
+end
+
+class MyDate
+
+  def initialize(val)
+    from_now(val)
+  end
+
+  def minutes
+    self
+  end
+
+  def from_now(val = nil)
+    @val ||= val if val
+    DateTime.now + @val/1440.0
+  end
+end
+
+describe Ixtlan::Sessions::Timeout do
+
+  before :all do
+    Controller.send :include, Ixtlan::Sessions::Timeout
+    @controller = Controller.new
+  end
+
+  before :each do
+    @controller.session.clear
+  end
+
+  it "should keep session when staying on same remote IP" do
+    @controller.headers['REMOTE_ADDR'] = "127.0.1.1"
+    @controller.session.size.should == 0
+    @controller.send(:check_session_ip_binding).should be_true
+    @controller.session.size.should == 1
+    @controller.send(:check_session_ip_binding).should be_true
+    @controller.session.size.should == 1
+  end
+
+  it "should kill session when changing remote IP" do
+    @controller.headers['REMOTE_ADDR'] = "127.0.1.1"
+    @controller.session.size.should == 0
+    @controller.send(:check_session_ip_binding).should be_true
+    @controller.session.size.should == 1
+
+    @controller.headers['REMOTE_ADDR'] = "127.0.0.1"
+    @controller.send(:check_session_ip_binding).should be_false
+    @controller.session.size.should == 0
+  end
+
+  it "should keep session if idle timeout is in the future" do
+    Rails.configuration.session_idle_timeout(1)
+    @controller.session.size.should == 0
+    @controller.send(:check_session_expiry).should be_true
+    @controller.session.size.should == 1
+    @controller.send(:check_session_expiry).should be_true
+    @controller.session.size.should == 1
+  end
+
+  it "should kill session if idle timeout is in the past" do
+    Rails.configuration.session_idle_timeout(-1)
+    @controller.session.size.should == 0
+    # first the session has not expiration_date so it will be set
+    @controller.send(:check_session_expiry).should be_true
+    @controller.session.size.should == 1 
+    # now the expiration date is in the past so there is a timeout
+    @controller.send(:check_session_expiry).should be_false
+    @controller.session.size.should == 0
+  end
+
+  it "should use the controller session_idle_timeout if overwritten" do
+    @controller.class.class_eval do
+      def  session_idle_timeout
+        MyDate.new(1)
+      end
+    end
+    @controller.session.size.should == 0
+    @controller.send(:check_session_expiry).should be_true
+    @controller.session.size.should == 1
+    @controller.send(:check_session_expiry).should be_true
+    @controller.session.size.should == 1
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 1
-    - 0
-  version: 0.1.0
+    - 1
+  version: 0.1.1
 platform: ruby
 authors: 
   - mkristian
@@ -14,55 +14,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +05:30
+date: 2011-03-22 00:00:00 +05:30
 default_executable: 
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rails
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - "="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 3
-              - 0
-              - 1
-            version: 3.0.1
-    type: :development
-    version_requirements: *id001
   - !ruby/object:Gem::Dependency 
     name: rspec
     prerelease: false
-    requirement: &id002 !ruby/object:Gem::Requirement 
+    requirement: &id001 !ruby/object:Gem::Requirement 
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
             segments: 
               - 2
-              - 0
-              - 1
-            version: 2.0.1
-    type: :development
-    version_requirements: *id002
-  - !ruby/object:Gem::Dependency 
-    name: cucumber
-    prerelease: false
-    requirement: &id003 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - "="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 9
               - 4
-            version: 0.9.4
+              - 0
+            version: 2.4.0
     type: :development
-    version_requirements: *id003
+    version_requirements: *id001
   - !ruby/object:Gem::Dependency 
     name: rake
     prerelease: false
-    requirement: &id004 !ruby/object:Gem::Requirement 
+    requirement: &id002 !ruby/object:Gem::Requirement 
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
@@ -72,7 +44,7 @@ dependencies:
               - 7
             version: 0.8.7
     type: :development
-    version_requirements: *id004
+    version_requirements: *id002
 description: idle session timeout for rails on a per controller base
 email: 
   - m.kristian@web.de
@@ -83,16 +55,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-  - README.textile
-  - features/step_definitions/simple_steps.rb
-  - features/generators.feature
   - lib/ixtlan-session-timeout.rb
   - lib/ixtlan/sessions/timeout.rb
   - lib/ixtlan/sessions/railtie.rb
+  - spec/timeout_spec.rb
 has_rdoc: true
 homepage: http://github.com/mkristian/ixtlan-session-timeout
-licenses: []
-
+licenses: 
+  - MIT-LICENSE
 post_install_message: 
 rdoc_options: 
   - --main
@@ -120,5 +90,5 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: idle session timeout on a per controller base
-test_files: []
-
+test_files: 
+  - spec/timeout_spec.rb

data/README.textile

@@ -1,42 +0,0 @@
-h1. Rails Idle Session Timeout
-
-p. when you deal with privacy related data during a session then it is important to timeout these session since it happens to often that a session stays open. there a lot of examples how to "reuse" an open session.
-
-p. sometimes it is nessecary to have different timeout for different parts of the system. you can do this with
-
-bc. class MyController
-  def session_idle_timeout
-    Configuration.instance.user_idle_session_timeout
-  end
-  . . . 
-end 
-
-p. or you want to bind your admin session to the IP of the admin:
-
-bc. class MyAdminController
-  before_filter :check_session_ip_binding  
-  . . . 
-end 
-
-p. or you do not want any session timeout
-
-bc. class MyAdminController
-  skip_before_filter :check_session_expiry
-  . . . 
-end 
-
-h2. install
-
-p. in Gemfile add *gem 'ixtlan-session-timeout'*
-
-p. for the configuration add for example in _config/initializers/session-timeout.rb_. without that the default idle timeout is 5 minutes.
-
-bc. Rails.application.config.idle_session_timeout = 30 #minutes
-
-h2. relation to ixtlan gem
-
-p. the ixtlan gem provides a setup generator which adds configuration examples for this gem in _config/initializer/ixtlan.rb_ (the dynamic configuration is part of the ixtlan gem and it is just easier to keep that inside that gem !!!)
-
-h2. relation to ixtlan-audit gem
-
-p. if that gem is present and loaded than any timeout will be log with the help of _Ixtlan::Audit::UserLogger_

data/features/generators.feature

@@ -1,5 +0,0 @@
-Feature: Generators for Ixtlan Audit
-
-  Scenario: The slf4r rails template creates a rails application which uses slf4r-wrapper
-    Given I create new rails application with template "simple.template"
-    Then the output should contain "setup slf4r logger wrapper with ActiveSupport::BufferedLogger"

data/features/step_definitions/simple_steps.rb

@@ -1,22 +0,0 @@
-require 'fileutils'
-Given /^I create new rails application with template "(.*)"$/ do |template|
-  name = template.sub(/.template$/, '')
-  directory = File.join('target', name)
-  rails_version = ENV['RAILS_VERSION'] || '3.0.1'
-
-  ruby = defined?(JRUBY_VERSION) ? "jruby" : "ruby"
-  rails_command = "#{ENV['GEM_HOME']}/bin/rails"
-  rails_command = "-S rails" unless File.exists?(rails_command)
-  command = "#{rails_command} _#{rails_version}_ new #{directory} -f -m templates/#{template}"
-  FileUtils.rm_rf(directory)
-
-  system "#{ruby} #{command}"
-  
-  @result = File.read("target/#{name}/log/development.log")
-  puts @result
-end
-
-Then /^the output should contain \"(.*)\"$/ do |expected|
-  (@result =~ /.*#{expected}.*/).should_not be_nil
-end
-