shanesveller-webbynode-api 0.0.5 → 0.0.6

data/README.rdoc

@@ -4,13 +4,19 @@ This gem wraps the API available for the VPS hosting company
 {WebbyNode}[http://www.webbynode.com]. Details and a preliminary
 design document for the API itself are available
 {here}[http://howto.webbynode.com/topic.php?id=25]. Functionality
-is currently based on the API guide version 1.
+is currently based on the API guide version 2.
+
+== Notice
+All previous methods/initializers used named/ordered arguments. New API
+interactions are designed to use hashes of arguments instead. Older API
+models will be converted to this new design pattern soon.
 
 == Currently Supported API functionality
 * Client information such as account status, contact/address info, credit
 * Webby information (status) and simple actions (start, shutdown, reboot)
 * List all webbies
 * DNS zone information such as domain name, TTL, and status
+* Creation/deletion of DNS zones
 
 == In Development
 * DNS record information such as type, data, name, id, and TTL
@@ -52,6 +58,13 @@ is currently based on the API guide version 1.
   pp @dns.domain
   pp @dns.records
 
+=== DNS Zone Creation/Deletion
+  require 'webbynode-api'
+  email = "example@email.com"
+  api_key = "1234567890abcdef"
+  @new_zone = WebbyNode::DNS.new_zone(:email => email, :token => token, :domain => "mynewdomain.com.", :ttl => 86400)
+  pp @new_zone["id"]
+
 == Copyright
 
 Copyright (c) 2009 Shane Sveller. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/webbynode-api.rb

@@ -18,7 +18,7 @@ class WebbyNode
 
     # Uses HTTParty to submit a secure API request via email address and token
     def auth_get(url, options = {})
-      raise ArgumentError, "No API information given" unless @email && @api_key
+      raise ArgumentError, "API information is missing or incomplete" unless @email && @api_key
       options[:query] ||= {}
       options[:query].merge!(:email => @email, :token => @api_key)
       results = self.class.get(url, options)
@@ -26,6 +26,18 @@ class WebbyNode
       return results
     end
 
+    def auth_post(url, options = {})
+      self.class.auth_post(url, options)
+    end
+
+    def self.auth_post(url, options = {})
+      options[:query] ||= {}
+      raise ArgumentError, "API information is missing or incomplete" unless options[:query][:email] && options[:query][:token]
+      results = self.post(url, options)
+      raise ArgumentError, "Probable bad API information given" if results == {}
+      return results
+    end
+
     # Catches simple requests for specific API data returned via a hash
     def method_missing(method)
       key = @data[method.to_s] if @data
@@ -34,4 +46,4 @@ class WebbyNode
   end
 end
 
-require File.join(File.dirname(__FILE__), 'webbynode-api', 'data')
+require File.join(File.dirname(__FILE__), 'webbynode-api', 'data')

data/lib/webbynode-api/data.rb

@@ -52,8 +52,31 @@ class WebbyNode
     end
 
     def records
-      raise "This method should only be called on DNS instances with an id." unless @id
+      raise "This method should only be called on DNS instances with an id" unless @id
       auth_get("/api/xml/dns/#{@id}/records")["hash"]["records"]
     end
+
+    def self.new_zone(options = {})
+      raise ArgumentError, "API access information via :email and :token are required arguments" unless options[:email] && options[:token]
+      raise ArgumentError, ":domain and :ttl are required arguments" unless options[:domain] && options[:ttl]
+      if options[:status]
+        raise ArgumentError, ":status must be 'Active' or 'Inactive'" unless %w(Active Inactive).include? options[:status]
+      end
+      zone_data = auth_post("/api/xml/dns/new", :query =>
+        {
+          :email => options[:email],
+          :token => options[:token],
+          "zone[domain]" => options[:domain],
+          "zone[ttl]" => options[:ttl],
+          "zone[status]" => options[:status]
+        })
+      return zone_data["hash"]
+    end
+
+    def self.delete_zone(options = {})
+      raise ArgumentError, "API access information via :email and :token are required arguments" unless options[:email] && options[:token]
+      raise ArgumentError, ":id is a required argument" unless options[:id]
+      return auth_post("/api/xml/dns/#{options[:id]}/delete", :query => options)["hash"]["success"]
+    end
   end
-end
+end

data/test/data/delete-zone.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <success type="boolean">true</success>
+</hash>

data/test/data/new-zone.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <status>Active</status>
+  <ttl type="integer">86400</ttl>
+  <domain>example.com.</domain>
+  <id type="integer">171</id>
+</hash>

data/test/webbynode-api_test.rb

@@ -7,15 +7,23 @@ class WebbynodeApiTest < Test::Unit::TestCase
       @api_key = "123456"
       data_path = File.join(File.dirname(__FILE__), "data")
       FakeWeb.clean_registry
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/client\?\w+/i, :body => File.read("#{data_path}/bad-auth.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/client\?\w+/i, :body => File.read("#{data_path}/bad-auth.xml"))
+      FakeWeb.register_uri(:post, /^https:\/\/manager\.webbynode\.com\/.+$/, :body => "")
     end
     should "raise ArgumentError if no API data given" do
-      assert_raise(ArgumentError){ WebbyNode::Client.new(nil, nil) }
-      assert_raise(ArgumentError){ WebbyNode::Client.new(@email, nil) }
-      assert_raise(ArgumentError){ WebbyNode::Client.new(nil, @api_key) }
+      # for auth_get
+      assert_raise(ArgumentError, "API information is missing or incomplete"){ WebbyNode::Client.new(nil, nil) }
+      assert_raise(ArgumentError, "API information is missing or incomplete"){ WebbyNode::Client.new(@email, nil) }
+      assert_raise(ArgumentError, "API information is missing or incomplete"){ WebbyNode::Client.new(nil, @api_key) }
+      # for auth_post
+      assert_raise(ArgumentError, "API information is missing or incomplete"){ WebbyNode::APIObject.new(nil, nil).auth_post("",{}) }
+      assert_raise(ArgumentError, "API information is missing or incomplete"){ WebbyNode::APIObject.new(@email, nil).auth_post("",{}) }
+      assert_raise(ArgumentError, "API information is missing or incomplete"){ WebbyNode::APIObject.new(nil, @api_key).auth_post("",{}) }
     end
     should "raise ArgumentError if bad API data given" do
-      assert_raise(ArgumentError){ WebbyNode::Client.new(@email, @api_key) }
+      assert_raise(ArgumentError, "Probable bad API information given"){ WebbyNode::Client.new(@email, @api_key) }
+      # TODO: Need XML fixture file for this
+      # assert_raise(ArgumentError, "Probable bad API information given"){ WebbyNode::APIObject.new(@email, @api_key).auth_post("",{}) }
     end
   end
   context "fetching client data from API" do
@@ -24,7 +32,7 @@ class WebbynodeApiTest < Test::Unit::TestCase
       api_key = "123456"
       data_path = File.join(File.dirname(__FILE__), "data")
       FakeWeb.clean_registry
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/client\?.+/i, :body => File.read("#{data_path}/client.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/client\?.+/i, :body => File.read("#{data_path}/client.xml"))
       @api = WebbyNode::Client.new(email, api_key)
     end
 
@@ -60,19 +68,17 @@ class WebbynodeApiTest < Test::Unit::TestCase
     end
   end
 
-  context "fetching webbies data from API" do
+  context "fetching webbies data from API with hostname" do
     setup do
       email = "example@email.com"
       api_key = "123456"
       hostname = "webby1"
       data_path = File.join(File.dirname(__FILE__), "data")
       FakeWeb.clean_registry
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/start\?.+/i, :body => File.read("#{data_path}/webby-start.xml"))
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/shutdown\?.+/i, :body => File.read("#{data_path}/webby-shutdown.xml"))
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/reboot\?.+/i, :body => File.read("#{data_path}/webby-reboot.xml"))
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webbies\?.+/i, :body => File.read("#{data_path}/webbies.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/start\?.+/i, :body => File.read("#{data_path}/webby-start.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/shutdown\?.+/i, :body => File.read("#{data_path}/webby-shutdown.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/reboot\?.+/i, :body => File.read("#{data_path}/webby-reboot.xml"))
       @webby = WebbyNode::Webby.new(email, api_key, hostname)
-      @webbies = WebbyNode::Webby.new(email, api_key)
     end
     should "return a job ID when starting, shutting down, or rebooting" do
       @webby.start.should == 2562
@@ -81,15 +87,25 @@ class WebbynodeApiTest < Test::Unit::TestCase
     end
     should "return a valid status" do
       data_path = File.join(File.dirname(__FILE__), "data")
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status.xml"))
       @webby.status.should == "on"
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status-shutdown.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status-shutdown.xml"))
       @webby.status.should == "Shutting down"
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status-off.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status-off.xml"))
       @webby.status.should == "off"
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status-reboot.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webby\/\w+\/status\?.+/i, :body => File.read("#{data_path}/webby-status-reboot.xml"))
       @webby.status.should == "Rebooting"
     end
+  end
+  context "fetching webbies data from API without hostname" do
+    setup do
+      email = "example@email.com"
+      api_key = "123456"
+      data_path = File.join(File.dirname(__FILE__), "data")
+      FakeWeb.clean_registry
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/webbies\?.+/i, :body => File.read("#{data_path}/webbies.xml"))
+      @webbies = WebbyNode::Webby.new(email, api_key)
+    end
     should "return a array of webbies" do
       @webbies.list.is_a?(Array).should be(true)
       webby = @webbies.list.first
