The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
CPAN-WWW-Top100-Retrieve-1.001
River stage zero No dependents
++
/ CPAN::WWW::Top100::Retrieve

NAME

CPAN::WWW::Top100::Retrieve - Retrieves the CPAN Top100 data from http://ali.as/top100

VERSION

  This document describes v1.001 of CPAN::WWW::Top100::Retrieve - released November 06, 2014 as part of CPAN-WWW-Top100-Retrieve.

SYNOPSIS

        #!/usr/bin/perl
        use strict; use warnings;

        use CPAN::WWW::Top100::Retrieve;
        use Data::Dumper;

        my $top100 = CPAN::WWW::Top100::Retrieve->new;
        print Dumper( $top100->list( 'heavy' ) );

DESCRIPTION

This module retrieves the data from CPAN Top100 and returns it in a structured format.

Constructor

This module uses Moose, so you can pass either a hash or hashref to the constructor. The object will cache all data relevant to the Top100 for as long as it's alive. If you want to get fresh data just make a new object and use that.

The attributes are:

debug

( not required )

A boolean value specifying debug warnings or not.

The default is: false

ua

( not required )

The LWP::UserAgent object to use in place of the default one.

The default is: LWP::UserAgent->new;

uri

( not required )

The uri of Top100 data we should use to retrieve data in place of the default one.

The default is: CPAN::WWW::Top100::Retrieve::Utils::default_top100_uri()

Methods

Currently, there is only one method: list(). You call this and get the arrayref of data back. For more information please look at the CPAN::WWW::Top100::Retrieve::Dist class. You can call list() as many times as you want, no need to re-instantiate the object for each query.

list

Takes one argument: the $type of Top100 list and returns an arrayref of dists.

WARNING: list() will return an empty list if errors happen. Please look at the error() method for the string.

Example:

        use Data::Dumper;
        print Dumper( $top100->list( 'heavy' ) );
        print Dumper( $top100->list( 'volatile' ) );

error

Returns the error string if it was set, undef if not.

SEE ALSO

Please see those modules/websites for more information related to this module.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc CPAN::WWW::Top100::Retrieve

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Email

You can email the author of this module at APOCAL at cpan.org asking for help with any problems you have.

Internet Relay Chat

You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: http://en.wikipedia.org/wiki/Internet_Relay_Chat. Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help:

  • irc.perl.org

    You can connect to the server at 'irc.perl.org' and join this channel: #perl-help then talk to this person for help: Apocalypse.

  • irc.freenode.net

    You can connect to the server at 'irc.freenode.net' and join this channel: #perl then talk to this person for help: Apocal.

  • irc.efnet.org

    You can connect to the server at 'irc.efnet.org' and join this channel: #perl then talk to this person for help: Ap0cal.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-cpan-www-top100-retrieve at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CPAN-WWW-Top100-Retrieve. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/apocalypse/perl-cpan-www-top100-retrieve

  git clone https://github.com/apocalypse/perl-cpan-www-top100-retrieve.git

AUTHOR

Apocalypse <APOCAL@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Apocalypse.

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

The full text of the license can be found in the LICENSE file included with this distribution.

DISCLAIMER OF WARRANTY

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.