dnsimple 4.3.0 → 5.1.0

data/lib/dnsimple/client/clients.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
 
@@ -137,7 +139,7 @@ module Dnsimple
     require_relative 'domains_dnssec'
     require_relative 'domains_email_forwards'
     require_relative 'domains_pushes'
-    require_relative 'collaborators'
+    require_relative 'domains_collaborators'
 
     class DomainsService < ClientService
       include Client::Domains
@@ -145,7 +147,7 @@ module Dnsimple
       include Client::DomainsDnssec
       include Client::DomainsEmailForwards
       include Client::DomainsPushes
-      include Client::Collaborators
+      include Client::DomainsCollaborators
     end
 
 
@@ -212,10 +214,12 @@ module Dnsimple
 
     require_relative 'zones'
     require_relative 'zones_records'
+    require_relative 'zones_distributions'
 
     class ZonesService < ClientService
       include Client::Zones
       include Client::ZonesRecords
+      include Client::ZonesDistributions
     end
 
 

data/lib/dnsimple/client/contacts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Contacts
@@ -29,7 +31,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Contact.new(r) })
       end
-      alias list contacts
       alias list_contacts contacts
 
       # Lists ALL the contacts in the account.
@@ -54,7 +55,6 @@ module Dnsimple
       def all_contacts(account_id, options = {})
         paginate(:contacts, account_id, options)
       end
-      alias all all_contacts
 
       # Creates a contact in the account.
       #
@@ -72,7 +72,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Contact.new(response["data"]))
       end
-      alias create create_contact
 
       # Gets a contact from the account.
       #
@@ -107,7 +106,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Contact.new(response["data"]))
       end
-      alias update update_contact
 
       # Deletes a contact from the account.
       #
@@ -127,7 +125,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_contact
 
     end
   end

data/lib/dnsimple/client/domains.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Domains
@@ -14,7 +16,7 @@ module Dnsimple
       #   client.domains.list(1010, page: 2)
       #
       # @example List domains, provide a sorting policy
-      #   client.domains.list(1010, sort: "expires_on:asc")
+      #   client.domains.list(1010, sort: "expiration:asc")
       #
       # @example List domains, provide a filtering policy
       #   client.domains.list(1010, filter: { name_like: "example" })
@@ -33,7 +35,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Domain.new(r) })
       end
-      alias list domains
       alias list_domains domains
 
       # Lists ALL the domains in the account.
@@ -59,7 +60,6 @@ module Dnsimple
       def all_domains(account_id, options = {})
         paginate(:domains, account_id, options)
       end
-      alias all all_domains
 
       # Creates a domain in the account.
       #
@@ -78,7 +78,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
       end
-      alias create create_domain
 
       # Gets a domain from the account.
       #
@@ -115,7 +114,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_domain
 
       # Resets the domain token.
       #

data/lib/dnsimple/client/{collaborators.rb → domains_collaborators.rb}

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
-    module Collaborators
+    module DomainsCollaborators
 
       # Lists the collaborators for a domain.
       #

data/lib/dnsimple/client/domains_delegation_signer_records.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsDelegationSignerRecords

data/lib/dnsimple/client/domains_dnssec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsDnssec

data/lib/dnsimple/client/domains_email_forwards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsEmailForwards

data/lib/dnsimple/client/domains_pushes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsPushes

data/lib/dnsimple/client/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Identity

data/lib/dnsimple/client/oauth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Oauth

data/lib/dnsimple/client/registrar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Registrar
@@ -7,7 +9,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#check
       #
       # @example Check whether example.com is available:
-      #   client.registrar.check(1010, "example.com")
+      #   client.registrar.check_domain(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
@@ -54,7 +56,7 @@ module Dnsimple
       #
       # @example Initiate the registration of example.com using the contact 1234 as registrant
       #   including WHOIS privacy for the domain and enabling auto renewal:
-      #   client.registrar.register(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
+      #   client.registrar.register_domain(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to register
@@ -76,7 +78,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#renew
       #
       # @example Renew example.com for 3 years:
