Masanori Ohgita > WebService-Zusaar > WebService::Zusaar

Download:
WebService-Zusaar-v0.0.4.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: v0.0.4   Source  

NAME ^

WebService::Zusaar - The Zusaar API wrapper module for perl

SYNOPSIS ^

  use WebService::Zusaar;
  
  my $zusaar = WebService::Zusaar->new( encoding => 'utf8' );
  
  # Request event
  $zusaar->fetch( 'event', keyword => 'Kansai.pm' );
  
  # Print each events title
  while ( my $event = $zusaar->next ){
        print $event->title . "(id:". $event->event_id .")\n";
  }

  # Request event/user
  $zusaar->fetch( 'event/user', event_id => '476003' );

  while ( my $event = $zusaar->next ){
    # Print each users of event
    foreach my $user( @{$event->users} ){
        print $user->nickname . "\n";
    }
  }

INSTALLATION (from GitHub) ^

  $ git clone git://github.com/mugifly/p5-WebService-Zusaar.git
  $ cpanm ./p5-WebService-Zusaar

METHODS ^

new ( [%params] )

Create an instance of WebService::Zusaar.

%params = (optional) LWP::UserAgent options, and encoding (example: encoding => 'utf8').

fetch ( $api_path [, %params] )

Send request to Zusaar API. Also, this method has supported a fetch like 'Auto-Pager'.

About the query, please see: http://www.zusaar.com/doc/api.html

About the fetch like 'AutoPager'

You can fetch all search results, by such as this code:

  # Request event
  $zusaar->fetch( 'event' );
  
  # Print each events title
  while ( my $event = $zusaar->next ){
        print $event->title . "\n";
  }

In the case of default, you can fetch max 10 items by single request to Zusaar API. However, this module is able to fetch all results by repeat request, automatically.

Also, you can disable this function, by specifying an option(disable_nextpage_fetch => 1) when call a constructor:

  my $zusaar = WebService::Zusaar->new(disable_nextpage_fetch => 1);

  # Request event
  $zusaar->fetch( 'event' );
  
  # Print each events title
  while ( my $event = $zusaar->next ){
        print $event->title . "\n";
  }

In this case, you can fetch max 10 items.

But also, you can fetch more items by causing a 'fetch' method again with 'start' parameter:

  # Request the event of the remaining again
  $zusaar->fetch( 'event', start => 10 ); # Fetch continue after 10th items.

next

Get a next item, from the fetched items in instance.

The item that you got is an object.

You can use the getter-methods (same as a API response fields name, such as: 'title', 'event_id', 'catch', etc...)

 my $event = $zusaar->next; # Get a next one item
 print $event->title . "\n"; # Output a 'title' (included in this item)

In addition, you can also use a following getter-methods : 'started', 'ended', 'updated'.

So, these methods return the each object as the 'DateTime::Format::ISO8601', from 'started_at', 'ended_at' and 'updated_at' field.

prev

Get a previous item, from the fetched items in instance.

iter

set or get a position of iterator.

SEE ALSO ^

https://github.com/mugifly/p5-WebService-Zusaar/ - Your feedback is highly appreciated.

DateTime::Format::ISO8601

Hash::AsObject

LWP::UserAgent

WebService::ATND - https://github.com/ytnobody/WebService-ATND/ (Maybe you can use this library with an almost similar code.)

COPYRIGHT AND LICENSE ^

Copyright (C) 2013, Masanori Ohgita (http://ohgita.info/).

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

I wrote this library with referred to the library that was written by ytnobody. Thank you.

Thanks, Perl Mongers & CPAN authors.

syntax highlighting: