README.rdoc in authpds-nyu-0.1.4 vs README.rdoc in authpds-nyu-0.2.0
- old
+ new
@@ -1,25 +1,28 @@
= AuthpdsNyu
+{<img src="https://secure.travis-ci.org/scotdalton/authpds-nyu.png?branch=master" alt="Build Status" />}[https://travis-ci.org/scotdalton/authpds-nyu]
+{<img src="https://gemnasium.com/scotdalton/authpds-nyu.png" alt="Dependency Status" />}[https://gemnasium.com/scotdalton/authpds-nyu]
+{<img src="https://codeclimate.com/badge.png" alt="Code Climage" />}[https://codeclimate.com/github/scotdalton/authpds-nyu]
This gem provides a mechanism for user authentication and authorization via NYU Libraries PDS system. It extends Authpds and provides NYU Libraries' specific configuration.
== 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
+ 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
+ serialize :user_attributes
acts_as_authentic do |c|
c.validations_scope = :username
c.validate_password_field = false
- c.require_password_confirmation = false
+ c.require_password_confirmation = false
c.disable_perishable_token_maintenance = true
end
end
=== Generate UserSession model
@@ -47,19 +50,15 @@
protect_from_forgery
require 'authpds'
include Authpds::Controllers::AuthpdsController
end
-
== Overview
The module extends Authpds and should be compatible with Authpds configuation.
It also provides hooks for custom functionality.
The documentation below describes NYU specific config methods available.
== Config Options Available
:opensso_url:: Base OpenSSO url (https://login.nyu.edu:443/sso)
:aleph_url:: Aleph url (http://aleph.library.nyu.edu)
:aleph_default_adm:: Aleph default ADM (NYU50)
-:aleph_default_sublibrary:: Aleph default sublibrary (BOBST)
-
-
-== Build Status {<img src="https://secure.travis-ci.org/scotdalton/authpds-nyu.png"/>}[http://travis-ci.org/scotdalton/authpds-nyu]
+:aleph_default_sublibrary:: Aleph default sublibrary (BOBST)
\ No newline at end of file