dnsimple 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfd2d022a76ad12b6b4259ce10a2f349c618a31f
-  data.tar.gz: 30bb0e50b7d8ed4662c113c70a84c584ae1d9a55
+  metadata.gz: e0f3e109fc2b3c88b76f2f569764e32792a626f7
+  data.tar.gz: e092631aa456c81f5a77076fab26334f2c9f93a0
 SHA512:
-  metadata.gz: 45b87521f74759ff510845caa7f3b661ce80af3d40aecaa962655296b07b5fab90ceb358e3f180a0a5f736105faadcb38a55078771961073303f496838a5d219
-  data.tar.gz: 364c11eb5e67241ff9123e67fa4ce5af26358c8d03eee7f5692b480cf882f56b155144f1c853f92b4b9072a97b69ed55f0fcb9792bb4b7448dd66830c0185b36
+  metadata.gz: f6393c8b54b069a15bd4cdce2e259586f7dde2c979b50bcddbeae5aa40015b08e6c6429851eba324daabbb7e27d05aa42f333bc09244032bb22790967762b9a6
+  data.tar.gz: 6f403fdb0107e7f8e50bee41ce24244ee5a1ae398835670bbdf19b369b0116f8d70788dd72f07bf1fd61e82821b277acb798807ea605b00f2593391f060693ad

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
+#### 4.1.0
+
+- NEW: Added domain premium price support (dnsimple/dnsimple-ruby#143)
+
+- CHANGED: Updated registration, transfer, renewal response payload (dnsimple/dnsimple-developer#111, dnsimple/dnsimple-ruby#140).
+- CHANGED: Normalize unique string identifiers to SID (dnsimple/dnsimple-ruby#141)
+
 
 #### 4.0.0
 

data/README.md

@@ -9,13 +9,6 @@ A Ruby client for the [DNSimple API v2](https://developer.dnsimple.com/v2/).
 We provide a full API and an easy-to-use web interface so you can get your domain registered and set up with a minimal amount of effort.
 
 
-## :warning: Beta Warning
-
-This branch targets the development of the API client for the [DNSimple API v2](https://developer.dnsimple.com/v2/). If you are looking for the stable version of the client for [DNSimple API v1](https://developer.dnsimple.com/v1/) then use the [`master-v1`](https://github.com/dnsimple/dnsimple-ruby/tree/master-v1) branch.
-
-This library is currently in beta version, the methods and the implementation should be considered a work-in-progress. Changes in the method naming, method signatures, public or internal APIs may happen during the beta period.
-
-
 ## Installation
 
 You can install the gem manually:
@@ -27,7 +20,7 @@ $ gem install dnsimple
 Or use Bundler and define it as a dependency in your Gemfile:
 
 ```
-gem 'dnsimple', '~> 3.0'
+gem 'dnsimple', '~> 4.0'
 ```
 
 ## Usage

data/lib/dnsimple/client/certificates.rb

@@ -16,7 +16,7 @@ module Dnsimple
       # @example List certificates, provide a sorting policy
       #   client.certificates.list(1010, "example.com", sort: "email:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -34,9 +34,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/certificates/#get
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or domain name
-      # @param  [Fixnum] certificate_id the certificate ID
+      # @param  [Integer] certificate_id the certificate ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Certificate>]
       #
@@ -52,9 +52,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/certificates/#download
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or domain name
-      # @param  [Fixnum] certificate_id the certificate ID
+      # @param  [Integer] certificate_id the certificate ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::CertificateBundle>]
       #
@@ -70,9 +70,9 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/certificates/#get-private-key
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or domain name
-      # @param  [Fixnum] certificate_id the certificate ID
+      # @param  [Integer] certificate_id the certificate ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::CertificateBundle>]
       #

data/lib/dnsimple/client/collaborators.rb

@@ -12,7 +12,7 @@ module Dnsimple
       # @example List collaborators, provide a specific page
       #   client.domains.collaborators(1010, "example.com", page: 2)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or name
       # @param  [Hash] request options
       # @option options [Integer] :page current page (pagination)
@@ -33,7 +33,7 @@ module Dnsimple
       # @example Add collaborator
       #   client.domains.add_collaborator(1010, "example.com", email: "user@example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or name
       # @param  [Hash] user attributes
       # @param  attributes [String] :email user email (mandatory)
@@ -57,7 +57,7 @@ module Dnsimple
       # @example Remove collaborator
       #   client.domains.remove_collaborator(1010, "example.com", 999)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id the domain ID or name
       # @param  [#to_s] contact_id the contact ID
       # @param  [Hash] request options

data/lib/dnsimple/client/contacts.rb

@@ -16,7 +16,7 @@ module Dnsimple
       # @example List contacts, provide a sorting policy
       #   client.contacts.list(1010, sort: "email:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -43,7 +43,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/contacts/#list
       # @see #contacts
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -60,7 +60,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#create
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] attributes
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Contact>]
@@ -78,7 +78,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#get
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] contact_id the contact ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Contact>]
@@ -95,7 +95,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#update
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] contact_id the contact ID
       # @param  [Hash] attributes
       # @param  [Hash] options
