gandi_v5 0.2.0 → 0.7.0

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+describe GandiV5::Email::Forward do
+  subject { described_class.new source: 'alice', destinations: ['bob@example.com'], fqdn: 'example.com' }
+
+  describe '#update' do
+    it 'ʘ‿ʘ' do
+      expect(GandiV5).to receive(:put).with(
+        'https://api.gandi.net/v5/email/forwards/example.com/alice',
+        '{"destinations":["bob@example.com","charlie@example.com"]}'
+      )
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.update('bob@example.com', 'charlie@example.com')).to eq 'Confirmation message.'
+      expect(subject.destinations).to match_array ['bob@example.com', 'charlie@example.com']
+    end
+
+    it 'Empty destinations' do
+      expect { subject.update }.to raise_error ArgumentError, 'destinations can\'t be empty'
+    end
+  end
+
+  it '#delete' do
+    expect(GandiV5).to receive(:delete).with(
+      'https://api.gandi.net/v5/email/forwards/example.com/alice'
+    )
+                                       .and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.delete).to eq 'Confirmation message.'
+  end
+
+  describe '#to_s' do
+    it 'With one destination' do
+      expect(subject.to_s).to eq 'alice@example.com -> bob@example.com'
+    end
+
+    it 'With many destinations' do
+      subject.instance_exec { @destinations = ['bob@example.com', 'charlie@example.com'] }
+      expect(subject.to_s).to eq 'alice@example.com -> bob@example.com, charlie@example.com'
+    end
+  end
+
+  describe '.create' do
+    it 'ʘ‿ʘ' do
+      response = double(
+        RestClient::Response,
+        headers: { location: 'https://api.gandi.net/v5/email/forwards/example.com/alice' }
+      )
+      expect(GandiV5).to receive(:post).with(
+        'https://api.gandi.net/v5/email/forwards/example.com',
+        '{"source":"alice","destinations":["bob@example.com"]}'
+      )
+                                       .and_return([response, { 'message' => 'Confirmation message.' }])
+
+      forward = described_class.new fqdn: 'example.com', source: 'alice', destinations: ['bob@example.com']
+      expect(described_class.create('example.com', 'alice', 'bob@example.com').to_h).to eq forward.to_h
+    end
+
+    it 'Empty destinations' do
+      expect { described_class.create('example.com', 'alice') }.to raise_error ArgumentError, 'destinations can\'t be empty'
+    end
+  end
+
+  describe '.list' 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
+        expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                  .and_yield(YAML.load_file(body_fixture))
+      end
+
+      its('count') { should eq 1 }
+      its('first.source') { should eq 'alice' }
+      its('first.destinations') { should match_array ['bob@example.com', 'charlie@example.com'] }
+      its('first.fqdn') { should eq 'example.com' }
+    end
+
+    describe 'Passes optional query params' do
+      %i[source sort_by].each do |param|
+        it param.to_s do
+          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
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ describe GandiV5::Email::Mailbox do
 
   describe '#refresh' do
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Mailbox', 'get.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Mailbox', 'fetch.yml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid')
                                       .and_return([nil, YAML.load_file(body_fixture)])
       subject.refresh
@@ -87,6 +87,108 @@ describe GandiV5::Email::Mailbox do
     end
   end
 
+  describe '#upgrade' do
+    let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type' }
+
+    context 'No sharing_id' do
+      it 'Is upgraded' do
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"premium"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.upgrade).to be true
+        expect(subject.type).to be :premium
+      end
+
+      it 'Is already premium' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.upgrade).to be false
+      end
+    end
+
+    context 'With sharing_id' do
+      let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type?sharing_id=abc' }
+
+      it 'Is upgraded' do
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"premium"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.upgrade(sharing_id: 'abc')).to be true
+        expect(subject.type).to be :premium
+      end
+
+      it 'Is already premium' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.upgrade(sharing_id: 'abc')).to be false
+      end
+    end
+
+    context 'Dry run' do
+      it 'Is upgraded' do
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"premium"}', 'Dry-Run': 1)
+                                          .and_return([nil, { 'status' => 'success' }])
+        expect(subject.upgrade(dry_run: true)).to eq('status' => 'success')
+        expect(subject.type).to be :standard
+      end
+
+      it 'Is already premium' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.upgrade(dry_run: true)).to be false
+      end
+    end
+  end
+
+  describe '#downgrade' do
+    let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type' }
+
+    context 'No sharing_id' do
+      it 'Is downgraded' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"standard"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.downgrade).to be true
+        expect(subject.type).to be :standard
+      end
+
+      it 'Is already premium' do
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.downgrade).to be false
+      end
+    end
+
+    context 'With sharing_id' do
+      let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type?sharing_id=abc' }
+
+      it 'Is downgraded' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"standard"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.downgrade(sharing_id: 'abc')).to be true
+        expect(subject.type).to be :standard
+      end
+
+      it 'Is already premium' do
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.downgrade(sharing_id: 'abc')).to be false
+      end
+    end
+
+    context 'Dry run' do
+      it 'Is downgraded' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"standard"}', 'Dry-Run': 1)
+                                          .and_return([nil, { 'status' => 'success' }])
+        expect(subject.downgrade(dry_run: true)).to eq('status' => 'success')
+        expect(subject.type).to be :premium
+      end
+
+      it 'Is already premium' do
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.downgrade(dry_run: true)).to be false
+      end
+    end
+  end
+
   it '#delete' do
     url = 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid'
     expect(GandiV5).to receive(:delete).with(url)
