gandi_v5 0.6.0 → 0.10.0

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/fixtures/bodies/GandiV5_Template/fetch.yml

@@ -0,0 +1,41 @@
+---
+description: description of template
+editable: true
+href: https://api.gandi.net/v5/template/templates/template-uuid
+id: template-uuid
+name: template name
+namespaces:
+- dns:record
+- domain:mailboxes
+- domain:nameservers
+- domain:webredirs
+orgname: org-name
+sharing_space:
+  id: sharing-space-uuid
+  name: sharing-space-name
+  reseller: true
+  type: user
+  sharing_space:
+    id: reseller-uuid
+    name: reseller-name
+variables: []
+payload:
+  'dns:records':
+    records:
+    - name: record-name
+      type: TXT
+      values: ['record-value']
+      ttl: 600
+  'domain:mailboxes':
+    values:
+    - login: user-name
+  'domain:nameservers':
+    addresses: ['1.1.1.1']
+    service: custom
+  'domain:webredirs':
+    values:
+    - type: http301
+      url: https://example.com/here
+      host: here.example.com
+      override: true
+      protocol: https

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

@@ -0,0 +1,20 @@
+---
+- description: description of template
+  editable: true
+  href: https://api.gandi.net/v5/template/templates/template-uuid
+  id: template-uuid
+  name: template name
+  namespaces:
+  - dns:record
+  - domain:mailboxes
+  - domain:nameservers
+  - domain:webredirs
+  orgname: org-name
+  sharing_space:
+    id: sharing-space-uuid
+    name: sharing-space-name
+    reseller: true
+    type: user
+    sharing_space:
+      id: reseller-uuid
+      name: reseller-name

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

@@ -0,0 +1,49 @@
+---
+attempt: 1
+created_at: '2020-11-29T14:57:14Z'
+id: dispatch-uuid
+sharing_id: sharing-uuid
+state: 10
+state_msg: state message
+task_updated_at: '2020-11-29T14:57:15Z'
+template_id: template-uuid
+template_name: template
+target:
+  name: domain-api-test1.net
+  type: domain
+target_id: target-uuid
+task_history:
+- namespace: 'domain:nameservers'
+  date: '2020-11-29T16:57:47Z'
+  status: 20
+  message: ''
+task_status:
+  'dns:records':
+    status: 0
+  'domain:mailboxes':
+    status: 10
+  'domain:nameservers':
+    status: 20
+  'domain:webredirs':
+    status: 30
+payload:
+  'dns:records':
+    default: false
+    records:
+    - name: record-name
+      type: TXT
+      values: ['record-value']
+      ttl: 600
+  'domain:mailboxes':
+    values:
+    - login: user-name
+  'domain:nameservers':
+    addresses: ['1.1.1.1']
+    service: custom
+  'domain:webredirs':
+    values:
+    - type: http301
+      url: https://example.com/here
+      host: here.example.com
+      override: true
+      protocol: https

data/spec/fixtures/vcr/Examples/List_domain_renewals.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/domain/domains?page=1&per_page=100
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '461'
+    body:
+      encoding: UTF-8
+      string: '[{"status":[],"dates":{"created_at":"2011-02-21T10:39:00Z","registry_created_at":"2003-03-12T12:02:11Z","registry_ends_at":"2021-03-12T12:02:11Z","updated_at":"2020-03-25T17:06:34Z"},"tags":[],"fqdn":"example.com","id":"domain-uuid","autorenew":false,"tld":"com","owner":"Mr. Example","orga_owner":"Example Org","domain_owner":"Owner","nameserver":{"current":"livedns"},"href":"https://api.gandi.net/v5/domain/domains/example.com","fqdn_unicode":"example.com"}]'
+  recorded_at: Mon, 17 Aug 2020 16:02:51 GMT
+
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/domain/check?currency=GBP&name=example.com&period=1&processes%5B%5D=renew
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abcde12345
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '353'
+    body:
+      encoding: UTF-8
+      string: '{"currency":"GBP","products":[{"name":"example.com","taxes":[{"rate":20,"name":"vat","type":"service"}],"process":"renew","prices":[{"min_duration":1,"discount":false,"price_after_taxes":8.87,"max_duration":9,"price_before_taxes":7.39,"duration_unit":"y"}],"status":"unavailable"}],"grid":"A","taxes":[{"rate":20,"name":"vat","type":"service"}]}'
+    http_version: 
+  recorded_at: Mon, 17 Aug 2020 16:53:54 GMT
+
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/Examples/List_email_addresses.yml

