File Coverage

blib/lib/Net/Twitter/Role/API/TwitterVision.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             package Net::Twitter::Role::API::TwitterVision;
2             $Net::Twitter::Role::API::TwitterVision::VERSION = '4.01043';
3 10     10   4547 use Moose::Role;
  10         25  
  10         54  
4              
5             requires qw/credentials/;
6              
7 10     10   43856 use Net::Twitter::API;
  10         25  
  10         55  
8              
9             has tvurl => ( isa => 'Str', is => 'ro', default => 'http://twittervision.com' );
10             has tvhost => ( isa => 'Str', is => 'ro', default => 'twittervision.com:80' );
11             has tvrealm => ( isa => 'Str', is => 'ro', default => 'Web Password' );
12              
13             requires qw/ua username password/;
14              
15             base_url     'tvurl';
16             authenticate 1;
17              
18             twitter_api_method current_status => (
19                 description => <<'',
20             Get the current location and status of a user.
21            
22                 path => 'user/current_status/id',
23                 method => 'GET',
24                 params => [qw/id callback/],
25                 required => [qw/id/],
26                 returns => 'HashRef',
27             );
28              
29             twitter_api_method update_twittervision => (
30                 description => <<'',
31             Updates the location for the authenticated user.
32            
33                 path => 'user/update_location',
34                 method => 'POST',
35                 params => [qw/location/],
36                 required => [qw/location/],
37                 returns => 'HashRef',
38             );
39              
40             1;
41              
42             __END__
43            
44             =head1 NAME
45            
46             Net::Twitter::Role::API::TwitterVision - A definition of the TwitterVision API as a Moose role
47            
48             =head1 VERSION
49            
50             version 4.01043
51            
52             =head1 SYNOPSIS
53            
54             package My::Twitter;
55             use Moose;
56             with 'Net::Twitter::API::TwitterVision';
57            
58             =head1 DEPRECATION NOTICE
59            
60             The public link to the TwitterVision API is no longer accessible, and my
61             inquires to TwitterVision have gone unanswered. I don't know if the service
62             still supports the API. So, use this role at your own risk.
63            
64             =head1 DESCRIPTION
65            
66             B<Net::Twitter::Role::API::TwitterVision> provides definitions for all the TwitterVision API
67             methods. Applying this role to any class provides methods for all of the
68             TwitterVision API methods.
69            
70             =head1 METHODS
71            
72             =over 4
73            
74             =item new
75            
76             Adds the following options to L<Net::Twitter/new>:
77            
78             =over 4
79            
80             =item tvurl
81            
82             A string containing the base URL for the TwitterVision API. Defaults to "http://twittervision.com".
83            
84             =item tvhost
85            
86             A string containing the TwitterVision API host. Defaults to "twittervision.com:80".
87            
88             =item tvrealm
89            
90             A string containing the TwitterVision Basic Authentication Realm name. Defaults to "Web Password".
91            
92             =back
93            
94             =back
95            
96             =head1 AUTHOR
97            
98             Marc Mims <marc@questright.com>
99            
100             =head1 LICENSE
101            
102             Copyright (c) 2016 Marc Mims
103            
104             The Twitter API itself, and the description text used in this module is:
105            
106             Copyright (c) 2009 Twitter
107            
108             This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
109            
110             =head1 DISCLAIMER OF WARRANTY
111            
112             BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
113             FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
114             OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
115             PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
116             EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
117             WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
118             ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
119             YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
120             NECESSARY SERVICING, REPAIR, OR CORRECTION.
121            
122             IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
123             WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
124             REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
125             LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
126             OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
127             THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
128             RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
129             FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
130             SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
131             SUCH DAMAGES.
132