File Coverage

lib/JIRA/REST/Class/User.pm
Criterion Covered Total %
statement 14 14 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod n/a
total 19 19 100.0


line stmt bran cond sub pod time code
1             package JIRA::REST::Class::User;
2 4     4   1862 use parent qw( JIRA::REST::Class::Abstract );
  4         5  
  4         18  
3 4     4   231 use strict;
  4         8  
  4         63  
4 4     4   10 use warnings;
  4         5  
  4         69  
5 4     4   47 use 5.010;
  4         10  
6              
7             our $VERSION = '0.10';
8             our $SOURCE = 'CPAN';
9             ## $SOURCE = 'GitHub'; # COMMENT
10             # the line above will be commented out by Dist::Zilla
11              
12             # ABSTRACT: A helper class for L<JIRA::REST::Class|JIRA::REST::Class> that represents a JIRA user as an object.
13              
14 4     4   14 use Readonly 2.04;
  4         40  
  4         283  
15              
16             Readonly my @ACCESSORS => qw( active avatarUrls displayName emailAddress key
17             name self timeZone );
18              
19             __PACKAGE__->mk_data_ro_accessors( @ACCESSORS );
20              
21             1;
22              
23             #pod =accessor B<active>
24             #pod
25             #pod A boolean indicating whether or not the user is active.
26             #pod
27             #pod =accessor B<avatarUrls>
28             #pod
29             #pod A hashref of the different sizes available for the project's avatar.
30             #pod
31             #pod =accessor B<displayName>
32             #pod
33             #pod The display name of the user.
34             #pod
35             #pod =accessor B<emailAddress>
36             #pod
37             #pod The email address of the user.
38             #pod
39             #pod =accessor B<key>
40             #pod
41             #pod The key for the user.
42             #pod
43             #pod =accessor B<name>
44             #pod
45             #pod The short name of the user.
46             #pod
47             #pod =accessor B<self>
48             #pod
49             #pod The URL of the JIRA REST API for the user
50             #pod
51             #pod =accessor B<timeZone>
52             #pod
53             #pod The home time zone of the user.
54             #pod
55             #pod =cut
56              
57             __END__
58              
59             =pod
60              
61             =encoding UTF-8
62              
63             =for :stopwords Packy Anderson Alexey Melezhik Atlassian GreenHopper JRC ScriptRunner TODO
64             aggregateprogress aggregatetimeestimate aggregatetimeoriginalestimate
65             assigneeType avatar avatarUrls completeDate displayName duedate
66             emailAddress endDate fieldtype fixVersions fromString genericized iconUrl
67             isAssigneeTypeValid issueTypes issuekeys issuelinks issuetype jira jql
68             lastViewed maxResults originalEstimate originalEstimateSeconds parentkey
69             projectId rapidViewId remainingEstimate remainingEstimateSeconds
70             resolutiondate sprintlist startDate subtaskIssueTypes timeSpent
71             timeSpentSeconds timeestimate timeoriginalestimate timespent timetracking
72             toString updateAuthor worklog workratio
73              
74             =head1 NAME
75              
76             JIRA::REST::Class::User - A helper class for L<JIRA::REST::Class|JIRA::REST::Class> that represents a JIRA user as an object.
77              
78             =head1 VERSION
79              
80             version 0.10
81              
82             =head1 READ-ONLY ACCESSORS
83              
84             =head2 B<active>
85              
86             A boolean indicating whether or not the user is active.
87              
88             =head2 B<avatarUrls>
89              
90             A hashref of the different sizes available for the project's avatar.
91              
92             =head2 B<displayName>
93              
94             The display name of the user.
95              
96             =head2 B<emailAddress>
97              
98             The email address of the user.
99              
100             =head2 B<key>
101              
102             The key for the user.
103              
104             =head2 B<name>
105              
106             The short name of the user.
107              
108             =head2 B<self>
109              
110             The URL of the JIRA REST API for the user
111              
112             =head2 B<timeZone>
113              
114             The home time zone of the user.
115              
116             =head1 RELATED CLASSES
117              
118             =over 2
119              
120             =item * L<JIRA::REST::Class|JIRA::REST::Class>
121              
122             =item * L<JIRA::REST::Class::Abstract|JIRA::REST::Class::Abstract>
123              
124             =back
125              
126             =head1 AUTHOR
127              
128             Packy Anderson <packy@cpan.org>
129              
130             =head1 COPYRIGHT AND LICENSE
131              
132             This software is Copyright (c) 2017 by Packy Anderson.
133              
134             This is free software, licensed under:
135              
136             The Artistic License 2.0 (GPL Compatible)
137              
138             =cut