gandi_v5 0.1.0

data/lib/gandi_v5.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative 'gandi_v5/version'
+require_relative 'gandi_v5/data'
+require_relative 'gandi_v5/error'
+
+require_relative 'gandi_v5/billing'
+require_relative 'gandi_v5/domain'
+require_relative 'gandi_v5/email'
+require_relative 'gandi_v5/live_dns'
+require_relative 'gandi_v5/organization'
+
+require 'rest_client'
+require 'securerandom'
+
+# Namespace for classes which access the Gandi V5 API.
+# Also provides useful methods and constants for them.
+# This is where you configure the gem:
+#  * Setting your Gandi API key:
+#    1. Get your API key - Login to Gandi and visit User Settings ->
+#       Change password & configure access restrictions.
+# @see https://api.gandi.net/docs/
+# @see https://doc.livedns.gandi.net/
+# @!attribute [w] api_key
+#   @return [String]
+class GandiV5
+  BASE = 'https://api.gandi.net/v5/'
+
+  class << self
+    attr_writer :api_key
+
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def get(url, **headers)
+      prepare_headers headers, url
+      response = RestClient.get url, **headers
+      parse_response response
+    rescue RestClient::BadRequest => e
+      handle_bad_request(e)
+    end
+
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * RestClient::Conflict
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def delete(url, **headers)
+      prepare_headers headers, url
+      response = RestClient.delete url, **headers
+      parse_response response
+    rescue RestClient::BadRequest => e
+      handle_bad_request(e)
+    end
+
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * RestClient::BadRequest
+    #  * RestClient::Conflict
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def patch(url, payload = '', **headers)
+      prepare_headers headers, url
+      headers[:'content-type'] ||= 'application/json'
+      response = RestClient.patch url, payload, **headers
+      parse_response response
+    rescue RestClient::BadRequest => e
+      handle_bad_request(e)
+    end
+
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * RestClient::BadRequest
+    #  * RestClient::Conflict
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def post(url, payload = '', **headers)
+      prepare_headers headers, url
+      headers[:'content-type'] ||= 'application/json'
+      response = RestClient.post url, payload, **headers
+      parse_response response
+    rescue RestClient::BadRequest => e
+      handle_bad_request(e)
+    end
+
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * RestClient::BadRequest
+    #  * RestClient::Conflict
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def put(url, payload = '', **headers)
+      prepare_headers headers, url
+      headers[:'content-type'] ||= 'application/json'
+      response = RestClient.put url, payload, **headers
+      parse_response response
+    rescue RestClient::BadRequest => e
+      handle_bad_request(e)
+    end
+
+    private
+
+    def api_key
+      @api_key ||= ENV.fetch('GANDI_API_KEY')
+    end
+
+    def authorisation_header(url)
+      if url.start_with?(BASE)
+        { Authorization: "Apikey #{api_key}" }
+      elsif url.start_with?(GandiV5::LiveDNS::BASE)
+        { 'X-Api-Key': api_key }
+      else
+        fail ArgumentError, "Don't know how to authorise for url: #{url}"
+      end
+    end
+
+    def parse_response(response)
+      type = response.headers.fetch(:content_type).split(';').first.chomp
+      case type
+      when 'text/plain'
+        response.body.to_s
+      when 'application/json'
+        response = JSON.parse(response.body)
+        if response.is_a?(Hash) && response['status'].eql?('error')
+          fail GandiV5::Error::GandiError.from_hash(response)
+        end
+
+        response
+      else
+        fail ArgumentError, "Don't know how to parse a #{type} response"
+      end
+    end
+
+    def prepare_headers(headers, url)
+      headers.transform_keys!(&:to_sym)
+      headers[:accept] ||= 'application/json'
+      headers.merge!(authorisation_header(url))
+    end
+
+    def handle_bad_request(exception)
+      data = JSON.parse exception.response.body
+      unless data.is_a?(Hash) && data['status'].eql?('error') && data['errors'].is_a?(Array)
+        raise exception
+      end
+
+      field, message = data['errors'].first.values_at('name', 'description')
+      fail GandiV5::Error::GandiError, "#{field}: #{message}"
+    rescue JSON::ParserError
+      raise exception
+    end
+  end
+end

data/spec/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/BlockLength:
+  Max: 500
+Metrics/LineLength:
+  Max: 125

