gandi_v5 0.7.0 → 0.8.0

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

@@ -0,0 +1,38 @@
+---
+- available_upgrade: true
+  created_at: 2020-01-02T12:34:56+00
+  database:
+    name: database name
+    status: database status
+    version: database version
+  datacenter:
+    code: FR-SD5
+    name: SD5
+    region: FR
+  expire_at: 2021-01-02T12:34:56+00
+  id: instance-uuid
+  language:
+    name: ruby
+    single_application: true
+    status: great
+    version: "2.7"
+  name: instance name
+  sharing_space:
+    id: sharing-space-uuid
+    name: sharing space name
+  size: s+
+  snapshot_enabled: true
+  status: active
+  storage:
+    additional:
+      unit: GB
+      value: 10
+    base:
+      unit: GB
+      value: 20
+    total:
+      unit: GB
+      value: 30
+  autorenew:
+    duration: 1
+    duration_type: m

data/spec/fixtures/bodies/GandiV5_SimpleHosting_Instance_VirtualHost/fetch.yml

@@ -0,0 +1,26 @@
+---
+created_at: 2020-01-02T12:34:56+00
+fqdn: vh.example.com
+is_a_test_vhost: false
+linked_dns_zone:
+  allow_alteration: true
+  cname: cn
+  domain: example.com
+  ipv4: 1.2.3.4
+  ipv6: 1:2::3:4
+  is_alterable: true
+  is_root: true
+  key: www
+  txt: abcd1234
+  last_checked_status: unknown
+  last_checked_at: 2020-02-03T23:45:56+00
+status: running
+application:
+  name: app-name
+  status: being_created
+  parameters: {}
+certificates:
+- href: example.com
+  id: cert-id
+  pending: true
+https_strategy: redirect_HTTP_to_HTTPS

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

@@ -0,0 +1,18 @@
+---
+- created_at: 2020-01-02T12:34:56+00
+  fqdn: vh.example.com
+  is_a_test_vhost: false
+  linked_dns_zone:
+    allow_alteration: true
+    last_checked_status: unknown
+    last_checked_at: 2020-02-03T23:45:56+00
+  status: running
+  application:
+    name: app-name
+    status: being_created
+    parameters: {}
+  certificates:
+  - href: example.com
+    id: cert-id
+    pending: true
+  https_strategy: redirect_HTTP_to_HTTPS

data/spec/units/gandi_v5/domain_spec.rb

@@ -45,7 +45,7 @@ describe GandiV5::Domain do
     end
 
     describe 'Passes optional query params' do
-      %i[fqdn sort_by tld].each do |param|
+      %i[fqdn sort_by tld resellee_id].each do |param|
         it param.to_s do
           expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { param => 5 })
           expect(described_class.list(param => 5)).to eq []

data/spec/units/gandi_v5/sharing_space_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::SharingSpace do
+end

data/spec/units/gandi_v5/simple_hosting/instance/application_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance::Application do
+  describe 'Helper methods' do
+    context 'being_created' do
+      subject { described_class.new status: :being_created }
+      its('being_created?') { should be true }
+      its('cancelled?') { should be false }
+      its('running?') { should be false }
+      its('error?') { should be false }
+    end
+
+    context 'cancelled' do
+      subject { described_class.new status: :cancelled }
+      its('being_created?') { should be false }
+      its('cancelled?') { should be true }
+      its('running?') { should be false }
+      its('error?') { should be false }
+    end
+
+    context 'running' do
+      subject { described_class.new status: :running }
+      its('being_created?') { should be false }
+      its('cancelled?') { should be false }
+      its('running?') { should be true }
+      its('error?') { should be false }
+    end
+
+    context 'error' do
+      subject { described_class.new status: :error }
+      its('being_created?') { should be false }
+      its('cancelled?') { should be false }
+      its('running?') { should be false }
+      its('error?') { should be true }
+    end
+  end
+end

data/spec/units/gandi_v5/simple_hosting/instance/database_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance::Database do
+end

data/spec/units/gandi_v5/simple_hosting/instance/language_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance::Language do
+end

