gandi_v5 0.6.0 → 0.10.0

data/spec/units/gandi_v5/domain/web_forwarding_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::WebForwarding do
+  subject { described_class.new fqdn: 'host.example.com' }
+
+  describe '#update' do
+    let(:url) { 'https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com' }
+    let(:updated_forwarding) { double GandiV5::Domain::WebForwarding }
+
+    before :each do
+      expect(subject).to receive(:refresh).and_return(updated_forwarding)
+      subject.instance_exec { @domain = 'example.com' }
+    end
+
+    it 'nothing' do
+      expect(GandiV5).to receive(:patch).with(url, '{}')
+      expect(subject.update).to be updated_forwarding
+    end
+
+    it 'target' do
+      expect(GandiV5).to receive(:patch).with(url, '{"url":"new"}')
+      expect(subject.update(target: 'new')).to be updated_forwarding
+    end
+
+    it 'override' do
+      expect(GandiV5).to receive(:patch).with(url, '{"override":false}')
+      expect(subject.update(override: false)).to be updated_forwarding
+    end
+
+    it 'protocol' do
+      expect(GandiV5).to receive(:patch).with(url, '{"protocol":"httpsonly"}')
+      expect(subject.update(protocol: :httpsonly)).to be updated_forwarding
+    end
+
+    it 'type' do
+      expect(GandiV5).to receive(:patch).with(url, '{"type":"http302"}')
+      expect(subject.update(type: :http302)).to be updated_forwarding
+    end
+  end
+
+  it '#delete' do
+    url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com'
+    expect(GandiV5).to receive(:delete).with(url).and_return([nil, { 'message' => 'Confirmation message.' }])
+    subject.instance_exec { @domain = 'example.com' }
+    expect(subject.delete).to eq 'Confirmation message.'
+  end
+
+  describe 'helper methods' do
+    context 'an HTTP 301 redirect' do
+      subject { described_class.new type: :http301 }
+      it('#permanent?') { expect(subject.permanent?).to be true }
+      it('#http301?') { expect(subject.http301?).to be true }
+      it('#temporary?') { expect(subject.temporary?).to be false }
+      it('#http302?') { expect(subject.http302?).to be false }
+      it('#found?') { expect(subject.found?).to be false }
+    end
+
+    context 'an HTTP 302 redirect' do
+      subject { described_class.new type: :http302 }
+      it('#permanent?') { expect(subject.permanent?).to be false }
+      it('#http301?') { expect(subject.http301?).to be false }
+      it('#temporary?') { expect(subject.temporary?).to be true }
+      it('#http302?') { expect(subject.http302?).to be true }
+      it('#found?') { expect(subject.found?).to be true }
+    end
+
+    context 'an http endpoint' do
+      subject { described_class.new protocol: :http }
+      it('#http?') { expect(subject.http?).to be true }
+      it('#https?') { expect(subject.https?).to be false }
+      it('#https_only?') { expect(subject.https_only?).to be false }
+    end
+
+    context 'an https endpoint' do
+      subject { described_class.new protocol: :https }
+      it('#http?') { expect(subject.http?).to be true }
+      it('#https?') { expect(subject.https?).to be true }
+      it('#https_only?') { expect(subject.https_only?).to be false }
+    end
+
+    context 'an https_only endpoint' do
+      subject { described_class.new protocol: :https_only }
+      it('#http?') { expect(subject.http?).to be false }
+      it('#https?') { expect(subject.https?).to be true }
+      it('#https_only?') { expect(subject.https_only?).to be true }
+    end
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'example.com', 'host' }
+
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_WebForwarding', 'fetch.yml'))
+      url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com'
+      expect(GandiV5).to receive(:get).with(url).and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('created_at') { should eq Time.new(2020, 11, 29, 14, 57, 14) }
+    its('updated_at') { should eq Time.new(2020, 11, 29, 14, 57, 15) }
+    its('type') { should eq :http301 }
+    its('fqdn') { should eq 'here.example.com' }
+    its('protocol') { should eq :https }
+    its('target') { should eq 'https://example.com/here' }
+    its('cert_status') { should eq '?' }
+    its('cert_uuid') { should eq 'cert-uuid' }
+  end
+
+  describe '.list' do
+    subject { described_class.list 'example.com' }
+
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_WebForwarding', 'list.yml'))
+      url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs'
+      expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100)
+                                                .and_yield(YAML.load_file(body_fixture))
+    end
+
+    its('count') { should eq 1 }
+    its('first.created_at') { should eq Time.new(2020, 11, 29, 14, 57, 14) }
+    its('first.updated_at') { should eq Time.new(2020, 11, 29, 14, 57, 15) }
+    its('first.type') { should eq :http301 }
+    its('first.fqdn') { should eq 'here.example.com' }
+    its('first.protocol') { should eq :https }
+    its('first.target') { should eq 'https://example.com/here' }
+    its('first.cert_status') { should eq '?' }
+    its('first.cert_uuid') { should eq 'cert-uuid' }
+  end
+
+  it '.create' do
+    url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs'
+    body = '{"host":"host","protocol":"httpsonly","type":"http302","url":"example.com","override":true}'
+    response = double(
+      RestClient::Response,
+      headers: { location: ' https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com' }
+    )
+    created_forwarding = double GandiV5::Domain::WebForwarding
+    expect(GandiV5).to receive(:post).with(url, body).and_return([response, 'Confirmation message'])
+    expect(described_class).to receive(:fetch).with('example.com', 'host').and_return(created_forwarding)
+
+    create = {
+      domain: 'example.com',
+      host: 'host',
+      target: 'example.com',
+      protocol: :https_only,
+      type: :http302,
+      override: true
+    }
+    expect(described_class.create(**create)).to be created_forwarding
+  end
+end

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 resellee_id].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
@@ -239,6 +208,18 @@ describe GandiV5::Domain do
     expect(subject.email_forwards(param: :value)).to be returns
   end
 
+  it '.webforwardings' do
+    returns = double Array
+    expect(GandiV5::Domain::WebForwarding).to receive(:list).with('example.com', param: :value).and_return(returns)
+    expect(subject.web_forwardings(param: :value)).to be returns
+  end
+
+  it '.webforwarding' do
+    returns = double Array
+    expect(GandiV5::Domain::WebForwarding).to receive(:fetch).with('example.com', 'host').and_return(returns)
+    expect(subject.web_forwarding('host')).to be returns
+  end
+
   describe '#to_s' do
     it 'Has identical fqdn and fqdn_unicode' do
       domain = described_class.new fqdn: 'example.com', fqdn_unicode: 'example.com'
@@ -525,6 +506,44 @@ describe GandiV5::Domain do
     end
   end
 
+  describe '#transfer_lock' do
+    it 'Passing nothing' do
+      expect(GandiV5).to receive(:patch).with(
+        'https://api.gandi.net/v5/domain/domains/example.com/status',
+        '{"clientTransferProhibited":true}'
+      ).and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.transfer_lock).to eq 'Confirmation message.'
+      expect(subject.status).to eq 'clientTransferProhibited'
+    end
+
+    it 'Passing true' do
+      expect(GandiV5).to receive(:patch).with(
+        'https://api.gandi.net/v5/domain/domains/example.com/status',
+        '{"clientTransferProhibited":true}'
+      ).and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.transfer_lock(true)).to eq 'Confirmation message.'
+      expect(subject.status).to eq 'clientTransferProhibited'
+    end
+
+    it 'Passing false' do
+      expect(GandiV5).to receive(:patch).with(
+        'https://api.gandi.net/v5/domain/domains/example.com/status',
+        '{"clientTransferProhibited":false}'
+      ).and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.transfer_lock(false)).to eq 'Confirmation message.'
+      expect(subject.status).to be nil
+    end
+  end
+
+  it '#transfer_unlock' do
+    expect(GandiV5).to receive(:patch).with(
+      'https://api.gandi.net/v5/domain/domains/example.com/status',
+      '{"clientTransferProhibited":false}'
+    ).and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.transfer_unlock).to eq 'Confirmation message.'
+    expect(subject.status).to be nil
+  end
+
   describe '#glue_records' do
     let(:glue_records) { double Hash }
 

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