-      #   client.registrar.renew(1010, "example.com", period: 3)
+      #   client.registrar.renew_domain(1010, "example.com", period: 3)
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to renew
@@ -97,7 +99,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#transfer
       #
       # @example Initiate the transfer for example.com using the contact 1234 as registrant:
-      #   client.registrar.transfer(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
+      #   client.registrar.transfer_domain(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer
@@ -114,12 +116,56 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
       end
 
+      # Retrieves the details of an existing domain transfer.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainTransfer
+      #
+      # @example Retrieve the transfer 42 for example.com:
+      #   client.registrar.get_domain_transfer(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_transfer_id the domain transfer ID
+      # @param  [Hash] options
+      # @return [Struct::DomainTransfer]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def get_domain_transfer(account_id, domain_name, domain_transfer_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/transfers/%s" % [account_id, domain_name, domain_transfer_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
+      end
+
+      # Cancels an in progress domain transfer.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#cancelDomainTransfer
+      #
+      # @example Cancel the transfer 42 for example.com:
+      #   client.registrar.cancel_domain_transfer(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_transfer_id the domain transfer ID
+      # @param  [Hash] options
+      # @return [Struct::DomainTransfer]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def cancel_domain_transfer(account_id, domain_name, domain_transfer_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/transfers/%s" % [account_id, domain_name, domain_transfer_id])
+        response = client.delete(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
+      end
+
       # Requests the transfer of a domain out of DNSimple.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#transfer-out
       #
       # @example Request to transfer of example.com out of DNSimple:
-      #   client.registrar.transfer_out(1010, "example.com")
+      #   client.registrar.transfer_domain_out(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer out

data/lib/dnsimple/client/registrar_auto_renewal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module RegistrarAutoRenewal

data/lib/dnsimple/client/registrar_delegation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module RegistrarDelegation
@@ -56,19 +58,19 @@ module Dnsimple
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Array] attributes
       # @param  [Hash] options
-      # @return [Dnsimple::Response<Array>]
+      # @return [Dnsimple::Response<Array<Dnsimple::Struct::VanityNameServer>>]
       #
       # @raise  [RequestError] When the request fails.
       def change_domain_delegation_to_vanity(account_id, domain_name, attributes, options = {})
         endpoint = Client.versioned("/%s/registrar/domains/%s/delegation/vanity" % [account_id, domain_name])
         response = client.put(endpoint, attributes, options)
 
-        Dnsimple::Response.new(response, response["data"])
+        Dnsimple::Response.new(response, response["data"].map { |r| Struct::VanityNameServer.new(r) })
       end
 
       # Disable vanity name servers for the domain.
       #
-      # @see https://developer.dnsimple.com/v2/registrar/delegation/#delegateFromVanity
+      # @see https://developer.dnsimple.com/v2/registrar/delegation/#dedelegateFromVanity
       #
       # @example Disable vanity name servers for example.com:
       #   client.registrar.change_domain_delegation_from_vanity(1010, "example.com")
@@ -83,7 +85,7 @@ module Dnsimple
         endpoint = Client.versioned("/%s/registrar/domains/%s/delegation/vanity" % [account_id, domain_name])
         response = client.delete(endpoint, options)
 
-        Dnsimple::Response.new(response, response["data"])
+        Dnsimple::Response.new(response, nil)
       end
 
     end

data/lib/dnsimple/client/registrar_whois_privacy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module RegistrarWhoisPrivacy
@@ -50,7 +52,7 @@ module Dnsimple
       #   client.registrar.disable_whois_privacy(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_name The domain name to check.
+      # @param  [#to_s] domain_name The domain name
       # @param  [Hash] options
       # @return [Struct::WhoisPrivacy]
       #
@@ -62,6 +64,26 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::WhoisPrivacy.new(response["data"]))
       end
 
