/ 
Finance-Currency-Convert-Mandiri-0.002
River stage one • 2 direct dependents • 4 total dependents
/ Finance::Currency::Convert::Mandiri

NAME

Finance::Currency::Convert::Mandiri - Convert currency using Bank Mandiri

VERSION

This document describes version 0.002 of Finance::Currency::Convert::Mandiri (from Perl distribution Finance-Currency-Convert-Mandiri), released on 2022-02-27.

SYNOPSIS

use Finance::Currency::Convert::Mandiri qw(convert_currency);

printf "1 USD = Rp %.0f\n", convert_currency(1, 'USD', 'IDR');

DESCRIPTION

This module can extract currency rates from the Bank Mandiri website:

https://www.bankmandiri.co.id/kurs/

Currently only conversions from a few currencies to Indonesian Rupiah (IDR) are supported.

CURRENCY MODULE STATISTICS

Supported pairs:

AUD/IDR IDR/AUD
CAD/IDR IDR/CAD
CHF/IDR IDR/CHF
CNY/IDR IDR/CNY
DKK/IDR IDR/DKK
EUR/IDR IDR/EUR
GBP/IDR IDR/GBP
HKD/IDR IDR/HKD
JPY/IDR IDR/JPY
MYR/IDR IDR/MYR
NOK/IDR IDR/NOK
NZD/IDR IDR/NZD
SAR/IDR IDR/SAR
SGD/IDR IDR/SGD
THB/IDR IDR/THB
USD/IDR IDR/USD

FUNCTIONS

convert_currency

Usage:

convert_currency($n, $from, $to, $which) -> any

Convert currency using Bank Mandiri.

Currently can only handle conversion to IDR. Dies if given other currency.

Will warn if failed getting currencies from the webpage.

Currency rate is not cached (retrieved from the website every time). Employ your own caching.

Will return undef if no conversion rate is available for the requested currency.

Use get_currencies(), which actually retrieves and scrapes the source web page, if you need the more complete result.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • $from* => str

  • $n* => float

  • $to* => str

  • $which => str (default: "avg_sr")

    Select which rate to use (default is average buy+sell for e-Rate).

    {buy,sell,avg}_{bn,er,ttc}.

Return value: (any)

get_currencies

Usage:

get_currencies() -> [$status_code, $reason, $payload, \%result_meta]

Extract data from Bank Mandiri page.

This function is not exported by default, but exportable.

No arguments.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

Will return a hash containing key currencies.

The currencies is a hash with currency symbols as keys and prices as values.

Tha values is a hash with these keys: buy_bn and sell_bn (Bank Note buy/sell rates), buy_sr and sell_sr (Special Rate buy/sell rates), buy_ttc and sell_ttc (Telegraphic Transfer Counter buy/sell rates).

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Finance-Currency-Convert-Mandiri.

SOURCE

Source repository is at https://github.com/perlancar/perl-Finance-Currency-Convert-Mandiri.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2018 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Finance-Currency-Convert-Mandiri

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.