authpds 0.2.9 → 1.0.0

data/README.rdoc

@@ -1,10 +1,10 @@
-= Authpds
 {<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
@@ -133,7 +133,7 @@ and further details about the module.
 
 == 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.
-:valid_sso_session?:: If there is no PDS handle, can we redirect to PDS to establish a SSO session based on some other information?  Returns a Boolean.
+: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.

data/lib/authpds/session.rb

@@ -20,7 +20,7 @@ module Authpds
   #
   # == Hooks Available
   # :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.
-  # :valid_sso_session?:: If there is no PDS handle, can we redirect to PDS to establish a SSO session based on some other information?  Returns a Boolean.
+  # :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.
@@ -51,7 +51,6 @@ module Authpds
     include Authpds::Session::PdsHandle
     include Authpds::Session::PdsUser
     include Authpds::Session::Record
-    include Authpds::Session::SessionId
     include Authpds::Session::UrlHandling
 
     def self.included(klass)

data/lib/authpds/session/authentication.rb

@@ -9,13 +9,15 @@ module Authpds
       def authenticate
         # Don't authenticate if the system is inaccessible.
         # If the application session id is nil, skip this check.
-        return false if controller.cookies["#{calling_system}_inaccessible".to_sym] == session_id unless session_id.nil?
+        return false if controller.cookies["#{calling_system}_inaccessible".to_sym] == true
         # If PDS session already established, authenticate
         return true unless pds_user.nil?
-        # Establish a PDS session if the user logged in via an alternative SSO mechanism and this isn't being called after login
-        controller.redirect_to sso_url({
-          :return_url => controller.request.url }) if valid_sso_session? unless controller.params["action"] =="validate" or controller.performed?
-        # Otherwise, do not authenticate
+        # Try to establish a PDS session if the user logged in via an alternative 
+        # SSO mechanism and this isn't being called after login
+        unless controller.params["action"] =="validate" or controller.performed?
+          controller.redirect_to sso_url({ :return_url => controller.request.url }) if attempt_sso?
+        end
+        # Definitely, do not authenticate if we got this far
         return false
       end
       protected :authenticate

data/lib/authpds/session/callbacks.rb

@@ -6,8 +6,8 @@ module Authpds
         @pds_record_identifier ||= self.class.pds_record_identifier
       end
 
-      # Hook to determine if we should set up an SSO session
-      def valid_sso_session?
+      # Hook to determine if we should attempt to establish a PDS session
+      def attempt_sso?
         return false
       end
 

data/lib/authpds/session/config.rb

@@ -21,8 +21,10 @@ module Authpds
 
       # Mapping of PDS attributes
       def pds_attributes(value = nil)
-        value.each_value { |pds_attr| pds_attr.gsub!("-", "_") } unless value.nil?
-        rw_config(:pds_attributes, value, {:email => "email", :firstname => "name", :lastname => "name", :primary_institution => "institute" })
+        value.each_value { |pds_attr|
+          pds_attr.gsub!("-", "_") } unless value.nil?
+        rw_config(:pds_attributes, value, { email: "email", firstname: "name",
+          lastname: "name", primary_institution: "institute" })
       end
       alias_method :pds_attributes=, :pds_attributes
 
@@ -36,7 +38,7 @@ module Authpds
       def login_inaccessible_url(value = nil)
         rw_config(:login_inaccessible_url, value, "")
       end
-      alias_method :redirect_logout_url=, :redirect_logout_url
+      alias_method :login_inaccessible_url=, :login_inaccessible_url
 
       # PDS user method to call to identify record
       def pds_record_identifier(value = nil)

data/lib/authpds/session/exception_handling.rb

@@ -3,11 +3,10 @@ module Authpds
     module ExceptionHandling
       def handle_login_exception(error)
         # Set a cookie saying that we've got some invalid stuff going on
-        # in this session.  Either PDS is screwy, OpenSSO is screwy, or both.
-        # Either way, we want to skip logging in since it's problematic (if anonymous).
+        # in this session.  PDS may be screwy. We want to skip logging in 
+        # since it's problematic (if anonymous).
         controller.cookies["#{calling_system}_inaccessible".to_sym] = {
-          :value => session_id,
-          :path => "/" } if anonymous?
+          :value => true, :path => "/" } if anonymous?
         # If anonymous access isn't allowed, we can't rightfully set the cookie.
         # We probably should send to a system down page.
         controller.redirect_to(login_inaccessible_url)
