gandi_v5 0.3.0 → 0.8.0

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,12 @@
+# frozen_string_literal: true
+
+# Namespace for classes which access LiveDNS details.
+class GandiV5
+  # Gandi Simple Hosting management API.
+  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,242 @@
+# 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.
+      # @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.
+      # @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.
+      # @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

data/lib/gandi_v5/simple_hosting/instance/application.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] parameters
+      #   @return [String]
+      # @!attribute [r] status
+      #   @return [Symbol] :error, :running, :being_created, :cancelled
+      class Application
+        include GandiV5::Data
+
+        members :name, :parameters
+        member :status, converter: GandiV5::Data::Converter::Symbol
+
+        # Check if the appliaction is currently being created
+        # @return [Boolean]
+        def being_created?
+          status == :being_created
+        end
+
+        # Check if the appliaction has been cancelled
+        # @return [Boolean]
+        def cancelled?
+          status == :cancelled
+        end
+
+        # Check if the appliaction is running
+        # @return [Boolean]
+        def running?
+          status == :running
+        end
+
+        # Check if the appliaction is in an error condition
+        # @return [Boolean]
+        def error?
+          status == :error
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/simple_hosting/instance/database.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] status
+      #   @return [String]
+      # @!attribute [r] version
+      #   @return [String]
+      class Database
+        include GandiV5::Data
+
+        members :name, :status, :version
+      end
+    end
+  end
+end

data/lib/gandi_v5/simple_hosting/instance/language.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # Sharing space which contains other billable items.
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] single_application
+      #   @return [Boolean]
+      # @!attribute [r] status
+      #   @return [String]
+      # @!attribute [r] version
+      #   @return [String]
+      class Language
+        include GandiV5::Data
+
+        members :name, :single_application, :status, :version
+      end
+    end
+  end
+end

data/lib/gandi_v5/simple_hosting/instance/upgrade.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] status
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String] "database" or "language"
+      # @!attribute [r] version
+      #   @return [String]
+      class Upgrade
+        include GandiV5::Data
+
+        members :name, :status, :type, :version
+      end
+    end
+  end
+end

data/lib/gandi_v5/simple_hosting/instance/virtual_host.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+# Namespace for classes which access LiveDNS details.
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # A simple hosting virtual host.
+      # @see https://api.gandi.net/docs/simplehosting/
+      # @!attribute [r] created_at
+      #   @return [Time]
+      # @!attribute [r] fqdn
+      #   @return [String] fully qualified domain name of the virtual host.
+      # @!attribute [r] instance_uuid
+      #   @return [String] UUID of the simple hosting instance which 'owns' the host.
+      # @!attribute [r] is_a_test_virtual_host
+      #   @return [Boolean]
+      # @!attribute [r] status
+      #   @return [Symbol] :being_created, :running, :being_deleted,
+      #                    :locked, :waiting_ownership, :ownership_validated,
+      #                    :validation_failed
+      # @!attribute [r] https_strategy
+      #   @return [Symbol] :http_only, :allow_http_and_https,
+      #                    :redirect_http_to_https
+      # @!attribute [r] Application
+      #   @return [GandiV5::SimpleHosting::Instance::Application]
+      # @!attribute [r] certificates
+      #   @return [Hash<String => Boolean>] Hash - certificate ID to pendingness
+      # @!attribute [r] linked_dns_zone
+      #   @return [GandiV5::SimpleHosting::Instance::VirtualHost::LinkedDnsZone]
+      class VirtualHost
+        include GandiV5::Data
+
+        members :created_at, :fqdn, :instance_uuid
+
+        member :is_a_test_virtual_host, gandi_key: 'is_a_test_vhost'
+        member :status, converter: GandiV5::Data::Converter::Symbol
+
+        member(
+          :https_strategy,
+          converter: GandiV5::Data::Converter.new(from_gandi: ->(data) { data.downcase.to_sym })
+        )
+
+        member(
+          :application,
+          converter: GandiV5::SimpleHosting::Instance::Application
+        )
+
+        member(
+          :certificates,
+          converter: GandiV5::Data::Converter.new(
+            from_gandi: ->(array) { Hash[array.map { |h| [h['id'], h['pending']] }] }
+          )
+        )
+
+        member(
+          :linked_dns_zone,
+          converter: GandiV5::SimpleHosting::Instance::VirtualHost::LinkedDnsZone
+        )
+
+        # Requery Gandi fo this hosts's information.
+        # @return [GandiV5::SimpleHosting::Instance::VirtualHost]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def refresh
+          _response, data = GandiV5.get url
+          from_gandi data
+        end
+
+        # Check if the virtual host is being created
+        # @return [Boolean]
+        def being_created?
+          status == :being_created
+        end
+
+        # Check if the virtual host is running
+        # @return [Boolean]
+        def running?
+          status == :running
+        end
+
+        # Check if the virtual host is being deleted
+        # @return [Boolean]
+        def being_deleted?
+          status == :being_deleted
+        end
+
+        # Check if the virtual host is locked
+        # @return [Boolean]
+        def locked?
+          status == :locked
+        end
+
+        # Check if the virtual host is waiting for an ownership check
+        # @return [Boolean]
+        def waiting_ownership?
+          status == :waiting_ownership
+        end
+
+        # Check if the virtual host has it's ownership validated
+        # @return [Boolean]
+        def ownership_validated?
+          status == :ownership_validated
+        end
+
+        # Check if the virtual host failed it's ownership check
+        # @return [Boolean]
+        def validation_failed?
+          status == :validation_failed
+        end
+
+        # Check if the virtual host is serving HTTP only
+        # @return [Boolean]
+        def http_only?
+          https_strategy == :http_only
+        end
+
+        # Check if the virtual host is serving HTTP and HTTPS
+        # @return [Boolean]
+        def http_and_https?
+          https_strategy == :http_and_https
+        end
+
+        # Check if the virtual host is serving HTTPS and redirecting HTTP to HTTPS
+        # @return [Boolean]
+        def redirect_http_to_https?
+          https_strategy == :redirect_http_to_https
+        end
+
+        # Check if the virtual host is serving HTTP requests
+        # @return [Boolean]
+        def http?
+          https_strategy == :http_only || https_strategy == :http_and_https
+        end
+
+        # Check if the virtual host is serving HTTPS requests
+        # @return [Boolean]
+        def https?
+          https_strategy == :http_and_https
+        end
+
+        # Get information on a virtual host.
+        # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
+        # @param uuid [String, #to_s] the UUID of the simple hosting instance.
+        # @param fqdn [String, #to_s] the fully qualified domain name of the virtual host.
+        # @return [GandiV5::SimpleHosting::Instance]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.fetch(instance_uuid, fqdn)
+          _response, data = GandiV5.get url(instance_uuid, fqdn)
+          from_gandi data.merge('instance_uuid' => instance_uuid)
+        end
+
+        # List instances.
+        # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances-instance_id-vhosts
+        # @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 status [String, #to_s] (optional)
+        #   filter the list by the virtual host'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::VirtualHost>]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.list(instance_uuid, page: (1..), per_page: 100, **params)
+          instances = []
+          GandiV5.paginated_get(url(instance_uuid), page, per_page, params: params) do |data|
+            instances += data.map { |item| from_gandi item.merge('instance_uuid' => instance_uuid) }
+          end
+          instances
+        end
+
+        private
+
+        def url
+          "#{BASE}simplehosting/instances/#{instance_uuid}/vhosts/#{CGI.escape(fqdn)}"
+        end
+
+        def self.url(instance_uuid, fqdn = nil)
+          "#{BASE}simplehosting/instances/#{instance_uuid}/vhosts" +
+            (fqdn ? "/#{CGI.escape fqdn}" : '')
+        end
+        private_class_method :url
+      end
+    end
+  end
+end