File Coverage

blib/lib/IO/Iron/IronMQ/Client.pm

Criterion	Covered	Total	%
statement	44	261	16.8
branch	0	50	0.0
condition	0	3	0.0
subroutine	16	41	39.0
pod	14	14	100.0
total	74	369	20.0

package IO::Iron::IronMQ::Client;

## no critic (Documentation::RequirePodAtEnd)
## no critic (Documentation::RequirePodSections)
## no critic (ControlStructures::ProhibitPostfixControls)
## no critic (Subroutines::RequireArgUnpacking)

use 5.010_000;
use strict;
use warnings;

# Global creator
BEGIN {
    use parent qw( IO::Iron::ClientBase );    # Inheritance
}

# Global destructor
END {
}

# ABSTRACT: IronMQ (Online Message Queue) Client.

our $VERSION = '0.14'; # VERSION: generated by DZP::OurPkgVersion

use Log::Any qw{$log};
use File::Spec;
use File::HomeDir;
use Hash::Util 0.06 qw{lock_keys lock_keys_plus unlock_keys legal_keys};
use Carp::Assert;
use Carp::Assert::More;
use English '-no_match_vars';
use Params::Validate qw(:all);

use IO::Iron::IronMQ::Api;
use IO::Iron::Common;
require IO::Iron::Connection;
require IO::Iron::IronMQ::Queue;

# CONSTANTS for this package

# DEFAULTS
use Const::Fast;

# Service specific!
const my $DEFAULT_API_VERSION => '3';
const my $DEFAULT_HOST        => 'mq-aws-us-east-1-1.iron.io';

sub new {
    my $class  = shift;
    my %params = validate(
        @_,
        {
            map { $_ => { type => SCALAR, optional => 1 }, } IO::Iron::Common::IRON_CLIENT_PARAMETERS(),    ## no critic (ValuesAndExpressions::ProhibitCommaSeparatedStatements)
        }
    );

    $log->tracef( 'Entering new(%s, %s)', $class, \%params );
    my $self = IO::Iron::ClientBase->new();

    # Add more keys to the self hash.
    my @self_keys = (
        'queues',    # References to all objects created of class IO::Iron::IronMQ::Queue.
        legal_keys( %{$self} ),
    );
    unlock_keys( %{$self} );
    lock_keys_plus( %{$self}, @self_keys );
    my $config = IO::Iron::Common::get_config(%params);
    $log->debugf( 'The config: %s', $config );
    $self->{'project_id'} = defined $config->{'project_id'} ? $config->{'project_id'} : undef;
    $self->{'queues'}     = [];
    assert_nonblank( $self->{'project_id'}, 'self->{project_id} is not defined or is blank' );

    unlock_keys( %{$self} );
    bless $self, $class;
    lock_keys( %{$self}, @self_keys );

    # Set up the connection client
    my $connection = IO::Iron::Connection->new(
        {
            'project_id'  => $config->{'project_id'},
            'token'       => $config->{'token'},
            'host'        => defined $config->{'host'} ? $config->{'host'} : $DEFAULT_HOST,
            'protocol'    => $config->{'protocol'},
            'port'        => $config->{'port'},
            'api_version' => defined $config->{'api_version'} ? $config->{'api_version'} : $DEFAULT_API_VERSION,
            'timeout'     => $config->{'timeout'},
            'connector'   => $params{'connector'},
        }
    );
    $self->{'connection'} = $connection;
    $log->debugf(
        'IronMQ Connection created with config: (project_id=%s; token=%s; host=%s; timeout=%s).',
        $config->{'project_id'},
        $config->{'token'}, $config->{'host'}, $config->{'timeout'}
    );
    $log->tracef( 'Exiting new: %s', $self );
    return $self;
}

sub get_queue {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name' => { type => SCALAR, },    # queue name.
        }
    );
    $log->tracef( 'Entering get_queue(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my ( $http_status_code, $response_message ) =
      $connection->perform_iron_action( IO::Iron::IronMQ::Api::IRONMQ_GET_QUEUE_INFO(), { '{Queue Name}' => $params{'name'}, } );
    $self->{'last_http_status_code'} = $http_status_code;
    my $new_queue      = $response_message->{'queue'};
    my $get_queue_name = $new_queue->{'name'};
    my $queue          = IO::Iron::IronMQ::Queue->new(
        {
            'ironmq_client' => $self,             # Pass a reference to the parent object.
            'name'          => $get_queue_name,
            'connection'    => $connection,
        }
    );
    $log->debugf( 'Created a new IO::Iron::IronMQ::Queue object (queue name=%s.', $get_queue_name );
    $log->tracef( 'Exiting get_queue: %s', $queue );
    return $queue;
}

sub get_queues {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'prefix' => { type => SCALAR, optional => 1, },
        }
    );
    $log->tracef('Entering get_queues()');

    my $previous = q{};
    my @queue_names;
    while ( my @names = $self->list_queues( 'per_page' => 30, 'previous' => $previous ) ) {
        push @queue_names, @names;
        $previous = $names[-1];
    }
    $log->debugf( 'Got a list of %d queue names.', scalar @queue_names );

    my @queues;
    foreach my $queue_name (@queue_names) {
        push @queues, $self->get_queue( 'name' => $queue_name );
    }

    $log->tracef( 'Exiting get_queues: %s', \@queues );
    return @queues;
}

sub create_and_get_queue {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name' => {
                type      => SCALAR,
                callbacks => {
                    'RFC 3986 reserved character check' => sub { return !IO::Iron::Common::contains_rfc_3986_res_chars(shift) },
                }
            },    # queue name.
            'message_timeout'    => { type => SCALAR, optional => 1, },
            'message_expiration' => { type => SCALAR, optional => 1, },
            'type'               => {
                type     => SCALAR,
                optional => 1,
                regex    => qr/^(?:multicast|unicast|pull)$/msx,    ## no critic (Variables::ProhibitPunctuationVars)
            },
            'push'        => { type => HASHREF, optional => 1, },
            'dead_letter' => { type => HASHREF, optional => 1, },
        }
    );
    $log->tracef( 'Entering create_queue(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'message_timeout'}    = $params{'message_timeout'}    if ( $params{'message_timeout'} );
    $item_body{'message_expiration'} = $params{'message_expiration'} if ( $params{'message_expiration'} );
    $item_body{'type'}               = $params{'type'}               if ( $params{'type'} );
    $item_body{'push'}               = $params{'push'}               if ( $params{'push'} );
    $item_body{'dead_letter'}        = $params{'dead_letter'}        if ( $params{'dead_letter'} );
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_CREATE_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;
    my $queue = IO::Iron::IronMQ::Queue->new(
        {
            'ironmq_client' => $self,             # Pass a reference to the parent object.
            'connection'    => $connection,
            'name'          => $params{'name'},
        }
    );
    $log->debugf( 'Created a new IO::Iron::IronMQ::Queue object (queue name=%s).', $queue->name() );
    $log->tracef( 'Exiting create_queue: %s', $queue );
    return $queue;
}

sub create_queue {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name' => {
                type      => SCALAR,
                callbacks => {
                    'RFC 3986 reserved character check' => sub { return !IO::Iron::Common::contains_rfc_3986_res_chars(shift) },
                }
            },    # queue name.
            'message_timeout'    => { type => SCALAR, optional => 1, },
            'message_expiration' => { type => SCALAR, optional => 1, },
            'type'               => {
                type     => SCALAR,
                optional => 1,
                regex    => qr/^(?:multicast|unicast|pull)$/msx,    ## no critic (Variables::ProhibitPunctuationVars)
            },
            'push'        => { type => HASHREF, optional => 1, },
            'dead_letter' => { type => HASHREF, optional => 1, },
        }
    );
    $log->tracef( 'Entering create_queue(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'message_timeout'}    = $params{'message_timeout'}    if ( $params{'message_timeout'} );
    $item_body{'message_expiration'} = $params{'message_expiration'} if ( $params{'message_expiration'} );
    $item_body{'type'}               = $params{'type'}               if ( $params{'type'} );
    $item_body{'push'}               = $params{'push'}               if ( $params{'push'} );
    $item_body{'dead_letter'}        = $params{'dead_letter'}        if ( $params{'dead_letter'} );
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_CREATE_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;
    $log->tracef( 'Exiting create_queue: %s', undef );
    return;
}

