Yanick Champoux > WWW-Ohloh-API > WWW::Ohloh::API::ContributorFact

Download:
WWW-Ohloh-API-v0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: v0.3.2   Source  

NAME ^

WWW::Ohloh::API::ContributorFact - Ohloh stats about a project's contributor

SYNOPSIS ^

    use WWW::Ohloh::API;

    my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );
    my $project = $ohloh->get_project( id => 12933 );
    
    my @contributors = $project->contributors;

DESCRIPTION ^

W::O::A::ContributorFact contains the information associated with a contributor to a project as defined at http://www.ohloh.net/api/reference/contributori_fact. To be properly populated, it must be created via the get_project method of a WWW::Ohloh::API object.

METHODS ^

API Data Accessors

analysis_id

Return the id of the analysis which provided the data for the contributor_fact.

contributor_id

Return the id of the contributor, which is unique within the scope of the project, but not globally.

contributor_name

Return the name used by the contrinutor when committing to the source control server.

account_id

Return the Ohloh account id of the contributor, if the contribution has been claimed. If not, return undef.

account_name

Return the account name of the contributor, if the contribution has been claimed, or undef otherwise. configured.

primary_language_id

Return the id of the language most used by the contributor.

primary_language_nice_name

Return the name of the language most used by the contributor.

comment_ratio

Return the ratio of lines committed by this contributor that are comments.

first_commit_time, last_commit_time

Return the time of the first/last commit by this contributor.

man_months

The total number of months for which this contributor made at least one commit.

commits

Return the total number of commits made by this contributor.

median_commits

Return the median number of commits by this contributor by active month.

contributor_language_facts

Return a list of WWW::Ohloh::API::ContributorLanguageFact objects containing the information pertaining to this contributor.

Other Methods

as_xml

Return the account information (including the account information and contributor language facts, if they have been retrieved) as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.

SEE ALSO ^

VERSION ^

This document describes WWW::Ohloh::API::ContributorFact version 0.3.2

BUGS AND LIMITATIONS ^

WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.

The 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 bug-www-ohloh-api@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Yanick Champoux <yanick@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2008, Yanick Champoux <yanick@cpan.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.

syntax highlighting: