pod updates
Brian Cassidy [Fri, 5 Oct 2007 14:50:53 +0000 (14:50 +0000)]
lib/Catalyst/Plugin/Authentication/Store/Minimal.pm
lib/Catalyst/Plugin/Authentication/Store/Null.pm

index 91c7c13..e48a45f 100644 (file)
@@ -104,8 +104,7 @@ __END__
 
 =head1 NAME
 
-Catalyst::Plugin::Authentication::Store::Minimal - Minimal
-authentication store.
+Catalyst::Plugin::Authentication::Store::Minimal - Minimal authentication store
 
 =head1 SYNOPSIS
 
index b4207ab..4c854c7 100644 (file)
@@ -37,3 +37,65 @@ sub user_supports {
 }
 
 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