data/spec/features/domain_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+describe 'Domain features' do
+  it 'List domains', :vcr do
+    list = GandiV5::Domain.list
+
+    expect(list.count).to eq 1
+    expect(list.first.fqdn).to eq 'example.net'
+    expect(list.first.fqdn_unicode).to eq 'example.net'
+    expect(list.first.name_servers).to be nil
+    expect(list.first.services).to be nil
+    expect(list.first.sharing_space).to be nil
+    expect(list.first.status).to match_array [:clientTransferProhibited]
+    expect(list.first.tld).to eq 'net'
+    expect(list.first.dates.registry_created_at).to eq Time.new(2019, 2, 13, 10, 4, 18)
+    expect(list.first.dates.updated_at).to eq Time.new(2019, 2, 25, 16, 20, 49)
+    expect(list.first.dates.authinfo_expires_at).to be nil
+    expect(list.first.dates.created_at).to eq Time.new(2019, 2, 13, 11, 4, 18)
+    expect(list.first.dates.deletes_at).to be nil
+    expect(list.first.dates.hold_begins_at).to be nil
+    expect(list.first.dates.hold_ends_at).to be nil
+    expect(list.first.dates.pending_delete_ends_at).to be nil
+    expect(list.first.dates.registry_ends_at).to eq Time.new(2021, 2, 13, 10, 4, 18)
+    expect(list.first.dates.renew_begins_at).to be nil
+    expect(list.first.dates.restore_ends_at).to be nil
+    expect(list.first.can_tld_lock).to be nil
+    expect(list.first.auto_renew.dates).to be nil
+    expect(list.first.auto_renew.duration).to be nil
+    expect(list.first.auto_renew.enabled).to be false
+    expect(list.first.auto_renew.org_id).to be nil
+    expect(list.first.auth_info).to be nil
+    expect(list.first.uuid).to eq 'ba1167be-2f76-11e9-9dfb-00163ec4cb00'
+    expect(list.first.sharing_uuid).to be nil
+    expect(list.first.tags).to match_array []
+    expect(list.first.trustee_roles).to be nil
+    expect(list.first.owner).to eq 'alice_doe'
+    expect(list.first.organisation_owner).to eq 'alice_doe'
+    expect(list.first.domain_owner).to eq 'Alice Doe'
+    expect(list.first.name_server).to be :livedns
+  end
+
+  it 'Renew domain', :vcr do
+    expect(GandiV5::Domain.fetch('example.net').renew_for(2)).to eq 'Domain renewed.'
+  end
+end

data/spec/features/livedns_domain_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+describe 'LiveDNS Domain features' do
+  it 'List domains', :vcr do
+    list = GandiV5::LiveDNS::Domain.list
+    expect(list.map(&:fqdn)).to match_array %w[example.com example.net]
+  end
+end

data/spec/features/livedns_zone_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+describe 'LiveDNS Zone features' do
+  it 'List zones', :vcr do
+    list = GandiV5::LiveDNS::Zone.list
+
+    expect(list.count).to eq 1
+    expect(list.first.uuid).to eq 'uuid-of-zone'
+    expect(list.first.name).to eq 'Zone Name'
+    expect(list.first.sharing_uuid).to be nil
+    expect(list.first.soa_retry).to eq 3_600
+    expect(list.first.soa_minimum).to eq 10_800
+    expect(list.first.soa_refresh).to eq 10_800
+    expect(list.first.soa_expire).to eq 604_800
+    expect(list.first.soa_serial).to eq 1_432_798_405
+    expect(list.first.soa_email).to eq 'hostmaster.gandi.net.'
+    expect(list.first.soa_primary_ns).to eq 'a.dns.gandi.net.'
+  end
+
+  it 'Save zone to file', :vcr do
+    zone = GandiV5::LiveDNS::Zone.new uuid: 'zone-uuid'
+    expect(File).to receive(:write).with('/path/to/file', "Contents of zone file.\n")
+
+    File.write '/path/to/file', zone.fetch_zone_lines
+  end
+
+  it 'Make and save snapshot', :vcr do
+    yaml = "--- !ruby/object:GandiV5::LiveDNS::Zone::Snapshot\n" \
+           "uuid: snapshot-uuid\n" \
+           "zone_uuid: zone-uuid\n" \
+           "created_at: 2016-12-16 16:51:26.000000000 Z\n" \
+           "records:\n" \
+           "- !ruby/object:GandiV5::LiveDNS::RecordSet\n" \
+           "  type: A\n" \
+           "  ttl: 10800\n" \
+           "  name: www\n" \
+           "  values:\n" \
+           "  - 10.0.1.42\n"
+    expect(File).to receive(:write).with('/path/to/file', yaml)
+
+    zone = GandiV5::LiveDNS::Zone.new uuid: 'zone-uuid'
+    snapshot = zone.take_snapshot
+    File.write '/path/to/file', snapshot.to_yaml
+  end
+end

