gandi_v5 0.8.0 → 0.10.1

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

@@ -208,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'
@@ -494,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/simple_hosting/instance/virtual_host_spec.rb

@@ -28,6 +28,85 @@ describe GandiV5::SimpleHosting::Instance::VirtualHost do
     expect(subject.linked_dns_zone.cname).to_not be nil
   end
 
+  describe '#update' do
+    describe 'application' do
+      it 'Given a GandiV5::SimpleHosting::Instance::Application' do
+        application = GandiV5::SimpleHosting::Instance::Application.new(
+          name: 'app-name',
+          parameters: {}
+        )
+
+        expect(GandiV5).to receive(:put).with(
+          'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com',
+          '{"application":{"name":"app-name","parameters":{}}}'
+        ).and_return([nil, body_fetch])
+        subject.update(application: application)
+
+        expect(subject.application.name).to eq 'app-name'
+        expect(subject.application.parameters).to eq({})
+      end
+
+      it 'Given a Hash' do
+        expect(GandiV5).to receive(:put).with(
+          'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com',
+          '{"application":{"name":"app-name"}}'
+        ).and_return([nil, body_fetch])
+        subject.update(application: { name: 'app-name' })
+      end
+    end
+
+    describe 'https_strategy' do
+      it ':redirect_http_to_https' do
+        expect(GandiV5).to receive(:put).with(
+          'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com',
+          '{"https_strategy":"redirect_HTTP_to_HTTPS"}'
+        ).and_return([nil, body_fetch])
+        subject.update(https_strategy: :redirect_http_to_https)
+        expect(subject.https_strategy).to be :redirect_http_to_https
+      end
+
+      it ':allow_http_and_https' do
+        expect(GandiV5).to receive(:put).with(
+          'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com',
+          '{"https_strategy":"allow_HTTP_and_HTTPS"}'
+        ).and_return([nil, body_fetch])
+        subject.update(https_strategy: :allow_http_and_https)
+        expect(subject.https_strategy).to be :redirect_http_to_https
+      end
+
+      it ':http_only' do
+        expect(GandiV5).to receive(:put).with(
+          'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com',
+          '{"https_strategy":"HTTP_only"}'
+        ).and_return([nil, body_fetch])
+        subject.update(https_strategy: :http_only)
+        expect(subject.https_strategy).to be :redirect_http_to_https
+      end
+
+      it 'invalid' do
+        expect(GandiV5).not_to receive(:put)
+        expect { subject.update(https_strategy: :invalid) }.to \
+          raise_error ArgumentError, 'https_strategy :invalid is invalid'
+      end
+    end
+
+    it 'linked_dns_zone' do
+      expect(GandiV5).to receive(:put).with(
+        'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com',
+        '{"linked_dns_zone":{"allow_alteration":false,"allow_alteration_override":true}}'
+      ).and_return([nil, body_fetch])
+      subject.update(linked_dns_zone_allow_alteration: false, linked_dns_zone_allow_alteration_override: true)
+      expect(subject.linked_dns_zone.allow_alteration).to be true
+    end
+  end
+
+  it '#delete' do
+    expect(GandiV5).to receive(:delete).with(
+      'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com'
+    ).and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.delete).to eq 'Confirmation message.'
+  end
+
   describe 'Helper methods' do
     describe 'Status' do
       context 'being_created' do
@@ -130,6 +209,52 @@ describe GandiV5::SimpleHosting::Instance::VirtualHost do
     end
   end
 
