From 651150cddb47722a588a54eb8b2307f2042e630e Mon Sep 17 00:00:00 2001
From: franck cuny <franck@lumberjaph.net>
Date: Mon, 7 Jun 2010 11:21:27 +0200
Subject: update POD

---
 lib/Net/Backtweet.pm | 45 ++++++++++++++++++++++++++++++++++++++--
 lib/Net/Backtype.pm  | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 101 insertions(+), 2 deletions(-)

(limited to 'lib')

diff --git a/lib/Net/Backtweet.pm b/lib/Net/Backtweet.pm
index b9e3c49..474cdc2 100644
--- a/lib/Net/Backtweet.pm
+++ b/lib/Net/Backtweet.pm
@@ -17,7 +17,7 @@ net_api_method tweets_by_url => (
       'Retrieve tweets that link to a given URL, whether the links are shortened or unshortened.',
     path     => '/tweets/search/links',
     method   => 'GET',
-    params   => [qw/q key/],
+    params   => [qw/q key itemsperpage start end/],
     required => [qw/q key/],
     expected => [qw/200/],
 );
@@ -42,13 +42,18 @@ net_api_method good_tweets_by_url => (
     expected => [qw/200/],
 );
 
+# back compatibility
+sub backtweet_search {
+    (shift)->tweets_by_url(@_);
+}
+
 1;
 
 =head1 SYNOPSIS
 
   use Net::Backtweet;
   my $client = Net::Backtweet->new();
-  my $res = $client->backtweet_search(q => 'http://lumberjaph.net/', key => $mykey);
+  my $res = $client->tweets_by_url(q => 'lumberjaph', key => 's3kr3t');
 
 =head1 DESCRIPTION
 
@@ -62,18 +67,54 @@ Net::Backtype is a client for the backtweet API.
 
 Retrieve the number of tweets that link to a particular URL.
 
+    my $tweets = $client->tweets_by_url(q => 'lumberjaph', key => 's3kr3t');
+
+=over 2
+
+=item B<q> query (required)
+
+=item B<key> API key (required)
+
+=item B<itemsperpage> number of items per page (optional)
+
+=item B<start> date start (optional)
+
+=item B<end> date end (optional)
+
+=back
+
 See L<http://www.backtype.com/developers/tweets-by-url>.
 
 =item B<stats_by_url>
 
 Retrieve the number of tweets that link to a particular URL.
 
+    my $stats = $client->stats_by_url(q => 'lumberjaph', key => 's3kr3t');
+
+=over 2
+
+=item B<q> query (required)
+
+=item B<key> API key (required)
+
+=back
+
 See L<http://www.backtype.com/developers/tweet-count>.
 
 =item B<good_tweets_by_url>
 
 Retrieve filtered tweets that link to a given URL with both shortened and unshortened links. This returns a subset of Tweets by URL.
 
+    my $good = $client->good_tweets_by_url(q => 'lumberjaph', key => 's3kr3t');
+
+=over 2
+
+=item B<q> query (required)
+
+=item B<key> API key (required)
+
+=back
+
 See L<http://www.backtype.com/developers/good-tweets>.
 
 =back
diff --git a/lib/Net/Backtype.pm b/lib/Net/Backtype.pm
index 235f1ee..6f28877 100644
--- a/lib/Net/Backtype.pm
+++ b/lib/Net/Backtype.pm
@@ -90,30 +90,88 @@ Net::Backtype is a client for the backtype API
 
 Search all the comments on BackType for a given string.
 
+    my $res = $client->comments_page(key => 's3kr3t', q => 'lumberjaph' );
+
+=over 2
+
+=item B<q> query (required)
+
+=item B<key> API key (required)
+
+=item B<start> date start (optional)
+
+=item B<end> date end (optional)
+
+=back
+
 See L<http://www.backtype.com/developers/comments-search>.
 
 =item B<comments_connect>
 
 Retrieve all conversations related to a given URL.
 
+    my $res = $client->comments_connect(key => 's3kr3t', url => 'lumberjaph');
+
+=over 2
+
+=item B<url> url (required)
+
+=item B<key> API key (required)
+
+=item B<sources> (optional)
+
+=item B<sort> (optional)
+
+=back
+
 See L<http://www.backtype.com/developers/comments-connect>.
 
 =item B<comments_connect_stats>
 
 Retrieve statistics on the conversations related to a given URL.
 
+    my $res = $client->comments_connect_stats(url => 'lumberjaph', key => 's3kr3t');
+
+=over 2
+
+=item B<url> url (required)
+
+=item B<key> API key (required)
+
+=back
+
 See L<http://www.backtype.com/developers/comments-connect-stats>.
 
 =item B<comments_author>
 
 Retrieve comments written by a particular author.
 
+    my $res = $client->comments_author(url => 'lumberjaph', key => 's3kr3t');
+
+=over 2
+
+=item B<url> url (required)
+
+=item B<key> API key (required)
+
+=back
+
 See L<http://www.backtype.com/developers/url-comments>.
 
 =item B<comments_page>
 
 Retrieve excerpts of comments published on a particular page.
 
+    my $res = $client->comments_page_stats(url => 'lumberjaph', key => 's3kr3t');
+
+=over 2
+
+=item B<url> url (required)
+
+=item B<key> API key (required)
+
+=back
+
 See L<http://www.backtype.com/developers/page-comments>.
 
 =item B<comments_page_stats>
-- 
cgit v1.2.3