view release on metacpan or  search on metacpan

lib/Games/EveOnline/EveCentral/Request/History.pm  view on Meta::CPAN

package Games::EveOnline::EveCentral::Request::History;
{
  $Games::EveOnline::EveCentral::Request::History::VERSION = '0.001';
}


# ABSTRACT: Create a request for the history endpoint.


use Moo 1.003001;
use MooX::Types::MooseLike 0.25;
use MooX::StrictConstructor 0.006;
use MooX::Types::MooseLike::Base qw(AnyOf Enum Int Str Undef);

use 5.012;

extends 'Games::EveOnline::EveCentral::Request';

use Readonly 1.03;


Readonly::Scalar my $ENDPOINT => 'history';


has 'type_id' => (
  is => 'ro',
  isa => Int,
  required => 1
);

has 'location_type' => (
  is => 'ro',
  isa => Enum['system', 'region'],
  predicate => 1
);

has 'location' => (
  is => 'ro',
  isa => AnyOf[Int, Str]
);

has 'bid' => (
  is => 'ro',
  isa => Enum['buy', 'sell'],
  required => 1
);

has '_path' => (
  is => 'lazy',
  isa => Str,
);



sub request {
  my $self = shift;
  my $path = $self->_path;

  return $self->http_request($path);
}



sub BUILD {
  my $self = shift;
  my $location = $self->location;

  if ($self->has_location_type()) {
    if (not defined $location or $location eq '') {
      die "Location must be provided.";
    }
  }
}

sub _build__path {
  my $self = shift;

  my $path = $ENDPOINT . '/';

  $path .= 'for/type/' . $self->type_id;

  if (defined $self->location_type) {
    $path .= '/' . $self->location_type;
    $path .= '/' . $self->location;
  }

  my $bid = $self->bid eq 'buy'? 1 : 0;
  $path .= '/bid/' . $bid;

  return $path;
}


1; # End of Games::EveOnline::EveCentral::Request::History

__END__

=pod

=head1 NAME

Games::EveOnline::EveCentral::Request::History - Create a request for the history endpoint.

=head1 VERSION

version 0.001

=head1 SYNOPSIS

  my $req = Games::EveOnline::EveCentral::Request::History->new(
    type_id => 34, # Mandatory.
    hours => 1, # defaults to 360
    min_q => 10000, # defaults to 1
    system => 30000142,
    regions => 10000002, # or [10000002, 10000003],
  )->request;

=head1 DESCRIPTION

This class is used to create HTTP::Request objects suitable to call the
`history` method on EVE Central.

Please take care to only use valid type ids.

Examples:

=over 4

=item * L<http://api.eve-central.com/api/history/for/type/34/system/Amarr/bid/1>

=item * L<http://api.eve-central.com/api/history/for/type/34/region/The%20Forge/bid/0>

=back

=for test_synopsis no strict 'vars'

=head1 METHODS

=head2 request

Returns an HTTP::Request object which can be used to call the 'history'
endpoint.

=begin private

=end private

=head1 AUTHOR

Pedro Figueiredo, C<< <me at pedrofigueiredo.org> >>

=head1 BUGS

Please report any bugs or feature requests through the web interface at
L<https://github.com/pfig/games-eveonline-evecentral/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 Games::EveOnline::EveCentral

You can also look for information at:

=over 4

=item * GitHub Issues (report bugs here)

L<https://github.com/pfig/games-eveonline-evecentral/issues>

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/Games-EveOnline-EveCentral>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/Games-EveOnline-EveCentral>

=item * CPAN

L<http://metacpan.org/module/Games::EveOnline::EveCentral>

=back

=head1 ACKNOWLEDGEMENTS

=over 4

=item * The people behind EVE Central.

L<http://eve-central.com/>

=back

=head1 LICENSE AND COPYRIGHT

Copyright 2013 Pedro Figueiredo.

This program is free software; you can redistribute it and/or modify it
under the terms of the Artistic License.