digitalocean 1.0.0 → 1.0.1

data/README.md

@@ -1,6 +1,6 @@
 # Digitalocean Ruby Bindings
 
-This gem is a wrapper for [DigitalOcean.com](https://www.digitalocean.com)'s API.
+### The easiest and most complete rubygem for [DigitalOcean](https://www.digitalocean.com). 
 
 [![BuildStatus](https://travis-ci.org/scottmotte/digitalocean.png?branch=master)](https://travis-ci.org/scottmotte/digitalocean)
 [![Gem Version](https://badge.fury.io/rb/digitalocean.png)](http://badge.fury.io/rb/digitalocean)
@@ -8,8 +8,17 @@ This gem is a wrapper for [DigitalOcean.com](https://www.digitalocean.com)'s API
 ```ruby
 Digitalocean.client_id  = "your_client_id"
 Digitalocean.api_key    = "your_api_key"
-droplets = Digitalocean::Droplet.all
-puts droplets.inspect
+result = Digitalocean::Droplet.all
+# =>
+# <RecursiveOpenStruct status="OK", droplets=[
+#   {"id"=>12345, "name"=>"dev", "image_id"=>2676, "size_id"=>63, "region_id"=>3, "backups_active"=>false, "ip_address"=>"198.555.55.55", "private_ip_address"=>nil, "locked"=>false, "status"=>"active", "created_at"=>"2013-06-12T03:07:14Z"}, 
+#   {"id"=>234674, "name"=>"server2", "image_id"=>441012, "size_id"=>62, "region_id"=>1, "backups_active"=>false, "ip_address"=>"192.555.55.56", "private_ip_address"=>nil, "locked"=>false, "status"=>"active", "created_at"=>"2013-06-17T00:30:12Z"}
+# ]>
+#
+
+result.status
+result.droplets
+result.droplets.first.ip_address
 ```
 
 ## Installation
@@ -39,6 +48,10 @@ Digitalocean.client_id  = "your_client_id"
 Digitalocean.api_key    = "your_api_key"
 ```
 
+You can find your keys at [https://cloud.digitalocean.com/api_access](https://cloud.digitalocean.com/api_access)
+
+[![](https://raw2.github.com/scottmotte/digitalocean/master/example.png)](https://cloud.digitalocean.com/api_access)
+
 ## Usage
 
 ### List Droplets
@@ -71,7 +84,7 @@ Digitalocean::Droplet.find(id)
 Digitalocean::Droplet.rename(id, {name: name})
 Digitalocean::Droplet.reboot(id)
 Digitalocean::Droplet.power_cycle(id)
-Digitalocean::Droplet.shut_down(id)
+Digitalocean::Droplet.shutdown(id)
 Digitalocean::Droplet.power_off(id)
 Digitalocean::Droplet.power_on(id)
 Digitalocean::Droplet.snapshot(id, {name: name})
@@ -101,7 +114,9 @@ Digitalocean::SshKey.create({name: name, ssh_pub_key: ssh_pub_key})
 Digitalocean::Event.find(id)
 ```
 
-There's also an [digitalocean-rubygem-example](https://github.com/scottmotte/digitalocean-rubygem-example) if you find you need more context.
+## Example
+
+There is a [digitalocean-rubygem-example](https://github.com/scottmotte/digitalocean-rubygem-example) to help jumpstart your development. 
 
 ## Contributing
 
@@ -125,5 +140,5 @@ You first need to request access from [scottmotte](http://github.com/scottmotte)
 
 ```
 gem build digitalocean.gemspec
-gem push digitalocean-1.0.0.gem
+gem push digitalocean-1.0.1.gem
 ```

data/lib/digitalocean.rb

@@ -19,7 +19,7 @@ module Digitalocean
       "rename"    => "https://api.digitalocean.com/droplets/[droplet_id]/rename/?client_id=[your_client_id]&api_key=[your_api_key]&name=[name]",
       "reboot"    => "https://api.digitalocean.com/droplets/[droplet_id]/reboot/?client_id=[your_client_id]&api_key=[your_api_key]",
       "power_cycle" => "https://api.digitalocean.com/droplets/[droplet_id]/power_cycle/?client_id=[your_client_id]&api_key=[your_api_key]",
-      "shut_down" => "https://api.digitalocean.com/droplets/[droplet_id]/shut_down/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "shutdown" => "https://api.digitalocean.com/droplets/[droplet_id]/shutdown/?client_id=[your_client_id]&api_key=[your_api_key]",
       "power_off" => "https://api.digitalocean.com/droplets/[droplet_id]/power_off/?client_id=[your_client_id]&api_key=[your_api_key]",
       "power_on"  => "https://api.digitalocean.com/droplets/[droplet_id]/power_on/?client_id=[your_client_id]&api_key=[your_api_key]",
       "snapshot"  => "https://api.digitalocean.com/droplets/[droplet_id]/snapshot/?name=[snapshot_name]&client_id=[your_client_id]&api_key=[your_api_key]",

data/lib/digitalocean/version.rb

@@ -1,3 +1,3 @@
 module Digitalocean
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/digitalocean/droplet_spec.rb

@@ -62,15 +62,15 @@ describe Digitalocean::Droplet do
     end
   end
 
-  describe "._shut_down" do
+  describe "._shutdown" do
     let(:droplet_id) { "1234" }
 
     before do
-      @url = subject._shut_down(droplet_id)
+      @url = subject._shutdown(droplet_id)
     end
 
     it do
-      @url.should eq "https://api.digitalocean.com/droplets/#{droplet_id}/shut_down/?client_id=client_id_required&api_key=api_key_required"
+      @url.should eq "https://api.digitalocean.com/droplets/#{droplet_id}/shutdown/?client_id=client_id_required&api_key=api_key_required"
     end
   end
 

data/spec/digitalocean_spec.rb

@@ -12,7 +12,7 @@ describe Digitalocean do
     it { subject.api_endpoint.should eq "https://api.digitalocean.com" }
     it { subject.client_id.should eq "client_id_required" }
     it { subject.api_key.should eq "api_key_required" }
-    it { subject::VERSION.should eq "1.0.0" }
+    it { subject::VERSION.should eq "1.0.1" }
   end
 
   describe "setting values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: digitalocean
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -140,6 +140,7 @@ files:
 - README.md
 - Rakefile
 - digitalocean.gemspec
+- example.png
 - lib/digitalocean.rb
 - lib/digitalocean/version.rb
 - spec/digitalocean/domain_spec.rb