File Coverage

blib/lib/WebService/Recruit/AbRoad/City.pm

Criterion	Covered	Total	%
statement	20	25	80.0
branch			n/a
condition			n/a
subroutine	10	15	66.6
pod	8	10	80.0
total	38	50	76.0

package WebService::Recruit::AbRoad::City;

use strict;
use base qw( WebService::Recruit::AbRoad::Base );
use vars qw( $VERSION );
use Class::Accessor::Fast;
use Class::Accessor::Children::Fast;

$VERSION = '0.0.1';

sub http_method { 'GET'; }

sub url { 'http://webservice.recruit.co.jp/ab-road/city/v1/'; }

sub query_class { 'WebService::Recruit::AbRoad::City::Query'; }

sub query_fields { [
    'key', 'area', 'country', 'city', 'keyword', 'in_use', 'order', 'start', 'count'
]; }

sub default_param { {
    'format' => 'xml'
}; }

sub notnull_param { [
    'key'
]; }

sub elem_class { 'WebService::Recruit::AbRoad::City::Element'; }

sub root_elem { 'results'; }

sub elem_fields { {
    'area' => ['code', 'name'],
    'city' => ['code', 'name', 'name_en', 'tour_count', 'lat', 'lng', 'area', 'country'],
    'country' => ['code', 'name', 'name_en'],
    'error' => ['message'],
    'results' => ['api_version', 'results_available', 'results_returned', 'results_start', 'city', 'api_version', 'error'],

}; }

sub force_array { [
    'city'
]; }

# __PACKAGE__->mk_query_accessors();

@WebService::Recruit::AbRoad::City::Query::ISA = qw( Class::Accessor::Fast );
WebService::Recruit::AbRoad::City::Query->mk_accessors( @{query_fields()} );

# __PACKAGE__->mk_elem_accessors();

@WebService::Recruit::AbRoad::City::Element::ISA = qw( Class::Accessor::Children::Fast );
WebService::Recruit::AbRoad::City::Element->mk_ro_accessors( root_elem() );
WebService::Recruit::AbRoad::City::Element->mk_child_ro_accessors( %{elem_fields()} );

=head1 NAME

WebService::Recruit::AbRoad::City - AB-ROAD Web Service "city" API

=head1 SYNOPSIS

    use WebService::Recruit::AbRoad;

    my $service = WebService::Recruit::AbRoad->new();

    my $param = {
        'key' => $ENV{'WEBSERVICE_RECRUIT_KEY'},
    };
    my $res = $service->city( %$param );
    my $data = $res->root;
    print "api_version: $data->api_version\n";
    print "results_available: $data->results_available\n";
    print "results_returned: $data->results_returned\n";
    print "results_start: $data->results_start\n";
    print "city: $data->city\n";
    print "...\n";

=head1 DESCRIPTION

This module is a interface for the C API.
It accepts following query parameters to make an request.

    my $param = {
        'key' => 'XXXXXXXX',
        'area' => 'EUR',
        'country' => 'BE',
        'city' => 'NYC',
        'keyword' => 'ベトナム',
        'in_use' => 'XXXXXXXX',
        'order' => 'XXXXXXXX',
        'start' => 'XXXXXXXX',
        'count' => 'XXXXXXXX',
    };
    my $res = $service->city( %$param );

C<$service> above is an instance of L.

=head1 METHODS

=head2 root

This returns the root element of the response.

    my $root = $res->root;

You can retrieve each element by the following accessors.

    $root->api_version
    $root->results_available
    $root->results_returned
    $root->results_start
    $root->city
    $root->city->[0]->code
    $root->city->[0]->name
    $root->city->[0]->name_en
    $root->city->[0]->tour_count
    $root->city->[0]->lat
    $root->city->[0]->lng
    $root->city->[0]->area
    $root->city->[0]->country
    $root->city->[0]->area->code
    $root->city->[0]->area->name
    $root->city->[0]->country->code
    $root->city->[0]->country->name
    $root->city->[0]->country->name_en


=head2 xml

This returns the raw response context itself.

    print $res->xml, "\n";

=head2 code

This returns the response status code.

    my $code = $res->code; # usually "200" when succeeded

=head2 is_error

This returns true value when the response has an error.

    die 'error!' if $res->is_error;

=head1 SEE ALSO

L

=head1 AUTHOR

RECRUIT Media Technology Labs

=head1 COPYRIGHT

Copyright 2008 RECRUIT Media Technology Labs

=cut
1;