Changeset 9688 for lang/perl/WebService-Simple/branch/lwp-base

Timestamp:

04/18/08 17:09:46 (7 months ago)

Author:

daisuke

Message:

lang/perl/WebService-Simple; docs

Files:

• lang/perl/WebService-Simple/branch/lwp-base/lib/WebService/Simple.pm (modified) (1 diff)

lang/perl/WebService-Simple/branch/lwp-base/lib/WebService/Simple.pm

@@ -157 +157 @@
   my $blob = $resp->parse_response; # Parsed with MyParser
 
+=head1 DESCRIPTION
+
+WebService::Simple is a simple class to interact with web services.
+
+It's basically an LWP::UserAgent that remembers recurring api URLs and
+parameters, plus sugar to parse the results.
+
+=head1 PARSERS
+
+Web services return their results in various different formats. Or perhaps
+you require more sophisticated results parsing than what WebService::Simple
+provides.
+
+WebService::Simple by default uses XML::Simple, but you can easily override
+that by providing a parser object to the constructor:
+
+  my $service = WebService::Simple->new(
+    response_parser => AVeryComplexParser->new,
+    ...
+  );
+  my $response = $service->get( ... );
+  my $thing = $response->parse_response;
+
+This allows great flexibility in handling different webservices
+
+=head1 AUTHOR
+
+Yusuke Wada  C<< <yusuke@kamawada.com> >>
+
+Daisuke Maki C<< <daisuke@endeworks.jp> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (c) 2008 Yusuke Wada, All rights reserved.
+
+This module is free software; you can redistribute it
+and/or modify it under the same terms as Perl itself.
+See L<perlartistic>.
+
 =cut