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

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::Account - an Ohloh account

SYNOPSIS ^

    use WWW::Ohloh::API;

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

    print $account->name;

DESCRIPTION ^

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

METHODS ^

API Data Accessors

id

Return the account's id.

name

Return the public name of the account.

created_at

Return the time at which the account was created.

updated_at

Return the last time at which the account was modified.

homepage_url

Return the URL to a member's home page, such as a blog, or undef if not configured.

avatar_url

Return the URL to the profile image displayed on Ohloh pages, or undef if not configured.

posts_count

Return the number of posts made to the Ohloh forums by this account.

location

Return a text description of this account holder's claimed location, or undef if not available.

country_code

Return a string representing the account holder's country, or undef is unavailable.

latitude, longitude

Return floating-point values representing the account's latitude and longitude, suitable for use with the Google Maps API, or undef is they are not available.

kudoScore, kudo_score, kudo

Return a WWW::Ohloh::API::KudoScore object holding the account's kudo information, or undef if the account doesn't have a kudo score yet. All three methods are equivalent.

stack( $retrieve )

Return the stack associated with the account as a WWW::Ohloh::API::Stack object.

If the optional $retrieve argument is given and false, the stack will not be queried from the Ohloh server and, if the information has not been retrieved previously, the method will return nothing.

Other Methods

as_xml

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.

OVERLOADING ^

When the object is called in a string context, it'll be replaced by the name associated with the account. E.g.,

    print $account;  # equivalent to 'print $account->name'

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: