File Coverage

blib/lib/WG/API/WoT.pm

Criterion	Covered	Total	%
statement	9	34	26.4
branch			n/a
condition			n/a
subroutine	4	29	13.7
pod	25	26	96.1
total	38	89	42.7

package WG::API::WoT;

use Const::Fast;

use Moo;

with 'WG::API::Base';

=head1 NAME

WG::API::WoT - Module to work with Wargaming.net Public API for World of Tanks

=head1 VERSION

Version v0.13

=cut

our $VERSION = 'v0.13';

const my $api_uri => '//api.worldoftanks.ru/';

sub _api_uri {
    my ($self) = @_;

    return $api_uri;
}

=head1 SYNOPSIS

Wargaming.net Public API is a set of API methods that provide access to Wargaming.net content, including in-game and game-related content, as well as player statistics.

This module provide access to WG Public API

    use WG::API;

    my $wot = WG::API->new( application_id => 'demo' )->wot();
    ...
    my $player = $wot->account_info( account_id => '1' );



=head1 CONSTRUCTOR

=head2 new

Create new object with params. Rerquired application id: L<https://developers.wargaming.net/documentation/guide/getting-started/>

Params:

 - application_id *
 - languare
 - api_uri

=head1 METHODS

=head2 Account

=over 1

=item B<account_list( [ %params ] )>

Method returns partial list of players. The list is filtered by initial characters of user name and sorted alphabetically

=over 2

=item I<required fields:>

    search - Player name search string. Parameter "type" defines minimum length and type of search. Using the exact search type, you can enter several names, separated with commas. Maximum length: 24.

=back

=cut

sub account_list {
    return shift->_request(
        'get', 'wot/account/list/', [ 'language', 'fields', 'type', 'search', 'limit' ], ['search'],
        @_
    );
}

=item B<account_info( [ %params ] )>

Method returns player details.

=over 2

=item I<required fields:>

    account_id - Account ID. Max limit is 100. Min value is 1.

=back

=cut

sub account_info {
    return shift->_request(
        'get', 'wot/account/info/', [ 'language', 'fields', 'access_token', 'extra', 'account_id' ],
        ['account_id'], @_
    );
}

=item B<account_tanks( [ %params ] )>

Method returns details on player's vehicles.

=over 2

=item I<required fields:>

    account_id - Account ID. Max limit is 100. Min value is 1.

=back

=cut

sub account_tanks {
    return shift->_request(
        'get', 'wot/account/tanks/', [ 'language', 'fields', 'access_token', 'account_id', 'tank_id' ],
        ['account_id'], @_
    );
}

=item B<account_achievements( [ %params ] )>

Method returns players' achievement details.

Achievement properties define the achievements field values:

    1-4 for Mastery Badges and Stage Achievements (type: "class");
    maximum value of Achievement series (type: "series");
    number of achievements earned from sections: Battle Hero, Epic Achievements, Group Achievements, Special Achievements, etc. (type: "repeatable, single, custom").

=over 2

=item I<required fields:>

    account_id - Account ID. Max limit is 100. Min value is 1.

=back

=cut

sub account_achievements {
    return shift->_request( 'get', 'wot/account/achievements/', [ 'language', 'fields', 'account_id' ], ['account_id'], @_ );
}

=item B<stronghold_claninfo( [ %params ] )>

Method returns general information and the battle statistics of clans in the Stronghold mode. Please note that information about the number of battles fought as well as the number of defeats and victories is updated once every 24 hours.

=over 2

=item I<required_fields:>

    clan_id - Clan IDs. Maximum limit: 100

=back

=cut

sub stronghold_claninfo {
    return shift->_request( 'get', 'wot/stronghold/claninfo/', [ 'clan_id', 'fields', 'language' ], ['clan_id'], @_ );
}

=item B<stronghold_clanreserves( [ %params ] )>

Method returns information about available Reserves and their current status.

=over 2

=item I<required_fields:>

    access_token - Access token for the private data of a user's account; can be received via the authorization method; valid within a stated time period

=back

=back

=cut

sub stronghold_clanreserves {
    return shift->_request( 'get', 'wot/stronghold/clanreserves/', [ 'access_token', 'fields', 'language' ], ['access_token'], @_ );
}

