shanesveller-webbynode-api 0.2.4 → 0.2.5

data/README.markdown

@@ -11,6 +11,7 @@ is currently based on the API guide version 2.
 * Webby information (status) and simple actions (start, shutdown, reboot)
 * List all webbies
 * DNS zone information such as domain name, TTL, and status
+* Look up DNS zone by domain name
 * List of all individual records in a given DNS zone
 * Creation/deletion of DNS zones
 * Activation/deactivation of DNS zones

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/webbynode-api/dns.rb

@@ -142,6 +142,25 @@ class WebbyNode
         raise ArgumentError, ":id is a required argument" unless options[:id]
         return auth_post("/api/xml/dns/#{options[:id]}/delete", :query => options)["hash"]["success"]
       end
+
+      # @since 0.2.5
+      # @option options [String] :email E-mail address used for API access
+      # @option options [String] :token API token used for API access
+      # @option options [String] :domain Domain name to search for
+      # @return [Hash, nil] Returns a hash of data about the zone if it exists
+      #   or nil
+      # @raise [ArgumentError] Raises ArgumentError if :token, :email or :domain
+      #   are missing from the options parameter
+      # @example Look up a zone for the domain "example.com." (Note the final period.)
+      #   WebbyNode::DNS::Zone.find_by_domain(:email => @email, :token => @token,
+      #   :domain => "example.com.")
+      def self.find_by_domain(options = {})
+        raise ArgumentError, ":domain is a required argument" unless options[:domain]
+        domain = options[:domain]
+        all_zones = ZoneList.new(:email => options[:email], :token => options[:token])
+        all_zones.data.reject! {|zone| zone["domain"] != domain}
+        return all_zones.data.first || nil
+      end
     end
 
     # Represents an Array of all DNS zones present on the API account

data/test/dns_test.rb

@@ -250,4 +250,34 @@ class WebbyNodeDNSTest < Test::Unit::TestCase
       WebbyNode::DNS::Record.delete(:email => @email, :token => @token, :id => @id)
     end
   end
+  context "when finding a zone by name" do
+    setup do
+      @email = "example@email.com"
+      @token = "123456"
+      @domain = "example.com."
+      data_path = File.join(File.dirname(__FILE__), "data", "dns")
+      FakeWeb.clean_registry
+      FakeWeb.register_uri(:get, /^https:\/\/manager\.webbynode\.com\/api\/xml\/dns\?.+/i, :body => File.read("#{data_path}/dns.xml"))
+    end
+    should "raise ArgumentError if :domain argument is absent" do
+      assert_raise(ArgumentError, ":domain is a required argument"){ WebbyNode::DNS::Zone.find_by_domain(:email => @email, :token => @token, :domain => nil)}
+      assert_nothing_raised{ WebbyNode::DNS::Zone.find_by_domain(:email => @email, :token => @token, :domain => @domain)}
+    end
+    should "return nil unless domain exists in a zone on account" do
+      for bad_zone in %w(example2.com baddomain.com nonexistant.com)
+        zone = WebbyNode::DNS::Zone.find_by_domain(:email => @email, :token => @token, :domain => bad_zone)
+        zone.should be(nil)
+      end
+    end
+    should "return a hash for the domain if a zone exists" do
+      zone = WebbyNode::DNS::Zone.find_by_domain(:email => @email, :token => @token, :domain => @domain)
+      zone.should_not be(nil)
+      zone.is_a?(Hash).should be(true)
+      zone["domain"].should == @domain
+      zone["id"].should == 1
+      zone = WebbyNode::DNS::Zone.find_by_domain(:email => @email, :token => @token, :domain => "inactive.com.")
+      zone["domain"].should == "inactive.com."
+      zone["id"].should == 132
+    end
+  end
 end

data/webbynode-api.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{webbynode-api}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Sveller"]
-  s.date = %q{2009-07-17}
+  s.date = %q{2009-07-22}
   s.default_executable = %q{webby}
   s.email = %q{shanesveller@gmail.com}
   s.executables = ["webby"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shanesveller-webbynode-api
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Shane Sveller
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-17 00:00:00 -07:00
+date: 2009-07-22 00:00:00 -07:00
 default_executable: webby
 dependencies: 
 - !ruby/object:Gem::Dependency