dnsimple 4.3.0 → 5.1.0

data/lib/dnsimple/client/vanity_name_servers.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module VanityNameServers
 
       # Enable vanity name servers for the domain.
       #
-      # @see https://developer.dnsimple.com/v2/vanity/#enable
+      # @see https://developer.dnsimple.com/v2/vanity/#enableVanityNameServers
       #
       # @example Enable vanity name servers for example.com:
-      #   client.vanity_name_servers.enable(1010, "example.com")
+      #   client.vanity_name_servers.enable_vanity_name_servers(1010, "example.com")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_name the domain name
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] the domain name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Array>]
       #
       # @raise  [RequestError] When the request fails.
@@ -24,14 +26,14 @@ module Dnsimple
 
       # Disable vanity name servers for the domain.
       #
-      # @see https://developer.dnsimple.com/v2/vanity/#disable
+      # @see https://developer.dnsimple.com/v2/vanity/#disableVanityNameServers
       #
       # @example Disable vanity name servers for example.com:
-      #   client.vanity_name_servers.disable(1010, "example.com")
+      #   client.vanity_name_servers.disable_vanity_name_servers(1010, "example.com")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_name the domain name
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] the domain name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<nil>]
       #
       # @raise  [RequestError] When the request fails.

data/lib/dnsimple/client/webhooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Webhooks
@@ -28,7 +30,6 @@ module Dnsimple
 
         Dnsimple::CollectionResponse.new(response, response["data"].map { |r| Struct::Webhook.new(r) })
       end
-      alias list webhooks
       alias list_webhooks webhooks
 
       # Creates a webhook in the account.
@@ -47,7 +48,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, Struct::Webhook.new(response["data"]))
       end
-      alias create create_webhook
 
       # Gets a webhook from the account.
       #
@@ -84,7 +84,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_webhook
 
     end
   end

data/lib/dnsimple/client/zones.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Zones
@@ -33,7 +35,6 @@ module Dnsimple
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Zone.new(r) })
       end
-      alias list zones
       alias list_zones zones
 
       # Lists ALL the zones in the account.

data/lib/dnsimple/client/zones_distributions.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  class Client
+    module ZonesDistributions
+
+      # Checks if a zone change is fully distributed to all DNSimple name
+      # servers across the globe.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/#checkZoneDistribution
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  zone_id [#to_s] the zone name
+      # @param  options [Hash]
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneDistribution>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def zone_distribution(account_id, zone_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/distribution" % [account_id, zone_id]), options)
+
+        Dnsimple::Response.new(response, Struct::ZoneDistribution.new(response["data"]))
+      end
+
+      # Checks if a zone record is fully distributed to all DNSimple name
+      # servers across the globe.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/records/#checkZoneRecordDistribution
+      #
+      # @example Get record 123 in zone "example.com"
+      #   client.zones.zone_record_distribution(1010, "example.com", 123)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [String] zone_id the zone name
+      # @param  [Integer] record_id the record ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneDistribution>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def zone_record_distribution(account_id, zone_id, record_id, options = {})
+        response = client.get(Client.versioned("/%s/zones/%s/records/%s/distribution" % [account_id, zone_id, record_id]), options)
+
+        Dnsimple::Response.new(response, Struct::ZoneDistribution.new(response["data"]))
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/zones_records.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module ZonesRecords
 
       # Lists the zone records in the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#list
+      # @see https://developer.dnsimple.com/v2/zones/records/#listZoneRecords
       # @see #all_records
       #
       # @example List records for the zone "example.com" in the first page
-      #   client.zones.records(1010, "example.com")
+      #   client.zones.list_zone_records(1010, "example.com")
       #
       # @example List records for the zone "example.com", provide a specific page
-      #   client.zones.records(1010, "example.com", page: 2)
+      #   client.zones.list_zone_records(1010, "example.com", page: 2)
       #
       # @example List records for the zone "example.com", sorting in ascending order
-      #   client.zones.records(1010, "example.com", sort: "type:asc")
+      #   client.zones.list_zone_records(1010, "example.com", sort: "type:asc")
       #
       # @example List records for the zone "example.com", filtering by 'A' record type
-      #   client.zones.records(1010, "example.com", filter: { type: 'A' })
+      #   client.zones.list_zone_records(1010, "example.com", filter: { type: 'A' })
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -30,13 +32,12 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def records(account_id, zone_id, options = {})
+      def zone_records(account_id, zone_id, options = {})
         response = client.get(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), Options::ListOptions.new(options))
 
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::ZoneRecord.new(r) })
       end
