NAME
WWW::PAUSE::Simple - An API for PAUSE
VERSION
This document describes version 0.457 of WWW::PAUSE::Simple (from Perl distribution WWW-PAUSE-Simple), released on 2024-02-18.
SYNOPSIS
DESCRIPTION
This module provides several functions for performing common tasks on PAUSE. There is also a CLI script pause distributed separately in App::pause.
FUNCTIONS
delete_files
Usage:
delete_files(%args) -> [$status_code, $reason, $payload, \%result_meta]Delete files.
When a file is deleted, it is not immediately deleted but has scheduled_for_deletion status for 72 hours, then deleted. During that time, the file can be undeleted.
This function is not exported by default, but exportable.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
files* => array[str]
File names/wildcard patterns.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.protect_files => array[str]
Protect some files/wildcard patterns from delete/cleanup.
retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
delete_old_releases
Usage:
delete_old_releases(%args) -> [$status_code, $reason, $payload, \%result_meta]Delete older versions of distributions.
Currently does not look for releases in subdirectories.
By default does not include developer (trial) releases. To include that, use --include-dev.
To only cleanup developer releases, you can use --include-dev and --exclude-nondev.
This function is not exported by default, but exportable.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
detail => bool
Whether to return detailed records.
exclude_dists => array[str]
Exclude specified distributions.
include_dev => bool (default: 0)
Whether to include cleaning up non-dev releases.
include_dists => array[str]
Only include specified distributions.
include_nondev => bool (default: 1)
Whether to include cleaning up non-dev releases.
num_keep => int (default: 1)
Number of new versions (including newest) to keep.
1 means to only keep the newest version, 2 means to keep the newest and the second newest, and so on.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.protect_files => array[str]
Protect some files/wildcard patterns from delete/cleanup.
retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
list_dists
Usage:
list_dists(%args) -> [$status_code, $reason, $payload, \%result_meta]List distributions.
Distribution names will be extracted from tarball/zip filenames.
Unknown/unparseable filenames will be skipped.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
detail => bool
Whether to return detailed records.
exclude_dists => array[str]
Exclude specified distributions.
include_dev => bool (default: 0)
Whether to include cleaning up non-dev releases.
include_dists => array[str]
Only include specified distributions.
include_nondev => bool (default: 1)
Whether to include cleaning up non-dev releases.
newest => bool
Only show newest non-dev version.
Dev versions will be skipped.
newest_n => int
Only show this number of newest versions.
Dev versions will be skipped.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
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)
list_files
Usage:
list_files(%args) -> [$status_code, $reason, $payload, \%result_meta]List files.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
del => bool
Only list files which are scheduled for deletion.
detail => bool
Whether to return detailed records.
files => array[str]
File names/wildcard patterns.
mtime_max => date
(No description)
mtime_min => date
(No description)
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
size_max => uint
(No description)
size_min => uint
(No description)
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
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)
list_modules
Usage:
list_modules(%args) -> [$status_code, $reason, $payload, \%result_meta]List modules (permissions).
This function is not exported.
Arguments ('*' denotes required arguments):
detail => bool
Whether to return detailed records.
modules => array[str]
Module names/wildcard patterns.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
type => str
Only list modules matching certain type.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
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)
reindex_files
Usage:
reindex_files(%args) -> [$status_code, $reason, $payload, \%result_meta]Force reindexing.
This function is not exported by default, but exportable.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
files* => array[str]
File names/wildcard patterns.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
undelete_files
Usage:
undelete_files(%args) -> [$status_code, $reason, $payload, \%result_meta]Undelete files.
When a file is deleted, it is not immediately deleted but has scheduled_for_deletion status for 72 hours, then deleted. During that time, the file can be undeleted.
This function is not exported by default, but exportable.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
files* => array[str]
File names/wildcard patterns.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
upload_files
Usage:
upload_files(%args) -> [$status_code, $reason, $payload, \%result_meta]Upload file(s).
This function is not exported.
This function supports dry-run operation.
Arguments ('*' denotes required arguments):
delay => duration
Pause a number of seconds between files.
If you upload a lot of files (e.g. 7-10 or more) at a time, the PAUSE indexer currently might choke with SQLite database locking problem and thus fail to index your releases. Giving a delay of say 2-3 minutes (120-180 seconds) between files will alleviate this problem.
files* => array[str]
File names/wildcard patterns.
password => str
PAUSE password.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.retries => int (default: 5)
Number of retries when received 5xx HTTP error from server.
The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.
subdir => str (default: "")
Subdirectory to put the file(s) into.
username => str
PAUSE ID.
If unset, default value will be searched from
~/.pause. Encrypted.pauseis not yet supported.
Special arguments:
-dry_run => bool
Pass -dry_run=>1 to enable simulation mode.
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)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/WWW-PAUSE-Simple.
SOURCE
Source repository is at https://github.com/perlancar/perl-WWW-PAUSE-Simple.
SEE ALSO
CPAN::Uploader which also does uploading from CLI.
WWW::PAUSE::CleanUpHomeDir which can clean old releases from your PAUSE account (CLI script is provided in example).
App::PAUSE::cleanup which also cleans old releases from your PAUSE account, with CLI included pause-cleanup.
https://perlancar.wordpress.com/2015/03/25/interacting-with-pause-using-cli/
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 -lIf 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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2024, 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015 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=WWW-PAUSE-Simple
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.