gandi_v5 0.3.0 → 0.8.0

data/lib/gandi_v5/simple_hosting/instance/virtual_host/linked_dns_zone.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      class VirtualHost
+        # @!attribute [r] allow_zone_alteration
+        #   @return [Boolean]
+        # @!attribute [r] cname
+        #   @return [String]
+        # @!attribute [r] domain
+        #   @return [String]
+        # @!attribute [r] ipv4
+        #   @return [String]
+        # @!attribute [r] ipv6
+        #   @return [String]
+        # @!attribute [r] is_alterable
+        #   @return [Boolean]
+        # @!attribute [r] is_root
+        #   @return [Boolean]
+        # @!attribute [r] key
+        #   @return [String]
+        # @!attribute [r] txt
+        #   @return [String]
+        # @!attribute [r] last_checked_at
+        #   @return [Time]
+        # @!attribute [r] status
+        #   @return [Symbol] :altered, :livedns_conflict, :livedns_done, :livedns_error, :unknown
+        class LinkedDnsZone
+          include GandiV5::Data
+
+          members :allow_alteration, :is_alterable, :last_checked_at,
+                  :cname, :domain, :is_root, :ipv4, :ipv6, :key, :txt
+
+          member(
+            :status,
+            gandi_key: 'last_checked_status',
+            converter: GandiV5::Data::Converter::Symbol
+          )
+
+          # Check if the linked zone is currently in an altered state
+          # @return [Boolean]
+          def altered?
+            status == :altered
+          end
+
+          # Check if the linked zone is currently in a conflicted state
+          # @return [Boolean]
+          def livedns_conflict?
+            status == :livedns_conflict
+          end
+
+          # Check if the linked zone has been updated
+          # @return [Boolean]
+          def livedns_done?
+            status == :livedns_done
+          end
+
+          # Check if the linked zone had an error updating
+          # @return [Boolean]
+          def livedns_error?
+            status == :livedns_error
+          end
+
+          # Check if the linked zone is in an unknown state
+          # @return [Boolean]
+          def unknown?
+            status == :unknown
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GandiV5
-  VERSION = '0.3.0'
+  VERSION = '0.8.0'
 end

data/spec/.rubocop.yml

@@ -1,4 +1,58 @@
+require:
+- rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.6.0
+Layout/EmptyLinesAroundAttributeAccessor:
+ Enabled: true
+Layout/LineLength:
+  Max: 125
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/BlockLength:
   Max: 750
-Metrics/LineLength:
-  Max: 125
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

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

@@ -35,3 +35,11 @@ contacts:
 services:
 - gandilivedns
 - dnssec
+sharing_space:
+  id: SHARING-UUID
+  name: User
+  type: user
+  reseller: true
+  sharing_space:
+    id: RESELLER-UUID
+    name: Reseller

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

@@ -1,4 +1,3 @@
 ---
-  zonedata: /zones/zone-uuid/recprds
   fqdn: example.com
-  zone: /zones/zone-uuid
+  automatic_snapshots: true

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml

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

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml

@@ -0,0 +1,3 @@
+---
+- a.example.com
+- b.example.com

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

@@ -0,0 +1,12 @@
+---
+id: key-uuid
+status: status
+fqdn: example.com
+algorithm: 2
+algorithm_name: Diffie-Hellman
+deleted: false
+ds: ds-record
+flags: 256
+fingerprint: fp
+public_key: pub-key
+tag: tag

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

@@ -0,0 +1,9 @@
+---
+- id: key-uuid
+  status: status
+  fqdn: example.com
+  algorithm: 2
+  algorithm_name: Diffie-Hellman
+  deleted: false
+  ds: ds-record
+  flags: 256

data/spec/fixtures/bodies/{GandiV5_LiveDNS_Zone_Snapshot → GandiV5_LiveDNS_Domain_Snapshot}/fetch.yml

@@ -1,7 +1,8 @@
 ---
-date_created: '2016-12-16T16:51:26Z'
-uuid: snapshot-uuid
-zone_uuid: zone-uuid
+created_at: '2016-12-16T16:51:26Z'
+id: snapshot-uuid
+name: snapshot-name
+automatic: true
 zone_data:
 - rrset_type: A
   rrset_ttl: 10800

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

@@ -0,0 +1,5 @@
+---
+- id: snapshot-uuid
+  name: snapshot-name
+  automatic: true
+  created_at: '2016-12-16T16:51:26Z'

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

@@ -0,0 +1,9 @@
+---
+id: key-uuid
+key_name: key-name
+secret: key-secret
+config_samples:
+  bind: bind-sample
+  knot: knot-sample
+  nsd: nsd-sample
+  powerdns: powerdns-sample

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/fixtures/bodies/GandiV5_Organization_Customer/list.yml

@@ -0,0 +1,8 @@
+---
+- id: customer-uuid
+  name: FirstLast
+  firstname: First
+  lastname: Last
+  email: first.last@example.com
+  type: individual
+  orgname: Org

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