data/spec/features/mailbox_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+describe 'Mailbox features' do
+  it 'List mailboxes', :vcr do
+    list = GandiV5::Email::Mailbox.list 'example.net'
+
+    expect(list.count).to eq 1
+    expect(list.first.login).to eq 'alice'
+    expect(list.first.fqdn).to eq 'example.net'
+    expect(list.first.address).to eq 'alice@example.net'
+    expect(list.first.uuid).to eq '066743e5-96e4-4a1d-9195-8b8a700a8a79'
+    expect(list.first.type).to be :standard
+    expect(list.first.quota_used).to eq 1_200
+    expect(list.first.aliases).to be nil
+    expect(list.first.fallback_email).to be nil
+    expect(list.first.responder).to be nil
+  end
+end

data/spec/fixtures/bodies/GandiV5_Billing/info.yaml

@@ -0,0 +1,10 @@
+---
+annual_balance: 123.45
+grid: A
+prepaid:
+  currency: GBP
+  amount: 1
+  warning_threshold: 
+  created_at: '2011-02-19T11:23:25Z'
+  updated_at: '2019-02-23T21:47:22Z'
+outstanding_amount: 0

data/spec/fixtures/bodies/GandiV5_Domain/availability.yaml

@@ -0,0 +1,15 @@
+---
+currency: GBP
+grid: A
+products:
+- status: unavailable
+  name: example.com
+  process: create
+  taxes:
+  - type: service
+    rate: 0
+    name: vat
+taxes:
+- type: service
+  rate: 0
+  name: vat

data/spec/fixtures/bodies/GandiV5_Domain/fetch_contacts.yaml

@@ -0,0 +1,8 @@
+---
+owner:
+  country: GB
+  email: owner@example.com
+  family: Fam
+  given: Giv
+  streetaddr: Somestreet
+  type: 1

data/spec/fixtures/bodies/GandiV5_Domain/get.yaml

@@ -0,0 +1,37 @@
+---
+status: []
+dates:
+  created_at: '2011-02-21T10:39:00Z'
+  registry_created_at: '2003-03-12T12:02:11Z'
+  registry_ends_at: '2020-03-12T12:02:11Z'
+  updated_at: '2019-02-06T09:49:37Z'
+tags:
+- Tag
+fqdn: example.com
+id: domain-uuid
+autorenew:
+  href: http://api.test/v5/domain/domains/example.com/autorenew
+  dates:
+  - '2021-01-13T09:04:18Z'
+  - '2021-01-29T10:04:18Z'
+  duration: 1
+  enabled: true
+  org_id: org-uuid
+tld: com
+nameservers:
+  - '192.168.0.1'
+  - '192.168.0.2'
+href: https://api.gandi.net/v5/domain/domains/example.com
+fqdn_unicode: example.com
+can_tld_lock: true
+contacts:
+  owner:
+    country: GB
+    email: owner@example.com
+    family: Fam
+    given: Giv
+    streetaddr: Somestreet
+    type: 1
+services:
+- gandilivedns
+- dnssec

data/spec/fixtures/bodies/GandiV5_Domain/list.yaml

@@ -0,0 +1,20 @@
+---
+- status: []
+  dates:
+    created_at: '2011-02-21T10:39:00Z'
+    registry_created_at: '2003-03-12T12:02:11Z'
+    registry_ends_at: '2020-03-12T12:02:11Z'
+    updated_at: '2019-02-06T09:49:37Z'
+  tags:
+  - Tag
+  fqdn: example.com
+  id: domain-uuid
+  autorenew: false
+  tld: com
+  owner: Example Owner
+  orga_owner: Example Organisation
+  domain_owner: Example Owner
+  nameserver:
+    current: livedns
+  href: https://api.gandi.net/v5/domain/domains/example.com
+  fqdn_unicode: example.com

data/spec/fixtures/bodies/GandiV5_Domain/renewal_info.yaml

@@ -0,0 +1,12 @@
+---
+renew:
+  begins_at: '2012-01-01T00:00:00Z'
+  durations:
+  - 1
+  - 2
+  maximum: 2
+  minimum: 1
+  prohibited: false
+contracts:
+  - id: uuid
+    name: Name

data/spec/fixtures/bodies/GandiV5_Domain/restore_info.yaml

@@ -0,0 +1,5 @@
+---
+restorable: true
+contracts:
+  - id: uuid
+    name: Name

data/spec/fixtures/bodies/GandiV5_Domain/tld.yaml

@@ -0,0 +1,10 @@
+---
+category: ccTLD
+name: eu
+lock: false
+change_owner: true
+authinfo_for_transfer: true
+full_tld: eu
+corporate: false
+ext_trade: true
+href: https://api.test/v5/domain/tlds/eu

