authpds 0.0.4 → 0.0.5

data/README.rdoc

@@ -2,4 +2,28 @@
 
 This project provides a mechanism for authenticating via Ex Libris' Patron Directory Services (PDS) and provides hooks for making authorization decisions based on the user information provided by PDS.  It leverages the authlogic gem and depends on a User-like model.
 
-For con
+
+Generate User-like model:
+rails generate model User username:string email:string firstname:string \
+	lastname:string mobile_phone:string crypted_password:string password_salt:string \
+	session_id:string persistence_token:string login_count:string last_request_at:string \
+	current_login_at:string last_login_at:string last_login_ip:string current_login_ip:string \
+	user_attributes:text refreshed_at:datetime
+
+Generate UserSession model
+rails generate authlogic:session user_session
+
+Create UserSessions controller
+rails generate controller UserSessions --no-assets --no-helper
+
+Mixin authpds methods into UserSessionsController
+class UserSessionsController < ApplicationController
+  include Authpds::Controllers::AuthpdsUserSessionsController
+end
+
+Mixin authpds methods into ApplicationController
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  require 'authpds'
+  include Authpds::Controllers::AuthpdsController
+end

data/lib/authpds.rb

@@ -7,7 +7,8 @@ AUTHPDS_PATH = File.dirname(__FILE__) + "/authpds/"
   'institution',
   'institution_list',
   'exlibris/pds',
-  'controllers/authpds_controller'
+  'controllers/authpds_controller',
+  'controllers/authpds_user_sessions_controller'
 ].each do |library|
   require AUTHPDS_PATH + library
 end

data/lib/authpds/acts_as_authentic.rb

@@ -28,9 +28,6 @@ module Authpds
 
       def primary_institution=(primary_institution)
         primary_institution = primary_institution.name if primary_institution.is_a?(Institution)
-        raise ArgumentError.new(
-          "Institution #{primary_institution} does not exist.\n" + 
-          "Please maker sure the institutions yaml file is configured correctly.") if InstitutionList.instance.get(primary_institution).nil?
         self.user_attributes=({:primary_institution => primary_institution})
       end
 

data/lib/authpds/institution.rb

@@ -1,11 +1,12 @@
 class Institution < Struct.new(:display_name, :name, :default_institution, 
   :application_layout, :ip_addresses, :parent_institution, :view_attributes, :login_attributes)
+  require 'ipaddr'
 
   # Better initializer than Struct gives us, take a hash instead
   # of an ordered array. :services=>[] is an array of service ids,
   # not actual Services!
-  def initialize(h={}, controller)
-    members.each {|m| self.send( ("#{m}=").to_sym , (h.delete(m.to_sym) || h.delete(m))) }
+  def initialize(h={})
+    members.each {|m| self.send( ("#{m}=").to_sym , (h.delete("#{m}".to_sym) || h.delete("#{m}"))) }
     default_institution = false unless default_institution
     # Log the fact that there are left overs in the hash
     # Rails.logger.warn("The following institution settings were ignored: #{h.inspect}.") unless h.empty?
