gandi_v5 0.1.0 → 0.6.0

data/lib/gandi_v5/billing.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'billing/info'
-
 class GandiV5
   # Gandi Billing API.
   # @see https://api.gandi.net/docs/billing
@@ -11,9 +9,9 @@ class GandiV5
     # @param url [sharing_id] the Sharing ID of the organisation to get info for
     #   defaults to the user the api key belomgs to.
     # @return [GandiV5::Billing::Info]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.info(sharing_id = nil)
-      data = GandiV5.get url(sharing_id)
+      _response, data = GandiV5.get url(sharing_id)
       GandiV5::Billing::Info.from_gandi data
     end
 

data/lib/gandi_v5/billing/info.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'info/prepaid'
-
 class GandiV5
   class Billing
     # Account's information.

data/lib/gandi_v5/data.rb

@@ -1,7 +1,5 @@
 # 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.
@@ -181,6 +179,7 @@ class GandiV5
         define_method "#{name}=" do |value|
           instance_variable_set("@#{name}", value)
         end
+
         private "#{name}="
       end
 

data/lib/gandi_v5/data/converter.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'converter/array_of'
-require_relative 'converter/symbol'
-require_relative 'converter/time'
-
 class GandiV5
   module Data
     # Namespace for converters to/from Gandi's format.

data/lib/gandi_v5/data/converter/integer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class GandiV5
+  module Data
+    class Converter
+      # Methods for converting strings to/from integerss.
+      class Integer
+        # @param value [Integer]
+        # @return [String]
+        def self.to_gandi(value)
+          return nil if value.nil?
+
+          value.to_s
+        end
+
+        # @param [String]
+        # @return value [Integer]
+        def self.from_gandi(value)
+          return nil if value.nil?
+
+          value.to_i
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/domain.rb

@@ -1,29 +1,5 @@
 # frozen_string_literal: true
 
-# TODO: Add method renewal_price(currency: 'GBP', period: 1, sharing_id: self.sharing_id)
-
-# TODO: Glue Record Management
-#  * get-v5-domain-domains-domain-hosts
-#  * post-v5-domain-domains-domain-hosts
-# TODO: Glue Record Information
-#  * get-v5-domain-domains-domain-hosts-name
-#  * put-v5-domain-domains-domain-hosts-name
-#  * delete-v5-domain-domains-domain-hosts-name
-# TODO: LiveDNS Management
-#  * get-v5-domain-domains-domain-livedns
-#  * post-v5-domain-domains-domain-livedns
-# TODO: Nameservers Management
-#  * get-v5-domain-domains-domain-nameservers
-#  * put-v5-domain-domains-domain-nameservers
-
-require_relative 'domain/auto_renew'
-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'
-
 class GandiV5
   # Gandi Domain Management API.
   # @see https://api.gandi.net/docs/domains
@@ -175,7 +151,7 @@ class GandiV5
     # Contacts for the domain.
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
     # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def contacts
       @contacts ||= fetch_contacts
     end
@@ -183,9 +159,9 @@ class GandiV5
     # Requery Gandi for the domain's contacts.
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-contacts
     # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def fetch_contacts
-      data = GandiV5.get url('contacts')
+      _response, data = GandiV5.get url('contacts')
       self.contacts = data.transform_keys(&:to_sym)
       CONTACTS_CONVERTER.call contacts
     end
