File Coverage

lib/Finance/Robinhood/Options/Instrument.pm

Criterion	Covered	Total	%
statement	15	43	34.8
branch			n/a
condition	5	10	50.0
subroutine	9	14	64.2
pod	4	4	100.0
total	33	71	46.4

package Finance::Robinhood::Options::Instrument;

=encoding utf-8

=for stopwords watchlist watchlists untradable urls

=head1 NAME

Finance::Robinhood::Options::Instrument - Represents a Single Options
Instrument

=head1 SYNOPSIS

    use Finance::Robinhood;
    my $rh = Finance::Robinhood->new;
    my $instruments = $rh->options_instruments();

    for my $instrument ($instruments->all) {
        CORE::say $instrument->chain_symbol;
    }

=cut

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

sub _test__init {
    my $rh         = t::Utility::rh_instance(1);
    my $instrument = $rh->options_instruments(
        chain_id    => $rh->equity_instrument_by_symbol('MSFT')->tradable_chain_id,
        tradability => 'tradable'
    )->current;
    isa_ok( $instrument, __PACKAGE__ );
    t::Utility::stash( 'INSTRUMENT', $instrument );    #  Store it for later
}
use overload '""' => sub ( $s, @ ) { $s->{url} }, fallback => 1;

sub _test_stringify {
    t::Utility::stash('INSTRUMENT') // skip_all();
    is(
        +t::Utility::stash('INSTRUMENT'),
        'https://api.robinhood.com/options/instruments/'
            . t::Utility::stash('INSTRUMENT')->id . '/'
    );
}
#
has _rh => undef => weak => 1;

=head1 METHODS

=head2 C


=head2 C


=head2 C

UUID used to identify this instrument.

=head2 C

Returns a hash reference with the following keys:

=over

=item C - Minimum tick size when applicable.

=item C - Minimum tick size when applicable.

=item C - At this price or more, the C will apply. Below this price, the C is required.

=back

=head2 C

Exposes whether or not this instrument can be traded on Robinhood. Either
C or C.

=head2 C



=head2 C

The strike of this particular instrument.

=head2 C

Indicates whether this instrument is being traded in general.

=head2 C

Indicated whether this is a C or C.

=cut

has [
    'chain_id',        'chain_symbol', 'id',           'min_ticks',
    'rhs_tradability', 'state',        'strike_price', 'tradability',
    'type',
];

=head2 C

Returns a Time::Moment object.

=cut

sub expiration_date ($s) {
    Time::Moment->from_string( $s->{expiration_date} . 'T00:00:00Z' );
}

sub _test_expiration_date {
    t::Utility::stash('INSTRUMENT') // skip_all();
    isa_ok( t::Utility::stash('INSTRUMENT')->expiration_date, 'Time::Moment' );
}

=head2 C

Returns a Time::Moment object.

=cut

sub issue_date ($s) {
    Time::Moment->from_string( $s->{issue_date} . 'T00:00:00Z' );
}

sub _test_issue_date {
    t::Utility::stash('INSTRUMENT') // skip_all();
    isa_ok( t::Utility::stash('INSTRUMENT')->issue_date, 'Time::Moment' );
}

=head2 C

Returns a Time::Moment object.

=cut

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

sub _test_created_at {
    t::Utility::stash('INSTRUMENT') // skip_all();
    isa_ok( t::Utility::stash('INSTRUMENT')->created_at, 'Time::Moment' );
}

=head2 C

Returns a Time::Moment object.

=cut

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

sub _test_updated_at {
    t::Utility::stash('INSTRUMENT') // skip_all();
    isa_ok( t::Utility::stash('INSTRUMENT')->updated_at, 'Time::Moment' );
}

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