data/spec/units/gandi_v5/simple_hosting/instance/upgrade_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance::Upgrade do
+end

data/spec/units/gandi_v5/simple_hosting/instance/virtual_host/linked_dns_zone_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance::VirtualHost::LinkedDnsZone do
+  describe 'Helper methods' do
+    context 'altered' do
+      subject { described_class.new status: :altered }
+      its('altered?') { should be true }
+      its('livedns_conflict?') { should be false }
+      its('livedns_done?') { should be false }
+      its('livedns_error?') { should be false }
+      its('unknown?') { should be false }
+    end
+
+    context 'altered' do
+      subject { described_class.new status: :livedns_conflict }
+      its('altered?') { should be false }
+      its('livedns_conflict?') { should be true }
+      its('livedns_done?') { should be false }
+      its('livedns_error?') { should be false }
+      its('unknown?') { should be false }
+    end
+
+    context 'livedns_done' do
+      subject { described_class.new status: :livedns_done }
+      its('altered?') { should be false }
+      its('livedns_conflict?') { should be false }
+      its('livedns_done?') { should be true }
+      its('livedns_error?') { should be false }
+      its('unknown?') { should be false }
+    end
+
+    context 'livedns_error' do
+      subject { described_class.new status: :livedns_error }
+      its('altered?') { should be false }
+      its('livedns_conflict?') { should be false }
+      its('livedns_done?') { should be false }
+      its('livedns_error?') { should be true }
+      its('unknown?') { should be false }
+    end
+
+    context 'unknown' do
+      subject { described_class.new status: :unknown }
+      its('altered?') { should be false }
+      its('livedns_conflict?') { should be false }
+      its('livedns_done?') { should be false }
+      its('livedns_error?') { should be false }
+      its('unknown?') { should be true }
+    end
+  end
+end

