App::Wax - webify your CLI
use App::Wax; exit App::Wax->new->run(\@ARGV);
App::Wax is the helper library for wax, a command-line program which runs other command-line programs and converts their URL arguments to file paths.
App::Wax
See the wax documentation for more details.
Type: Str, rw, default: wax
wax
The application name used in debug and error messages.
Type: Bool, rw, default: false.
If set to true, the remote resource is stored to a persistent file whose path is substituted for the resource's URL on subsequent invocations of the command.
If cache and "mirror" are both set to true, an exception is thrown.
cache
Type: Str, rw, optional.
The directory to download remote resources to. If not supplied, the system's temporary directory is used.
True if "cache" or "mirror" are true, false otherwise. Used to determine which "resolve" method to use.
Type: LWP::UserAgent, rw.
The LWP::UserAgent instance used to perform network requests.
Type: Mime::Types, rw.
An instance of Mime::Types used to help determine an extension for the file.
If set to true, the remote resource is stored to a persistent file. On subsequent invocations, the resource is re-downloaded if it has been updated, and its path is substituted for the resource's URL.
If "cache" and "mirror" are both set to true, an exception is thrown.
An optional token used to mark the end of wax's options.
Type: Str, rw.
The template format string supplied as the TEMPLATE parameter to File::Temp->new().
TEMPLATE
File::Temp->new()
Type: Int, rw, default: 60.
The timeout (in seconds) for HTTP requests.
The value of the user agent's HTTP User-Agent header.
User-Agent
If set to true, diagnostic messages are printed to STDERR.
Signature: $url: Str -> $content_type: Str
Returns the value of the HTTP Content-Type header for the supplied URL e.g. text/html.
Content-Type
text/html
Signature: $message: Str -> None
Logs the message to STDERR if "verbose" is set to true.
Signature: $template: Str, @args: List[Str] -> None
Interpolates the arguments into the sprintf template and logs the message to STDERR if "verbose" is set to true.
sprintf
Signature: $url: Str, $path: Str -> Maybe[Str]
Saves the contents of the URL to the path. Returns the error message if an error ocurred.
Signature: $url: Str -> $extension: Str
Returns the file extension for the given URL (e.g. .html) if one can be determined from the resource's Content-Type header, or the path component of the URL if it's text/plain. Otherwise, returns an empty string.
.html
text/plain
Signature: $param: Str -> $components: ArrayRef[Str] | Undef
Returns a true value (a reference to an array of URL components returned by "uri_split" in URI::Split) if the supplied string is a valid absolute URL, false otherwise.
Signature: $level: Str, $message: Str -> None
Logs the message, with the level prefixed, to STDERR.
Signature: $level: Str, $template: Str, @args: List[Str] -> None
Interpolates the arguments into the sprintf template and logs the message, with the level prefixed, to STDERR.
Signature: $command: ArrayRef[Str] -> Str
Returns a string representation of the supplied command.
Signature: $url: Str -> ($path: Str, $error: Maybe[Str]): List|ArrayRef
Takes a URL and returns a list (list context) or ArrayRef (scalar context) containing the file path corresponding to the URL, and an optional error message if the download or I/O failed.
The path is returned by "resolve_keep" if "keep" is true, or "resolve_temp" otherwise.
Signature: $url: Str -> ($filename: Str, $error: Maybe[Str])
Returns the path the cached or mirrored URL should be saved to/retrieved from and an optional error message if creation of the index file (see below) failed.
resolve_keep uses an additional file to store the resource's extension. If this file can't be created, the error message is returned as the second element of the list. Otherwise, it's undef.
resolve_keep
Signature: $url: Str -> $path: Str
Returns the path of the temporary file the URL should be saved to.
Signature: $command: ArrayRef[Str] -> $exit_code: Int
Takes a command and runs it with filenames substituted for URLs. Returns the command's exit code.
None by default.
1.0.5
RT #37347
chocolateboy <chocolate@cpan.org>
Copyright (C) 2010-2015 by chocolateboy
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.1 or, at your option, any later version of Perl 5 you may have available.
To install App::Wax, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Wax
CPAN shell
perl -MCPAN -e shell install App::Wax
For more information on module installation, please visit the detailed CPAN module installation guide.