gandi_v5 0.2.0 → 0.7.0

data/lib/gandi_v5/live_dns/domain/dnssec_key.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A DNSSEC key for a domain's DNS records.
+      # @!attribyte [r] uuid
+      #   @return [String]
+      # @!attribyte [r] status
+      #   @return [String]
+      # @!attribyte [r] fqdn
+      #   @return [String]
+      # @!attribyte [r] algorithm_id
+      #   @return [Integer]
+      # @!attribyte [r] algorithm_name
+      #   @return [String]
+      # @!attribyte [r] deleted
+      #   @return [Boolean]
+      # @!attribyte [r] ds
+      #   @return [String]
+      # @!attribyte [r] flags
+      #   @return [Integer]
+      # @!attribyte [r] fingerprint
+      #   @return [String]
+      # @!attribyte [r] public_key
+      #   @return [String]
+      # @!attribyte [r] tag
+      #   @return [String]
+      class DnssecKey
+        include GandiV5::Data
+
+        members :status, :fqdn, :deleted, :ds, :flags, :fingerprint, :public_key,
+                :tag, :algorithm_name
+
+        member :uuid, gandi_key: 'id'
+        member :algorithm_id, gandi_key: 'algorithm'
+
+        # Delete this key.
+        # @return [String] The confirmation message from Gandi.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def delete
+          _response, data = GandiV5.delete url
+          self.deleted = true
+          data['message']
+        end
+
+        # Undelete this key.
+        # @return [String] The confirmation message from Gandi.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def undelete
+          _response, data = GandiV5.patch url, { deleted: false }.to_json
+          self.deleted = false
+          data['message']
+        end
+
+        # Check if this is a zone signing key
+        # @return [Boolean]
+        def zone_signing_key?
+          flags == 256
+        end
+
+        # Check if this is a key signing key
+        # @return [Boolean]
+        def key_signing_key?
+          flags == 257
+        end
+
+        # Create a new DNSSEC key for a zone.
+        # @param fqdn [String, #to_s] the fully qualified domain to create the key for.
+        # @param flags [Integer, :key_signing_key, :zone_signing_key] the key's flags.
+        # @return [GandiV5::LiveDNS::Domain::DnssecKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.create(fqdn, flags)
+          flags = 256 if flags == :zone_signing_key
+          flags = 257 if flags == :key_signing_key
+          fail ArgumentError, 'flags is invalid' unless flags.is_a?(Integer)
+
+          response, _data = GandiV5.post url(fqdn), { flags: flags }.to_json
+          fetch fqdn, response.headers[:location].split('/').last
+        end
+
+        # Get keys for a FQDN from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name to get the keys for.
+        # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.list(fqdn)
+          _response, data = GandiV5.get url(fqdn)
+          data.map { |item| from_gandi item }
+        end
+
+        # Get DNSSEC key from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name the key was made for.
+        # @param uuid [String, #to_s] the UUID of the key to fetch.
+        # @return [GandiV5::LiveDNS::Domain::DnssecKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(fqdn, uuid)
+          _response, data = GandiV5.get url(fqdn, uuid)
+          from_gandi data
+        end
+
+        private
+
+        def url
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/keys/#{CGI.escape uuid}"
+        end
+
+        def self.url(fqdn, uuid = nil)
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/keys" +
+            (uuid ? "/#{CGI.escape uuid}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end

data/lib/gandi_v5/live_dns/domain/record.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A record set which comes from either a domain or zone.
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] ttl
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] values
+      #   @return [Array<String>]
+      class Record
+        include GandiV5::Data
+
+        member :type, gandi_key: 'rrset_type'
+        member :ttl, gandi_key: 'rrset_ttl', converter: GandiV5::Data::Converter::Integer
+        member :name, gandi_key: 'rrset_name'
+        member :values, gandi_key: 'rrset_values'
+
+        # Generate zone file lines for the record.
+        # @return [String]
+        def to_s
+          values.map do |value|
+            "#{name}\t#{ttl}\tIN\t#{type}\t#{value}"
+          end.join("\n")
+        end
+
+        GandiV5::LiveDNS::RECORD_TYPES.each do |t|
+          # Check the record type.
+          # @return [Boolean]
+          define_method "#{t.downcase}?" do
+            type.eql?(t)
+          end
+        end
+
+        # Check the TTL's value in seconds.
+        # @param number [Integer] the number of second(s) to check against.
+        # @return [Boolean]
+        def second?(number = 1)
+          ttl == number
+        end
+        alias seconds? second?
+
+        # Check the TTL's value in minutes.
+        # @param number [Integer] the number of minute(s) to check against.
+        # @return [Boolean]
+        def minute?(number = 1)
+          ttl == number * 60
+        end
+        alias minutes? minute?
+
+        # Check the TTL's value in hours.
+        # @param number [Integer] the number of hour(s) to check against.
+        # @return [Boolean]
+        def hour?(number = 1)
+          ttl == number * 3_600
+        end
+        alias hours? hour?
+
+        # Check the TTL's value in days.
+        # @param number [Integer] the number of day(s) to check against.
+        # @return [Boolean]
+        def day?(number = 1)
+          ttl == number * 86_400
+        end
+        alias days? day?
+
+        # Check the TTL's value in weeks.
+        # @param number [Integer] the number of week(s) to check against.
+        # @return [Boolean]
+        def week?(number = 1)
+          ttl == number * 604_800
+        end
+        alias weeks? day?
+      end
+    end
+  end
+end

