Rishwanth Yeddula > WWW-Codeguard-0.02 > WWW::Codeguard

Download:
WWW-Codeguard-0.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.02   Source  

NAME ^

WWW::Codeguard - Perl interface to interact with the Codeguard API

VERSION ^

Version 0.02

SYNOPSIS ^

This module provides you with an perl interface to interact with the Codeguard API. This is really just the base class that returns the proper object to use. Depending on the params you pass, it will return either the 'Partner' object, or the 'User' object.

        use WWW::Codeguard;

        my $partner_api = WWW::Codeguard->new(
                {
                        api_url => $api_url,
                        partner => {
                                partner_key => $partner_key,
                        },
                }
        );

        my $user_api = WWW::Codeguard->new(
                {
                        api_url => $api_url,
                        user => {
                                api_key       => $user_api_key,
                                api_secret    => $user_api_secret,
                                access_secret => $user_access_secret,
                                access_token  => $user_access_token,
                        },
                }
        );

Object Initialization ^

Input takes an hashref of params. The hashref should contain:

        api_url
        partner => $hashref_containing_the_partner_options
        user => $hashref_containing_the_user_options

If both 'partner' and 'user' options are specified, then you should use it an array context to get back both objects:

        my ($partner_api, $user_api) = WWW::Codeguard->new(
                {
                        api_url => $api_url,
                        partner => {
                                partner_key => $partner_key,
                        },
                        user => {
                                api_key       => $user_api_key,
                                api_secret    => $user_api_secret,
                                access_secret => $user_access_secret,
                                access_token  => $user_access_token,
                        },
                }
        );

If array context is not specified, then it will only return the partner api object even if both objects were created.

METHODS ^

Partner methods are documented in WWW::Codeguard::Partner

User methods are documented in WWW::Codeguard::User

get_error

Returns the current value in $self->{_error}.

get_api_url

Returns the current value in $self->{api_url}.

_check_params

Input: Three hashrefs that contain the following in the specified order:

        1) the hashref to the params that need to be checked.
        2) the hashref to the 'required' set of params
        3) the hashref to the 'optional' set of params

Outupt: Undef if everything is good. If errors are detected, it will return a hashref that has two arrays:

        'required_params' - which will list the required params that are missing. And
        'blank_params'    - which will list the params that have blank values specified for them.

This also 'prunes' the first hashref of params that are not specified in either the required or the optional hashrefs.

_error

Internal method that is used to report and set $self->{_error}.

Will croak if a true second argument is passed. Example:

        $self->_error($msg, 1); 

AUTHOR ^

Rishwanth Yeddula, <ryeddula at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-www-codeguard at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Codeguard. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the following perldoc commands.

    perldoc WWW::Codeguard
    perldoc WWW::Codeguard::Partner
    perldoc WWW::Codeguard::User

You can also look for information at:

ACKNOWLEDGMENTS ^

Thanks to Hostgator.com for funding the development of this module and providing test resources.

LICENSE AND COPYRIGHT ^

Copyright 2014 Rishwanth Yeddula.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

syntax highlighting: