File Coverage

lib/Finance/Robinhood/Forex/Historicals.pm

Criterion	Covered	Total	%
statement	11	39	28.2
branch			n/a
condition	4	8	50.0
subroutine	7	11	63.6
pod	4	4	100.0
total	26	62	41.9

package Finance::Robinhood::Forex::Historicals;

=encoding utf-8

=for stopwords watchlist watchlists untradable urls

=head1 NAME

Finance::Robinhood::Forex::Historicals - Represents a Forex Currency's
Historical Price Data

=head1 SYNOPSIS

    use Finance::Robinhood;
    my $rh = Finance::Robinhood->new->login('user', 'pass');

    # TODO

=cut

our $VERSION = '0.92_003';
use Mojo::Base-base, -signatures;
use Mojo::URL;

sub _test__init {
    my $rh = t::Utility::rh_instance(1);
    my $historicals = $rh->forex_pair_by_id(
                             '3d961844-d360-45fc-989b-f6fca761d511') # BTC-USD
        ->historicals(interval => '5minute');
    isa_ok($historicals, __PACKAGE__);
    t::Utility::stash('HISTORICALS', $historicals);    #  Store it for later
}
##

=head1 METHODS

=cut

has _rh => undef => weak => 1;

=head2 C


=head2 C

Returns a list of Finance::Robinhood::Forex::Historicals::DataPoint object.

=head2 C



=head2 C


=head2 C

Returns a Time::Moment object.

=head2 C


=head2 C

Returns a Time::Moment object.

=head2 C


=head2 C

=cut

has ['bounds',     'interval',
     'open_price', 'previous_close_price',
     'span',       'symbol'
];

sub data_points ($s) {
    require Finance::Robinhood::Forex::Historicals::Datapoint;
    map {
        Finance::Robinhood::Forex::Historicals::Datapoint->new(_rh => $s->_rh,
                                                               %{$_})
    } @{$s->{data_points}};
}

sub _test_data_points {
    t::Utility::stash('HISTORICALS')
        // skip_all('No historicals object in stash');
    my ($datapoint) = t::Utility::stash('HISTORICALS')->data_points;
    isa_ok($datapoint, 'Finance::Robinhood::Forex::Historicals::Datapoint');
}

sub open_time ($s) {
    Time::Moment->from_string($s->{open_time});
}

sub _test_open_time {
    t::Utility::stash('HISTORICALS')
        // skip_all('No historicals object in stash');
    isa_ok(t::Utility::stash('HISTORICALS')->open_time, 'Time::Moment');
}

=head2 C

Returns a Time::Moment object.

=cut

sub previous_close_time ($s) {
    Time::Moment->from_string($s->{previous_close_time});
}

sub _test_previous_close_time {
    t::Utility::stash('HISTORICALS')
        // skip_all('No historicals object in stash');
    isa_ok(t::Utility::stash('HISTORICALS')->previous_close_time,
           'Time::Moment');
}

=head2 C

Returns the related Finance::Robinhood::Forex::Pair object.

=cut

sub pair ($s) {
    $s->_rh->forex_pair_by_id($s->{id});
}

sub _test_instrument {
    t::Utility::stash('HISTORICALS')
        // skip_all('No historicals object in stash');
    isa_ok(t::Utility::stash('HISTORICALS')->pair,
           'Finance::Robinhood::Forex::Pair');
}

=head1 LEGAL

This is a simple wrapper around the API used in the official apps. The author
provides no investment, legal, or tax advice and is not responsible for any
damages incurred while using this software. This software is not affiliated
with Robinhood Financial LLC in any way.

For Robinhood's terms and disclosures, please see their website at
https://robinhood.com/legal/

=head1 LICENSE

Copyright (C) Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under
the terms found in the Artistic License 2. Other copyrights, terms, and
conditions may apply to data transmitted through this module. Please refer to
the L section.

=head1 AUTHOR

Sanko Robinson [e-mail]

=cut

1;