/ 
Perinci-Access-HTTP-Client-0.10
River stage three • 6 direct dependents • 540 total dependents
/ Perinci::Access::HTTP::Client

NAME

Perinci::Access::HTTP::Client - Riap::HTTP client

VERSION

version 0.10

SYNOPSIS

use Perinci::Access::HTTP::Client;
my $pa = Perinci::Access::HTTP::Client->new;

## perform Riap requests

# list all functions in package
my $res = $pa->request(list => 'http://localhost:5000/api/',
                       {uri=>'/Some/Module/', type=>'function'});
# -> [200, "OK", ['/Some/Module/mult2', '/Some/Module/mult2']]

# call function
$res = $pa->request(call => 'http://localhost:5000/api/',
                    {uri=>'/Some/Module/mult2', args=>{a=>2, b=>3}});
# -> [200, "OK", 6]

# get function metadata
$res = $pa->request(meta => 'http://localhost:5000/api/',
                    {uri=>'/Foo/Bar/multn'});
# -> [200, "OK", {v=>1.1, summary=>'Multiple many numbers', ...}]

# pass HTTP credentials
my $pa = Perinci::Access::HTTP::Client->new(user => 'admin', password=>'123');
my $res = $pa->request(call => '...', {...});
# -> [200, "OK", 'result']

## parse server URL
$res = $pa->parse_url("https://cpanlists.org/api/"); # {proto=>"https", path=>"/App/cpanlists/Server/"}

DESCRIPTION

This class implements Riap::HTTP client.

This class uses Log::Any for logging.

ATTRIBUTES

  • realm => STR

    For HTTP basic authentication. Defaults to "restricted area" (this is the default realm used by Plack::Middleware::Auth::Basic).

  • user => STR

    For HTTP basic authentication. Default will be taken from environment PERINCI_HTTP_USER.

  • password => STR

    For HTTP basic authentication. Default will be taken from environment PERINCI_HTTP_PASSWORD.

METHODS

PKG->new(%attrs) => OBJ

Instantiate object. Known attributes:

  • retries => INT (default 2)

    Number of retries to do on network failure. Setting it to 0 will disable retries.

  • retry_delay => INT (default 3)

    Number of seconds to wait between retries.

  • lwp_implementor => STR

    If specified, use this class for http LWP::Protocol::implementor(). For example, to access Unix socket server instead of a normal TCP one, set this to 'LWP::Protocol::http::SocketUnix'.

  • log_level => INT (default 0 or from environment)

    Will be fed into Riap request key 'loglevel' (if >0). Note that some servers might forbid setting log level.

    If TRACE environment variable is true, default log_level will be set to 6. If DEBUG, 5. If VERBOSE, 4. If quiet, 1. Else 0.

  • log_callback => CODE

    Pass log messages from the server to this subroutine. If not specified, log messages will be "rethrown" into Log::Any logging methods (e.g. $log->warn(), $log->debug(), etc).

$pa->request($action => $server_url, \%extra_keys) => $res

Send Riap request to $server_url. Note that $server_url is the HTTP URL of Riap server. You will need to specify code entity URI via uri key in %extra_keys.

%extra_keys is optional and contains additional Riap request keys (except action, which is taken from $action).

$pa->parse_url($server_url) => HASH

ENVIRONMENT

PERINCI_HTTP_USER.

PERINCI_HTTP_PASSWORD.

FAQ

TODO

  • attr: hook/handler to pass to $ua

  • attr: use custom $ua object

SEE ALSO

Perinci::Access::HTTP::Server

Riap, Rinci

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

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