data/spec/units/gandi_v5/simple_hosting/instance/virtual_host_spec.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance::VirtualHost do
+  let :body_list do
+    YAML.load_file(
+      File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_SimpleHosting_Instance_VirtualHost', 'list.yml')
+      )
+    )
+  end
+  let :body_fetch do
+    YAML.load_file(
+      File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_SimpleHosting_Instance_VirtualHost', 'fetch.yml')
+      )
+    )
+  end
+
+  subject do
+    described_class.new instance_uuid: 'instance-uuid', fqdn: 'vh.example.com'
+  end
+
+  it '#refresh' do
+    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.refresh
+    expect(subject.linked_dns_zone.cname).to_not be nil
+  end
+
+  describe 'Helper methods' do
+    describe 'Status' do
+      context 'being_created' do
+        subject { described_class.new status: :being_created }
+        its('being_created?') { should be true }
+        its('running?') { should be false }
+        its('being_deleted?') { should be false }
+        its('locked?') { should be false }
+        its('waiting_ownership?') { should be false }
+        its('ownership_validated?') { should be false }
+        its('validation_failed?') { should be false }
+      end
+      context 'running' do
+        subject { described_class.new status: :running }
+        its('being_created?') { should be false }
+        its('running?') { should be true }
+        its('being_deleted?') { should be false }
+        its('locked?') { should be false }
+        its('waiting_ownership?') { should be false }
+        its('ownership_validated?') { should be false }
+        its('validation_failed?') { should be false }
+      end
+      context 'being_deleted' do
+        subject { described_class.new status: :being_deleted }
+        its('being_created?') { should be false }
+        its('running?') { should be false }
+        its('being_deleted?') { should be true }
+        its('locked?') { should be false }
+        its('waiting_ownership?') { should be false }
+        its('ownership_validated?') { should be false }
+        its('validation_failed?') { should be false }
+      end
+      context 'locked' do
+        subject { described_class.new status: :locked }
+        its('being_created?') { should be false }
+        its('running?') { should be false }
+        its('being_deleted?') { should be false }
+        its('locked?') { should be true }
+        its('waiting_ownership?') { should be false }
+        its('ownership_validated?') { should be false }
+        its('validation_failed?') { should be false }
+      end
+      context 'waiting_ownership' do
+        subject { described_class.new status: :waiting_ownership }
+        its('being_created?') { should be false }
+        its('running?') { should be false }
+        its('being_deleted?') { should be false }
+        its('locked?') { should be false }
+        its('waiting_ownership?') { should be true }
+        its('ownership_validated?') { should be false }
+        its('validation_failed?') { should be false }
+      end
+      context 'ownership_validated' do
+        subject { described_class.new status: :ownership_validated }
+        its('being_created?') { should be false }
+        its('running?') { should be false }
+        its('being_deleted?') { should be false }
+        its('locked?') { should be false }
+        its('waiting_ownership?') { should be false }
+        its('ownership_validated?') { should be true }
+        its('validation_failed?') { should be false }
+      end
+      context 'validation_failed' do
+        subject { described_class.new status: :validation_failed }
+        its('being_created?') { should be false }
+        its('running?') { should be false }
+        its('being_deleted?') { should be false }
+        its('locked?') { should be false }
+        its('waiting_ownership?') { should be false }
+        its('ownership_validated?') { should be false }
+        its('validation_failed?') { should be true }
+      end
+    end
+
+    describe 'HTTP(S)' do
+      context 'HTTP_only' do
+        subject { described_class.new https_strategy: :http_only }
+        its('http_only?') { should be true }
+        its('http_and_https?') { should be false }
+        its('redirect_http_to_https?') { should be false }
+        its('http?') { should be true }
+        its('https?') { should be false }
+      end
+      context 'HTTP_and_HTTPS' do
+        subject { described_class.new https_strategy: :http_and_https }
+        its('http_only?') { should be false }
+        its('http_and_https?') { should be true }
+        its('redirect_http_to_https?') { should be false }
+        its('http?') { should be true }
+        its('https?') { should be true }
+      end
+      context 'redirect_HTTP_to_HTTPS' do
+        subject { described_class.new https_strategy: :redirect_http_to_https }
+        its('http_only?') { should be false }
+        its('http_and_https?') { should be false }
+        its('redirect_http_to_https?') { should be true }
+        its('http?') { should be false }
+        its('https?') { should be false }
+      end
+    end
+  end
+
+  describe '.list' do
+    subject { described_class.list('instance-uuid') }
+    let(:url) { 'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/vhosts' }
+
+    describe 'With default parameters' do
+      before :each do
+        expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                  .and_yield(body_list)
+      end
+
+      its('count') { should eq 1 }
+      its('first.created_at') { should eq Time.new(2020, 1, 2, 12, 34, 56, 0) }
+      its('first.fqdn') { should eq 'vh.example.com' }
+      its('first.is_a_test_virtual_host') { should be false }
+      its('first.linked_dns_zone.allow_alteration') { should be true }
+      its('first.linked_dns_zone.status') { should eq :unknown }
+      its('first.linked_dns_zone.last_checked_at') { should eq Time.new(2020, 2, 3, 23, 45, 56, 0) }
+      its('first.status') { should eq :running }
+      its('first.application.name') { should eq 'app-name' }
+      its('first.application.status') { should eq :being_created }
+      its('first.application.parameters') { should eq({}) }
+      its('first.certificates') { should eq({ 'cert-id' => true }) }
+      its('first.https_strategy') { should eq :redirect_http_to_https }
+    end
+
+    describe 'Passes optional query params' do
+      %i[fqdn status sort_by].each do |param|
+        it param do
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { param => 'value' })
+                                                    .and_return([nil, []])
+          described_class.list('instance-uuid', param => 'value')
+        end
+      end
+    end
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'instance-uuid', 'vh.example.com' }
+
+    before :each do
+      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])
+    end
+
+    its('created_at') { should eq Time.new(2020, 1, 2, 12, 34, 56, 0) }
+    its('fqdn') { should eq 'vh.example.com' }
+    its('is_a_test_virtual_host') { should be false }
+    its('linked_dns_zone.allow_alteration') { should be true }
+    its('linked_dns_zone.cname') { should eq 'cn' }
+    its('linked_dns_zone.domain') { should eq 'example.com' }
+    its('linked_dns_zone.ipv4') { should eq '1.2.3.4' }
+    its('linked_dns_zone.ipv6') { should eq '1:2::3:4' }
+    its('linked_dns_zone.is_alterable') { should be true }
+    its('linked_dns_zone.is_root') { should be true }
+    its('linked_dns_zone.key') { should eq 'www' }
+    its('linked_dns_zone.txt') { should eq 'abcd1234' }
+    its('linked_dns_zone.status') { should eq :unknown }
+    its('linked_dns_zone.last_checked_at') { should eq Time.new(2020, 2, 3, 23, 45, 56, 0) }
+    its('status') { should eq :running }
+    its('application.name') { should eq 'app-name' }
+    its('application.status') { should eq :being_created }
+    its('application.parameters') { should eq({}) }
+    its('certificates') { should eq({ 'cert-id' => true }) }
+    its('https_strategy') { should eq :redirect_http_to_https }
+  end
+end

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

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting::Instance do
+  let :body_list do
+    YAML.load_file(
+      File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_SimpleHosting_Instance', 'list.yml')
+      )
+    )
+  end
+  let :body_fetch do
+    YAML.load_file(
+      File.expand_path(
+        File.join('spec', 'fixtures', 'bodies', 'GandiV5_SimpleHosting_Instance', 'fetch.yml')
+      )
+    )
+  end
+
+  subject do
+    described_class.new uuid: 'instance-uuid'
+  end
+
+  describe 'Actions' do
+    let(:url) { 'https://api.gandi.net/v5/simplehosting/instances/instance-uuid/action' }
+
+    %i[restart console reset_database_password].each do |action|
+      it ".#{action}" do
+        expect(GandiV5).to receive(:post).with(url, "{\"action\":\"#{action}\"}")
+                                         .and_return([nil, 'Confirmation message'])
+        expect(subject.send(action)).to eq 'Confirmation message'
+      end
+    end
+  end
+
+  it '#refresh' do
+    expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/simplehosting/instances/instance-uuid')
+                                    .and_return([nil, body_fetch])
+    subject.refresh
+    expect(subject.access_information).to_not be nil
+  end
+
+  describe 'Helper methods' do
+    describe 'Status' do
+      context 'waiting_bill' do
+        subject { described_class.new status: :waiting_bill }
+        its('waiting_bill?') { should be true }
+        its('being_created?') { should be false }
+        its('active?') { should be false }
+        its('paused?') { should be false }
+        its('locked?') { should be false }
+        its('being_deleted?') { should be false }
+      end
+      context 'being_created' do
+        subject { described_class.new status: :being_created }
+        its('waiting_bill?') { should be false }
+        its('being_created?') { should be true }
+        its('active?') { should be false }
+        its('paused?') { should be false }
+        its('locked?') { should be false }
+        its('being_deleted?') { should be false }
+      end
+      context 'active' do
+        subject { described_class.new status: :active }
+        its('waiting_bill?') { should be false }
+        its('being_created?') { should be false }
+        its('active?') { should be true }
+        its('paused?') { should be false }
+        its('locked?') { should be false }
+        its('being_deleted?') { should be false }
+      end
+      context 'paused' do
+        subject { described_class.new status: :paused }
+        its('waiting_bill?') { should be false }
+        its('being_created?') { should be false }
+        its('active?') { should be false }
+        its('paused?') { should be true }
+        its('locked?') { should be false }
+        its('being_deleted?') { should be false }
+      end
+      context 'locked' do
+        subject { described_class.new status: :locked }
+        its('waiting_bill?') { should be false }
+        its('being_created?') { should be false }
+        its('active?') { should be false }
+        its('paused?') { should be false }
+        its('locked?') { should be true }
+        its('being_deleted?') { should be false }
+      end
+      context 'being_deleted' do
+        subject { described_class.new status: :being_deleted }
+        its('waiting_bill?') { should be false }
+        its('being_created?') { should be false }
+        its('active?') { should be false }
+        its('paused?') { should be false }
+        its('locked?') { should be false }
+        its('being_deleted?') { should be true }
+      end
+    end
+  end
+
+  describe '.list' do
+    subject { described_class.list }
+    let(:url) { 'https://api.gandi.net/v5/simplehosting/instances' }
+
+    describe 'With default parameters' do
+      before :each do
+        expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: {})
+                                                  .and_yield(body_list)
+      end
+
+      its('count') { should eq 1 }
+      its('first.created_at') { should eq Time.new(2020, 1, 2, 12, 34, 56) }
+      its('first.database.name') { should eq 'database name' }
+      its('first.database.status') { should eq 'database status' }
+      its('first.database.version') { should eq 'database version' }
+      its('first.data_center') { should eq 'FR-SD5' }
+      its('first.expire_at') { should eq Time.new(2021, 1, 2, 12, 34, 56) }
+      its('first.uuid') { should eq 'instance-uuid' }
+      its('first.language.name') { should eq 'ruby' }
+      its('first.language.single_application') { should be true }
+      its('first.language.status') { should eq 'great' }
+      its('first.language.version') { should eq '2.7' }
+      its('first.name') { should eq 'instance name' }
+      its('first.sharing_space.uuid') { should eq 'sharing-space-uuid' }
+      its('first.sharing_space.name') { should eq 'sharing space name' }
+      its('first.size') { should eq 's+' }
+      its('first.snapshot_enabled') { should be true }
+      its('first.status') { should eq 'active' }
+      its('first.storage') { should eq({ base: '20 GB', additional: '10 GB', total: '30 GB' }) }
+      its('first.auto_renew') { should eq '1 m' }
+    end
+
+    describe 'Passes optional query params' do
+      %i[sharing_id name fqdn size status sort_by].each do |param|
+        it param do
+          expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100, params: { param => 'value' })
+                                                    .and_return([nil, []])
+          described_class.list(param => 'value')
+        end
+      end
+    end
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'instance-uuid' }
+
+    before :each do
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/simplehosting/instances/instance-uuid')
+                                      .and_return([nil, body_fetch])
+    end
+
+    its('access_information') { should be_a Hash }
+    its('created_at') { should eq Time.new(2020, 1, 2, 12, 34, 56, 0) }
+    its('database.name') { should eq 'database name' }
+    its('database.status') { should eq 'database status' }
+    its('database.version') { should eq 'database version' }
+    its('data_center') { should eq 'FR-SD5' }
+    its('expire_at') { should eq Time.new(2021, 1, 2, 12, 34, 56, 0) }
+    its('uuid') { should eq 'instance-uuid' }
+    its('is_trial') { should be false }
+    its('language.name') { should eq 'ruby' }
+    its('language.single_application') { should be true }
+    its('language.status') { should eq 'great' }
+    its('language.version') { should eq '2.7' }
+    its('name') { should eq 'instance name' }
+    its('sharing_space.uuid') { should eq 'sharing-space-uuid' }
+    its('sharing_space.name') { should eq 'sharing space name' }
+    its('size') { should eq 's+' }
+    its('snapshot_enabled') { should be true }
+    its('status') { should eq 'active' }
+    its('storage') { should eq({ base: '20 GB', additional: '10 GB', total: '30 GB' }) }
+    its('virtual_hosts.first.fqdn') { should eq 'vhost1.example.com' }
+    its('auto_renew') { should eq '1 m' }
+    its('compatible_applications.first.name') { should eq 'compatable name' }
+    its('compatible_applications.first.parameters') { should be_a Hash }
+    its('password_updated_at') { should eq Time.new(2020, 6, 2, 12, 34, 56, 0) }
+    its('upgrade_to.first.name') { should eq 'upgrade to name' }
+    its('upgrade_to.first.status') { should eq 'upgrade to status' }
+    its('upgrade_to.first.type') { should eq 'database' }
+    its('upgrade_to.first.version') { should eq 'upgrade to version' }
+  end
+end