gandi_v5 0.1.0 → 0.6.0

data/lib/gandi_v5/domain/auto_renew.rb

@@ -21,10 +21,10 @@ class GandiV5
 
       # Disable auto renewal for the associated domain.
       # @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 disable
         body = { enabled: false }.to_json
-        data = GandiV5.patch url, body
+        _response, data = GandiV5.patch url, body
         self.enabled = false
         data['message']
       end
@@ -35,7 +35,7 @@ class GandiV5
       # @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.
+      # @raise [GandiV5::Error::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
@@ -47,7 +47,7 @@ class GandiV5
           org_id: org_id
         }.to_json
 
-        data = GandiV5.patch url, body
+        _response, data = GandiV5.patch url, body
         self.enabled = true
         self.duration = duration
         self.org_id = org_id

data/lib/gandi_v5/domain/availability.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Information about the availabillity of processes on a domain.
+    # @!attribute [r] currency
+    #   @return [String]
+    # @!attribute [r] grid
+    #   @return [String]
+    # @!attribute [r] products
+    #   @return [Arrav<GandiV5::Domain::Availability::Product>]
+    # @!attribute [r] taxes
+    #   @return [Array<GandiV5::Domain::Availability::Tax>]
+    class Availability
+      include GandiV5::Data
+
+      members :currency, :grid
+      member :products, converter: GandiV5::Domain::Availability::Product, array: true
+      member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
+
+      # 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 processes [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 [GandiV5::Domain::Availability]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(fqdn, **options)
+        _response, data = GandiV5.get("#{BASE}domain/check", params: { name: fqdn }.merge(options))
+        GandiV5::Domain::Availability.from_gandi data
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    class Availability
+      # Information about an available product.
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] prices
+      #   @return [Array<GandiV5::Domain::Availability::Product::Price>]
+      # @!attribute [r] periods
+      #   @return [Array<GandiV5::Domain::Availability::Product::Period>]
+      # @!attribute [r] taxes
+      #   @return [Array<GandiV5::Domain::Availability::Tax>]
+      # @!attribute [r] process
+      #   @return [Symbol]
+      # @!attribute [r] status
+      #   @return [Symbol]
+      class Product
+        include GandiV5::Data
+
+        STATUSES = {
+          available: 'Domain name is available',
+          available_reserved: 'Domain name reserved under special conditions',
+          available_preorder: 'Domain name can be pre-ordered',
+          unavailable: 'Domain name is not available',
+          unavailable_premium: 'Domain name is not available',
+          unavailable_restricted: 'Domain name is not available (forbidden)',
+          error_invalid: 'Provided value is not a valid domain name',
+          error_refused: 'Service is temporarily down',
+          error_timeout: 'Service timed out, try the method again later',
+          error_unknown: 'Internal server error',
+          reserved_corporate: 'The TLD for the given domain name is reserved for ' \
+                              'Gandi Corporate Services customers',
+          pending: 'Result is not yet ready, try the method again later',
+          error_eoi: 'The TLD for the given domain name is in an ' \
+                     'Expression of Interest (EOI) period'
+        }.freeze
+
+        members :name
+        member :prices, converter: GandiV5::Domain::Availability::Product::Price, array: true
+        member :periods, converter: GandiV5::Domain::Availability::Product::Period, array: true
+        member :process, converter: GandiV5::Data::Converter::Symbol
+        member :status, converter: GandiV5::Data::Converter::Symbol
+        member :taxes, converter: GandiV5::Domain::Availability::Tax, array: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    class Availability
+      class Product
+        # Information about an available product.
+        # @!attribute [r] name
+        #   @return [String]
+        # @!attribute [r]
+        #   @return [Time] starts_at
+        # @!attribute [r]
+        #   @return [Time, nil] ends_at
+        class Period
+          include GandiV5::Data
+
+          members :name
+          member :starts_at, converter: GandiV5::Data::Converter::Time
+          member :ends_at, converter: GandiV5::Data::Converter::Time
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    class Availability
+      class Product
+        # Information about an available product.
+        # @!attribute [r] duration_unit
+        #   @return [String] time unit for the duration (e.g. y)
+        # @!attribute [r] max_duration
+        #   @return [Integer] maximum duration for which this price unit applies
+        # @!attribute [r] min_duration
+        #   @return [Integer] minimum duration for which this price unit applies.
+        # @!attribute [r] price_after_taxes
+        #   @return [Numeric] pricing after tax is applied
+        # @!attribute [r] price_before_taxes
+        #   @return [Numeric] pricing before tax is applied
+        # @!attribute [r] discount
+        #   @return [Boolean, nil] whether a discount is active on this price unit
+        # @!attribute [r] normal_price_after_taxes
+        #   @return [Numeric, nil] pricing after tax is applied, when no discount applies
+        # @!attribute [r] normal_price_before_taxes
+        #   @return [Numeric, nil] pricing before tax is applied, when no discount applies
+        # @!attribute [r] type
+        #   @return [String, nil]
+        class Price
+          include GandiV5::Data
+
+          members :duration_unit, :max_duration, :min_duration,
+                  :price_after_taxes, :price_before_taxes,
+                  :discount, :normal_price_after_taxes, :normal_price_after_taxes, :type
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    class Availability
+      # Information about tax due on a process/product.
+      # @!attribute [r] name
+      #   @return [String] name of the tax (e.g. VAT)
+      # @!attribute [r] rate
+      #   @return [Numeric] percentage rate of the tax (e.g. 20)
+      # @!attribute [r] type
+      #   @return [String] type of the tax (e.g. service)
+      class Tax
+        include GandiV5::Data
+
+        members :name, :rate, :type
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Information about a specific TLD (Top Level Domain).
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] full_tld
+    #   @return [String]
+    # @!attribute [r] authinfo_for_transfer
+    #   @return [Boolean] whether authinfo is required for a transfer.
+    # @!attribute [r] category
+    #   @return [String]
+    # @!attribute [r] change_owner
+    #   @return [Boolean] whther changing owner is pemritted.
+    # @!attribute [r] corporate
+    #   @return [Boolean] whether this is a corporate TLD.
+    # @!attribute [r] ext_trade
+    #   @return [Boolean]
+    # @!attribute [r] lock
+    #   @return [Boolean]
+    class TLD
+      include GandiV5::Data
+
+      members :name, :full_tld, :authinfo_for_transfer, :change_owner, :corporate, :ext_trade, :lock
+      member :category, converter: GandiV5::Data::Converter::Symbol
+
+      # List of available TLDs.
+      # @see https://api.gandi.net/docs/domains#get-v5-domain-tlds
+      # @return Array<GandiV5::Domain::TLD>
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list
+        GandiV5.get(url)
+               .last
+               .map { |tld| GandiV5::Domain::TLD.from_gandi tld }
+      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 [GandiV5::Domain::TLD]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(name)
+        _response, data = GandiV5.get url(name)
+        GandiV5::Domain::TLD.from_gandi data
+      end
+
+      private
+
+      def self.url(name = nil)
+        "#{BASE}domain/tlds" +
+          (name ? "/#{CGI.escape name}" : '')
+      end
+      private_class_method :url
+    end
+  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,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