File Coverage

blib/lib/WWW/StatsMix/UserAgent.pm

Criterion	Covered	Total	%
statement	24	47	51.0
branch	0	4	0.0
condition			n/a
subroutine	8	13	61.5
pod	4	4	100.0
total	36	68	52.9

package WWW::StatsMix::UserAgent;

$WWW::StatsMix::UserAgent::VERSION = '0.06';

=head1 NAME

WWW::StatsMix::UserAgent - StatsMix API user agent library.

=head1 VERSION

Version 0.06

=cut

use 5.006;
use JSON;
use Data::Dumper;

use LWP::UserAgent;
use HTTP::Request::Common qw(POST PUT GET DELETE);
use WWW::StatsMix::UserAgent::Exception;

use Moo;
use namespace::clean;

has 'api_key' => ( is => 'ro', required => 1 );
has 'ua'      => ( is => 'rw', default  => sub { LWP::UserAgent->new(agent => "WWW-StatsMix-API/0.01"); } );

=head1 DESCRIPTION

The L  module  is part of the core library for StatsMix
API services.

=head1 METHODS

=head2 get()

The method get() expects one parameter i.e. URL and returns the standard response.
On error throws exception of type L.

=cut

sub get {
    my ($self, $url) = @_;

    my $request = GET($url);
    $request->header("X-StatsMix-Token", $self->api_key);

    return _response($self->ua->request($request));
}

=head2 put(, )

The method put()  expects three parameters i.e. URL, Headers, Content in the same
order and returns the standard response. On error throws exception of type L.

=cut

sub put {
    my ($self, $url, $content) = @_;

    my $request = POST($url, $content);
    $request->method('PUT');
    $request->header("X-StatsMix-Token", $self->api_key);

    return _response($self->ua->request($request));
}

=head2 post(, )

The method post() expects three parameters i.e. URL, Headers, Content in the same
order and returns the standard response. On error throws exception of type L.

=cut

sub post {
    my ($self, $url, $content) = @_;

    my $request = POST($url, $content);
    $request->header("X-StatsMix-Token", $self->api_key);

    return _response($self->ua->request($request));
}

=head2 delete()

The method delete() expects one parameter URL and returns the  standard response.
On error throws exception of type L.

=cut

sub delete {
    my ($self, $url) = @_;

    my $request = DELETE($url);
    $request->header("X-StatsMix-Token", $self->api_key);

    return _response($self->ua->request($request));
}

sub _response {
    my ($response) = @_;

    my @caller = caller(1);
    @caller = caller(2) if $caller[3] eq '(eval)';

    unless ($response->is_success) {
        WWW::StatsMix::UserAgent::Exception->throw({
            method      => $caller[3],
            message     => $response->message,
            code        => $response->code,
            filename    => $caller[1],
            line_number => $caller[2] });
    }

    return $response;
}

=head1 AUTHOR

Mohammad S Anwar, C<<  >>

=head1 REPOSITORY

L

=head1 BUGS

Please report any bugs or feature requests to C,
or through the web interface at L.
I will be notified, and then you'll automatically be notified of progress on your
bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc WWW::StatsMix::UserAgent

You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back

Copyright (C) 2014 - 2015 Mohammad S Anwar.

This  program  is  free software; you can redistribute it and/or modify it under
the  terms  of the the Artistic License (2.0). You may obtain a copy of the full
license at:

L

Any  use,  modification, and distribution of the Standard or Modified Versions is
governed by this Artistic License.By using, modifying or distributing the Package,
you accept this license. Do not use, modify, or distribute the Package, if you do
not accept this license.

If your Modified Version has been derived from a Modified Version made by someone
other than you,you are nevertheless required to ensure that your Modified Version
 complies with the requirements of this license.

This  license  does  not grant you the right to use any trademark,  service mark,
tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license
to make,  have made, use,  offer to sell, sell, import and otherwise transfer the
Package with respect to any patent claims licensable by the Copyright Holder that
are  necessarily  infringed  by  the  Package. If you institute patent litigation
(including  a  cross-claim  or  counterclaim) against any party alleging that the
Package constitutes direct or contributory patent infringement,then this Artistic
License to you shall terminate on the date that such litigation is filed.

Disclaimer  of  Warranty:  THE  PACKAGE  IS  PROVIDED BY THE COPYRIGHT HOLDER AND
CONTRIBUTORS  "AS IS'  AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
WARRANTIES    OF   MERCHANTABILITY,   FITNESS   FOR   A   PARTICULAR  PURPOSE, OR
NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS
REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL,  OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE
OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=cut

1; # End of WWW::StatsMix::UserAgent