add a check that user really exists to Store::Htpasswd::User's constructor
[catagits/Catalyst-Authentication-Store-Htpasswd.git] / lib / Catalyst / Plugin / Authentication / Store / Htpasswd / User.pm
index b5efe7c..3a80007 100644 (file)
@@ -6,31 +6,56 @@ use base qw/Catalyst::Plugin::Authentication::User Class::Accessor::Fast/;
 use strict;
 use warnings;
 
-BEGIN { __PACKAGE__->mk_accessors(qw/user/) }
+BEGIN { __PACKAGE__->mk_accessors(qw/user store/) }
+
+use overload '""' => sub { shift->id }, fallback => 1;
 
 sub new {
-       my ( $class, $user ) = @_;
+       my ( $class, $store, $user ) = @_;
+
+       return unless $user;
+
+       bless { store => $store, user => $user }, $class;
+}
 
-       bless { user => $user }, $class;
+sub id {
+    my $self = shift;
+    return $self->user->username;
 }
 
 sub supported_features {
        return {
                password => {
                        self_check => 1,
-               }
+               },
+               session => 1
        };
 }
 
 sub check_password {
        my ( $self, $password ) = @_;
-
        return $self->user->check_password( $password );
 }
 
 sub roles {
        my $self = shift;
-       split( ",", $self->user->extra_info );
+       my $field = $self->user->extra_info->[0];
+       return defined $field ? split /,/, $field : ();
+}
+
+sub for_session {
+    my $self = shift;
+    return $self->id;
+}
+
+sub AUTOLOAD {
+       my $self = shift;
+       
+       ( my $method ) = ( our $AUTOLOAD =~ /([^:]+)$/ );
+
+       return if $method eq "DESTROY";
+       
+       $self->user->$method;
 }
 
 __PACKAGE__;
@@ -44,11 +69,39 @@ __END__
 Catalyst::Plugin::Authentication::Store::Htpasswd::User - A user object
 representing an entry in an htpasswd file.
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
-       use Catalyst::Plugin::Authentication::Store::Htpasswd::User;
+This object wraps an L<Authen::Htpasswd::User> object. An instance of it will be returned
+by C<< $c->user >> when using L<Catalyst::Plugin::Authentication::Store::Htpasswd>. Methods 
+not defined in this module are passed through to the L<Authen::Htpasswd::User> object. The
+object stringifies to the username.
 
-=head1 DESCRIPTION
+=head1 METHODS
+
+=head2 new($store,$user)
+
+Creates a new object from a store object, normally an instance of 
+L<Catalyst::Plugin::Authentication::Store::Htpasswd::Backend>, and a user object,
+normally an instance of L<Authen::Htpasswd::User>.
+
+=head2 id
+
+Returns the username.
+
+=head2 check_password($password)
+
+Returns whether the password is valid.
+
+=head2 roles
+
+Returns an array of roles, which is extracted from a comma-separated list in the
+third field of the htpasswd file.
+
+=head1 COPYRIGHT & LICENSE
+
+       Copyright (c) 2005 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