dnsimple 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49d2f2a2d0892e3ae7e31b563035cd668200f164a05fcde6b59b5fb497a123ee
-  data.tar.gz: 572cf3a3277efb2cb55cd5f9a0fc644bfe4a356a2853846e6f3af37a3964e28e
+  metadata.gz: 6ccd26ac738f667185d2005071eb215045dcce8bdcaaf48ba5b1b31f9187bdcf
+  data.tar.gz: a8474bcd18275b39465931d06230fd07434a839a39dbfeead1e130289929f7a6
 SHA512:
-  metadata.gz: 90c025c122e88a6408f57abf2ff564ea309e10af4e85c16c2e1d8b513b58cfb726514634abd00e746e98a966827df7082d16ec333d32cb5290c0711a2ac94bd4
-  data.tar.gz: ba8db8d64adddf8d7aa04f66527eaa0fb00a6ed00be88c52c0a23d21b616ef0ef03a7850e83b0571f6be7d2e227915a4b755b58064136d199adce9b3b2ccf117
+  metadata.gz: bb079ccceb1587b61ce3d0660a9963dad812d01da3634d0581dc80095fb2157fc86a191d711590bfb8d85c48c9c47e47a6a30b7e6e14c107b50195894e552c67
+  data.tar.gz: e7a5735a36b36dca5dee66104d90c0bbdb83afa878a9e5423bcac5b46b965a5324e16ad6380cb9f8a51ee91d3df8baa3bff47633c750b9ce529d0a9ed62c0e78

data/.travis.yml

@@ -1,21 +1,18 @@
 language: ruby
 
-sudo: false
-
 rvm:
   - 2.1
   - 2.2
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 
 env:
   - COVERALL=1
 
 before_install:
-  - rvm get latest
-  - gem update --system
-  - gem install bundler
+  - gem install bundler -v 1.17.3
 
 notifications:
   slack:

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
+### 4.6.0
+
+- NEW: Added WHOIS privacy renewal (GH-171)
+
+
 ### 4.5.0
 
 - NEW: Added zone distribution and zone record distribution (GH-160)

data/lib/dnsimple/client.rb