=head2 Encyclopedia

=over 1

=item B<encyclopedia_vehicles( [ %params ] )>

Method returns list of available vehicles.

=cut

sub encyclopedia_vehicles {
    return shift->_request( 'get', 'wot/encyclopedia/vehicles/', [ 'fields', 'language', 'limit', 'nation', 'page_no', 'tank_id', 'tier', 'type' ], undef, @_ );
}

=item B<encyclopedia_vehicleprofile( [ %params ] )>

=over 2

=item I<required fields>

    tank_id - vehicle id

=back

=cut

sub encyclopedia_vehicleprofile {
    return shift->_request(
        'get', 'wot/encyclopedia/vehicleprofile/',
        [ 'tank_id', 'engine_id', 'fields', 'gun_id', 'language', 'profile_id', 'radio_id', 'suspension_id', 'turret_id' ],
        ['tank_id'],
        @_
    );
}

=item B<encyclopedia_achievements( [ %params ] )>

Method returns information about achievements.

=cut

sub encyclopedia_achievements {
    return shift->_request( 'get', 'wot/encyclopedia/achievements/', [ 'fields', 'language' ], undef, @_ );
}

=item B<encyclopedia_info( [ %params ] )>

Method returns information about Tankopedia.

=cut

sub encyclopedia_info {
    return shift->_request( 'get', 'wot/encyclopedia/info/', [ 'fields', 'language' ], undef, @_ );
}

=item B<encyclopedia_arenas( [ %params ] )>

Method returns information about maps.

=cut

sub encyclopedia_arenas {
    return shift->_request( 'get', 'wot/encyclopedia/arenas/', [ 'fields', 'language' ], undef, @_ );
}

=item B<encyclopedia_provisions( [ %params ] )>

Method returns a list of available equipment and consumables.

=cut

sub encyclopedia_provisions {
    return shift->_request( 'get', 'wot/encyclopedia/provisions/', [ 'fields', 'language', 'limit', 'page_no', 'provision_id', 'type' ], undef, @_ );
}

=item B<encyclopedia_personalmissions( [ %params ] )>

Method returns details on Personal Missions on the basis of specified campaign IDs, operation IDs, mission branch and tag IDs.

=cut

sub encyclopedia_personalmissions {
    return shift->_request( 'get', 'wot/encyclopedia/personalmissions/', [ 'compaign_id', 'fields', 'language', 'operation_id', 'set_id', 'tag' ], undef, @_ );
}

=item B<encyclopedia_boosters( [ %params ] )>

Method returns information about Personal Reserves.

=cut

sub encyclopedia_boosters {
    return shift->_request( 'get', 'wot/encyclopedia/boosters/', [ 'fields', 'language' ], undef, @_ );
}

=item B<encyclopedia_vehicleprofiles( [ %params ] )>

Method returns vehicle configuration characteristics.

=over 2

=item I<required fields>

    tank_id - vehicle id.

=back

=cut

sub encyclopedia_vehicleprofiles {
    return shift->_request( 'get', 'wot/encyclopedia/vehicleprofiles/', [ 'tank_id', 'fields', 'language', 'order_by' ], ['tank_id'], @_ );
}

=item B<encyclopedia_modules( [ %params ] )>

Method returns list of available modules that can be installed on vehicles, such as engines, turrets, etc. At least one input filter parameter (module ID, type) is required to be indicated.

=cut

sub encyclopedia_modules {
    return shift->_request( 'get', 'wot/encyclopedia/modules/', [ 'extra', 'fields', 'language', 'limit', 'module_id', 'nation', 'page_no', 'type' ], undef, @_ );
}

=item B<encyclopedia_badges( [ %params ] )>

Method returns list of available badges a player can gain in Ranked Battles.

=cut

sub encyclopedia_badges {
    return shift->_request( 'get', 'wot/encyclopedia/badges/', [ 'fields', 'language' ], undef, @_ );
}

=item B<encyclopedia_crewroles( [ %params ] )>

Method returns full description of all crew qualifications.

=cut

sub encyclopedia_crewroles {
    return shift->_request( 'get', 'wot/encyclopedia/crewroles/', [ 'fields', 'language', 'role' ], undef, @_ );
}

=item B<encyclopedia_crewskills( [ %params ] )>

Method returns full description of all crew skills.

=cut

sub encyclopedia_crewskills {
    return shift->_request( 'get', 'wot/encyclopedia/crewskills/', [ 'fields', 'language', 'role', 'skill' ], undef, @_ );
}

=back

=head2 Clan ratings

=over 1

=item B<clanratings_types()>

Method returns details on ratings types and categories.

=cut

sub clanratings_types {
    return shift->_request( 'get', 'wot/clanratings/types/', [], [], @_ );
}

=item B<calnratings_dates( [ %params ] )>

Method returns dates with available rating data.

=cut

sub clanratings_dates {
    return shift->_request( 'get', 'wot/clanratings/dates/', ['limit'], undef, @_ );
}

=item B<clanratings_clans>

Method returns clan ratings by specified IDs.

=over 2

=item I<required_fields:>

    clan_id - Clan IDs. Maximum limit: 100

=back

=cut

sub clanratings_clans {
    return shift->_request( 'get', 'wot/clanratings/clans/', [ 'clan_id', 'date', 'fields', 'language' ], ['clan_id'], @_ );
}

=item B<clanratings_neighbors( [ %params ] )>

Method returns list of adjacent positions in specified clan rating

=over 2

=item I<required_fields:>

    clan_id - Clan IDs. Maximum limit: 100
    rank_field - Rating category

=back

=cut

sub clanratings_neighbors {
    return shift->_request( 'get', 'wot/clanratings/neighbors/', [ 'clan_id', 'rank_field', 'date', 'fields', 'language', 'limit' ], [ 'clan_id', 'rank_field' ], @_ );
}

=item B<clanratings_top( [ %params ] )>

Method returns the list of top clans by specified parameters

=over 2

=item I<required_fields:>

    rank_field - Rating category

=back

=back

=cut

sub clanratings_top {
    return shift->_request( 'get', 'wot/clanratings/top/', [ 'rank_field', 'date', 'fields', 'language', 'limit', 'page_no' ], ['rank_field'], @_ );
}

=head2 Player's vehicles

=over 1

=item B<tanks_stats( [ %params ] )>

Method returns overall statistics, Tank Company statistics, and clan statistics per each vehicle for each user.

=over 2

=item I<required fields:>

    account_id - Account ID. Max limit is 100. Min value is 1.

=cut

sub tanks_stats {
    return shift->_request(
        'get', 'wot/tanks/stats/',
        [ 'language', 'fields', 'access_token', 'account_id', 'tank_id', 'in_garage', 'extra' ],
        ['account_id'], @_
    );
}

=item B<tanks_achievements( [ %params ] )>

Method returns list of achievements on all vehicles.

Achievement properties define the achievements field values:

    1-4 for Mastery Badges and Stage Achievements (type: "class");
    maximum value of Achievement series (type: "series");
    number of achievements earned from sections: Battle Hero, Epic Achievements, Group Achievements, Special Achievements, etc. (type: "repeatable, single, custom").

=over 2

=item I<required fields:>

    account_id - Account ID. Max limit is 100. Min value is 1.

=back

=back

=cut

sub tanks_achievements {
    return shift->_request(
        'get', 'wot/tanks/achievements/',
        [ 'language', 'fields', 'access_token', 'account_id', 'tank_id', 'in_garage' ],
        ['account_id'], @_
    );
}

=back

=head1 BUGS

Please report any bugs or feature requests to C<cynovg at cpan.org>, or through the web interface at L<https://gitlab.com/cynovg/WG-API/issues>.  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 WG::API

You can also look for information at:

=over 4

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

L<https://gitlab.com/cynovg/WG-API/issues>

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/WG-API>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/WG-API>

=item * Search CPAN

L<https://metacpan.org/pod/WG::API>

=back


=head1 ACKNOWLEDGEMENTS

...

=head1 SEE ALSO

WG API Reference L<https://developers.wargaming.net/>

=head1 AUTHOR

Cyrill Novgorodcev , C<< <cynovg at cpan.org> >>

=head1 LICENSE AND COPYRIGHT

Copyright 2015 Cyrill Novgorodcev.

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<http://www.perlfoundation.org/artistic_license_2_0>

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 WG::API::WoT