@@ -108,8 +124,8 @@ class WebbynodeApiTest < Test::Unit::TestCase
       api_key = "123456"
       data_path = File.join(File.dirname(__FILE__), "data")
       FakeWeb.clean_registry
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/dns\?.+/i, :body => File.read("#{data_path}/dns.xml"))
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\?.+/i, :body => File.read("#{data_path}/dns-1.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\?.+/i, :body => File.read("#{data_path}/dns.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\?.+/i, :body => File.read("#{data_path}/dns-1.xml"))
       @dns = WebbyNode::DNS.new(email, api_key)
     end
     should "return an array of zones with domain, status, id, and TTL" do
@@ -134,9 +150,9 @@ class WebbynodeApiTest < Test::Unit::TestCase
       id = 1
       data_path = File.join(File.dirname(__FILE__), "data")
       FakeWeb.clean_registry
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/dns\?.+/i, :body => File.read("#{data_path}/dns.xml"))
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\?.+/i, :body => File.read("#{data_path}/dns-1.xml"))
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\/records\?.+/i, :body => File.read("#{data_path}/dns-records.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\?.+/i, :body => File.read("#{data_path}/dns.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\?.+/i, :body => File.read("#{data_path}/dns-1.xml"))
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\/records\?.+/i, :body => File.read("#{data_path}/dns-records.xml"))
       @dns = WebbyNode::DNS.new(email, api_key, id)
     end
     should "return domain name, status, id and TTL" do
