JSAN::Index::Release - A JavaScript Archive Network (JSAN) Release
This class provides objects for a single release of a distribution by an author
In addition to the general methods provided by Class::DBI, it has the following methods
The id accessor returns the unique identifier for the release (an integer)
id
The source access returns the root-relative path within a JSAN mirror that the package can be found at.
source
The distribution method returns the JSAN::Index::Distribution for the distribution that this release is of.
distribution
The author method returns the JSAN::Index::Author for the JSAN author that uploaded the release.
author
The version accessor returns the version of the release.
version
The created accessor returns the time that the release was received and first indexed by the JSAN upload server.
created
Returns an integer in unix epoch time.
The created_string method returns the time that the release was recieved and first indexed by the JSAN upload server.
created_string
Is equivalent to scalar localtime $object->created.
scalar localtime $object->created
Returns a time as a localtime string.
The doc accessor returns the root-relative location of the documentation for this release on the http://openjsan.org/ website.
doc
The meta accessor returns the actual content of the META.yml file that came with the distribution.
meta
META.yml
The meta_data method loads and deserialises the META.yml content contained in the index (and returned by the meta method above).
meta_data
The checksum accessor returns the MD5 checksum for the release tarball.
checksum
The latest accessor returns a boolean flag indicating if the release is the most recent release of the distribution.
latest
The requires method finds the set of run-time library dependencies for this release, as identified in the META.yml data contained in the index.
requires
Returns a reference to a HASH where the key is the name of a library as a string, and the value is the version for the dependency (or zero if the dependency is not for a specific version).
The requires_libraries method returns a list of the JSAN::Index::Library dependencies as identified by the META.yml file for the release.
requires_libraries
JSAN::Index::Library
The requires_releases method returns a list of the JSAN::Index::Release dependencies based on the dependencies specified in the META.yml file for the release.
requires_releases
JSAN::Index::Release
The build_requires method finds the set of build-time library dependencies for this release, as identified in the META.yml data contained in the index.
build_requires
The build_requires_libraries method returns a list of the build-time JSAN::Index::Library dependencies as identified by the META.yml file for the release.
build_requires_libraries
The requires_releases method returns a list of the JSAN::Index::Release build-time depedencies based on those specified in the META.yml file for the release.
The file_path method returns the location on the local disk where the release tarball should be, if mirrored.
file_path
The mirror method fetches the tarball from your JSAN currently configured JSAN mirror as determined by JSAN::Transport (if not already cached).
mirror
Returns a file path to the tarball on the local machine, or may emit an exception thrown by the underlying JSAN::Transport functions.
The file_mirrored method checks to see if the release tarball has previously been downloaded to the local mirror.
file_mirrored
Returns true if the file exists in the local mirror, or false if not.
The archive method returns the release as an in-memory archive. Depending on the type, this should be either a Archive::Tar or an Archive::Zip object.
archive
Bugs should be reported via the CPAN bug tracker at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=JSAN-Client
For other issues, contact the author.
Adam Kennedy <cpan@ali.as>, http://ali.as/
JSAN::Index, JSAN::Shell, http://openjsan.org
Copyright 2005 Adam Kennedy. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
To install JSAN::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm JSAN::Client
CPAN shell
perl -MCPAN -e shell install JSAN::Client
For more information on module installation, please visit the detailed CPAN module installation guide.