DigitalOcean - An OO interface to the Digital Ocean API.
Version 0.08
This module is an object oriented interface into the Digital Ocean API.
use DigitalOcean; #for more efficient use, remove "wait_on_events => 1". See WAITING ON EVENTS section for more info my $do = DigitalOcean->new(client_id=> $client_id, api_key => $api_key, wait_on_events => 1); for my $droplet (@{$do->droplets}) { print "Droplet " . $droplet->name . " has id " . $droplet->id . "\n"; } my $droplet = $do->droplet($droplet_id); $droplet->reboot; $droplet->power_off; $droplet->power_on; $droplet->destroy; my $new_droplet = $do->create_droplet( name => 'new_droplet', size_id => $size_id, image_id => $image_id, region_id => $region_id, ); $new_droplet->enable_backups;
This module is written to be flexible, so that if changes are made to the Digital Ocean API, then I don't have to update this module every time they make changes so that this module will still work. What I mean by this is that if Digital Ocean adds new parameters that need to be passed into their calls, these parameters can be passed into the current calls even if I don't specify them as options and it should still work. For example, say that for the create_droplet call Digital Ocean adds a new required parameter "timestamp". All you would have to do is pass in timestamp:
$do->create_droplet( name => 'new_droplet', size_id => $size_id, image_id => $image_id, region_id => $region_id, timestamp => $timestamp, );
And timestamp will be added to the request call with the other parameters. However, if Digital Ocean adds any new attributes to an object, such as droplet_type for DigitalOcean::Droplet, this I will have to add to the DigitalOcean::Droplet in order for the DigitalOcean::Droplet objects to respect this new attribute. If you see that Digital Ocean has added a new attribute that I do not have in one of my objects, please let me know in bugs.
For some calls in Digital Ocean's API, you need to wait for one call to finish before you can submit another request that depends on the first call. For instance, if you resize a droplet and then want to take a snapshot of the droplet, you must wait until the action of resizing the droplet is complete before you can take the snapshot of this droplet. If you set wait_on_events to 1, then DigitalOcean will wait on every event until it is complete, so this way you do not have to worry about the synchronization of events or if you need to wait between two events. However, turning wait_on_events on for every event can also cause your script to run much slower if you do not need to be waiting on every event.
You may wait on all events by passing in wait_on_events when you create the DigitalOcean object:
my $do = DigitalOcean->new(client_id=> $client_id, api_key => $api_key, wait_on_events => 1);
Or you can toggle it after you have created the DigitalOcean object:
$do->wait_on_events(1); $do->wait_on_events(undef);
The default for wait_on_events is that it is set to undef and does not wait on events.
A more efficient solution is to only wait on indiviudal events that you have to wait on. You can pass in the wait_on_event flag to any subroutine (this includes subroutines in DigitalOcean's sub modules, such as DigitalOcean::Droplet) and DigitalOcean will wait until that call is complete before returning.
my $droplet = $do->create_droplet( name => 'new_droplet', size_id => $size_id, image_id => $image_id, region_id => $region_id, wait_on_event => 1, ); $droplet->reboot(wait_on_event => 1); $droplet->snapshot(wait_on_event => 1); my $domain = $do->domain(56789); my $record = $domain->record(98765); $record->edit( record_type => 'A', data => '196.87.89.45', wait_on_event => 1, ); etc.
DigitalOcean uses DigitalOcean::Event's wait subroutine to wait on events.
DigitalOcean uses DigitalOcean::Event's wait subroutine to wait on events. It does this by making requests to Digital Ocean until the event is complete. You can use time_between_requests to determine how long DigitalOcean waits between requests before making another request to Digital Ocean to see if an event is done. You can use it like so:
$do->time_between_requests(1);
or
my $do = DigitalOcean->new(client_id=> $client_id, api_key => $api_key, time_between_requests => 1);
An integer value must be passed in. The default is 2.
This will return an array reference of DigitalOcean::Droplet objects.
my $droplets = $do->droplets; for my $droplet (@{$droplets}) { print $droplet->name . "\n"; }
This will create a new droplet and return a DigitalOcean::Droplet object. The parameters are:
name Required, String, this is the name of the droplet - must be formatted by hostname rules
size_id Required, Numeric, this is the id of the size you would like the droplet created at
image_id Required, Numeric, this is the id of the image you would like the droplet created with
region_id Required, Numeric, this is the id of the region you would like your server in
ssh_key_ids Optional, Numeric CSV, comma separated list of ssh_key_ids that you would like to be added to the server
private_networking Optional, Boolean, enables a private network interface if the region supports private networking
my $new_droplet = $do->create_droplet( name => 'new_droplet', size_id => $size_id, image_id => $image_id, region_id => $region_id, );
This will retrieve a droplet by id and return a DigitalOcean::Droplet object.
my $droplet = $do->droplet(56789);
This will return an array reference of DigitalOcean::Region objects.
my $regions = $do->regions; for my $region (@{$regions}) { print $region->name . "\n"; }
This will return an array reference of DigitalOcean::Image objects.
my $images = $do->images; for my $image (@{$images}) { print $image->name . "\n"; }
This will retrieve an image by id and return a DigitalOcean::Image object.
my $image = $do->image(56789);
This will return an array reference of DigitalOcean::Size objects.
my $sizes = $do->sizes; for my $size (@{$sizes}) { print $size->name . "\n"; }
This will return an array reference of DigitalOcean::SSH::Key objects.
my $ssh_keys = $do->ssh_keys; for my $ssh_key (@{$ssh_keys}) { print $ssh_key->name . "\n"; }
This will create a new ssh key and return a DigitalOcean::SSH::Key object. The parameters are:
name Required, String, the name you want to give this SSH key.
ssh_key_pub Required, String, the actual public SSH key.
my $new_ssh_key = $do->create_ssh_key( name => 'new_ssh_key', ssh_key_pub => $ssh_key_pub, );
This will retrieve an ssh_key by id and return a DigitalOcean::SSH::Key object.
my $ssh_key = $do->ssh_key(56789);
This will return an array reference of DigitalOcean::Domain objects.
my $domains = $do->domains; for my $domain (@{$domains}) { print $domain->name . "\n"; }
This will create a new domain and return a DigitalOcean::Domain object. The parameters are:
name Required, String, the domain name
ip_address Required, String, IP address for the domain's initial A record.
my $domain = $do->create_domain( name => 'example.com', ip_address => '127.0.0.1', );
This will retrieve a domain by id and return a DigitalOcean::Domain object.
my $domain = $do->domain(56789);
This will retrieve an event by id and return a DigitalOcean::Event object.
my $event = $do->event(56789);
Adam Hopkins, <srchulo at cpan.org>
<srchulo at cpan.org>
Please report any bugs or feature requests to bug-webservice-digitalocean at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DigitalOcean. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-webservice-digitalocean at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc DigitalOcean
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=DigitalOcean
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/DigitalOcean
CPAN Ratings
http://cpanratings.perl.org/d/DigitalOcean
Search CPAN
http://search.cpan.org/dist/DigitalOcean/
Copyright 2013 Adam Hopkins.
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:
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.
To install DigitalOcean, copy and paste the appropriate command in to your terminal.
cpanm
cpanm DigitalOcean
CPAN shell
perl -MCPAN -e shell install DigitalOcean
For more information on module installation, please visit the detailed CPAN module installation guide.