Fixes to docs and AUTHORITY

[catagits/Catalyst-Plugin-Authentication.git] / lib / Catalyst / Plugin / Authentication.pm

diff --git a/lib/Catalyst/Plugin/Authentication.pm b/lib/Catalyst/Plugin/Authentication.pm
index 4898277..1438f29 100644 (file)
--- a/lib/Catalyst/Plugin/Authentication.pm
+++ b/lib/Catalyst/Plugin/Authentication.pm
@@ -1,18 +1,17 @@
 package Catalyst::Plugin::Authentication;
 
-use base qw/Class::Accessor::Fast/;
-
-__PACKAGE__->mk_accessors(qw/_user/);
-
-use strict;
-use warnings;
-
+use Moose;
+use namespace::clean -except => 'meta';
 use MRO::Compat;
 use Tie::RefHash;
 use Class::Inspector;
 use Catalyst::Authentication::Realm;
 
-our $VERSION = "0.10016";
+with 'MooseX::Emulate::Class::Accessor::Fast';
+
+__PACKAGE__->mk_accessors(qw/_user/);
+
+our $VERSION = "0.10020";
 
 sub set_authenticated {
     my ( $c, $user, $realmname ) = @_;
@@ -474,6 +473,7 @@ sub auth_stores {
     my %hash = ( 'default' => $self->get_auth_realm('default')->store);
 }
 
+__PACKAGE__->meta->make_immutable;
 __PACKAGE__;
 
 __END__
@@ -482,8 +482,7 @@ __END__
 
 =head1 NAME
 
-Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst
-authentication framework.
+Catalyst::Plugin::Authentication - Infrastructure plugin for the Catalyst authentication framework.
 
 =head1 SYNOPSIS
 
@@ -863,14 +862,20 @@ default realm is checked.
 =head2 $c->user( )
 
 Returns the currently logged in user, or undef if there is none.
+Normally the user is re-retrieved from the store.
+For L<Catalyst::Authentication::Store::DBIx::Class> the user is re-restored 
+using the primary key of the user table. 
+Thus B<user> can throw an error even though B<user_exists>
+returned true.
 
 =head2 $c->user_exists( )
 
 Returns true if a user is logged in right now. The difference between
-user_exists and user is that user_exists will return true if a user is logged
+B<user_exists> and B<user> is that user_exists will return true if a user is logged
 in, even if it has not been yet retrieved from the storage backend. If you only
 need to know if the user is logged in, depending on the storage mechanism this
 can be much more efficient.
+B<user_exists> only looks into the session while B<user> is trying to restore the user.
 
 =head2 $c->user_in_realm( $realm )
 
@@ -1106,30 +1111,50 @@ Register stores into the application.
 
 =head2 $c->get_user( )
 
-=head1 AUTHORS
+=head1 SUPPORT
+
+Please use the rt.cpan.org bug tracker, and git patches are wecome.
+
+Questions on usage should be directed to the Catalyst mailing list
+or the #catalyst irc channel.
 
-Yuval Kogman, C<nothingmuch@woobling.org>
+=head1 AUTHORS
 
-Jay Kuri, C<jayk@cpan.org>
+Yuval Kogman, C<nothingmuch@woobling.org> - original author
 
-Jess Robinson
+Jay Kuri, C<jayk@cpan.org> - Large rewrite
 
-David Kamholz
+=head1 PRIMARY MAINTAINER
 
 Tomas Doran (t0m), C<bobtfish@bobtfish.net>
 
-kmx
+=hasd1 ADDITIONAL CONTRIBUTORS
+
+=over
+
+=item Jess Robinson
+
+=item David Kamholz
 
-Nigel Metheringham
+=itm kmx
 
-Florian Ragwitz C<rafl@debian.org>
+=item Nigel Metheringham
 
-Stephan Jauernick C<stephanj@cpan.org>
+=item Florian Ragwitz C<rafl@debian.org>
+
+=item Stephan Jauernick C<stephanj@cpan.org>
+
+=item Oskari Ojala (Okko), C<perl@okko.net>
+
+=item John Napiorkowski (jnap) C<jjnapiork@cpan.org>
+
+=back
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright (c) 2005 - 2009
-the Catalyst::Plugin::Authentication L</AUTHORS>
+Copyright (c) 2005 - 2012
+the Catalyst::Plugin::Authentication L</AUTHORS>,
+L</PRIMARY MAINTAINER> and L</ADDITIONAL CONTRIBUTORS>
 as listed above.
 
 This program is free software; you can redistribute