data/spec/fixtures/bodies/GandiV5_Domain/tlds.yaml

@@ -0,0 +1,7 @@
+---
+- name: a
+  href: https://api.gandi.net/v5/domain/tlds/a
+- name: b
+  href: https://api.gandi.net/v5/domain/tlds/b
+- name: c
+  href: https://api.gandi.net/v5/domain/tlds/c

data/spec/fixtures/bodies/GandiV5_Email_Mailbox/get.yaml

@@ -0,0 +1,16 @@
+---
+address: address@example.com
+aliases:
+- alias-1
+- alias-2
+domain: example.com
+href: https://api.test/api/v5/email/example.com/mailbox-uuid
+id: mailbox-uuid
+login: address
+mailbox_type: standard
+quota_used: 1000000
+responder:
+  enabled: false
+  starts_at: '2000-01-01T00:00:00Z'
+  ends_at: '2000-01-02T00:00:00Z'
+  message: This is an autoresponse.

data/spec/fixtures/bodies/GandiV5_Email_Mailbox/list.yaml

@@ -0,0 +1,8 @@
+---
+- address: address@example.com
+  domain: example.com
+  href: https://api.test/api/v5/email/example.com/mailbox-uuid
+  id: mailbox-uuid
+  login: address
+  mailbox_type: standard
+  quota_used: 1000000

data/spec/fixtures/bodies/GandiV5_Email_Slot/get.yaml

@@ -0,0 +1,10 @@
+---
+status: inactive
+capacity: 51200
+refund_amount: 16.16
+mailbox_type: premium
+refundable: true
+refund_currency: EUR
+id: 125
+href: http://api.test/v5/email/slots/mailbox-api-test-1.fr/125
+created_at: '2019-04-08T08:48:41Z'

data/spec/fixtures/bodies/GandiV5_Email_Slot/list.yaml

@@ -0,0 +1,8 @@
+---
+- status: inactive
+  capacity: 3072
+  mailbox_type: standard
+  refundable: true
+  id: 125
+  href: http://api.test/v5/email/slots/mailbox-api-test-1.fr/125
+  created_at: '2019-04-08T08:48:41Z'

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/get.yaml

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

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list.yaml

@@ -0,0 +1,2 @@
+---
+- fqdn: example.com

data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/get.yaml

@@ -0,0 +1,11 @@
+---
+retry: 3600
+uuid: zone-uuid
+minimum: 900
+refresh: 10800
+expire: 604800
+serial: 1432798405
+user_uuid: user-uuid
+email: hostmaster.gandi.net.
+primary_ns: a.dns.gandi.net.
+name: Name

data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/list.yaml

@@ -0,0 +1,11 @@
+---
+- retry: 3600
+  uuid: zone-uuid
+  minimum: 900
+  refresh: 10800
+  expire: 604800
+  serial: 1432798405
+  user_uuid: user-uuid
+  email: hostmaster.gandi.net.
+  primary_ns: a.dns.gandi.net.
+  name: Name

data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/get.yaml

@@ -0,0 +1,9 @@
+---
+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']

data/spec/fixtures/bodies/GandiV5_Organization/get.yaml

@@ -0,0 +1,17 @@
+---
+username: UserName
+city: City
+streetaddr: Street Address
+zip: Post Code
+name: FirstLast
+firstname: First
+lastname: Last
+security_email: security@example.com
+id: organization-uuid
+phone: '+12.34567890'
+security_phone: '+23.45678901'
+country: GB
+security_email_validated: true
+security_email_validation_deadline: '2017-11-22T17:13:33Z'
+email: username@example.com
+lang: en

data/spec/fixtures/vcr/Domain_features/List_domains.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
+      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",
+              "registry_created_at": "2019-02-13T10:04:18Z",
+              "registry_ends_at": "2021-02-13T10:04:18Z",
+              "updated_at": "2019-02-25T16:20:49Z"
+            },
+            "tags": [],
+            "fqdn": "example.net",
+            "id": "ba1167be-2f76-11e9-9dfb-00163ec4cb00",
+            "autorenew": false,
+            "tld": "net",
+            "owner": "alice_doe",
+            "orga_owner": "alice_doe",
+            "domain_owner": "Alice Doe",
+            "nameserver": {
+              "current": "livedns"
+            },
+            "href": "https://api.test/v5/domain/domains/example.net",
+            "fqdn_unicode": "example.net"
+          }
+        ]
+    http_version: 
+  recorded_at: Thu, 30 May 2019 06:22:02 GMT
+recorded_with: VCR 4.0.0