Group
Extension

Net-TribalWarsMap-API-TribeLookup/lib/Net/TribalWarsMap/API/TribeLookup.pm


use strict;
use warnings;

package Net::TribalWarsMap::API::TribeLookup;
BEGIN {
  $Net::TribalWarsMap::API::TribeLookup::AUTHORITY = 'cpan:KENTNL';
}
{
  $Net::TribalWarsMap::API::TribeLookup::VERSION = '0.1.0';
}

# ABSTRACT: Query general information about tribes.



use Carp qw(croak);
use Moo;


has 'ua' => (
  is      => 'ro',
  lazy    => 1,
  builder => sub {
    require Net::TribalWarsMap::API::HTTP;
    return Net::TribalWarsMap::API::HTTP->new( cache_name => 'tribe_lookup_scraper' );
  },
);


has 'decoder' => (
  is      => 'ro',
  lazy    => 1,
  builder => sub {
    require JSON;
    return JSON->new();
  },
);


has 'world' => (
  is       => ro =>,
  required => 1,
);


has search => (
  is       => ro =>,
  required => 1,
  isa      => sub {
    length( $_[0] ) >= 2 or croak q[Tribe Lookups must have >2 characters];
  },
);


has _ts => (
  is      => ro =>,
  lazy    => 1,
  builder => sub {
    require DateTime;
    my $ds = DateTime->now();
    return sprintf q[%s-%s-%s], $ds->month_0, $ds->day, $ds->hour;
  },
);


has 'uri' => (
  is      => ro => lazy => 1,
  builder => sub {
    sprintf q[http://%s.tribalwarsmap.com/data.php?type=tribesearch&q=%s&ms=%s] => ( $_[0]->world, $_[0]->search, $_[0]->_ts );
  },
);


has _results => (
  is      => ro =>,
  lazy    => 1,
  builder => sub {
    my $result = $_[0]->ua->get( $_[0]->uri );
    croak q[failed to get data] if not $result->{success};
    return $_[0]->decoder->decode( $result->{content} )->{'tribedata'};
  },
);


has _decoded_results => (
  is      => ro =>,
  lazy    => 1,
  builder => sub {
    my $dr = $_[0]->_results;
    require Net::TribalWarsMap::API::TribeLookup::Result;
    my $out = {};
    for my $tribe ( keys %{$dr} ) {
      $out->{$tribe} = Net::TribalWarsMap::API::TribeLookup::Result->from_data_line( $tribe, @{ $dr->{$tribe} } );
    }
    return $out;
  },
);


sub get_tag {
  my ( $class, $world, $tag ) = @_;
  my $search = substr $tag, 0, 2;
  for my $tribe ( $class->search_tribes( $world, $search ) ) {
    return $tribe if $tribe->tag eq $tag;
  }
  return;
}


sub search_tribes {
  my ( $class, $world, $search, $filter ) = @_;
  my $dr = $class->new( world => $world, search => $search );
  if ( not $filter ) {
    return values %{ $dr->_decoded_results };
  }
  return grep { $_->name =~ $filter } values %{ $dr->_decoded_results };
}

1;

__END__

=pod

=encoding utf-8

=head1 NAME

Net::TribalWarsMap::API::TribeLookup - Query general information about tribes.

=head1 VERSION

version 0.1.0

=head1 SYNOPSIS

    # Tag based lookup
    my $result = Net::TribalWarsMap::API::TribeLookup->get_tag('en69', 'kill');

    # Generic search
    my @results = Net::TribalWarsMap::API::TribeLookup->search_tribes('en69', 'Alex');

    # generic search with name filter
    my @results = Net::TribalWarsMap::API::TribeLookup->search_tribes('en69', 'lex',qr/^Alex/ );

    # Advanced
    my $instance = Net::TribalWarsMap::API::TribeLookup->new(
        world => 'en69',
        search => 'alex',
    );
    my $raw_results = $instance->_results;

=head1 METHODS

=head2 C<ua>

    my $ua = $instance->ua;

=head2 C<decoder>

    my $decoder = $instance->decoder();

=head2 C<world>

    my $world = $instance->world(); # en67 or similar

=head2 C<search>

    my $search = $instance->search();

=head2 C<uri>

    my $search_uri = $class->new( world => ... , search => ... )->uri;

=head2 C<get_tag>

    my $result = $class->get_tag( $world, $tag );

For example:

    my $result = $class->get_tag('en69', 'kill');

If C<$tag> is not found, C<undef> is returned.

=head2 C<search_tribes>

    my @results = $class->search_tribes( $world, $search_string );

or

    my @results = $class->search_tribes( $world, $search_string , $name_filter_regexp );

For instance:

      my @results = $class->search_tribes( 'en69', 'kill' );

will return all tribes in C<world en69> with the sub-string C<kill> in their tag or name.

      my @results = $class->search_tribes( 'en69', 'kill' , qr/bar/);

will return all tribes in C<world en69> with the sub-string C<kill> in their tag or name, where their name also matches

      $tribe->name =~ qr/bar/

=head1 ATTRIBUTES

=head2 C<ua>

The HTTP User Agent to use for requests.

Default is a L<< C<Net::TribalWarsMap::API::HTTP>|Net::TribalWarsMap::API::HTTP >> instance.

    $instance->new( ua => $user_agent );
    ...
    my $ua = $instance->ua();

=head2 C<decoder>

The C<JSON> Decoder object

    my $instance = $class->new(
        decoder => JSON->new()
    );

=head2 C<world>

B<MANDATORY PARAMETER>:

    my $instance = $class->new( world => $world_name );

This will be something like C<en67>, and is the prefix used in domain C<URI>'s.

=head2 C<search>

    my $instance = $class->new( search => $string );

=head2 C<uri>

Normally this parameter is not required to be provided, and is instead
composed by joining an existing base URI with C<world> C<search> and C<_ts>

    my $instance = $class->new( uri => 'fully qualified search URI' );

=head1 PRIVATE ATTRIBUTES

=head2 C<_ts>

    my $instance = $class->new( _ts => "mm-dd-yyy" );

=head2 C<_results>

Lazy builder that returns a C<json>-decoded version of the result of fetching C<uri>.

    my $instance = $class->new( _results => { %complex_structure } );

=head2 C<_decoded_results>

Lazy builder that returns a Hash of Objects decoded from the result of C<_results>

    my %complex_structure = (
        key => Net::TribalWarsMap::API::TribeLookup::Result->new(),
        key2 => Net::TribalWarsMap::API::TribeLookup::Result->new(),
    );
    my $instance => $class->new( _decoded_results => { %complex_structure } );

=head1 PRIVATE METHODS

=head2 C<_ts>

    my $now = $instance->_ts;

=head2 C<_results>

    my $raw_results = $instance->_results;

=head2 C<_decoded_results>

    my %decoded_results = %{ $instance->_decoded_results };

=begin MetaPOD::JSON v1.1.0

{
    "namespace":"Net::TribalWarsMap::API::TribeLookup",
    "interface":[ "class","single_class" ],
    "inherits":"Moo::Object"
}


=end MetaPOD::JSON

=head1 AUTHOR

Kent Fredric <kentfredric@gmail.com>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Kent Fredric <kentfredric@gmail.com>.

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

=cut


Powered by Groonga
Maintained by Kenichi Ishigaki <ishigaki@cpan.org>. If you find anything, submit it on GitHub.