gandi_v5 0.6.0 → 0.7.0

data/lib/gandi_v5/live_dns/zone.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # A zone within the LiveDNS system.
-    # Zones can be used by any number of domains.
-    # @!attribute [r] uuid
-    #   @return [String]
-    # @!attribute [r] name
-    #   @return [String]
-    # @!attribute [r] sharing_uuid
-    #   @return [String]
-    # @!attribute [r] soa_retry
-    #   @return [Integer] retry period, as reported in SOA record.
-    # @!attribute [r] soa_minimum
-    #   @return [Integer] minimum and negative TTL, as reported in SOA record.
-    # @!attribute [r] soa_refresh
-    #   @return [Integer] refresh period, as reported in SOA record.
-    # @!attribute [r] soa_expire
-    #   @return [Integer] expire period, as reported in SOA record.
-    # @!attribute [r] soa_serial
-    #   @return [Integer] serial number, as reported in SOA record.
-    # @!attribute [r] soa_email
-    #   @return [String] admin email address, as reported in SOA record.
-    # @!attribute [r] soa_primary_ns
-    #   @return [String] primary name server, as reported in SOA record.
-    class Zone
-      include GandiV5::Data
-      include GandiV5::LiveDNS::HasZoneRecords
-
-      members :uuid, :name
-      member :sharing_uuid, gandi_key: 'sharing_id'
-      member :soa_retry, gandi_key: 'retry'
-      member :soa_minimum, gandi_key: 'minimum'
-      member :soa_refresh, gandi_key: 'refresh'
-      member :soa_expire, gandi_key: 'expire'
-      member :soa_serial, gandi_key: 'serial'
-      member :soa_email, gandi_key: 'email'
-      member :soa_primary_ns, gandi_key: 'primary_ns'
-
-      alias zone_uuid uuid
-
-      # Generate SOA record for the zone
-      # @return [String]
-      def to_s
-        "@\tIN\tSOA\t#{soa_primary_ns} #{soa_email} (\n" \
-        "\t#{soa_serial}\t;Serial\n" \
-        "\t#{soa_refresh}\t\t;Refresh\n" \
-        "\t#{soa_retry}\t\t;Retry\n" \
-        "\t#{soa_expire}\t\t;Expire\n" \
-        "\t#{soa_minimum}\t\t;Minimum & Negative TTL\n" \
-        ')'
-      end
-
-      # List the domains that use this zone.
-      # @return [Array<String>] The FQDNs.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def list_domains
-        _response, data = GandiV5.get "#{url}/domains"
-        data.map { |item| item['fqdn'] }
-      end
-
-      # Attach domain to this zone.
-      # @param fqdn [String, #fqdn, #to_s] the fully qualified domain name
-      #   that should start using this zone.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def attach_domain(fqdn)
-        fqdn = fqdn.fqdn if fqdn.respond_to?(:fqdn)
-        _resp, data = GandiV5.patch "#{BASE}domains/#{CGI.escape fqdn}", { zone_uuid: uuid }.to_json
-        data['message']
-      end
-
-      # Get snapshot UUIDs for this zone from Gandi.
-      # @return [Hash{String => Time}] Mapping snapshot UUID to time made.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def snapshots
-        GandiV5::LiveDNS::Zone::Snapshot.list uuid
-      end
-
-      # Get snapshot from Gandi.
-      # @param uuid [String] the UUID of the snapshot to fetch.
-      # @return [GandiV5::LiveDNS::Zone::Snapshot]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def snapshot(uuid)
-        GandiV5::LiveDNS::Zone::Snapshot.fetch self.uuid, uuid
-      end
-
-      # Take a snapshot of this zone.
-      # @return [GandiV5::LiveDNS::Zone::Snapshot]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def take_snapshot
-        _response, data = GandiV5.post "#{url}/snapshots"
-        snapshot data['uuid']
-      end
-
-      # Update this zone.
-      # @param name [String, #to_s] new name for the zone.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def update(name:)
-        _response, data = GandiV5.patch url, { name: name }.to_json
-        self.name = name
-        data['message']
-      end
-
-      # Delete this zone from Gandi.
-      # @return [nil]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def delete
-        GandiV5.delete url
-      end
-
-      # Create a new zone.
-      # @param name [String] the name for the created zone.
-      # @param sharing_id [String] the UUID of the account to ceate the zone under.
-      # @return [GandiV5::LiveDNS::Zone] The created zone.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.create(name, sharing_id: nil)
-        params = sharing_id ? { sharing_id: sharing_id } : {}
-
-        response, _data = GandiV5.post(
-          url,
-          { name: name }.to_json,
-          params: params
-        )
-
-        fetch response.headers[:location].split('/').last
-      end
-
-      # List the zones.
-      # @return [Array<GandiV5::LiveDNS::Zone>]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.list
-        _response, data = GandiV5.get url
-        data.map { |item| from_gandi item }
-      end
-
-      # Get a zone from Gandi.
-      # @param uuid [String, #to_s] the UUID of the zone to fetch.
-      # @return [GandiV5::LiveDNS::Zone]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.fetch(uuid)
-        _response, data = GandiV5.get url(uuid)
-        from_gandi data
-      end
-
-      private
-
-      def url
-        "#{BASE}zones/#{CGI.escape uuid}"
-      end
-
-      def self.url(uuid = nil)
-        BASE + (uuid ? "zones/#{CGI.escape(uuid)}" : 'zones')
-      end
-      private_class_method :url
-    end
-  end
-end

