File Coverage

blib/lib/Net/RabbitMQ/Management/API.pm

Criterion	Covered	Total	%
statement	49	234	20.9
branch	4	170	2.3
condition	4	9	44.4
subroutine	12	63	19.0
pod	51	51	100.0
total	120	527	22.7

package Net::RabbitMQ::Management::API;
{
  $Net::RabbitMQ::Management::API::VERSION = '0.01';
}

# ABSTRACT: Interface to the HTTP Rest API of the RabbitMQ management plugin

use Moo;

use Carp qw(croak);
use HTTP::Headers;
use HTTP::Request;
use JSON::Any;
use LWP::UserAgent;
use Net::RabbitMQ::Management::API::Result;
use URI;



has 'ua' => (
    builder => '_build_ua',
    is      => 'ro',
    lazy    => 1,
);


has 'username' => (
    is      => 'ro',
    default => sub {
        return 'guest';
    },
);


has 'password' => (
    is      => 'ro',
    default => sub {
        return 'guest';
    },
);


has 'url' => (
    is       => 'ro',
    required => 1,
    trigger  => sub {
        my ( $self, $uri ) = @_;
        $self->{url} = URI->new("$uri");
    },
);

has '_json' => (
    builder => '_build__json',
    is      => 'ro',
    lazy    => 1,
);


sub request {
    my ( $self, %args ) = @_;

    my $method = delete $args{method} || croak 'Missing mandatory key in parameters: method';
    my $path   = delete $args{path}   || croak 'Missing mandatory key in parameters: path';
    my $data   = delete $args{data};

    croak "Invalid method: $method" unless grep $_ eq $method, qw(DELETE GET PATCH POST PUT);

    my $uri      = $self->_uri_for($path);
    my $request  = $self->_request_for( $method, $uri, $data );
    my $response = $self->ua->request($request);

    return Net::RabbitMQ::Management::API::Result->new( response => $response );
}

sub _request_for {
    my ( $self, $method, $uri, $data ) = @_;

    my $headers = HTTP::Headers->new;

    my $request = HTTP::Request->new( $method, $uri, $headers );
    $request->authorization_basic( $self->username, $self->password );

    if ($data) {
        my $json = $self->_json->encode($data);
        $request->content($json);
    }

    $request->header( 'Content-Length' => length $request->content );
    $request->header( 'Content-Type'   => 'application/json' );

    return $request;
}

sub _uri_for {
    my ( $self, $path ) = @_;

    my $uri = $self->url->clone;

    $uri->path( $uri->path . $path );

    return $uri;
}

sub _build__json {
    my ($self) = @_;
    return JSON::Any->new;
}

sub _build_ua {
    my ($self) = @_;
    return LWP::UserAgent->new;
}


sub get_overview {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/overview',
    );
}


sub get_nodes {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/nodes',
    );
}


sub get_node {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/nodes/%s/', $args{name} ),
    );
}


sub get_extensions {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/extensions',
    );
}


sub get_configuration {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/all-configuration',
    );
}


sub update_configuration {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: users'       unless $args{users};
    croak 'Missing key in parameters: vhosts'      unless $args{vhosts};
    croak 'Missing key in parameters: permissions' unless $args{permissions};
    croak 'Missing key in parameters: queues'      unless $args{queues};
    croak 'Missing key in parameters: exchanges'   unless $args{exchanges};
    croak 'Missing key in parameters: bindings'    unless $args{bindings};

    return $self->request(
        method => 'POST',
        path   => '/all-configuration',
        data   => \%args,
    );
}


sub get_connections {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/connections',
    );
}


sub get_connection {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/connections/%s', $args{name} ),
    );
}


sub delete_connection {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/connections/%s', $args{name} ),
    );
}


sub get_channels {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/channels',
    );
}


sub get_channel {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/channels/%s', $args{name} ),
    );
}


sub get_exchanges {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/exchanges',
    );
}


sub get_exchanges_in_vhost {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/exchanges/%s', $args{vhost} ),
    );
}


sub get_exchange {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/exchanges/%s/%s', $args{vhost}, $args{name} ),
    );
}


sub create_exchange {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};
    croak 'Missing key in parameters: type'  unless $args{type};

    return $self->request(
        method => 'PUT',
        path   => sprintf( '/exchanges/%s/%s', delete $args{vhost}, delete $args{name} ),
        data   => \%args,
    );
}


sub delete_exchange {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/exchanges/%s/%s', $args{vhost}, $args{name} ),
    );
}


sub get_exchange_bindings_by_source {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/exchanges/%s/%s/bindings/source', $args{vhost}, $args{name} ),
    );
}


sub get_exchange_bindings_by_destination {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/exchanges/%s/%s/bindings/destination', $args{vhost}, $args{name} ),
    );
}


sub publish_exchange_message {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'             unless $args{name};
    croak 'Missing key in parameters: vhost'            unless $args{vhost};
    croak 'Missing key in parameters: properties'       unless $args{properties};
    croak 'Missing key in parameters: routing_key'      unless $args{routing_key};
    croak 'Missing key in parameters: payload'          unless $args{payload};
    croak 'Missing key in parameters: payload_encoding' unless $args{payload_encoding};

    return $self->request(
        method => 'POST',
        path   => sprintf( '/exchanges/%s/%s/publish', delete $args{vhost}, delete $args{name} ),
        data   => \%args,
    );
}


sub get_queues {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/queues',
    );
}


sub get_queues_in_vhost {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/queues/%s', $args{vhost} ),
    );
}


sub get_queue {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/queues/%s/%s', $args{vhost}, $args{name} ),
    );
}


