gandi_v5 0.1.0

data/spec/fixtures/vcr/Domain_features/Renew_domain.yml

@@ -0,0 +1,133 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/domain/domains/example.net
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "status": [
+            "clientTransferProhibited"
+          ],
+          "dates": {
+            "created_at": "2019-02-13T11:04:18Z",
+            "deletes_at": "2021-03-30T00:04:18Z",
+            "hold_begins_at": "2021-02-13T10:04:18Z",
+            "hold_ends_at": "2021-03-30T10:04:18Z",
+            "pending_delete_ends_at": "2021-05-04T10:04:18Z",
+            "registry_created_at": "2019-02-13T10:04:18Z",
+            "registry_ends_at": "2021-02-13T10:04:18Z",
+            "renew_begins_at": "2012-01-01T00:00:00Z",
+            "restore_ends_at": "2021-04-29T10:04:18Z",
+            "updated_at": "2019-02-25T16:20:49Z",
+            "authinfo_expires_at": "2020-02-25T16:20:49Z"
+          },
+          "can_tld_lock": true,
+          "tags": [],
+          "nameservers": [
+            "ns-25-a.gnadi.net",
+            "ns-113-b.gnadi.net",
+            "ns-58-c.gnadi.net"
+          ],
+          "contacts": {
+            "owner": {
+              "city": "Paris",
+              "given": "Alice",
+              "reachability": "pending",
+              "family": "Doe",
+              "zip": "75001",
+              "extra_parameters": {
+                "birth_date": "",
+                "birth_department": "",
+                "birth_city": "",
+                "birth_country": ""
+              },
+              "country": "FR",
+              "streetaddr": "5 rue neuve",
+              "data_obfuscated": true,
+              "mail_obfuscated": true,
+              "phone": "+33.123456789",
+              "state": "FR-J",
+              "validation": "none",
+              "type": 0,
+              "email": "alice@example.org"
+            }
+          },
+          "fqdn": "example.net",
+          "autorenew": {
+            "dates": [
+              "2021-01-13T09:04:18Z",
+              "2021-01-29T10:04:18Z",
+              "2021-02-12T10:04:18Z"
+            ],
+            "org_id": "fe0b931c-18c5-11e9-b9b5-00163ec4cb00",
+            "duration": 1,
+            "href": "http://api.test/v5/domain/domains/example.net/autorenew",
+            "enabled": false
+          },
+          "authinfo": "8vyhljvJg+",
+          "sharing_space": {
+            "id": "fe0b931c-18c5-11e9-b9b5-00163ec4cb00",
+            "name": "alice_doe"
+          },
+          "tld": "net",
+          "services": [
+            "gandilivedns",
+            "mailboxv2"
+          ],
+          "id": "ba1167be-2f76-11e9-9dfb-00163ec4cb00",
+          "trustee_roles": [],
+          "href": "http://api.test/v5/domain/domains/example.net",
+          "fqdn_unicode": "example.net"
+        }
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+
+- request:
+    method: post
+    uri: https://api.gandi.net/v5/domain/domains/example.net/renew
+    body:
+      encoding: US-ASCII
+      string: '{"duration":2}'
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "message":"Domain renewed."
+        }
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/LiveDNS_Domain_features/List_domains.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://dns.api.gandi.net/api/v5/domains
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          {"fqdn":"example.com"},
+          {"fqdn":"example.net"}
+        ]
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/LiveDNS_Zone_features/List_zones.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://dns.api.gandi.net/api/v5/zones
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      X-Api-Key:
+      - abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          {
+            "retry": 3600,
+            "uuid": "uuid-of-zone",
+            "minimum": 10800,
+            "refresh": 10800,
+            "expire": 604800,
+            "serial": 1432798405,
+            "user_uuid": "uuid-of-user",
+            "email": "hostmaster.gandi.net.",
+            "primary_ns": "a.dns.gandi.net.",
+            "name": "Zone Name"
+          }
+        ]
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/LiveDNS_Zone_features/Make_and_save_snapshot.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://dns.api.gandi.net/api/v5/zones/zone-uuid/snapshots
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      X-Api-Key:
+      - abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "message": "Zone Snapshot Created",
+          "uuid": "snapshot-uuid"
+        }
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+
+- request:
+    method: get
+    uri: https://dns.api.gandi.net/api/v5/zones/zone-uuid/snapshots/snapshot-uuid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - text/plain
+      X-Api-Key:
+      - abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+         "date_created": "2016-12-16T16:51:26Z",
+         "uuid": "snapshot-uuid",
+         "zone_uuid": "zone-uuid",
+         "zone_data": [
+          {
+           "rrset_type": "A",
+           "rrset_ttl": 10800,
+           "rrset_name": "www",
+           "rrset_values": ["10.0.1.42"]
+           }
+          ]
+        }
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/LiveDNS_Zone_features/Save_zone_to_file.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://dns.api.gandi.net/api/v5/zones/zone-uuid/records
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - text/plain
+      X-Api-Key:
+      - abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: "Contents of zone file.\n"
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/Mailbox_features/List_mailboxes.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.gandi.net/v5/email/mailboxes/example.net?page=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - Apikey abdce12345
+      Host:
+      - api.gandi.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |-
+        [
+          {
+            "domain": "example.net",
+            "login": "alice",
+            "address": "alice@example.net",
+            "id": "066743e5-96e4-4a1d-9195-8b8a700a8a79",
+            "mailbox_type": "standard",
+            "quota_used": 1200,
+            "href": "https://api.test/api/v5/email/example.net/066743e5-96e4-4a1d-9195-8b8a700a8a79"
+          }
+        ]
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+recorded_with: VCR 4.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'dotenv'
+require 'coveralls'
+require 'rspec/its'
+require 'simplecov'
+require 'timecop'
+require 'vcr'
+require 'webmock/rspec'
+require 'yaml'
+
+allow_http_connections_to = %w[localhost 127.0.0.1]
+
+Dotenv.load File.join(__dir__, 'test.env')
+
+SimpleCov.coverage_dir(File.join('tmp', 'coverage'))
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+if ENV['TRAVIS']
+  Coveralls.wear!
+  allow_http_connections_to.push 'coveralls.io'
+end
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec  do |configuration|
+    # Using the expect syntax is preferable to the should syntax in some cases.
+    # The problem here is that the :should syntax that RSpec uses can fail in
+    # the case of proxy objects, and objects that include the delegate module.
+    # Essentially it requires that we define methods on every object in the
+    # system. Not owning every object means that we cannot ensure this works in
+    # a consistent manner. The expect syntax gets around this problem by not
+    # relying on RSpec specific methods being defined on every object in the
+    # system.
+    # configuration.syntax = [:expect, :should]
+    configuration.syntax = :expect
+  end
+
+  config.before(:each) { Timecop.return }
+end
+
+VCR.configure do |config|
+  config.ignore_hosts(*allow_http_connections_to)
+  config.cassette_library_dir = File.join __dir__, 'fixtures', 'vcr'
+  config.hook_into :webmock
+  # config.default_cassette_options = { :record => :none }
+end
+VCR::RSpec::Metadata.configure!
+
+WebMock.disable_net_connect! allow: allow_http_connections_to
+
+require 'gandi_v5'

data/spec/test.env

@@ -0,0 +1 @@
+GANDI_API_KEY = 'abdce12345'

data/spec/units/gandi_v5/billing/info/prepaid_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+describe GandiV5::Billing::Info::Prepaid do
+  describe '#warning?' do
+    it 'No warning theshold set' do
+      prepaid_info = described_class.new amount: 10, warning_threshold: nil
+      expect(prepaid_info.warning?).to be nil
+    end
+
+    it 'More than warning theshold' do
+      prepaid_info = described_class.new amount: 10, warning_threshold: 5
+      expect(prepaid_info.warning?).to be false
+    end
+
+    it 'Less than warning theshold' do
+      prepaid_info = described_class.new amount: 10, warning_threshold: 20
+      expect(prepaid_info.warning?).to be true
+    end
+  end
+end

data/spec/units/gandi_v5/billing/info_spec.rb

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

data/spec/units/gandi_v5/billing_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+describe GandiV5::Billing do
+  describe '.info' do
+    subject { described_class.info }
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yaml'))
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/billing/info')
+                                      .and_return(YAML.load_file(body_fixture))
+    end
+
+    its('annual_balance') { should eq 123.45 }
+    its('grid') { should eq 'A' }
+    its('outstanding_amount') { should eq 0 }
+    its('prepaid_monthly_invoice') { should be_nil }
+    its('prepaid.amount') { should eq 1 }
+    its('prepaid.created_at') { should eq Time.new(2011, 2, 19, 11, 23, 25) }
+    its('prepaid.currency') { should eq 'GBP' }
+    its('prepaid.updated_at') { should eq Time.new(2019, 2, 23, 21, 47, 22) }
+    its('prepaid.warning_threshold') { should be_nil }
+  end
+
+  describe '.info (for a sharing_id)' do
+    subject { described_class.info('sharing-id') }
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yaml'))
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/billing/info/sharing-id')
+                                      .and_return(YAML.load_file(body_fixture))
+    end
+
+    its('annual_balance') { should eq 123.45 }
+    its('grid') { should eq 'A' }
+    its('outstanding_amount') { should eq 0 }
+    its('prepaid_monthly_invoice') { should be_nil }
+    its('prepaid.amount') { should eq 1 }
+    its('prepaid.created_at') { should eq Time.new(2011, 2, 19, 11, 23, 25) }
+    its('prepaid.currency') { should eq 'GBP' }
+    its('prepaid.updated_at') { should eq Time.new(2019, 2, 23, 21, 47, 22) }
+    its('prepaid.warning_threshold') { should be_nil }
+  end
+end

