Yanick Champoux > WWW-Ohloh-API-v0.3.2 > WWW::Ohloh::API::KudoScore

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::KudoScore - an Ohloh kudo score

SYNOPSIS ^

    use WWW::Ohloh::API;

    my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );
    my $account $ohloh->get_account( id => 12933 );
    my $kudo = $account->kudo_score;

    print $kudo->rank;

DESCRIPTION ^

W::O::A::KudoScore contains the kudo information associated with an Ohloh account as defined at http://www.ohloh.net/api/reference/kudo_score. To be properly populated, it must be retrieved via the kudo_score method of a WWW::Ohloh::API::Account object.

METHODS ^

API Data Accessors

created_at

Return the time at which this KudoScore was calculated.

rank, kudo_rank

Return the KudoRank, which is an integer from 1 to 10.

position

Return an integer which orders all participants. The person with `position` equals 1 is the highest-ranked person on Ohloh.

max_position

Return the total number of partcipants in the most recent KudoScore calculations. The person whose `position` equals `max_position` is the lowest-ranked person on Ohloh.

position_delta

Return the change in this person's position since the previous kudo score calculations. Here, a negative number represents an improvement, since lower positions are better.

Other Methods

as_xml

Return the kudo information as an XML string. Note that this is not the exact xml document as returned by the Ohloh server: due to the current XML parsing module used by W::O::A (to wit: XML::Simple), the ordering of the nodes can differ.

SEE ALSO ^

VERSION ^

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.

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: