The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
WWW-AUR-0.13
River stage one • 1 direct dependent • 1 total dependent
2 ++
/ WWW::AUR::URI

NAME

WWW::AUR::URI - Generate dynamic URIs for accessing the AUR

SYNOPSIS

  use WWW::AUR::URI qw(:all);
  
  my $uri = pkgfile_uri('perl-www-aur');
  $uri = pkgbuild_uri('perl-www-aur');
  $uri = pkg_uri('SB' => 'n', 'O' => 1234, 'https' => 'YUP');
  
  # Override Scheme to use https or something...
  local $WWW::AUR::URI::Scheme = 'https';
  my $httpsuri = pkgfile_uri('perl-www-aur');
  print $httpsuri # "https://aur.archlinux.org/..."

DESCRIPTION

This is a collection of functions used internally by other modules in the WWW-AUR distribution. For advanced users only. Well... sorta.

EXPORTS

This module exports nothing by default. You must explicitly import functions or import the all tag to import all functions.

  use WWW::AUR::URI qw( pkgfile_uri pkgbuild_uri pkg_uri rpc_uri );
  use WWW::AUR::URI qw( :all );

FUNCTIONS

pkgfile_uri

  $URI = pkgfile_uri( $PKGNAME )
$PKGNAME

The name of the package.

$URI

The standard URI to the source package tarball.

pkgbuild_uri

  $URI = pkgbuild_uri( $PKGNAME )
$PKGNAME

The name of the package.

$URI

The standard URI to the conveniently extracted PKGBUILD file.

pkg_uri

  $URI = pkg_uri( %QUERY_PARAMS )

This generates a URI for the http://aur.archlinux.org/packages.php webpage. The one that shows package information and comments, etc.

%QUERY_PARAMS

You can supply whatever query parameters that you want. You might want to look at the AUR's HTML source to learn how they work.

One special parameter that acts differently is the 'https' parameter. If this key exists and its value is a truthy value, then the URI is given as an https link and not an http link. The 'https' parameter is also not passed in as a query parameter.

If the 'https' parameter is not given, then the value of the "Scheme" global package variable is used instead.

$URI

The URI to packages.php with query parameters appended.

rpc_uri

  $URI = rpc_uri( $METHOD, @ARGS )

Generates a URI for the http://aur.archlinux.org/rpc.php page.

$METHOD

The RPC "method" to use. Must be either search, info, multiinfo, or msearch.

@ARG

The RPC "arguments" to give to the "method". multiinfo is the only "method" that uses all of the arguments given. The other methods only use the first argument and ignore the rest.

$URI

The URI to the rpc.php page with query parameters in place.

PACKAGE VARIABLES

Scheme

This scalar contains the URI scheme to be inserted into all generated URIs. I suppose the only real use for this is if you want to only generate "https" URIs. The default value is "http".

Example
  # This prints a URI starting with https://
  local $WWW::AUR::URI::Scheme = 'https';
  print pkgbuild_uri('perl-www-aur'), "\n";

SEE ALSO

WWW::AUR

AUTHOR

Justin Davis, <juster at cpan dot org>

BUGS

Please email me any bugs you find. I will try to fix them as quick as I can.

SUPPORT

Send me an email if you have any questions or need help.

LICENSE AND COPYRIGHT

Copyright 2011 Justin Davis.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.