sub get_queue_info {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name' => { type => SCALAR, },    # queue name.
        }
    );
    $log->tracef( 'Entering get_queue_info(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my ( $http_status_code, $response_message ) =
      $connection->perform_iron_action( IO::Iron::IronMQ::Api::IRONMQ_GET_QUEUE_INFO(), { '{Queue Name}' => $params{'name'}, } );
    $self->{'last_http_status_code'} = $http_status_code;
    my $info = $response_message;

    # {"id":"51be[...]","name":"Log_Test_Queue","size":0,"total_messages":3,"project_id":"51bd[...]"}
    $log->debugf( 'Returned info about queue %s.', $params{'name'} );
    $log->tracef( 'Exiting get_queue_info: %s', $info );
    return $info;
}

sub update_queue {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name' => {
                type      => SCALAR,
                callbacks => {
                    'RFC 3986 reserved character check' => sub { return !IO::Iron::Common::contains_rfc_3986_res_chars(shift) },
                }
            },    # queue name.
            'message_timeout'    => { type => SCALAR,  optional => 1, },
            'message_expiration' => { type => SCALAR,  optional => 1, },
            'push'               => { type => HASHREF, optional => 1, },
            'dead_letter'        => { type => HASHREF, optional => 1, },
        }
    );
    $log->tracef( 'Entering update_queue(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'message_timeout'}    = $params{'message_timeout'}    if ( $params{'message_timeout'} );
    $item_body{'message_expiration'} = $params{'message_expiration'} if ( $params{'message_expiration'} );
    $item_body{'push'}               = $params{'push'}               if ( $params{'push'} );
    $item_body{'dead_letter'}        = $params{'dead_letter'}        if ( $params{'dead_letter'} );
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_UPDATE_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;
    $log->tracef( 'Exiting update_queue: %s', undef );
    return;
}

sub delete_queue {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name' => {
                type      => SCALAR,
                callbacks => {
                    'RFC 3986 reserved character check' => sub { return !IO::Iron::Common::contains_rfc_3986_res_chars(shift) },
                    'Is longer than zero characters'    => sub { return length shift },
                }
            },    # queue name.
        }
    );
    $log->tracef( 'Entering delete_queue(%s)', \%params );

    my $connection = $self->{'connection'};
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_DELETE_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;
    $log->debugf( 'Deleted queue (queue name=%s).', $params{'name'} );
    $log->tracef( 'Exiting delete_queue: %d', undef );
    return;
}

sub list_queues {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'per_page' => {
                type     => SCALAR,
                optional => 0,
                regex    => qr/^[[:digit:]]{1,}$/msx,    ## no critic (Variables::ProhibitPunctuationVars)
            },
            'previous' => { type => SCALAR, optional => 0, },    # Can be empty string.
            'prefix'   => { type => SCALAR, optional => 1, },
        }
    );
    $log->tracef('Entering list_queues()');

    my @queues;
    my $connection = $self->{'connection'};
    my %query_params;
    $query_params{'{per_page}'} = $params{'per_page'} if $params{'per_page'};
    $query_params{'{previous}'} = $params{'previous'} if $params{'previous'};
    $query_params{'{prefix}'}   = $params{'prefix'}   if $params{'prefix'};
    my ( $http_status_code, $response_message ) =
      $connection->perform_iron_action( IO::Iron::IronMQ::Api::IRONMQ_LIST_QUEUES(), {%query_params} );
    $self->{'last_http_status_code'} = $http_status_code;

    foreach my $queue_info ( @{ $response_message->{'queues'} } ) {
        my $queue_name = $queue_info->{'name'};
        push @queues, $queue_name;
    }

    $log->tracef( 'Exiting list_queues: %s', \@queues );
    return @queues;
}

sub add_subscribers {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name'        => { type => SCALAR, },                  # queue name.
            'subscribers' => { type => ARRAYREF, optional => 1 }
            ,    # array of subscriber hashes containing a required "url" field and an optional "headers" map for custom headers.
        }
    );
    $log->tracef( 'Entering add_subscribers(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'subscribers'} = $params{'subscribers'} if ( $params{'subscribers'} );
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_ADD_SUBSCRIBERS_TO_A_MESSAGE_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;

    $log->tracef( 'Exiting add_subscribers: %d', 1 );
    return 1;
}

# TODO Inform bug in documentation: does not return the queue info, returns: "{msg => 'Updated'}".

