authpds 1.1.2 → 1.1.3

data/README.md

@@ -0,0 +1,168 @@
+[![Gem Version](https://badge.fury.io/rb/authpds.png)](http://badge.fury.io/rb/authpds)
+[![Build Status](https://api.travis-ci.org/scotdalton/authpds.png?branch=master)](https://travis-ci.org/scotdalton/authpds)
+[![Dependency Status](https://gemnasium.com/scotdalton/authpds.png)](http://gemnasium.com/scotdalton/authpds)
+[![Code Climate](https://codeclimate.com/github/scotdalton/authpds.png)](http://codeclimate.com/github/scotdalton/authpds)
+[![Coverage Status](https://coveralls.io/repos/scotdalton/authpds/badge.png?branch=master)](https://coveralls.io/r/scotdalton/authpds)
+
+# Authpds
+Libraries 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](https://github.com/binarylogic/authlogic) gem and depends
+on a User-like model.
+
+## Basics
+### 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:integer 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
+
+### Configure User-like model
+    class User < ActiveRecord::Base
+      serialize :user_attributes  
+
+      acts_as_authentic do |c|
+        c.validations_scope = :username
+        c.validate_password_field = false
+        c.require_password_confirmation = false  
+        c.disable_perishable_token_maintenance = true
+      end
+    end
+
+### Generate UserSession model
+    $ rails generate authlogic:session user_session
+
+### Configure UserSession with Authpds options
+    class UserSession < Authlogic::Session::Base
+      pds_url "https://login.library.institution.edu"
+      redirect_logout_url "http://library.institution.edu"
+      calling_system "my_system"
+
+      def expiration_date
+        1.second.ago
+      end
+    end
+
+### Create UserSessions controller
+    $ rails generate controller UserSessions --no-assets --no-helper
+
+### Configure institutions
+
+#### Create institutions.yml file
+Calling the institution "default" will make it the default:
+
+    default:
+      login:
+        code: INST01
+      display_name: My Institution
+
+An alternative syntax:
+
+    INST01:
+      login:
+        code: INST01
+      default: true
+      display_name: My Institution
+
+You can create multiple institution listings as follows:
+
+    INST01:
+      login:
+        code: INST01
+      default: true
+      display_name: My Institution
+    INST02:
+      login:
+        code: INST01
+      display_name: Your Institution
+
+The two separate institutions above share a code in this example.
+The code attribute determines the institute parameter in the PDS url.
+
+#### Institution fields
+| Field | Description |
+| ----- | ----------- |
+| `name` | Institution name |
+| `display_name` | Name to display to users. |
+| `default` | Boolean indicating whether this is a default Institution. Alternatively, an Institution can be named 'default'.|
+| `parent_institution` | A parent Institution from which this child will inherit fields. |
+| `ip_addresses` | IP addresses associated with the Institution. |
+| `login` | Login configurations associated with the Institution. |
+| `layouts` | Layout configurations associated with the Institution. |
+| `views` | View configurations associated with the Institution. |
+| `controllers` | Controller configurations associated with the Institution. |
+| `models` | Model configurations associated with the Institution. |
+  
+
+#### Create institution initializer
+
+Most likely it will just work if you put the config file in 
+
+    "#{Rails.root}/config/institutions.yml"
+
+If you have your institutions config file in another location make sure to
+change the line below accordingly.
+
+    Institutions.loadpaths << File.join("other", "path")
+    Institutions.filenames << "other_file.yml"
+
+### Mixin authpds methods into UserSessionsController
+    class UserSessionsController < ApplicationController
+      require 'authpds'
+      include Authpds::Controllers::AuthpdsSessionsController
+    end
+
+### Mixin authpds methods into ApplicationController
+    class ApplicationController < ActionController::Base
+      protect_from_forgery
+      require 'authpds'
+      include Authpds::Controllers::AuthpdsController
+    end
+
+### Mixin institution url helpers into ApplicationHelper
+    module ApplicationHelper
+      include Authpds::Helpers::Institution::UrlHelper
+    end
+
+## Overview
+The Authpds gem mixes in callbacks to Authlogic for persisting sessions based on a valid PDS handle.
+The module extends Authlogic and should be compatible with Authlogic configuation.
+It also provides hooks for custom functionality.
+The documentation below describes the hooks available for overriding, PDS config methods
+and further details about the module.
+
+## Config Accessors Available
+| Accessor | Description |
+| -------- | ----------- |
+| `#pds_url` | Base pds url |
+| `#calling_system` | Name of the system (authpds) |
+| `#anonymous` | Does the system allow anonymous access? (true) |
+| `#pds_attributes` | Mapping of PDS attributes to record attributes |
+| `#redirect_logout_url` | Custom redirect logout url |
+| `#login_inaccessible_url` | Custom url to redirect to in case of PDS system outage |
+| `#pds_record_identifier` | PDS user method to call to identify record |
+| `#institution_param_key` | Querystring parameter key for the institution value in this system |
+| `#validate_url_name` | URL name for validation action in routes (validate_url) |
+
+## Hooks Available for Overriding
+| Hook | Description |
+| ---- | ----------- |
+| `#pds_record_identifier` | Allows for more complex logic in determining what should be used as the record identifier. Defaults to what was set in the `pds_record_identifier` config. Returns a Symbol. |
+| `#attempt_sso?` | If there is no PDS handle, can we attempt to establish a PDS session based on some other information?  Returns a Boolean. |
+| `#additional_authorization` | Allows for additions to the authorization decision. Returns a Boolean. |
+| `#additional_attributes` | Allows for additional attributes to be stored in the record. Returns a Hash. |
+| `#expiration_date` | Indicates when the record information should be refreshed. Defaults to one week ago.  Returns a Date or Time. |
+
+## Further Implementation Details 
+### Persisting a Session in AuthLogic
+When persisting a Session, Authlogic attempts to create the Session based on information available 
+without having to perform an actual login by calling the `#persisting?` method. 
+Authologic provides several callbacks from the `#persisting?`
+method, e.g. `#before_persisting`, `#persist`, `#after_persisting`.
+We're using the `#persist` callback and setting it to `#persist_session`.
+
+### Access to the controller in Session
+The class that Session extends, Authologic::Session::Base, has an explicit handle to the current
+controller via the instance method `#controller`. This gives our custom instance methods access to
+cookies, session information, loggers, etc. and also allows them to perform redirects and renders.

data/lib/authpds/acts_as_authentic.rb

@@ -8,4 +8,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/acts_as_authentic/core_attributes.rb

@@ -2,9 +2,7 @@ module Authpds
   module ActsAsAuthentic
     module CoreAttributes
       def self.included(klass)
-        klass.class_eval do
-          serialize :user_attributes
-        end
+        klass.class_eval { serialize :user_attributes }
       end
 
       # Setting the username field also resets the persistence_token if the value changes.
@@ -13,12 +11,17 @@ module Authpds
         reset_persistence_token if username_changed?
       end
 
-      # "Smart" updating of user_attributes.  Maintains user_attributes that are not explicity overwritten.
+      # "Smart" updating of user_attributes.
+      # Maintains user_attributes that are not explicity overwritten.
       def user_attributes=(new_attributes)
-        write_attribute(:user_attributes, new_attributes) and return unless new_attributes.kind_of?(Hash)
-        # Set new/updated attributes
-        write_attribute(:user_attributes, (user_attributes || {}).merge(new_attributes))
+        if new_attributes.kind_of?(Hash)
+          # Merge new/updated attributes with new attributes taking precedence
+          merged_attributes = (user_attributes || {}).merge(new_attributes)
+          write_attribute(:user_attributes, merged_attributes)
+        else
+          write_attribute(:user_attributes, new_attributes)
+        end
       end
     end
   end
-end
+end

data/lib/authpds/acts_as_authentic/expiration.rb

@@ -2,18 +2,16 @@ module Authpds
   module ActsAsAuthentic
     module Expiration
       def self.included(klass)
-        klass.class_eval do
-          attr_accessor :expiration_date
-        end
+        klass.class_eval { attr_accessor :expiration_date }
       end
 
       # Returns a boolean based on whether the User has been refreshed recently.
-      # If User#refreshed_at is older than User#expiration_date, the User is expired and the data
-      # may need to be refreshed.
+      # If User#refreshed_at is older than User#expiration_date,
+      # the User is expired and the data may need to be refreshed.
       def expired?
         # If the record is older than the expiration date, it is expired.
         (refreshed_at.nil?) ? true : refreshed_at < expiration_date
       end
     end
   end
-end
+end

data/lib/authpds/acts_as_authentic/institutions_attributes.rb

@@ -4,25 +4,49 @@ module Authpds
       require 'institutions'
 
       def primary_institution
-        all_institutions[user_attributes[:primary_institution]] unless user_attributes.nil?
+        unless user_attributes.blank?
+          all_institutions[user_attributes[:primary_institution]]
+        end
       end
 
       def primary_institution=(new_primary_institution)
-        new_primary_institution = new_primary_institution.code if new_primary_institution.is_a?(Institutions::Institution)
-        self.user_attributes=({:primary_institution => new_primary_institution.to_sym}) unless new_primary_institution.nil?
+        if new_primary_institution.is_a?(Institutions::Institution)
+          new_primary_institution = new_primary_institution.code
+        end
+        if new_primary_institution.present?
+          self.user_attributes = 
+            { primary_institution: new_primary_institution.to_sym }
+        end
       end
 
       def institutions
-        user_attributes[:institutions].collect { |institution| all_institutions[institution] } unless user_attributes.nil?
+        if user_attributes.present?
+          user_attributes[:institutions].collect do |institution| 
+            all_institutions[institution]
+          end
+        end
       end
 
       def institutions=(new_institutions)
-        raise ArgumentError.new("Institutions input should be an array.") unless new_institutions.is_a?(Array)
-        new_institutions.collect! { |institution| institution.to_sym }
-        new_institutions = new_institutions.select { |institution|
-          all_institutions[ new_institutions.is_a?(Institutions::Institution) ? institution.code : institution.to_sym]
-        }
-        self.user_attributes=({:institutions => new_institutions}) unless new_institutions.empty?
+        unless new_institutions.is_a?(Array)
+          raise ArgumentError.new("Institutions input should be an array.")
+        end
+        # Collect the codes as symbols
+        new_institutions.collect! do |institution|
+          if institution.is_a?(Institutions::Institution)
+            institution.code
+          else
+            institution.to_sym
+          end
+        end
+        # Whitelist the institutions
+        new_institutions = new_institutions.select do |institution|
+          all_institutions[institution].present?
+        end
+        # Add them to the user attributes
+        if new_institutions.present?
+          self.user_attributes = { institutions: new_institutions }
+        end
       end
 
       def all_institutions
@@ -31,4 +55,4 @@ module Authpds
       private :all_institutions
     end
   end
-end
+end

data/lib/authpds/controllers/authpds_controller.rb

@@ -1,13 +1,30 @@
 module Authpds
   module Controllers
     module AuthpdsController
+      include Authpds::Helpers::CurrentUserHelper
+      include Authpds::Helpers::Institution::CurrentInstitutionHelper
+      include Authpds::Helpers::Institution::UrlHelper
+
       def self.included(klass)
+        # Include 
         klass.class_eval do
-          include Authpds::Controllers::AuthpdsController::CoreAttributes
-          include Authpds::Controllers::AuthpdsController::InstitutionAttributes
-          include Authpds::Controllers::AuthpdsController::UrlHandling
+          helper_method :current_user_session, :current_user
+          helper_method :current_primary_institution
+        end
+      end
+
+      # Controller method to generate the Appropriate redirect url
+      def user_session_redirect_url(url)
+        # Work with what we have
+        case
+        when url.present?
+          url
+        when request.referer.present?
+          request.referer
+        else
+          root_url
         end
       end
     end
   end
-end
+end

data/lib/authpds/controllers/authpds_sessions_controller.rb

@@ -5,15 +5,20 @@ module Authpds
       # GET /login
       def new
         @user_session = UserSession.new(params)
-        (redirect_to @user_session.login_url(params) and return) unless @user_session.login_url.nil?
-        raise RuntimeError.new( "Error in #{self.class}.\nNo login url defined") if @user_session.login_url.nil?
+        unless @user_session.login_url.blank?
+          redirect_to @user_session.login_url(params)
+        else
+          raise RuntimeError.new( "Error in #{self.class}.\nNo login url defined")
+        end
       end
 
       # GET /validate
       def validate
         # Only create a new one if it doesn't exist
         @user_session ||= UserSession.create(params[:user_session])
-        redirect_to (params[:return_url].nil?) ? root_url : params[:return_url]
+        # If we have a return url, redirect to that otherwise use the root url
+        redirect_to (params[:return_url].present?) ? 
+          params[:return_url] : root_url
       end
 
       # DELETE /user_sessions/1
@@ -22,8 +27,8 @@ module Authpds
         user_session = UserSession.find
         logout_url = user_session.logout_url(params) unless user_session.nil?
         user_session.destroy unless user_session.nil?
-        redirect_to user_session_redirect_url(logout_url)
+        redirect_to user_session_redirect_url(logout_url) unless performed?
       end
     end
   end
-end
+end

data/lib/authpds/exlibris/pds.rb

@@ -57,4 +57,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/helpers/current_user_helper.rb

@@ -0,0 +1,17 @@
+module Authpds
+  module Helpers
+    module CurrentUserHelper
+      # Get the current UserSession if it exists
+      def current_user_session
+        @current_user_session ||= UserSession.find
+      end
+
+      # Get the current User if there is a UserSession
+      def current_user
+        if current_user_session.present? 
+          @current_user ||= current_user_session.record
+        end
+      end
+    end
+  end
+end

data/lib/authpds/helpers/institution/current_institution_helper.rb

@@ -0,0 +1,44 @@
+module Authpds
+  module Helpers
+    module Institution
+      module CurrentInstitutionHelper
+        # Include institutional param helper
+        include ParamHelper
+
+        # Determine current primary institution based on:
+        #   0. institutions are not being used (returns nil)
+        #   1. institution query string parameter in URL
+        #   2. institution associated with the client IP
+        #   3. primary institution for the current user
+        #   4. first default institution
+        def current_primary_institution
+          @current_primary_institution ||= case
+            when (institution_param.present? && institutions[institution_param])
+              institutions[institution_param]
+            when primary_institution_from_ip.present?
+              primary_institution_from_ip
+            when (@current_user && current_user.primary_institution)
+              current_user.primary_institution
+            else
+              Institutions.defaults.first
+            end
+        end
+
+        # Grab the first institution that matches the client IP
+        def primary_institution_from_ip
+          unless request.nil?
+            @primary_institution_from_ip ||=
+              Institutions.with_ip(request.remote_ip).first
+          end
+        end
+        private :primary_institution_from_ip
+
+        # All institutions
+        def institutions
+          @institutions ||= Institutions.institutions
+        end
+        private :institutions
+      end
+    end
+  end
+end

data/lib/authpds/helpers/institution/param_helper.rb

@@ -0,0 +1,19 @@
+module Authpds
+  module Helpers
+    module Institution
+      module ParamHelper
+        # The institution param key as configured in UserSession
+        def institution_param_key
+          @institution_param_key ||= UserSession.institution_param_key
+        end
+
+        # The institution param as a Symbol
+        def institution_param
+          if params["#{institution_param_key}"].present?
+            params["#{institution_param_key}"].to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/lib/authpds/helpers/institution/url_helper.rb

@@ -0,0 +1,18 @@
+module Authpds
+  module Helpers
+    module Institution
+      module UrlHelper
+        # Include institutional param helper
+        include ParamHelper
+
+        # Override Rails #url_for to add institution 
+        def url_for(options={})
+          if institution_param.present? and options.is_a? Hash
+            options[institution_param_key] ||= institution_param
+          end
+          super options
+        end
+      end
+    end
+  end
+end

data/lib/authpds/session.rb

@@ -63,4 +63,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/authentication.rb

@@ -23,4 +23,4 @@ module Authpds
       protected :authenticate
     end
   end
-end
+end

data/lib/authpds/session/authlogic_callbacks.rb

@@ -9,4 +9,4 @@ module Authpds
       protected :persist_session
     end
   end
-end
+end

data/lib/authpds/session/authorization.rb

@@ -13,4 +13,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/callbacks.rb

@@ -27,4 +27,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/config.rb

@@ -59,4 +59,4 @@ module Authpds
       alias_method :validate_url_name=, :validate_url_name
     end
   end
-end
+end

data/lib/authpds/session/core_attributes.rb

@@ -31,4 +31,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/exception_handling.rb

@@ -20,4 +20,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/institution_attributes.rb

@@ -13,4 +13,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/pds_handle.rb

@@ -7,4 +7,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/pds_user.rb

@@ -11,4 +11,4 @@ module Authpds
       end
     end
   end
-end
+end

data/lib/authpds/session/record.rb

@@ -31,4 +31,4 @@ module Authpds
       private :reset_record
     end
   end
-end
+end

data/lib/authpds/session/url_handling.rb

@@ -58,4 +58,4 @@ module Authpds
       private :validate_url
     end
   end
-end
+end

data/lib/authpds/version.rb

@@ -1,3 +1,3 @@
 module Authpds
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authpds
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -167,12 +167,13 @@ files:
 - lib/authpds/acts_as_authentic/expiration.rb
 - lib/authpds/acts_as_authentic/institutions_attributes.rb
 - lib/authpds/acts_as_authentic.rb
-- lib/authpds/controllers/authpds_controller/core_attributes.rb
-- lib/authpds/controllers/authpds_controller/institution_attributes.rb
-- lib/authpds/controllers/authpds_controller/url_handling.rb
 - lib/authpds/controllers/authpds_controller.rb
 - lib/authpds/controllers/authpds_sessions_controller.rb
 - lib/authpds/exlibris/pds.rb
+- lib/authpds/helpers/current_user_helper.rb
+- lib/authpds/helpers/institution/current_institution_helper.rb
+- lib/authpds/helpers/institution/param_helper.rb
+- lib/authpds/helpers/institution/url_helper.rb
 - lib/authpds/session/authentication.rb
 - lib/authpds/session/authlogic_callbacks.rb
 - lib/authpds/session/authorization.rb
@@ -191,7 +192,7 @@ files:
 - lib/tasks/pds-auth_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 - test/authpds_controller_test.rb
 - test/authpds_test.rb
 - test/authpds_user_sessions_controller_test.rb
@@ -227,7 +228,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4432743681608320129
+      hash: -458188680690181348
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -236,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4432743681608320129
+      hash: -458188680690181348
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/README.rdoc

@@ -1,150 +0,0 @@
-{<img src="https://badge.fury.io/rb/authpds.png" alt="Gem Version" />}[http://badge.fury.io/rb/authpds]
-{<img src="https://api.travis-ci.org/scotdalton/authpds.png?branch=master" alt="Build Status" />}[https://travis-ci.org/scotdalton/authpds]
-{<img src="https://gemnasium.com/scotdalton/authpds.png" alt="Dependency Status" />}[https://gemnasium.com/scotdalton/authpds]
-{<img src="https://codeclimate.com/github/scotdalton/authpds.png" />}[https://codeclimate.com/github/scotdalton/authpds]
-{<img src="https://coveralls.io/repos/scotdalton/authpds/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/scotdalton/authpds]
-
-= Authpds
-Libraries 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.
-
-== Basics
-=== 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:integer 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
-
-=== Configure User-like model
-  class User < ActiveRecord::Base
-    serialize :user_attributes  
-
-    acts_as_authentic do |c|
-      c.validations_scope = :username
-      c.validate_password_field = false
-      c.require_password_confirmation = false  
-      c.disable_perishable_token_maintenance = true
-    end
-  end
-
-=== Generate UserSession model
-  $ rails generate authlogic:session user_session
-
-=== Configure UserSession with Authpds options
-  class UserSession < Authlogic::Session::Base
-    pds_url "https://login.library.institution.edu"
-    redirect_logout_url "http://library.institution.edu"
-    calling_system "my_system"
-
-    def expiration_date
-      1.second.ago
-    end
-  end
-
-=== Create UserSessions controller
-  $ rails generate controller UserSessions --no-assets --no-helper
-
-=== Configure institutions
-
-==== Create institutions.yml file
-
-Calling the institution "default" will make it the default:
-
-  default:
-    login:
-      code: INST01
-    display_name: My Institution
-
-An alternative syntax:
-
-  INST01:
-    login:
-      code: INST01
-    default: true
-    display_name: My Institution
-
-You can create multiple institution listings as follows:
-
-  INST01:
-    login:
-      code: INST01
-    default: true
-    display_name: My Institution
-  INST02:
-    login:
-      code: INST01
-    display_name: Your Institution
-
-The two separate institutions above share a code in this example. The code attribute determines the institute parameter in the PDS url.
-
-==== Institution fields
-:name:: Institution name
-:display_name:: Name to display to users.
-:default:: Boolean indicating whether this is a default Institution.  Alternatively, an Institution can be named 'default'.
-:parent_institution:: A parent Institution from which this child will inherit fields.
-:ip_addresses:: IP addresses associated with the Institution.
-:login:: Login configurations associated with the Institution.
-:layouts:: Layout configurations associated with the Institution.
-:views:: View configurations associated with the Institution.
-:controllers:: Controller configurations associated with the Institution.
-:models:: Model configurations associated with the Institution.
-  
-
-==== Create institution initializer
-
-Most likely it will just work if you put the config file in 
-  "#{Rails.root}/config/institutions.yml"
-
-If you have your institutions config file in another location make sure to change the line below accordingly.
-  Institutions.loadpaths << File.join("other", "path")
-  Institutions.filenames << "other_file.yml"
-
-=== Mixin authpds methods into UserSessionsController
-  class UserSessionsController < ApplicationController
-    require 'authpds'
-    include Authpds::Controllers::AuthpdsSessionsController
-  end
-
-=== Mixin authpds methods into ApplicationController
-  class ApplicationController < ActionController::Base
-    protect_from_forgery
-    require 'authpds'
-    include Authpds::Controllers::AuthpdsController
-  end
-
-== Overview
-The Authpds gem mixes in callbacks to Authlogic for persisting
-sessions based on a valid PDS handle.  
-The module extends Authlogic and should be compatible with Authlogic configuation.
-It also provides hooks for custom functionality.
-The documentation below describes the hooks available for overriding, PDS config methods
-and further details about the module.
-
-== Config Options Available
-:pds_url:: Base pds url
-:calling_system:: Name of the system (authpds)
-:anonymous:: Does the system allow anonymous access? (true)
-:pds_attributes:: Mapping of PDS attributes to record attributes
-:redirect_logout_url:: Custom redirect logout url
-:login_inaccessible_url:: Custom url to redirect to in case of PDS system outage
-:pds_record_identifier:: PDS user method to call to identify record
-:institution_param_key:: Querystring parameter key for the institution value in this system
-:validate_url_name:: URL name for validation action in routes (validate_url)
-
-== Hooks Available for Overriding
-:pds_record_identifier:: Allows for more complex logic in determining what should be used as the record identifier. Defaults to what was set in the pds_record_identifier config.  Returns a Symbol.
-:attempt_sso?:: If there is no PDS handle, can we attempt to establish a PDS session based on some other information?  Returns a Boolean.
-:additional_authorization:: Allows for additions to the authorization decision.  Returns a Boolean.
-:additional_attributes:: Allows for additional attributes to be stored in the record.  Returns a Hash.
-:expiration_date:: Indicates when the record information should be refreshed.  Defaults to one week ago.  Returns a Date or Time.
-
-== Further Implementation Details 
-=== Persisting a Session in AuthLogic
-When persisting a Session, Authlogic attempts to create the Session based on information available 
-without having to perform an actual login by calling the :persisting? method. Authologic provides several callbacks from the :persisting?
-method, e.g. :before_persisting, :persist, :after_persisting.  We're using the :persist callback and setting it to :persist_session.
-
-=== Access to the controller in Session
-The class that Session extends, Authologic::Session::Base, has an explicit handle to the current controller via the instance method 
-:controller.  This gives our custom instance methods access to cookies, session information, loggers, etc. and also allows them to 
-perform redirects and renders.

data/lib/authpds/controllers/authpds_controller/core_attributes.rb

@@ -1,24 +0,0 @@
-module Authpds
-  module Controllers
-    module AuthpdsController
-      module CoreAttributes
-        # Set helper methods when this module is included.
-        def self.included(klass)
-          klass.class_eval do
-            helper_method :current_user_session, :current_user
-          end
-        end
-
-        # Get the current UserSession if it exists
-        def current_user_session
-          @current_user_session ||= UserSession.find
-        end
-
-        # Get the current User if there is a UserSession
-        def current_user
-          @current_user ||= current_user_session.record unless current_user_session.nil?
-        end
-      end
-    end
-  end
-end

data/lib/authpds/controllers/authpds_controller/institution_attributes.rb

@@ -1,63 +0,0 @@
-module Authpds
-  module Controllers
-    module AuthpdsController
-      module InstitutionAttributes
-        require 'institutions'
-
-        # Set helper methods when this module is included.
-        def self.included(klass)
-          klass.class_eval do
-            helper_method :current_primary_institution
-            helper_method :url_for
-          end
-        end
-
-        # Determine current primary institution based on:
-        #   0. institutions are not being used (returns nil)
-        #   1. institution query string parameter in URL
-        #   2. institution associated with the client IP
-        #   3. primary institution for the current user
-        #   4. first default institution
-        def current_primary_institution
-          @current_primary_institution ||=
-            (institution_param.nil? or all_institutions[institution_param].nil?) ?
-              ((primary_institution_from_ip.nil?) ?
-                ((@current_user.nil? or current_user.primary_institution.nil?) ?
-                  Institutions.defaults.first :
-                    current_user.primary_institution) :
-                      primary_institution_from_ip) :
-                        all_institutions[institution_param]
-        end
-
-        # Override Rails ActionController#url_for to add institution.
-        def url_for(options={})
-          if institution_param.present? and options.is_a? Hash
-            options[institution_param_key] ||= institution_param
-          end
-          super options
-        end
-
-        # Grab the first institution that matches the client IP
-        def primary_institution_from_ip
-          Institutions.with_ip(request.remote_ip).first unless request.nil?
-        end
-        private :primary_institution_from_ip
-
-        def institution_param_key
-          @institution_param_key ||= UserSession.institution_param_key
-        end
-        private :institution_param_key
-
-        def institution_param
-          params["#{institution_param_key}"].to_sym unless params["#{institution_param_key}"].nil?
-        end
-        private :institution_param
-
-        def all_institutions
-          @all_institutions ||= Institutions.institutions
-        end
-        private :all_institutions
-      end
-    end
-  end
-end

data/lib/authpds/controllers/authpds_controller/url_handling.rb

@@ -1,12 +0,0 @@
-module Authpds
-  module Controllers
-    module AuthpdsController
-      module UrlHandling
-        # Controller method to generate the Appropriate redirect url
-        def user_session_redirect_url(url)
-          (url.nil? or url.empty?) ? (request.referer.nil?) ? root_url : request.referer : url
-        end
-      end
-    end
-  end
-end