gandi_v5 0.6.0 → 0.10.0

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # An application running on a simple hosting 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,20 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # A simple hosting 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
+      # A language running on a simple hosting instance.
+      # @!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,22 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # An available upgrade on a simple hosting 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,272 @@
+# frozen_string_literal: true
+
+# Namespace for classes which access LiveDNS details.
+class GandiV5
+  class SimpleHosting
+    class Instance
+      # A virtual host on a simple hosting instance.
+      # @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 virtual 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
+
+        # Delete the virtual host.
+        # @see https://api.gandi.net/docs/simplehosting/#delete-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
+        # @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 virtual host.
+        # @see https://api.gandi.net/docs/simplehosting/#patch-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
+        # @param application [GandiV5::SimpleHosting::Instance::Application, Hash]
+        # @param https_strategy [:http_only, :allow_http_and_https, :redirect_http_to_https]
+        # @param linked_dns_zone_allow_alteration [Boolean]
+        #   authorize Gandi to modify your DNS zone so that your vhost points to their
+        #   Simple Hosting public endpoints.
+        # @param linked_dns_zone_allow_alteration_override [Boolean]
+        #   authorize Gandi to override your DNS zone if there already is a record to
+        #   link your instance to your vhost fqdn.
+        # @return [GandiV5::SimpleHosting::Instance::VirtualHost] self.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        # rubocop:disable Metrics/MethodLength
+        def update(
+          application: nil,
+          https_strategy: nil,
+          linked_dns_zone_allow_alteration: nil,
+          linked_dns_zone_allow_alteration_override: false
+        )
+          https_strategy = case https_strategy
+                           when nil then nil
+                           when :http_only then 'HTTP_only'
+                           when :allow_http_and_https then 'allow_HTTP_and_HTTPS'
+                           when :redirect_http_to_https then 'redirect_HTTP_to_HTTPS'
+                           else
+                             fail ArgumentError,
+                                  "https_strategy #{https_strategy.inspect} is invalid"
+                           end
+
+          body = {}
+          body[:application] = application.to_h.slice(:name, :parameters) if application
+          body[:https_strategy] = https_strategy if https_strategy
+          unless linked_dns_zone_allow_alteration.nil?
+            body[:linked_dns_zone] = {
+              allow_alteration: linked_dns_zone_allow_alteration,
+              allow_alteration_override: linked_dns_zone_allow_alteration_override
+            }
+          end
+
+          _response, data = GandiV5.put url, body.to_json
+          from_gandi data
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        # 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 instance_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
+
+        # Create a new virtual host for an instance
+        # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-vhosts
+        # @param fqdn [String, #to_s] the fully qualified domain of the virtual host to create.
+        # @param application [GandiV5::SimpleHosting::Instance::Application, Hash]
+        # @param linked_dns_zone_allow_alteration [Boolean]
+        #   authorize Gandi to modify your DNS zone so that your vhost points to their
+        #   Simple Hosting public endpoints.
+        # @param linked_dns_zone_allow_alteration_override [Boolean]
+        #   authorize Gandi to override your DNS zone if there already is a record to
+        #   link your instance to your vhost fqdn.
+        # @return [GandiV5::SimpleHosting::Instance::VirtualHost]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.create(
+          instance_uuid,
+          fqdn,
+          application: nil,
+          linked_dns_zone_allow_alteration: nil,
+          linked_dns_zone_allow_alteration_override: false
+        )
+          body = { fqdn: fqdn }
+          body[:application] = application.to_h.slice(:name, :parameters) if application
+          unless linked_dns_zone_allow_alteration.nil?
+            body[:linked_dns_zone] = {
+              allow_alteration: linked_dns_zone_allow_alteration,
+              allow_alteration_override: linked_dns_zone_allow_alteration_override
+            }
+          end
+
+          _response, _data = GandiV5.post url(instance_uuid), body.to_json
+          fetch instance_uuid, fqdn
+        end
+
+        # List virtual hosts for an instance.
+        # @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

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class SimpleHosting
+    class Instance
+      class VirtualHost
+        # A DNS Zone linked to a virtual host on a simple hosting instance.
+        # @!attribute [r] allow_alteration
+        #   @return [Boolean]
+        # @!attribute [r] cname
+        #   @return [String]
+        # @!attribute [r] domain
+        #   @return [String]
+        # @!attribute [r] ipv4
+        #   @return [String]
+        # @!attribute [r] ipv6
+        #   @return [String]
+        # @!attribute [r] is_alterable
+        #   @return [Boolean]
+        # @!attribute [r] is_root
+        #   @return [Boolean]
+        # @!attribute [r] key
+        #   @return [String]
+        # @!attribute [r] txt
+        #   @return [String]
+        # @!attribute [r] last_checked_at
+        #   @return [Time]
+        # @!attribute [r] status
+        #   @return [Symbol] :altered, :livedns_conflict, :livedns_done, :livedns_error, :unknown
+        class LinkedDnsZone
+          include GandiV5::Data
+
+          members :allow_alteration, :is_alterable, :last_checked_at,
+                  :cname, :domain, :is_root, :ipv4, :ipv6, :key, :txt
+
+          member(
+            :status,
+            gandi_key: 'last_checked_status',
+            converter: GandiV5::Data::Converter::Symbol
+          )
+
+          # Check if the linked zone is currently in an altered state
+          # @return [Boolean]
+          def altered?
+            status == :altered
+          end
+
+          # Check if the linked zone is currently in a conflicted state
+          # @return [Boolean]
+          def livedns_conflict?
+            status == :livedns_conflict
+          end
+
+          # Check if the linked zone has been updated
+          # @return [Boolean]
+          def livedns_done?
+            status == :livedns_done
+          end
+
+          # Check if the linked zone had an error updating
+          # @return [Boolean]
+          def livedns_error?
+            status == :livedns_error
+          end
+
+          # Check if the linked zone is in an unknown state
+          # @return [Boolean]
+          def unknown?
+            status == :unknown
+          end
+        end
+      end
+    end
+  end
+end