data/lib/gandi_v5/live_dns/zone/snapshot.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    class Zone
-      # A snapshot (backup) of a zone.
-      # @!attribute [r] uuid
-      #   @return [String]
-      # @!attribute [r] zone_uuid
-      #   @return [String]
-      # @!attribute [r] created_at
-      #   @return [Time]
-      # @!attribute [r] records
-      #   @return [Array<GandiV5::LiveDNS::RecordSet>]
-      class Snapshot
-        include GandiV5::Data
-
-        members :uuid, :zone_uuid
-        member :created_at, gandi_key: 'date_created', converter: GandiV5::Data::Converter::Time
-        member(
-          :records,
-          gandi_key: 'zone_data',
-          converter: GandiV5::LiveDNS::RecordSet,
-          array: true
-        )
-
-        alias snapshot_uuid uuid
-
-        # Delete this snapshot.
-        # @return [String] The confirmation message from Gandi.
-        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-        def delete
-          _response, data = GandiV5.delete url
-          data['message']
-        end
-
-        # @see GandiV5::LiveDNS::Zone.fetch
-        def fetch_zone
-          GandiV5::LiveDNS::Zone.fetch zone_uuid
-        end
-
-        # The snapshot's zone (fetching from Gandi if required).
-        # @return [GandiV5::LiveDNS::Zone]
-        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-        def zone
-          @zone ||= fetch_zone
-        end
-
-        # Get snapshot UUIDs for this zone from Gandi.
-        # @return [Hash{String => Time}] Mapping UUID to time made.
-        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-        def self.list(zone_uuid)
-          _response, data = GandiV5.get url(zone_uuid)
-          Hash[data.map { |snapshot| [snapshot['uuid'], Time.parse(snapshot['date_created'])] }]
-        end
-
-        # Get snapshot from Gandi.
-        # @param zone_uuid [String, #to_s] the UUID of the zone the snapshot was made of.
-        # @param snapshot_uuid [String, #to_s] the UUID of the snapshot to fetch.
-        # @return [GandiV5::LiveDNS::Zone::Snapshot]
-        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-        def self.fetch(zone_uuid, snapshot_uuid)
-          _response, data = GandiV5.get url(zone_uuid, snapshot_uuid)
-          from_gandi data
-        end
-
-        private
-
-        def url
-          "#{BASE}zones/#{CGI.escape zone_uuid}/snapshots/#{CGI.escape uuid}"
-        end
-
-        def self.url(zone_uuid, snapshot_uuid = nil)
-          "#{BASE}zones/#{CGI.escape zone_uuid}/snapshots" +
-            (snapshot_uuid ? "/#{CGI.escape snapshot_uuid}" : '')
-        end
-        private_class_method :url
-      end
-    end
-  end
-end

data/spec/features/domain_spec.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-describe 'Domain features' do
-  it 'List domains', :vcr do
-    list = GandiV5.domains
-
-    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 eq []
-    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

@@ -1,8 +0,0 @@
-# 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

@@ -1,44 +0,0 @@
-# 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
-    hash = {
-      uuid: 'snapshot-uuid',
-      zone_uuid: 'zone-uuid',
-      created_at: Time.new(2016, 12, 16, 16, 51, 26),
-      records: [
-        type: 'A',
-        ttl: 10_800,
-        name: 'www',
-        values: ['10.0.1.42']
-      ]
-    }
-
-    zone = GandiV5::LiveDNS::Zone.new uuid: 'zone-uuid'
-    snapshot = zone.take_snapshot
-    expect(snapshot.to_h).to eq hash
-  end
-end

data/spec/features/mailbox_spec.rb

@@ -1,18 +0,0 @@
-# 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_LiveDNS_Zone/fetch.yml

@@ -1,11 +0,0 @@
----
-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.yml

@@ -1,11 +0,0 @@
----
-- 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/list.yml

@@ -1,3 +0,0 @@
----
-- uuid: snapshot-uuid
-  date_created: '2016-12-16T16:51:26Z'

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

@@ -1,55 +0,0 @@
----
-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",
-            "nameservers": []
-          }
-        ]
-    http_version: 
-  recorded_at: Thu, 30 May 2019 06:22:02 GMT
-recorded_with: VCR 4.0.0