lib/Text/Tradition/User.pm

   1 package Text::Tradition::User;
   2
   3 use strict;
   4 use warnings;
   5
   6 use Moose;
   7 with qw(KiokuX::User);
   8
   9 ## 'id' provided by KiokuX::User stores our username
  10 has 'password'   => (is => 'rw', required => 1);
  11 ## Change this default active value if you want/need to have an admin confirm a user after they self-create.
  12 has 'active'     => (is => 'rw', default => sub { 1; });
  13 # 'traits' => ['Array'] ?
  14 # https://metacpan.org/module/Moose::Meta::Attribute::Native::Trait::Array
  15 has 'traditions' => (is => 'rw',
  16                      traits => ['Array'],
  17                      handles => {
  18                          'add_tradition' => 'push',
  19                      },
  20                      isa => 'ArrayRef[Text::Tradition]',
  21                      default => sub { [] },
  22                      required => 0);
  23
  24 after add_tradition => sub {
  25     my ($self, $tradition) = @_;
  26     $tradition->user($self)
  27         unless $tradition->has_user && $tradition->user->id eq $self->id;
  28 };
  29
  30 1;
  31
  32 =head1 NAME
  33
  34 Text::Tradition::User - Users which own traditions, and can login to the web app
  35
  36 =head1 SYNOPSIS
  37
  38     ## Users are managed by Text::Tradition::UserStore
  39
  40     my $userstore = Text::Tradition::UserStore->new(dsn => 'dbi:SQLite:foo.db');
  41     my $newuser = $userstore->add_user({ username => 'fred',
  42                                          password => 'somepassword' });
  43
  44     my $fetchuser = $userstore->find_user({ username => 'fred' });
  45     if($fetchuser->check_password('somepassword')) {
  46        ## login user or .. whatever
  47     }
  48
  49     my $user = $userstore->deactivate_user({ username => 'fred' });
  50     if(!$user->active) {
  51       ## shouldnt be able to login etc
  52     }
  53
  54     foreach my $t (@{ $user->traditions }) {
  55       ## do something with traditions owned by this user.
  56     }
  57
  58 =head1 DESCRIPTION
  59
  60 User objects representing owners of L<Text::Tradition>s and authenticated users.
  61
  62 =head2 ATTRIBUTES
  63
  64 =head3 id
  65
  66 Inherited from KiokuX::User, stores the 'username' (login) of the user.
  67
  68 =head3 password
  69
  70 User's password, encrypted on creation (by
  71 L<KiokuX::User::Util/crypt_password>.
  72
  73 =head3 active
  74
  75 Active flag, defaults to true (1). Will be set to false (0) by
  76 L<Text::Tradition::UserStore/deactivate_user>.
  77
  78 =head3 traditions
  79
  80 Returns an ArrayRef of L<Text::Tradition> objects belonging to this user.
  81
  82 =head2 METHODS
  83
  84 =head3 check_password
  85
  86 Inherited from KiokuX::User, verifies a given password string against
  87 the stored encrypted version.
  88