mtgsy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eb81b3ca3aa7b5260a4ac6ffdaa495443a50c07
-  data.tar.gz: 3c3bc8c0a0606530490ba26b4957f685d3edf2d6
+  metadata.gz: bc6b8e0b7879d36ff3ab5654de17ba77eb69d8c4
+  data.tar.gz: ce784a9ed3e24a25a7f78376c61e4148ad9c101b
 SHA512:
-  metadata.gz: ceec4d977f42565e3623d94045ee0414ea21240d15fbde873aadd9fd673785af1cb817436d8526f9ddf6e1243a9083bec77fcf2292309e131611a00048141381
-  data.tar.gz: 592b20fd9d189d2356419eb84b467154d691c2aacf9e9c5c8198a59043a24b02c99a3ec34916f70b0924e6b55b4b41d6a55544db8392e637826e1027c507bc87
+  metadata.gz: e09afa49dbad2e5ad2be48a5eddd42cf7db900e02595997e38b03785d82b88f432a8b68b184bb3dcd7a3be7e8806af66f1d1fd65ee4a7400e1af8af6637b8d59
+  data.tar.gz: 0d91bb1e5c49c9413660afd95b35247937fdbde74a7667b3611e5ee081bcf4f1b7954dcfc0c10adeb842cd73658fce98010de4444458aa0787eb7c72d2e38f28

data/README.md

@@ -18,8 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
+    ## Start things off...
+    require 'mtgsy'
     client = Mtgsy::ApiClient.new(username: "my_username", password: "my_password", domainname: "mydomain.com")
-    client.add_record(name: "www", type: "A", data: "127.0.0.1", aux: "0", ttl: "3600")
+
+    ## Add records
+    client.add_record(name: "www1", type: "A", data: "127.0.0.1")
+    client.add_record(name: "www2", type: "A", data: "127.0.0.2", ttl: "3600")
+    client.add_record(name: "www3", type: "A", data: "127.0.0.3", ttl: "3600", aux: "5")
+
+    ## Update records
+    client.update_record(name: "www1", type: "A", data: "127.0.0.11")
+
+    ## Delete records:
+    client.delete_record(name: "www1")
+    client.delete_record(name: "www2")
+    client.delete_record(name: "www3")
+
+    ## List all records in a zone:
+    client.records("ALL")    # Returns an array of _all_ records in the zone
+    client.records("A")      # Returns an array of all A records in the zone
+    client.records("CNAME")  # Returns an array of all CNAME records in the zone
+    client.records("AAAA")   # Returns an array of all AAAA records in the zone
+
+    ## List all possible records types:
+    client.record_types?
 
 ## Contributing
 

data/lib/mtgsy/api_client.rb

@@ -8,13 +8,14 @@ module Mtgsy
       @api_endpoint = "https://www.mtgsy.net/dns/api.php"
       @record_types = [ 'A', 'AAAA', 'CNAME', 'HINFO', 'MX', 'NS', 'PTR', 'RP', 'SRV', 'TXT' ]
 
-      @debug        = options[:debug] ? options[:debug] : false
+      @debug        = options[:debug]      ? options[:debug]      : false
 
+      ## these are for setting up global defaults. they can be overridden though
       # attr_accessor
-      @domainname = options[:domainname] ? options[:domainname] : nil
-      @username   = options[:username]   ? options[:username]   : nil
-      @ttl        = options[:ttl]        ? options[:ttl]        : 900
-      @aux = 0
+      @domainname   = options[:domainname] ? options[:domainname] : nil
+      @username     = options[:username]   ? options[:username]   : nil
+      @aux          = options[:aux]        ? options[:aux]        : 0
+      @ttl          = options[:ttl]        ? options[:ttl]        : 900
 
       # attr_writer
       @password     = options[:password]   ? options[:password]   : nil
@@ -62,6 +63,10 @@ module Mtgsy
       what_happened?(@agent, command)
     end
 
+    alias :add    :add_record
+    alias :delete :delete_record
+    alias :update :update_record
+
     def refresh!
       command = "listrecords"
       post_to_mtgsy([ command ])
@@ -78,9 +83,12 @@ module Mtgsy
         end
         instance_variable_set("@records_#{x}", tmp_placeholder)
       end
+
+      nil
     end
 
     def records(type="ALL")
+      type.upcase!
       self.refresh! unless @records_ALL
 
       eval("@records_#{type}")
@@ -115,6 +123,7 @@ module Mtgsy
         @agent.post(@api_endpoint, post_data)
       end
 
+      ## I included `command` just in case one day the responses are different depending on the command used
       def what_happened?(mechanize_instance, command)
         mtgsy_return_code = mechanize_instance.page.body.match(/[0-9]+/)[0].to_i
 

data/lib/mtgsy/version.rb

@@ -1,3 +1,3 @@
 module Mtgsy
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtgsy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Barnett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize