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   1797 use parent qw( JIRA::REST::Class::Abstract );
  4         9  
  4         20  
3 4     4   255 use strict;
  4         20  
  4         73  
4 4     4   16 use warnings;
  4         8  
  4         83  
5 4     4   52 use 5.010;
  4         12  
6              
7             our $VERSION = '0.11';
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   18 use Readonly 2.04;
  4         50  
  4         276  
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 Alexandr Alexey Ciornii Melezhik Atlassian GreenHopper JRC
64             ScriptRunner TODO aggregateprogress aggregatetimeestimate
65             aggregatetimeoriginalestimate assigneeType avatar avatarUrls completeDate
66             displayName duedate emailAddress endDate fieldtype fixVersions fromString
67             genericized iconUrl isAssigneeTypeValid issueTypes issuekeys issuelinks
68             issuetype jira jql lastViewed maxResults originalEstimate
69             originalEstimateSeconds parentkey projectId rapidViewId remainingEstimate
70             remainingEstimateSeconds resolutiondate sprintlist startDate
71             subtaskIssueTypes timeSpent timeSpentSeconds timeestimate
72             timeoriginalestimate timespent timetracking toString updateAuthor worklog
73             workratio
74              
75             =head1 NAME
76              
77             JIRA::REST::Class::User - A helper class for L<JIRA::REST::Class|JIRA::REST::Class> that represents a JIRA user as an object.
78              
79             =head1 VERSION
80              
81             version 0.11
82              
83             =head1 READ-ONLY ACCESSORS
84              
85             =head2 B<active>
86              
87             A boolean indicating whether or not the user is active.
88              
89             =head2 B<avatarUrls>
90              
91             A hashref of the different sizes available for the project's avatar.
92              
93             =head2 B<displayName>
94              
95             The display name of the user.
96              
97             =head2 B<emailAddress>
98              
99             The email address of the user.
100              
101             =head2 B<key>
102              
103             The key for the user.
104              
105             =head2 B<name>
106              
107             The short name of the user.
108              
109             =head2 B<self>
110              
111             The URL of the JIRA REST API for the user
112              
113             =head2 B<timeZone>
114              
115             The home time zone of the user.
116              
117             =head1 RELATED CLASSES
118              
119             =over 2
120              
121             =item * L<JIRA::REST::Class|JIRA::REST::Class>
122              
123             =item * L<JIRA::REST::Class::Abstract|JIRA::REST::Class::Abstract>
124              
125             =back
126              
127             =head1 AUTHOR
128              
129             Packy Anderson <packy@cpan.org>
130              
131             =head1 COPYRIGHT AND LICENSE
132              
133             This software is Copyright (c) 2017 by Packy Anderson.
134              
135             This is free software, licensed under:
136              
137             The Artistic License 2.0 (GPL Compatible)
138              
139             =cut