sub delete_subscribers {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name'        => { type => SCALAR, },                  # queue name.
            'subscribers' => { type => ARRAYREF, optional => 1 }
            ,    # array of subscriber hashes containing a required "url" field and an optional "headers" map for custom headers.
        }
    );
    $log->tracef( 'Entering delete_subscribers(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'subscribers'} = $params{'subscribers'} if ( $params{'subscribers'} );
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_DELETE_SUBSCRIBERS_FROM_A_MESSAGE_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;

    $log->debugf( 'Deleted subscribers (queue name=%s).', $params{'name'} );
    $log->tracef( 'Exiting delete_subscribers: %d', 1 );
    return 1;
}

sub add_alerts {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name'   => { type => SCALAR, },    # queue name.
            'alerts' => {
                type      => ARRAYREF,
                callbacks => {
                    'Assert item content' => sub {
                        foreach my $alert ( @{ $_[0] } ) {

                            # TODO New function: Carp::Assert::More::assert_allowed(). Allowed keys in hash.
                            assert_exists(
                                $alert,
                                [ 'type', 'queue', 'trigger' ],
                                'Hash alert contains keys \'type\', \'queue\' and \'trigger\'.'
                            );
                        }
                        return 1;
                    }
                }
            }, # An array of alert hashes containing required "type", "queue", "trigger", and optional "direction", "snooze" fields. Maximum number of alerts is 5.
        }
    );
    $log->tracef( 'Entering add_alerts(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'alerts'} = $params{'alerts'};
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_ADD_ALERTS_TO_A_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;

    $log->tracef( 'Exiting add_alerts: %d', 1 );
    return 1;
}

sub replace_alerts {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name'   => { type => SCALAR, },    # queue name.
            'alerts' => {
                type      => ARRAYREF,
                callbacks => {
                    'Assert item content' => sub {
                        foreach my $alert ( @{ $_[0] } ) {
                            assert_exists(
                                $alert,
                                [ 'type', 'queue', 'trigger' ],
                                'Hash alert contains keys \'type\', \'queue\' and \'trigger\'.'
                            );
                        }
                        return 1;
                    }
                }
            }, # An array of alert hashes containing required "type", "queue", "trigger", and optional "direction", "snooze" fields. Maximum number of alerts is 5.
        }
    );
    $log->tracef( 'Entering replace_alerts(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );

    my $connection = $self->{'connection'};
    my %item_body;
    $item_body{'alerts'} = $params{'alerts'};
    my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
        IO::Iron::IronMQ::Api::IRONMQ_REPLACE_ALERTS_ON_A_QUEUE(),
        {
            '{Queue Name}' => $params{'name'},
            'body'         => \%item_body,
        }
    );
    $self->{'last_http_status_code'} = $http_status_code;

    $log->tracef( 'Exiting replace_alerts: %d', 1 );
    return 1;
}

sub delete_alerts {
    my $self   = shift;
    my %params = validate(
        @_,
        {
            'name'   => { type => SCALAR, },    # queue name.
            'alerts' => {
                type      => ARRAYREF,
                optional  => 1,
                callbacks => {
                    'Either parameter \'alerts\' or \'id\'' => sub {
                        return exists $_[1]->{'id'} ? 0 : 1;
                    },
                    'Assert item content' => sub {
                        foreach my $alert ( @{ $_[0] } ) {
                            assert_exists( $alert, ['id'], 'Hash alert contains key \'id\'.' );
                        }
                        return 1;
                    }
                },
            },    # An array of alerts hashes containing "id" field.
            'id' => {
                type      => SCALAR,
                optional  => 1,
                callbacks => {
                    'Either parameter \'alerts\' or \'id\'' => sub {
                        return exists $_[1]->{'alerts'} ? 0 : 1;
                    },
                },
            },    # alert id.
                  # TODO New function: Params::Validate::validate(), mutually exclusive parameters.
        }
    );
    $log->tracef( 'Entering delete_alerts(%s)', \%params );
    assert_nonblank( $params{'name'}, 'Parameter \'name\' is a non blank string' );
    assert( $params{'alerts'} || $params{'id'}, 'Have either parameter \'alerts\' or \'id\'.' );

    my $connection = $self->{'connection'};
    if ( $params{'alerts'} ) {
        my %item_body;
        $item_body{'alerts'} = $params{'alerts'};
        my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
            IO::Iron::IronMQ::Api::IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE(),
            {
                '{Queue Name}' => $params{'name'},
                'body'         => \%item_body,
            }
        );
        $self->{'last_http_status_code'} = $http_status_code;
    }
    else {
        my ( $http_status_code, $response_message ) = $connection->perform_iron_action(
            IO::Iron::IronMQ::Api::IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE_BY_ID(),
            {
                '{Queue Name}' => $params{'name'},
                '{Alert ID}'   => $params{'id'},
            }
        );
        $self->{'last_http_status_code'} = $http_status_code;
    }

    $log->debugf( 'Deleted alerts (queue name=%s).', $params{'name'} );
    $log->tracef( 'Exiting delete_alerts: %d', 1 );
    return 1;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

