/ 
WWW-AUR-0.02
River stage one • 1 direct dependent • 1 total dependent
/ WWW::AUR

NAME

WWW::AUR - API for the Archlinux User Repository website.

SYNOPSIS

use WWW::AUR;
my $aur = WWW::AUR->new( basepath => '/tmp/aurtmp' );
my $pkg = $aur->find( 'perl-www-aur' );

# download_size() can check the file size without downloading...
printf "Preparing to download source package file (%d bytes).\n",
    $pkg->download_size;

$pkg->download;
printf "Downloaded pkgfile to %s.\n", $pkg->src_pkg_path;

$pkg->extract;  # calls download() if you didn't
printf "Extracted pkgfile to %s.\n", $pkg->src_dir_path;

$pkg->build;    # calls extract()  if you didn't
printf "Built binary pkgfile and saved to %s.\n", $pkg->bin_pkg_path;

my $who = $pkg->maintainer();
printf "%s is maintained by %s.\n", $pkg->{name}, $who->name;

print "As well as the following packages:\n";
for my $otherpkg ( $who->packages ) {
    printf " - %s\n", $otherpkg->name;
}

my $login = $aur->login( 'myname', 'mypassword' )
    or die "Failed to login as myname, what a shock";

$login->vote( 'my-favorite-package' );
$login->disown( 'i-hate-this-package' );
$login->upload( '../a-new-package-file.src.pkg.tar.gz' );

print "Iterating through ALL packages...\n";
my $iter = $aur->packages;
while ( my $pkgobj = $iter->next ) {
    print "$pkgobj->{name} -- $pkgobj->{version}\n";
}

DESCRIPTION

The Archlinux User Repository is a relatively simple website that houses user-submitted packages for ArchLinux. These "source packages" merely contain what is required to build the package, unlike Archlinux's official repository which house binary packages.

This module provides an interface for the straight-forward AUR user as well as for AUR author, aka package maintainers. The goal is to be able to do anything with this module that you could with a web browser.

The WWW::AUR::Package module also allows the module user to download and build source packages using makepkg. Installation is left up to the module user and is not implemented in this module.

CONSTRUCTOR

$OBJ = WWW::AUR->new( %PATH_PARAMS );
Parameters
%PATH_PARAMS

These parameters are optional. See "PATH PARAMETERS".

Returns
$OBJ

A WWW::AUR object.

METHODS

@PACKAGES = $OBJ->search( $QUERY );
Parameters
$QUERY

A string to match package names against. The string can have regexp anchors (^ or $).

If $QUERY contains anchors then only package names that match the anchored text are returned. Other special regexp chars will be sent to the query literally. Since the AUR does not directly support regexp searches this will most likely return unexpected results.

Returns
@PACKAGES

A list of WWW::AUR::Package objects that matched the search query.

find

$PKGOBJ | undef = $OBJ->find( $NAME )
Parameters
$NAME

The exact name of a package to find.

Returns
$PKGOBJ

A WWW::AUR::Package object if one was found.

undef

If no package matching the given $NAME was found.

maintainer

$MAINOBJ | undef = $OBJ->maintainer( $NAME );
Parameters
$NAME

The name of the maintainer to find. Case-insensitive.

Returns
$MAINOBJ

A WWW::AUR::Maintainer object if a matching maintainer was found.

undef

If no matching maintainer was found.

packages

$ITEROBJ = $OBJ->packages()
Parameters

None

Returns
$ITEROBJ

A WWW::AUR::Iterator object.

login

$LOGINOBJ | undef = $OBJ->login( $USERNAME, $PASSWORD );
Parameters
$USERNAME

The maintainer name to login to the AUR with.

$PASSWORD

The password to use for logging in.

Returns
$LOGINOBJ

A WWW::AUR::Login object, if the login succeeded.

undef

If the login failed.

PATH PARAMETERS

The constructor's only parameters are for paths to use in objects. Path parameters are propogated to every WWW::AUR::Package object that is created. Package objects are created when methods such as "search" and "find".

Path parameters are also propogated to objects that create their own WWW::AUR::Package object, in turn. For example they are propogated to the WWW::AUR::Maintainer object created by "maintainer", the WWW::AUR::Login object created by "login", and the WWW::AUR::Iterator object created by "packages".

$BASEPATH

Specifies a base with which to set the dlpath, extpath, and destpath quickly. Setting the base path sets the other path parameters to paths relative to the basepath.

After the 'basepath' is set, other path parameters can still be overriden with their own parameters to new.

Defaults to /tmp/WWW-AUR.

$DLPATH

A directory to store downloaded source package files.

Defaults to $BASEPATH/src.

$EXTPATH

A directory to store source package directories. These are extracted from the source package file.

Defaults to $BASEPATH/build.

$DESTPATH

A directory to store built binary package files. Binary package files are built from the source package files by using makepkg.

Defaults to $BASEPATH/cache.

SEE ALSO

AUTHOR

Justin Davis, <juster at cpan dot org>

BUGS

Please report any bugs or feature requests to bug-www-aur at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-AUR. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

Send me an email at the above address if you have any questions or need help.

LICENSE AND COPYRIGHT

Copyright 2010 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.