+  describe '.create' do
+    it 'With just fqdn' do
+      expect(GandiV5).to receive(:post).with(
+        'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts',
+        '{"fqdn":"vh.example.com"}'
+      ).and_return([nil, nil])
+
+      url = 'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com'
+      expect(GandiV5).to receive(:get).with(url).and_return([nil, body_fetch])
+
+      subject = described_class.create('instance-uuid', 'vh.example.com')
+      expect(subject.created_at).to eq Time.new(2020, 1, 2, 12, 34, 56, 0)
+    end
+
+    it 'Also with application' do
+      expect(GandiV5).to receive(:post).with(
+        'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts',
+        '{"fqdn":"vh.example.com","application":{"name":"app-name"}}'
+      ).and_return([nil, nil])
+
+      url = 'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com'
+      expect(GandiV5).to receive(:get).with(url).and_return([nil, body_fetch])
+
+      subject = described_class.create('instance-uuid', 'vh.example.com', application: { name: 'app-name' })
+      expect(subject.created_at).to eq Time.new(2020, 1, 2, 12, 34, 56, 0)
+    end
+
+    it 'Also with linked_dns_zone' do
+      expect(GandiV5).to receive(:post).with(
+        'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts',
+        '{"fqdn":"vh.example.com","linked_dns_zone":{"allow_alteration":false,"allow_alteration_override":true}}'
+      ).and_return([nil, nil])
+
+      url = 'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts/vh.example.com'
+      expect(GandiV5).to receive(:get).with(url).and_return([nil, body_fetch])
+
+      subject = described_class.create(
+        'instance-uuid',
+        'vh.example.com',
+        linked_dns_zone_allow_alteration: false,
+        linked_dns_zone_allow_alteration_override: true
+      )
+      expect(subject.created_at).to eq Time.new(2020, 1, 2, 12, 34, 56, 0)
+    end
+  end
+
   describe '.list' do
     subject { described_class.list('instance-uuid') }
     let(:url) { 'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts' }

data/spec/units/gandi_v5/simple_hosting/instance_spec.rb

@@ -179,4 +179,12 @@ describe GandiV5::SimpleHosting::Instance do
     its('upgrade_to.first.type') { should eq 'database' }
     its('upgrade_to.first.version') { should eq 'upgrade to version' }
   end
+
+  it '.create_virtual_host' do
+    returns = double Object
+    expect(GandiV5::SimpleHosting::Instance::VirtualHost).to receive(:create).with('instance-uuid', 'fqdn', key: :value)
+                                                                             .and_return(returns)
+    expect(subject).to receive(:refresh)
+    subject.create_virtual_host 'fqdn', key: :value
+  end
 end

data/spec/units/gandi_v5/template/dispatch_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+describe GandiV5::Template::Dispatch do
+  subject do
+    described_class.new uuid: 'dispatch-uuid'
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch('dispatch-uuid') }
+
+    before :each do
+      expect(GandiV5).to receive(:get).with(url).and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    let(:url) { 'https://api.gandi.net/v5/template/dispatch/dispatch-uuid' }
+    let(:body_fixture) do
+      File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Template_Dispatch', 'fetch.yml'))
+    end
+
+    its('attempt') { should eq 1 }
+    its('created_at') { should eq Time.new(2020, 11, 29, 14, 57, 14) }
+    its('uuid') { should eq 'dispatch-uuid' }
+    its('created_by') { should eq 'sharing-uuid' }
+    its('state') { should be :running }
+    its('state_message') { should eq 'state message' }
+    its('updated_at') { should eq Time.new(2020, 11, 29, 14, 57, 15) }
+    its('template_uuid') { should eq 'template-uuid' }
+    its('template_name') { should eq 'template' }
+    its('target_uuid') { should eq 'target-uuid' }
+    its('task_history') do
+      should eq(
+        [
+          {
+            at: Time.new(2020, 11, 29, 16, 57, 47),
+            what: :name_servers,
+            status: :done,
+            message: ''
+          }
+        ]
+      )
+    end
+    its('task_statuses') do
+      should eq(
+        {
+          dns_records: :pending,
+          mailboxes: :running,
+          name_servers: :done,
+          web_forwardings: :error
+        }
+      )
+    end
+
+    its('payload.dns_records.count') { should eq 1 }
+    its('payload.dns_records.first.name') { should eq 'record-name' }
+    its('payload.dns_records.first.type') { should eq 'TXT' }
+    its('payload.dns_records.first.values') { should eq ['record-value'] }
+    its('payload.dns_records.first.ttl') { should eq 600 }
+
+    its('payload.mailboxes') { should eq ['user-name'] }
+
+    its('payload.name_servers') { should eq ['1.1.1.1'] }
+
+    its('payload.web_forwardings.count') { should eq 1 }
+    its('payload.web_forwardings.first.type') { should eq :http301 }
+    its('payload.web_forwardings.first.target') { should eq 'https://example.com/here' }
+    its('payload.web_forwardings.first.fqdn') { should eq 'here.example.com' }
+    its('payload.web_forwardings.first.override') { should be true }
+    its('payload.web_forwardings.first.protocol') { should eq :https }
+  end
+end

data/spec/units/gandi_v5/template/payload/web_forwarding_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+describe GandiV5::Template::Payload::WebForwarding do
+  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
+end