/ 
App-fiatx-0.003
River stage one • 1 direct dependent • 1 total dependent
/ fiatx

NAME

fiatx - Get fiat currency conversion rates

VERSION

This document describes version 0.003 of fiatx (from Perl distribution App-fiatx), released on 2018-06-19.

SYNOPSIS

First, create a MySQL database e.g. fiatx. Then in ~/.config/fiatx.conf:

db_name=fiatx
; the app can also look for passwords in my.cnf
; db_username=...
; db_password=...

To get conversion rates of USD/IDR (by default the dealer's 'sell' rate):

% fiatx spot-rate USD IDR

By default result is cached for 4 hours, to force querying from the source again:

% fiatx spot-rate USD IDR --no-cache

To get dealer's 'buy' rate:

% fiatx spot-rate USD IDR --type buy

To query from a specific source:

% fiatx spot-rate USD IDR --source bi

To get highest/lowest rate of all sources:

% fiatx spot-rate USD IDR --source :highest
% fiatx spot-rate USD IDR --source :lowest

To get rate from source with the newest/oldest update:

% fiatx spot-rate USD IDR --source :newest
% fiatx spot-rate USD IDR --source :oldest

To get rate averaged from several sources:

% fiatx spot-rate USD IDR --source :average

To list available sources:

% fiatx sources

To get all spot rates from a source:

% fiatx all-spot-rates bca

For more details, use fiatx --help or consult documentation.

DESCRIPTION

SUBCOMMANDS

all-spot-rates

Get all spot (latest) rates from a source.

sources

List available sources.

spot-rate

Get spot (latest) rate.

OPTIONS

* marks required options.

Common options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--quiet

Shortcut for --log-level=error.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

Options for subcommand all-spot-rates

--db-name=s*
--db-password=s
--db-username=s
--max-age-cache=s

Above this age (in seconds), we retrieve rate from remote source again.

Default value:

14400
--no-cache=s

Alias for --max-age-cache 0.

See --max-age-cache.

--source=s*

Ask for a specific remote source.

Default value:

":any"

If you want a specific remote source, you can specify it here. The default is ':any' which is to pick the first source that returns a recent enough current rate.

Other special values: `:highest` to return highest rate of all sources, `:lowest` to return lowest rate of all sources, ':newest' to return rate from source with the newest last update time, ':oldest' to return rate from source with the oldest last update time, ':average' to return arithmetic average of all sources.

Options for subcommand spot-rate

--db-name=s*
--db-password=s
--db-username=s
--from=s*
--max-age-cache=s

Above this age (in seconds), we retrieve rate from remote source again.

Default value:

14400
--no-cache=s

Alias for --max-age-cache 0.

See --max-age-cache.

--source=s

Ask for a specific remote source.

Default value:

":any"

If you want a specific remote source, you can specify it here. The default is ':any' which is to pick the first source that returns a recent enough current rate.

Other special values: `:highest` to return highest rate of all sources, `:lowest` to return lowest rate of all sources, ':newest' to return rate from source with the newest last update time, ':oldest' to return rate from source with the oldest last update time, ':average' to return arithmetic average of all sources.

--to=s*
--type=s

Which rate is wanted? e.g. sell, buy.

Default value:

"sell"

Valid values:

["sell","buy"]

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C fiatx fiatx

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete fiatx 'p/*/`fiatx`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/fiatx.conf, ~/fiatx.conf, or /etc/fiatx.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)

Configuration for subcommand all-spot-rates

db_name (see --db-name)
db_password (see --db-password)
db_username (see --db-username)
max_age_cache (see --max-age-cache)
source (see --source)

Configuration for subcommand sources

Configuration for subcommand spot-rate

db_name (see --db-name)
db_password (see --db-password)
db_username (see --db-username)
from (see --from)
max_age_cache (see --max-age-cache)
source (see --source)
to (see --to)
type (see --type)

ENVIRONMENT

FIATX_OPT => str

Specify additional command-line options.

FILES

~/.config/fiatx.conf

~/fiatx.conf

/etc/fiatx.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-fiatx.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-fiatx.

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by 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.