File Coverage

lib/Web/Authenticate/User/Storage/Handler/Role.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1 1     1   335 use strict;
  1         1  
  1         39  
2             package Web::Authenticate::User::Storage::Handler::Role;
3             $Web::Authenticate::User::Storage::Handler::Role::VERSION = '0.002';
4 1     1   3 use Mouse::Role;
  1         1  
  1         4  
5             #ABSTRACT: A Mouse::Role that defines what methods a Web::Authenticate::User::Storage::Handler object should contain.
6              
7              
8             requires 'load_user';
9              
10              
11             requires 'load_user_by_id';
12              
13              
14             requires 'store_user';
15              
16             1;
17              
18             __END__
19              
20             =pod
21              
22             =encoding UTF-8
23              
24             =head1 NAME
25              
26             Web::Authenticate::User::Storage::Handler::Role - A Mouse::Role that defines what methods a Web::Authenticate::User::Storage::Handler object should contain.
27              
28             =head1 VERSION
29              
30             version 0.002
31              
32             =head1 METHODS
33              
34             =head2 load_user
35              
36             Accepts the parameters passed to L<Web::Authenticate/"login"> and validates the login and returns the user matching the passed data.
37             Returns a L<Web::Authenticate::User> upon success, undef otherwise.
38              
39             =head2 load_user_by_id
40              
41             Loads a user by their id.
42              
43             =head2 store_user
44              
45             Accepts the parameters passed to L<Web::Authenticate/"login"> and creates a user with those credentials.
46             Returns a L<Web::Authenticate::User> upon success, undef otherwise.
47              
48             =head1 AUTHOR
49              
50             Adam Hopkins <srchulo@cpan.org>
51              
52             =head1 COPYRIGHT AND LICENSE
53              
54             This software is copyright (c) 2017 by Adam Hopkins.
55              
56             This is free software; you can redistribute it and/or modify it under
57             the same terms as the Perl 5 programming language system itself.
58              
59             =cut