README.rdoc in authpds-0.2.9 vs README.rdoc in authpds-1.0.0
- old
+ new
@@ -1,12 +1,12 @@
-= 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
=== Generate User-like model
$ rails generate model User username:string email:string firstname:string \
@@ -131,10 +131,10 @@
: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.
-: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.
== Further Implementation Details
\ No newline at end of file