IO::Iron::IronMQ::Client - IronMQ (Online Message Queue) Client.

=head1 VERSION

version 0.14

=head1 SYNOPSIS

    require IO::Iron::IronMQ::Client;

    my $iron_mq_client = IO::Iron::IronMQ::Client->new();
    my $iron_mq_queue_new = $iron_mq_client->create_queue('name' => 'My_Message_Queue');
    # Or get an existing queue.
    my $iron_mq_queue = $iron_mq_client->get_queue('name' => 'My_Message_Queue');
    my $queue_info = $iron_mq_client->get_queue_info('name' => 'My_Message_Queue');
    my $iron_mq_msg_send = IO::Iron::IronMQ::Message->new(
        'body' => "My message",
        );
    my $msg_send_id = $iron_mq_queue->post_messages('messages' => [ $iron_mq_msg_send ]);
    my $iron_mq_msg_peek = $iron_mq_queue->peek();
    my @iron_mq_msgs_pull = $iron_mq_queue->reserve_messages( n => 1 );
    my $pulled_msg_body = $iron_mq_msgs_pull[0]->body();
    my $delete_ret = $iron_mq_queue->delete( 'ids' => [ $iron_mq_msgs_pull[0]->id() ]);
    my $cleared = $iron_mq_queue->clear();
    my $queue_deleted = $iron_mq_client->delete_queue('name' => 'My_Message_Queue');

=head1 DESCRIPTION

IO::Iron::IronMQ is a client for the IronMQ message queue at L<http://www.iron.io/|http://www.iron.io/>.
IronMQ is a cloud based message queue with a REST API.
IO::Iron::IronMQ creates a Perl object for interacting with IronMQ.
All IronMQ functions are available.

The class IO::Iron::IronMQ::Client instantiates the 'project', IronMQ access configuration.

=head2 IronMQ Message Queue

L<http://www.iron.io/|http://www.iron.io/>

