gandi_v5 0.4.0 → 0.9.0

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A DNSSEC key for a domain's DNS records.
+      # @!attribute [r] uuid
+      #   @return [String]
+      # @!attribute [r] status
+      #   @return [String]
+      # @!attribute [r] fqdn
+      #   @return [String]
+      # @!attribute [r] algorithm_id
+      #   @return [Integer]
+      # @!attribute [r] algorithm_name
+      #   @return [String]
+      # @!attribute [r] deleted
+      #   @return [Boolean]
+      # @!attribute [r] ds
+      #   @return [String]
+      # @!attribute [r] flags
+      #   @return [Integer]
+      # @!attribute [r] fingerprint
+      #   @return [String]
+      # @!attribute [r] public_key
+      #   @return [String]
+      # @!attribute [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.
+        # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-keys-id
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn-keys-id
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains-fqdn-keys
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys-id
+        # @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,111 @@
+# 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.
+        # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-snapshots-id
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn-snapshots-id
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-snapshots
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-snapshots-id
+        # @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,74 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class LiveDNS
+    class Domain
+      # A Tsig key.
+      # @!attribute [r] uuid
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] secret
+      #   @return [String]
+      # @!attribute [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.
+        # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-axfr-tsig
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-axfr-tsig
+        # @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.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-axfr-tsig-id
+        # @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/sharing_space.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class GandiV5
+  # Sharing space which contains other billable items.
+  # @!attribute [r] uuid
+  #   @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, :type, :reseller
+    member :uuid, gandi_key: 'id'
+    member(
+      :reseller_details,
+      gandi_key: 'sharing_space',
+      converter: GandiV5::SharingSpace
+    )
+    alias sharing_space_uuid uuid
+  end
+end

data/lib/gandi_v5/simple_hosting.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Namespace for classes which access LiveDNS details.
+class GandiV5
+  # Gandi Simple Hosting management API.
+  # @see https://api.gandi.net/docs/simplehosting/
+  class SimpleHosting
+    # @see GandiV5::Simplehosting::Instance.list
+    def self.instances
+      GandiV5::SimpleHosting::Instance.list
+    end
+  end
+end

