gandi_v5 0.6.0 → 0.7.0

data/lib/gandi_v5/live_dns/domain/dnssec_key.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A DNSSEC key for a domain's DNS records.
+      # @!attribyte [r] uuid
+      #   @return [String]
+      # @!attribyte [r] status
+      #   @return [String]
+      # @!attribyte [r] fqdn
+      #   @return [String]
+      # @!attribyte [r] algorithm_id
+      #   @return [Integer]
+      # @!attribyte [r] algorithm_name
+      #   @return [String]
+      # @!attribyte [r] deleted
+      #   @return [Boolean]
+      # @!attribyte [r] ds
+      #   @return [String]
+      # @!attribyte [r] flags
+      #   @return [Integer]
+      # @!attribyte [r] fingerprint
+      #   @return [String]
+      # @!attribyte [r] public_key
+      #   @return [String]
+      # @!attribyte [r] tag
+      #   @return [String]
+      class DnssecKey
+        include GandiV5::Data
+
+        members :status, :fqdn, :deleted, :ds, :flags, :fingerprint, :public_key,
+                :tag, :algorithm_name
+
+        member :uuid, gandi_key: 'id'
+        member :algorithm_id, gandi_key: 'algorithm'
+
+        # Delete this key.
+        # @return [String] The confirmation message from Gandi.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def delete
+          _response, data = GandiV5.delete url
+          self.deleted = true
+          data['message']
+        end
+
+        # Undelete this key.
+        # @return [String] The confirmation message from Gandi.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def undelete
+          _response, data = GandiV5.patch url, { deleted: false }.to_json
+          self.deleted = false
+          data['message']
+        end
+
+        # Check if this is a zone signing key
+        # @return [Boolean]
+        def zone_signing_key?
+          flags == 256
+        end
+
+        # Check if this is a key signing key
+        # @return [Boolean]
+        def key_signing_key?
+          flags == 257
+        end
+
+        # Create a new DNSSEC key for a zone.
+        # @param fqdn [String, #to_s] the fully qualified domain to create the key for.
+        # @param flags [Integer, :key_signing_key, :zone_signing_key] the key's flags.
+        # @return [GandiV5::LiveDNS::Domain::DnssecKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.create(fqdn, flags)
+          flags = 256 if flags == :zone_signing_key
+          flags = 257 if flags == :key_signing_key
+          fail ArgumentError, 'flags is invalid' unless flags.is_a?(Integer)
+
+          response, _data = GandiV5.post url(fqdn), { flags: flags }.to_json
+          fetch fqdn, response.headers[:location].split('/').last
+        end
+
+        # Get keys for a FQDN from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name to get the keys for.
+        # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.list(fqdn)
+          _response, data = GandiV5.get url(fqdn)
+          data.map { |item| from_gandi item }
+        end
+
+        # Get DNSSEC key from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name the key was made for.
+        # @param uuid [String, #to_s] the UUID of the key to fetch.
+        # @return [GandiV5::LiveDNS::Domain::DnssecKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(fqdn, uuid)
+          _response, data = GandiV5.get url(fqdn, uuid)
+          from_gandi data
+        end
+
+        private
+
+        def url
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/keys/#{CGI.escape uuid}"
+        end
+
+        def self.url(fqdn, uuid = nil)
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/keys" +
+            (uuid ? "/#{CGI.escape uuid}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end

data/lib/gandi_v5/live_dns/domain/record.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A record set which comes from either a domain or zone.
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] ttl
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] values
+      #   @return [Array<String>]
+      class Record
+        include GandiV5::Data
+
+        member :type, gandi_key: 'rrset_type'
+        member :ttl, gandi_key: 'rrset_ttl', converter: GandiV5::Data::Converter::Integer
+        member :name, gandi_key: 'rrset_name'
+        member :values, gandi_key: 'rrset_values'
+
+        # Generate zone file lines for the record.
+        # @return [String]
+        def to_s
+          values.map do |value|
+            "#{name}\t#{ttl}\tIN\t#{type}\t#{value}"
+          end.join("\n")
+        end
+
+        GandiV5::LiveDNS::RECORD_TYPES.each do |t|
+          # Check the record type.
+          # @return [Boolean]
+          define_method "#{t.downcase}?" do
+            type.eql?(t)
+          end
+        end
+
+        # Check the TTL's value in seconds.
+        # @param number [Integer] the number of second(s) to check against.
+        # @return [Boolean]
+        def second?(number = 1)
+          ttl == number
+        end
+        alias seconds? second?
+
+        # Check the TTL's value in minutes.
+        # @param number [Integer] the number of minute(s) to check against.
+        # @return [Boolean]
+        def minute?(number = 1)
+          ttl == number * 60
+        end
+        alias minutes? minute?
+
+        # Check the TTL's value in hours.
+        # @param number [Integer] the number of hour(s) to check against.
+        # @return [Boolean]
+        def hour?(number = 1)
+          ttl == number * 3_600
+        end
+        alias hours? hour?
+
+        # Check the TTL's value in days.
+        # @param number [Integer] the number of day(s) to check against.
+        # @return [Boolean]
+        def day?(number = 1)
+          ttl == number * 86_400
+        end
+        alias days? day?
+
+        # Check the TTL's value in weeks.
+        # @param number [Integer] the number of week(s) to check against.
+        # @return [Boolean]
+        def week?(number = 1)
+          ttl == number * 604_800
+        end
+        alias weeks? day?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A snapshot (backup) of a domain's DNS records.
+      # @!attribute [r] fqdn
+      #   @return [String]
+      # @!attribute [r] uuid
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] created_at
+      #   @return [Time]
+      # @!attribute [r] automatic
+      #   @return [Boolean]
+      class Snapshot
+        include GandiV5::Data
+
+        members :name, :automatic, :fqdn
+        member :created_at, converter: GandiV5::Data::Converter::Time
+        member :uuid, gandi_key: 'id'
+        member(
+          :records,
+          gandi_key: 'zone_data',
+          converter: GandiV5::LiveDNS::Domain::Record,
+          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
+
+        # Update this snapshot.
+        # @param name [String, #to_s] new name for the snapshot.
+        # @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
+
+        # Get snapshot details for this FQDN from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name to get the snapshots for.
+        # @param page [#each<Integer, #to_s>] the page(s) of results to retrieve.
+        #   If page is not provided keep querying until an empty list is returned.
+        #   If page responds to .each then iterate until an empty list is returned.
+        # @param per_page [Integer, #to_s] (optional default 100) how many results to get per page.
+        # @param automatic [nil, Boolean] (optional) filter by automatic or manual snapshot.
+        # @return [Array<GandiV5::LiveDNS::Domain::Snapshot>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.list(fqdn, page: (1..), per_page: 100, **params)
+          params.reject! { |_k, v| v.nil? }
+
+          snapshots = []
+          GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
+            snapshots += data.map { |item| from_gandi item.merge(fqdn: fqdn) }
+          end
+          snapshots
+        end
+
+        # Get snapshot from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name the snapshot was made for.
+        # @param uuid [String, #to_s] the UUID of the snapshot to fetch.
+        # @return [GandiV5::LiveDNS::Domain::Snapshot]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(fqdn, uuid)
+          _response, data = GandiV5.get url(fqdn, uuid)
+          from_gandi data.merge(fqdn: fqdn)
+        end
+
+        # Get the records which makeup this snapshot (fetching from Gandi if required).
+        # @return [Array<GandiV5::LiveDNS::Domain::Record>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def records
+          return @records unless @records.nil?
+
+          @records = fetch_records
+        end
+
+        private
+
+        def fetch_records
+          _response, data = GandiV5.get url
+          data.fetch('zone_data').map { |item| GandiV5::LiveDNS::Domain::Record.from_gandi item }
+        end
+
+        def url
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/snapshots/#{CGI.escape uuid}"
+        end
+
+        def self.url(fqdn, snapshot_uuid = nil)
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/snapshots" +
+            (snapshot_uuid ? "/#{CGI.escape snapshot_uuid}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end

data/lib/gandi_v5/live_dns/domain/tsig_key.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A Tsig key.
+      # @!attribyte [r] uuid
+      #   @return [String]
+      # @!attribyte [r] name
+      #   @return [String]
+      # @!attribyte [r] secret
+      #   @return [String]
+      # @!attribyte [r] config_examples
+      #   @return [Hash<Symbol -> String>]
+      class TsigKey
+        include GandiV5::Data
+
+        member :secret
+        member :uuid, gandi_key: 'id'
+        member :name, gandi_key: 'key_name'
+        member(
+          :config_examples,
+          gandi_key: 'config_samples',
+          converter: GandiV5::Data::Converter.new(
+            from_gandi: ->(value) { value.transform_keys(&:to_sym) },
+            to_gandi: ->(_value) { nil }
+          )
+        )
+
+        # Create a new DNSSEC key for a zone.
+        # @param sharing_id [nil, String, #to_s]
+        # @return [GandiV5::LiveDNS::Domain::DnssecKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.create(sharing_id = nil)
+          url_ = url
+          url_ += "?sharing_id=#{CGI.escape sharing_id}" if sharing_id
+
+          _response, data = GandiV5.post url_
+          fetch data.fetch('id')
+        end
+
+        # Get keys from Gandi.
+        # If you need the secret, fingerprint, public_key or tag attributes you'll need
+        # to use GandiV5::LiveDNS::Domain::DnssecKey.fetch on each item.
+        # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
+        # @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 Tsig key from Gandi.
+        # @param uuid [String, #to_s] the UUID of the key to fetch.
+        # @return [GandiV5::LiveDNS::Domain::TsigKey]
+        # @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 self.url(uuid = nil)
+          "#{BASE}livedns/axfr/tsig" +
+            (uuid ? "/#{CGI.escape uuid}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end

data/lib/gandi_v5/version.rb

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

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

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

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml

@@ -0,0 +1,3 @@
+---
+- id: key-uuid
+  key_name: key-name

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml

@@ -0,0 +1,3 @@
+---
+- a.example.com
+- b.example.com

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

@@ -0,0 +1,12 @@
+---
+id: key-uuid
+status: status
+fqdn: example.com
+algorithm: 2
+algorithm_name: Diffie-Hellman
+deleted: false
+ds: ds-record
+flags: 256
+fingerprint: fp
+public_key: pub-key
+tag: tag

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

@@ -0,0 +1,9 @@
+---
+- id: key-uuid
+  status: status
+  fqdn: example.com
+  algorithm: 2
+  algorithm_name: Diffie-Hellman
+  deleted: false
+  ds: ds-record
+  flags: 256

data/spec/fixtures/bodies/{GandiV5_LiveDNS_Zone_Snapshot → GandiV5_LiveDNS_Domain_Snapshot}/fetch.yml

@@ -1,7 +1,8 @@
 ---
-date_created: '2016-12-16T16:51:26Z'
-uuid: snapshot-uuid
-zone_uuid: zone-uuid
+created_at: '2016-12-16T16:51:26Z'
+id: snapshot-uuid
+name: snapshot-name
+automatic: true
 zone_data:
 - rrset_type: A
   rrset_ttl: 10800

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

@@ -0,0 +1,5 @@
+---
+- id: snapshot-uuid
+  name: snapshot-name
+  automatic: true
+  created_at: '2016-12-16T16:51:26Z'

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

@@ -0,0 +1,9 @@
+---
+id: key-uuid
+key_name: key-name
+secret: key-secret
+config_samples:
+  bind: bind-sample
+  knot: knot-sample
+  nsd: nsd-sample
+  powerdns: powerdns-sample