+      # Renews whois privacy for the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/whois-privacy/#renew
+      #
+      # @example Renew whois privacy for "example.com":
+      #   client.registrar.renew_whois_privacy(1010, "example.com")
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] The domain name
+      # @param  options [Hash]
+      # @return [Struct::WhoisPrivacy]
+      #
+      # @raise  [RequestError] When the request fails.
+      def renew_whois_privacy(account_id, domain_name, options = {})
+        endpoint = whois_privacy_endpoint(account_id, domain_name) + "/renewals"
+        response = client.post(endpoint, nil, options)
+
+        Dnsimple::Response.new(response, Struct::WhoisPrivacyRenewal.new(response["data"]))
+      end
+
 
       private
 

data/lib/dnsimple/client/services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Services
@@ -28,7 +30,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Service.new(r) })
       end
-      alias list services
       alias list_services services
 
       # Lists ALL the available one-click services.
@@ -55,7 +56,6 @@ module Dnsimple
       def all_services(options = {})
         paginate(:services, options)
       end
-      alias all all_services
 
       # Gets the service with specified ID.
       #

data/lib/dnsimple/client/services_domains.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module ServicesDomains

data/lib/dnsimple/client/templates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Templates

data/lib/dnsimple/client/templates_domains.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module TemplatesDomains

data/lib/dnsimple/client/templates_records.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module TemplatesRecords

data/lib/dnsimple/client/tlds.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Tlds
-      # Lists the tlds available for registration
+      # Lists the TLDs available for registration
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#list
+      # @see https://developer.dnsimple.com/v2/tlds/#listTlds
       #
       # @example List TLDs in the first page
-      #   client.tlds.list
+      #   client.tlds.list_tlds
       #
       # @example List TLDs, providing a specific page
-      #   client.tlds.list(page: 2)
+      #   client.tlds.list_tlds(page: 2)
       #
       # @example List TLDs, providing sorting policy
-      #   client.tlds.list(sort: "tld:asc")
+      #   client.tlds.list_tlds(sort: "tld:asc")
       #
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -21,13 +23,11 @@ module Dnsimple
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Tld>]
       #
       # @raise [Dnsimple::RequestError]
-      def tlds(options = {})
+      def list_tlds(options = {})
         response = client.get(Client.versioned("/tlds"), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Tld.new(r) })
       end
-      alias list tlds
-      alias list_tlds tlds
 
       # Lists ALL the TLDs in DNSimple.
       #
@@ -37,8 +37,8 @@ module Dnsimple
       # Please use this method carefully, as fetching the entire collection will increase the number of requests
       # you send to the API server and you may eventually risk to hit the throttle limit.
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#list
-      # @see #tlds
+      # @see https://developer.dnsimple.com/v2/tlds/#listTlds
+      # @see #list_tlds
       #
       # @example List all TLDs in DNSimple
       #     client.tlds.all
@@ -51,13 +51,12 @@ module Dnsimple
       #
       # @raise [Dnsimple::RequestError]
       def all_tlds(options = {})
-        paginate(:tlds, options)
+        paginate(:list_tlds, options)
       end
-      alias all all_tlds
 
-      # Gets a TLD's details
+      # Gets a TLD details
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#get
+      # @see https://developer.dnsimple.com/v2/tlds/#getTld
       #
       # @example Get information on a specific TLD
       #     client.tlds.tld('com')
@@ -76,10 +75,10 @@ module Dnsimple
 
       # Gets the extended attributes for a TLD.
       #
-      # @see https://developer.dnsimple.com/v2/tlds/#extended-attributes
+      # @see https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes
       #
       # @example Get extended attributes for a specific TLD
-      #     client.tlds.extended_attributes('uk')
+      #     client.tlds.tld_extended_attributes('uk')
       #
       # @param  [#to_s] tld The TLD name.
       # @param  [Hash] options
@@ -87,7 +86,7 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def extended_attributes(tld, options = {})
+      def tld_extended_attributes(tld, options = {})
         response = client.get(Client.versioned("/tlds/%s/extended_attributes" % tld), options)
 
         Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::ExtendedAttribute.new(r) })