[Catalyst-commits] r6958 - trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store

[bricas at dev.catalyst.perl.org]

Author: bricas
Date: 2007-10-05 15:50:53 +0100 (Fri, 05 Oct 2007)
New Revision: 6958

Modified:
   trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Minimal.pm
   trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Null.pm
Log:
pod updates

Modified: trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Minimal.pm
===================================================================
--- trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Minimal.pm	2007-10-05 03:56:40 UTC (rev 6957)
+++ trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Minimal.pm	2007-10-05 14:50:53 UTC (rev 6958)
@@ -104,8 +104,7 @@
 
 =head1 NAME
 
-Catalyst::Plugin::Authentication::Store::Minimal - Minimal
-authentication store.
+Catalyst::Plugin::Authentication::Store::Minimal - Minimal authentication store
 
 =head1 SYNOPSIS
 

Modified: trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Null.pm
===================================================================
--- trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Null.pm	2007-10-05 03:56:40 UTC (rev 6957)
+++ trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Store/Null.pm	2007-10-05 14:50:53 UTC (rev 6958)
@@ -37,3 +37,65 @@
 }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Catalyst::Plugin::Authentication::Store::Null - Null authentication store
+
+=head1 SYNOPSIS
+
+    use Catalyst qw(
+        Authentication
+    );
+
+    __PACKAGE__->config->{authentication} = {
+        default_realm => 'remote',
+        realms => {
+            remote => {
+                credential => {
+                    class => 'TypeKey',
+                    key_url => 'http://example.com/regkeys.txt',
+                },
+                store => {
+                    class => 'Null',
+                }
+            }
+    	}
+    };
+
+=head1 DESCRIPTION
+
+The Null store is a transparent store where any supplied user data is
+accepted. This is mainly useful for remotely authenticating credentials
+(e.g. TypeKey, OpenID) which may not be tied to any local storage. It also
+helps facilitate integration with the Session plugin.
+
+=head1 METHODS
+
+=head2 new( )
+
+Creates a new instance of the store.
+
+=head2 for_session( )
+
+Returns the user object passed to the method.
+
+=head2 from_session( )
+
+Returns the user object passed to the method.
+
+=head2 find_user( )
+
+Since this store isn't tied to any real set of users, this method just returns
+the user info bless as a L<Catalyst::Plugin::Authentication::User::Hash>
+object.
+
+=head2 user_supports( )
+
+Delegates to L<Catalyst::Plugin::Authentication::User::Hash>.
+
+=cut