dnsmadeeasy-api 0.9.6 → 0.9.7

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== Release 0.9.7 - Jul 08, 2011
+
+* FIX: API Documentation
+
 == Release 0.9.6 - Jul 08, 2011
 
 * NEW: Added CHANGELOG

data/Rakefile

@@ -2,7 +2,7 @@ require "rubygems"
 require "rake"
 require "echoe"
 
-Echoe.new("dnsmadeeasy-api", "0.9.6") do |p|
+Echoe.new("dnsmadeeasy-api", "0.9.7") do |p|
   p.description = "Ruby client for DNSMadeEasy API."
   p.summary = "Ruby client for DNSMadeEasy API."
   p.url = "http://rubygems.org/gems/dnsmadeeasy-api"

data/dnsmadeeasy-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dnsmadeeasy-api}
-  s.version = "0.9.6"
+  s.version = "0.9.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Nitesh Goel}]

data/lib/dnsmadeeasy/api.rb

@@ -90,7 +90,7 @@ module DnsMadeEasy
     end
     
     # Create a new domain entry.
-    
+    #
     # Returns a hash of the newly created domain entry, e.g.
     #   { "name" => "sigfig.com", "nameServer" => ["ns66.dnsmadeeasy.com", "ns99.dnsmadeeasy.com"], "gtdEnabled" => true }
     def create_domain!(domain)
@@ -101,7 +101,7 @@ module DnsMadeEasy
     end
     
     # Delete a domain entry.
-
+    #
     # Returns a hash of the deleted domain entry, e.g.
     #   { "name" => "sigfig.com", "nameServer" => ["ns66.dnsmadeeasy.com", "ns99.dnsmadeeasy.com"], "gtdEnabled" => true }
     def delete_domain!(domain)
@@ -113,7 +113,7 @@ module DnsMadeEasy
     end
     
     # Describe a domain entry.
-    
+    #
     # Returns a hash of the domain entry, e.g.
     #   { "name" => "sigfig.com", "nameServer" => ["ns66.dnsmadeeasy.com", "ns99.dnsmadeeasy.com"], "gtdEnabled" => true }
     def describe_domain(domain)
@@ -132,7 +132,7 @@ module DnsMadeEasy
     #
     # Returns an array of hashes, each hash representing a dns entry, e.g.
     #   [
-    #     {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" }
+    #     {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" },
     #     { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
     #   ]
     def list_records(domain, filter={})
@@ -153,15 +153,15 @@ module DnsMadeEasy
     #   :ttl         => Time to live. The amount of time a record will be cached before being refreshed. E.g. 300
     #
     # Here's a list of possible data values, with the record type they are used with:
-    # * A: <host IP>
-    # * AAAA: <IPv6 host IP>
-    # * CNAME: <target name>
-    # * HTTPRED: <redirection URL>
-    # * MX: <priority> <target name>
-    # * NS: <name server>
-    # * PTR: <target name>
-    # * SRV: <priority> <weight> <port> <target name>
-    # * TXT: <text value>
+    # * A: [host IP]
+    # * AAAA: [IPv6 host IP]
+    # * CNAME: [target name]
+    # * HTTPRED: [redirection URL]
+    # * MX: [priority] [target name]
+    # * NS: [name server]
+    # * PTR: [target name]
+    # * SRV: [priority] [weight] [port] [target name]
+    # * TXT: [text value]
     #
     # N.B. for CNAME, MX, NS, PTR, and SRV records, the domain name of the dns record is automatically
     # appended to the given data unless the data ends with a "." So, to map, say mail to mail.google.com,
@@ -207,7 +207,7 @@ module DnsMadeEasy
     # 
     # Returns an array of hashes, each hash representing a deleted dns entry, e.g.
     #   [
-    #     {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" }
+    #     {  "name" => "", "type" => "A", "data" => "127.0.0.1", "ttl" => 7200, "id" => 12345, "gtdLocation" => "DEFAULT" },
     #     { "name" => "www", "type" => "CNAME", data => "sigfig.com.", "ttl" => 7200, id => 23456, "gtdLocation" => "DEFAULT" }
     #   ]
     # An empty array is returned if no deletions are made.
@@ -238,15 +238,15 @@ module DnsMadeEasy
     #   :ttl         => Time to live. The amount of time a record will be cached before being refreshed. E.g. 300
     #
     # Here's a list of possible data values, with the record type they are used with:
-    # * A: <host IP>
-    # * AAAA: <IPv6 host IP>
-    # * CNAME: <target name>
-    # * HTTPRED: <redirection URL>
-    # * MX: <priority> <target name>
-    # * NS: <name server>
-    # * PTR: <target name>
-    # * SRV: <priority> <weight> <port> <target name>
-    # * TXT: <text value>
+    # * A: [host IP]
+    # * AAAA: [IPv6 host IP]
+    # * CNAME: [target name]
+    # * HTTPRED: [redirection URL]
+    # * MX: [priority] [target name]
+    # * NS: [name server]
+    # * PTR: [target name]
+    # * SRV: [priority] [weight] [port] [target name]
+    # * TXT: [text value]
     #
     # N.B. for CNAME, MX, NS, PTR, and SRV records, the domain name of the dns record is automatically
     # appended to the given data unless the data ends with a "." So, to map, say mail to mail.google.com,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dnsmadeeasy-api
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 9
-  - 6
-  version: 0.9.6
+  - 7
+  version: 0.9.7
 platform: ruby
 authors: 
 - Nitesh Goel