-      alias list records
-      alias list_records records
+      alias list_zone_records zone_records
 
       # Lists ALL the zone records in the account.
       #
@@ -46,11 +47,11 @@ 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/zones/records/#list
+      # @see https://developer.dnsimple.com/v2/zones/records/#listZoneRecords
       # @see #records
       #
       # @example List all records for the zone "example.com"
-      #   client.zones.all_records(1010, "example.com")
+      #   client.zones.all_zone_records(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -63,17 +64,16 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def all_records(account_id, zone_id, options = {})
-        paginate(:records, account_id, zone_id, options)
+      def all_zone_records(account_id, zone_id, options = {})
+        paginate(:list_zone_records, account_id, zone_id, options)
       end
-      alias all all_records
 
       # Creates a zone record in the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#create
+      # @see https://developer.dnsimple.com/v2/zones/records/#createZoneRecord
       #
       # @example Create a URL record in zone "example.com"
-      #   client.zones.create_record(1010, "example.com", name: "www", type: "url", content: "example.com")
+      #   client.zones.create_zone_record(1010, "example.com", name: "www", type: "url", content: "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -83,20 +83,19 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def create_record(account_id, zone_id, attributes, options = {})
+      def create_zone_record(account_id, zone_id, attributes, options = {})
         Extra.validate_mandatory_attributes(attributes, [:type, :name, :content])
         response = client.post(Client.versioned("/%s/zones/%s/records" % [account_id, zone_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
-      alias create create_record
 
       # Gets a zone record from the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#get
+      # @see https://developer.dnsimple.com/v2/zones/records/#getZoneRecord
       #
       # @example Get record 123 in zone "example.com"
-      #   client.zones.record(1010, "example.com", 123)
+      #   client.zones.zone_record(1010, "example.com", 123)
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -106,7 +105,7 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def record(account_id, zone_id, record_id, options = {})
+      def zone_record(account_id, zone_id, record_id, options = {})
         response = client.get(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), options)
 
         Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
@@ -114,10 +113,10 @@ module Dnsimple
 
       # Updates a zone record in the account.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#update
+      # @see https://developer.dnsimple.com/v2/zones/records/#updateZoneRecord
       #
       # @example Update the TTL to 600 of record 123 in zone "example.com"
-      #   client.zones.update_record(1010, "example.com", 123, ttl: 600)
+      #   client.zones.update_zone_record(1010, "example.com", 123, ttl: 600)
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -128,21 +127,20 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def update_record(account_id, zone_id, record_id, attributes, options = {})
+      def update_zone_record(account_id, zone_id, record_id, attributes, options = {})
         response = client.patch(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), attributes, options)
 
         Dnsimple::Response.new(response, Struct::ZoneRecord.new(response["data"]))
       end
-      alias update update_record
 
       # Deletes a zone record from the account.
       #
       # WARNING: this cannot be undone.
       #
-      # @see https://developer.dnsimple.com/v2/zones/records/#delete
+      # @see https://developer.dnsimple.com/v2/zones/records/#deleteZoneRecord
       #
       # @example Delete record 123 in zone "example.com"
-      #   client.zones.delete_record(1010, "example.com", 123)
+      #   client.zones.delete_zone_record(1010, "example.com", 123)
       #
       # @param  [Integer] account_id the account ID
       # @param  [String] zone_id the zone name
@@ -152,12 +150,11 @@ module Dnsimple
       #
       # @raise  [Dnsimple::NotFoundError]
       # @raise  [Dnsimple::RequestError]
-      def delete_record(account_id, zone_id, record_id, options = {})
+      def delete_zone_record(account_id, zone_id, record_id, options = {})
         response = client.delete(Client.versioned("/%s/zones/%s/records/%s" % [account_id, zone_id, record_id]), nil, options)
 
         Dnsimple::Response.new(response, nil)
       end
-      alias delete delete_record
 
     end
   end

data/lib/dnsimple/default.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Dnsimple
 
   # Default configuration options for {Client}
   module Default
 
     # Default API endpoint
-    BASE_URL = "https://api.dnsimple.com/".freeze
+    BASE_URL = "https://api.dnsimple.com/"
 
     # Default User Agent header
-    USER_AGENT = "dnsimple-ruby/#{VERSION}".freeze
+    USER_AGENT = "dnsimple-ruby/#{VERSION}"
 
     class << self
 
@@ -15,13 +17,13 @@ module Dnsimple
       # @return [Array] of option keys
       def keys
         @keys ||= [
-            :base_url,
-            :username,
-            :password,
-            :access_token,
-            :domain_api_token,
-            :user_agent,
-            :proxy,
+          :base_url,
+          :username,
+          :password,
+          :access_token,
+          :domain_api_token,
+          :user_agent,
+          :proxy,
         ]
       end
 

data/lib/dnsimple/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
 
   class Error < StandardError

data/lib/dnsimple/extra.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   module Extra
 

data/lib/dnsimple/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   module Options
 

data/lib/dnsimple/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
 
   # The Response represents a response returned by a client request.
@@ -69,10 +71,10 @@ module Dnsimple
       super
 
       pagination = http_response["pagination"]
-      @page           = pagination["current_page"]
-      @per_page       = pagination["per_page"]
-      @total_entries  = pagination["total_entries"]
-      @total_pages    = pagination["total_pages"]
+      @page = pagination["current_page"]
+      @per_page = pagination["per_page"]
+      @total_entries = pagination["total_entries"]
+      @total_pages = pagination["total_pages"]
     end
 
   end

data/lib/dnsimple/struct.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   module Struct
 
@@ -18,6 +20,8 @@ require_relative 'struct/collaborator'
 require_relative 'struct/contact'
 require_relative 'struct/certificate'
 require_relative 'struct/certificate_bundle'
+require_relative 'struct/certificate_purchase'
+require_relative 'struct/certificate_renewal'
 require_relative 'struct/delegation_signer_record'
 require_relative 'struct/dnssec'
 require_relative 'struct/domain'
@@ -36,8 +40,11 @@ require_relative 'struct/template'
 require_relative 'struct/template_record'
 require_relative 'struct/tld'
 require_relative 'struct/user'
+require_relative 'struct/vanity_name_server'
 require_relative 'struct/whois_privacy'
+require_relative 'struct/whois_privacy_renewal'
 require_relative 'struct/zone'
 require_relative 'struct/zone_file'
+require_relative 'struct/zone_distribution'
 require_relative 'struct/webhook'
 require_relative 'struct/whoami'

data/lib/dnsimple/struct/account.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   module Struct
 

data/lib/dnsimple/struct/certificate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   module Struct
 
@@ -8,9 +10,15 @@ module Dnsimple
       # @return [Integer] The associated domain ID.
       attr_accessor :domain_id
 
+      # @return [Integer] The associated contact ID.
+      attr_accessor :contact_id
+
       # @return [String] The certificate common name.
       attr_accessor :common_name
 
+      # @return [Array<String>] The certificate alternate names.
+      attr_accessor :alternate_names
+
       # @return [Integer] The years the certificate will last.
       attr_accessor :years
 
@@ -23,6 +31,9 @@ module Dnsimple
       # @return [String] The Certificate Authority (CA) that issued the certificate.
       attr_accessor :authority_identifier
 
+      # @return [Boolean] True if the certificate is set to auto-renew on expiration.
+      attr_accessor :auto_renew
+
       # @return [String] When the certificate was created in DNSimple.
       attr_accessor :created_at