data/lib/gandi_v5/simple_hosting/instance.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+# Namespace for classes which access LiveDNS details.
+class GandiV5
+  class SimpleHosting
+    # A simple hosting instance.
+    # @see https://api.gandi.net/docs/simplehosting/
+    # @!attribute [r] uuid
+    #   @return [String]
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] size
+    #   @return [String] one of: s, s+, m, l, xl, xxl
+    # @!attribute [r] password_updated_at
+    #   @return [Time]
+    # @!attribute [r] created_at
+    #   @return [Time]
+    # @!attribute [r] expire_at
+    #   @return [Time]
+    # @!attribute [r] status
+    #   @return [Symbol] :waiting_bill, :being_created, :active
+    #                    :paused, :locked, :being_deleted
+    # @!attribute [r] snapshot_enabled
+    #   @return [Boolean]
+    # @!attribute [r] available_upgrade
+    #   @return [Boolean]
+    # @!attribute [r] is_trial
+    #   @return [Boolean]
+    # @!attribute [r] access_information
+    #   @return [Hash] as returned by Gandi.
+    # @!attribute [r] sharing_space
+    #   @return [GandiV5::SharingSpace] who pays for this instance.
+    # @!attribute [r] data_center
+    #   @return [String] code of the data center hosting this instance.
+    # @!attribute [r] storage
+    #   @return [Hash<Symbol => "#{number} #{unit}">]
+    #     storage split by :base, :additional and :total
+    # @!attribute [r] auto_renew
+    #   @return [string] "#{number} #{unit}".
+    # @!attribute [r] virtual_hosts
+    #   @return [Array<GandiV5::SimpleHosting::Instance::VirtualHost>]
+    # @!attribute [r] database
+    #   @return [GandiV5::SimpleHosting::Instance::Database]
+    # @!attribute [r] language
+    #   @return [GandiV5::SimpleHosting::Instance::Language]
+    # @!attribute [r] compatible_applications
+    #   @return [Array<GandiV5::SimpleHosting::Instance::Application>]
+    # @!attribute [r] upgrade_to
+    #   @return [Array<GandiV5::SimpleHosting::Instance::Upgrade>]
+    class Instance
+      include GandiV5::Data
+
+      members :name, :size, :password_updated_at, :created_at, :expire_at, :status,
+              :snapshot_enabled, :available_upgrade, :is_trial, :access_information
+
+      member :uuid, gandi_key: 'id'
+
+      member(
+        :sharing_space,
+        gandi_key: 'sharing_space',
+        converter: GandiV5::SharingSpace
+      )
+
+      member(
+        :data_center,
+        gandi_key: 'datacenter',
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: ->(hash) { hash['code'] }
+        )
+      )
+
+      member(
+        :storage,
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: lambda do |hash|
+            hash.transform_values { |value| "#{value['value']} #{value['unit']}" }
+                .transform_keys(&:to_sym)
+          end
+        )
+      )
+
+      member(
+        :auto_renew,
+        gandi_key: 'autorenew',
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: ->(hash) { "#{hash['duration']} #{hash['duration_type']}" }
+        )
+      )
+
+      member(
+        :virtual_hosts,
+        gandi_key: 'vhosts',
+        array: true,
+        converter: GandiV5::SimpleHosting::Instance::VirtualHost
+      )
+
+      member(
+        :database,
+        converter: GandiV5::SimpleHosting::Instance::Database
+      )
+
+      member(
+        :language,
+        converter: GandiV5::SimpleHosting::Instance::Language
+      )
+
+      member(
+        :compatible_applications,
+        array: true,
+        converter: GandiV5::SimpleHosting::Instance::Application
+      )
+
+      member(
+        :upgrade_to,
+        array: true,
+        converter: GandiV5::SimpleHosting::Instance::Upgrade
+      )
+
+      # Instruct Gandi to restart this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
+      # @return [String] confirmation message.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def restart
+        _response, data = GandiV5.post "#{url}/action", { 'action' => 'restart' }.to_json
+        data
+      end
+
+      # Instruct Gandi to console this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
+      # @return [String] confirmation message.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def console
+        _response, data = GandiV5.post "#{url}/action", { 'action' => 'console' }.to_json
+        data
+      end
+
+      # Instruct Gandi to reset the database password for this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
+      # @return [String] confirmation message.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def reset_database_password
+        _response, data = GandiV5.post(
+          "#{url}/action",
+          { 'action' => 'reset_database_password' }.to_json
+        )
+        data
+      end
+
+      # Requery Gandi fo this instance's information.
+      # @return [GandiV5::SimpleHosting::Instance]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def refresh
+        _response, data = GandiV5.get url
+        from_gandi data
+      end
+
+      # Check if this instance is waiting for a bill
+      # @return [Boolean]
+      def waiting_bill?
+        status == :waiting_bill
+      end
+
+      # Check if this instance is being created
+      # @return [Boolean]
+      def being_created?
+        status == :being_created
+      end
+
+      # Check if this instance is active
+      # @return [Boolean]
+      def active?
+        status == :active
+      end
+
+      # Check if this instance is paused
+      # @return [Boolean]
+      def paused?
+        status == :paused
+      end
+
+      # Check if this instance is locked
+      # @return [Boolean]
+      def locked?
+        status == :locked
+      end
+
+      # Check if this instance is being deleted
+      # @return [Boolean]
+      def being_deleted?
+        status == :being_deleted
+      end
+
+      # Get information on an instance.
+      # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances-instance_id
+      # @param uuid [String, #to_s] the UUID of the instance.
+      # @return [GandiV5::SimpleHosting::Instance]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(uuid)
+        _response, data = GandiV5.get url(uuid)
+        from_gandi data
+      end
+
+      # List instances.
+      # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances
+      # @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 sharing_id [String, #to_s] (optional)
+      #   filter the list by who pays the bill.
+      # @param size [String, #to_s] (optional)
+      #   filter the list by instance size (s, s+, m, i, xl, xxl).
+      # @param name [String, #to_s] (optional)
+      #   filter the list by instance name, allows * as wildcard.
+      # @param status [String, #to_s] (optional)
+      #   filter the list by the instance's status.
+      # @param fqdn [String, #to_s] (optional)
+      #   filter the list by the virtual host's domain name, allows * as wildcard.
+      # @param sort_by [String, #to_s] (optional default "created_at")
+      #   how to sort the list, prefix with a minus to reverse sort order.
+      # @return [Array<GandiV5::SimpleHosting::Instance>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list(page: (1..), per_page: 100, **params)
+        instances = []
+        GandiV5.paginated_get(url, page, per_page, params: params) do |data|
+          instances += data.map { |item| from_gandi item }
+        end
+        instances
+      end
+
+      private
+
+      def url
+        "#{BASE}simplehosting/instances/" +
+          CGI.escape(uuid)
+      end
+
+      def self.url(uuid = nil)
+        "#{BASE}simplehosting/instances" +
+          (uuid ? "/#{CGI.escape uuid}" : '')
+      end
+      private_class_method :url
+    end
+  end
+end