File Coverage

lib/Finance/Robinhood/Forex/Currency.pm

Criterion	Covered	Total	%
statement	16	39	41.0
branch			n/a
condition	3	6	50.0
subroutine	8	11	72.7
pod	2	2	100.0
total	29	58	50.0

package Finance::Robinhood::Forex::Currency;

=encoding utf-8

=for stopwords watchlist watchlists untradable urls

=head1 NAME

Finance::Robinhood::Forex::Currency - Represents a Single Forex Currency
Watchlist

=head1 SYNOPSIS

    use Finance::Robinhood;
    my $rh = Finance::Robinhood->new;

    # TODO

=cut

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

sub _test__init {
    my $rh  = t::Utility::rh_instance(1);
    my $btc = $rh->forex_currency_by_id('d674efea-e623-4396-9026-39574b92b093');    # BTC
    isa_ok( $btc, __PACKAGE__ );
    t::Utility::stash( 'CURRENCY', $btc );    #  Store it for later
}
use overload '""' => sub ( $s, @ ) { $s->{id} }, fallback => 1;

sub _test_stringify {
    t::Utility::stash('CURRENCY') // skip_all();
    like(
        +t::Utility::stash('CURRENCY'),
        qr'^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'i
    );
}
#
has _rh => undef => weak => 1;

=head1 METHODS

=head2 C

If defined, this returns a hex color code used for display.

=head2 C

Short code used to represent this currency for display. 'USD', for example.

=head2 C

Returns a UUID.

=head2 C

The increment used as a minimum for display, etc. For example, USD would return
C<0.01> to prevent sub-penny price display.

=head2 C

Returns a string suited for display. And example would be 'US Dollar'.

=head2 C

This is the asset type. Currently, C or C.

=cut

has [ 'brand_color', 'code', 'id', 'increment', 'name', 'type' ];

=head2 C

    my $news = $currency->news;

Returns an iterator containing Finance::Robinhood::News elements.

=cut

sub news ($s) { $s->_rh->news( $s->id ) }

sub _test_news {
    t::Utility::stash('CURRENCY') // skip_all();
    my $news = t::Utility::stash('CURRENCY')->news;
    isa_ok( $news,          'Finance::Robinhood::Utility::Iterator' );
    isa_ok( $news->current, 'Finance::Robinhood::News' );
}

=head2 C

    my $pair = $currency->pair;

Returns a Finance::Robinhood::Forex::Pair object.

=cut

sub pair ($s) {
    my ($retval) = grep { $_->asset_currency->id eq $s->id } $s->_rh->forex_pairs->all;
    $retval;
}

sub _test_pairs {
    t::Utility::stash('CURRENCY') // skip_all();
    my $pair = t::Utility::stash('CURRENCY')->pair;
    isa_ok( $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;