sub create_queue {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'PUT',
        path   => sprintf( '/queues/%s/%s', delete $args{vhost}, delete $args{name} ),
        data   => \%args,
    );
}


sub delete_queue {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/queues/%s/%s', $args{vhost}, $args{name} ),
    );
}


sub get_queue_bindings {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/queues/%s/%s/bindings', $args{vhost}, $args{name} ),
    );
}


sub delete_queue_contents {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/queues/%s/%s/contents', $args{vhost}, $args{name} ),
    );
}


sub get_queue_messages {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'     unless $args{name};
    croak 'Missing key in parameters: vhost'    unless $args{vhost};
    croak 'Missing key in parameters: encoding' unless $args{encoding};
    croak 'Missing key in parameters: count'    unless defined $args{count};
    croak 'Missing key in parameters: requeue'  unless defined $args{requeue};

    return $self->request(
        method => 'POST',
        path   => sprintf( '/queues/%s/%s/get', delete $args{vhost}, delete $args{name} ),
        data   => \%args,
    );
}


sub get_bindings {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/bindings',
    );
}


sub get_bindings_in_vhost {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/bindings/%s', $args{vhost} ),
    );
}


sub get_bindings_between_exchange_and_queue {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost'    unless $args{vhost};
    croak 'Missing key in parameters: exchange' unless $args{exchange};
    croak 'Missing key in parameters: queue'    unless $args{queue};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/bindings/%s/e/%s/q/%s', $args{vhost}, $args{exchange}, $args{queue} ),
    );
}


sub create_bindings_between_exchange_and_queue {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost'       unless $args{vhost};
    croak 'Missing key in parameters: exchange'    unless $args{exchange};
    croak 'Missing key in parameters: queue'       unless $args{queue};

    return $self->request(
        method => 'POST',
        path   => sprintf( '/bindings/%s/e/%s/q/%s', delete $args{vhost}, delete $args{exchange}, delete $args{queue} ),
        data   => \%args,
    );
}


sub get_binding {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost'    unless $args{vhost};
    croak 'Missing key in parameters: exchange' unless $args{exchange};
    croak 'Missing key in parameters: queue'    unless $args{queue};
    croak 'Missing key in parameters: name'     unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/bindings/%s/e/%s/q/%s/%s', $args{vhost}, $args{exchange}, $args{queue}, $args{name} ),
    );
}


sub create_binding {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost'    unless $args{vhost};
    croak 'Missing key in parameters: exchange' unless $args{exchange};
    croak 'Missing key in parameters: queue'    unless $args{queue};
    croak 'Missing key in parameters: name'     unless $args{name};

    return $self->request(
        method => 'PUT',
        path   => sprintf( '/bindings/%s/e/%s/q/%s/%s', $args{vhost}, $args{exchange}, $args{queue}, $args{name} ),
    );
}


sub delete_binding {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost'    unless $args{vhost};
    croak 'Missing key in parameters: exchange' unless $args{exchange};
    croak 'Missing key in parameters: queue'    unless $args{queue};
    croak 'Missing key in parameters: name'     unless $args{name};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/bindings/%s/e/%s/q/%s/%s', $args{vhost}, $args{exchange}, $args{queue}, $args{name} ),
    );
}


sub get_vhosts {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/vhosts',
    );
}


sub get_vhost {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/vhosts/%s', $args{name} ),
    );
}


sub create_vhost {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'PUT',
        path   => sprintf( '/vhosts/%s', $args{name} ),
    );
}


sub delete_vhost {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/vhosts/%s', $args{name} ),
    );
}


sub get_vhost_permissions {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/vhosts/%s/permissions', $args{name} ),
    );
}


sub get_users {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/users',
    );
}


sub get_user {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/users/%s', $args{name} ),
    );
}


sub create_user {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};
    croak 'Missing key in parameters: tags' unless $args{tags};
    croak 'Missing key in parameters: password or password_hash' unless $args{password} or $args{password_hash};

    return $self->request(
        method => 'PUT',
        path   => sprintf( '/users/%s', delete $args{name} ),
        data   => \%args,
    );
}


sub delete_user {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/users/%s', $args{name} ),
    );
}


sub get_user_permissions {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name' unless $args{name};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/users/%s/permissions', $args{name} ),
    );
}


sub get_user_details {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/whoami',
    );
}


sub get_users_permissions {
    my ($self) = @_;

    return $self->request(
        method => 'GET',
        path   => '/permissions',
    );
}


sub get_user_vhost_permissions {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/permissions/%s/%s', $args{vhost}, $args{name} ),
    );
}


sub create_user_vhost_permissions {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'      unless $args{name};
    croak 'Missing key in parameters: vhost'     unless $args{vhost};
    croak 'Missing key in parameters: write'     unless $args{write};
    croak 'Missing key in parameters: read'      unless $args{read};
    croak 'Missing key in parameters: configure' unless $args{configure};

    return $self->request(
        method => 'PUT',
        path   => sprintf( '/permissions/%s/%s', delete $args{vhost}, delete $args{name} ),
        data   => \%args,
    );
}


sub delete_user_vhost_permissions {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: name'  unless $args{name};
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'DELETE',
        path   => sprintf( '/permissions/%s/%s', $args{vhost}, $args{name} ),
    );
}


sub vhost_aliveness_test {
    my ( $self, %args ) = @_;
    croak 'Missing key in parameters: vhost' unless $args{vhost};

    return $self->request(
        method => 'GET',
        path   => sprintf( '/aliveness-test/%s', $args{vhost} ),
    );
}

1;

__END__