@@ -204,7 +306,7 @@ describe GandiV5::Email::Mailbox do
 
     it 'No aliases and :standard type' do
       body = '{"mailbox_type":"standard","login":"login","password":"crypted_password","aliases":[]}'
-      expect(GandiV5).to receive(:post).with(url, body)
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
       expect(described_class).to receive(:fetch).with('example.com', 'created-mailbox-uuid').and_return(created_mailbox)
@@ -214,7 +316,7 @@ describe GandiV5::Email::Mailbox do
 
     it 'With aliases' do
       body = '{"mailbox_type":"standard","login":"login","password":"crypted_password","aliases":["alias-1"]}'
-      expect(GandiV5).to receive(:post).with(url, body)
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
       expect(described_class).to receive(:fetch).with('example.com', 'created-mailbox-uuid').and_return(created_mailbox)
@@ -224,7 +326,7 @@ describe GandiV5::Email::Mailbox do
 
     it 'With different type' do
       body = '{"mailbox_type":"premium","login":"login","password":"crypted_password","aliases":[]}'
-      expect(GandiV5).to receive(:post).with(url, body)
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
       expect(described_class).to receive(:fetch).with('example.com', 'created-mailbox-uuid').and_return(created_mailbox)
@@ -254,13 +356,23 @@ describe GandiV5::Email::Mailbox do
         'no available standard slots'
       )
     end
+
+    it 'Doing a dry run' do
+      body = '{"mailbox_type":"standard","login":"login","password":"crypted_password","aliases":[]}'
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 1)
+                                       .and_return([nil, { 'status' => 'success' }])
+      expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
+      expect(described_class).to_not receive(:fetch)
+
+      expect(described_class.create('example.com', 'login', good_password, dry_run: true)).to eq('status' => 'success')
+    end
   end
 
   describe '.fetch' do
     subject { described_class.fetch 'example.com', 'mailbox-uuid' }
 
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Mailbox', 'get.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Mailbox', 'fetch.yml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid')
                                       .and_return([nil, YAML.load_file(body_fixture)])
     end
@@ -281,16 +393,16 @@ describe GandiV5::Email::Mailbox do
 
   describe '.list' do
     let(:body_fixture) do
-      File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Mailbox', 'list.yaml'))
+      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 }
@@ -302,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/email/slot_spec.rb

@@ -28,7 +28,7 @@ describe GandiV5::Email::Slot do
 
   describe '#refresh' do
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Slot', 'get.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Slot', 'fetch.yml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/slots/example.com/123')
                                       .and_return([nil, YAML.load_file(body_fixture)])
       subject.refresh
@@ -130,7 +130,7 @@ describe GandiV5::Email::Slot do
     end
     let(:created_slot) { double GandiV5::Email::Slot }
 
-    it 'With default type' do
+    it 'With default type and no sharingID' do
       expect(GandiV5).to receive(:post).with(url, '{"mailbox_type":"standard"}')
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:fetch).with('example.com', 'created-slot-uuid').and_return(created_slot)
@@ -143,7 +143,15 @@ describe GandiV5::Email::Slot do
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:fetch).with('example.com', 'created-slot-uuid').and_return(created_slot)
 
-      expect(described_class.create('example.com', :premium)).to be created_slot
+      expect(described_class.create('example.com', type: :premium)).to be created_slot
+    end
+
+    it 'With sharingID' do
+      expect(GandiV5).to receive(:post).with("#{url}?sharing_id=SHARING-ID", '{"mailbox_type":"standard"}')
+                                       .and_return([created_response, { 'message' => 'Confirmation message.' }])
+      expect(described_class).to receive(:fetch).with('example.com', 'created-slot-uuid').and_return(created_slot)
+
+      expect(described_class.create('example.com', sharing_id: 'SHARING-ID')).to be created_slot
     end
   end
 
@@ -151,7 +159,7 @@ describe GandiV5::Email::Slot do
     subject { described_class.fetch 'example.com', 123 }
 
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Slot', 'get.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Slot', 'fetch.yml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/slots/example.com/123')
                                       .and_return([nil, YAML.load_file(body_fixture)])
     end
@@ -171,7 +179,7 @@ describe GandiV5::Email::Slot do
     subject { described_class.list 'example.com' }
 
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Slot', 'list.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Email_Slot', 'list.yml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/email/slots/example.com')
                                       .and_return([nil, YAML.load_file(body_fixture)])
     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