gandi_v5 0.2.0 → 0.3.0

data/lib/gandi_v5/domain/availability.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'availability/tax'
-require_relative 'availability/product'
-
 class GandiV5
   class Domain
     # Information about the availabillity of processes on a domain.

data/lib/gandi_v5/domain/availability/product.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'product/price'
-require_relative 'product/period'
-
 class GandiV5
   class Domain
     class Availability

data/lib/gandi_v5/domain/live_dns.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # LiveDNS information for a domain.
+    # @!attribute [r] current
+    #   @return [:classic, :livedns, :other]
+    #     type of nameservers currently set. classic corresponds to Gandi's classic nameservers,
+    #     livedns is for the new, default, Gandi nameservers and other is for custom nameservers.
+    # @!attribute [r] name_servers
+    #   @return [Array<String>] list of current nameservers.
+    # @!attribute [r] dnssec_available
+    #   @return [nil, Boolean] whether DNSSEC may be applied to the domain.
+    # @!attribute [r] livednssec_available
+    #   @return [nil, Boolean] whether DNSSEC with liveDNS may be applied to this domain.
+    class LiveDNS
+      include GandiV5::Data
+
+      members :dnssec_available, :livednssec_available
+      member :name_servers, gandi_key: 'nameservers'
+      member :current, converter: GandiV5::Data::Converter::Symbol
+
+      # Check if classic DNS is being used.
+      # @return [Boolean]
+      def classic?
+        current == :classic
+      end
+
+      # Check if custom DNS is being used.
+      # @return [Boolean]
+      def custom?
+        current == :custom
+      end
+
+      # Check if LiveDNS is being used.
+      # @return [Boolean]
+      def livedns?
+        current == :livedns
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain/renewal_information.rb

@@ -17,8 +17,6 @@ class GandiV5
     #   @return [Integer]
     # @!attribute [r] minimum
     #   @return [Integer]
-    # @!attribute [r] contracts
-    #   @return [Array<GandiV5::Domain::Contract>]
     class RenewalInformation
       include GandiV5::Data
 
@@ -26,7 +24,6 @@ class GandiV5
 
       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]

data/lib/gandi_v5/email.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'email/mailbox'
-require_relative 'email/offer'
-require_relative 'email/slot'
-
 class GandiV5
   # Gandi Email Mailbox Management API.
   class Email

data/lib/gandi_v5/email/forward.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Email
+    # A forwarding address that lives within a domain.
+    # @see https://docs.gandi.net/en/gandimail/forwarding_and_aliases/
+    # @!attribute [r] source
+    #   @return [String] the source email address ("alice" rather than "alice@example.com").
+    # @!attribute [r] destinations
+    #   @return [Array<String>] list of destination email addresses.
+    # @!attribute [r] fqdn
+    #   @return [String] domain name.
+    class Forward
+      include GandiV5::Data
+
+      members :source, :fqdn
+      member :destinations, array: true
+
+      # Delete the forwarding.
+      # @see https://api.gandi.net/docs/email/#delete-v5-email-forwards-domain-source
+      # @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 the forwarding.
+      # @see https://api.gandi.net/docs/email/#put-v5-email-forwards-domain-source
+      # @param destinations [Array<String, #to_s>] new list of destination email addresses.
+      # @return [String] The confirmation message from Gandi.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def update(*destinations)
+        fail ArgumentError, 'destinations can\'t be empty' if destinations.none?
+
+        _response, data = GandiV5.put url, { destinations: destinations }.to_json
+        @destinations = destinations.map(&:to_s)
+        data['message']
+      end
+
+      # Returns the string representation of the forwarding.
+      # @return [String]
+      def to_s
+        "#{source}@#{fqdn} -> #{destinations.join(', ')}"
+      end
+
+      # Create a new forward.
+      # @see https://api.gandi.net/docs/email/#post-v5-email-forwards-domain
+      # @param fqdn [String, #to_s] the fully qualified domain name for the forward.
+      # @param source [String, #to_s]
+      #   the source email address ("alice" rather than "alice@example.com").
+      # @param destinations [Array<String, #to_s>] list of destination email addresses.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.create(fqdn, source, *destinations)
+        fail ArgumentError, 'destinations can\'t be empty' if destinations.none?
+
+        body = {
+          source: source,
+          destinations: destinations
+        }.to_json
+        _response, _data = GandiV5.post url(fqdn), body
+
+        new fqdn: fqdn, source: source, destinations: destinations
+      end
+
+      # List forwards for a domain.
+      # @see https://api.gandi.net/docs/email/#get-v5-email-forwards-domain
+      # @param fqdn [String, #to_s] the fully qualified domain name for the forwards.
+      # @param page [Integer, #each<Integer>] which page(s) of results to get.
+      #   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 ot get per page.
+      # @param sort_by [#to_s] (optional default "login")
+      #   how to sort the results ("login", "-login").
+      # @param source [String] (optional) filter the source (pattern)
+      #   e.g. ("alice" "*lice", "alic*").
+      # @return [Array<GandiV5::Email::Forward>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list(fqdn, page: (1..), **params)
+        page = [page.to_i] unless page.respond_to?(:each)
+
+        params.reject! { |_k, v| v.nil? }
+
+        mailboxes = []
+        page.each do |page_number|
+          _response, data = GandiV5.get url(fqdn), params: params.merge(page: page_number)
+          break if data.empty?
+
+          mailboxes += data.map { |mailbox| from_gandi mailbox.merge(fqdn: fqdn) }
+          break if data.count < params.fetch(:per_page, 100)
+        end
+        mailboxes
+      end
+
+      private
+
+      def url
+        "#{BASE}email/forwards/#{CGI.escape fqdn}/#{CGI.escape source}"
+      end
+
+      def self.url(fqdn, source = nil)
+        "#{BASE}email/forwards/#{CGI.escape fqdn}" +
+          (source ? "/#{CGI.escape source}" : '')
+      end
+      private_class_method :url
+    end
+  end
+end

data/lib/gandi_v5/email/mailbox.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'mailbox/responder'
-
 class GandiV5
   class Email
     # A mailbox that lives within a domain.

data/lib/gandi_v5/error.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'error/gandi_error'
-
 class GandiV5
   # Generic error class for errors occuring using the API.
   class Error < RuntimeError

data/lib/gandi_v5/live_dns.rb

@@ -44,7 +44,3 @@ class GandiV5
     # rubocop:enable Style/GuardClause
   end
 end
-
-require_relative 'live_dns/record_set'
-require_relative 'live_dns/domain'
-require_relative 'live_dns/zone'

data/lib/gandi_v5/live_dns/domain.rb

@@ -9,6 +9,7 @@ class GandiV5
     #   @return [String]
     class Domain
       include GandiV5::Data
+      include GandiV5::LiveDNS::HasZoneRecords
 
       members :fqdn
 
@@ -26,150 +27,6 @@ class GandiV5
         from_gandi data
       end
 
-      # @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
-
       # Change the zone used by this domain.
       # @param uuid [String, #uuid, #to_s] the UUID of the zone this domain should now use.
       # @return [String] The confirmation message from Gandi.

data/lib/gandi_v5/live_dns/has_zone_records.rb

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