data/spec/units/gandi_v5/data/converter/array_of_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+describe GandiV5::Data::Converter::ArrayOf do
+  subject { described_class.new GandiV5::Data::Converter::Symbol }
+
+  it '#from_gandi' do
+    expect(subject.from_gandi(['value'])).to match_array [:value]
+  end
+
+  it '#to_gandi' do
+    expect(subject.to_gandi([:value])).to match_array ['value']
+  end
+
+  it 'nil value' do
+    expect(subject.from_gandi(nil)).to be nil
+    expect(subject.to_gandi(nil)).to be nil
+  end
+end

data/spec/units/gandi_v5/data/converter/symbol_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe GandiV5::Data::Converter::Symbol do
+  it '.from_gandi' do
+    expect(described_class.from_gandi('value')).to eq :value
+  end
+
+  it '.to_gandi' do
+    expect(described_class.to_gandi(:value)).to eq 'value'
+  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/data/converter/time_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe GandiV5::Data::Converter::Time do
+  it '.from_gandi' do
+    expect(described_class.from_gandi('2019-02-13T11:04:18Z')).to eq Time.new(2019, 2, 13, 11, 4, 18, 0)
+  end
+
+  it '.to_gandi' do
+    expect(described_class.to_gandi(Time.new(2019, 2, 13, 11, 4, 18, 0))).to eq '2019-02-13T11:04:18Z'
+  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/data/converter_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+describe GandiV5::Data::Converter do
+  let(:proc) { double Proc }
+
+  describe '#to_gandi' do
+    it 'Has a to_gandi proc' do
+      expect(proc).to receive(:call).with(:value).and_return(:return)
+      subject = described_class.new to_gandi: proc
+      expect(subject.to_gandi(:value)).to be :return
+    end
+
+    it 'Hasn\'t a to_gandi proc' do
+      subject = described_class.new
+      expect(subject.to_gandi(:value)).to be :value
+    end
+  end
+
+  describe '#from_gandi' do
+    it 'Has a from_gandi proc' do
+      expect(proc).to receive(:call).with(:value).and_return(:return)
+      subject = described_class.new from_gandi: proc
+      expect(subject.from_gandi(:value)).to be :return
+    end
+
+    it 'Hasn\'t a from_gandi proc' do
+      subject = described_class.new
+      expect(subject.from_gandi(:value)).to be :value
+    end
+  end
+end