File Coverage

lib/Finance/Robinhood/Equity/Watchlist.pm

Criterion	Covered	Total	%
statement	23	88	26.1
branch	0	8	0.0
condition	10	29	34.4
subroutine	15	22	68.1
pod	5	5	100.0
total	53	152	34.8

package Finance::Robinhood::Equity::Watchlist;

=encoding utf-8

=for stopwords watchlist watchlists untradable urls

=head1 NAME

Finance::Robinhood::Equity::Watchlist - Represents a Single Robinhood Watchlist

=head1 SYNOPSIS

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

    # TODO

=cut

our $VERSION = '0.92_003';

sub _test__init {
    my $rh        = t::Utility::rh_instance(1);
    my $watchlist = $rh->equity_watchlist_by_name('Default');
    isa_ok($watchlist, __PACKAGE__);
    t::Utility::stash('WATCHLIST', $watchlist);    #  Store it for later
}
use Mojo::Base 'Finance::Robinhood::Utilities::Iterator', -signatures;
use Mojo::URL;
use overload '""' => sub ($s, @) { $s->{_next_page} // $s->{_first_page} },
    fallback => 1;
use Finance::Robinhood::Equity::Watchlist::Element;

sub _test_stringify {
    t::Utility::stash('WATCHLIST') // skip_all();
    is(+t::Utility::stash('WATCHLIST'),
        'https://api.robinhood.com/watchlists/Default/');
}

=head1 METHODS

This is a subclass of Finance::Robinhood::Utilities::Iterator. All the sweet,
sugary goodness from there works here. Note that C, C,
etc. return  Finance::Robinhood::Equity::Watchlist::Element objects.

=cut

# Inherits _rh from Iterator

=head2 C

	warn $watchlist->name;

Returns the name given to this watchlist.

=cut

has 'name' => sub ($s) {
    $s->{results}->[0]->{watchlist} =~ m[.+\/(\w+)\/$];
    $1;
};

sub _test_name {
    t::Utility::stash('WATCHLIST') // skip_all();
    is(t::Utility::stash('WATCHLIST')->name, 'Default');
}

# Private
has 'url' => sub ($s) {
    sprintf 'https://api.robinhood.com/watchlists/%s/', $s->name;
};

sub _test_url {
    t::Utility::stash('WATCHLIST') // skip_all();
    is(t::Utility::stash('WATCHLIST')->url,
        'https://api.robinhood.com/watchlists/Default/');
}

# Override methods from Iterator
has _class     => sub ($s) {'Finance::Robinhood::Equity::Watchlist::Element'};
has _next_page => sub ($s) { $s->{url} };

sub _test_current {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    isa_ok(t::Utility::stash('WATCHLIST')->current,
           'Finance::Robinhood::Equity::Watchlist::Element');
}

sub _test_next {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    isa_ok(t::Utility::stash('WATCHLIST')->next,
           'Finance::Robinhood::Equity::Watchlist::Element');
}

=head2 C

    $watchlist->populate('MSFT', 'QQQ', 'BA');

Adds a list of equity instruments in bulk by their ticker symbol and returns a
boolean.

=cut

sub populate ($s, @symbols) {

    # Split symbols into groups of 32 to keep URL length down
    my $res;
    while (@symbols) {
        $res = $s->_rh->_post($s->url . 'bulk_add/',
                              symbols => splice @symbols,
                              0, 32
        );
        return Finance::Robinhood::Error->new($res->json)
            if !$res->is_success;
    }
    return $res->is_success ||
        Finance::Robinhood::Error->new(
             $res->is_server_error ? (details => $res->message) : $res->json);
}

sub _test_populate {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    ok(t::Utility::stash('WATCHLIST')->populate('MSFT'), 'adding MSFT');
    todo("Test that the instrument was added by checking watchlist size" =>
         sub { pass('ugh') });
}

=head2 C

    $watchlist->add_instrument($msft);

Adds an equity instrument. If successful, a
Finance::Robinhood::Equity::Watchlist::Element object is returned.

=cut

sub add_instrument ($s, $instrument) {
    my $res = $s->_rh->_post($s->url, instrument => $instrument);
    return $res->is_success
        ? Finance::Robinhood::Equity::Watchlist::Element->new(_rh => $s->_rh,
                                                              %{$res->json})
        : Finance::Robinhood::Error->new(
             $res->is_server_error ? (details => $res->message) : $res->json);
}

sub _test_add_instrument {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    my $result
        = t::Utility::stash('WATCHLIST')
        ->add_instrument(t::Utility::stash('WATCHLIST')
                         ->_rh->equity_instrument_by_symbol('MSFT'));
    isa_ok($result,
           $result
           ? 'Finance::Robinhood::Equity::Watchlist::Element'
           : 'Finance::Robinhood::Error'
    );
}

=head2 C

    my @instruments = $watchlist->instruments();

This method makes a call to grab data for every equity instrument on the
watchlist and returns them as a list.

=cut

sub instruments ($s) {
    $s->_rh->equity_instruments_by_id(map { $_->id } $s->all);
}

sub _test_instruments {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    my @instruments = t::Utility::stash('WATCHLIST')->instruments;
    isa_ok($_, 'Finance::Robinhood::Equity::Instrument') for @instruments;
}

=head2 C

    my @ids = $watchlist->ids();

Returns the instrument id for all equity instruments as a list.

=cut

sub ids ($s) {
    map { $_->id } $s->all;
}

sub _test_ids {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    my @ids = t::Utility::stash('WATCHLIST')->ids;
    like($_, qr[^[0-9a-f]{8}(?:\-[0-9a-f]{4}){3}\-[0-9a-f]{12}$]i, $_)
        for @ids;
}

=head2 C

    $watchlist->reorder( @ids );

This method moves items of the watchlist around.

=cut

sub reorder ($s, @ids) {
    my $res = $s->_rh->_post($s->url . 'reorder/', uuids => join ',', @ids);
    return $res->is_success || Finance::Robinhood::Error->new(%{$res->json});
}

sub _test_reorder {
    t::Utility::stash('WATCHLIST') // skip_all();
    t::Utility::stash('WATCHLIST')->reset;
    my @ids = t::Utility::stash('WATCHLIST')->ids;
    ok(t::Utility::stash('WATCHLIST')->reorder(reverse @ids), 'reorder(...)');
    t::Utility::stash('WATCHLIST')->reset;
    my @reordered = t::Utility::stash('WATCHLIST')->ids;
    is([reverse @ids], \@reordered);
}

=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;