File Coverage

blib/lib/Yukki/Model/User.pm

Criterion	Covered	Total	%
statement	29	35	82.8
branch	0	2	0.0
condition			n/a
subroutine	10	11	90.9
pod	1	1	100.0
total	40	49	81.6

package Yukki::Model::User;
$Yukki::Model::User::VERSION = '0.991_001'; # TRIAL

$Yukki::Model::User::VERSION = '0.991001';use v5.24;
use utf8;
use Moo;

extends 'Yukki::Model';

use Yukki::Types qw( LoginName );
use Yukki::TextUtil qw( load_file );

use Type::Params qw( validate );
use Type::Utils;
use Types::Path::Tiny;
use Types::Standard qw( slurpy Dict );

use namespace::clean;

# ABSTRACT: lookup users


sub find {
    my ($self, $opt)
        = validate(\@_, class_type(__PACKAGE__), slurpy Dict[login_name => LoginName]);
    my $login_name = $opt->{login_name};

    my $user_file = $self->locate('user_path', $login_name);
    if (-e $user_file) {
        return load_file($user_file);
    }

    return;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Yukki::Model::User - lookup users

=head1 VERSION

version 0.991_001

=head1 SYNOPSIS

  my $users = $app->model('User');
  my $user  = $users->find('bob');

  my $login_name = $user->{login_name};
  my $password   = $user->{password};
  my $name       = $user->{name};
  my $email      = $user->{email};
  my @groups     = @{ $user->{groups} };

=head1 DESCRIPTION

Read access to the current list of authorized users.

=head1 METHODS

=head2 find

  my $user = $users->find(login_name => $login_name);

Returns a hash containing the information related to a specific user named by login name.

=head1 AUTHOR

Andrew Sterling Hanenkamp <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut