gandi_v5 0.6.0 → 0.7.0

data/spec/units/gandi_v5/live_dns_spec.rb

@@ -13,18 +13,6 @@ describe GandiV5::LiveDNS do
     expect(described_class.domains).to be returns
   end
 
-  it '.zone' do
-    returns = double GandiV5::LiveDNS::Zone
-    expect(GandiV5::LiveDNS::Zone).to receive(:fetch).with('zone-uuid').and_return(returns)
-    expect(described_class.zone('zone-uuid')).to be returns
-  end
-
-  it '.zones' do
-    returns = double Array
-    expect(GandiV5::LiveDNS::Zone).to receive(:list).and_return(returns)
-    expect(described_class.zones).to be returns
-  end
-
   describe '.require_valid_record_type' do
     it 'Does nothing for valid type' do
       expect { described_class.require_valid_record_type 'A' }.to_not raise_error

data/spec/units/gandi_v5_spec.rb

@@ -57,8 +57,10 @@ describe GandiV5 do
           response_data = { 'hello' => 'world' }
           response = double RestClient::Response, body: response_data.to_json, headers: { content_type: 'application/json' }
           expect(described_class).to receive(:prepare_headers)
-          expect(RestClient).to receive(method).with('url', hash_including(accept: 'application/json')).and_return(response)
-          expect(described_class.send(method, 'url', accept: 'application/json')).to match_array [response, response_data]
+          expect(RestClient).to receive(method).with('url', hash_including(accept: 'application/json'))
+                                               .and_return(response)
+          expect(described_class.send(method, 'url', accept: 'application/json'))
+            .to match_array [response, response_data]
         end
 
         it 'As text' do
@@ -75,7 +77,7 @@ describe GandiV5 do
         end
 
         it 'Adds authentication header' do
-          expect(RestClient).to receive(method).with(anything, hash_including(Authorization: 'Apikey abdce12345'))
+          expect(RestClient).to receive(method).with(anything, hash_including(authorization: 'Apikey abdce12345'))
                                                .and_return(response)
           expect(described_class).to receive(:parse_response)
           expect(described_class.send(method, 'https://api.gandi.net/v5/')).to match_array [response, nil]
@@ -146,7 +148,7 @@ describe GandiV5 do
         end
 
         it 'Adds authentication header' do
-          expect(RestClient).to receive(method).with(any_args, hash_including(Authorization: 'Apikey abdce12345'))
+          expect(RestClient).to receive(method).with(any_args, hash_including(authorization: 'Apikey abdce12345'))
                                                .and_return(response)
           expect(described_class).to receive(:parse_response)
           expect(described_class.send(method, 'https://api.gandi.net/v5/', payload)).to match_array [response, nil]
@@ -168,20 +170,23 @@ describe GandiV5 do
     end
   end
 
-  describe 'Generates correct authorisation header' do
-    it 'When requesting from main V5 API' do
-      expect(described_class.send(:authorisation_header, 'https://api.gandi.net/v5/example'))
-        .to eq(Authorization: "Apikey #{api_key}")
+  describe 'Prepares headers' do
+    it 'Sets accept it not present' do
+      headers = {}
+      described_class.send(:prepare_headers, headers, GandiV5::BASE)
+      expect(headers[:accept]).to eq 'application/json'
     end
 
-    it 'When requesting from main LiveDNS V5 API' do
-      expect(described_class.send(:authorisation_header, 'https://dns.api.gandi.net/api/v5/example'))
-        .to eq('X-Api-Key': api_key)
+    it 'Leaves accept alone if present' do
+      headers = { accept: 'leave/alone' }
+      described_class.send(:prepare_headers, headers, GandiV5::BASE)
+      expect(headers[:accept]).to eq 'leave/alone'
     end
 
-    it 'Raises ArgumentError when requesting an unknown url' do
-      expect { described_class.send(:authorisation_header, 'https://unknown.example.com') }
-        .to raise_error ArgumentError, 'Don\'t know how to authorise for url: https://unknown.example.com'
+    it 'Sets authorization' do
+      headers = {}
+      described_class.send(:prepare_headers, headers, GandiV5::BASE)
+      expect(headers[:authorization]).to eq "Apikey #{api_key}"
     end
   end
 
@@ -238,4 +243,96 @@ describe GandiV5 do
         .to raise_error GandiV5::Error::GandiError, 'field: message'
     end
   end
+
+  describe '.paginated_get' do
+    let(:url) { "#{GandiV5::BASE}test/url" }
+    let(:do_nothing) { ->(_this_data) { nil } }
+
+    it 'Keeps fetching until getting a partial list' do
+      headers1 = { params: { 'page' => 1, 'per_page' => 2 } }
+      headers2 = { params: { 'page' => 2, 'per_page' => 2 } }
+      expect(GandiV5).to receive(:get).with(url, headers1)
+                                      .ordered
+                                      .and_return([nil, %i[a b]])
+      expect(GandiV5).to receive(:get).with(url, headers2)
+                                      .ordered
+                                      .and_return([nil, %i[c]])
+
+      described_class.paginated_get(url, (1..2), 2, &do_nothing)
+    end
+
+    it 'Keeps fetching until getting an empty list' do
+      headers1 = { params: { 'page' => 1, 'per_page' => 2 } }
+      headers2 = { params: { 'page' => 2, 'per_page' => 2 } }
+      expect(GandiV5).to receive(:get).with(url, headers1)
+                                      .ordered
+                                      .and_return([nil, %i[a b]])
+      expect(GandiV5).to receive(:get).with(url, headers2)
+                                      .ordered
+                                      .and_return([nil, []])
+
+      described_class.paginated_get(url, (1..2), 2, &do_nothing)
+    end
+
+    it 'Passes per_page option' do
+      headers = { params: { 'page' => 1, 'per_page' => 100 } }
+      expect(GandiV5).to receive(:get).with(url, headers)
+                                      .and_return([nil, []])
+      described_class.paginated_get(url, 1, 100, &do_nothing)
+    end
+
+    it 'Passes on other params' do
+      headers = { params: { 'page' => 1, 'per_page' => 100, 'custom' => 'value' } }
+      expect(GandiV5).to receive(:get).with(url, headers)
+                                      .and_return([nil, []])
+      described_class.paginated_get(url, 1, 100, params: { custom: 'value' }, &do_nothing)
+    end
+
+    it 'Passes on other headers' do
+      headers = { params: { 'page' => 1, 'per_page' => 100 }, custom: :value }
+      expect(GandiV5).to receive(:get).with(url, headers)
+                                      .and_return([nil, []])
+      described_class.paginated_get(url, 1, 100, custom: :value, &do_nothing)
+    end
+
+    describe 'Honors passed pages' do
+      it 'Has an each method' do
+        headers1 = { params: { 'page' => 1, 'per_page' => 2 } }
+        headers2 = { params: { 'page' => 2, 'per_page' => 2 } }
+        expect(GandiV5).to receive(:get).with(url, headers1)
+                                        .ordered
+                                        .and_return([nil, %i[a b]])
+        expect(GandiV5).to receive(:get).with(url, headers2)
+                                        .ordered
+                                        .and_return([nil, %i[c d]])
+
+        described_class.paginated_get(url, (1..2), 2, &do_nothing)
+      end
+
+      it 'Positive integer' do
+        headers = { params: { 'page' => 3, 'per_page' => 2 } }
+        expect(GandiV5).to receive(:get).with(url, headers)
+                                        .ordered
+                                        .and_return([nil, %i[a b c]])
+        described_class.paginated_get(url, 3, 2, &do_nothing)
+      end
+
+      it 'Nonpositive integer' do
+        expect { described_class.paginated_get(url, -3, 2, &do_nothing) }.to \
+          raise_error ArgumentError, 'page must be positive'
+      end
+    end
+
+    it 'Relies on caller to build their list' do
+      this_data = [:a]
+      expect(GandiV5).to receive(:get).and_return([nil, this_data])
+      expect { |b| described_class.paginated_get(url, 1, 100, &b) }.to yield_with_args(this_data)
+    end
+
+    it 'Requires a block' do
+      allow(GandiV5).to receive(:get).and_return([nil, [:a]])
+
+      expect { described_class.paginated_get(url) }.to raise_error LocalJumpError
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gandi_v5
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -336,18 +336,14 @@ files:
 - lib/gandi_v5/error/gandi_error.rb
 - lib/gandi_v5/live_dns.rb
 - lib/gandi_v5/live_dns/domain.rb
-- lib/gandi_v5/live_dns/has_zone_records.rb
-- lib/gandi_v5/live_dns/record_set.rb
-- lib/gandi_v5/live_dns/zone.rb
-- lib/gandi_v5/live_dns/zone/snapshot.rb
+- lib/gandi_v5/live_dns/domain/dnssec_key.rb
+- lib/gandi_v5/live_dns/domain/record.rb
+- lib/gandi_v5/live_dns/domain/snapshot.rb
+- lib/gandi_v5/live_dns/domain/tsig_key.rb
 - lib/gandi_v5/organization.rb
 - lib/gandi_v5/organization/customer.rb
 - lib/gandi_v5/version.rb
 - spec/.rubocop.yml
-- spec/features/domain_spec.rb
-- spec/features/livedns_domain_spec.rb
-- spec/features/livedns_zone_spec.rb
-- spec/features/mailbox_spec.rb
 - spec/fixtures/bodies/GandiV5_Billing/info.yml
 - spec/fixtures/bodies/GandiV5_Domain/fetch.yml
 - spec/fixtures/bodies/GandiV5_Domain/fetch_contacts.yml
@@ -367,20 +363,17 @@ files:
 - spec/fixtures/bodies/GandiV5_Email_Slot/list.yml
 - spec/fixtures/bodies/GandiV5_LiveDNS_Domain/fetch.yml
 - spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone/fetch.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone/list.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/fetch.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/list.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/fetch.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/list.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/fetch.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/list.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/fetch.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/list.yml
 - spec/fixtures/bodies/GandiV5_Organization/fetch.yml
 - spec/fixtures/bodies/GandiV5_Organization/list.yml
 - spec/fixtures/bodies/GandiV5_Organization_Customer/list.yml
-- spec/fixtures/vcr/Domain_features/List_domains.yml
-- spec/fixtures/vcr/Domain_features/Renew_domain.yml
-- spec/fixtures/vcr/LiveDNS_Domain_features/List_domains.yml
-- spec/fixtures/vcr/LiveDNS_Zone_features/List_zones.yml
-- spec/fixtures/vcr/LiveDNS_Zone_features/Make_and_save_snapshot.yml
-- spec/fixtures/vcr/LiveDNS_Zone_features/Save_zone_to_file.yml
-- spec/fixtures/vcr/Mailbox_features/List_mailboxes.yml
 - spec/spec_helper.rb
 - spec/test.env
 - spec/units/gandi_v5/billing/info/prepaid_spec.rb
@@ -414,10 +407,11 @@ files:
 - spec/units/gandi_v5/email/slot_spec.rb
 - spec/units/gandi_v5/error/gandi_error_spec.rb
 - spec/units/gandi_v5/error_spec.rb
+- spec/units/gandi_v5/live_dns/domain/dnssec_key_spec.rb
+- spec/units/gandi_v5/live_dns/domain/record_spec.rb
+- spec/units/gandi_v5/live_dns/domain/snapshot_spec.rb
+- spec/units/gandi_v5/live_dns/domain/tsig_key_spec.rb
 - spec/units/gandi_v5/live_dns/domain_spec.rb
-- spec/units/gandi_v5/live_dns/record_set_spec.rb
-- spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb
-- spec/units/gandi_v5/live_dns/zone_spec.rb
 - spec/units/gandi_v5/live_dns_spec.rb
 - spec/units/gandi_v5/organization/customer_spec.rb
 - spec/units/gandi_v5/organization_spec.rb

data/lib/gandi_v5/live_dns/has_zone_records.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # Methods for handling record related requests in both
-    # GandiV5::LiveDNS::Domain and GandiV5::LiveDNS::Zone.
-    module HasZoneRecords
-      # @overload fetch_records()
-      #   Fetch all records for this domain.
-      # @overload fetch_records(name)
-      #   Fetch records for a name.
-      #   @param name [String] the name to fetch records for.
-      # @overload fetch_records(name, type)
-      #   Fetch records of a type for a name.
-      #   @param name [String] the name to fetch records for.
-      #   @param type [String] the record type to fetch.
-      # @return [Array<GandiV5::LiveDNS::RecordSet>]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def fetch_records(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type type if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-
-        _response, data = GandiV5.get url_
-        data = [data] unless data.is_a?(Array)
-        data.map { |item| GandiV5::LiveDNS::RecordSet.from_gandi item }
-      end
-
-      # @overload fetch_zone_lines()
-      #   Fetch all records for this domain.
-      # @overload fetch_zone_lines(name)
-      #   Fetch records for a name.
-      #   @param name [String] the name to fetch records for.
-      # @overload fetch_zone_lines(name, type)
-      #   Fetch records of a type for a name.
-      #   @param name [String] the name to fetch records for.
-      #   @param type [String] the record type to fetch.
-      # @return [String]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def fetch_zone_lines(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type type if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-
-        GandiV5.get(url_, accept: 'text/plain').last
-      end
-
-      # Add record to this domain.
-      # @param name [String]
-      # @param type [String]
-      # @param ttl [Integer]
-      # @param values [Array<String>]
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def add_record(name, type, ttl, *values)
-        GandiV5::LiveDNS.require_valid_record_type type
-        fail ArgumentError, 'ttl must be positive and non-zero' unless ttl.positive?
-        fail ArgumentError, 'there must be at least one value' if values.none?
-
-        body = {
-          rrset_name: name,
-          rrset_type: type,
-          rrset_ttl: ttl,
-          rrset_values: values
-        }.to_json
-        _response, data = GandiV5.post "#{url}/records", body
-        data['message']
-      end
-
-      # @overload delete_records()
-      #   Delete all records for this domain.
-      # @overload delete_records(name)
-      #   Delete records for a name.
-      #   @param name [String] the name to delete records for.
-      # @overload delete_records(name, type)
-      #   Delete records of a type for a name.
-      #   @param name [String] the name to delete records for.
-      #   @param type [String] the record type to delete.
-      # @return [nil]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def delete_records(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type(type) if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-        GandiV5.delete(url_).last
-      end
-
-      # Replace all records for this domain.
-      # @param records
-      #   [Array<Hash<:name, :type => String, :ttl => Integer, :values => Array<String>>>]
-      #   the records to add.
-      # @param text [String] zone file lines to replace the records with.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [ArgumentError] if neither/both of records & test are passed.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def replace_records(records: nil, text: nil)
-        unless [records, text].count(&:nil?).eql?(1)
-          fail ArgumentError, 'you must pass ONE of records: or text:'
-        end
-
-        if records
-          body = {
-            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-          }.to_json
-          _response, data = GandiV5.put "#{url}/records", body
-        elsif text
-          _response, data = GandiV5.put "#{url}/records", text, 'content-type': 'text/plain'
-        end
-        data['message']
-      end
-
-      # @override replace_records_for(name, records)
-      #   Replace records for a name in this domain.
-      #   @param name [String]
-      #   @param records
-      #     [Array<Hash<type: String, ttl: Integer, values: Array<String>>>]
-      #     the records to add.
-      # @override replace_records_for(name, values, type: nil, ttl: nil)
-      #   Replace records for a name in this domain.
-      #   @param name [String]
-      #   @param type [String] the record type.
-      #   @param ttl [Integer] the TTL to set for the record.
-      #   @param values [Array<String>] the values to set for the record.
-      #   @raise [ArgumentError] if ttl is present and type is absent.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def replace_records_for(name, records, type: nil, ttl: nil)
-        fail ArgumentError, 'missing keyword: type' if ttl && type.nil?
-
-        if type
-          GandiV5::LiveDNS.require_valid_record_type type
-          body = { rrset_values: records, rrset_ttl: ttl }
-          # body[:rrset_ttl] = ttl if ttl
-          _response, data = GandiV5.put "#{url}/records/#{name}/#{type}", body.to_json
-
-        else
-          body = {
-            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-          }
-          _response, data = GandiV5.put "#{url}/records/#{name}", body.to_json
-        end
-
-        data['message']
-      end
-    end
-  end
-end

data/lib/gandi_v5/live_dns/record_set.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # A record set which comes from either a domain or zone.
-    # @!attribute [r] type
-    #   @return [String]
-    # @!attribute [r] ttl
-    #   @return [Integer]
-    # @!attribute [r] name
-    #   @return [String]
-    # @!attribute [r] values
-    #   @return [Array<String>]
-    class RecordSet
-      include GandiV5::Data
-
-      member :type, gandi_key: 'rrset_type'
-      member :ttl, gandi_key: 'rrset_ttl', converter: GandiV5::Data::Converter::Integer
-      member :name, gandi_key: 'rrset_name'
-      member :values, gandi_key: 'rrset_values'
-
-      # Generate zone file lines for the record.
-      # @return [String]
-      def to_s
-        values.map do |value|
-          "#{name}\t#{ttl}\tIN\t#{type}\t#{value}"
-        end.join("\n")
-      end
-
-      GandiV5::LiveDNS::RECORD_TYPES.each do |t|
-        # Check the record type.
-        # @return [Boolean]
-        define_method "#{t.downcase}?" do
-          type.eql?(t)
-        end
-      end
-
-      # Check the TTL's value in seconds.
-      # @param number [Integer] the number of second(s) to check against.
-      # @return [Boolean]
-      def second?(number = 1)
-        ttl == number
-      end
-      alias seconds? second?
-
-      # Check the TTL's value in minutes.
-      # @param number [Integer] the number of minute(s) to check against.
-      # @return [Boolean]
-      def minute?(number = 1)
-        ttl == number * 60
-      end
-      alias minutes? minute?
-
-      # Check the TTL's value in hours.
-      # @param number [Integer] the number of hour(s) to check against.
-      # @return [Boolean]
-      def hour?(number = 1)
-        ttl == number * 3_600
-      end
-      alias hours? hour?
-
-      # Check the TTL's value in days.
-      # @param number [Integer] the number of day(s) to check against.
-      # @return [Boolean]
-      def day?(number = 1)
-        ttl == number * 86_400
-      end
-      alias days? day?
-
-      # Check the TTL's value in weeks.
-      # @param number [Integer] the number of week(s) to check against.
-      # @return [Boolean]
-      def week?(number = 1)
-        ttl == number * 604_800
-      end
-      alias weeks? day?
-    end
-  end
-end