File Coverage

blib/lib/WebService/30Boxes/API/Response.pm

Criterion	Covered	Total	%
statement	9	28	32.1
branch	0	2	0.0
condition			n/a
subroutine	3	7	42.8
pod	2	4	50.0
total	14	41	34.1

package WebService::30Boxes::API::Response;

use strict;
use warnings;
use HTTP::Response;

our @ISA = qw(HTTP::Response);
our $VERSION = '1.05';

sub new {
   my ($class, $args) = @_;
   my $self = new HTTP::Response;
      $self->{'error_code'} = undef;
      $self->{'error_msg'}  = undef;
      $self->{'success'}    = undef;
      $self->{'_xml'}       = undef;
   bless $self, $class;
   return $self;
}

sub set_error {
   my ($self, $code, $msg) = @_;
   $self->{'success'}  = 0;
   $self->{'error_code'} = $code;
   $self->{'error_msg'}  = $msg;
}

sub set_success {
   my ($self) = @_;
   $self->{'success'}    = 1;
   $self->{'error_code'} = undef;
   $self->{'error_msg'}  = undef;
}

sub reply {
   my ($self, $xml) = @_;
   $self->{'_xml'} = $xml if($xml);
   return $self->{'_xml'};
}

1;
#################### main pod documentation begin ###################

=head1 NAME

WebService::30Boxes::API::Response - Response from 30Boxes REST API

=head1 SYNOPSIS

  use WebService::30Boxes::API;

  # You always have to provide your api_key
  my $boxes  = WebService::30Boxes::API->(api_key => 'your_api_key');

  # Then you might want to lookup a user and print some info
  my $result = $boxes->call('user.FindById', { id => 47 });
  if($result->{'success'}) {
     my $user   = $result->reply->{'user'};

     print $user->{'firstName'}, " ",
           $user->{'lastName'}, " joined 30Boxes at ",
           $user->{'createDate'},"\n";
  } else {
     print "An error occured ($result->{'error_code'}: ".
           "$result->{'error_msg'})";
  }

=head1 DESCRIPTION

C- Response from 30Boxes API

The response object is basically a L class, with a few
things added. These keys can be queried:

=over 5

=item success

Was the call succesful?

=item error_code

If not succesful, what error code did we get?

=item error_msg

And the error message

=back

=head2 METHODS

=head3 reply

C returns the result of L's parsing of the 30Boxes
reply. See the example above.

=head1 SEE ALSO

L, L, L

=head1 BUGS

Please report any bugs to L

=head1 AUTHOR

M. Blom,
[e-mail],
L

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2006 by M. Blom

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.

=cut