File Coverage

blib/lib/WWW/NOS/Open/Video.pm
Criterion Covered Total %
statement 20 20 100.0
branch n/a
condition n/a
subroutine 7 7 100.0
pod n/a
total 27 27 100.0


line stmt bran cond sub pod time code
1             # -*- cperl; cperl-indent-level: 4 -*-
2             # Copyright (C) 2011-2021, Roland van Ipenburg
3             package WWW::NOS::Open::Video v1.0.5;
4 4     4   50 use strict;
  4         8  
  4         118  
5 4     4   22 use warnings;
  4         9  
  4         115  
6              
7 4     4   18 use utf8;
  4         6  
  4         27  
8 4     4   127 use 5.014000;
  4         12  
9              
10 4     4   18 use Moose qw/extends/;
  4         7  
  4         36  
11 4     4   18383 use namespace::autoclean '-also' => qr/^__/sxm;
  4         9  
  4         42  
12              
13             extends 'WWW::NOS::Open::MediaResource';
14              
15 4     4   340 no Moose;
  4         7  
  4         17  
16              
17             __PACKAGE__->meta->make_immutable;
18              
19             1;
20              
21             __END__
22              
23             =encoding utf8
24              
25             =for stopwords Bitbucket DateTime URI perl Ipenburg MERCHANTABILITY
26              
27             =head1 NAME
28              
29             WWW::NOS::Open::Video - client side video in the Open NOS REST API.
30              
31             =head1 VERSION
32              
33             This document describes WWW::NOS::Open::Video version C<v1.0.5>.
34              
35             =head1 SYNOPSIS
36              
37             use WWW::NOS::Open::Video;
38              
39             =head1 DESCRIPTION
40              
41             This class represents a video as returned in the latest ten videos list.
42              
43             =head1 SUBROUTINES/METHODS
44              
45             =head2 C<new>
46              
47             Create a new video object.
48              
49             =over
50              
51             =item 1. A hash containing the properties and their values.
52              
53             =back
54              
55             =head2 C<get_id>
56              
57             Returns the id of the video as integer.
58              
59             =head2 C<get_title>
60              
61             Returns the title of the video as string.
62              
63             =head2 C<get_description>
64              
65             Returns the description of the video as string.
66              
67             =head2 C<get_published>
68              
69             Returns the publishing date of the video as a L<DateTime|DateTime> object.
70              
71             =head2 C<get_last_update>
72              
73             Returns the date of the last update for the video as a L<DateTime|DateTime>
74             object.
75              
76             =head2 C<get_thumbnail_xs>
77              
78             Returns the URL of the extra small thumbnail for the video as an L<URI|URI>
79             object.
80              
81             =head2 C<get_thumbnail_s>
82              
83             Returns the URL of the small thumbnail for the video as an L<URI|URI> object.
84              
85             =head2 C<get_thumbnail_m>
86              
87             Returns the URL of the medium sized thumbnail for the video as an L<URI|URI>
88             object.
89              
90             =head2 C<get_link>
91              
92             Returns the URL of the video as an L<URI|URI> object.
93              
94             =head2 C<get_embed_code>
95              
96             Return the HTML code to embed the video in an HTML page.
97              
98             =head2 C<get_keywords>
99              
100             Returns the list of keywords for the video as a reference to an array of
101             strings.
102              
103             =head1 CONFIGURATION AND ENVIRONMENT
104              
105             =head1 DEPENDENCIES
106              
107             =over 4
108              
109             =item * perl 5.14
110              
111             =item * L<Moose|Moose>
112              
113             =item * L<WWW::NOS::Open::MediaResource|WWW::NOS::Open::MediaResource>
114              
115             =item * L<namespace::autoclean|namespace::autoclean>
116              
117             =back
118              
119             =head1 INCOMPATIBILITIES
120              
121             =head1 DIAGNOSTICS
122              
123             =head1 BUGS AND LIMITATIONS
124              
125             Please report any bugs or feature requests at
126             L<Bitbucket|https://bitbucket.org/rolandvanipenburg/www-nos-open/issues>.
127              
128             =head1 AUTHOR
129              
130             Roland van Ipenburg, E<lt>roland@rolandvanipenburg.comE<gt>
131              
132             =head1 LICENSE AND COPYRIGHT
133              
134             Copyright 2011-2021 by Roland van Ipenburg
135              
136             This library is free software; you can redistribute it and/or modify
137             it under the same terms as Perl itself, either Perl version 5.14.0 or,
138             at your option, any later version of Perl 5 you may have available.
139              
140             =head1 DISCLAIMER OF WARRANTY
141              
142             BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
143             FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
144             OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
145             PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
146             EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
147             WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
148             ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
149             YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
150             NECESSARY SERVICING, REPAIR, OR CORRECTION.
151              
152             IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
153             WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
154             REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
155             LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
156             OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
157             THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
158             RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
159             FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
160             SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
161             SUCH DAMAGES.
162              
163             =cut