Changeset 4255 for lang/perl/WWW-HatenaDiary

Timestamp:

01/09/08 10:49:21 (5 years ago)

Author:

kentaro

Message:

lang/perl/WWW-Hatena: wrote a POD, added prereq modules into Makefile.PL

Location:

lang/perl/WWW-HatenaDiary/trunk

Files:

• Makefile.PL (modified) (1 diff)
• README (modified) (2 diffs)
• lib/WWW/HatenaDiary.pm (modified) (6 diffs)

lang/perl/WWW-HatenaDiary/trunk/Makefile.PL

@@ -10 +10 @@
     Getopt::Long
     Digest::MD5
+    Text::Hatena
+    Web::Scraper
+    WWW::Mechanize
+    JSON::Syck
 /);
 

lang/perl/WWW-HatenaDiary/trunk/README

@@ -3 +3 @@
 INSTALLATION
 
-WWW::HatenaDiary installation is straightforward. If your CPAN shell is set up,
-you should just be able to do
+WWW::HatenaDiary installation is straightforward. If your CPAN shell
+is set up, you should just be able to do
 
     % cpan WWW::HatenaDiary
@@ -25 +25 @@
 to read the documentation online with your favorite pager.
 
+AUTHOR
+
 Tokuhiro Matsuno
+Kentaro Kuribayashi

lang/perl/WWW-HatenaDiary/trunk/lib/WWW/HatenaDiary.pm

@@ -76 +76 @@
 
     my $entry = Load($self->{mech}->content);
-
     if($args->{format}) {
         $entry->{body} = Text::Hatena->parse($entry->{body});
     }
-
     $entry;
 }
@@ -97 +95 @@
         carp "Invalid ymd format: $args->{date}. YYYY-MM-DD formatted date is required.";
     }
-}
-
-# TODO: implement retrieve_month method.
-sub retrieve_month {
-    my ($self, $args) = @_;
-    die "Not implemented yet";
 }
 
@@ -190 +182 @@
 =head1 NAME
 
-WWW::HatenaDiary -
+WWW::HatenaDiary - CRUD interface to Hatena::Diary
 
 =head1 SYNOPSIS
@@ -196 +188 @@
   use WWW::HatenaDiary;
 
