/ 
McBain-2.001000
River stage one • 3 direct dependents • 3 total dependents
/ McBain::Directly

NAME

McBain::Directly - Use a McBain API directly from Perl code.

SYNOPSIS

# if the API is object oriented
use MyAPI;

my $api = MyAPI->new;

$two_times_five = $api->call('GET:/math/multiply', { one => 2, two => 5 });

# if the API is not object oriented
use MyAPI;

$two_times_five = MyAPI->call('GET:/math/multiply', { one => 2, two => 5 });

DESCRIPTION

The McBain::Directly module is the default, and simplest McBain runner available. It allows using APIs written with McBain directly from Perl code.

When used directly, McBain APIs behave like so:

  • Return values from the API's methods are returned to the caller as is, with no formatting or processing whatsoever.

  • Exceptions are returned as is as well, in McBain's standard exception hash-ref format. This means the call() method dies when errors are encountered, so you should check for exceptions with eval, or use something like Try::Tiny.

METHODS EXPORTED TO YOUR API

None.

METHODS REQUIRED BY MCBAIN

This runner module implements the following methods required by McBain:

init( )

Does nothing here.

generate_env( $namespace, $payload )

Accepts the arguments to the call() method and creates McBain's standard $env hash-ref.

generate_res( $env, $res )

Simply returns the results as-is.

handle_exception( $err )

Simply rethrows the exception.

BUGS AND LIMITATIONS

Please report any bugs or feature requests to bug-McBain@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=McBain.

SUPPORT

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

perldoc McBain::Directly

You can also look for information at:

AUTHOR

Ido Perlmuter <ido@ido50.net>

LICENSE AND COPYRIGHT

Copyright (c) 2013-2014, Ido Perlmuter ido@ido50.net.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either version 5.8.1 or any later version. See perlartistic and perlgpl.

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

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.