whitespace fixes
[catagits/Catalyst-Authentication-Store-Htpasswd.git] / lib / Catalyst / Authentication / Store / Htpasswd.pm
index b45019f..090f6e3 100644 (file)
@@ -1,21 +1,23 @@
 #!/usr/bin/perl
 
 package Catalyst::Authentication::Store::Htpasswd;
+# ABSTRACT: Authen::Htpasswd based user storage/authentication
+
 use base qw/Class::Accessor::Fast/;
 use strict;
 use warnings;
 
-use Authen::Htpasswd;
+use Authen::Htpasswd 0.13;
 use Catalyst::Authentication::Store::Htpasswd::User;
 use Scalar::Util qw/blessed/;
 
-our $VERSION = '1.004';
+our $VERSION = '1.006';
 
 BEGIN { __PACKAGE__->mk_accessors(qw/file user_field user_class/) }
 
 sub new {
     my ($class, $config, $app, $realm) = @_;
-    
+
     my $file = delete $config->{file};
     unless (ref $file) {
         my $filename = ($file =~ m|^/|) ? $file : $app->path_to($file)->stringify;
@@ -25,7 +27,7 @@ sub new {
     $config->{file} = $file;
     $config->{user_class} ||= __PACKAGE__ . '::User';
     $config->{user_field} ||= 'username';
-    
+
     bless { %$config }, $class;
 }
 
@@ -38,7 +40,7 @@ sub find_user {
 sub user_supports {
     my $self = shift;
 
-    # this can work as a class method, but in that case you can't have 
+    # this can work as a class method, but in that case you can't have
     # a custom user class
     ref($self) ? $self->user_class->supports(@_)
         : Catalyst::Authentication::Store::Htpasswd::User->supports(@_);
@@ -55,11 +57,6 @@ __END__
 
 =pod
 
-=head1 NAME
-
-Catalyst::Authentication::Store::Htpasswd - Authen::Htpasswd based
-user storage/authentication.
-
 =head1 SYNOPSIS
 
     use Catalyst qw/
@@ -82,7 +79,7 @@ user storage/authentication.
                     },
                 },
             },
-        },   
+        },
     );
 
     sub login : Global {
@@ -93,7 +90,7 @@ user storage/authentication.
 
 =head1 DESCRIPTION
 
-This plugin uses L<Authen::Htpasswd> to let your application use C<<.htpasswd>>
+This plugin uses L<Authen::Htpasswd> to let your application use C<< .htpasswd >>
 files for it's authentication storage.
 
 =head1 METHODS
@@ -108,18 +105,19 @@ Looks up the user, and returns a Catalyst::Authentication::Store::Htpasswd::User
 
 =head2 user_supports
 
-Delegates to L<Catalyst::Authentication::Store::Htpasswd::User->user_supports|Catalyst::Authentication::Store::Htpasswd::User#user_supports>
+Delegates to L<< Catalyst::Authentication::User->supports|Catalyst::Authentication::User/supports >> or an
+override in L<user_class|/user_class>.
 
 =head2 from_session
 
-Delegates the user lookup to C<< find_user >>
+Delegates the user lookup to L<find_user|/find_user>
 
 =head1 CONFIGURATION
 
 =head2 file
 
 The path to the htpasswd file. If the path starts with a slash, then it is assumed to be a fully
-qualified path, otherwise the path is fed through C<< $c->path_to >> and so normalised to the 
+qualified path, otherwise the path is fed through C<< $c->path_to >> and so normalised to the
 application root.
 
 Alternatively, it is possible to pass in an L<Authen::Htpasswd> object here, and this will be
@@ -149,24 +147,8 @@ Example:
     # Later in your code
     $c->authenticate({ email_address => $c->req->param("email"), password => $c->req->param("password") });
 
-=head1 AUTHORS
-
-Yuval Kogman C<<nothingmuch@woobling.org>>
-
-David Kamholz C<<dkamholz@cpan.org>>
-
-Tomas Doran C<<bobtfish@bobtfish.net>>
-
 =head1 SEE ALSO
 
 L<Authen::Htpasswd>.
 
-=head1 COPYRIGHT & LICENSE
-
-       Copyright (c) 2005-2008 the aforementioned authors. All rights
-       reserved. This program is free software; you can redistribute
-       it and/or modify it under the same terms as Perl itself.
-
 =cut
-
-