@@ -15,7 +14,9 @@ module Authpds
       end
 
       def alert_the_authorities(error)
-        controller.logger.error("Error in #{self.class}. Something is amiss with PDS authentication.\n#{error}\n#{error.backtrace.inspect}}")
+        controller.logger.error("Error in #{self.class}. " +
+          "Something is amiss with PDS authentication.\n" +
+            "#{error}\n#{error.backtrace.inspect}")
       end
     end
   end

data/lib/authpds/session/institution_attributes.rb

@@ -3,8 +3,9 @@ module Authpds
     module InstitutionAttributes
       def institution_attributes
         @institution_attributes ||=
-          (controller.current_primary_institution.nil? or controller.current_primary_institution.auth.nil?) ?
-            {} : controller.current_primary_institution.auth
+          (controller.current_primary_institution.nil? or 
+            controller.current_primary_institution.auth.nil?) ?
+              {} : controller.current_primary_institution.auth
       end
 
       def insitution_code

data/lib/authpds/session/pds_handle.rb

@@ -2,7 +2,8 @@ module Authpds
   module Session
     module PdsHandle
       def pds_handle
-        @pds_handle ||= (controller.cookies[:PDS_HANDLE] || controller.params[:pds_handle])
+        @pds_handle ||= (controller.cookies[:PDS_HANDLE] ||
+          controller.params[:pds_handle])
       end
     end
   end

data/lib/authpds/session/pds_user.rb

@@ -2,15 +2,12 @@ module Authpds
   module Session
     module PdsUser
       def pds_user
-        begin
-          @pds_user ||= Authpds::Exlibris::Pds::BorInfo.new(pds_url, calling_system, pds_handle) unless pds_handle.nil?
-          return @pds_user unless @pds_user.nil? or @pds_user.error
-        rescue Exception => e
-          # Delete the PDS_HANDLE, since this isn't working.
-          # controller.cookies.delete(:PDS_HANDLE) unless pds_handle.nil?
-          handle_login_exception e
-          return nil
-        end
+        @pds_user ||= Authpds::Exlibris::Pds::BorInfo.new(pds_url,
+          calling_system, pds_handle) unless pds_handle.nil?
+        return @pds_user unless @pds_user.nil? or @pds_user.error
+      rescue Exception => e
+        handle_login_exception e
+        return nil
       end
     end
   end

data/lib/authpds/session/record.rb

@@ -3,7 +3,8 @@ module Authpds
     module Record
       # Get the record associated with this PDS user.
       def get_record(login)
-        record = (klass.find_by_smart_case_login_field(login) || klass.new(login_field => login))
+        record = (klass.find_by_smart_case_login_field(login) ||
+          klass.new(login_field => login))
       end
 
       # Set the record information associated with this PDS user.
@@ -18,8 +19,9 @@ module Authpds
       # Reset expired data
       def reset_record(attempted_record)
         pds_attributes.each do |record_attr, pds_attr|
