File Coverage

blib/lib/Mastodon/Entity/Instance.pm
Criterion Covered Total %
statement 15 15 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod n/a
total 20 20 100.0


line stmt bran cond sub pod time code
1             package Mastodon::Entity::Instance;
2              
3 7     7   8259 use strict;
  7         18  
  7         257  
4 7     7   61 use warnings;
  7         24  
  7         342  
5              
6             our $VERSION = '0.017';
7              
8 7     7   72 use Moo;
  7         21  
  7         90  
9             with 'Mastodon::Role::Entity';
10              
11 7     7   3355 use Types::Standard qw( Str );
  7         34  
  7         156  
12 7     7   7548 use Mastodon::Types qw( URI );
  7         23  
  7         96  
13              
14             has email => ( is => 'ro', isa => Str, );
15             has description => ( is => 'ro', isa => Str, );
16             has title => ( is => 'ro', isa => Str, );
17             has uri => ( is => 'ro', isa => URI, coerce => 1, required => 1, );
18              
19             1;
20              
21             =encoding utf8
22              
23             =head1 NAME
24              
25             Mastodon::Entity::Instance - A Mastodon instance
26              
27             =head1 DESCRIPTION
28              
29             This object should not be manually created. It is intended to be generated
30             from the data received from a Mastodon server using the coercions in
31             L<Mastodon::Types>.
32              
33             For current information, see the
34             L<Mastodon API documentation|https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#instance>
35              
36             =head1 ATTRIBUTES
37              
38             =over 4
39              
40             =item B<uri>
41              
42             URI of the current instance.
43              
44             =item B<title>
45              
46             The instance's title.
47              
48             =item B<description>
49              
50             A description for the instance.
51              
52             =item B<email>
53              
54             An email address which can be used to contact the instance administrator.
55              
56             =back
57              
58             =head1 AUTHOR
59              
60             =over 4
61              
62             =item *
63              
64             José Joaquín Atria <jjatria@cpan.org>
65              
66             =back
67              
68             =head1 COPYRIGHT AND LICENSE
69              
70             This software is copyright (c) 2017 by José Joaquín Atria.
71              
72             This is free software; you can redistribute it and/or modify it under
73             the same terms as the Perl 5 programming language system itself.
74              
75             =cut