dnsimple 11.0.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4181725aaf336953ed62dc82cb74fe1d4457880f9fccf3940c817e27ffa559b5
-  data.tar.gz: 11662d9a7780adbb47599e34a6e820c2b980c0be22ec79985557f4bd1801592c
+  metadata.gz: 31ae749f873b79c185866f4d4eb065ca98bcbcb956aefe9b2e105c7768edce8d
+  data.tar.gz: 7662580ca2df8c17507cc1f46e551cd65ac03b3c6a74a910ca38eaa8613c321d
 SHA512:
-  metadata.gz: c4357613ee6e5c1b8d25a89a8ce6d61fa53c3369bf59ff9e33f5fce0fc800f31e5a0f0d4709726de2fb0f0c4bc7ec092a34c238d9b8fca28bdb722ad6cd2462b
-  data.tar.gz: fa7726f50d6794b34ce537292d50b8050379751942201dad2e61ae246aed2ba5079841140b87ac6bd4494b724aeebc155cc59438f9f9693f69b8dc0c4742357f
+  metadata.gz: e1fd16b35b4fe0bce02df6e8a3af70eb9df5cc76c18c4b6e264e50f0c6b2efeac3631ed7cd76a25e6aaedc4a9fcfdf94e23a31f6f37f248cb49123c31f2ae170
+  data.tar.gz: b4e9842be063a37cd705bfe8ecf365b0cbd8dc315489f80b8e17290e8b96311d0adc836deffaff3151ea5379cd16d1c45503bfce827756a8aeb0cb8110c56acf

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
       - name: Wait for tests to succeed
-        uses: lewagon/wait-on-check-action@v1.4.0
+        uses: lewagon/wait-on-check-action@v1.4.1
         with:
           ref: 'refs/heads/main'
           running-workflow-name: 'Release to RubyGems'

data/.rubocop_dnsimple.yml

@@ -98,7 +98,7 @@ Naming/MemoizedInstanceVariableName:
 # to use simple ? methods.
 # Moreover, it's actually more efficient to not-use predicates:
 # https://github.com/bbatsov/rubocop/issues/3633
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: false
 
 # The team agreed decided to use exception.

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 11.1.0
+
+- NEW: Added `Dnsimple::Client::ZonesRecords#batch_change_zone_records` to make changes to zone records in a batch. (dnsimple/dnsimple-ruby#434)
+
 ## 11.0.0
 
 - CHANGED: Removed `from` and `to` fields in `EmailForward`

data/lib/dnsimple/client/zones_records.rb

@@ -156,6 +156,39 @@ module Dnsimple
         Dnsimple::Response.new(response, nil)
       end
 
+      # Updates a zone with a set of records (records to be created, edited or deleted), as an atomic batch operation.
+      #
+      # @see https://developer.dnsimple.com/v2/zones/records/batchChangeZoneRecords
+      #
+      # @example Create 2 A records in zone "example.com", update 1 record and delete 1 record.
+      #   client.zones.batch_change_zone_records(1010, "example.com", { creates: [{ type: "A", content: "1.2.3.4", name: "ab" }, { type: "A", content: "2.3.4.5", name: "ab" }], updates: [{ id: 67622534, content: "3.2.3.40", name: "www" } }, deletes: [{ id: 67622509 })
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [String] zone_id the zone name
+      # @param  attributes [Hash] Specifies the record creations and/or updates and/or deletions that should be performed as an atomic batch operation in the zone
+      # @option attributes [Array<Hash>] :creates (optional)
+      # @option attributes [Array<Hash>] :updates (optional)
+      # @option attributes [Array<Hash>] :deletes (optional)
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::ZoneRecordsBatchChange>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def batch_change_zone_records(account_id, zone_id, attributes, options = {})
+        response = client.post(Client.versioned("/%s/zones/%s/batch" % [account_id, zone_id]), attributes, options)
+
+        creates, updates, deletes = []
+        if response["data"]
+          creates_data = response["data"]["creates"] || []
+          creates = creates_data.map { |r| Struct::ZoneRecord.new(r) }
+          updates_data = response["data"]["updates"] || []
+          updates = updates_data.map { |r| Struct::ZoneRecord.new(r) }
+          deletes_data = response["data"]["deletes"] || []
+          deletes = deletes_data.map { |r| Struct::ZoneRecordId.new(r) }
+        end
+        Dnsimple::Response.new(response, Struct::ZoneRecordsBatchChange.new({ creates: creates, updates: updates, deletes: deletes }))
+      end
+
     end
   end
 end

data/lib/dnsimple/struct/zone_record_id.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+    class ZoneRecordId < Base
+
+      # @return [Integer] The record ID in DNSimple.
+      attr_accessor :id
+
+    end
+  end
+end

data/lib/dnsimple/struct/zone_records_batch_change.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  module Struct
+    class ZoneRecordsBatchChange < Base
+
+      # @return [Array<ZoneRecord>]
+      attr_accessor :creates
+
+      # @return [Array<ZoneRecord>]
+      attr_accessor :updates
+
+      # @return [Array<ZoneRecordId>]
+      attr_accessor :deletes
+
+    end
+  end
+end

data/lib/dnsimple/struct.rb

@@ -51,6 +51,8 @@ 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_records_batch_change"
+require_relative "struct/zone_record_id"
 require_relative "struct/zone_file"
 require_relative "struct/zone_distribution"
 require_relative "struct/webhook"

data/lib/dnsimple/version.rb

@@ -2,6 +2,6 @@
 
 module Dnsimple
 
-  VERSION = "11.0.0"
+  VERSION = "11.1.0"
 
 end

data/spec/dnsimple/client/domains_delegation_signer_records_spec.rb

@@ -163,7 +163,7 @@ describe Dnsimple::Client, ".domains" do
     context "when the delegation signer record does not exist" do
       it "raises NotFoundError" do
         stub_request(:get, %r{/v2})
-            .to_return(read_http_fixture("notfound-delegationsignerrecord.http"))
+            .to_return(read_http_fixture("notfound-delegationSignerRecord.http"))
 
         expect {
           subject.delegation_signer_record(account_id, domain_id, ds_record_id)
@@ -200,7 +200,7 @@ describe Dnsimple::Client, ".domains" do
     context "when the delegation signer record does not exist" do
       it "raises NotFoundError" do
         stub_request(:delete, %r{/v2})
-            .to_return(read_http_fixture("notfound-delegationsignerrecord.http"))
+            .to_return(read_http_fixture("notfound-delegationSignerRecord.http"))
 
         expect {
           subject.delete_delegation_signer_record(account_id, domain_id, ds_record_id)

data/spec/dnsimple/client/zones_records_spec.rb

@@ -316,4 +316,99 @@ describe Dnsimple::Client, ".zones" do
     end
   end
 
+  describe "#batch_change_zone_records" do
+    let(:account_id) { 1010 }
+    let(:attributes) { { creates: [{ type: "A", content: "3.2.3.4", name: "ab" }, { type: "A", content: "4.2.3.4", name: "ab" }], updates: [{ id: 67622534, content: "3.2.3.40", name: "update1-1757049890" }, { id: 67622537, content: "5.2.3.40", name: "update2-1757049890" }], deletes: [{ id: 67622509 }, { id: 67622527 }] } }
+    let(:zone_id) { "example.com" }
+
+    before do
+      stub_request(:post, %r{/v2/#{account_id}/zones/#{zone_id}/batch$})
+          .to_return(read_http_fixture("batchChangeZoneRecords/success.http"))
+    end
+
+
+    it "builds the correct request" do
+      subject.batch_change_zone_records(account_id, zone_id, attributes)
+
+      expect(WebMock).to have_requested(:post, "https://api.dnsimple.test/v2/#{account_id}/zones/#{zone_id}/batch")
+          .with(body: attributes)
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the result" do
+      response = subject.batch_change_zone_records(account_id, zone_id, attributes)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::ZoneRecordsBatchChange)
+      expect(result.creates[0].id).to eq(67623409)
+      expect(result.creates[0].type).to eq(attributes.fetch(:creates)[0].fetch(:type))
+      expect(result.creates[0].name).to eq(attributes.fetch(:creates)[0].fetch(:name))
+      expect(result.creates[0].content).to eq(attributes.fetch(:creates)[0].fetch(:content))
+      expect(result.creates[0].regions).to eq(["global"])
+      expect(result.creates[1].id).to eq(67623410)
+      expect(result.updates[0].id).to eq(67622534)
+      expect(result.updates[0].type).to eq("A")
+      expect(result.updates[0].name).to eq(attributes.fetch(:updates)[0].fetch(:name))
+      expect(result.updates[0].content).to eq(attributes.fetch(:updates)[0].fetch(:content))
+      expect(result.updates[1].id).to eq(67622537)
+      expect(result.deletes[0].id).to eq(67622509)
+      expect(result.deletes[1].id).to eq(67622527)
+    end
+
+    context "when there are errors with creation" do
+      it "raises RequestError" do
+        stub_request(:post, %r{/v2/#{account_id}/zones/#{zone_id}/batch$})
+            .to_return(read_http_fixture("batchChangeZoneRecords/error_400_create_validation_failed.http"))
+
+        expect {
+          subject.batch_change_zone_records(account_id, zone_id, attributes)
+        }.to raise_error(Dnsimple::RequestError, "Validation failed") do |exception|
+          expect(exception.attribute_errors["creates"][0]["message"]).to eq("Validation failed")
+          expect(exception.attribute_errors["creates"][0]["index"]).to eq(0)
+          expect(exception.attribute_errors["creates"][0]["errors"]).to eq({ "record_type" => ["unsupported"] })
+        end
+      end
+    end
+
+    context "when there are errors with updates" do
+      it "raises RequestError" do
+        stub_request(:post, %r{/v2/#{account_id}/zones/#{zone_id}/batch$})
+            .to_return(read_http_fixture("batchChangeZoneRecords/error_400_update_validation_failed.http"))
+
+        expect {
+          subject.batch_change_zone_records(account_id, zone_id, attributes)
+        }.to raise_error(Dnsimple::RequestError, "Validation failed") do |exception|
+          expect(exception.attribute_errors["updates"][0]["message"]).to eq("Record not found ID=99999999")
+          expect(exception.attribute_errors["updates"][0]["index"]).to eq(0)
+        end
+      end
+    end
+
+    context "when there are errors with deletes" do
+      it "raises RequestError" do
+        stub_request(:post, %r{/v2/#{account_id}/zones/#{zone_id}/batch$})
+            .to_return(read_http_fixture("batchChangeZoneRecords/error_400_delete_validation_failed.http"))
+
+        expect {
+          subject.batch_change_zone_records(account_id, zone_id, attributes)
+        }.to raise_error(Dnsimple::RequestError, "Validation failed") do |exception|
+          expect(exception.attribute_errors["deletes"][0]["message"]).to eq("Record not found ID=67622509")
+          expect(exception.attribute_errors["deletes"][0]["index"]).to eq(0)
+        end
+      end
+    end
+
+    context "when the zone does not exist" do
+      it "raises NotFoundError" do
+        stub_request(:post, %r{/v2})
+            .to_return(read_http_fixture("notfound-zone.http"))
+
+        expect {
+          subject.batch_change_zone_records(account_id, zone_id, attributes)
+        }.to raise_error(Dnsimple::NotFoundError)
+      end
+    end
+  end
+
 end

data/spec/fixtures.http/batchChangeZoneRecords/error_400_create_validation_failed.http

@@ -0,0 +1,16 @@
+HTTP/1.1 400 Bad Request
+Server: nginx
+Date: Tue, 23 Sep 2025 10:21:06 GMT
+Content-Type: application/json; charset=utf-8
+Content-Length: 137
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2397
+X-RateLimit-Reset: 1758626142
+X-WORK-WITH-US: Love automation? So do we! https://dnsimple.com/jobs
+Cache-Control: no-cache
+X-Request-Id: 22761da9-ad02-4970-add5-e26602b09bb5
+X-Runtime: 0.115194
+Strict-Transport-Security: max-age=63072000
+
+{"message":"Validation failed","errors":{"creates":[{"index":0,"message":"Validation failed","errors":{"record_type":["unsupported"]}}]}}

data/spec/fixtures.http/batchChangeZoneRecords/error_400_delete_validation_failed.http

@@ -0,0 +1,15 @@
+HTTP/1.1 400 Bad Request
+server: nginx
+date: Fri, 05 Sep 2025 06:50:48 GMT
+content-type: application/json; charset=utf-8
+content-length: 107
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2390
+X-RateLimit-Reset: 1757058040
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+cache-control: no-cache
+x-request-id: 254988cd-401b-4a32-b5d8-c25502573c9a
+x-runtime: 0.105704
+strict-transport-security: max-age=63072000
+
+{"message":"Validation failed","errors":{"deletes":[{"index":0,"message":"Record not found ID=67622509"}]}}

data/spec/fixtures.http/batchChangeZoneRecords/error_400_update_validation_failed.http

@@ -0,0 +1,15 @@
+HTTP/1.1 400 Bad Request
+server: nginx
+date: Fri, 05 Sep 2025 06:52:30 GMT
+content-type: application/json; charset=utf-8
+content-length: 107
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2388
+X-RateLimit-Reset: 1757058040
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+cache-control: no-cache
+x-request-id: e042a192-69de-46b5-9ea0-add647a9b20a
+x-runtime: 0.170298
+strict-transport-security: max-age=63072000
+
+{"message":"Validation failed","errors":{"updates":[{"index":0,"message":"Record not found ID=99999999"}]}}

data/spec/fixtures.http/batchChangeZoneRecords/success.http

@@ -0,0 +1,16 @@
+HTTP/1.1 200 OK
+server: nginx
+date: Fri, 05 Sep 2025 05:25:01 GMT
+content-type: application/json; charset=utf-8
+content-length: 1080
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2399
+X-RateLimit-Reset: 1757053501
+x-work-with-us: Love automation? So do we! https://dnsimple.com/jobs
+etag: W/"0d9f98e87eccabb6c8045c7fd0b61e5e"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: f331c43b-7f06-4b1f-90a1-e88efee10c1c
+x-runtime: 0.334890
+strict-transport-security: max-age=63072000
+
+{"data":{"creates":[{"id":67623409,"zone_id":"example.com","parent_id":null,"name":"ab","content":"3.2.3.4","ttl":3600,"priority":null,"type":"A","regions":["global"],"system_record":false,"created_at":"2025-09-05T05:25:00Z","updated_at":"2025-09-05T05:25:00Z"},{"id":67623410,"zone_id":"example.com","parent_id":null,"name":"ab","content":"4.2.3.4","ttl":3600,"priority":null,"type":"A","regions":["global"],"system_record":false,"created_at":"2025-09-05T05:25:00Z","updated_at":"2025-09-05T05:25:00Z"}],"updates":[{"id":67622534,"zone_id":"example.com","parent_id":null,"name":"update1-1757049890","content":"3.2.3.40","ttl":3600,"priority":null,"type":"A","regions":["global"],"system_record":false,"created_at":"2025-09-05T04:40:15Z","updated_at":"2025-09-05T05:25:00Z"},{"id":67622537,"zone_id":"example.com","parent_id":null,"name":"update2-1757049890","content":"5.2.3.40","ttl":3600,"priority":null,"type":"A","regions":["global"],"system_record":false,"created_at":"2025-09-05T04:40:22Z","updated_at":"2025-09-05T05:25:00Z"}],"deletes":[{"id":67622509},{"id":67622527}]}}

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

@@ -4,6 +4,9 @@ Date: Sun, 18 Feb 2024 10:48:05 GMT
 Content-Type: application/json
 Content-Length: 120
 Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1547125899
 X-WORK-WITH-US: Love automation? So do we! https://dnsimple.com/jobs
 Cache-Control: no-cache
 X-Request-Id: 2a8d691f-f47e-4d41-9916-eba67e683914
@@ -16,4 +19,4 @@ X-Permitted-Cross-Domain-Policies: none
 Content-Security-Policy: frame-ancestors 'none'
 Strict-Transport-Security: max-age=63072000
 
-{"data":{"id":43,"domain_id":214,"state":"new","created_at":"2024-02-14T14:40:42Z","updated_at":"2024-02-14T14:40:42Z"}}
+{"data":{"id":43,"domain_id":214,"state":"new","created_at":"2024-02-14T14:40:42Z","updated_at":"2024-02-14T14:40:42Z"}}

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

@@ -4,6 +4,9 @@ Date: Sun, 18 Feb 2024 10:46:17 GMT
 Content-Type: application/json
 Content-Length: 120
 Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1547125899
 X-WORK-WITH-US: Love automation? So do we! https://dnsimple.com/jobs
 Cache-Control: no-cache
 X-Request-Id: 3bf33ae7-22f2-473c-8e39-8738d2bcce89
@@ -16,4 +19,4 @@ X-Permitted-Cross-Domain-Policies: none
 Content-Security-Policy: frame-ancestors 'none'
 Strict-Transport-Security: max-age=63072000
 
-{"data":{"id":43,"domain_id":214,"state":"new","created_at":"2024-02-14T14:40:42Z","updated_at":"2024-02-14T14:40:42Z"}}
+{"data":{"id":43,"domain_id":214,"state":"new","created_at":"2024-02-14T14:40:42Z","updated_at":"2024-02-14T14:40:42Z"}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.1.0
 platform: ruby
 authors:
 - DNSimple
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-20 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -184,6 +184,8 @@ files:
 - lib/dnsimple/struct/zone_distribution.rb
 - lib/dnsimple/struct/zone_file.rb
 - lib/dnsimple/struct/zone_record.rb
+- lib/dnsimple/struct/zone_record_id.rb
+- lib/dnsimple/struct/zone_records_batch_change.rb
 - lib/dnsimple/version.rb
 - spec/dnsimple/client/accounts_spec.rb
 - spec/dnsimple/client/billing_spec.rb
@@ -227,6 +229,10 @@ files:
 - spec/fixtures.http/applyTemplate/success.http
 - spec/fixtures.http/authorizeDomainTransferOut/success.http
 - spec/fixtures.http/badgateway.http
+- spec/fixtures.http/batchChangeZoneRecords/error_400_create_validation_failed.http
+- spec/fixtures.http/batchChangeZoneRecords/error_400_delete_validation_failed.http
+- spec/fixtures.http/batchChangeZoneRecords/error_400_update_validation_failed.http
+- spec/fixtures.http/batchChangeZoneRecords/success.http
 - spec/fixtures.http/cancelDomainTransfer/success.http
 - spec/fixtures.http/changeDomainDelegation/success.http
 - spec/fixtures.http/changeDomainDelegationFromVanity/success.http
@@ -343,7 +349,7 @@ files:
 - spec/fixtures.http/method-not-allowed.http
 - spec/fixtures.http/notfound-certificate.http
 - spec/fixtures.http/notfound-contact.http
-- spec/fixtures.http/notfound-delegationsignerrecord.http
+- spec/fixtures.http/notfound-delegationSignerRecord.http
 - spec/fixtures.http/notfound-domain.http
 - spec/fixtures.http/notfound-domainpush.http
 - spec/fixtures.http/notfound-emailforward.http