gandi_v5 0.3.0 → 0.8.0

data/lib/gandi_v5/live_dns/has_zone_records.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # Methods for handling record related requests in both
-    # GandiV5::LiveDNS::Domain and GandiV5::LiveDNS::Zone.
-    module HasZoneRecords
-      # @overload fetch_records()
-      #   Fetch all records for this domain.
-      # @overload fetch_records(name)
-      #   Fetch records for a name.
-      #   @param name [String] the name to fetch records for.
-      # @overload fetch_records(name, type)
-      #   Fetch records of a type for a name.
-      #   @param name [String] the name to fetch records for.
-      #   @param type [String] the record type to fetch.
-      # @return [Array<GandiV5::LiveDNS::RecordSet>]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def fetch_records(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type type if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-
-        _response, data = GandiV5.get url_
-        data = [data] unless data.is_a?(Array)
-        data.map { |item| GandiV5::LiveDNS::RecordSet.from_gandi item }
-      end
-
-      # @overload fetch_zone_lines()
-      #   Fetch all records for this domain.
-      # @overload fetch_zone_lines(name)
-      #   Fetch records for a name.
-      #   @param name [String] the name to fetch records for.
-      # @overload fetch_zone_lines(name, type)
-      #   Fetch records of a type for a name.
-      #   @param name [String] the name to fetch records for.
-      #   @param type [String] the record type to fetch.
-      # @return [String]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def fetch_zone_lines(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type type if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-
-        GandiV5.get(url_, accept: 'text/plain').last
-      end
-
-      # Add record to this domain.
-      # @param name [String]
-      # @param type [String]
-      # @param ttl [Integer]
-      # @param values [Array<String>]
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def add_record(name, type, ttl, *values)
-        GandiV5::LiveDNS.require_valid_record_type type
-        fail ArgumentError, 'ttl must be positive and non-zero' unless ttl.positive?
-        fail ArgumentError, 'there must be at least one value' if values.none?
-
-        body = {
-          rrset_name: name,
-          rrset_type: type,
-          rrset_ttl: ttl,
-          rrset_values: values
-        }.to_json
-        _response, data = GandiV5.post "#{url}/records", body
-        data['message']
-      end
-
-      # @overload delete_records()
-      #   Delete all records for this domain.
-      # @overload delete_records(name)
-      #   Delete records for a name.
-      #   @param name [String] the name to delete records for.
-      # @overload delete_records(name, type)
-      #   Delete records of a type for a name.
-      #   @param name [String] the name to delete records for.
-      #   @param type [String] the record type to delete.
-      # @return [nil]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def delete_records(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type(type) if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-        GandiV5.delete(url_).last
-      end
-
-      # Replace all records for this domain.
-      # @param records
-      #   [Array<Hash<:name, :type => String, :ttl => Integer, :values => Array<String>>>]
-      #   the records to add.
-      # @param text [String] zone file lines to replace the records with.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [ArgumentError] if neither/both of records & test are passed.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def replace_records(records: nil, text: nil)
-        unless [records, text].count(&:nil?).eql?(1)
-          fail ArgumentError, 'you must pass ONE of records: or text:'
-        end
-
-        if records
-          body = {
-            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-          }.to_json
-          _response, data = GandiV5.put "#{url}/records", body
-        elsif text
-          _response, data = GandiV5.put "#{url}/records", text, 'content-type': 'text/plain'
-        end
-        data['message']
-      end
-
-      # @override replace_records_for(name, records)
-      #   Replace records for a name in this domain.
-      #   @param name [String]
-      #   @param records
-      #     [Array<Hash<type: String, ttl: Integer, values: Array<String>>>]
-      #     the records to add.
-      # @override replace_records_for(name, values, type: nil, ttl: nil)
-      #   Replace records for a name in this domain.
-      #   @param name [String]
-      #   @param type [String] the record type.
-      #   @param ttl [Integer] the TTL to set for the record.
-      #   @param values [Array<String>] the values to set for the record.
-      #   @raise [ArgumentError] if ttl is present and type is absent.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def replace_records_for(name, records, type: nil, ttl: nil)
-        fail ArgumentError, 'missing keyword: type' if ttl && type.nil?
-
-        if type
-          GandiV5::LiveDNS.require_valid_record_type type
-          body = { rrset_values: records, rrset_ttl: ttl }
-          # body[:rrset_ttl] = ttl if ttl
-          _response, data = GandiV5.put "#{url}/records/#{name}/#{type}", body.to_json
-
-        else
-          body = {
-            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-          }
-          _response, data = GandiV5.put "#{url}/records/#{name}", body.to_json
-        end
-
-        data['message']
-      end
-    end
-  end
-end

data/lib/gandi_v5/live_dns/record_set.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # 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 RecordSet
-      include GandiV5::Data
-
-      member :type, gandi_key: 'rrset_type'
-      member :ttl, gandi_key: 'rrset_ttl'
-      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

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