@@ -204,8 +204,8 @@ module Dnsimple
 
     def base_options
       {
-          format:   :json,
-          headers:  {
+          format: :json,
+          headers: {
               "Accept" => "application/json",
           },
       }

data/lib/dnsimple/client/registrar_whois_privacy.rb

@@ -50,7 +50,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 +62,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/struct.rb

@@ -40,6 +40,7 @@ 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'

data/lib/dnsimple/struct/whois_privacy_renewal.rb

@@ -0,0 +1,28 @@
+module Dnsimple
+  module Struct
+
+    class WhoisPrivacyRenewal < Base
+      # @return [Integer] The associated domain ID.
+      attr_accessor :domain_id
+
+      # @return [Integer] The associated WHOIS Privacy ID.
+      attr_accessor :whois_privacy_id
+
+      # @return [String] The WHOIS Privacy order state.
+      attr_accessor :state
+
+      # @return [Boolean] Whether the WHOIS Privacy is enabled for the domain.
+      attr_accessor :enabled
+
+      # @return [String] The date the WHOIS Privacy will expire on.
+      attr_accessor :expires_on
+
+      # @return [String] When the WHOIS Privacy was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the WHOIS Privacy was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "4.5.0".freeze
+  VERSION = "4.6.0".freeze
 end

data/spec/dnsimple/client/registrar_whois_privacy_spec.rb

@@ -116,4 +116,59 @@ describe Dnsimple::Client, ".registrar" do
     end
   end
 
+
+  describe "#renew_whois_privacy" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/registrar/domains/.+/whois_privacy/renewals$})
+          .to_return(read_http_fixture("renewWhoisPrivacy/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.renew_whois_privacy(account_id, domain_name = "example.com")
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_name}/whois_privacy/renewals")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the whois privacy order" do
+      response = subject.renew_whois_privacy(account_id, "example.com")
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::WhoisPrivacyRenewal)
+      expect(result.domain_id).to be_kind_of(Integer)
+      expect(result.whois_privacy_id).to be_kind_of(Integer)
+      expect(result.enabled).to be(true)
+      expect(result.expires_on).to be_kind_of(String)
+    end
+
+    context "when whois privacy was't previously purchased" do
+      before do
+        stub_request(:post, %r{/v2/#{account_id}/registrar/domains/.+/whois_privacy/renewals$})
+            .to_return(read_http_fixture("renewWhoisPrivacy/whois-privacy-not-found.http"))
+      end
+
+      it "raises error" do
+        expect do
+          subject.renew_whois_privacy(account_id, "example.com")
+        end.to raise_error(Dnsimple::RequestError, "WHOIS privacy not found for example.com")
+      end
+    end
+
+    context "when there is already a whois privacy renewal order in progress" do
+      before do
+        stub_request(:post, %r{/v2/#{account_id}/registrar/domains/.+/whois_privacy/renewals$})
+            .to_return(read_http_fixture("renewWhoisPrivacy/whois-privacy-duplicated-order.http"))
+      end
+
+      it "raises error" do
+        expect do
+          subject.renew_whois_privacy(account_id, "example.com")
+        end.to raise_error(Dnsimple::RequestError, "The whois privacy for example.com has just been renewed, a new renewal cannot be started at this time")
+      end
+    end
+  end
+
 end

data/spec/fixtures.http/renewWhoisPrivacy/success.http

@@ -0,0 +1,21 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Thu, 10 Jan 2019 12:12:50 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1547125899
+ETag: W/"e5bf5d90a6c95e5f1443dcbaf2cc27c6"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 6e80e830-21ae-46ea-9191-98811884808a
+X-Runtime: 1.459325
+X-Frame-Options: DENY
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 1; mode=block
+X-Download-Options: noopen
+X-Permitted-Cross-Domain-Policies: none
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"domain_id":100,"whois_privacy_id":999,"state":"new","expires_on":"2020-01-10","enabled":true,"created_at":"2019-01-10T12:12:48Z","updated_at":"2019-01-10T12:12:48Z"}}

data/spec/fixtures.http/renewWhoisPrivacy/whois-privacy-duplicated-order.http

@@ -0,0 +1,19 @@
+HTTP/1.1 400 Bad Request
+Server: nginx
+Date: Thu, 10 Jan 2019 12:13:21 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2397
+X-RateLimit-Reset: 1547125899
+Cache-Control: no-cache
+X-Request-Id: 16cc92bb-fe38-434b-b483-602d77ac77d3
+X-Runtime: 0.122201
+X-Frame-Options: DENY
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 1; mode=block
+X-Download-Options: noopen
+X-Permitted-Cross-Domain-Policies: none
+
+{"message":"The whois privacy for example.com has just been renewed, a new renewal cannot be started at this time","errors":{}}

data/spec/fixtures.http/renewWhoisPrivacy/whois-privacy-not-found.http

@@ -0,0 +1,19 @@
+HTTP/1.1 400 Bad Request
+Server: nginx
+Date: Thu, 10 Jan 2019 12:11:39 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2399
+X-RateLimit-Reset: 1547125899
+Cache-Control: no-cache
+X-Request-Id: 2727b7c4-97af-4e22-9c7f-bd84e20f2dc1
+X-Runtime: 0.139925
+X-Frame-Options: DENY
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 1; mode=block
+X-Download-Options: noopen
+X-Permitted-Cross-Domain-Policies: none
+
+{"message":"WHOIS privacy not found for example.com","errors":{}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Anthony Eden
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -172,6 +172,7 @@ files:
 - lib/dnsimple/struct/webhook.rb
 - lib/dnsimple/struct/whoami.rb
 - lib/dnsimple/struct/whois_privacy.rb
+- lib/dnsimple/struct/whois_privacy_renewal.rb
 - lib/dnsimple/struct/zone.rb
 - lib/dnsimple/struct/zone_distribution.rb
 - lib/dnsimple/struct/zone_file.rb
@@ -324,6 +325,9 @@ files:
 - spec/fixtures.http/removeCollaborator/success.http
 - spec/fixtures.http/renewDomain/error-tooearly.http
 - spec/fixtures.http/renewDomain/success.http
+- spec/fixtures.http/renewWhoisPrivacy/success.http
+- spec/fixtures.http/renewWhoisPrivacy/whois-privacy-duplicated-order.http
+- spec/fixtures.http/renewWhoisPrivacy/whois-privacy-not-found.http
 - spec/fixtures.http/resetDomainToken/success.http
 - spec/fixtures.http/response.http
 - spec/fixtures.http/success-with-malformed-json.http
@@ -359,8 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: The DNSimple API client for Ruby
@@ -512,6 +515,9 @@ test_files:
 - spec/fixtures.http/removeCollaborator/success.http
 - spec/fixtures.http/renewDomain/error-tooearly.http
 - spec/fixtures.http/renewDomain/success.http
+- spec/fixtures.http/renewWhoisPrivacy/success.http
+- spec/fixtures.http/renewWhoisPrivacy/whois-privacy-duplicated-order.http
+- spec/fixtures.http/renewWhoisPrivacy/whois-privacy-not-found.http
 - spec/fixtures.http/resetDomainToken/success.http
 - spec/fixtures.http/response.http
 - spec/fixtures.http/success-with-malformed-json.http