NAME

cek-bpom-products - Search BPOM products via https://cekbpom.pom.go.id/

VERSION

This document describes version 0.016 of cek-bpom-products (from Perl distribution App-CekBpom), released on 2021-12-09.

SYNOPSIS

Usage:

DESCRIPTION

Uses LWP::UserAgent::Plugin so you can add retry, caching, or additional HTTP client behavior by setting LWP_USERAGENT_PLUGINS environment variable.

OPTIONS

* marks required options.

Main options

--bentuk-sediaan

Shortcut for --search-type=bentuk_sediaan.

See --search-type.

--get-product-detail

For each product (search result), fetch the detail. This currently fetches the manufacturer ("produsen"), which is not displayed by the search result page. Note that this requires a separate HTTP request for each product so can potentially take a long time and might get you banned. Suggestions include: (1) searching without this option first to find out the number of results, then search again with this option if you need it; (2) use <pm:LWP::UserAgent::Plugin::Delay> to throttle your HTTP requests.

--jumlah-dan-kemasan

Shortcut for --search-type=jumlah_dan_kemasan.

See --search-type.

--komposisi

Shortcut for --search-type=komposisi.

See --search-type.

--merk

Shortcut for --search-type=merk.

See --search-type.

--nama-pendaftar

Shortcut for --search-type=nama_pendaftar.

See --search-type.

--nama-produk

Shortcut for --search-type=nama_produk.

See --search-type.

--nomor-registrasi

Shortcut for --search-type=nomor_registrasi.

See --search-type.

--npwp-pendaftar

Shortcut for --search-type=npwp_pendaftar.

See --search-type.

--queries-json=s

See --query.

Can also be specified as the 1st command-line argument and onwards.

--query=s@*

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

--search-type=s@, -t

Select what field(s) to search against.

By default, if not specified, will search against product name ("nama_produk") and brand ("merk"). If you specify multiple times, it will search against all those types, e.g.:

--search-type nama_produk --search-type nama_pendaftar

or:

--nama-produk --nama-pendaftar

Note: the mobile app version allows you to search for products by original manufacturer ("produsen") as well, which is not available in the website version. The website allows you to search for producers ("sarana") by name/address/city/province/country, though, and lets you view what products are registered for that producer.

This utility will allow you to fetch the detail of each product, including manufacturer (see `--get-product-detail` option).

Can be specified multiple times.

--search-types-json=s

Select what field(s) to search against (JSON-encoded).

See --search-type.

-m

Shortcut for --search-type=merk.

See --search-type.

-p

Shortcut for --search-type=nama_produk.

See --search-type.

-P

Shortcut for --search-type=nama_pendaftar.

See --search-type.

Configuration options

--config-path=s, -c: Set path to configuration file.
--config-profile=s: Set configuration profile to use.
--no-config, -C: Do not use any configuration file.

Environment options

--no-env: Do not read environment for default options.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--note=s

Add note.

This will not be sent as queries, but will be added to the log file if log file is specified, as well as added to the result dump file name, in encoded form.

--query-log-file=s

Log queries to log file.

If specified, each invocation of this utility will be logged into a line in the specified file path, in TSV format. Tab character in the query will be converted into 4 spaces, to avoid clash with the use of Tab as field separator.

For example, this invocation:

% cek-bpom-products "minuman susu fermentasi" yakult --query-log-file /some/path.txt

Sample log line:

time:2020-10-22T01:02:03.000Z    queries:minuman susu fermentasi,yakult    search_types:merk,nama_produk    num_results:51    duration:3.402

--quiet

Shortcut for --log-level=error.

--result-dump-dir=s

Dump result to directory.

If specified, will dump full enveloped result to a file in specified directory path, in JSON format. The JSON formatting makes it easy to grep each row. The file will be named `cek-bpom-products-result.<encoded-timestamp>.<search-types-encoded>.<queries-encoded>(.<note-encoded>)?.json`. The encoded timestamp is ISO 8601 format with colon replaced by underscore. The encoded query will replace all every group of "unsafe" characters in query with a single dash. The same goes with encoded note, which comes from the `note` argument. For example, this invocation:

% cek-bpom-products "minuman susu fermentasi" yakult --note "some note"

will result in a result dump file name like: `cek-bpom-products-result.2020-10-22T01_02_03.000Z.merk-nama_produk.minuman-susu-fermentasi-yakult.some-note.json`.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

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

Default value:

undef

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?: Display help message and exit.
--version, -v: Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C cek-bpom-products cek-bpom-products

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 cek-bpom-products 'p/*/`cek-bpom-products`/'

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): /home/u1/.config/cek-bpom-products.conf, /home/u1/cek-bpom-products.conf, or /etc/cek-bpom-products.conf.

All found files will be read and merged.

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

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION 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.

You can also 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 equals some string: [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 some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [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.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [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 -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

format (see --format)
get_product_detail (see --get-product-detail)
log_level (see --log-level)
naked_res (see --naked-res)
note (see --note)
queries (see --query)
query_log_file (see --query-log-file)
result_dump_dir (see --result-dump-dir)
search_types (see --search-type)

ENVIRONMENT

CEK_BPOM_PRODUCTS_OPT => str

Specify additional command-line options.

FILES

/home/u1/.config/cek-bpom-products.conf

/home/u1/cek-bpom-products.conf

/etc/cek-bpom-products.conf

EXAMPLES

By default search against name (nama_produk) and brand (merk):

% cek-bpom-products hichew hi-chew 'hi chew'

Adding --trace will show query details, --format html+datatables is convenient to see/search/sort results in browser:

% cek-bpom-products hichew hi-chew 'hi chew' --trace --format html+datatables

HOMEPAGE

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

SOURCE

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

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 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=App-CekBpom

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.

To install App::CekBpom, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::CekBpom

CPAN shell

perl -MCPAN -e shell
install App::CekBpom

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Configuration options

Environment options

Logging options

Output options

Other options

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

ENVIRONMENT

CEK_BPOM_PRODUCTS_OPT => str

FILES

EXAMPLES

HOMEPAGE

SOURCE

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions