File Coverage

blib/lib/Minion/Backend/API.pm

Criterion	Covered	Total	%
statement	76	78	97.4
branch	3	6	50.0
condition	10	21	47.6
subroutine	24	24	100.0
pod	21	21	100.0
total	134	150	89.3

package Minion::Backend::API;
use Mojo::Base 'Minion::Backend';

use Mojo::UserAgent;

our $VERSION = 0.01;

has 'ua';
has 'url';

sub broadcast {
    my ($self, $command, $args, $ids) = (shift, shift, shift || [], shift || []);

    my $res = $self->ua->put(
        $self->url . '/broadcast'
        => json => {
            command => $command,
            args    => $args,
            ids     => $ids
        }
    )->result;

    $self->_success($res);
}

sub dequeue {
    my ($self, $id, $wait, $options) = @_;

    # slows down
    select(undef, undef, undef, 0.5);

    my $res = $self->ua->post(
        $self->url . '/dequeue'
        => json => {
            id      => $id,
            wait    => $wait,
            options => $options,
            tasks   => [keys %{$self->minion->tasks}]
        }
    )->result;

    $self->_success($res);
}

sub enqueue {
    my ($self, $task, $args, $options) = (shift, shift, shift || [], shift || {});

    my $res = $self->ua->post(
        $self->url . '/enqueue'
        => json => {
            task    => $task,
            args    => $args,
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub fail_job {
    my ($self, $id, $retries, $result) = @_;

    my $res = $self->ua->patch(
        $self->url . '/fail-job'
        => json => {
            id      => $id,
            retries => $retries,
            result  => $result
        }
    )->result;

    $self->_success($res);
}

sub finish_job {
    my ($self, $id, $retries, $result) = @_;

    my $res = $self->ua->patch(
        $self->url . '/finish-job'
        => json => {
            id      => $id,
            retries => $retries,
            result  => $result
        }
    )->result;

    $self->_success($res);
}

sub history {
    my $self = shift;

    my $res = $self->ua->get($self->url . '/history')->result;

    $self->_success($res);
}

sub list_jobs {
    my ($self, $offset, $limit, $options) = @_;

    my $res = $self->ua->get(
        $self->url . '/list-jobs'
        => json => {
            offset  => $offset,
            limit   => $limit,
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub list_locks {
    my ($self, $offset, $limit, $options) = @_;

    my $res = $self->ua->get(
        $self->url . '/list-locks'
        => json => {
            offset  => $offset,
            limit   => $limit,
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub list_workers {
    my ($self, $offset, $limit, $options) = @_;

    my $res = $self->ua->get(
        $self->url . '/list-workers'
        => json => {
            offset  => $offset,
            limit   => $limit,
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub lock {
    my ($self, $name, $duration, $options) = (shift, shift, shift, shift // {});

    my $res = $self->ua->get(
        $self->url . '/lock'
        => json => {
            name     => $name,
            duration => $duration,
            options  => $options
        }
    )->result;

    $self->_success($res);
}

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

    my $ua = $args[1] && $args[1]->isa('Mojo::UserAgent')
           ? $args[1]
           : Mojo::UserAgent->new;

    my $url = $args[0];
    $url    =~ s/\/$//;

    return $self->SUPER::new(ua => $ua, url => $url);
}

sub note {
    my ($self, $id, $merge) = @_;

    my $res = $self->ua->patch(
        $self->url . '/note'
        => json => {
            id    => $id,
            merge => $merge
        }
    )->result;

    $self->_success($res);
}

sub receive {
    my ($self, $id) = @_;

    my $res = $self->ua->patch(
        $self->url . '/receive'
        => json => {
            id => $id
        }
    )->result;

    $self->_success($res);
}

sub register_worker {
    my ($self, $id, $options) = (shift, shift, shift || {});

    my $res = $self->ua->post(
        $self->url . '/register-worker'
        => json => {
            id      => $id,
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub remove_job {
    my ($self, $id) = @_;

    my $res = $self->ua->delete(
        $self->url . '/remove-job'
        => json => {
            id => $id
        }
    )->result;

    $self->_success($res);
}

sub repair {
    my $self = shift;

    my $res = $self->ua->post(
        $self->url . '/repair'
    )->result;

    $self->_success($res);
}

sub reset {
    my ($self, $options) = (shift, shift // {});

    my $res = $self->ua->post(
        $self->url . '/reset'
        => json => {
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub retry_job {
    my ($self, $id, $retries, $options) = (shift, shift, shift, shift || {});

    my $res = $self->ua->put(
        $self->url . '/retry-job'
        => json => {
            id      => $id,
            retries => $retries,
            options => $options
        }
    )->result;

    $self->_success($res);
}

sub stats {
    my $self = shift;

    my $res = $self->ua->get($self->url . '/stats')->result;

    $self->_success($res);
}

sub unlock {
    my ($self, $name) = @_;

    my $res = $self->ua->delete(
        $self->url . '/unlock'
        => json => {
            name => $name
        }
    )->result;

    $self->_success($res);
}

sub unregister_worker {
    my ($self, $id) = @_;

    my $res = $self->ua->delete(
        $self->url . '/unregister-worker'
        => json => {
            id => $id
        }
    )->result;

    $self->_success($res);
}

sub _success {
    my ($self, $res) = @_;

    if ($res->is_success) {
        my $data = $res->json;

        return $data->{result} || undef if $data->{success};
    }

    return;
}

1;

=encoding utf8

=head1 NAME

Minion::Backend::API - API Rest backend

=head1 SYNOPSIS

    # simple
    use Minion::Backend::API;

    my $backend = Minion::Backend::API->new('https://my-api.com');

    # using with your own Mojo::UserAgent
    use Mojo::UserAgent;
    use Minion::Backend::API;

    my $ua = Mojo::UserAgent->new;
    my $backend = Minion::Backend::API->new('https://my-api.com', $ua);

=head1 DESCRIPTION

L is a backend for L based on L.
This module need be used together with the module L,
access it to see manual.

=head1 ATTRIBUTES

L inherits all attributes from L and
implements the following new ones.

=head2 url

  my $url  = $backend->url;
  $backend = $backend->url('https://my-api.com');

=head2 ua

  my $ua   = $backend->ua;
  $backend = $backend->ua(Mojo::UserAgent->new);

=head1 SEE MORE OPTIONS

L

=head1 SEE ALSO

L, L, L, L, L.

=head1 AUTHOR

Lucas Tiago de Moraes C

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by Lucas Tiago de Moraes.

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

=cut