File Coverage

blib/lib/MetaCPAN/API/Favorite.pm

Criterion	Covered	Total	%
statement	25	25	100.0
branch	7	8	87.5
condition	1	3	33.3
subroutine	5	5	100.0
pod	1	1	100.0
total	39	42	92.8

use strict;
use warnings;
package MetaCPAN::API::Favorite;
# ABSTRACT: Favorite ++ information for MetaCPAN::API
$MetaCPAN::API::Favorite::VERSION = '0.44';
use Carp;
use Any::Moose 'Role';

# /favorite/_search only
sub favorite {
    my $self  = shift;
    my %opts  = @_ ? @_ : ();
    my $url   = '';
    my $error = "Only 'search' can be used here";

    %opts or croak $error;

    my %extra_opts = ();

    if ( defined ( my $search_opts = $opts{'search'} ) ) {
        ref $search_opts && ref $search_opts eq 'HASH'
            or croak $error;

        %extra_opts = %{$search_opts};
        $url        = 'favorite/_search';
    } else {
        croak $error;
    }

    return $self->fetch( $url, %extra_opts );
}

1;

__END__

=pod

=head1 NAME

MetaCPAN::API::Favorite - Favorite ++ information for MetaCPAN::API

=head1 VERSION

version 0.44

=head1 DESCRIPTION

This role provides MetaCPAN::API with fetching information about favorite
++ information.

=head1 METHODS

=head2 favorite

    # example lifted from MetaCPAN docs
    my $result = $mcpan->favorite(
        search => {
            user   => "SZABGAB",
            fields => "distribution",
            size   => 100,
        },
    );

Searches MetaCPAN for favorite ++ information.

Only complex searches are currently available.

=head1 AUTHOR

Sawyer X <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Sawyer X.

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

=cut