@@ -147,6 +163,57 @@ class WebbynodeApiTest < Test::Unit::TestCase
     end
     should "return an array of records with id, type, name, data, auxiliary data, and TTL" do
       @dns.records.is_a?(Array).should be(true)
+      record = @dns.records.first
+      record["id"].should == 51
+      record["ttl"].should == 86400
+      record["data"].should == "200.100.200.100"
+      record["name"].should be(nil)
+      record["aux"].should == 0
+      record["type"].should == "A"
+    end
+  end
+  context "creating a new DNS zone" do
+    setup do
+      @email = "example@email.com"
+      @api_key = "123456"
+      @domain = "example.com."
+      @ttl = 86400
+      data_path = File.join(File.dirname(__FILE__), "data")
+      FakeWeb.clean_registry
+      FakeWeb.register_uri(:post, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/new\?.+/i, :body => File.read("#{data_path}/new-zone.xml"))
+    end
+    should "raise ArgumentError if API information isn't present" do
+      assert_raise(ArgumentError,"API access information via :email and :token are required arguments"){ WebbyNode::DNS.new_zone(:token => @api_key, :domain => @domain, :ttl => @ttl) }
+      assert_raise(ArgumentError,"API access information via :email and :token are required arguments"){ WebbyNode::DNS.new_zone(:email => @email, :domain => @domain, :ttl => @ttl) }
+    end
+    should "raise ArgumentError if :domain or :ttl aren't included in method call" do
+      assert_raise(ArgumentError, ":domain and :ttl are required arguments"){ WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :ttl => @ttl) }
+      assert_raise(ArgumentError, ":domain and :ttl are required arguments"){ WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :domain => @domain) }
+    end
+    should "raise ArgumentError if :status is not a valid option" do
+      assert_raise(ArgumentError, ":domain and :ttl are required arguments"){ WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :ttl => @ttl, :status => "Not active") }
+      assert_nothing_raised(ArgumentError){ WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :domain => @domain, :ttl => @ttl, :status => "Active") }
+      assert_nothing_raised(ArgumentError){ WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :domain => @domain, :ttl => @ttl, :status => "Inactive") }
+      assert_nothing_raised(ArgumentError){ WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :domain => @domain, :ttl => @ttl, :status => nil) }
+    end
+    should "return a Hash containing the new zone's information" do
+      @new_zone =  WebbyNode::DNS.new_zone(:email => @email, :token => @api_key, :domain => @domain, :ttl => @ttl, :status => "Inactive")
+      @new_zone["id"].should == 171
+      @new_zone["domain"].should == "example.com."
+      @new_zone["ttl"].should == 86400
+    end
+  end
+  context "deleting a DNS zone" do
+    setup do
+      @email = "example@email.com"
+      @api_key = "123456"
+      @id = 171
+      data_path = File.join(File.dirname(__FILE__), "data")
+      FakeWeb.clean_registry
+      FakeWeb.register_uri(:post, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\/\d+\/delete\?.+/i, :body => File.read("#{data_path}/delete-zone.xml"))
+    end
+    should "return a boolean true for succesful deletion" do
+      WebbyNode::DNS.delete_zone(:email => @email, :token => @api_key, :id => @id)
     end
   end
 end

