Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 183 lines (118 sloc) 4.581 kb
741ecd8 Sawyer X removing boilerplate README
authored
1 NAME
c3578df Sawyer X updating files for 0.06 release
authored
2 WWW::FMyLife - Obtain FMyLife.com anecdotes via API
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
3
741ecd8 Sawyer X removing boilerplate README
authored
4 VERSION
0621df4 Sawyer X releasing 0.15
authored
5 Version 0.15
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
6
741ecd8 Sawyer X removing boilerplate README
authored
7 SYNOPSIS
5ccd283 Sawyer X refreshing readme file
authored
8 THIS MODULE IS STILL UNDER INITIAL DEVELOPMENT! BE WARNED!
9
741ecd8 Sawyer X removing boilerplate README
authored
10 use WWW::FMyLife;
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
11
cbfb6ef Sawyer X updating files for release
authored
12 my $fml = WWW::FMyLife->new();
13 print map { "Items: $_\n" } $fml->last( { as => text' } );
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
14
0155ebd Sawyer X updating for 0.07 release
authored
15 DESCRIPTION
16 This module fetches FMyLife.com (FML) anecdotes, comments, votes and
17 more via API, comfortably and in an extensible manner.
18
cbfb6ef Sawyer X updating files for release
authored
19 my @items = $fml->top_daily();
741ecd8 Sawyer X removing boilerplate README
authored
20 foreach my $item (@items) {
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
21 my $item_id = $item->id;
22 my $item_content = $item->content;
23 print "[$item_id] $item_content\n";
741ecd8 Sawyer X removing boilerplate README
authored
24 }
5ccd283 Sawyer X refreshing readme file
authored
25
cbfb6ef Sawyer X updating files for release
authored
26 print $fml->random()->text, "\n";
741ecd8 Sawyer X removing boilerplate README
authored
27 ...
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
28
741ecd8 Sawyer X removing boilerplate README
authored
29 EXPORT
30 This module exports nothing.
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
31
0155ebd Sawyer X updating for 0.07 release
authored
32 SUBROUTINES/METHODS
5ccd283 Sawyer X refreshing readme file
authored
33 last()
34 Fetches the last quotes. Can accept a hashref that indicates the
35 formatting:
36
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
37 # returns an array of WWW::FMyLife::Item objects
5ccd283 Sawyer X refreshing readme file
authored
38 $fml->last();
39
e796cc7 Sawyer X updated META.yml and README for 0.03 release
authored
40 # or more explicitly
41 $fml->last( { as => 'object' } ); # same as above
42 $fml->last( { as => 'text' } ); # returns an array of text anecdotes
43 $fml->last( { as => 'data' } ); # returns an array of hashes of anecdotes
5ccd283 Sawyer X refreshing readme file
authored
44
e796cc7 Sawyer X updated META.yml and README for 0.03 release
authored
45 You can also specify which page you want:
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
46
47 # return 1st page
48 my @last = fml->last();
49
50 # return 5th page
51 my @last = $fml->last(5);
52
53 # same
54 my @last = $fml->last( { page => 5 } );
55
56 And options can be mixed:
57
58 my @not_so_last = $fml->last( { as => 'text', page => 50 } );
59
cbfb6ef Sawyer X updating files for release
authored
60 random
61 This method gets a single random quote as an object.
62
63 top
64 This method works the same as the last() method, only it fetches the top
65 quotes.
66
67 This method, as for its variations, can format as an object, text or
68 data.
69
70 top_day
71 This method works the same as the last() method, only it fetches the top
72 quotes.
73
74 This specific variant fetches the top anecdotes from the last day.
75
76 top_week
77 This method works the same as the last() method, only it fetches the top
78 quotes.
79
80 This specific variant fetches the top anecdotes from the last week.
81
82 top_month
83 This method works the same as the last() method, only it fetches the top
84 quotes.
85
86 This specific variant fetches the top anecdotes from the last month.
87
0155ebd Sawyer X updating for 0.07 release
authored
88 flop
89 Fetches the flop quotes.
90
91 This method, as for its variations, can format as an object, text or
92 data.
93
94 flop_day
95 Fetches the flop quotes of the day.
96
97 flop_week
98 Fetches the flop quotes of the week.
99
100 flop_month
101 Fetches the flop quotes of the month.
102
5ccd283 Sawyer X refreshing readme file
authored
103 credentials( $username, $password ) (NOT YET FULLY IMPLEMENTED)
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
104 WARNING: THIS HAS NOT YET BEEN IMPLEMENTED.
105
106 THE TESTS HAVE BEEN DISABLED FOR NOW, PLEASE WAIT FOR A MORE ADVANCED
107 VERSION.
108
741ecd8 Sawyer X removing boilerplate README
authored
109 Sets credentials for members.
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
110
741ecd8 Sawyer X removing boilerplate README
authored
111 $fml->credentials( 'foo', 'bar' );
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
112
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
113 # same thing
741ecd8 Sawyer X removing boilerplate README
authored
114 $fml->username('foo');
115 $fml->password('bar');
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
116
c3578df Sawyer X updating files for 0.06 release
authored
117 AUTHOR
e796cc7 Sawyer X updated META.yml and README for 0.03 release
authored
118 Sawyer X (XSAWYERX), "<xsawyerx at cpan.org>"
119
120 Tamir Lousky (TLOUSKY), "<tlousky at cpan.org>"
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
121
0155ebd Sawyer X updating for 0.07 release
authored
122 DEPENDENCIES
123 Moose
124
125 XML::Simple
126
127 LWP::UserAgent
128
129 BUGS AND LIMITATIONS
741ecd8 Sawyer X removing boilerplate README
authored
130 Please report any bugs or feature requests to "bug-www-fmylife at
131 rt.cpan.org", or through the web interface at
132 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-FMyLife>.
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
133
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
134 You can also use the Issues Tracker on Github @
135 <http://github.com/xsawyerx/www-fmylife/issues>.
136
741ecd8 Sawyer X removing boilerplate README
authored
137 SUPPORT
138 You can find documentation for this module with the perldoc command.
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
139
741ecd8 Sawyer X removing boilerplate README
authored
140 perldoc WWW::FMyLife
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
141
741ecd8 Sawyer X removing boilerplate README
authored
142 You can also look for information at:
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
143
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
144 * Our Github!
145
146 <http://github.com/xsawyerx/www-fmylife/tree/master>
147
741ecd8 Sawyer X removing boilerplate README
authored
148 * RT: CPAN's request tracker
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
149
741ecd8 Sawyer X removing boilerplate README
authored
150 <http://rt.cpan.org/NoAuth/Bugs.html?Dist=WWW-FMyLife>
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
151
741ecd8 Sawyer X removing boilerplate README
authored
152 * AnnoCPAN: Annotated CPAN documentation
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
153
741ecd8 Sawyer X removing boilerplate README
authored
154 <http://annocpan.org/dist/WWW-FMyLife>
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
155
741ecd8 Sawyer X removing boilerplate README
authored
156 * CPAN Ratings
157
158 <http://cpanratings.perl.org/d/WWW-FMyLife>
159
160 * Search CPAN
161
162 <http://search.cpan.org/dist/WWW-FMyLife/>
163
3697775 Sawyer X updating README from POD, removing IO::Prompt from members test
authored
164 * FML (FMyLife)
165
166 <http://www.fmylife.com>
167
e796cc7 Sawyer X updated META.yml and README for 0.03 release
authored
168 SEE ALSO
169 * WWW::VieDeMerde
170
171 Apparently supports more options right now. Mainly for French
172 version but seems to support English as well.
173
0155ebd Sawyer X updating for 0.07 release
authored
174 LICENSE AND COPYRIGHT
dbf68af Sawyer X version 0.13 out
authored
175 Copyright 2010 Sawyer X, Tamir Lousky.
741ecd8 Sawyer X removing boilerplate README
authored
176
177 This program is free software; you can redistribute it and/or modify it
178 under the terms of either: the GNU General Public License as published
179 by the Free Software Foundation; or the Artistic License.
180
181 See http://dev.perl.org/licenses/ for more information.
1215e23 Sawyer X initial commit, still missing EVERYTHING
authored
182
Something went wrong with that request. Please try again.