NAME

WebService::ReviewBoard - Perl library to talk to a review board installation thru web services.

VERSION

This document describes WebService::ReviewBoard version 0.0.1

SYNOPSIS

    use WebService::ReviewBoard;

    # pass in the name of the reviewboard url to the constructor
    my $rb = WebService::ReviewBoard->new( 'http://demo.review-board.org/' );
    $rb->login( 'username', 'password' );

    # create_review returns a WebService::ReviewBoard::Review object 
    my $review = $rb->create_review();
  

DESCRIPTION

This is an alpha release of WebService::ReviewBoard. The interface may change at any time and there are many parts of the API that are not implemented. You've been warned!

Patches welcome!

INTERFACE

create_review( $args )

Must pass in which repository to use. Using one of these (from the API documentation):

    * repository_path: The repository to create the review request against. If not specified, the DEFAULT_REPOSITORY_PATH setting will be used. If both this and repository_id are set, repository_path's value takes precedence.
    * repository_id: The ID of the repository to create the review request against. 

Example:

    my $review = $rb->create_review( [ respository_id => 1 ] );

get_review_board_url

login

DIAGNOSTICS

"you must pass WebService::ReviewBoard->new a username"

"you must pass WebService::ReviewBoard->new a password"

"create_review couldn't determine ID from this JSON that it got back from the server: %s"

"_api_post needs an LWP::UserAgent as first arg"

"No path to _api_post"

"Error fetching %s: %s"

"you must call %s as a method"

"get_review_board_url(): please first construct a WebService::ReviewBoard object"

"Need a field name at (eval 38) line 1"

I'm not sure where this error is coming from, but it seems to be when you fail to pass a repository path or id to create_review method.

CONFIGURATION AND ENVIRONMENT

None.

DEPENDENCIES

    version
    YAML::Syck
    Data::Dumper
    Bundle::LWP
    Log::Log4Perl

There are also a bunch of Test::* modules that you need if you want all the tests to pass:

    Test::More
    Test::Pod
    Test::Exception
    Test::Pod::Coverage
    Test::Perl::Critic

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-webservice-reviewboard@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Jay Buffington <jaybuffington@gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2008, Jay Buffington <jaybuffington@gmail.com>. 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.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "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 SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE 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 MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (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 SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

cpanm WebService::ReviewBoard

perl -MCPAN -e shell
install WebService::ReviewBoard