NAME

MetaCPAN::Client::Author - An Author data object

VERSION

version 2.029000

SYNOPSIS

    my $author = $mcpan->author('MICKEY');

DESCRIPTION

a MetaCPAN author entity object.

ATTRIBUTES

pauseid

The author's pause id, which is a string like "MICKEY" or "XSAWYERX".

name

The author's full name, if they've provided this in their MetaCPAN profile. This may contain Unicode characters.

ascii_name

An ASCII-only version of the author's full name, if they've provided this in their MetaCPAN profile.

city

The author's city, if they've provided this in their MetaCPAN profile.

region

The author's region, if they've provided this in their MetaCPAN profile.

country

The author's country, if they've provided this in their MetaCPAN profile.

updated

An ISO8601 datetime string like "2016-11-19T12:41:46" indicating when the author last updated their MetaCPAN profile. This is always provided in UTC.

dir

The author's CPAN directory, which is something like "id/P/PE/PERLER".

gravatar_url

The author's gravatar.com user URL, if they have one. This URL is generated using PAUSEID@cpan.org.

This is an arrayref containing zero or more hashrefs. Each hashref contains two keys, "name" and "id". The known names are currently "paypal", "wishlist", and "flattr". The id will be an appropriate id or URL for the thing in question.

This may be empty if the author has not provided this information in their MetaCPAN profile.

For example:

    [
        { "name" => "paypal",   "id" => "brian.d.foy@gmail.com" },
        { "name" => "wishlist", "id" => "http://amzn.com/w/4O7IX9ZNQJR" },
    ],

email

This is an arrayref containing zero or more email addresses that the author has added to their MetaCPAN profile. Note that this does not include the "AUTHOR@cpan.org" email address that all CPAN authors have.

website

This is an arrayref of website URLs provided by the author in their MetaCPAN profile.

profile

This is an arrayref containing zero or more hashrefs. Each hashref contains two keys, "name" and "id". The names are things like "github" or "stackoverflow". The id will be an appropriate id for the site in question.

For example:

    [
        { name => "amazon",        id => "B002MRC39U"  },
        { name => "stackoverflow", id => "brian-d-foy" },
    ]

This may be empty if the author has not provided this information in their MetaCPAN profile.

perlmongers

This is an arrayref containing zero or more hashrefs. Each hashref contains two keys, "name" and "url". The names are things like "Minneapolis.pm".

This may be empty if the author has not provided this information in their MetaCPAN profile.

links

This is a hashref where the keys are a link type, and the values are URLs. The currently known keys are:

cpan_directory
The author's CPAN directory.
backpan_directory
The author's BackCPAN directory.
cpantesters_reports
The author's CPAN Testers Reports page.
cpantesters_matrix
The author's CPAN Testers matrix page.
cpants
The author's CPANTS page.
metacpan_explorer
A link to the MetaCPAN explorer site pre-populated with a request for the author's profile.

blog

This is an arrayref containing zer or more hashrefs. Each hashref contains two keys, "url" and "feed". For example:

    {
        url  => "http://blogs.perl.org/users/brian_d_foy/",
        feed => "http://blogs.perl.org/users/brian_d_foy/atom.xml",
    }

release_count

This is a hashref containing counts for various types of releases. The known keys are:

cpan
The total number of distribution uplaods the author currently has on CPAN.
latest
The total number of unique distributions the author currently has on CPAN.
backpan-only
The number of distribution uploads currently only available via BackPAN.

extra

Returns a hashref. The contents of this are entirely arbitrary and will vary by author.

METHODS

BUILDARGS

Ensures format of the input.

releases

    my $releases = $author->releases();

This method returns a MetaCPAN::Client::ResultSet of MetaCPAN::Client::Release objects. It includes all of the author's releases with the "latest" status.

metacpan_url

Returns a link to the author's page on MetaCPAN.

AUTHORS

Sawyer X <xsawyerx@cpan.org>
Mickey Nasriachi <mickey@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.