godaddy23 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb0f7096b018e115f6cd9569ffb5f921199b289cf70eb7797c453706c9b25ac
-  data.tar.gz: ffed7ba33007967d6cf8cbb4cb2b71f033a85b71971b8922a5a8a1d871a2c825
+  metadata.gz: fba08155664b36e309d922e162c92f16431c5a12132ecff5e746b1dbf0a6ae0b
+  data.tar.gz: 6c5102a68816d1bc31cb5a78aa569aa836ab9dc0778d2bbcda8a52682777daa2
 SHA512:
-  metadata.gz: 5234d45d9634003f6654f6ac68efc8424f088ccc30bb48a4baeb5ca64b577778ebedef4b56a6fad6d4d5f67a6f9a0437cbac307982621c1c3a27c173994bb2aa
-  data.tar.gz: d85765dca0dadf9edcebd5c977578d714acc6f99253c974e60820f4f3251c9ac87b8a770e7e81f5e0a42478a4004f170985394434ef1868a34757383ab54e7d2
+  metadata.gz: 76d8011e3135644b5745b0c016770f91e8c0c8f4f41926a66fd46a950e861e976d141fdac396de3ded5f0aca1accecc06505d463857ed2655c52bf0afaf76e3e
+  data.tar.gz: 45fa4264607265b379eb059d940e48393ea7bf1537bdc9dc4f49ac26b8a5fd8f4456a33c45c425cba1e9816ea95b210d55a1b66a547faefce99f1f5cf8138541

data/lib/godaddy23.rb

@@ -10,6 +10,32 @@
 
 # By default this gem is set for the production environment
 
+# API reference for domains
+
+# available # GET # /v1/domains/available # Determine whether or not the specified domain is available for purchase
+# availables # POST # /v1/domains/available # Determine whether or not the specified domains are available for purchase
+# n/a # POST # /v1/domains/contacts/validate # Validate the request body using the Domain Contact Validation Schema for  specified domains.
+# n/a # POST # /v1/domains/purchase # Purchase and register the specified Domain
+# n/a # GET # /v1/domains/purchase/schema/{tld} # Retrieve the schema to be submitted when registering a Domain for the  specified TLD
+# n/a # POST # /v1/domains/purchase/validate # Validate the request body using the Domain Purchase Schema for the # specified TLD
+# n/a # GET # /v1/domains/suggest # Suggest alternate Domain names based on a seed Domain, a set of keywords, or the # shopper's purchase history
+# n/a # GET # /v1/domains/tlds # Retrieves a list of TLDs supported and enabled for sale
+# n/a # DELETE # /v1/domains/{domain} # Cancel a purchased domain
+# details # GET # /v1/domains/{domain} # Retrieve details for the specified Domain
+# n/a # PATCH # /v1/domains/{domain} # Update details for the specified Domain
+# n/a # PATCH # /v1/domains/{domain}/contacts # Update domain
+# n/a # DELETE # /v1/domains/{domain}/privacy # Submit a privacy cancellation request for the given domain
+# n/a # POST # /v1/domains/{domain}/privacy/purchase # Purchase privacy for a specified domain
+# n/a # PATCH # /v1/domains/{domain}/records # Add the specified DNS Records to the specified Domain
+# replace_records # PUT # /v1/domains/{domain}/records # Replace all DNS Records for the specified Domain
+# list_records # GET # /v1/domains/{domain}/records/{type}/{name} # Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name
+# replace_records # PUT # /v1/domains/{domain}/records/{type}/{name} # Replace all DNS Records for the specified Domain with the specified Type and Name
+# n/a # DELETE # /v1/domains/{domain}/records/{type}/{name} # Delete all DNS Records for the specified Domain with the specified Type and Name
+# replace_records # PUT # /v1/domains/{domain}/records/{type} # Replace all DNS Records for the specified Domain with the specified Type
+# n/a # POST # /v1/domains/{domain}/renew # Renew the specified Domain
+# n/a # POST # /v1/domains/{domain}/transfer # Purchase and start or restart transfer process
+# n/a # POST # /v1/domains/{domain}/verifyRegistrantEmail # Re-send Contact E-mail Verification for specified Domain
+
 
 require 'net/http'
 require 'uri'
@@ -35,7 +61,7 @@ module GoDaddy23
     #
     #
     def details(domain)
-      submit(domain)
+      get(domain)
     end
     
     # Retrieve DNS Records for the specified Domain, optionally with the
@@ -45,7 +71,7 @@ module GoDaddy23
     #   name: e.g. www
     #
     # curl -X 'GET' \
-    #   'https://api.godaddy.com/v1/domains/[MYDOMAIN]' \
+    #   'https://api.godaddy.com/v1/domains/[MYDOMAIN]/records/[TYPE]/[NAME]' \
     #   -H 'accept: application/json' \
     #   -H 'Authorization: sso-key [APIKEY]:[SECRET]
     #
@@ -60,16 +86,67 @@ module GoDaddy23
         uri += '/' + name
       end
       
-      submit(uri)
+      get(uri)
+      
+    end
+    
+    # Replace all DNS Records for the specified Domain with the specified Type and Name
+    #
+    #   type: e.g. A
+    #   name: e.g. www    
+    #
+    # warning: be careful if you don't supply a type and name as you may 
+    #          accidentally remove existing records if they are not being 
+    #          updated using the *records* keyword parameter
+    #
+    # curl -X 'PUT' \
+    #   'https://api.godaddy.com/v1/domains/[DOMAIN]/records/[TYPE]/[NAME]' \
+    #   -H 'accept: application/json' \
+    #   -H 'Content-Type: application/json' \
+    #   -H 'Authorization: sso-key [APIKEY]:[SECRET]' \
+    #   -d '[
+    # {"data":"[NEW_IP]","ttl":600}
+    # ]'    
+    #
+    def replace_records(domain, type: nil, name: nil, records: [])
+      
+      uri = domain
+      uri += '/records'
+      uri += '/' + type if type
+      
+      if name then
+        uri += '/A' if type.nil?
+        uri += '/' + name
+      end
       
+      put(uri, records)
     end
     
     private
+    
+    def get(uri_part)
+      r = submit(uri_part) do |uri|
+        Net::HTTP::Get.new(uri)        
+      end
+      JSON.parse(r.body, symbolize_names: true)      
+    end
+    
+    def put(uri_part, payload)
+      
+      r = submit(uri_part) do |uri|
+        request = Net::HTTP::Put.new(uri)        
+        request.content_type = "application/json"
+        request.body = JSON.dump(payload)
+        request
+      end
+      
+    end    
 
     def submit(s)
 
       uri = URI.parse(@url + "/v1/domains/" + s)
-      request = Net::HTTP::Get.new(uri)
+
+      request = yield(uri) if block_given?
       request["Accept"] = "application/json"
       request["Authorization"] = "sso-key %s:%s" % [@apikey, @secret]
 
@@ -81,7 +158,6 @@ module GoDaddy23
         http.request(request)
       end
 
-      JSON.parse(response.body, symbolize_names: true)
 
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: godaddy23
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - James Robertson
@@ -36,7 +36,7 @@ cert_chain:
   Yg9iNn+HpSpcgFFNYkD9AkRV4P3F0m3lGd5T/u5I61G8igHUOocGsbItrIsMUv5k
   tlXmn35NPgEcJF/WY5HMzywKhA3Vj/dVyxo=
   -----END CERTIFICATE-----
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: digital.robertson@gmail.com