lib/authpds-nyu/session.rb in authpds-nyu-0.0.9 vs lib/authpds-nyu/session.rb in authpds-nyu-0.1.0

@@ -1,6 +1,18 @@
 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
         extend Config
         include AuthpdsCallbackMethods
@@ -60,10 +72,10 @@
           secure true
           login_inaccessible_url "http://library.nyu.edu/errors/login-library-nyu-edu/"
         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
 
       def aleph_bor_auth_permissions(bor_id=nil, verification=nil, adm=nil, sublibrary=nil)
\ No newline at end of file