IronMQ is a message queue as a service available to Internet connecting
applications via its REST interface. Built with distributed
cloud applications in mind, it provides on-demand message
queuing with HTTPS transport, one-time FIFO delivery, message persistence,
and cloud-optimized performance. [see L<http://www.iron.io/|http://www.iron.io/>]

=head2 Using the IronMQ Client Library

IO::Iron::IronMQ::Client is a normal Perl package meant to be used as an object.

    require IO::Iron::IronMQ::Client;
    my $iron_mq_client = IO::Iron::IronMQ::Client->new( { } );

The following parameters can be given to new() as items in the first parameter which is a hash.

=over 8

=item project_id,        The ID of the project to use for requests.

=item token,             The OAuth token that is used to authenticate requests.

=item host,              The domain name the API can be located at. E.g. 'mq-aws-us-east-1.iron.io/1'.

=item protocol,          The protocol that will be used to communicate with the API. Defaults to "https".

=item port,              The port to connect to the API through. Defaults to 443.

=item api_version,       The version of the API to connect through. Defaults to the version supported by the client.

=item timeout,           REST client timeout (for REST calls accessing IronMQ.)

=item config,            Config filename with path if required.

=back

You can also give the parameters in the config file F<.iron.json>
(in home dir) or
F<iron.json> (in current dir) or as environmental variables. Please read
L<http://dev.iron.io/mq/reference/configuration/|http://dev.iron.io/mq/reference/configuration/>
for further details.

After creating the client, the client can create a new message queue, get,
modify or delete an old one or get all the existing message queues within
the same project.

The client has all the methods which interact with
queues; the queue (object of IO::Iron::IronMQ::Queue) has methods which involve
messages.

If failed, the methods cause exception. After successfull REST API call,
the HTTP return code can be retrieved with method
last_http_status_code().

    # Create a new queue. (Parameter queue name;
    # return an IO::Iron::IronMQ::Queue object)
    my $iron_mq_queue = $iron_mq_client->create_and_get_queue(
            'name' => 'My_Message_Queue',
    );

    # Get an existing queue. (Parameter queue name;
    # return an IO::Iron::IronMQ::Queue object)
    my $iron_mq_queue = $iron_mq_client->get_queue( 'name' => 'My_Message_Queue');

    # Delete an existing queue. (Parameter queue name;
    # return undef)
    $iron_mq_client->delete_queue( 'name' => 'My_Message_Queue');

    # Get all the queues.
    # Return a list of IO::Iron::IronMQ::Queue objects.
    my @iron_mq_queues = $iron_mq_client->get_queues();

    # Get info about the queue
    # (Return a hash containing items name, id, size, project, etc.).
    my $queue_info = $iron_mq_client->get_queue_info( 'name' => 'My_Message_Queue');

A IO::Iron::IronMQ::Queue object gives access to a single message queue.
With it you can do all the normal things one would with a message queue.

Messages are objects of the class IO::Iron::IronMQ::Message. It contains
the following attributes:

=over 8

=item - body, Free text. If you want to put an object or a hash here, it needs to be serialized first; use e.g. JSON, Storable or YAML to stringify it. Then give the resulting string here.

=item - delay, The item will not be available on the queue until this many seconds have passed.

=item - push_headersn, Headers for push queues.

=item - id, Message id from IronMQ (available after message has been pulled/peeked).

=item - reserved_count, Not yet implemented. (available after message has been pulled/peeked).

=item - reservation_id, Reservation id string from the queue.

=back

	my $iron_mq_msg_send_01 = IO::Iron::IronMQ::Message->new(
			'body' => "My message",
			);
	# Or
	use YAML::Tiny;
	%msg_body_hash_02 = (msg_body_text => 'My message 2', msg_body_item => {sub_item => 'Sub text'});
	my $yaml = YAML::Tiny->new(); $yaml->[0] = \%msg_body_hash_02;
	my $msg_body = $yaml->write_string();
	my $iron_mq_msg_send_02 = IO::Iron::IronMQ::Message->new(
			'body' => $msg_body,
			'delay' => $msg_delay,	 # The item will not be available on the queue until this many seconds have passed.
			);
	# Return YAML serialized structure:
	my $yaml_de = YAML::Tiny->new(); $yaml_de = $yaml_de->read_string($iron_mq_msg_send_02->body());

IO::Iron::IronMQ::Queue objects are created by the client IO::Iron::IronMQ::Client.
With an IO::Iron::IronMQ::Queue object you can push messages to the queue,
or pull messages from it. The names push and pull are used because the
queue is likened to a pipe. The queue is like a FIFO pipe (first in, first out).

Get queue name.

	my $queue_name = $iron_mq_queue->name();

Add one or more messages to the queue. Returns the ids of the messages sent
or the number of sent messages.

	my $msg_send_id = $iron_mq_queue->post_messages( 'messages' => [ $iron_mq_msg_send_01 ] );
	my @msg_send_ids = $iron_mq_queue->post_messages( 'messages' => [ $iron_mq_msg_send_01, $iron_mq_msg_send_02 ] );
	my $number_of_msgs_sent = $iron_mq_queue->post_messages( 'messages' => [ $iron_mq_msg_send_01, $iron_mq_msg_send_02 ] );

Read one or more messages from the queue and reserve them so another process
cannot access them. Parameters: n (number of messages you want, default 1,
maximum 100; if there is less, all available messages will be returned),
if no messages, an empty list will be returned,
timeout (After timeout (in seconds), item will be placed back onto queue,
default is 60 seconds, minimum is 30 seconds, and maximum is 86,400 seconds (24 hours)).

	my @iron_mq_msg_pulls = $iron_mq_queue->reserve_messages( n => 10, timeout => 120 );

Read one or more messages from the queue but don't reserve them.
Parameters: n (number of messages you want, default 1, maximum 100; if there
is less, all available messages will be returned),
if no messages, an empty list will be returned.

	my @iron_mq_msg_peeks = $iron_mq_queue->peek( n => 10 );

Delete one or more messages from the queue. Call this when you have
processed the messages. Returns the ids of the messages deleted
or the number of deleted messages.

	my $deleted_msg_id = $iron_mq_queue->delete( 'ids' => [ $msg_id_01 ] );
	my @deleted_msg_ids = $iron_mq_queue->delete( 'ids' => [ $msg_id_01, $msg_id_02 ] );
	my $number_of_msgs_deleted = $iron_mq_queue->delete( 'ids' => [ $msg_id_01, $msg_id_02 ] );

Release one or more messages back to the queue.
Releasing a reserved message unreserves the message and puts
it back on the queue as if the message had timed out.
Delay: The item will not be available on the queue until this
many seconds have passed. Default is 0 seconds.
Maximum is 604,800 seconds (7 days).

Returns 1.

	my $released_msg = $iron_mq_queue->release( 'id' => $msg_id_01, 'delay' => $delay );

Touch one or more messages in the queue. Touching a reserved message extends
its timeout to the duration specified when the message was created.
Default is 60 seconds.
Returns 1.

	my $touched_msg = $iron_mq_queue->touch_message( 'id' => $msg_id_01 );

Clear all messages from the queue: delete all messages,
whether they are reserved or not.

	my $cleared = $iron_mq_queue->clear_messages();

Get queue size.

	my $size = $iron_mq_queue->size();

=head3 Push Queue Commands

Get push status for a message. Retrieve the push status for a
particular message which will let you know which subscribers
have received the message, which have failed, how many times
it's tried to be delivered and the status code returned from
the endpoint.

	my $info = $iron_mq_queue->get_push_statuses( 'id' => $msg_id );
	my @subscribers = (@{info->{'subscribers'}});

Acknowledge / Delete Push Message for a Subscriber.
This is only for use with long running processes that have
previously returned a 202.

	my $info = $iron_mq_queue->get_push_statuses( 'id' => $msg_id );
	my @subscribers = (@{info->{'subscribers'}});
	my $push_acknowledged = $iron_mq_queue->delete_push_message(
		'id' => $msg_id, 'subscriber' => $subscribers[0]->{'id'}
		);

Add Subscribers to a Queue.

	my $add_ret_val = $iron_mq_queue->add_subscribers(
			'name' => $queue_name,
			'subscribers' => [
				{ 'url' => "ironmq://project_id:token\@host/queue_name" },
				{ 'url' => "ironmq:///$queue_name_02" },
			],
		);

Remove Subscribers from a Queue

	my $del_ret_val = $iron_mq_client->delete_subscribers(
			'name' => $queue_name,
			'subscribers' => [
				{ 'url' => "ironmq:///$queue_name" },
			],
		);

=head3 Queue Alerts

Add Alerts to a Queue. This is for Pull Queue only.

	my $alert_added = $iron_mq_client->add_alerts(
		'name' => $normal_queue->name(),
		'alerts' => [
				{
					'type' => 'fixed',
					'queue' => $alert_queue->name(),
					'trigger' => 1,
					'direction' => 'asc',
					'snooze' => 0,
				}
			],
		);

Replace alerts. Change the existing alerts to the given ones.

	my $alert_replaced = $iron_mq_client->replace_alerts(
		'name' => $normal_queue->name(),
		'alerts' => [
				{
					'type' => 'fixed',
					'queue' => $alert_queue->name(),
					'trigger' => 2,
					'direction' => 'desc',
					'snooze' => 0,
				},
				{
					'type' => 'fixed',
					'queue' => $alert_queue->name(),
					'trigger' => 5,
					'direction' => 'desc',
					'snooze' => 5,
				},
			],
		);

Delete alerts. You can either give an array containing items (hashes)
which contain key 'id', or delete only one alert with the parameter 'id'.

	my $alert_deleted = $iron_mq_client->delete_alerts(
		'name' => $normal_queue->name(),
		'alerts' => [
				{ 'id' => $alert_id, },
			],
		);

Or:

	$alert_deleted = $iron_mq_client->delete_alerts(
		'name' => $normal_queue->name(),
		'id' => $alert_id,
		);

=head3 Exceptions

A REST call to IronMQ server may fail for several reason.
All failures generate an exception using the L<Exception::Class|Exception::Class> package.
Class IronHTTPCallException contains the field status_code, response_message and error.
Error is formatted as such: IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>.

	use Try::Tiny;
	use Scalar::Util qw{blessed};
	try {
		my $queried_iron_mq_queue_01 = $iron_mq_client->get_queue($unique_queue_name_01);
	}
	catch {
		die $_ unless blessed $_ && $_->can('rethrow');
		if ( $_->isa('IronHTTPCallException') ) {
			if ($_->status_code == 404) {
				print "Bad things! Can not just find the catch in this!\n";
			}
		}
		else {
			$_->rethrow; # Push the error upwards.
		}
	};

=for stopwords IronMQ API HTTPS optimized OAuth https config Config filename

=for stopwords json dir successfull serialized JSON Storable YAML stringify

=for stopwords unreserves IronHTTPCallException Params succcessful Iron.io

=for stopwords Mikko Koivunalho perldoc CPAN AnnoCPAN ACKNOWLEDGMENTS

=for stopwords TODO semafores tradename licensable MERCHANTABILITY

=for stopwords lexicographically

=head1 REQUIREMENTS

See L<IO::Iron|IO::Iron> for requirements.

=head1 SUBROUTINES/METHODS

=head2 new

Creator function.

=head2 get_queue

Return a IO::Iron::IronMQ::Queue object representing
a particular message queue.

=over 8

=item Params: queue name. Queue must exist. If not, fails with an exception.

=item Return: IO::Iron::IronMQ::Queue object.

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 get_queues

Return a IO::Iron::IronMQ::Queue objects representing message queues.
Not paginated; you get all the queues! Heavy because every queue must
separately be queried in IronMQ v3.

=over 8

=item Params: prefix

=item Return: List of IO::Iron::IronMQ::Queue objects.

=back

=head2 create_and_get_queue

Return a IO::Iron::IronMQ::Queue object. Throws if fails.
Combines create_queue() and get_queue() (which hides get_queue_info()).

URL format for subscribers to Iron.io systems:
[ironmq_or_ironworker]://[project_id:token]@[host]/queue_or_worker_name

=over 8

=item Params: name, message_timeout, message_expiration, type, push { subscribers, retries, retries_delay, error_queue }, dead_letter { queue_name, max_reservations }.

=item Return: IO::Iron::IronMQ::Queue object.

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 create_queue

Return nothing. Throws if fails.

URL format for subscribers to Iron.io systems:
[ironmq_or_ironworker]://[project_id:token]@[host]/queue_or_worker_name

=over 8

=item Params: name, message_timeout, message_expiration, type, push { subscribers, retries, retries_delay, error_queue }, dead_letter { queue_name, max_reservations }.

=item Return: undefined.

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 get_queue_info

=over 8

=item Params: queue name.

=item Return: a hash containing info about queue.

=back

=head2 update_queue

Update a queue. Return nothing. Throw if fails.

=over 8

=item Params: name, subscribers, push_type, retries, retries_delay, error_queue.

=item Return: undefined.

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 delete_queue

Delete an IronMQ queue. Return undefined. Throw if fails.

=over 8

=item Params: queue name. Queue must exist. If not, fails with an exception.

=item Return: undefined.

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 list_queues

Return a list of queue names.

Paginated with per_page and previous
(this is the last queue on the previous page, it will start from the next one.
If queue with specified name does not exist result will contain
first per_page queues that lexicographically greater than previous).

=over 8

=item Params: per_page, previous, prefix.

=item Return: List.

=back

=head2 add_subscribers

Add subscribers to a push queue.

=over 8

=item Params: name, subscribers.

=item Returns 1 if succcessful

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 delete_subscribers

Delete the given subscribers from the queue.

=over 8

=item Params: name, subscribers.

=item Returns 1 if succcessful

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 add_alerts

Add alerts to a queue.

=over 8

=item Params: name, alerts.

=item Returns 1 if succcessful

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 replace_alerts

Replace alerts to a queue. Replace the old alerts (if any) with these new ones.

=over 8

=item Params: name, alerts.

=item Returns 1 if succcessful

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head2 delete_alerts

Delete the given alerts from the queue.

=over 8

=item Params: name, alerts.

=item Returns 1 if successful

=item Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

=back

=head1 AUTHOR

Mikko Koivunalho <[e-mail]>

=head1 BUGS

Please report any bugs or feature requests to [e-mail] or through the web interface at:
 http://rt.cpan.org/Public/Dist/Display.html?Name=IO-Iron

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by Mikko Koivunalho.

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

The full text of the license can be found in the
F<LICENSE> file included with this distribution.

=cut