changes update plus some stub docs
Brian Cassidy [Wed, 24 Oct 2007 19:45:53 +0000 (19:45 +0000)]
Changes
lib/Catalyst/Plugin/Authentication/Realm.pm
lib/Catalyst/Plugin/Authentication/Realm/Compatibility.pm

diff --git a/Changes b/Changes
index f062d07..beff03b 100644 (file)
--- a/Changes
+++ b/Changes
@@ -2,6 +2,8 @@ Revision history for Perl extension Catalyst::Plugin::Authentication
 
 0.10003 2007-XX-XX
         - Added a "Null" store for credentials that don't require real stores.
+        - Make realms bonafide objects
+        - Added auto_update and auto_create options to the Realm object
 
 0.10002 2007-07-22
         - $user->store() should NOT be set by C::P::Auth - if it's needed - it
index caace07..7dcf1a7 100644 (file)
@@ -2,6 +2,7 @@ package Catalyst::Plugin::Authentication::Realm;
 
 use strict;
 use warnings;
+
 use base qw/Class::Accessor::Fast/;
 
 BEGIN {
@@ -136,3 +137,31 @@ sub from_session {
 __PACKAGE__;
 
 __END__
+
+=pod
+
+=head1 NAME
+
+Catalyst::Plugin::Authentication::Realm - Base class for realm objects.
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=over 4
+
+=item new
+
+=item find_user
+
+=item authenticate
+
+=item save_user_in_session
+
+=item from_session
+
+=back
+
+=cut
+
+
index a7547a9..fcf12cf 100644 (file)
@@ -2,8 +2,8 @@ package Catalyst::Plugin::Authentication::Realm::Compatibility;
 
 use strict;
 use warnings;
-use base qw/Catalyst::Plugin::Authentication::Realm/;
 
+use base qw/Catalyst::Plugin::Authentication::Realm/;
 
 ## very funky - the problem here is that we can't do real realm initialization
 ## but we need a real realm object to function.  So - we kinda fake it - we 
@@ -21,4 +21,26 @@ sub new {
 
 __PACKAGE__;
 
-__END__
\ No newline at end of file
+__END__
+
+=pod
+
+=head1 NAME
+
+Catalyst::Plugin::Authentication::Realm::Compatibility - Compatibility realm object
+
+=head1 DESCRIPTION
+
+An empty realm object for compatibility reasons.
+
+=head1 METHODS
+
+=over 4
+
+=item new
+
+Returns a, basically empty, realm object.
+
+=back
+
+=cut