gandi_v5 0.2.0 → 0.7.0

data/lib/gandi_v5/domain.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'domain/auto_renew'
-require_relative 'domain/availability'
-require_relative 'domain/contact'
-require_relative 'domain/contract'
-require_relative 'domain/dates'
-require_relative 'domain/renewal_information'
-require_relative 'domain/restore_information'
-require_relative 'domain/sharing_space'
-require_relative 'domain/tld'
-
 class GandiV5
   # Gandi Domain Management API.
   # @see https://api.gandi.net/docs/domains
@@ -221,10 +211,13 @@ class GandiV5
     # @param duration [Integer, #to_s] how long to renew for (in years).
     # @return [String] confirmation message from Gandi.
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-    def renew_for(duration = 1)
+    def renew_for(duration = 1, sharing_id: nil, dry_run: false)
       body = { duration: duration }.to_json
-      _response, data = GandiV5.post url('renew'), body
-      data['message']
+      url_ = url('renew')
+      url_ = sharing_id ? "#{url_}?sharing_id=#{sharing_id}" : url_
+
+      _response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
+      dry_run ? data : data['message']
     end
 
     # Restoration information for the domain.
@@ -280,10 +273,163 @@ class GandiV5
                                    .prices.first
     end
 
+    # LiveDNS information for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
+    # @return [GandiV5::Domain::LiveDNS]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def livedns
+      @livedns ||= fetch_livedns
+    end
+
+    # Requery Gandi for the domain's LiveDNS information.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
+    # @return [GandiV5::Domain::LiveDNS]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def fetch_livedns
+      _response, data = GandiV5.get url('livedns')
+      @livedns = GandiV5::Domain::LiveDNS.from_gandi data
+      @name_server = @livedns.current
+      @name_servers = @livedns.name_servers
+      @livedns
+    end
+
+    # Enable LiveDNS for the domain.
+    # If you want to disable LiveDNS, change the nameservers.
+    # Please note that if the domain is on the classic Gandi DNS,
+    # this will also perform a copy of all existing records immediately afterwards.
+    # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def enable_livedns
+      _response, data = GandiV5.post url('livedns')
+      data['message']
+    end
+
+    # Name servers for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
+    # @return [Array<String>]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def name_servers
+      @name_servers ||= fetch_name_servers
+    end
+
+    # Requery Gandi for the domain's name servers.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
+    # @return [Array<String>]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def fetch_name_servers
+      _response, data = GandiV5.get url('nameservers')
+      @name_servers = data
+    end
+
+    # Update name servers in Gandi.
+    # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
+    # @param nameservers [Array<String>] the name servers to use.
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def update_name_servers(nameservers)
+      _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
+      @name_servers = nameservers
+      data['message']
+    end
+
+    # Glue records for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
+    # @return [Hash<String => Array<String>>] name to list of IPs
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def glue_records
+      @glue_records ||= fetch_glue_records
+    end
+
+    # Requery Gandi for the domain's glue records.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
+    # @return [Hash<String => Array<String>>] name to list of IPs
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def fetch_glue_records
+      _response, data = GandiV5.get url('hosts')
+      @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
+    end
+
+    # Add a new glue record to the domain in Gandi.
+    # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
+    # @param ips [Array<String>] the IPs for the name.
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def add_glue_record(name, *ips)
+      _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
+      @glue_records ||= {}
+      @glue_records[name] = ips
+      data['message']
+    end
+
+    # Get a specific glue record for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
+    # @return [Hash<String => Array<String>>] name to list of IPs
+    # @return [nil] name was not found
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def glue_record(name)
+      records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
+      records.key?(name) ? records.select { |k, _v| k == name } : nil
+    end
+
+    # Update a specific glue record for the domain.
+    # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
+    # @param ips [Array<String>] the IPs for the name.
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def update_glue_record(name, *ips)
+      _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
+      @glue_records ||= {}
+      @glue_records[name] = ips
+      data['message']
+    end
+
+    # Delete a specific glue record for the domain.
+    # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def delete_glue_record(name)
+      _response, data = GandiV5.delete url('hosts', name)
+      @glue_records ||= {}
+      @glue_records.delete(name)
+      data['message']
+    end
+
+    # @see GandiV5::Email::Mailbox.list
+    def mailboxes(**params)
+      GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
+    end
+
+    # @see GandiV5::Email::Slot.list
+    def mailbox_slots(**params)
+      GandiV5::Email::Slot.list(**params, fqdn: fqdn)
+    end
+
+    # @see GandiV5::Email::Forward.list
+    def email_forwards(**params)
+      GandiV5::Email::Forward.list(**params, fqdn: fqdn)
+    end
+
     # Create (register) a new domain.
     # Warning! This is not a free operation. Please ensure your prepaid account has enough credit.
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains
     # @param fqdn [String, #to_s] the fully qualified domain name to create.