-  my $hatena = WWW::HatenaDiary->new({
+  my $diary = WWW::HatenaDiary->new({
       login_id => $login_id,
       login_pw => $login_pw,
@@ -202 +194 @@
 
   # Create
-  my $uri = $hatena->create({
-      title => 'mixi',
-      body  => 'boofy',
+  my $edit_uri = $diary->create({
+      title => $title,
+      body  => $body,
+  });
+
+  # Retrieve
+  my $post = $diary->retrieve({
+      uri => $edit_uri,
+  })
+
+  my $day_body = $diary->retrieve_day({
+      date => $date,     # $date must be YYYY-MM-DD formatted string
   });
 
   # Update
-  $uri = $hatena->update({
-      uri   => $uri,
-      title => 'Update: mixi',
-      body  => "Update: boofy",
-  });
-
-  $hatena->update_day({date => '2008-01-01', body => <<'EOS'});
-* title 1
-body 1
-
-* title 2
-body 2
-EOS
-
-  # Retrieve
-  my $body = $hatena->retrieve($uri)
-  my $day_body = $hatena->retrieve_day({date => '2008-01-01'});
+  $edit_uri = $diary->update({
+      uri   => $edit_uri,
+      title => $new_title,
+      body  => $new_body,
+  });
+
+  $diary->update_day({
+      date => $date,     # $date must be YYYY-MM-DD formatted string
+      body => $new_body,
+  });
 
   # Delete
-  $hatena->delete($uri);                # not implemented yet
-  $hatena->delete_day({date => $date});
+  $diary->delete({       # not implemented yet
+      uri => $edit_uri,
+  });
+
+  $diary->delete_day({,
+      date => $date,     # $date must be YYYY-MM-DD formatted string
+  });
 
 =head1 DESCRIPTION
 
-WWW::HatenaDiary is
-
-=head1 THANKS
-
-typester++ some codes copied from Fuse::Hatena.
+WWW::HatenaDiary provides a CRUD interface to Hatena::Diary, aiming to
+help you efficiently communicate with the service with programatical
+ways.
+
+This module is, so far, for those who want to write some tools not
+only to retrieve data from diaries, but also to create/update/delete
+the posts at the same time. Which is why I adopted the way as if this
+module treats such API like AtomPP, and this module retrieves and
+returns raw formatted post content not a data already converted to
+HTML.
+
+=head1 METHODS
+
+=head2 new ( I<\%args> )
+
+=over 4
+
+  my $diary = WWW::HatenaDiary->new({
+      login_id => $login_id,
+      login_pw => $login_pw,
+  });
+
+Creates and returns a new WWW::HatenaDiary object. Both C<login_id>
+and C<login_pw> are required.
+
+=back
+
+=head2 create ( I<\%args> )
+
+=over 4
+
+  my $edit_uri = $diary->create({
+      title => $title,
+      body  => $body,
+  });
+
+Creates a new post and returns a URI as a L<URI> object for you to
+retrieve/update/delete the post later on.
+
+=back
+
+=head2 retrieve ( I<\%args> )
+
+=over 4
+
+  my $post = $diary->retrieve({
+      uri => $edit_uri,
+  })
+
+Retrieves the post for C<uri>. The return value C<$post> is a
+reference to a hash which contains the fields as follows:
+
+=item title
+
+Title of the post.
+
+=item body
+
+Content of the post as a raw formatted data.
+
+=item editable
+
+Flag if you're authorized to edit the post or not.
+
+=item rkm
+
+Token which is internally used when this module sends a request. You
+needn't care about it.
+
+=back
+
+=head2 retrieve_day ( I<\%args> )
+
+=over 4
+
+  my $day_body = $diary->retrieve_day({
+      date => $date, # $date must be YYYY-MM-DD formatted string
+  });
+
+Retrieves the post body for C<date>. So far, this method gets only the
+raw formatted content of the post.
+
+=back
+
+=head2 update ( I<\%args> )
+
+=over 4
+
+  $edit_uri = $diary->update({
+      uri   => $edit_uri,
+      title => $new_title,
+      body  => $new_body,
+  });
+
+Updates the post for C<uri> and returns the URI as a L<URI> object for
+you to do with the post still more.
+
+=back
+
+=head2 update_day ( I<\%args> )
+
+=over 4
+
+  $diary->update_day({
+      date => $date,     # $date must be YYYY-MM-DD formatted string
+      body => $new_body,
+  });
+
+Updates the whole posts of the C<date>. C<body> must be a
+Hatena::Diary style formatted data, that is, this method emulates the
+way when you write a post on your browser and send it via the form.
+
+=back
+
+=head2 delete ( I<\%args> ) **NOT IMPLEMENTED YET**
+
+=over 4
+
+  $diary->delete({
+      uri => $edit_uri,
+  });
+
+Deletes the post for C<uri>.
+
+=back
+
+=head2 delete_day ( I<\%args> )
+
+=over 4
+
+  $diary->delete_day({
+      date => $date, # $date must be YYYY-MM-DD formatted string
+  });
+
+Deletes the whole posts of the C<date>.
+
+=back
+
+=head1 SEE ALSO
+
+=over 4
+
+=item * Hatena::Diary (Japanese)
+
+L<http://d.hatena.ne.jp/>
+
+=back
+
+=head1 ACKNOWLEDGMENT
+
+typester++ for some codes copied from Fuse::Hatena.
 
 =head1 AUTHOR
@@ -243 +388 @@
 
 Kentaro Kuribayashi E<lt>kentarok aaaatttt gmail dotottto commmmmE<gt>
-
-=head1 SEE ALSO
 
 =head1 LICENSE