@@ -0,0 +1,80 @@
+---
+access_information:
+  admin_url: admin.example.com/
+  database:
+    admins:
+    - type: phpMyAdmin
+      url: admin.example.com/phpmyadmin
+      username: database admin username
+    host: database.example.com
+    port: 1234
+    socket: /socket/for/database
+  deploy:
+  - cli:
+      init: cli init string
+    git:
+      deploy: git deploy string
+      remote: git remote string
+      url: git url string
+    sftp:
+      directory: sftp directory
+      document_root: sftp document root
+      server: sftp server
+      url: sftp url
+    vhost:
+      fqdn: example.com
+      href: link/to/href/details/virtualhost-uuid
+  user: A user
+available_upgrade: false
+console:
+  enabled: true
+  url: console.example.com/
+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
+is_trial: false
+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
+vhosts:
+  - fqdn: vhost1.example.com
+    href: link/to.vhost/details
+autorenew:
+  duration: 1
+  duration_type: m
+compatible_applications:
+- name: compatable name
+  parameters: {}
+password_updated_at: 2020-06-02T12:34:56+00
+upgrade_to:
+- name: upgrade to name
+  status: upgrade to status
+  type: database
+  version: upgrade to version

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/data/converter/integer_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe GandiV5::Data::Converter::Integer do
+  it '.from_gandi' do
+    expect(described_class.from_gandi('123')).to eq 123
+  end
+
+  it '.to_gandi' do
+    expect(described_class.to_gandi(123)).to eq '123'
+  end
+
+  it 'nil value' do
+    expect(described_class.from_gandi(nil)).to be nil
+    expect(described_class.to_gandi(nil)).to be nil
+  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
@@ -108,7 +77,12 @@ describe GandiV5::Domain do
     its('domain_owner') { should be_nil }
     its('name_servers') { should match_array %w[192.168.0.1 192.168.0.2] }
     its('services') { should match_array %i[gandilivedns dnssec] }
-    its('sharing_space') { should be_nil }
+    its('sharing_space.uuid') { should eq 'SHARING-UUID' }
+    its('sharing_space.name') { should eq 'User' }
+    its('sharing_space.type') { should eq 'user' }
+    its('sharing_space.reseller') { should be true }
+    its('sharing_space.reseller_details.uuid') { should eq 'RESELLER-UUID' }
+    its('sharing_space.reseller_details.name') { should eq 'Reseller' }
     its('dates.created_at') { should eq Time.new(2011, 2, 21, 10, 39, 0) }
     its('dates.registry_created_at') { should eq Time.new(2003, 3, 12, 12, 2, 11) }
     its('dates.registry_ends_at') { should eq Time.new(2020, 3, 12, 12, 2, 11) }
@@ -268,7 +242,7 @@ describe GandiV5::Domain do
     its('domain_owner') { should be_nil }
     its('name_servers') { should match_array %w[192.168.0.1 192.168.0.2] }
     its('services') { should match_array %i[gandilivedns dnssec] }
-    its('sharing_space') { should be_nil }
+    its('sharing_space') { should_not be_nil }
     its('dates.created_at') { should eq Time.new(2011, 2, 21, 10, 39, 0) }
     its('dates.registry_created_at') { should eq Time.new(2003, 3, 12, 12, 2, 11) }
     its('dates.registry_ends_at') { should eq Time.new(2020, 3, 12, 12, 2, 11) }
@@ -373,10 +347,46 @@ describe GandiV5::Domain do
       its('durations') { should match_array [1, 2] }
     end
 
-    it '#renew_for' do
-      expect(GandiV5).to receive(:post).with('https://api.gandi.net/v5/domain/domains/example.com/renew', '{"duration":2}')
-                                       .and_return([nil, { 'message' => 'Confirmation message.' }])
-      expect(subject.renew_for(2)).to eq 'Confirmation message.'
+    describe '#renew_for' do
+      it 'Defaults to 1 year and current user' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew',
+          '{"duration":1}',
+          'Dry-Run': 0
+        )
+                                         .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.renew_for).to eq 'Confirmation message.'
+      end
+
+      it 'With provided duration' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew',
+          '{"duration":2}',
+          'Dry-Run': 0
+        )
+                                         .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.renew_for(2)).to eq 'Confirmation message.'
+      end
+
+      it 'With provided sharing_id' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew?sharing_id=def',
+          '{"duration":1}',
+          'Dry-Run': 0
+        )
+                                         .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.renew_for(sharing_id: 'def')).to eq 'Confirmation message.'
+      end
+
+      it 'Does a dry run' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew',
+          '{"duration":1}',
+          'Dry-Run': 1
+        )
+                                         .and_return([nil, { 'status' => 'success' }])
+        expect(subject.renew_for(dry_run: true)).to eq('status' => 'success')
+      end
     end
 
     describe '#renewal_price' do