data/lib/gandi_v5/live_dns/domain/snapshot.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A snapshot (backup) of a domain's DNS records.
+      # @!attribute [r] fqdn
+      #   @return [String]
+      # @!attribute [r] uuid
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] created_at
+      #   @return [Time]
+      # @!attribute [r] automatic
+      #   @return [Boolean]
+      class Snapshot
+        include GandiV5::Data
+
+        members :name, :automatic, :fqdn
+        member :created_at, converter: GandiV5::Data::Converter::Time
+        member :uuid, gandi_key: 'id'
+        member(
+          :records,
+          gandi_key: 'zone_data',
+          converter: GandiV5::LiveDNS::Domain::Record,
+          array: true
+        )
+
+        alias snapshot_uuid uuid
+
+        # Delete this snapshot.
+        # @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 this snapshot.
+        # @param name [String, #to_s] new name for the snapshot.
+        # @return [String] The confirmation message from Gandi.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def update(name:)
+          _response, data = GandiV5.patch url, { name: name }.to_json
+          self.name = name
+          data['message']
+        end
+
+        # Get snapshot details for this FQDN from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name to get the snapshots for.
+        # @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 to get per page.
+        # @param automatic [nil, Boolean] (optional) filter by automatic or manual snapshot.
+        # @return [Array<GandiV5::LiveDNS::Domain::Snapshot>]
+        # @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? }
+
+          snapshots = []
+          GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|
+            snapshots += data.map { |item| from_gandi item.merge(fqdn: fqdn) }
+          end
+          snapshots
+        end
+
+        # Get snapshot from Gandi.
+        # @param fqdn [String, #to_s] The fully qualified domain name the snapshot was made for.
+        # @param uuid [String, #to_s] the UUID of the snapshot to fetch.
+        # @return [GandiV5::LiveDNS::Domain::Snapshot]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(fqdn, uuid)
+          _response, data = GandiV5.get url(fqdn, uuid)
+          from_gandi data.merge(fqdn: fqdn)
+        end
+
+        # Get the records which makeup this snapshot (fetching from Gandi if required).
+        # @return [Array<GandiV5::LiveDNS::Domain::Record>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def records
+          return @records unless @records.nil?
+
+          @records = fetch_records
+        end
+
+        private
+
+        def fetch_records
+          _response, data = GandiV5.get url
+          data.fetch('zone_data').map { |item| GandiV5::LiveDNS::Domain::Record.from_gandi item }
+        end
+
+        def url
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/snapshots/#{CGI.escape uuid}"
+        end
+
+        def self.url(fqdn, snapshot_uuid = nil)
+          "#{BASE}livedns/domains/#{CGI.escape fqdn}/snapshots" +
+            (snapshot_uuid ? "/#{CGI.escape snapshot_uuid}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end

data/lib/gandi_v5/live_dns/domain/tsig_key.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A Tsig key.
+      # @!attribyte [r] uuid
+      #   @return [String]
+      # @!attribyte [r] name
+      #   @return [String]
+      # @!attribyte [r] secret
+      #   @return [String]
+      # @!attribyte [r] config_examples
+      #   @return [Hash<Symbol -> String>]
+      class TsigKey
+        include GandiV5::Data
+
+        member :secret
+        member :uuid, gandi_key: 'id'
+        member :name, gandi_key: 'key_name'
+        member(
+          :config_examples,
+          gandi_key: 'config_samples',
+          converter: GandiV5::Data::Converter.new(
+            from_gandi: ->(value) { value.transform_keys(&:to_sym) },
+            to_gandi: ->(_value) { nil }
+          )
+        )
+
+        # Create a new DNSSEC key for a zone.
+        # @param sharing_id [nil, String, #to_s]
+        # @return [GandiV5::LiveDNS::Domain::DnssecKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.create(sharing_id = nil)
+          url_ = url
+          url_ += "?sharing_id=#{CGI.escape sharing_id}" if sharing_id
+
+          _response, data = GandiV5.post url_
+          fetch data.fetch('id')
+        end
+
+        # Get keys from Gandi.
+        # If you need the secret, fingerprint, public_key or tag attributes you'll need
+        # to use GandiV5::LiveDNS::Domain::DnssecKey.fetch on each item.
+        # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.list
+          _response, data = GandiV5.get url
+          data.map { |item| from_gandi item }
+        end
+
+        # Get Tsig key from Gandi.
+        # @param uuid [String, #to_s] the UUID of the key to fetch.
+        # @return [GandiV5::LiveDNS::Domain::TsigKey]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(uuid)
+          _response, data = GandiV5.get url(uuid)
+          from_gandi data
+        end
+
+        private
+
+        def self.url(uuid = nil)
+          "#{BASE}livedns/axfr/tsig" +
+            (uuid ? "/#{CGI.escape uuid}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end

data/lib/gandi_v5/organization.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'email/mailbox'
-require_relative 'email/offer'
-require_relative 'email/slot'
-
 class GandiV5
   # The Organization API is a read-only API.
   # All organization management must be performed via the web interface.
@@ -54,13 +50,50 @@ class GandiV5
 
     alias organization_uuid uuid
 
+    # @see GandiV5::Organization::Customer.list
+    def customers(org_uuid, **params)
+      GandiV5::Organization::Customer.list(org_uuid, **params)
+    end
+
+    # @see GandiV5::Organization::Customer.create
+    def create_customer(org_uuid, **params)
+      GandiV5::Organization::Customer.create(org_uuid, **params)
+    end
+
     # Get information about the current authenticated user.
     # @see https://api.gandi.net/docs/organization#get-v5-organization-user-info
     # @return [GandiV5::Organization]
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.fetch
-      _response, data = GandiV5.get "#{BASE}organization/user-info"
+      _response, data = GandiV5.get "#{url}/user-info"
       from_gandi data
     end
+
+    # List organisations.
+    # @see https://api.gandi.net/docs/domains#get-v5-organization-organizations
+    # @param name [String, #to_s] (optional)
+    #   filters the list by name, with optional patterns.
+    #   e.g. "alice", "ali*", "*ice"
+    # @param type [String, #to_s] (optional)
+    #   filters the list by type of organization.
+    #   One of: "individual", "company", "association", "publicbody"
+    # @param permission [String, #to_s] (optional)
+    #   filters the list by the permission the authenticated user
+    #   has on that organization and products in it.
+    # @param sort_by [String, #to_s] (optional default "name") how to sort the list.
+    # @return [Array<GandiV5::Organization>]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def self.list(**params)
+      params['~name'] = params.delete(:name) if params.key?(:name)
+      _resp, data = GandiV5.get "#{url}/organizations", params: params
+      data.map { |organisation| from_gandi organisation }
+    end
+
+    private
+
+    def self.url
+      "#{BASE}organization"
+    end
+    private_class_method :url
   end
 end

data/lib/gandi_v5/organization/customer.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Organization
+    # A customer of a reseller organization
+    # @!attribute [r] id
+    #   @return [String] The main identifier of the customer.
+    #                    Also known as sharing_id in many routes.
+    # @!attribute [r] email
+    #   @return [String] Email of the customer.
+    # @!attribute [r] first_name
+    #   @return [String] First name of the customer.
+    # @!attribute [r] last_name
+    #   @return [String] Last name of the customer.
+    # @!attribute [r] name
+    #   @return [String] Name of the customer.
+    # @!attribute [r] type
+    #   @return [:individual, :company, :association, :publicbody]
+    # @!attribute [r] org_name
+    #   @return [nil, String] Organization legal name of the customer..
+    class Customer
+      include GandiV5::Data
+
+      members :email, :name
+      member :uuid, gandi_key: 'id'
+      member :first_name, gandi_key: 'firstname'
+      member :last_name, gandi_key: 'lastname'
+      member :org_name, gandi_key: 'orgname'
+      member :type, converter: GandiV5::Data::Converter::Symbol
+
+      # Create a new customer for this organization.
+      # @see https://api.gandi.net/docs/organization/#post-v5-organization-organizations-id-customers
+      # @param org_uuid [String] UUID of the organization to create the customer for.
+      # @param firstname [String, #to_s] (required) Customer's first name.
+      # @param lastname [String, #to_s] (required) Customer's last name.
+      # @param type [String, #to_s] (required) Type of customer
+      #   ("individual", "company", "association" or "publicbody").
+      # @param streetaddr [String, #to_s] (required) Customer's street address.
+      # @param city [String, #to_s] (required) Customer's city.
+      # @param country [String, #to_s] (required) Customer's country.
+      # @param email [String, #to_s] (required) Customer's email address.
+      # @param phone [String, #to_s] (required) Customer's phone number.
+      # @param fax [String, #to_s] (optional) Customer's fax number.
+      # @param streetaddr2 [String, #to_s] (optional) Customer's street address (2nd line).
+      # @param state [String, #to_s] (optional) Customer's state/province/region.
+      # @param zip [String, #to_s] (optional) Customer's postal/zip code.
+      # @param reference [String, #to_s] (optional)
+      #   Optional text to display on the invoice, such as your own customer reference info.
+      # @param orgname [String, #to_s] (optional) Customer Organization's legal name.
+      # @return [nil]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def self.create(org_uuid, **params)
+        %i[city country email firstname lastname phone streetaddr type].each do |attr|
+          fail ArgumentError, "missing keyword: #{attr}" unless params.key?(attr)
+        end
+        unless %w[individual company association publicbody].include?(params[:type].to_s)
+          fail ArgumentError, "invalid type: #{params[:type].inspect}"
+        end
+
+        _response, _data = GandiV5.post(url(org_uuid), params.to_json)
+        nil
+      end
+
+      # List organisation's customers.
+      # @see https://api.gandi.net/docs/organization/#get-v5-organization-organizations-id-customers
+      # @param org_uuid [String] UUID of the organization to fetch customers for.
+      # @param name [String, #to_s] (optional)
+      #   filters the list by name, with optional patterns.
+      #   e.g. "alice", "ali*", "*ice"
+      # @param permission [String, #to_s] (optional)
+      #   filters the list by the permission the authenticated user has on
+      #   that organization and products in it.
+      # @param sort_by [String, #to_s] (optional default "name") how to sort the list.
+      # @return [Array<GandiV5::Organization>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list(org_uuid, **params)
+        params['~name'] = params.delete(:name) if params.key?(:name)
+        _resp, data = GandiV5.get url(org_uuid), params: params
+        data.map { |organisation| from_gandi organisation }
+      end
+
+      private
+
+      def self.url(org_uuid)
+        "#{BASE}organization/organizations/#{org_uuid}/customers"
+      end
+      private_class_method :url
+    end
+  end
+end