https://github.com/xsawyerx/anyevent-ec2-tiny

Tiny asynchronous (non-blocking) interface to EC2 using AnyEvent
https://github.com/xsawyerx/anyevent-ec2-tiny

Last synced: 28 days ago
JSON representation

Tiny asynchronous (non-blocking) interface to EC2 using AnyEvent

• Host: GitHub
• URL: https://github.com/xsawyerx/anyevent-ec2-tiny
• Owner: xsawyerx
• Created: 2013-02-24T08:36:32.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-02-26T23:20:08.000Z (over 11 years ago)
• Last Synced: 2024-10-13T11:37:51.412Z (about 1 month ago)
• Language: Perl
• Size: 113 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.pod
  • Changelog: Changes

Awesome Lists containing this project

README

        
=pod

=head1 NAME

AnyEvent::EC2::Tiny - Tiny asynchronous (non-blocking) interface to EC2 using AnyEvent

=head1 VERSION

version 0.002

=head1 SYNOPSIS

    use v5.14;

    use AnyEvent::EC2::Tiny;

    my $ec2 = AnyEvent::EC2::Tiny->new(

        AWSAccessKey => $ENV{'AWS_ACCESS_KEY'},

        AWSSecretKey => $ENV{'AWS_SECRET_KEY'},

        region       => $ENV{'AWS_REGION'},

        debug        => 1,

    );

    # We are essentially encoding 'raw' EC2 API calls with a v2

    # signature and turning XML responses into Perl data structures

    my $xml = $ec2->send(

        'RegionName.1' => 'us-east-1',

        Action         => 'DescribeRegions',

        success_cb => sub {

            my $xml = shift;

            # prints ec2.us-east-1.amazonaws.com

            say $xml->{'regionInfo'}{'item'}[0]{'regionEndpoint'};

        },

        fail_cb => sub {

            my $error = shift;

            $error->{'type'} # HTTP or XML

            $error->{'data'} # hashref to body, errors, xml, headers, etc.

            $error->{'text'} # text of the error

        },

    );

=head1 DESCRIPTION

This is a basic asynchronous, non-blocking, interface to EC2 based on

L. It's relatively compatible while the only difference is

with regards to the callbacks and returned information.

=head1 METHODS

=head2 send

C expects the same arguments as C in L, except

you should also provide two additional arguments.

=head3 success_cb

    $ec2->send(

        ...

        success_cb => sub {

            my $xml = shift;

            # do whatever you want with it

        },

    );

Receives the resulting XML you would normally receive. Then you do whatever

you want with it, such as fetching the information or using it to create

another request.

=head3 fail_cb

    $ec2->send(

        ...

        fail_cb => sub {

            my $error = shift;

            if ( $error->{'type'} eq 'HTTP' ) {

                # this was an HTTP error

                my $http_headers = $error->{'data'}{'headers'};

                my $http_body    = $error->{'data'}{'body'};

                warn 'HTTP error received: ', $error->{'text'};

            } else {

                # $error->{'type'} eq 'XML'

                # this was an XML error

                my $http_headers = $error->{'data'}{'headers'};

                my $http_body    = $error->{'data'}{'body'};

                my $xml          = $error->{'data'}{'xml'};

                my $xml_errors   = $error->{'data'}{'errors'};

                warn "XML error received: ', $error->{'text'};

            }

        },

    );

Since we can't simply C or C in event-based code (the event loop

would catch it and you won't be able to do much about it), we instead provide

a failure callback. The failure callback receives a hash reference including

all information relevant to the request.

These are the available keys in the returned hash reference:

=over 4

=item C

Either B or B.

Since there are two possible failures (one being the HTTP request, and the

other being any problems expressed in the XML returned) you can use the C

key to know which type of error you received.

=item C

Additional information for the error.

B error receives the HTTP body (C) and headers (C).

B error receives the HTTP body (C), headers (C), XML data

(C) and XML errors (C).

=item C

A string containing the error that occured. This matches the errors returned

by L.

=back

=head1 CREDITS

Credit goes to Mark Allen for L.

=head1 AUTHOR

Sawyer X 

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Sawyer X.

This is free software; you can redistribute it and/or modify it under

the same terms as the Perl 5 programming language system itself.