- SEE ALSO
- BUGS AND LIMITATIONS
- LICENCE AND COPYRIGHT
WWW::Ohloh::API::Project - an Ohloh project
use WWW::Ohloh::API; my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key ); my $project = $ohloh->get_project( id => 1001 ); print $project->homepage_url;
W::O::A::Project contains the information associated with an Ohloh project as defined at http://www.ohloh.net/api/reference/project. To be properly populated, it must be created via the
get_project method of a WWW::Ohloh::API object.
API Data Accessors
Return the project's id.
Return the name of the project.
Return the time at which the project was initially added to Ohloh.
Return the time of the most recent modification of the project's record.
Return a description of the project.
Return the URL of the project's homepage.
Return an url to a project download.
Return a URL to an IRC channel associated to the project.
Return the number of stacks currently using the project.
Return a number ranging from 1.0 to 5.0, representing the average value of all user ratings for this project, where 1 is the worst possible rating, and 5 the best.
Return the number of users having rated this project.
Return the id of the current analysis associated with the project. It'll be the latest analysis if the project has been retrieved via
get_project, and will be null if retrieved via
analysis( $id )
Return the Ohloh analysis $id (which can also be the keyword 'latest') as an WWW::Ohloh::API::Analysis object. If $id is omitted, return the previously requested analysis for this project or, if none has been requested yet, the latest analysis available for the project.
activity_facts( $analysis_id )
Return activity facts related to the project as a WWW::Ohloh::API::ActivityFacts object. The activity facts are taken from the analysis specified by $analysis_id. If
$analysis_id is not given, the previously called analysis will be used and, if no analysis has been explicitly called, the latest one will be used.
$project = $ohloh->get_project( 12345); # retrieve the project $latest = $project->activity_facts; # get the latest facts $specific = $project->activity_facts( 789 ); # get facts from analysis 789 $project->analysis( 789 ); $specific = $project->activity_facts; # equivalent to previous example
@factoids = $project->factoids;
Return the factoids associated with the project as WWW::Ohloh::API::Factoid objects.
Return the account information (including the kudo score if it applies) as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.
Factoids will be included in the xml output if they have been queried prior to the call to as_xml.
Ohloh API reference: http://www.ohloh.net/api/getting_started
Ohloh Account API reference: http://www.ohloh.net/api/reference/project
This document describes WWW::Ohloh::API version 0.3.2
BUGS AND LIMITATIONS
WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.
as_xml() method returns a re-encoding of the account data, which can differ of the original xml document sent by the Ohloh server.
Please report any bugs or feature requests to
email@example.com, or through the web interface at http://rt.cpan.org.
LICENCE AND COPYRIGHT
Copyright (c) 2008, Yanick Champoux
<firstname.lastname@example.org>. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.