gandi_v5 0.8.0 → 0.9.0

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

@@ -4,6 +4,7 @@ class GandiV5
   class SimpleHosting
     class Instance
       class VirtualHost
+        # A DNS Zone linked to a virtual host on a simple hosting instance.
         # @!attribute [r] allow_zone_alteration
         #   @return [Boolean]
         # @!attribute [r] cname

data/lib/gandi_v5/version.rb

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

data/spec/features/list_domain_renewals_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe 'Examples', :vcr do
+  it 'List domain renewals' do
+    expect(STDOUT).to receive(:puts).with("2021-03-12\t£8.87\texample.com")
+
+    # For each domain (sorted by assending renewal date) print <date>\t<cost>\t<fqdn>
+    GandiV5::Domain.list.each do |domain|
+      puts [
+        domain.dates.registry_ends_at.to_date,
+        "£#{domain.renewal_price.price_after_taxes}",
+        domain.fqdn
+      ].join("\t")
+    end
+  end
+end

data/spec/features/list_email_addresses_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe 'Examples', :vcr do
+  it 'List email addresses' do
+    expect(STDOUT).to receive(:puts).with("alias@example.com\talias for user@example.com").ordered
+    expect(STDOUT).to receive(:puts).with("forward@example.com\tforwards to user@example.com").ordered
+    expect(STDOUT).to receive(:puts).with("user@example.com\tstandard mailbox (0% of 3GB used)").ordered
+
+    # For each domain:
+    #   1. Create an empty hash to store address => description
+    #   2. Get the mailboxes and add them to the hash
+    #   3. Get the forwards and add them to the hash
+    #   4. Sort the hash by email address
+    #   5. Print the list
+    GandiV5::Domain.list.each do |domain|
+      emails = {}
+
+      mailboxes = GandiV5::Email::Mailbox.list(domain.fqdn)
+      mailboxes.each do |mailbox|
+        mailbox.refresh
+        emails["#{mailbox.login}@#{domain.fqdn}"] = "#{mailbox.type} mailbox " \
+                                             "(#{mailbox.quota_usage.to_i}% " \
+                                             "of #{(mailbox.quota / 1024**3).round}GB used)"
+        mailbox.aliases.each do |alias_name|
+          emails["#{alias_name}@#{domain.fqdn}"] = "alias for #{mailbox.login}@#{domain.fqdn}"
+        end
+      end
+
+      forwards = GandiV5::Email::Forward.list(domain.fqdn)
+      forwards.each do |forward|
+        emails["#{forward.source}@#{domain.fqdn}"] = "forwards to #{forward.destinations.join(', ')}"
+      end
+
+      emails.sort.each do |address, text|
+        puts "#{address}\t#{text}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+---
+created_at: '2011-02-21T10:39:00Z'
+owner_contact: owner contact
+params:
+  domain: example.com
+  duration: 1
+  reseller: reseller-uuid
+  tld: com
+  version: 0
+step: step text
+step_nb: 2
+updated_at: '2011-02-22T10:39:00Z'
+errortype: error-type
+errortype_label: error label
+foa:
+- answer: ans
+  email: user@example.com
+inner_step: inner-step
+regac_at: '2011-02-23T10:39:00Z'
+start_at: '2011-02-24T10:39:00Z'
+transfer_procedure: transfer-procedure

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

@@ -0,0 +1,10 @@
+---
+available: true
+fqdn: example.com
+fqdn_ulabel: EXAMPLE.COM
+corporate: false
+internal: false
+durations: [1, 2, 3]
+minimum_duration: 1
+maximum_duration: 3
+msg: This is a message

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/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