+    # @param dry_run [Boolean]
+    #   whether the details should be checked instead of actually creating the domain.
+    # @param sharing_id [String] either:
+    #   * nil (default) - nothing special happens
+    #   * an organization ID - pay using another organization
+    #     (you need to have billing permissions on the organization
+    #     and use the same organization name for the domain name's owner).
+    #     The invoice will be edited using this organization's information.
+    #   * a reseller ID - buy a domain for a customer using a reseller account
+    #     (you need to have billing permissions on the reseller organization
+    #     and have your customer's information for the owner).
+    #     The invoice will be edited using the reseller organization's information.
     # @param owner [GandiV5::Domain::Contact, #to_gandi, #to_h] (required)
     #   the owner of the new domain.
     # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h] (optional, defaults to owner)
@@ -308,25 +454,24 @@ class GandiV5
     # @param nameservers [Array<String>, #to_gandi, #to_json] (optional)
     #   List of nameservers. Gandi's LiveDNS nameservers are used if omitted..
     # @param price [Numeric, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
-    # @param reselle_id [String, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
+    # @param resellee_id [String, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
     # @param smd [String, #to_gandi, #to_json] (optional)
     #   Contents of a Signed Mark Data file (used for newgtld sunrises, tld_period must be sunrise).
     # @param tld_period ["sunrise", "landrush", "eap1", "eap2", "eap3", "eap4", "eap5", "eap6",
     #   "eap7", "eap8", "eap9", "golive", #to_gandi, #to_json] (optional)
     #   @see https://docs.gandi.net/en/domain_names/register/new_gtld.html
-    # @param dry_run [Boolean] whether the details should be checked
-    #   instead of actually creating the domain
     # @return [GandiV5::Domain] the created domain
     # @return [Hash] if doing a dry run, you get what Gandi returns
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error
-    def self.create(fqdn, dry_run: false, **params)
+    def self.create(fqdn, dry_run: false, sharing_id: nil, **params)
       fail ArgumentError, 'missing keyword: owner' unless params.key?(:owner)
 
       body = params.merge(fqdn: fqdn)
                    .transform_values { |val| val.respond_to?(:to_gandi) ? val.to_gandi : val }
                    .to_json
+      url_ = sharing_id ? "#{url}?sharing_id=#{sharing_id}" : url
 
-      response, data = GandiV5.post(url, body, 'Dry-Run': dry_run ? 1 : 0)
+      response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
       dry_run ? data : fetch(response.headers[:location].split('/').last)
     end
 
@@ -347,7 +492,7 @@ class GandiV5
     # @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 ot get per page.
+    # @param per_page [Integer, #to_s] (optional default 100) how many results to get per page.
     # @param fqdn [String, #to_s] (optional)
     #   filters the list by domain name, with optional patterns.
     #   e.g. "example.net", "example.*", "*ample.com"
@@ -356,25 +501,19 @@ class GandiV5
     # @return [Array<GandiV5::Domain>]
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.list(page: (1..), per_page: 100, **params)
-      page = [page.to_i] unless page.respond_to?(:each)
-
       domains = []
-      page.each do |page_number|
-        _resp, data = GandiV5.get url, params: params.merge(page: page_number, per_page: per_page)
-        break if data.empty?
-
+      GandiV5.paginated_get(url, page, per_page, params: params) do |data|
         domains += data.map { |domain| from_gandi domain }
-        break if data.count < per_page
       end
       domains
     end
 
     private
 
-    def url(extra = nil)
+    def url(*extra)
       "#{BASE}domain/domains/" +
         CGI.escape(fqdn) +
-        (extra ? "/#{extra}" : '')
+        (extra.empty? ? '' : "/#{extra.join('/')}")
     end
 
     def self.url(fqdn = nil)

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/domain/sharing_space.rb

@@ -7,14 +7,22 @@ class GandiV5
     #   @return [String]
     # @!attribute [r] name
     #   @return [String]
+    # @!attribute [r] type
+    #   @return [String]
     # @!attribute [r] reseller
     #   @return [nil, Boolean]
+    # @!attribute [r] reseller_details
+    #   @return [nil, GandiV5::Domain::SharingSpace]
     class SharingSpace
       include GandiV5::Data
 
-      members :name, :reseller
+      members :name, :type, :reseller
       member :uuid, gandi_key: 'id'
-
+      member(
+        :reseller_details,
+        gandi_key: 'sharing_space',
+        converter: GandiV5::Domain::SharingSpace
+      )
       alias sharing_space_uuid uuid
     end
   end

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,102 @@
+# 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..), per_page: 100, **params)
+        params.reject! { |_k, v| v.nil? }
+
+        mailboxes = []
+        GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
+          mailboxes += data.map { |mailbox| from_gandi mailbox.merge(fqdn: fqdn) }
+        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