shanesveller-webbynode-api 0.0.1 → 0.0.3

data/README.rdoc

@@ -1,6 +1,51 @@
 = webbynode-api
 
-Description goes here.
+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.
+
+== Currently Supported API functionality
+* Client information such as account status, contact/address info, credit
+* Webby information (status) and simple actions (start, shutdown, reboot)
+* DNS zone information such as domain name, TTL, and status
+
+== In Development
+* DNS record information such as type, data, name, id, and TTL
+
+== Planned Features
+* DNS zone/record creation, editing and deletion
+* Whatever else WebbyNode gives us in the API :)
+
+== Example Usage
+=== Account
+  require 'webbynode-api'
+  email = "example@email.com"
+  api_key = "1234567890abcdef"
+  @client = WebbyNode::Client.new(email, api_key)
+  puts @client.firstname
+
+=== Webby
+  require 'webbynode-api'
+  email = "example@email.com"
+  api_key = "1234567890abcdef"
+  hostname = "webby1"
+  @webby = WebbyNode::Webby.new(email, api_key, hostname)
+  @webby.status
+  @webby.shutdown
+  @webby.status
+
+=== DNS
+  require 'webbynode-api'
+  email = "example@email.com"
+  api_key = "1234567890abcdef"
+  zone_id = 123
+  @dns = WebbyNode::DNS.new(email, api_key)
+  pp @dns.zones
+  @dns = WebbyNode::DNS.new(email, api_key, zone_id)
+  pp @dns.domain
+  pp @dns.records
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.3

data/lib/webbynode-api.rb

@@ -3,28 +3,32 @@ gem 'httparty'
 require 'httparty'
 
 class WebbyNode
-  class Client
+  class APIObject
     include HTTParty
     base_uri "https://manager.webbynode.com"
     format :xml
 
     attr_accessor :email, :api_key, :data
 
+    # Creates a new API object secured by e-mail address and API token
     def initialize(email, api_key)
       @email = email
       @api_key = api_key
-      @data = self.auth_get('/api/xml/client')["hash"]["client"]
     end
 
+    # Uses HTTParty to submit a secure API request via email address and token
     def auth_get(url, options = {})
       options[:query] ||= {}
       options[:query].merge!(:email => @email, :token => @api_key)
       self.class.get(url, options)
     end
 
+    # Catches simple requests for specific API data returned via a hash
     def method_missing(method)
-      key = @data[method.to_s]
+      key = @data[method.to_s] if @data
       key
     end
   end
-end
+end
+
+require File.join(File.dirname(__FILE__), 'webbynode-api', 'data')

data/lib/webbynode-api/data.rb

@@ -0,0 +1,51 @@
+class WebbyNode
+  # Represents the account-holder's information
+  class Client < WebbyNode::APIObject
+    def initialize(email, api_key)
+      super(email, api_key)
+      @data = auth_get("/api/xml/client")["hash"]["client"]
+    end
+  end
+
+  # Represents an individual webby with status, reboot/shutdown/start functionality
+  # via +method_missing+
+  class Webby < WebbyNode::APIObject
+    attr_accessor :hostname
+
+    def initialize(email, api_key, hostname)
+      super(email, api_key)
+      @hostname = hostname
+    end
+
+    def method_missing(method)
+      if method.to_s == "status"
+        return auth_get("/api/xml/webby/#{@hostname}/status")["hash"]["status"]
+      elsif %w(start shutdown reboot).include? method.to_s
+        return auth_get("/api/xml/webby/#{@hostname}/#{method.to_s}")["hash"]["job_id"]
+      else
+        raise "No such action possible on a Webby."
+      end
+    end
+  end
+
+  class DNS < WebbyNode::APIObject
+    attr_accessor :id
+
+    # Optionally takes an ID as the third argument to fetch just that zone. Without,
+    # you get an array of all zones.
+    def initialize(email, api_key, id = nil)
+      super(email, api_key)
+      if id
+        @id = id
+        @data = auth_get("/api/xml/dns/#{@id}")["hash"]["zone"]
+      else
+        @data = auth_get("/api/xml/dns")["hash"]
+      end
+    end
+
+    def records
+      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
+  end
+end

data/test/data/dns-1.xml

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

data/test/data/dns-records.xml

@@ -0,0 +1,22 @@
+<!-- Courtesy of the WebbyNode API guide, version 1, page 10 -->
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <records type="array">
+    <record>
+      <type>A</type>
+      <aux type="integer">0</aux>
+      <name/>
+      <data>200.100.200.100</data>
+      <id type="integer">51</id>
+      <ttl type="integer">86400</ttl>
+    </record>
+    <record>
+      <type>A</type>
+      <aux type="integer">0</aux>
+      <name>*</name>
+      <data>200.100.200.100</data>
+      <id type="integer">26</id>
+      <ttl type="integer">86400</ttl>
+    </record>
+  </records>
+</hash>