@@ -20,14 +21,13 @@ class Institution < Struct.new(:display_name, :name, :default_institution,
   # Check the list of IP addresses for the given IP
   def includes_ip?(prospective_ip_address)
     return false if ip_addresses.nil?
-    require 'ipaddr'
     ip_prospect = IPAddr.new(prospective_ip_address)
     ip_addresses.each do |ip_address|
       ip_range = (ip_address.match(/[\-\*]/)) ? 
         (ip_address.match(/\-/)) ? 
           (IPAddr.new(ip_address.split("-")[0])..IPAddr.new(ip_address.split("-")[1])) :
-            (ip_address.gsub(/\*/, "0")..ip_address.gsub(/\*/, "255")) :
-              IPAddr.new(ip_address).to_range 
+            (IPAddr.new(ip_address.gsub(/\*/, "0"))..IPAddr.new(ip_address.gsub(/\*/, "255"))) :
+              IPAddr.new(ip_address).to_range
       return true if ip_range === ip_prospect unless ip_range.nil?
     end
     return false;

data/lib/authpds/institution_list.rb

@@ -53,8 +53,8 @@ class InstitutionList
         institution_hash["name"] = institution_name
         # Merge with parent institution
         institution_hash = 
-        institution_list[institution_hash["parent_institution"]].
-          merge(institution_hash) unless institution_hash["parent_institution"].nil?
+          institution_list[institution_hash["parent_institution"]].
+            merge(institution_hash) unless institution_hash["parent_institution"].nil?
         @institutions[institution_name] = Institution.new(institution_hash)
       end
     end

data/lib/authpds/session.rb

@@ -131,6 +131,12 @@ module Authpds
         rw_config(:pds_record_identifier, value, :id)
       end
       alias_method :pds_record_identifier=, :pds_record_identifier
+
+      # PDS user method to call to get users primary institution
+      def pds_record_primary_institution(value = nil)
+        rw_config(:pds_record_primary_institution, value, :institute)
+      end
+      alias_method :pds_record_primary_institution=, :pds_record_primary_institution
     end 
     
     module AuthpdsCallbackMethods
@@ -138,7 +144,12 @@ module Authpds
       def pds_record_identifier
         self.class.pds_record_identifier
       end
-      
+
+      # Hook for more complicated logic to determine PDS user primary institution
+      def pds_record_primary_institution
+        self.class.pds_record_primary_institution
+      end
+
       # Hook to determine if we should set up an SSO session
       def valid_sso_session?
         return false
@@ -242,6 +253,7 @@ module Authpds
         self.attempted_record.expiration_date = expiration_date
         # Do this part only if user data has expired.
         if self.attempted_record.expired?
+          self.attempted_record.primary_institution= pds_user.send(pds_record_primary_institution)
           pds_attributes.each { |user_attr, pds_attr|
             self.attempted_record.send("#{user_attr}=".to_sym, pds_user.send(pds_attr.to_sym)) if user.respond_to?("#{user_attr}=".to_sym) }
           # Set default pds user attributes

data/lib/authpds/version.rb

@@ -1,3 +1,3 @@
 module Authpds
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/support/config/institutions.yml

@@ -1,14 +1,14 @@
 NYU:
   login_attributes:
-    link_code: NYSID
-    logout_url: 'http://bobcat.library.nyu.edu/nysid'
-  default_institution: true
+    link_code: NYU
+    logout_url: 'http://bobcat.library.nyu.edu'
+  default_institution: false
   display_name: NYU Libraries
   view_attributes:
     test_view_attribute1: test_attribute1_nyu
     test_view_attribute2: test_attribute2_nyu
   ip_addresses:
-    - 128.122.0.0-128.122.149.239
+    - 128.122.0.0-128.122.149.238
     - 172.26.*.*
     - 172.27.*.*
     - 172.22.88.*
@@ -16,7 +16,7 @@ NYU:
     - 128.238.*.*
     
 NYUAD:
-  default_institution: false
+  default_institution: true
   display_name: NYUAD Library
   view_attributes:
     test_view_attribute1: test_attribute1_nyuad

data/test/test_helper.rb

@@ -41,7 +41,7 @@ require File.dirname(__FILE__) + '/../lib/authpds' unless defined?(Authpds)
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 class ActiveSupport::TestCase
-  VALID_PDS_HANDLE_FOR_NYU = '132012112947113134742310506860'
+  VALID_PDS_HANDLE_FOR_NYU = '232012135435113217012644778009'
   VALID_PDS_HANDLE_FOR_NEWSCHOOL = '272201212284614806184193096120278'
   VALID_PDS_HANDLE_FOR_COOPER = '272201212284614806184193096120278'
   INVALID_PDS_HANDLE = "Invalid"
@@ -72,7 +72,16 @@ class Authlogic::TestCase::MockController
   def performed?
     false
   end
-end
-
 
+  def request
+    @request ||= Authlogic::TestCase::MockRequest.new(self)
+  end
+  
+  def env
+    @env ||= {'REMOTE_ADDR' => "128.122.149.239"}
+  end
+end
 
+class UserSessionsController < Authlogic::TestCase::MockController
+  include Authpds::Controllers::AuthpdsUserSessionsController
+end

data/test/unit/authpds_controller_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+class ApplicationControllerTest < ActiveSupport::TestCase
+  
+  def setup
+    activate_authlogic
+    controller.session[:session_id] = "FakeSessionID"
+    InstitutionList.class_variable_set(:@@institutions_yaml_path, nil)
+    InstitutionList.instance.instance_variable_set(:@institutions, nil)
+    controller.instance_variable_set(:@current_primary_institution, nil)
+  end
+  
+  test "current_user_session_nil" do
+    assert_nil(controller.current_user_session)
+  end
+
+  test "current_user_session" do
+    assert_nil(controller.current_user_session)
+    controller.cookies[:PDS_HANDLE] = { :value => VALID_PDS_HANDLE_FOR_NYU }
+    user_session = controller.current_user_session
+    assert_not_nil(user_session)
+  end
+
+  test "current_user_nil" do
+    assert_nil(controller.current_user)
+  end
+
+  test "current_user" do
+    assert_nil(controller.current_user)
+    controller.cookies[:PDS_HANDLE] = { :value => VALID_PDS_HANDLE_FOR_NYU }
+    user = controller.current_user
+    assert_not_nil(user)
+    assert_equal("N12162279", user.username)
+  end
+
+  test "current_primary_institution_nil" do
+    assert_nil(controller.current_primary_institution)
+  end
+
+  test "current_primary_institution_default" do
+    assert_nil(controller.current_primary_institution)
+    controller.request[:session_id] = "FakeSessionID"
+    InstitutionList.yaml_path= "#{File.dirname(__FILE__)}/../support/config/institutions.yml"
+    assert_equal(InstitutionList.instance.get("NYUAD"), controller.current_primary_institution)
+  end
+
+
+  test "current_primary_institution_user" do
+    assert_nil(controller.current_primary_institution)
+    InstitutionList.yaml_path= "#{File.dirname(__FILE__)}/../support/config/institutions.yml"
+    controller.cookies[:PDS_HANDLE] = { :value => VALID_PDS_HANDLE_FOR_NYU }
+    assert_equal("N12162279", controller.current_user.username)
+    assert_equal(InstitutionList.instance.get("NYU"), controller.current_user.primary_institution)
+    assert_equal(InstitutionList.instance.get("NYU"), controller.current_primary_institution)
+  end
+end

data/test/unit/authpds_user_sessions_controller_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+class UserSessionsControllerTest < ActiveSupport::TestCase
+  
+  def setup
+    activate_authlogic
+    controller.session[:session_id] = "FakeSessionID"
+    controller.cookies[:PDS_HANDLE] = { :value => VALID_PDS_HANDLE_FOR_NYU }
+  end
+  
+  test "current_user_session" do
+    user_session = controller.current_user_session
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authpds
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000 Z
+date: 2012-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2151877740 !ruby/object:Gem::Requirement
+  requirement: &2151877500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2151877740
+  version_requirements: *2151877500
 - !ruby/object:Gem::Dependency
   name: authlogic
-  requirement: &2151876500 !ruby/object:Gem::Requirement
+  requirement: &2151876340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151876500
+  version_requirements: *2151876340
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2151871260 !ruby/object:Gem::Requirement
+  requirement: &2151871060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151871260
+  version_requirements: *2151871060
 description: Libraries that use Ex Libris products, can integrate Rails application
   with PDS to provide single sign-on across systems.
 email:
@@ -71,6 +71,8 @@ files:
 - test/support/user.rb
 - test/support/user_session.rb
 - test/test_helper.rb
+- test/unit/authpds_controller_test.rb
+- test/unit/authpds_user_sessions_controller_test.rb
 - test/unit/pds_test.rb
 - test/unit/user_session_test.rb
 - test/unit/user_test.rb
@@ -106,6 +108,8 @@ test_files:
 - test/support/user.rb
 - test/support/user_session.rb
 - test/test_helper.rb
+- test/unit/authpds_controller_test.rb
+- test/unit/authpds_user_sessions_controller_test.rb
 - test/unit/pds_test.rb
 - test/unit/user_session_test.rb
 - test/unit/user_test.rb