package IO::Iron::IronMQ::Api;
## no critic (Documentation::RequirePodAtEnd)
## no critic (Documentation::RequirePodSections)
use 5.010_000;
use strict;
use warnings;
# Global Creator
BEGIN {
# No exports.
}
# Global Destructor
END {
}
=for stopwords IronMQ API Mikko Koivunalho perldoc CPAN AnnoCPAN ACKNOWLEDGMENTS TODO tradename licensable MERCHANTABILITY
=head1 NAME
IO::Iron::IronMQ::Api - IronMQ API reference for Perl Client Libraries!
=cut
our $VERSION = '0.12'; # VERSION: generated by DZP::OurPkgVersion
=head1 SYNOPSIS
This package is for internal use of IO::Iron::IronMQ::Client/Queue packages.
Only IronMQ v3. Older v1/v2 no longer supported.
=head1 DESCRIPTION
=head1 SUBROUTINES/METHODS
=cut
=head2 Operate message queues
=head3 IRONMQ_CREATE_QUEUE
/projects/{Project ID}/queues/{Queue Name}
=cut
sub IRONMQ_CREATE_QUEUE {
return {
'action_name' => 'IRONMQ_CREATE_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}',
'action' => 'PUT',
'return' => 'NONE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'message_timeout' => 1, 'message_expiration' => 1, 'type' => 1, 'push' => 1, 'dead_letter' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Created a message queue.',
};
}
=head3 IRONMQ_GET_QUEUE_INFO
/projects/{Project ID}/queues/{Queue Name}
=cut
sub IRONMQ_GET_QUEUE_INFO {
return {
'action_name' => 'IRONMQ_GET_QUEUE_INFO',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}',
'action' => 'GET',
'return' => 'HASH',
'retry' => 1,
'require_body' => 0,
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Got info about a message queue.',
};
}
=head3 IRONMQ_UPDATE_QUEUE
/projects/{Project ID}/queues/{Queue Name}
=cut
sub IRONMQ_UPDATE_QUEUE {
return {
'action_name' => 'IRONMQ_UPDATE_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}',
'action' => 'PATCH',
'return' => 'NONE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'subscribers' => 1, 'push_type' => 1, 'retries' => 1, 'retries_delay' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Updated a message queue.',
};
}
=head3 IRONMQ_DELETE_QUEUE
/projects/{Project ID}/queues/{Queue Name}
=cut
sub IRONMQ_DELETE_QUEUE {
return {
'action_name' => 'IRONMQ_DELETE_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 0,
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Deleted message queue.',
};
}
=head3 IRONMQ_LIST_QUEUES
/projects/{Project ID}/queues
=cut
sub IRONMQ_LIST_QUEUES {
return {
'action_name' => 'IRONMQ_LIST_QUEUES',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues',
'action' => 'GET',
'return' => 'HASH',
'retry' => 0,
'require_body' => 0,
'url_params' => { 'per_page' => 1, 'previous' => 1, 'prefix' => 1, },
'url_escape' => { '{Project ID}' => 1 },
'log_message' => '(project={Project ID}). Listed queues.',
};
}
=head3 IRONMQ_ADD_SUBSCRIBERS_TO_A_MESSAGE_QUEUE
/projects/{Project ID}/queues/{Queue Name}/subscribers
=cut
sub IRONMQ_ADD_SUBSCRIBERS_TO_A_MESSAGE_QUEUE {
return {
'action_name' => 'IRONMQ_ADD_SUBSCRIBERS_TO_A_MESSAGE_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/subscribers',
'action' => 'POST',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'subscribers' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Updated a message queue by adding subscribers.',
};
}
=head3 IRONMQ_DELETE_SUBSCRIBERS_FROM_A_MESSAGE_QUEUE
/projects/{Project ID}/queues/{Queue Name}/subscribers
=cut
sub IRONMQ_DELETE_SUBSCRIBERS_FROM_A_MESSAGE_QUEUE {
return {
'action_name' => 'IRONMQ_DELETE_SUBSCRIBERS_FROM_A_MESSAGE_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/subscribers',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'subscribers' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Updated a message queue by deleting subscribers.',
};
}
=head2 Define queue alerts
=head3 IRONMQ_ADD_ALERTS_TO_A_QUEUE
/projects/{Project ID}/queues/{Queue Name}/alerts
=cut
# TODO Bug in documentation: href last '/' not needed.
sub IRONMQ_ADD_ALERTS_TO_A_QUEUE {
return {
'action_name' => 'IRONMQ_ADD_ALERTS_TO_A_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/alerts',
'action' => 'POST',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'alerts' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Set alerts to the queue.',
};
}
=head3 IRONMQ_REPLACE_ALERTS_ON_A_QUEUE
/projects/{Project ID}/queues/{Queue Name}/alerts
=cut
# TODO Bug in documentation: href last '/' not needed.
sub IRONMQ_REPLACE_ALERTS_ON_A_QUEUE {
return {
'action_name' => 'IRONMQ_REPLACE_ALERTS_ON_A_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/alerts',
'action' => 'PUT',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'alerts' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Replaced alerts on the queue.',
};
}
=head3 IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE
/projects/{Project ID}/queues/{Queue Name}/alerts
=cut
# TODO Bug in documentation: href last '/' not needed.
sub IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE {
return {
'action_name' => 'IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/alerts',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'alerts' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Removed alerts from the queue.',
};
}
=head3 IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE_BY_ID
/projects/{Project ID}/queues/{Queue Name}/alerts/{Alert ID}
=cut
sub IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE_BY_ID {
return {
'action_name' => 'IRONMQ_REMOVE_ALERTS_FROM_A_QUEUE_BY_ID',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/alerts/{Alert ID}',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 0,
'request_fields' => { 'alerts' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, '{Alert ID}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}, alert_id={Alert ID}). Removed one alert from the queue.',
};
}
=head2 Operate messages
=head3 IRONMQ_POST_MESSAGES
/projects/{Project ID}/queues/{Queue Name}/messages
=cut
sub IRONMQ_POST_MESSAGES {
return {
'action_name' => 'IRONMQ_POST_MESSAGES',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages',
'action' => 'POST',
'return' => 'HASH',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'messages' => 1 },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Pushed messages to the queue.',
};
}
=head3 IRONMQ_RESERVE_MESSAGES
/projects/{Project ID}/queues/{Queue Name}/messages
=cut
sub IRONMQ_RESERVE_MESSAGES {
return {
'action_name' => 'IRONMQ_RESERVE_MESSAGES',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/reservations',
'action' => 'POST',
'return' => 'HASH',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'n' => 1, 'timeout' => 1, 'wait' => 1, 'delete' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}). Reserved messages from the queue.',
};
}
=head3 IRONMQ_GET_MESSAGE_BY_ID
/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}
=cut
sub IRONMQ_GET_MESSAGE_BY_ID {
return {
'action_name' => 'IRONMQ_GET_MESSAGE_BY_ID',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}',
'action' => 'GET',
'return' => 'HASH',
'retry' => 1,
'require_body' => 0,
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, '{Message ID}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}, message_id={Message ID}). Got a message from the queue.',
};
}
=head3 IRONMQ_PEEK_MESSAGES
/projects/{Project ID}/queues/{Queue Name}/messages/peek
=cut
sub IRONMQ_PEEK_MESSAGES {
return {
'action_name' => 'IRONMQ_PEEK_MESSAGES',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages',
'action' => 'GET',
'return' => 'HASH',
'retry' => 1,
'require_body' => 0,
'url_params' => { 'n' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}). Peeked at messages on the queue.',
};
}
=head3 IRONMQ_DELETE_MESSAGE
/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}
=cut
sub IRONMQ_DELETE_MESSAGE {
return {
'action_name' => 'IRONMQ_DELETE_MESSAGE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'reservation_id' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, '{Message ID}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}, message_id={Message ID}). Deleted a message from the queue.',
};
}
=head3 IRONMQ_DELETE_MESSAGES
/projects/{Project ID}/queues/{Queue Name}/messages
=cut
sub IRONMQ_DELETE_MESSAGES {
return {
'action_name' => 'IRONMQ_DELETE_MESSAGES',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'ids' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}). Deleted messages from the queue.',
};
}
=head3 IRONMQ_TOUCH_MESSAGE
/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}/touch
=cut
sub IRONMQ_TOUCH_MESSAGE {
return {
'action_name' => 'IRONMQ_TOUCH_MESSAGE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}/touch',
'action' => 'POST',
'return' => 'HASH',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'reservation_id' => 1, 'timeout' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, '{Message ID}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}, message_id={Message ID}). Touched a message on the queue.',
};
}
=head3 IRONMQ_RELEASE_MESSAGE
/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}/release
=cut
sub IRONMQ_RELEASE_MESSAGE {
return {
'action_name' => 'IRONMQ_RELEASE_MESSAGE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}/release',
'action' => 'POST',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => { 'reservation_id' => 1, 'delay' => 1, },
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, '{Message ID}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}, message_id={Message ID}). Released a message on the queue.',
};
}
=head3 IRONMQ_CLEAR_MESSAGES
/projects/{Project ID}/queues/{Queue Name}/clear
=cut
sub IRONMQ_CLEAR_MESSAGES {
return {
'action_name' => 'IRONMQ_CLEAR_MESSAGES',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages',
'action' => 'DELETE',
'return' => 'MESSAGE',
'retry' => 1,
'require_body' => 1,
'request_fields' => {},
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1, },
'log_message' => '(project={Project ID}, queue={Queue Name}). Cleared all messages from the queue.',
};
}
=head3 IRONMQ_GET_PUSH_STATUSES_FOR_A_MESSAGE
/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}/subscribers
=cut
sub IRONMQ_GET_PUSH_STATUSES_FOR_A_MESSAGE {
return {
'action_name' => 'IRONMQ_GET_PUSH_STATUSES_FOR_A_MESSAGE',
'href' => '{Protocol}://{Host}:{Port}/{API Version}/projects/{Project ID}/queues/{Queue Name}/messages/{Message ID}/subscribers',
'action' => 'GET',
'return' => 'HASH',
'retry' => 1,
'require_body' => 0,
'url_escape' => { '{Project ID}' => 1, '{Queue Name}' => 1 },
'log_message' => '(project={Project ID}, queue={Queue Name}, message_id={Message ID}). Got push status about a message.',
};
}
=head1 AUTHOR
Mikko Koivunalho, C<< <mikko.koivunalho at iki.fi> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-io-iron at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IO-Iron>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc IO::Iron::IronMQ::Client
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=IO-Iron>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/IO-Iron>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/IO-Iron>
=item * Search CPAN
L<http://search.cpan.org/dist/IO-Iron/>
=back
=head1 ACKNOWLEDGMENTS
Cool idea, "message queue in the cloud": http://www.iron.io/.
=head1 TODO
=over 4
=back
=head1 LICENSE AND COPYRIGHT
Copyright 2013 Mikko Koivunalho.
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:
L<http://www.perlfoundation.org/artistic_license_2_0>
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=cut
1; # End of IO::Iron::IronMQ::Api