data/test/data/dns.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <zones type="array">
+    <zone>
+      <status>Active</status>
+      <ttl type="integer">86400</ttl>
+      <domain>example.com.</domain>
+      <id type="integer">1</id>
+    </zone>
+    <zone>
+      <status>Active</status>
+      <ttl type="integer">7200</ttl>
+      <domain>fluid.com.</domain>
+      <id type="integer">111</id>
+    </zone>
+    <zone>
+      <status>Inactive</status>
+      <ttl type="integer">86400</ttl>
+      <domain>inactive.com.</domain>
+      <id type="integer">132</id>
+    </zone>
+  </zones>
+</hash>

data/test/data/webby-reboot.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <job-id type="integer">2564</job-id>
+</hash>

data/test/data/webby-shutdown.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <job-id type="integer">2561</job-id>
+</hash>

data/test/data/webby-start.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <job-id type="integer">2562</job-id>
+</hash>

data/test/data/webby-status-off.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <status>off</status>
+</hash>

data/test/data/webby-status-reboot.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <status>Rebooting</status>
+</hash>

data/test/data/webby-status-shutdown.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <status>Shutting down</status>
+</hash>

data/test/data/webby-status.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <status>on</status>
+</hash>

data/test/webbynode-api_test.rb

@@ -6,7 +6,7 @@ class WebbynodeApiTest < Test::Unit::TestCase
       email = "example@email.com"
       api_key = "123456"
       data_path = File.join(File.dirname(__FILE__), "data")
-      FakeWeb.register_uri(:get, /https:\/\/manager\.webbynode\.com\/api\/xml\/client\?.+/i, :body => File.read("#{data_path}/api-xml-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
 
@@ -41,4 +41,79 @@ class WebbynodeApiTest < Test::Unit::TestCase
       @api.phonenumber.should == "555-867-5309"
     end
   end
+
+  context "fetching webbies data from API" do
+    setup do
+      email = "example@email.com"
+      api_key = "123456"
+      hostname = "webby1"
+      data_path = File.join(File.dirname(__FILE__), "data")
+      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)
+    end
+    should "return a job ID when starting, shutting down, or rebooting" do
+      @webby.start.should == 2562
+      @webby.shutdown.should == 2561
+      @webby.reboot.should == 2564
+    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"))
+      @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"))
+      @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"))
+      @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"))
+      @webby.status.should == "Rebooting"
+    end
+  end
+
+  context "fetching DNS data from API without id" do
+    setup do
+      email = "example@email.com"
+      api_key = "123456"
+      data_path = File.join(File.dirname(__FILE__), "data")
+      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
+      @dns.zones.is_a?(Array).should be(true)
+      @dns.zones.size.should == 3
+      zone = @dns.zones.first
+      zone["id"].should == 1
+      zone["status"].should == "Active"
+      zone["domain"].should == "example.com."
+      zone["ttl"].should == 86400
+      zone = @dns.zones.last
+      zone["id"].should == 132
+      zone["status"].should == "Inactive"
+      zone["domain"].should == "inactive.com."
+      zone["ttl"].should == 86400
+    end
+  end
+  context "fetching DNS data from API with id" do
+    setup do
+      email = "example@email.com"
+      api_key = "123456"
+      id = 1
+      data_path = File.join(File.dirname(__FILE__), "data")
+      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
+      @dns.domain.should == "example.com."
+      @dns.id.should == 1
+      @dns.ttl.should == 86400
+      @dns.status.should == "Active"
+    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)
+    end
+  end
 end

data/webbynode-api.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{webbynode-api}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shane Sveller"]
+  s.date = %q{2009-07-10}
+  s.email = %q{shanesveller@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/webbynode-api.rb",
+     "lib/webbynode-api/data.rb",
+     "test/data/client.xml",
+     "test/data/dns-1.xml",
+     "test/data/dns-records.xml",
+     "test/data/dns.xml",
+     "test/data/webby-reboot.xml",
+     "test/data/webby-shutdown.xml",
+     "test/data/webby-start.xml",
+     "test/data/webby-status-off.xml",
+     "test/data/webby-status-reboot.xml",
+     "test/data/webby-status-shutdown.xml",
+     "test/data/webby-status.xml",
+     "test/test_helper.rb",
+     "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.summary = %q{wraps the WebbyNode API into nice Ruby objects}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/webbynode-api_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shanesveller-webbynode-api
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
 - Shane Sveller
@@ -30,9 +30,21 @@ files:
 - Rakefile
 - VERSION
 - lib/webbynode-api.rb
-- test/data/api-xml-client.xml
+- lib/webbynode-api/data.rb
+- test/data/client.xml
+- test/data/dns-1.xml
+- test/data/dns-records.xml
+- test/data/dns.xml
+- test/data/webby-reboot.xml
+- test/data/webby-shutdown.xml
+- test/data/webby-start.xml
+- test/data/webby-status-off.xml
+- test/data/webby-status-reboot.xml
+- test/data/webby-status-shutdown.xml
+- test/data/webby-status.xml
 - test/test_helper.rb
 - test/webbynode-api_test.rb
+- webbynode-api.gemspec
 has_rdoc: true
 homepage: http://github.com/shanesveller/webbynode-api
 post_install_message: