dnsimple 8.8.0 → 8.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874a1e978f9845bb7a50c9f596fb30b22186730498972ed4c538664939c9e3d6
-  data.tar.gz: 1a1ec6d73ca64499a9e9462529d18f9e8643a619a349310c5e3b4e6f0c3d8050
+  metadata.gz: 6757a107a26286469b7b0e991849e0557cdc1c2ff21e74f92377fd5c62047d08
+  data.tar.gz: 26633769cf4c7453bad5fcaa8ad6cf0d4d98d368e6a705d4834fe57cace492ad
 SHA512:
-  metadata.gz: d28ef3ce63861291b5b95bb7d373685367c25bb33e3ddf42ee403e8d8c3963d8e0bf377280ca97560ac142855ee4b1d6de74cdad6241a534a3978c5aa6c17085
-  data.tar.gz: a0bef36ed74defb05757c8ed9e21d90198c5fee95530da0c77212f4fa303c5bb6ce4773989d5ed8ac2e8f78068e2d3d92044593fb53d2c14ea7a9f1c1a5fbe49
+  metadata.gz: a483b5e60d097291d45f4062f270392f34505b965e906792d3458dcad334dd5bf69f92e6b5f2d345612dabbead4129c90401ba5c619bc3a9f06f550d7b661291
+  data.tar.gz: 00e503a63429b4e9160fe3a6c92fd177085636de937366299bf03ba036a1b8ed426e371132dd14cee43b53f6c70826e6f6e851c45410450ec16402be483a84c5

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 8.9.0
+
+- NEW: Added `Dnsimple::Client::Registrar#restore_domain` to restore a domain. (dnsimple/dnsimple-ruby#379)
+- NEW: Added `Dnsimple::Client::Registrar#get_domain_restore` to retrieve the details of an existing dommain restore. (dnsimple/dnsimple-ruby#379)
+
 ## 8.8.0
 
 - NEW: Added `Dnsimple::Client::DnsAnalytics#query` to query and pull data from the DNS Analytics API endpoint(dnsimple/dnsimple-ruby#375)

data/lib/dnsimple/client/registrar.rb

@@ -218,6 +218,49 @@ module Dnsimple
         Dnsimple::Response.new(response, nil)
       end
 
+      # Restores a domain.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#restore
+      #
+      # @example Restore example.com:
+      #   client.registrar.restore_domain(1010, "example.com", {})
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name to restore
+      # @param  [Hash] attributes
+      # @param  [Hash] options
+      # @return [Struct::DomainRestore]
+      #
+      # @raise  [RequestError] When the request fails.
+      def restore_domain(account_id, domain_name, attributes = nil, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/restores" % [account_id, domain_name])
+        response = client.post(endpoint, attributes, options)
+
+        Dnsimple::Response.new(response, Struct::DomainRestore.new(response["data"]))
+      end
+
+      # Retrieve the details of an existing domain restore.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainRestore
+      #
+      # @example Retrieve the restore 42 for example.com:
+      #   client.registrar.get_domain_restore(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_restore_id the domain restore ID
+      # @param  [Hash] options
+      # @return [Struct::DomainRestore]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def get_domain_restore(account_id, domain_name, domain_restore_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/restores/%s" % [account_id, domain_name, domain_restore_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainRestore.new(response["data"]))
+      end
+
     end
   end
 end

data/lib/dnsimple/struct/domain_restore.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+    class DomainRestore < Base
+
+      # @return [Integer] The domain restore ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Integer] The associated domain ID.
+      attr_accessor :domain_id
+
+      # @return [String] The state of the restore.
+      attr_accessor :state
+
+      # @return [String] When the domain restore was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the domain restore was last updated in DNSimple.
+      attr_accessor :updated_at
+
+    end
+  end
+end

data/lib/dnsimple/struct.rb

@@ -31,6 +31,7 @@ require_relative 'struct/domain_premium_price'
 require_relative 'struct/domain_price'
 require_relative 'struct/domain_push'
 require_relative 'struct/domain_registration'
+require_relative 'struct/domain_restore'
 require_relative 'struct/domain_transfer'
 require_relative 'struct/domain_renewal'
 require_relative 'struct/dns_analytics'

data/lib/dnsimple/version.rb

@@ -2,6 +2,6 @@
 
 module Dnsimple
 
-  VERSION = "8.8.0"
+  VERSION = "8.9.0"
 
 end

data/spec/dnsimple/client/registrar_spec.rb

@@ -571,4 +571,57 @@ describe Dnsimple::Client, ".registrar" do
       expect(result).to be_nil
     end
   end
+
+  describe "#restore_domain" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/registrar/domains/.+/restores$})
+          .to_return(read_http_fixture("restoreDomain/success.http"))
+    end
+
+
+    it "builds the correct request" do
+      subject.restore_domain(account_id, domain_name = "example.com", {})
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_name}/restores")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the domain" do
+      response = subject.restore_domain(account_id, "example.com", {})
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DomainRestore)
+      expect(result.id).to be_a(Integer)
+      expect(result.domain_id).to be_a(Integer)
+    end
+  end
+
+  describe "#get_domain_restore" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/registrar/domains/.+/restores/.+$})
+          .to_return(read_http_fixture("getDomainRestore/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.get_domain_restore(account_id, domain_name = "example.com", restore_id = 361)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_name}/restores/#{restore_id}")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the domain restore" do
+      response = subject.get_domain_restore(account_id, "example.com", 361)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DomainRestore)
+      expect(result.id).to be_a(Integer)
+      expect(result.domain_id).to be_a(Integer)
+    end
+  end
 end

data/spec/fixtures.http/getDomainRestore/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Fri, 09 Dec 2016 19:46:57 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2394
+X-RateLimit-Reset: 1481315245
+ETag: W/"179d85ea8a26a3d5dc76e42de2d7918e"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: ba6f2707-5df0-4ffa-b91b-51d4460bab8e
+X-Runtime: 13.571302
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Frame-Options: DENY
+X-Permitted-Cross-Domain-Policies: none
+X-XSS-Protection: 1; mode=block
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"domain_id":999,"state":"restored","created_at":"2016-12-09T19:46:45Z","updated_at":"2016-12-12T19:46:45Z"}}

data/spec/fixtures.http/restoreDomain/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Fri, 09 Dec 2016 19:46:57 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2394
+X-RateLimit-Reset: 1481315245
+ETag: W/"179d85ea8a26a3d5dc76e42de2d7918e"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: ba6f2707-5df0-4ffa-b91b-51d4460bab8e
+X-Runtime: 13.571302
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Frame-Options: DENY
+X-Permitted-Cross-Domain-Policies: none
+X-XSS-Protection: 1; mode=block
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"domain_id":999,"state":"new","created_at":"2016-12-09T19:46:45Z","updated_at":"2016-12-09T19:46:45Z"}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 8.8.0
+  version: 8.9.0
 platform: ruby
 authors:
 - DNSimple
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -164,6 +164,7 @@ files:
 - lib/dnsimple/struct/domain_push.rb
 - lib/dnsimple/struct/domain_registration.rb
 - lib/dnsimple/struct/domain_renewal.rb
+- lib/dnsimple/struct/domain_restore.rb
 - lib/dnsimple/struct/domain_transfer.rb
 - lib/dnsimple/struct/email_forward.rb
 - lib/dnsimple/struct/extended_attribute.rb
@@ -300,6 +301,7 @@ files:
 - spec/fixtures.http/getDomainPrices/success.http
 - spec/fixtures.http/getDomainRegistration/success.http
 - spec/fixtures.http/getDomainRenewal/success.http
+- spec/fixtures.http/getDomainRestore/success.http
 - spec/fixtures.http/getDomainTransfer/success.http
 - spec/fixtures.http/getDomainTransferLock/success.http
 - spec/fixtures.http/getEmailForward/success.http
@@ -371,6 +373,7 @@ files:
 - spec/fixtures.http/renewWhoisPrivacy/whois-privacy-duplicated-order.http
 - spec/fixtures.http/renewWhoisPrivacy/whois-privacy-not-found.http
 - spec/fixtures.http/response.http
+- spec/fixtures.http/restoreDomain/success.http
 - spec/fixtures.http/success-with-malformed-json.http
 - spec/fixtures.http/transferDomain/error-indnsimple.http
 - spec/fixtures.http/transferDomain/error-missing-authcode.http