File Coverage

blib/lib/App/Maisha/Plugin/Base.pm
Criterion Covered Total %
statement 24 25 96.0
branch n/a
condition n/a
subroutine 17 18 94.4
pod 16 16 100.0
total 57 59 96.6


line stmt bran cond sub pod time code
1             package App::Maisha::Plugin::Base;
2              
3 9     9   53688 use strict;
  9         23  
  9         339  
4 9     9   49 use warnings;
  9         18  
  9         2657  
5              
6             our $VERSION = '0.21';
7              
8             #----------------------------------------------------------------------------
9             # Public API
10              
11             sub new {
12 5     5 1 3480 my $class = shift;
13 5         23 my $self = {
14             source => 'maisha',
15             useragent => 'Maisha/0.18 (Perl)',
16             clientname => 'Maisha',
17             clientver => '0.18',
18             clienturl => 'http://maisha.grango.org'
19             };
20              
21 5         14 bless $self, $class;
22 5         19 return $self;
23             }
24              
25 2     2 1 6 sub login { return 0 }
26              
27 1     1 1 827 sub api_update {}
28 1     1 1 922 sub api_friends {}
29 1     1 1 906 sub api_user {}
30 1     1 1 889 sub api_user_timeline {}
31 1     1 1 898 sub api_friends_timeline {}
32 1     1 1 813 sub api_public_timeline {}
33 1     1 1 1679 sub api_followers {}
34              
35 1     1 1 820 sub api_replies {}
36 1     1 1 835 sub api_send_message {}
37 1     1 1 863 sub api_direct_messages_to {}
38 1     1 1 794 sub api_direct_messages_from {}
39              
40 1     1 1 893 sub api_follow {}
41 1     1 1 815 sub api_unfollow {}
42              
43 0     0 1   sub api_search {}
44              
45             1;
46              
47             __END__
48              
49             =head1 NAME
50              
51             App::Maisha::Plugin::Base - Maisha interface base module
52              
53             =head1 DESCRIPTION
54              
55             This module is used as a base for services. Where services do not provide
56             functionality, they will use the methods provided here.
57              
58             =head1 METHODS
59              
60             =head2 Constructor
61              
62             =over 4
63              
64             =item * new
65              
66             =back
67              
68             =head2 Process Methods
69              
70             =over 4
71              
72             =item * login
73              
74             Login to the service.
75              
76             =back
77              
78             =head2 API Methods
79              
80             The API methods are used to interface to with the Twitter API.
81              
82             =over 4
83              
84             =item * api_follow
85              
86             =item * api_unfollow
87              
88             =item * api_user
89              
90             =item * api_user_timeline
91              
92             =item * api_friends
93              
94             =item * api_friends_timeline
95              
96             =item * api_public_timeline
97              
98             =item * api_followers
99              
100             =item * api_update
101              
102             =item * api_replies
103              
104             =item * api_send_message
105              
106             =item * api_direct_messages_to
107              
108             =item * api_direct_messages_from
109              
110             =item * api_search
111              
112             =back
113              
114             =head1 SEE ALSO
115              
116             For further information regarding the commands and configuration, please see
117             the 'maisha' script included with this distribution.
118              
119             L<App::Maisha>
120              
121             =head1 WEBSITES
122              
123             =over 4
124              
125             =item * Main Site: L<http://maisha.grango.org>
126              
127             =item * Git Repo: L<http://github.com/barbie/maisha/tree/master>
128              
129             =item * RT Queue: L<RT: http://rt.cpan.org/Public/Dist/Display.html?Name=App-Maisha>
130              
131             =back
132              
133             =head1 AUTHOR
134              
135             Barbie, <barbie@cpan.org>
136             for Miss Barbell Productions <http://www.missbarbell.co.uk>.
137              
138             =head1 COPYRIGHT AND LICENSE
139              
140             Copyright (C) 2009-2014 by Barbie
141              
142             This distribution is free software; you can redistribute it and/or
143             modify it under the Artistic License v2.
144              
145             =cut