gandi_v5 0.6.0 → 0.7.0

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/list.yml

@@ -0,0 +1,4 @@
+---
+- id: key-uuid
+  key_name: key-name
+  secret: key-secret

data/spec/units/gandi_v5/domain_spec.rb

@@ -5,14 +5,14 @@ describe GandiV5::Domain do
 
   describe '.list' do
     let(:body_fixture) { File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain', 'list.yml')) }
+    let(:url) { 'https://api.gandi.net/v5/domain/domains' }
 
     describe 'With default values' do
       subject { described_class.list }
 
       before :each do
-        headers = { params: { page: 1, per_page: 100 } }
-        expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/domains', headers)
-                                        .and_return([nil, YAML.load_file(body_fixture)])
+        expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                  .and_yield(YAML.load_file(body_fixture))
       end
 
       its('count') { should eq 1 }
@@ -44,42 +44,11 @@ describe GandiV5::Domain do
       its('first.contacts?') { should be false }
     end
 
-    it 'Keeps fetching until no more to get' do
-      headers1 = { params: { page: 1, per_page: 1 } }
-      headers2 = { params: { page: 2, per_page: 1 } }
-      # https://github.com/rubocop-hq/rubocop/issues/7088
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/domains', headers1)
-                                      .ordered
-                                      .and_return([nil, YAML.load_file(body_fixture)])
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/domains', headers2)
-                                      .ordered
-                                      .and_return([nil, []])
-
-      expect(described_class.list(per_page: 1).count).to eq 1
-    end
-
-    it 'Given a range as page number' do
-      headers1 = { params: { page: 1, per_page: 1 } }
-      headers2 = { params: { page: 2, per_page: 1 } }
-      # https://github.com/rubocop-hq/rubocop/issues/7088
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/domains', headers1)
-                                      .ordered
-                                      .and_return([nil, YAML.load_file(body_fixture)])
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/domains', headers2)
-                                      .ordered
-                                      .and_return([nil, []])
-
-      expect(described_class.list(page: (1..2), per_page: 1).count).to eq 1
-    end
-
     describe 'Passes optional query params' do
-      %i[fqdn page per_page sort_by tld].each do |param|
+      %i[fqdn sort_by tld].each do |param|
         it param.to_s do
-          param = { param => 5 }
-          headers = { params: { page: 1, per_page: 100 }.merge(param) }
-          expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/domains', headers)
-                                          .and_return([nil, []])
-          expect(described_class.list(**param)).to eq []
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { param => 5 })
+          expect(described_class.list(param => 5)).to eq []
         end
       end
     end

data/spec/units/gandi_v5/email/forward_spec.rb

@@ -63,14 +63,14 @@ describe GandiV5::Email::Forward do
     let(:body_fixture) do
       File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Forward', 'list.yml'))
     end
+    let(:url) { 'https://api.gandi.net/v5/email/forwards/example.com' }
 
     describe 'With default values' do
       subject { described_class.list 'example.com' }
 
       before :each do
-        headers = { params: { page: 1 } }
-        expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/forwards/example.com', headers)
-                                        .and_return([nil, YAML.load_file(body_fixture)])
+        expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                  .and_yield(YAML.load_file(body_fixture))
       end
 
       its('count') { should eq 1 }
@@ -79,40 +79,11 @@ describe GandiV5::Email::Forward do
       its('first.fqdn') { should eq 'example.com' }
     end
 
-    it 'Keeps fetching until no more to get' do
-      headers1 = { params: { page: 1, per_page: 1 } }
-      headers2 = { params: { page: 2, per_page: 1 } }
-      # https://github.com/rubocop-hq/rubocop/issues/7088
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/forwards/example.com', headers1)
-                                      .ordered
-                                      .and_return([nil, YAML.load_file(body_fixture)])
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/forwards/example.com', headers2)
-                                      .ordered
-                                      .and_return([nil, []])
-
-      expect(described_class.list('example.com', per_page: 1).count).to eq 1
-    end
-
-    it 'Given a range as page number' do
-      headers1 = { params: { page: 1, per_page: 1 } }
-      headers2 = { params: { page: 2, per_page: 1 } }
-      # https://github.com/rubocop-hq/rubocop/issues/7088
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/forwards/example.com', headers1)
-                                      .ordered
-                                      .and_return([nil, YAML.load_file(body_fixture)])
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/forwards/example.com', headers2)
-                                      .ordered
-                                      .and_return([nil, []])
-
-      expect(described_class.list('example.com', page: (1..2), per_page: 1).count).to eq 1
-    end
-
     describe 'Passes optional query params' do
       %i[source sort_by].each do |param|
         it param.to_s do
-          headers = { params: { page: 1 }.merge(param => 'value') }
-          expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/forwards/example.com', headers)
-                                          .and_return([nil, []])
+          headers = { params: { param => 'value' } }
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, **headers)
           expect(described_class.list('example.com', param => 'value')).to eq []
         end
       end

data/spec/units/gandi_v5/email/mailbox_spec.rb

@@ -395,14 +395,14 @@ describe GandiV5::Email::Mailbox do
     let(:body_fixture) do
       File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Mailbox', 'list.yml'))
     end
+    let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com' }
 
     describe 'With default values' do
       subject { described_class.list 'example.com' }
 
       before :each do
-        headers = { params: { page: 1 } }
-        expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com', headers)
-                                        .and_return([nil, YAML.load_file(body_fixture)])
+        expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                  .and_yield(YAML.load_file(body_fixture))
       end
 
       its('count') { should eq 1 }
@@ -414,43 +414,13 @@ describe GandiV5::Email::Mailbox do
       its('first.quota_used') { should eq 1_000_000 }
     end
 
-    it 'Keeps fetching until no more to get' do
-      headers1 = { params: { page: 1, per_page: 1 } }
-      headers2 = { params: { page: 2, per_page: 1 } }
-      # https://github.com/rubocop-hq/rubocop/issues/7088
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com', headers1)
-                                      .ordered
-                                      .and_return([nil, YAML.load_file(body_fixture)])
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com', headers2)
-                                      .ordered
-                                      .and_return([nil, []])
-
-      expect(described_class.list('example.com', per_page: 1).count).to eq 1
-    end
-
-    it 'Given a range as page number' do
-      headers1 = { params: { page: 1, per_page: 1 } }
-      headers2 = { params: { page: 2, per_page: 1 } }
-      # https://github.com/rubocop-hq/rubocop/issues/7088
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com', headers1)
-                                      .ordered
-                                      .and_return([nil, YAML.load_file(body_fixture)])
-      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com', headers2)
-                                      .ordered
-                                      .and_return([nil, []])
-
-      expect(described_class.list('example.com', page: (1..2), per_page: 1).count).to eq 1
-    end
-
     describe 'Passes optional query params' do
       {
         login: '~login',
         sort_by: :sort_by
       }.each do |param, query_param|
         it param.to_s do
-          headers = { params: { page: 1 }.merge(query_param => 'value') }
-          expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com', headers)
-                                          .and_return([nil, []])
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { query_param => 'value' })
           expect(described_class.list('example.com', param => 'value')).to eq []
         end
       end

data/spec/units/gandi_v5/live_dns/domain/dnssec_key_spec.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+describe GandiV5::LiveDNS::Domain::DnssecKey do
+  subject do
+    described_class.new(
+      uuid: 'key-uuid',
+      status: 'status',
+      fqdn: 'example.com',
+      algorithm_id: 2,
+      algorithm_name: 'Diffie-Hellman',
+      deleted: false,
+      ds: 'ds-record',
+      flags: 256,
+      fingerprint: 'fp',
+      public_key: 'pub-key',
+      tag: 'tag'
+    )
+  end
+
+  it '#delete' do
+    expect(GandiV5).to receive(:delete).with('https://api.gandi.net/v5/livedns/domains/example.com/keys/key-uuid')
+                                       .and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.delete).to eq 'Confirmation message.'
+    expect(subject.deleted).to be true
+  end
+
+  it '#undelete' do
+    subject = described_class.new deleted: true, uuid: 'key-uuid', fqdn: 'example.com'
+    url = 'https://api.gandi.net/v5/livedns/domains/example.com/keys/key-uuid'
+    expect(GandiV5).to receive(:patch).with(url, '{"deleted":false}')
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.undelete).to eq 'Confirmation message.'
+    expect(subject.deleted).to be false
+  end
+
+  describe 'flags helper methods' do
+    describe '256 (zone signing key)' do
+      before(:each) { subject.instance_exec { @flags = 256 } }
+      its('zone_signing_key?') { should be true }
+      its('key_signing_key?') { should be false }
+    end
+
+    describe '257 (key signing key)' do
+      before(:each) { subject.instance_exec { @flags = 257 } }
+      its('zone_signing_key?') { should be false }
+      its('key_signing_key?') { should be true }
+    end
+  end
+
+  describe '.create' do
+    let(:url) { 'https://api.gandi.net/v5/livedns/domains/example.com/keys' }
+    let(:response) do
+      double RestClient::Response, headers: {
+        location: 'https://api.gandi.net/v5/livedns/domains/example.com/keys/created-key-uuid'
+      }
+    end
+
+    it 'Accepts integer for flags' do
+      returns = double described_class
+      expect(GandiV5).to receive(:post).with(url, '{"flags":256}').and_return([response, nil])
+      expect(described_class).to receive(:fetch).with('example.com', 'created-key-uuid')
+                                                .and_return(returns)
+      expect(described_class.create('example.com', :zone_signing_key)).to be returns
+    end
+
+    it 'Accepts :zone_signing_key for flags' do
+      expect(GandiV5).to receive(:post).with(url, '{"flags":256}').and_return([response, nil])
+      expect(described_class).to receive(:fetch)
+      described_class.create('example.com', :zone_signing_key)
+    end
+
+    it 'Accepts :key_signing_key for flags' do
+      expect(GandiV5).to receive(:post).with(url, '{"flags":257}').and_return([response, nil])
+      expect(described_class).to receive(:fetch)
+      described_class.create('example.com', :key_signing_key)
+    end
+
+    it 'Fails on invalid flags' do
+      expect { described_class.create('example.com', :invalid) }.to raise_error ArgumentError, 'flags is invalid'
+      expect { described_class.create('example.com', '0') }.to raise_error ArgumentError, 'flags is invalid'
+    end
+  end
+
+  it '.list' do
+    body_fixture = File.expand_path(
+      File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Domain_DnssecKey', 'list.yml')
+    )
+    url = 'https://api.gandi.net/v5/livedns/domains/example.com/keys'
+
+    expect(GandiV5).to receive(:get).with(url).and_return([nil, YAML.load_file(body_fixture)])
+    results = described_class.list('example.com')
+    result = results.first
+    expect(results.count).to eq 1
+    expect(result.uuid).to eq 'key-uuid'
+    expect(result.status).to eq 'status'
+    expect(result.fqdn).to eq 'example.com'
+    expect(result.algorithm_id).to eq 2
+    expect(result.algorithm_name).to eq 'Diffie-Hellman'
+    expect(result.deleted).to be false
+    expect(result.ds).to eq 'ds-record'
+    expect(result.flags).to eq 256
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'example.com', 'key-uuid' }
+
+    before :each do
+      body_fixture = File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Domain_DnssecKey', 'fetch.yml')
+      )
+      url = 'https://api.gandi.net/v5/livedns/domains/example.com/keys/key-uuid'
+      expect(GandiV5).to receive(:get).with(url)
+                                      .and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('uuid') { should eq 'key-uuid' }
+    its('status') { should eq 'status' }
+    its('fqdn') { should eq 'example.com' }
+    its('algorithm_id') { should eq 2 }
+    its('algorithm_name') { should eq 'Diffie-Hellman' }
+    its('deleted') { should be false }
+    its('ds') { should eq 'ds-record' }
+    its('flags') { should eq 256 }
+    its('fingerprint') { should eq 'fp' }
+    its('public_key') { should eq 'pub-key' }
+    its('tag') { should eq 'tag' }
+  end
+end

data/spec/units/gandi_v5/live_dns/{record_set_spec.rb → domain/record_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe GandiV5::LiveDNS::RecordSet do
+describe GandiV5::LiveDNS::Domain::Record do
   subject do
     described_class.new type: 'A', ttl: 900, name: 'www', values: %w[192.168.0.1 192.168.0.2]
   end

data/spec/units/gandi_v5/live_dns/domain/snapshot_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+describe GandiV5::LiveDNS::Domain::Snapshot do
+  subject do
+    described_class.new(
+      created_at: Time.new(2016, 12, 16, 16, 51, 26, 0),
+      uuid: 'snapshot-uuid',
+      name: 'snapshot-name',
+      automatic: false,
+      records: [],
+      fqdn: 'example.com'
+    )
+  end
+
+  it '#update' do
+    url = 'https://api.gandi.net/v5/livedns/domains/example.com/snapshots/snapshot-uuid'
+    body = '{"name":"NEW NAME"}'
+    expect(GandiV5).to receive(:patch).with(url, body)
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.update(name: 'NEW NAME')).to eq 'Confirmation message.'
+    expect(subject.name).to eq 'NEW NAME'
+  end
+
+  it '#delete' do
+    expect(GandiV5).to receive(:delete).with('https://api.gandi.net/v5/livedns/domains/example.com/snapshots/snapshot-uuid')
+                                       .and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.delete).to eq 'Confirmation message.'
+  end
+
+  describe '#records' do
+    it 'Returns existing if present' do
+      expect(GandiV5).to_not receive(:get)
+      expect(subject.records).to eq []
+    end
+
+    it 'Fetches and saves if not present' do
+      subject = described_class.new fqdn: 'example.com', uuid: 'snapshot-uuid'
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/livedns/domains/example.com/snapshots/snapshot-uuid')
+                                      .and_return([nil, { 'zone_data' => [{ 'rrset_name' => 'HELLO' }] }])
+      expect(subject.records.count).to eq 1
+      expect(subject.records.first.name).to eq 'HELLO'
+    end
+  end
+
+  describe '.list' do
+    let :body_fixture do
+      File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Domain_Snapshot', 'list.yml'))
+    end
+    let(:url) { 'https://api.gandi.net/v5/livedns/domains/example.com/snapshots' }
+
+    it 'With default parameters' do
+      expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                .and_yield(YAML.load_file(body_fixture))
+      results = described_class.list('example.com')
+      result = results.first
+      expect(results.count).to eq 1
+      expect(result.name).to eq 'snapshot-name'
+      expect(result.created_at).to eq Time.new(2016, 12, 16, 16, 51, 26, 0)
+      expect(result.uuid).to eq 'snapshot-uuid'
+      expect(result.automatic).to be true
+      expect(result.fqdn).to eq 'example.com'
+    end
+
+    describe 'Passes optional query params' do
+      describe 'automatic' do
+        it 'true' do
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { automatic: true })
+          described_class.list('example.com', automatic: true)
+        end
+
+        it 'false' do
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { automatic: false })
+          described_class.list('example.com', automatic: false)
+        end
+      end
+    end
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'example.com', 'snapshot-uuid' }
+
+    before :each do
+      body_fixture = File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Domain_Snapshot', 'fetch.yml')
+      )
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/livedns/domains/example.com/snapshots/snapshot-uuid')
+                                      .and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('created_at') { should eq Time.new(2016, 12, 16, 16, 51, 26, 0) }
+    its('uuid') { should eq 'snapshot-uuid' }
+    its('name') { should eq 'snapshot-name' }
+    its('automatic') { should be true }
+    its('fqdn') { should eq 'example.com' }
+    its('records.count') { should eq 1 }
+    its('records.first.type') { should eq 'A' }
+    its('records.first.ttl') { should eq 10_800 }
+    its('records.first.name') { should eq 'www' }
+    its('records.first.values') { should match_array ['10.0.1.42'] }
+  end
+end

data/spec/units/gandi_v5/live_dns/domain/tsig_key_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+describe GandiV5::LiveDNS::Domain::TsigKey do
+  subject do
+    described_class.new(
+      uuid: 'key-uuid',
+      name: 'key-name',
+      secret: 'key-secret',
+      config_examples: { test: 'test config sample' }
+    )
+  end
+
+  describe '.create' do
+    it 'Without sharing_id' do
+      url = 'https://api.gandi.net/v5/livedns/axfr/tsig'
+      created = { 'href' => '', 'id' => 'created-key-uuid', 'key_name' => 'based on id' }
+      returns = double described_class
+
+      expect(GandiV5).to receive(:post).with(url).and_return([nil, created])
+      expect(described_class).to receive(:fetch).with('created-key-uuid')
+                                                .and_return(returns)
+      expect(described_class.create).to be returns
+    end
+
+    it 'With sharing_id' do
+      url = 'https://api.gandi.net/v5/livedns/axfr/tsig?sharing_id=sharing-id'
+      created = { 'href' => '', 'id' => 'created-key-uuid', 'key_name' => 'based on id' }
+      returns = double described_class
+
+      expect(GandiV5).to receive(:post).with(url).and_return([nil, created])
+      expect(described_class).to receive(:fetch).with('created-key-uuid')
+                                                .and_return(returns)
+      expect(described_class.create('sharing-id')).to be returns
+    end
+  end
+
+  it '.list' do
+    body_fixture = File.expand_path(
+      File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Domain_TsigKey', 'list.yml')
+    )
+    url = 'https://api.gandi.net/v5/livedns/axfr/tsig'
+
+    expect(GandiV5).to receive(:get).with(url).and_return([nil, YAML.load_file(body_fixture)])
+    results = described_class.list
+    result = results.first
+    expect(results.count).to eq 1
+    expect(result.uuid).to eq 'key-uuid'
+    expect(result.name).to eq 'key-name'
+    expect(result.secret).to eq 'key-secret'
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'key-uuid' }
+
+    before :each do
+      body_fixture = File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Domain_TsigKey', 'fetch.yml')
+      )
+      url = 'https://api.gandi.net/v5/livedns/axfr/tsig/key-uuid'
+      expect(GandiV5).to receive(:get).with(url)
+                                      .and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('uuid') { should eq 'key-uuid' }
+    its('name') { should eq 'key-name' }
+    its('secret') { should eq 'key-secret' }
+    its('config_examples') do
+      should eq(
+        {
+          bind: 'bind-sample',
+          knot: 'knot-sample',
+          nsd: 'nsd-sample',
+          powerdns: 'powerdns-sample'
+        }
+      )
+    end
+  end
+end