+          next unless self.attempted_record.respond_to?("#{record_attr}=".to_sym)
           attempted_record.send("#{record_attr}=".to_sym,
-            pds_user.send(pds_attr.to_sym)) if self.attempted_record.respond_to?("#{record_attr}=".to_sym)
+            pds_user.send(pds_attr.to_sym))
         end
         pds_user.class.public_instance_methods(false).each do |pds_attr_reader|
           attempted_record.user_attributes = {

data/lib/authpds/session/url_handling.rb

@@ -16,18 +16,21 @@ module Authpds
 
       # URL to redirect to after logout.
       def logout_url(params={})
-        auth_pds_url "logout", user_session_redirect_url(redirect_logout_url), params
+        auth_pds_url "logout",
+          user_session_redirect_url(redirect_logout_url), params
       end
 
       def auth_pds_login_url(func, params)
-        auth_pds_url func, validate_url(params), :institute => insitution_code, :calling_system => calling_system
+        auth_pds_url func, validate_url(params), 
+          :institute => insitution_code, :calling_system => calling_system
       end
-      protected :auth_pds_login_url
+      private :auth_pds_login_url
 
       def auth_pds_url(func, url, params)
         auth_pds_url = "#{pds_url}/pds?func=#{func}"
         params.each_pair do |key, value|
-          auth_pds_url << "&#{key}=#{CGI::escape(value)}" unless key.nil? or value.nil?
+          next if key.blank? or value.blank?
+          auth_pds_url << "&#{key}=#{CGI::escape(value)}"
         end
         auth_pds_url << "&url=#{CGI::escape(url)}"
       end
@@ -38,14 +41,17 @@ module Authpds
       end
       private :user_session_redirect_url
 
-      # Returns the URL for validating a UserSession on return from a remote login system.
+      # Returns the URL for validating a UserSession on 
+      # return from a remote login system
       def validate_url(params={})
-        url = controller.send(validate_url_name, :return_url => user_session_redirect_url(params[:return_url]))
-        return url if params.nil? or params.empty?
-        url << "?" if url.match('\?').nil?
+        url = controller.send(validate_url_name, 
+          :return_url => user_session_redirect_url(params[:return_url]))
+        return url if params.blank?
+        url << "?" if url.match('\?').blank?
         params.each do |key, value|
           next if [:controller, :action, :return_url].include?(key)
-          url << "&#{calling_system}_#{key}=#{CGI::escape(value)}" unless key.nil? or value.nil?
+          next if key.blank? or value.blank?
+          url << "&#{calling_system}_#{key}=#{CGI::escape(value)}"
         end
         url
       end

data/lib/authpds/version.rb

@@ -1,3 +1,3 @@
 module Authpds
-  VERSION = "0.2.9"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,141 +1,160 @@
 --- !ruby/object:Gem::Specification
 name: authpds
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Scot Dalton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: authlogic
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.2.14
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.2.14
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: institutions
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.13.0
 description: Libraries that use Ex Libris products, can integrate Rails application
   with PDS to provide single sign-on across systems.
 email:
@@ -165,7 +184,6 @@ files:
 - lib/authpds/session/pds_handle.rb
 - lib/authpds/session/pds_user.rb
 - lib/authpds/session/record.rb
-- lib/authpds/session/session_id.rb
 - lib/authpds/session/url_handling.rb
 - lib/authpds/session.rb
 - lib/authpds/version.rb
@@ -196,26 +214,33 @@ files:
 - test/vcr_cassettes/nyu.yml
 homepage: http://github.com/scotdalton/authpds
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3908509940850661859
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3908509940850661859
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Allows applications to use Ex Libris' Patron Directory Service (PDS) for
   authentication.
 test_files:

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjFlODczYmRlNDhhMzI0NTY1NzkwNDk2ZWUxZjFjYWQ3YTQwNzgwZQ==
-  data.tar.gz: !binary |-
-    NmYzMTUyOWU1MDVmZmIwMzIwYjY2MzhhNmVmZjdiMTkwMDQzYWU1NA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZjhiOTUxYzI0M2Y1NDZlMDFkYmQ5NmE4MmYwMjcxODVkNDQzOTYxYmRhZGM3
-    OWZjOGRhNzRhNGEwOTQyNmFjMjk5MjBhOGEwMmQ2NjBkYTY4MTkxMWZhZWUw
-    ZWYwY2VjZTBkNDA3OGJmYjQ2ZWQ1ZmE5ZDdlOWI0ZDRiNjQ0NWU=
-  data.tar.gz: !binary |-
-    Y2U3MWY1MjhhMjU1MzY0OTY0YmY2MTg2MDZhZGIzMWYwZDZlZmRiMWNmNjM4
-    ZDQ5YzkxZjlhZWFlMTBiNDBkNGVjMjM4M2IyZTQxYTIzZTBjYjljYmIwYmJm
-    Y2VjYjU1MTE5YjIzYThiODQwYzVjOTQ2Y2UyMzRiMDUzMDhmMGU=

data/lib/authpds/session/session_id.rb

@@ -1,12 +0,0 @@
-module Authpds
-  module Session
-    module SessionId
-      def session_id
-        @session_id ||=
-          (controller.session.respond_to?(:session_id)) ?
-            (controller.session.session_id) ?
-              controller.session.session_id : controller.session[:session_id] : controller.session[:session_id]
-      end
-    end
-  end
-end