#!perl

use 5.010001;
use strict;
use warnings;

our $DATE = '2021-05-26'; # DATE
our $VERSION = '0.008'; # VERSION

use Perinci::CmdLine::Any;

Perinci::CmdLine::Any->new(
    url => "/App/fiatx/fiatx",
    log => 1,
)->run;

# ABSTRACT: Currency exchange rate tool
# PODNAME: fiatx

__END__

=pod

=encoding UTF-8

=head1 NAME

fiatx - Currency exchange rate tool

=head1 VERSION

This document describes version 0.008 of fiatx (from Perl distribution App-fiatx), released on 2021-05-26.

=head1 SYNOPSIS

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

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

 ; optional. this way, you can just specify USD instead of USD/IDR
 ;default_quote_currency=IDR

Then:

 # Check USD/IDR rates from any source
 % fiatx USD/IDR
 % fiatx usd      ;# works, if you have set default_quote_currency to IDR

 # Check rate from specific source(s) only
 % fiatx usd -s bca
 % fiatx usd -s bca -s bi

 # Check rate and prefer specific types only (in this case: bank notes)
 % fiatx usd -t bn

 # Check rates of all known pairs from all sources (possible huge list and takes
 # a long time, turn on --trace to see progress):
 % fiatx --all-pairs --trace

 # See available sources
 % fiatx -l

=head1 DESCRIPTION

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--action>=I<s>

Default value:

 "get_spot_rates"

=item B<--default-quote-currency>=I<s>

=item B<--max-age-cache>=I<s>

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

Default value:

 14400

=item B<--no-cache>

Alias for --max-age-cache 0.

See C<--max-age-cache>.

=item B<--query>=I<s>

=item B<--source>=I<s@>, B<-s>

Can be specified multiple times.

=item B<--sources-json>=I<s>

See C<--source>.

=item B<-l>

Shortcut for --action=list_sources.

See C<--action>.

=back

=head2 Configuration options

=over

=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

=item B<--config-profile>=I<s>, B<-P>

Set configuration profile to use.

=item B<--no-config>, B<-C>

Do not use any configuration file.

=back

=head2 Database connection options

=over

=item B<--db-name>=I<s>

=item B<--db-password>=I<s>

=item B<--db-username>=I<s>

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

=back

=head2 Logging options

=over

=item B<--debug>

Shortcut for --log-level=debug.

=item B<--log-level>=I<s>

Set log level.

=item B<--quiet>

Shortcut for --log-level=error.

=item B<--trace>

Shortcut for --log-level=trace.

=item B<--verbose>

Shortcut for --log-level=info.

=back

=head2 Output options

=over

=item B<--format>=I<s>

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

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--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]


=item B<--page-result>

Filter output through a pager.

=item B<--view-result>

View output using a viewer.

=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

 complete -C fiatx fiatx

in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

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

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 CONFIGURATION FILE

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

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

All found files will be read and merged.

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

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

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

You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[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.

To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.

List of available configuration parameters:

 action (see --action)
 db_name (see --db-name)
 db_password (see --db-password)
 db_username (see --db-username)
 default_quote_currency (see --default-quote-currency)
 format (see --format)
 log_level (see --log-level)
 max_age_cache (see --max-age-cache)
 naked_res (see --naked-res)
 query (see --query)
 sources (see --source)

=head1 ENVIRONMENT

=head2 FIATX_OPT => str

Specify additional command-line options.

=head1 FILES

F<~/.config/fiatx.conf>

F<~/fiatx.conf>

F</etc/fiatx.conf>

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://github.com/perlancar/perl-App-fiatx/issues>

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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

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

=cut