data/webbynode-api.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{webbynode-api}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Sveller"]
-  s.date = %q{2009-07-11}
+  s.date = %q{2009-07-12}
   s.email = %q{shanesveller@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,9 +23,11 @@ Gem::Specification.new do |s|
      "lib/webbynode-api/data.rb",
      "test/data/bad-auth.xml",
      "test/data/client.xml",
+     "test/data/delete-zone.xml",
      "test/data/dns-1.xml",
      "test/data/dns-records.xml",
      "test/data/dns.xml",
+     "test/data/new-zone.xml",
      "test/data/webbies.xml",
      "test/data/webby-reboot.xml",
      "test/data/webby-shutdown.xml",
@@ -38,11 +40,10 @@ Gem::Specification.new do |s|
      "test/webbynode-api_test.rb",
      "webbynode-api.gemspec"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/shanesveller/webbynode-api}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{wraps the WebbyNode API into nice Ruby objects}
   s.test_files = [
     "test/test_helper.rb",
@@ -51,7 +52,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shanesveller-webbynode-api
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Shane Sveller
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-11 00:00:00 -07:00
+date: 2009-07-12 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,9 +33,11 @@ files:
 - lib/webbynode-api/data.rb
 - test/data/bad-auth.xml
 - test/data/client.xml
+- test/data/delete-zone.xml
 - test/data/dns-1.xml
 - test/data/dns-records.xml
 - test/data/dns.xml
+- test/data/new-zone.xml
 - test/data/webbies.xml
 - test/data/webby-reboot.xml
 - test/data/webby-shutdown.xml
@@ -47,7 +49,7 @@ files:
 - test/test_helper.rb
 - test/webbynode-api_test.rb
 - webbynode-api.gemspec
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/shanesveller/webbynode-api
 post_install_message: 
 rdoc_options: 
@@ -71,7 +73,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: wraps the WebbyNode API into nice Ruby objects
 test_files: 
 - test/test_helper.rb