@@ -0,0 +1,103 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/domain/domains?page=1&per_page=100
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '461'
+    body:
+      encoding: UTF-8
+      string: '[{"status":[],"dates":{"created_at":"2011-02-21T10:39:00Z","registry_created_at":"2003-03-12T12:02:11Z","registry_ends_at":"2021-03-12T12:02:11Z","updated_at":"2020-03-25T17:06:34Z"},"tags":[],"fqdn":"example.com","id":"domain-uuid","autorenew":false,"tld":"com","owner":"Mr. Example","orga_owner":"Example Org","domain_owner":"Owner","nameserver":{"current":"livedns"},"href":"https://api.gandi.net/v5/domain/domains/example.com","fqdn_unicode":"example.com"}]'
+  recorded_at: Mon, 17 Aug 2020 16:02:51 GMT
+
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/email/mailboxes/example.com?page=1&per_page=100
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '284'
+    body:
+      encoding: UTF-8
+      string: '[{"responder":{"message":"","enabled":false},"mailbox_type":"standard","login":"user","quota_used":3597,"domain":"example.com","aliases":["alias"],"address":"user@example.com","href":"https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid","id":"mailbox-uuid"}]'
+  recorded_at: Mon, 17 Aug 2020 16:02:51 GMT
+
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '270'
+    body:
+      encoding: UTF-8
+      string: '{"responder":{"message":"","enabled":false},"mailbox_type":"standard","login":"user","quota_used":3597,"domain":"example.com","aliases":["alias"],"address":"user@example.com","href":"https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid","id":"mailbox-uuid"}'
+  recorded_at: Mon, 17 Aug 2020 16:17:50 GMT
+
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/email/forwards/example.com?page=1&per_page=100
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '127'
+    body:
+      encoding: UTF-8
+      string: '[{"destinations":["user@example.com"],"source":"forward","href":"https://api.gandi.net/v5/email/forwards/example.com/forward"}]'
+  recorded_at: Mon, 17 Aug 2020 16:02:52 GMT
+
+recorded_with: VCR 4.0.0

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'dotenv'
-require 'coveralls'
 require 'rspec/its'
 require 'simplecov'
+require 'simplecov-lcov'
 require 'timecop'
 require 'vcr'
 require 'webmock/rspec'
@@ -13,14 +13,15 @@ allow_http_connections_to = %w[localhost 127.0.0.1]
 
 Dotenv.load File.join(__dir__, 'test.env')
 
-SimpleCov.coverage_dir(File.join('tmp', 'coverage')) unless ENV.key?('TRAVIS')
+if ENV.key?('GITHUB_ACTIONS')
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+else
+  SimpleCov.coverage_dir File.join('tmp', 'coverage')
+end
 SimpleCov.start do
   add_filter 'spec/'
-end
-
-if ENV.key?('TRAVIS')
-  Coveralls.wear!
-  allow_http_connections_to.push 'coveralls.io'
+  add_filter '.github/'
 end
 
 RSpec.configure do |config|

