File Coverage

blib/lib/cPanel/APIClient/Service/cpanel.pm

Criterion	Covered	Total	%
statement	9	15	60.0
branch	0	2	0.0
condition			n/a
subroutine	3	5	60.0
pod	1	2	50.0
total	13	24	54.1

package cPanel::APIClient::Service::cpanel;

use strict;
use warnings;

=encoding utf-8

=head1 NAME

cPanel::APIClient::Service::cpanel

=head1 SYNOPSIS

If your transport uses blocking I/O:

    my $resp = $client->call_uapi('Email', 'list_pops', \%args);

    my $pops_ar = $resp->get_data();

If your transport uses non-blocking I/O:

    my $call = $client->call_uapi('Email', 'list_pops', \%args);

    $call->promise()->then( sub {
        my ($resp) = @_;

        my $pops_ar = $resp->get_data();
    } );

Some non-blocking transports support canceling in-progress requests, thus:

    $client->cancel($call, ..);

See your transport’s documentation for more details.

=cut

#----------------------------------------------------------------------

use parent qw( cPanel::APIClient::Service );

# overridden in tests
our $_PORT = 2083;

#----------------------------------------------------------------------

=head1 METHODS

=head2 $whatsit = I->call_uapi( $MODULE, $FUNC, \%ARGS, \%METAARGS )

Calls a single UAPI call. %ARGS values should be simple scalars or arrays
thereof.

The return value depends on I’s configured transport:

=over

=item * If the transport uses blocking I/O, then the return will be a
L instance.

=item * A transport that uses non-blocking I/O can determine its own
mechanism
for returning the API call response. Some might return a promise (e.g.,
L), others a L, and still others might
return nothing and instead take a callback as a parameter. See the
individual transport’s documentation for details. Eventually, though,
a L instance should somehow be given
to indicate the API call response.

=back

=cut

sub call_uapi {
    my ( $self, $module, $func, $args_hr, $metaargs_hr ) = @_;

    die "Meta-arguments are not implemented!" if $metaargs_hr;

    require cPanel::APIClient::Request::UAPI;
    my $req = cPanel::APIClient::Request::UAPI->new( $module, $func, $args_hr, $metaargs_hr );

    return $self->{'transporter'}->request( $self, $req );
}

# undocumented for now
sub get_https_port {
    return $_PORT;
}

=head1 LICENSE

Copyright 2020 cPanel, L. L. C. All rights reserved. L

This is free software; you can redistribute it and/or modify it under the
same terms as Perl itself. See L.

=cut

1;