authpds-nyu 0.0.9 → 0.1.0

data/README.rdoc

@@ -1,3 +1,63 @@
 = AuthpdsNyu
 
-Gem to connect to NYU PDS system for user authentication and authorization.
+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
+
+=== 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.nyu.edu"
+    redirect_logout_url "http://bobcat.library.nyu.edu"
+    calling_system "nyu_system"
+    anonymous true
+  end
+
+=== Create UserSessions controller
+  $ rails generate controller UserSessions --no-assets --no-helper
+
+=== 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 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)
+

data/lib/authpds-nyu/session.rb

@@ -1,4 +1,16 @@
 module AuthpdsNyu
+  # == Overview
+  # This gem provides a mechanism for user authentication and authorization via NYU Libraries PDS system.  
+  # 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)
+  # 
   module Session
     def self.included(klass)
       klass.class_eval do
@@ -62,7 +74,7 @@ module AuthpdsNyu
         end
       end
       
-      # Override logout url for NYU.
+      # Overriden logout url for NYU.
       def logout_url(params={})
         return "#{self.class.pds_url}/logout?url=#{CGI::escape(controller.user_session_redirect_url(self.class.redirect_logout_url))}"
       end

data/lib/authpds-nyu/version.rb

@@ -1,3 +1,3 @@
 module AuthpdsNyu
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authpds-nyu
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000 Z
+date: 2012-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2151933700 !ruby/object:Gem::Requirement
+  requirement: &2151934880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2151933700
+  version_requirements: *2151934880
 - !ruby/object:Gem::Dependency
   name: authpds
-  requirement: &2151932200 !ruby/object:Gem::Requirement
+  requirement: &2151932960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151932200
+  version_requirements: *2151932960
 - !ruby/object:Gem::Dependency
   name: exlibris-aleph
-  requirement: &2151930480 !ruby/object:Gem::Requirement
+  requirement: &2151931660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151930480
+  version_requirements: *2151931660
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2151929580 !ruby/object:Gem::Requirement
+  requirement: &2151930180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151929580
+  version_requirements: *2151930180
 description: NYU libraries SSO client.
 email:
 - scotdalton@gmail.com