data/spec/units/gandi_v5/domain/transfer_in/availability_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::TransferIn::Availability do
+  describe '.fetch' do
+    let(:body_fixture) do
+      File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_TransferIn_Availability', 'fetch.yml'))
+    end
+
+    describe 'Without auth_code' do
+      subject { described_class.fetch 'example.com' }
+
+      before(:each) do
+        url = 'https://api.gandi.net/v5/domain/transferin/example.com/available'
+        expect(GandiV5).to receive(:post).with(url, {})
+                                         .and_return([nil, YAML.load_file(body_fixture)])
+      end
+
+      its('available') { should be true }
+      its('fqdn') { should eq 'example.com' }
+      its('fqdn_unicode') { should eq 'EXAMPLE.COM' }
+      its('corporate') { should be false }
+      its('internal') { should be false }
+      its('durations') { should eq [1, 2, 3] }
+      its('minimum_duration') { should eq 1 }
+      its('maximum_duration') { should eq 3 }
+      its('message') { should eq 'This is a message' }
+    end
+
+    describe 'With auth_code' do
+      subject { described_class.fetch 'example.com', 'auth-code' }
+
+      before(:each) do
+        url = 'https://api.gandi.net/v5/domain/transferin/example.com/available'
+        expect(GandiV5).to receive(:post).with(url, { 'authinfo' => 'auth-code' })
+                                         .and_return([nil, YAML.load_file(body_fixture)])
+      end
+
+      its('available') { should be true }
+      its('fqdn') { should eq 'example.com' }
+      its('fqdn_unicode') { should eq 'EXAMPLE.COM' }
+      its('corporate') { should be false }
+      its('internal') { should be false }
+      its('durations') { should eq [1, 2, 3] }
+      its('minimum_duration') { should eq 1 }
+      its('maximum_duration') { should eq 3 }
+      its('message') { should eq 'This is a message' }
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::TransferIn do
+  subject { described_class.new fqdn: 'example.com' }
+
+  describe '.fetch' do
+    subject { described_class.fetch 'example.com' }
+
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_TransferIn', 'fetch.yml'))
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/transferin/example.com')
+                                      .and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('fqdn') { should eq 'example.com' }
+    its('created_at') { should eq Time.new(2011, 2, 21, 10, 39, 0, 0) }
+    its('owner_contact') { should eq 'owner contact' }
+    its('duration') { should eq 1 }
+    its('reseller_uuid') { should eq 'reseller-uuid' }
+    its('version') { should eq 0 }
+    its('step') { should eq 'step text' }
+    its('step_number') { should eq 2 }
+    its('updated_at') { should eq Time.new(2011, 2, 22, 10, 39, 0, 0) }
+    its('errortype') { should eq 'error-type' }
+    its('errortype_label') { should eq 'error label' }
+    its('inner_step') { should eq 'inner-step' }
+    its('regac_at') { should eq Time.new(2011, 2, 23, 10, 39, 0, 0) }
+    its('start_at') { should eq Time.new(2011, 2, 24, 10, 39, 0, 0) }
+    its('transfer_procedure') { should eq 'transfer-procedure' }
+    its('foa_status') { should eq({ 'user@example.com' => 'ans' }) }
+  end
+
+  describe '.create' do
+    let(:url) { 'https://api.gandi.net/v5/domain/transferin' }
+
+    describe 'Sets dry-run header' do
+      let(:body) { '{"owner":{},"fqdn":"example.com"}' }
+
+      it 'False by default' do
+        expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0).and_return([nil, { 'message' => 'confirmation' }])
+        described_class.create 'example.com', owner: {}
+      end
+
+      it 'True' do
+        expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 1).and_return([nil, nil])
+        described_class.create 'example.com', owner: {}, dry_run: true
+      end
+
+      it 'False' do
+        expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0).and_return([nil, { 'message' => 'confirmation' }])
+        described_class.create 'example.com', owner: {}, dry_run: false
+      end
+
+      it 'Dry run was successful' do
+        returns = { 'status' => 'success' }
+        expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 1)
+                                         .and_return([nil, returns])
+        expect(described_class.create('example.com', owner: {}, dry_run: true)).to be returns
+      end
+
+      it 'Dry run has errors' do
+        returns = {
+          'status' => 'error',
+          'errors' => [{ 'description' => 'd', 'location' => 'l', 'name' => 'n' }]
+        }
+        expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 1)
+                                         .and_return([nil, returns])
+        expect(described_class.create('example.com', owner: {}, dry_run: true)).to be returns
+      end
+    end
+
+    describe 'Sets sharing_id' do
+      it 'Absent by default' do
+        expect(GandiV5).to receive(:post).with(url, any_args).and_return([nil, { 'message' => 'confirmation' }])
+        described_class.create('example.com', owner: {})
+      end
+
+      it 'Paying as another organization' do
+        expect(GandiV5).to receive(:post).with("#{url}?sharing_id=organization_id", any_args)
+                                         .and_return([nil, { 'message' => 'confirmation' }])
+        described_class.create('example.com', sharing_id: 'organization_id', owner: {})
+      end
+
+      it 'Buy as a reseller' do
+        expect(GandiV5).to receive(:post).with("#{url}?sharing_id=reseller_id", any_args)
+                                         .and_return([nil, { 'message' => 'confirmation' }])
+        described_class.create('example.com', sharing_id: 'reseller_id', owner: {})
+      end
+    end
+
+    it 'Success' do
+      body = '{"owner":{},"fqdn":"example.com"}'
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
+                                       .and_return([nil, { 'message' => 'confirmation' }])
+      expect(described_class.create('example.com', owner: {})).to eq 'confirmation'
+    end
+
+    it 'Errors on missing owner' do
+      expect { described_class.create 'example.com' }.to raise_error ArgumentError, 'missing keyword: owner'
+    end
+
+    it 'Given contact as hash' do
+      body = '{"owner":{"email":"owner@example.com"},"fqdn":"example.com"}'
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
+                                       .and_return([nil, { 'message' => 'confirmation' }])
+      described_class.create 'example.com', owner: { email: 'owner@example.com' }
+    end
+
+    it 'Given contact as GandiV5::Domain::Contact' do
+      body = '{"owner":{"email":"owner@example.com"},"fqdn":"example.com"}'
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
+                                       .and_return([nil, { 'message' => 'confirmation' }])
+      owner = double GandiV5::Domain::Contact, to_gandi: { 'email' => 'owner@example.com' }
+      described_class.create 'example.com', owner: owner
+    end
+  end
+
+  it '.relaunch' do
+    expect(GandiV5).to receive(:put).with('https://api.gandi.net/v5/domain/transferin/example.com')
+                                    .and_return([nil, { 'message' => 'confirmation' }])
+    expect(described_class.relaunch('example.com')).to eq 'confirmation'
+  end
+
+  it '.resend_foa_emails' do
+    url = 'https://api.gandi.net/v5/domain/transferin/example.com/foa'
+    body = '{"email":"user@example.com"}'
+    expect(GandiV5).to receive(:post).with(url, body)
+                                     .and_return([nil, { 'message' => 'confirmation' }])
+    expect(described_class.resend_foa_emails('example.com', 'user@example.com')).to eq 'confirmation'
+  end
+
+  it '#relaunch' do
+    returned = double String
+    expect(described_class).to receive(:relaunch).with('example.com').and_return(returned)
+    expect(subject.relaunch).to be returned
+  end
+
+  it '#resend_foa_emails' do
+    returned = double String
+    expect(described_class).to receive(:resend_foa_emails).with('example.com', 'user@example.com').and_return(returned)
+    expect(subject.resend_foa_emails('user@example.com')).to be returned
+  end
+end