gandi_v5 0.1.0

data/lib/gandi_v5/data.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+require_relative 'data/converter'
+
+class GandiV5
+  # Addin providing a DSL to manage declaring attributes and how to map
+  # and convert to/from Gandi's fields.
+  module Data
+    # api private
+    # Add contents of ClassMethods to the Class which includes this module.
+    # @param host_class [Class] the class which included us.
+    def self.included(host_class)
+      host_class.extend ClassMethods
+
+      host_class.instance_exec do
+        @data_members ||= Set.new
+        @data_converters ||= {}
+        @data_map_key_to_member ||= {}
+        @data_map_member_to_key ||= {}
+      end
+    end
+
+    # Get a hash representation of the object.
+    # @return [Hash<Symbol => Object>]
+    def to_h
+      Hash[
+        data_members.map do |key|
+          value = send(key)
+          next [key, value] if value.nil?
+
+          if value.is_a?(Enumerable)
+            value = to_h_transform_enumerable(value)
+          elsif value.respond_to?(:to_h)
+            value = value.to_h
+          end
+          [key, value]
+        end
+      ]
+    end
+
+    # Get a hash representation of this object suitable for passing back to Gandi.
+    # @return [Hash<String => nil, Boolean, String, Numeric, Hash, Array>]
+    def to_gandi
+      data = {}
+
+      data_members.each do |member|
+        key = data_member_to_gandi_key(member)
+        value = send(member)
+        converter = data_converter_for(member)
+
+        data[key] = if value.respond_to?(:to_gandi)
+                      value.to_gandi
+                    elsif converter && !value.nil?
+                      converter.to_gandi(value)
+                    else
+                      value
+                    end
+      end
+
+      data
+    end
+
+    # Get an array of values from particular members.
+    # @param keys [Array<Symbol, String>] e.g. :fqdn, "contacts.owner"
+    # @return [Array<Object>]
+    # rubocop:disable Style/IfUnlessModifier
+    def values_at(*keys)
+      keys.map(&:to_s).map do |key|
+        key, sub_key = key.split('.', 2)
+        unless data_member?(key.to_sym)
+          fail ArgumentError, "#{key} is not a member."
+        end
+
+        sub_key.empty? ? send(key) : send(key).values_at(sub_key)
+      end
+    end
+    # rubocop:enable Style/IfUnlessModifier
+
+    # Update instance with data from Gandi.
+    # @param data [Hash]
+    # @return [self]
+    def from_gandi(data)
+      translate_gandi(data).each do |key, value|
+        next unless data_member?(key.to_sym)
+
+        send "#{key}=", value
+      end
+      self
+    end
+
+    # Create a new instance from any passed members.
+    # @param members [Hash<Symbol => Object>]
+    # rubocop:disable Style/IfUnlessModifier
+    def initialize(**members)
+      members.each do |member, value|
+        unless data_member?(member)
+          fail ArgumentError, "unknown keyword: #{member}"
+        end
+
+        send "#{member}=", value
+      end
+    end
+    # rubocop:enable Style/IfUnlessModifier
+
+    private
+
+    def data_members
+      self.class.send(:data_members)
+    end
+
+    def data_member?(member)
+      self.class.send(:data_member?, member)
+    end
+
+    def data_gandi_key_to_member(gandi_key)
+      self.class.send(:data_gandi_key_to_member, gandi_key)
+    end
+
+    def data_member_to_gandi_key(member)
+      self.class.send(:data_member_to_gandi_key, member)
+    end
+
+    def data_converter_for(member)
+      self.class.send(:data_converter_for, member)
+    end
+
+    def data_converter_for?(member)
+      self.class.send(:data_converter_for?, member)
+    end
+
+    def translate_gandi(data)
+      self.class.send(:translate_gandi, data)
+    end
+
+    def to_h_transform_enumerable(value)
+      method = :transform_keys if value.respond_to?(:transform_keys)
+      method ||= :map if value.respond_to?(:map)
+
+      value.send(method) do |v|
+        next to_h_transform_value(v) if v.is_a?(Enumerable)
+
+        v.respond_to?(:to_h) ? v.to_h : v
+      end
+    end
+
+    # Class methods to add to classes which include this module.
+    module ClassMethods
+      # Create a new instance with data from Gandi.
+      # @param data [Hash]
+      def from_gandi(data)
+        return nil if data.nil?
+
+        new(
+          translate_gandi(data).transform_keys(&:to_sym)
+                               .select { |k, _v| data_member?(k) }
+        )
+      end
+
+      private
+
+      def members(*names)
+        names.each do |name|
+          member name
+        end
+      end
+
+      def member(name, gandi_key: name.to_s, converter: nil, array: false)
+        @data_members.add name
+        @data_map_key_to_member[gandi_key] = name
+        @data_map_member_to_key[name] = gandi_key
+        convert_member_with(name, gandi_key, converter, array) if converter
+
+        define_method name do
+          instance_variable_get "@#{name}"
+        end
+
+        define_method "#{name}?" do
+          !instance_variable_get("@#{name}").nil?
+        end
+
+        define_method "#{name}=" do |value|
+          instance_variable_set("@#{name}", value)
+        end
+        private "#{name}="
+      end
+
+      # @api private
+      def data_members
+        instance_variable_get(:@data_members).to_a
+      end
+
+      # @api private
+      def data_member?(member)
+        instance_variable_get(:@data_members).include?(member)
+      end
+
+      # @api private
+      def data_gandi_key_to_member(gandi_key)
+        instance_variable_get(:@data_map_key_to_member).fetch(gandi_key)
+      end
+
+      # @api private
+      def data_member_to_gandi_key(member)
+        instance_variable_get(:@data_map_member_to_key).fetch(member)
+      end
+
+      # @api private
+      def data_converter_for(member)
+        instance_variable_get(:@data_converters)[member]
+      end
+
+      # @api private
+      def data_converter_for?(member)
+        instance_variable_get(:@data_converters).key?(member)
+      end
+
+      # @api private
+      def convert_member_with(name, gandi_key, converter, array)
+        converter = GandiV5::Data::Converter::ArrayOf.new(converter) if array
+        @data_converters[name] = converter
+        @data_converters[gandi_key] = converter
+      end
+
+      def translate_gandi(data)
+        return nil unless data.is_a?(Hash)
+
+        data = data.clone
+
+        # Do name mapping
+        @data_map_key_to_member.each do |key, member|
+          data[member] = data.delete(key) if data.key?(key)
+        end
+
+        # Do value conversions
+        data.each do |key, value|
+          converter = data_converter_for(key)
+          data[key] = converter.from_gandi(value) if converter
+        end
+
+        data
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain/auto_renew.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Automatic renewal information for a domain.
+    # @!attribute [r] dates
+    #   @return [nil, Array<Time>]
+    # @!attribute [r] duration
+    #   @return [nil, Integer]
+    # @!attribute [r] enabled
+    #   @return [nil, Boolean]
+    # @!attribute [r] org_id
+    #   @return [nil, String]
+    class AutoRenew
+      include GandiV5::Data
+
+      attr_accessor :domain
+
+      members :duration, :enabled, :org_id
+      member :dates, converter: GandiV5::Data::Converter::Time, array: true
+
+      # Disable auto renewal for the associated domain.
+      # @return [String] The confirmation message from Gandi.
+      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      def disable
+        body = { enabled: false }.to_json
+        data = GandiV5.patch url, body
+        self.enabled = false
+        data['message']
+      end
+
+      # Disable auto renewal for the associated domain.
+      # @param duration [Integer, #to_s] how long to renew for.
+      # @param org_id [String, #to_s] UUID of the organisation that should pay.
+      # @return [String] The confirmation message from Gandi.
+      # @raise [ArgumentError] if duration is invalid (not 1 to 9 (inclusive)).
+      # @raise [ArgumentError] if org_id is not passed and not set for this domain.
+      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      def enable(duration: self.duration || 1, org_id: self.org_id)
+        fail ArgumentError, 'duration can not be less than 1' if duration < 1
+        fail ArgumentError, 'duration can not be more than 9' if duration > 9
+        fail ArgumentError, 'org_id is required' if org_id.nil?
+
+        body = {
+          enabled: true,
+          duration: duration,
+          org_id: org_id
+        }.to_json
+
+        data = GandiV5.patch url, body
+        self.enabled = true
+        self.duration = duration
+        self.org_id = org_id
+        data['message']
+      end
+
+      private
+
+      def url
+        "#{BASE}domain/domains/#{CGI.escape domain.fqdn}/autorenew"
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain/contact.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Information for a single contact for a domain.
+    # @!attribute [r] country
+    #   @return [String] .
+    # @!attribute [r] email
+    #   @return [String] .
+    # @!attribute [r] family
+    #   @return [String] .
+    # @!attribute [r] given
+    #   @return [String] .
+    # @!attribute [r] address
+    #   @return [String] .
+    # @!attribute [r] type
+    #   @return [:person, :company, :association, :'public body', :reseller]
+    # @!attribute [r] brand_number
+    #   @return [nil, String]
+    # @!attribute [r] city
+    #   @return [nil, String]
+    # @!attribute [r] data_obfuscated
+    #   @return [nil, Boolean]
+    # @!attribute [r] extra_parameters
+    #   @return [nil, Hash]
+    # @!attribute [r] fax
+    #   @return [nil, String]
+    # @!attribute [r] jo_announce_number
+    #   @return [nil, String]
+    # @!attribute [r] jo_announce_page
+    #   @return [nil, String]
+    # @!attribute [r] jo_declaration_page
+    #   @return [nil, String]
+    # @!attribute [r] jo_publication_date
+    #   @return [nil, String]
+    # @!attribute [r] mail_obfuscated
+    #   @return [nil, Boolean]
+    # @!attribute [r] mobile
+    #   @return [nil, String]
+    # @!attribute [r] organisation_name
+    #   @return [nil, String] the legal name of the company, association, or public body
+    #     if the contact type is not :person.
+    # @!attribute [r] phone
+    #   @return [nil, String]
+    # @!attribute [r] reachability
+    #   @return [nil, :pending, :done, :failed, :deleted, :none]
+    # @!attribute [r] sharing_uuid
+    #   @return [nil, String]
+    # @!attribute [r] siren
+    #   @return [nil, String]
+    # @!attribute [r] state
+    #   @return [nil, String]
+    #     @see https://docs.gandi.net/en/rest_api/domain_api/contacts_api.html
+    # @!attribute [r] validation
+    #   @return [nil, :pending, :done, :failed, :deleted, :none]
+    # @!attribute [r] zip
+    #   @return [nil, String]
+    class Contact
+      include GandiV5::Data
+
+      TYPES = {
+        person: 'Person',
+        company: 'Company',
+        association: 'Association',
+        'public body': 'Public Body',
+        reseller: 'Reseller'
+      }.freeze
+      REACHABILITIES = %i[pending done failed deleted none].freeze
+      VALIDATIONS = %i[pending done failed deleted none].freeze
+
+      members :country, :email, :family, :given, :brand_number, :city, :data_obfuscated,
+              :extra_parameters, :fax, :jo_announce_number, :jo_announce_page,
+              :jo_declaration_page, :jo_publication_date, :mail_obfuscated,
+              :mobile, :phone, :siren, :state, :zip
+
+      member :organisation_name, gandi_key: 'orgname'
+      member :address, gandi_key: 'streetaddr'
+      member :sharing_uuid, gandi_key: 'sharing_id'
+
+      member(
+        :type,
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: ->(type) { TYPES.keys[type] },
+          to_gandi: ->(type) { TYPES.keys.index(type) }
+        )
+      )
+      member :reachability, converter: GandiV5::Data::Converter::Symbol
+      member :validation, converter: GandiV5::Data::Converter::Symbol
+
+      # Get the name for this contact.
+      # @return [String] e.g. "John Smith" or "Some Company LTD."
+      def name
+        type.eql?(:person) ? "#{given} #{family}" : organisation_name
+      end
+
+      # @return [String] Containing type and name.
+      def to_s
+        "#{TYPES[type]}\t#{name}"
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain/contract.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # A contract relevant to renewing/restoring a domain.
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] href
+    #   @return [nil, String]
+    # @!attribute [r] registry_contract_href
+    #   @return [nil, String]
+    class Contract
+      include GandiV5::Data
+
+      members :id, :name, :href, :registry_contract_href
+
+      alias contract_id id
+    end
+  end
+end

data/lib/gandi_v5/domain/dates.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Dates of key events for a domain.
+    # @!attribute [r] registry_created_at
+    #   @return [Time]
+    # @!attribute [r] updated_at
+    #   @return [Time]
+    # @!attribute [r] authinfo_expires_at
+    #   @return [nil, Time]
+    # @!attribute [r] created_at
+    #   @return [nil, Time]
+    # @!attribute [r] deletes_at
+    #   @return [nil, Time]
+    # @!attribute [r] hold_begins_at
+    #   @return [nil, Time]
+    # @!attribute [r] hold_ends_at
+    #   @return [nil, Time]
+    # @!attribute [r] pending_delete_ends_at
+    #   @return [nil, Time]
+    # @!attribute [r] registry_ends_at
+    #   @return [nil, Time]
+    # @!attribute [r] renew_begins_at
+    #   @return [nil, Time]
+    # @!attribute [r] restore_ends_at
+    #   @return [nil, Time]
+    class Dates
+      include GandiV5::Data
+
+      member :registry_created_at, converter: GandiV5::Data::Converter::Time
+      member :updated_at, converter: GandiV5::Data::Converter::Time
+      member :authinfo_expires_at, converter: GandiV5::Data::Converter::Time
+      member :created_at, converter: GandiV5::Data::Converter::Time
+      member :deletes_at, converter: GandiV5::Data::Converter::Time
+      member :hold_begins_at, converter: GandiV5::Data::Converter::Time
+      member :hold_ends_at, converter: GandiV5::Data::Converter::Time
+      member :pending_delete_ends_at, converter: GandiV5::Data::Converter::Time
+      member :registry_ends_at, converter: GandiV5::Data::Converter::Time
+      member :renew_begins_at, converter: GandiV5::Data::Converter::Time
+      member :restore_ends_at, converter: GandiV5::Data::Converter::Time
+    end
+  end
+end

data/lib/gandi_v5/domain/renewal_information.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Renewal information for a domain.
+    # @!attribute [r] begins_at
+    #   @return [Time]
+    # @!attribute [r] ends_at
+    #   @return [nil, Time]
+    # @!attribute [r] in_renew_period
+    #   @return [nil, Boolean]
+    # @!attribute [r] prohibited
+    #   @return [Boolean]
+    # @!attribute [r] durations
+    #   @return [Array<Integer>]
+    # @!attribute [r] maximum
+    #   @return [Integer]
+    # @!attribute [r] minimum
+    #   @return [Integer]
+    # @!attribute [r] contracts
+    #   @return [Array<GandiV5::Domain::Contract>]
+    class RenewalInformation
+      include GandiV5::Data
+
+      members :in_renew_period, :prohibited, :durations, :maximum, :minimum
+
+      member :begins_at, converter: GandiV5::Data::Converter::Time
+      member :ends_at, converter: GandiV5::Data::Converter::Time
+      member :contracts, converter: GandiV5::Domain::Contract, array: true
+
+      # Check if the domain is currently renewable.
+      # @return [Boolean]
+      def renewable?
+        return false if prohibited
+        return false if begins_at > Time.now
+
+        ends_at.nil? || ends_at >= Time.now
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain/restore_information.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Restoration information for a domain.
+    # @see https://docs.gandi.net/en/domain_names/renew/restore.html
+    # @!attribute [r] restorable
+    #   @return [Boolean]
+    # @!attribute [r] contracts
+    #   @return [nil, Array<GandiV5::Domain::Contract>]
+    class RestoreInformation
+      include GandiV5::Data
+
+      members :restorable, :contracts
+      member :contracts, converter: GandiV5::Domain::Contract, array: true
+    end
+  end
+end

data/lib/gandi_v5/domain/sharing_space.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Sharing space which contains a domain.
+    # @!attribute [r] uuid
+    #   @return [String]
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] reseller
+    #   @return [nil, Boolean]
+    class SharingSpace
+      include GandiV5::Data
+
+      members :name, :reseller
+      member :uuid, gandi_key: 'id'
+
+      alias sharing_space_uuid uuid
+    end
+  end
+end