@@ -115,7 +115,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/contacts/#delete
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] contact_id the contact ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/domains.rb

@@ -19,7 +19,7 @@ module Dnsimple
       # @example List domains, provide a filtering policy
       #   client.domains.list(1010, filter: { name_like: "example" })
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -47,7 +47,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/domains/#list
       # @see #domains
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting option
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -65,7 +65,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#create
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] attributes
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
@@ -84,7 +84,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#get
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<Dnsimple::Struct::Domain>]
@@ -103,7 +103,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#delete
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
@@ -121,7 +121,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/#reset-token
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/domains_email_forwards.rb

@@ -15,7 +15,7 @@ module Dnsimple
       # @example List email forwards, provide a sorting policy
       #   client.domains.email_forwards(1010, "example.com", sort: "from:asc")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
@@ -42,7 +42,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#list
       # @see #email_forwards
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] options the filtering and sorting option
       # @option options [Integer] :page current page (pagination)
@@ -59,7 +59,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#create
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] attributes
       # @param  [Hash] options
@@ -77,7 +77,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#get
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [#to_s] email_forward_id The email forward ID
       # @param  [Hash] options
@@ -97,7 +97,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/domains/email-forwards/#delete
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [#to_s] email_forward_id The email forward ID
       # @param  [Hash] options

data/lib/dnsimple/client/domains_pushes.rb

@@ -9,7 +9,7 @@ module Dnsimple
       # @example Initiate a domain pushe for example.com:
       #   client.domains.initiate_push(1010, "example.com", new_account_email: "admin@target-account.test")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
       # @param  [Hash] attributes
       # @option attributes [String] :new_account_email the target account email (mandatory)
@@ -34,7 +34,7 @@ module Dnsimple
       # @example List domain pushes, provide a specific page
       #   client.domains.pushes(2020, page: 2)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [Hash] options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
@@ -55,8 +55,8 @@ module Dnsimple
       # @example Accept a domain push in the target account:
       #   client.domains.accept_push(2020, 1, contact_id: 2)
       #
-      # @param  [Fixnum] account_id the target account ID
-      # @param  [Fixnum] push_id the domain push ID
+      # @param  [Integer] account_id the target account ID
+      # @param  [Integer] push_id the domain push ID
       # @param  [Hash] options
       # @param  [Hash] attributes
       # @option attributes [Integer] :contact_id the contact ID (mandatory)
@@ -78,8 +78,8 @@ module Dnsimple
       # @example Reject a domain push in the target account:
       #   client.domains.reject_push(2020, 1, contact_id: 2)
       #
-      # @param  [Fixnum] account_id the target account ID
-      # @param  [Fixnum] push_id the domain push ID
+      # @param  [Integer] account_id the target account ID
+      # @param  [Integer] push_id the domain push ID
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
       #

data/lib/dnsimple/client/registrar.rb

@@ -9,7 +9,7 @@ module Dnsimple
       # @example Check whether example.com is available:
       #   client.registrar.check(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Hash] options
       # @return [Struct::DomainCheck]
@@ -22,6 +22,32 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainCheck.new(response["data"]))
       end
 
+      # Checks the premium price for a domain
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#premium-price
+      #
+      # @example Check the ruby.codes premium price:
+      #   client.registrar.domain_premium_price(1010, "ruby.codes")
+      #
+      # @example Check the ruby.codes premium price for transfer:
+      #   client.registrar.domain_premium_price(1010, "ruby.codes", action: "transfer")
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name to check
+      # @param  [Hash] options
+      # @option options [String] :action Optional action between "registration",
+      #   "renewal", and "transfer". If omitted, it defaults to "registration".
+      # @return [Struct::DomainPremiumPrice]
+      #
+      # @raise  [RequestError] When the request fails.
+      def domain_premium_price(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/premium_price" % [account_id, domain_name])
+        options[:query] = { action: options.delete(:action) } if options.key?(:action)
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainPremiumPrice.new(response["data"]))
+      end
+
       # Registers a domain.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#register
@@ -30,11 +56,11 @@ module Dnsimple
       #   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)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to register
       # @param  [Hash] attributes
       # @param  [Hash] options
-      # @return [Struct::Domain]
+      # @return [Struct::DomainRegistration]
       #
       # @raise  [RequestError] When the request fails.
       def register_domain(account_id, domain_name, attributes, options = {})
@@ -42,7 +68,7 @@ module Dnsimple
         endpoint = Client.versioned("/%s/registrar/domains/%s/registration" % [account_id, domain_name])
         response = client.post(endpoint, attributes, options)
 
-        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
+        Dnsimple::Response.new(response, Struct::DomainRegistration.new(response["data"]))
       end
 
       # Renews a domain.
@@ -52,18 +78,18 @@ module Dnsimple
       # @example Renew example.com for 3 years:
       #   client.registrar.renew(1010, "example.com", period: 3)
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to renew
       # @param  [Hash] attributes
       # @param  [Hash] options
-      # @return [Struct::Domain]
+      # @return [Struct::DomainRenewal]
       #
       # @raise  [RequestError] When the request fails.
       def renew_domain(account_id, domain_name, attributes = nil, options = {})
         endpoint = Client.versioned("/%s/registrar/domains/%s/renewal" % [account_id, domain_name])
         response = client.post(endpoint, attributes, options)
 
-        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
+        Dnsimple::Response.new(response, Struct::DomainRenewal.new(response["data"]))
       end
 
       # Starts the transfer of a domain to DNSimple.
@@ -73,11 +99,11 @@ module Dnsimple
       # @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")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer
       # @param  [Hash] attributes
       # @param  [Hash] options
-      # @return [Struct::Domain]
+      # @return [Struct::DomainTransfer]
       #
       # @raise  [RequestError] When the request fails.
       def transfer_domain(account_id, domain_name, attributes, options = {})
@@ -85,7 +111,7 @@ module Dnsimple
         endpoint = Client.versioned("/%s/registrar/domains/%s/transfer" % [account_id, domain_name])
         response = client.post(endpoint, attributes, options)
 
-        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
+        Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
       end
 
       # Requests the transfer of a domain out of DNSimple.
@@ -95,7 +121,7 @@ module Dnsimple
       # @example Request to transfer of example.com out of DNSimple:
       #   client.registrar.transfer_out(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer out
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/registrar_auto_renewal.rb

@@ -6,7 +6,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/registrar/auto-renewal/
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]
@@ -23,7 +23,7 @@ module Dnsimple
       #
       # @see https://developer.dnsimple.com/v2/registrar/auto-renewal/
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]

data/lib/dnsimple/client/registrar_delegation.rb

@@ -9,7 +9,7 @@ module Dnsimple
       # @example List the name servers example.com is delegating to:
       #   client.registrar.domain_delegation(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Hash] options
       # @return [Dnsimple::Response<Array>]
@@ -30,7 +30,7 @@ module Dnsimple
       #   client.registrar.change_domain_delegation(1010, "example.com",
       #       ["ns1.dnsimple.com", "ns2.dnsimple.com", "ns3.dnsimple.com", "ns4.dnsimple.com"])
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Array] attributes
       # @param  [Hash] options
@@ -52,7 +52,7 @@ module Dnsimple
       #   client.registrar.change_domain_delegation_to_vanity(1010, "example.com",
       #       ["ns1.example.com", "ns2.example.com", "ns3.example.com", "ns4.example.com"])
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Array] attributes
       # @param  [Hash] options
@@ -73,7 +73,7 @@ module Dnsimple
       # @example Disable vanity name servers for example.com:
       #   client.registrar.change_domain_delegation_from_vanity(1010, "example.com")
       #
-      # @param  [Fixnum] account_id the account ID
+      # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
       # @param  [Hash] options
       # @return [Dnsimple::Response<nil>]