@@ -199,7 +175,7 @@ class GandiV5
     # @param tech [GandiV5::Domain::Contact, #to_gandi, #to_h]
     #   details for the new technical contact.
     # @return [Hash{:owner, :admin, :bill, :tech => GandiV5::Domain::Contact}]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def update_contacts(admin: nil, bill: nil, tech: nil)
       body = {
         admin: admin.respond_to?(:to_gandi) ? admin.to_gandi : admin,
@@ -214,7 +190,7 @@ class GandiV5
     # Renewal information for the domain.
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
     # @return [GandiV5::Domain::RenewalInformation]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def renewal_information
       @renewal_information ||= fetch_renewal_information
     end
@@ -222,9 +198,9 @@ class GandiV5
     # Requery Gandi for the domain's renewal information.
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-renew
     # @return [GandiV5::Domain::RenewalInformation]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def fetch_renewal_information
-      data = GandiV5.get url('renew')
+      _response, data = GandiV5.get url('renew')
       data = data['renew'].merge('contracts' => data['contracts'])
       @renewal_information = GandiV5::Domain::RenewalInformation.from_gandi data
     end
@@ -234,31 +210,32 @@ class GandiV5
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-renew
     # @param duration [Integer, #to_s] how long to renew for (in years).
     # @return [String] confirmation message from Gandi.
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-    def renew_for(duration = 1)
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def renew_for(duration = 1, sharing_id: nil, dry_run: false)
       body = { duration: duration }.to_json
-      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
 
-    # TODO: Test when I have a restorable domain
     # Restoration information for the domain.
     # @see https://docs.gandi.net/en/domain_names/renew/restore.html
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
     # @return [GandiV5::Domain::RestoreInformation]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def restore_information
       @restore_information ||= fetch_restore_information
     end
 
-    # TODO: Test when I have a restorable domain
     # Requery Gandi for the domain's restore information.
     # @see https://docs.gandi.net/en/domain_names/renew/restore.html
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-restore
     # @return [GandiV5::Domain::RestoreInformation]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def fetch_restore_information
-      data = GandiV5.get url('restore')
+      _response, data = GandiV5.get url('restore')
       @restore_information = GandiV5::Domain::RestoreInformation.from_gandi data
     rescue RestClient::NotFound
       @restore_information = GandiV5::Domain::RestoreInformation.from_gandi restorable: false
@@ -269,25 +246,190 @@ class GandiV5
     # @see https://docs.gandi.net/en/domain_names/renew/restore.html
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-restore
     # @return [String] The confirmation message from Gandi.
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def restore
-      data = GandiV5.post url('restore'), '{}'
+      _response, data = GandiV5.post url('restore'), '{}'
       data['message']
     end
 
     # Requery Gandi fo this domain's information.
     # @return [GandiV5::Domain]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def refresh
-      data = GandiV5.get url
+      _response, data = GandiV5.get url
       from_gandi data
       auto_renew.domain = self
     end
 
+    # Get the price for renewing this domain.
+    # @param currency [String] the currency to get the price in (e.g. GBP)
+    # @param period [Integer] the number of year(s) renewal to get the price for
+    # @return [GandiV5::Domain::Availability::Product::Price]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+    def renewal_price(currency: 'GBP', period: 1)
+      arguments = { processes: [:renew], currency: currency, period: period }
+      GandiV5::Domain::Availability.fetch(fqdn, **arguments)
+                                   .products.first
+                                   .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)
@@ -312,34 +454,34 @@ 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 [Hash] if actually creating, you get what Gandi returns.
-    # @return [Hash] if doing a dry run, you get what Gandi returns.
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-    # TODO: Return created domain unless dry_run
-    def self.create(fqdn, dry_run: false, **params)
+    # @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, 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
-      GandiV5.post url, body, 'Dry-Run': dry_run ? 1 : 0
+      url_ = sharing_id ? "#{url}?sharing_id=#{sharing_id}" : url
+
+      response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
+      dry_run ? data : fetch(response.headers[:location].split('/').last)
     end
 
     # Get information on a domain.
     # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain
     # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
     # @return [GandiV5::Domain]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.fetch(fqdn)
-      data = GandiV5.get url(fqdn)
+      _response, data = GandiV5.get url(fqdn)
       domain = from_gandi data
       domain.auto_renew.domain = fqdn
       domain
@@ -357,13 +499,13 @@ class GandiV5
     # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
     # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
     # @return [Array<GandiV5::Domain>]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @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|
-        data = GandiV5.get url, params: params.merge(page: page_number, per_page: per_page)
+        _resp, data = GandiV5.get url, params: params.merge(page: page_number, per_page: per_page)
         break if data.empty?
 
         domains += data.map { |domain| from_gandi domain }
@@ -372,54 +514,12 @@ class GandiV5
       domains
     end
 
-    # Check domain availability and pricing.
-    # @see https://api.gandi.net/docs/domains#get-v5-domain-check
-    # @param fqdn [String, #to_s] the fully qualified domain name to check.
-    # @param country [String, #to_s] (optional) ISO country code for which taxes are to be applied.
-    # @param currency [String, #to_s] (optional) request price for a specific ISO currency code.
-    # @param duration_unit [String, #to_s] (optional) define the unit for max_duration.
-    # @param extension [String, #to_s] (optional) query a specific extension for product options.
-    # @param grid [String, #to_s] (optional) request price for a specific rate.
-    # @param lang [String, #to_s] (optional) language code.
-    # @param max_duration [Integer, #to_s] (optional)
-    #   set a limit on the duration range for returned prices.
-    # @param period [String, #to_s] (optional) specific registration period to query.
-    # @param _ [Array<:create, :renew, :transfer etc.>] (optional default [:create])
-    #   list of at least 1 process for which pricing is to be made.
-    # @param sharing_id [String, #to_s] (optional) organization for which the pricing is to be made.
-    # @return [Hash]
-    # TODO: Return an Availabillity object ???
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-    def self.availability(fqdn, **options)
-      GandiV5.get "#{BASE}domain/check", params: { name: fqdn }.merge(options)
-    end
-
-    # List of available TLDs.
-    # @see https://api.gandi.net/docs/domains#get-v5-domain-tlds
-    # @return Array<String>
-    # TODO: Maybe return an array of TLD objects ???
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-    def self.tlds
-      GandiV5.get("#{BASE}domain/tlds")
-             .map { |hash| hash['name'] }
-    end
-
-    # Get TLD information.
-    # @see https://api.gandi.net/docs/domains#get-v5-domain-tlds-name
-    # @param name [String, #to_s] the top level domain to get information for.
-    # @return [Hash]
-    # TODO: Return a TLD object ???
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-    def self.tld(name)
-      GandiV5.get("#{BASE}domain/tlds/#{CGI.escape name}").transform_keys(&:to_sym)
-    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)