digitalocean 0.0.3 → 1.0.0.rc.2

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Scott Motte
+Copyright (c) 2014 Scott Motte
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -6,71 +6,88 @@ This gem is a wrapper for [DigitalOcean.com](https://www.digitalocean.com)'s API
 
 Add this line to your application's Gemfile:
 
-    gem 'digitalocean'
+```
+gem 'digitalocean'
+```
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install digitalocean
+```
+gem install digitalocean
+```
 
 Then in your application initialize the gem:
 
-    $ Digitalocean.client_id  = "your_client_id"
-    $ Digitalocean.api_key    = "your_api_key"
+```ruby
+Digitalocean.client_id  = "your_client_id"
+Digitalocean.api_key    = "your_api_key"
+```
 
 ## Usage
 
 ### List Droplets
 
-    $ Digitalocean::Droplet.all
+```ruby
+Digitalocean::Droplet.all
+```
 
-### Retrieve Droplet
+### Find Droplet
 
-    $ Digitalocean::Droplet.retrieve("id_of_droplet")
+```ruby
+Digitalocean::Droplet.find("id_of_droplet")
+```
 
 ### Create Droplet
 
-    $ Digitalocean::Droplet.create({:name => droplet_name, :size_id => size_id, :image_id => image_id, :region_id => region_id)
-
+```ruby
+Digitalocean::Droplet.create({:name => droplet_name, :size_id => size_id, :image_id => image_id, :region_id => region_id)
+```
 ## Available Commands
 
-    $ Digitalocean::Droplet.all
-    $ Digitalocean::Droplet.retrieve(id)
-    $ Digitalocean::Droplet.create({})
-    $ Digitalocean::Droplet.reboot(id)
-    $ Digitalocean::Droplet.power_cycle(id)
-    $ Digitalocean::Droplet.shut_down(id)
-    $ Digitalocean::Droplet.power_off(id)
-    $ Digitalocean::Droplet.power_on(id)
-    $ Digitalocean::Droplet.snapshot(id)
-    $ Digitalocean::Droplet.destroy(id)
-
-    $ Digitalocean::Image.all
-    $ Digitalocean::Image.find(id)
-    $ Digitalocean::Image.destroy(id)
-    $ Digitalocean::Image.transfer(id, region_id)
-
-    $ Digitalocean::Region.all
-
-    $ Digitalocean::Size.all
-
-    $ Digitalocean::SshKey.all
-    $ Digitalocean::SshKey.retrieve(id)
-    $ Digitalocean::SshKey.create({})
-
-    $ Digitalocean::Domain.all
-    $ Digitalocean::Domain.find(id)
-    $ Digitalocean::Domain.create(domain_name, ip_address)
-    $ Digitalocean::Domain.destroy(id)
-
-    $ Digitalocean::Record.all(domain_id)
-    $ Digitalocean::Record.find(domain_id, record_id)
-    $ Digitalocean::Record.create(domain_id, record_type, data, [name, priority, port, weight])
-    $ Digitalocean::Record.edit(domain_id, record_id, {})
-    $ Digitalocean::Record.destroy(domain_id, record_id)
+```ruby
+Digitalocean::Domain.all
+Digitalocean::Domain.find(id)
+Digitalocean::Domain.create({name: name, ip_address: ip_address})
+Digitalocean::Domain.destroy(id)
+
+Digitalocean::Droplet.all
+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.power_off(id)
+Digitalocean::Droplet.power_on(id)
+Digitalocean::Droplet.snapshot(id, {name: name})
+Digitalocean::Droplet.create({name: name, size_id: size_id, image_id: image_id, region_id: region_id, ssh_key_ids: ssh_key_ids})
+Digitalocean::Droplet.destroy(id)
+
+Digitalocean::Image.all
+Digitalocean::Image.all({filter: "my_images"})
+Digitalocean::Image.find(id)
+Digitalocean::Image.destroy(id)
+Digitalocean::Image.transfer(id, {region_id: region_id})
+
+Digitalocean::Record.all(domain_id)
+Digitalocean::Record.find(domain_id, record_id)
+Digitalocean::Record.create(domain_id, {record_type: record_type, data: data})
+Digitalocean::Record.edit(domain_id, record_id, {record_type: record_type, data: data})
+Digitalocean::Record.destroy(domain_id, record_id)
+
+Digitalocean::Region.all
+
+Digitalocean::Size.all
+
+Digitalocean::SshKey.all
+Digitalocean::SshKey.find(id)
+Digitalocean::SshKey.create({name: name, ssh_pub_key: ssh_pub_key})
+```
 
 ## Contributing
 
@@ -80,8 +97,19 @@ Then in your application initialize the gem:
 6. Push to the branch (`git push origin my-new-feature`)
 7. Create new Pull Request
 
+When adding methods, add to the list of DEFINITIONS in `lib/digitalocean.rb`. Additionally, write a spec and add it to the list in the README.
+
 ## Running Specs
 
-1. cp .env-example .env
-2. Set your credentials in the .env file
-3. bundle exec foreman run bundle exec rspec spec/digitalocean/*
+```
+bundle exec rspec spec/*
+```
+
+## Publish to RubyGems.org
+
+You first need to request access from [scottmotte](http://github.com/scottmotte).
+
+```
+gem build digitalocean.gemspec
+gem push digitalocean-1.0.0.rc.1.gem
+```

data/lib/digitalocean.rb

@@ -2,18 +2,84 @@ require "faraday"
 require "faraday_middleware"
 require "recursive-open-struct"
 require "digitalocean/version"
-require "digitalocean/droplet"
-require "digitalocean/image"
-require "digitalocean/region"
-require "digitalocean/size"
-require "digitalocean/ssh_key"
-require "digitalocean/domain"
-require "digitalocean/record"
-
 
 module Digitalocean
   extend self
 
+  DEFINITIONS     = {
+    "Domain"  => {
+      "all"       => "https://api.digitalocean.com/domains?client_id=[your_client_id]&api_key=[your_api_key]",
+      "find"      => "https://api.digitalocean.com/domains/[domain_id]?client_id=[your_client_id]&api_key=[your_api_key]",
+      "create"    => "https://api.digitalocean.com/domains/new?client_id=[your_client_id]&api_key=[your_api_key]&name=[domain]&ip_address=[ip_address]", 
+      "destroy"   => "https://api.digitalocean.com/domains/[domain_id]/destroy?client_id=[your_client_id]&api_key=[your_api_key]" 
+    },
+    "Droplet" => {
+      "all"       => "https://api.digitalocean.com/droplets/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "find"      => "https://api.digitalocean.com/droplets/[droplet_id]?client_id=[your_client_id]&api_key=[your_api_key]",
+      "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]",
+      "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]",
+      "create"    => "https://api.digitalocean.com/droplets/new?client_id=[your_client_id]&api_key=[your_api_key]&name=[droplet_name]&size_id=[size_id]&image_id=[image_id]&region_id=[region_id]&ssh_key_ids=[ssh_key_ids]", # unique case that is not copy/paste 
+      "destroy"   => "https://api.digitalocean.com/droplets/[droplet_id]/destroy/?client_id=[your_client_id]&api_key=[your_api_key]"
+    },
+    "Image"   => {
+      "all"       => "https://api.digitalocean.com/images/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "find"      => "https://api.digitalocean.com/images/[image_id]/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "destroy"      => "https://api.digitalocean.com/images/[image_id]/destroy/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "transfer"      => "https://api.digitalocean.com/images/[image_id]/transfer/?client_id=[your_client_id]&api_key=[your_api_key]&region_id=[region_id]" 
+    },
+    "Record"  => {
+      "all"       => "https://api.digitalocean.com/domains/[domain_id]/records?client_id=[your_client_id]&api_key=[your_api_key]",
+      "find"       => "https://api.digitalocean.com/domains/[domain_id]/records/[record_id]?client_id=[your_client_id]&api_key=[your_api_key]",
+      "create"     => "https://api.digitalocean.com/domains/[domain_id]/records/new?client_id=[your_client_id]&api_key=[your_api_key]&record_type=[record_type]&data=[data]",
+      "edit"       => "https://api.digitalocean.com/domains/[domain_id]/records/[record_id]/edit?client_id=[your_client_id]&api_key=[your_api_key]",
+      "destroy"    => "https://api.digitalocean.com/domains/[domain_id]/records/[record_id]/destroy?client_id=[your_client_id]&api_key=[your_api_key]" 
+    },
+    "Region"  => {
+      "all"       => "https://api.digitalocean.com/regions/?client_id=[your_client_id]&api_key=[your_api_key]"
+    },
+    "Size"    => {
+      "all"       => "https://api.digitalocean.com/sizes/?client_id=[your_client_id]&api_key=[your_api_key]"
+    },
+    "SshKey"  => {
+      "all"       => "https://api.digitalocean.com/ssh_keys/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "find"      => "https://api.digitalocean.com/ssh_keys/[ssh_key_id]/?client_id=[your_client_id]&api_key=[your_api_key]",
+      "create"    => "https://api.digitalocean.com/ssh_keys/new/?name=[ssh_key_name]&ssh_pub_key=[ssh_public_key]&client_id=[your_client_id]&api_key=[your_api_key]"
+    }
+  }
+
+  DEFINITIONS.each do |resource|
+    resource_name = resource[0]
+
+    resource_class = Class.new(Object) do
+      # http://stackoverflow.com/questions/3026943/define-method-for-instance-of-class
+      singleton = class << self; self end
+
+      DEFINITIONS[resource_name].each do |method_name, url|
+        parts         = url.split("?")
+        pre_query     = parts[0]
+        post_query    = parts[1]
+
+        singleton.send :define_method, "_#{method_name}" do |*args|
+          pre_query   = Digitalocean.process_standard_args_from_part(pre_query, args)
+          post_query  = Digitalocean.process_hash_args_from_part(post_query, args)
+
+          [pre_query, post_query].join("?")
+        end
+
+        singleton.send :define_method, method_name do |*args|
+          Digitalocean.request_and_respond send("_#{method_name}", *args)
+        end
+      end
+    end
+
+    Digitalocean.const_set(resource_name, resource_class) 
+  end
+
   def request=(request)
     @request = request
   end
@@ -31,7 +97,7 @@ module Digitalocean
 
   def client_id
     return @client_id if @client_id
-    "missing_client_id"
+    "client_id_required"
   end
 
   def api_key=(api_key)
@@ -43,15 +109,73 @@ module Digitalocean
 
   def api_key
     return @api_key if @api_key
-    "missing_api_key"
+    "api_key_required"
   end
 
   def api_endpoint
     "https://api.digitalocean.com"
   end
 
-  def credential_attrs
-    {:client_id => Digitalocean.client_id, :api_key => Digitalocean.api_key}
+  def request_and_respond(url)
+    resp = Digitalocean.request.get url
+    hash = RecursiveOpenStruct.new(resp.body, :recurse_over_arrays => true)
+
+    hash
+  end
+
+  def process_standard_args_from_part(part, args)
+    parts = part.split(/\[|\]/)
+
+    if parts.length > 1
+      parts.each_with_index do |v, i|
+        is_every_other = (i%2 == 1)
+        parts[i] = args.shift if is_every_other
+      end
+    end
+
+    parts.join("")
+  end
+
+  def process_client_id_and_api_key(parts)
+    # Begin by taking care of the client_id and api_key
+    client_id_index = parts.index "client_id="
+    client_id_index = parts.index "&client_id=" if !client_id_index
+    parts[client_id_index+1] = client_id if client_id_index
+
+    api_key_index = parts.index "api_key="
+    api_key_index = parts.index "&api_key=" if !api_key_index
+    parts[api_key_index+1] = api_key if api_key_index
+
+    parts
+  end
+
+  def process_hash_args_from_part(part, args)
+    parts = part.split(/\[|\]/)
+    parts = process_client_id_and_api_key(parts)
+
+    hash = args[-1]
+    if hash.is_a?(Hash)
+      if parts.length > 1
+        hash.each do |key, value|
+          query_setter    = "#{key}="
+          query_arg_index = parts.index query_setter 
+          query_arg_index = parts.index "&#{query_setter}" if !query_arg_index # handle case of ampersand
+
+          if query_arg_index != nil
+            parts[query_arg_index+1] = value
+            hash.delete(key) # cleanup
+          end
+        end
+      end
+
+      # append any additional hash arguments (optional params)
+      hash.each do |key, value|
+        appendable_param = "&#{key}=#{value}"
+        parts.push(appendable_param)
+      end
+    end
+
+    parts.join("")
   end
 
   private
@@ -59,9 +183,7 @@ module Digitalocean
   def setup_request!
     options = {
       :headers  =>  {'Accept' => "application/json"},
-      :ssl      =>  {:verify => false},
-      :url      =>  Digitalocean.api_endpoint,
-      :params   =>  Digitalocean.credential_attrs 
+      :ssl      =>  {:verify => false}
     }
 
     Digitalocean.request = ::Faraday::Connection.new(options) do |builder|
@@ -71,4 +193,4 @@ module Digitalocean
       builder.adapter ::Faraday.default_adapter
     end
   end
-end
+end

data/lib/digitalocean/version.rb

@@ -1,3 +1,3 @@
 module Digitalocean
-  VERSION = "0.0.3"
+  VERSION = "1.0.0.rc.2"
 end

data/spec/digitalocean/domain_spec.rb

@@ -1,69 +1,53 @@
 require 'spec_helper'
 
 describe Digitalocean::Domain do
-  let(:ok)        { "OK" }
   let(:subject)   { Digitalocean::Domain }
 
-  context "correct api key" do
+  describe "._all" do
     before do
-      set_client_id_and_api_key!
+      @url = subject._all
     end
 
-    describe ".all" do
-      before do
-        @response = subject.all
-      end
-
-      context "default" do
-        it do
-          @response.status.should eq ok
-        end
-      end
+    it do
+      @url.should eq "https://api.digitalocean.com/domains?client_id=client_id_required&api_key=api_key_required" 
+    end
+  end
 
-      describe ".find" do
-        before do
-          domain_id = @response.domains.first.id
-          @response2 = subject.find(domain_id)
-        end
+  describe "._find" do
+    let(:domain_id) { "1234" }
 
-        context "default" do
-          it do
-            @response2.status.should eq ok
-          end
-        end
-      end
+    before do
+      @url = subject._find(domain_id)
+    end
 
-      describe ".create" do
-        let(:domain_name) { ["digitalocean_spec_", SecureRandom.hex(15), ".com"].join }
+    it do
+      @url.should eq "https://api.digitalocean.com/domains/#{domain_id}?client_id=client_id_required&api_key=api_key_required" 
+    end
+  end
 
-        before do
-          domain = @response.domains.first
-          @response_create = subject.create(domain_name, domain.ip_address)
-        end
+  describe "._create" do
+    let(:name)        { "test_domain" }
+    let(:ip_address)  { "test_ip_address" }
+    let(:args)        { {name: name, ip_address: ip_address } }
 
-        context "default" do
-          it do
-            @response_create.status.should eq ok
-          end
-        end
-      end
+    before do
+      @url = subject._create(args)
+    end
 
-      describe ".destroy" do
-        let(:domain_name) { ["digitalocean_spec_", SecureRandom.hex(15), ".com"].join }
+    it do
+      @url.should eq "https://api.digitalocean.com/domains/new?client_id=client_id_required&api_key=api_key_required&name=test_domain&ip_address=test_ip_address"
+    end
+  end
 
-        before do
-          droplet = @response.droplets.first
-          @response_create = subject.create(domain_name, droplet.ip_address)
-          @response_destroy = subject.destroy(@response_create.id)
-        end
+  describe "._destroy" do
+    let(:domain_id) { "test_domain_id" }
 
-        context "default" do
-          it do
-            @response_destroy.status.should eq ok
-          end
-        end
-      end
+    before do
+      @url = subject._destroy(domain_id)
+    end
 
+    it do
+      @url.should eq "https://api.digitalocean.com/domains/test_domain_id/destroy?client_id=client_id_required&api_key=api_key_required"
     end
   end
-end
+end