gandi_v5 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bfa3d695cec03737e8e5c3639c7744300babd00d59081f4edf14f013d2e9787
-  data.tar.gz: ce687383ed1d014889d22e9d33a068dad8a8dc8ec2a73a38c9150014195a3f0b
+  metadata.gz: cc90c3434cb1207a7eed04d4b2331039f8ac8e32e2861e4d3693b034658eabb1
+  data.tar.gz: 51b125b39d4b4fe71a2fc4f55815bf8c4e5c94a5d7e01bfd9e104be1886a91fa
 SHA512:
-  metadata.gz: a2752f84704fbd326503b2bada3e3193d2215abc6c19e1b71198b29eabaf4e67f473249d076aa806ca2c937195a35c7d2a8c490e1f586d0c3f121be5900c1ae5
-  data.tar.gz: 398dc026b251a700432dee898e23c207bee4fa10c5bcc879f706f0e9c0ed0793d3b670861b97221bd4f64bfbfd27c32a589b5b7eeb911662b95623461ec90f59
+  metadata.gz: 6478500701daaeec1623ce28db9d0568a9971f6087d7d7064d13cded11afa76e24b987e7804b7a88a2b5f3b4aa0496b860352399be8fcd82cdb88b640ba1c5e8
+  data.tar.gz: bd3089b11811fc944acaf7d39798d45a36c5e17a9a5be90d2a90d07270a2ca835e73428f58d641893d79f074b96a7c42671efb1ed2c4c40ca838840a0ee87759

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Gandi V5 API Gem Changelog
 
+## Version 0.10.0
+
+* GandiV5::Domain
+  * Add \#transfer_lock(lock = true) and \#transfer_unlock
+  * Add template_id argument to .create
+  * Add \#web_forwardings -> GandiV5::Domain::WebForwarding.list
+  * Add \#new_web_forwarding -> GandiV5::Domain::WebForwarding.create
+* GandiV5::Domain::TransferIn
+  * Add template_id argument to .create
+* GandiV5::Domain::WebForwarding
+* GandiV5::SimpleHosting::Instance::VirtualHost: (I don't use simple hosting myself so it's possible I've misread the docs and a bug is waiting to be found, please add an issue if I have)
+  * Add .create (aliased as GandiV5::SimpleHosting::Instance#create_virtual_host)
+  * Add \#delete
+  * Add \#update
+* GandiV5::Template
+* GandiV5::Template::Dispatch
+* Add testing against truffleruby-20.3.0
+
 ## Version 0.9.1
 
 * Add testing against ruby 2.7.2 and 3.0.0

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/gandi_v5.png)](http://badge.fury.io/rb/gandi_v5)
-[![Build Status](https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=main)](http://travis-ci.org/robertgauld/gandi_v5)
+[![Commit Checks](https://github.com/robertgauld/gandi_v5/workflows/Commit%20Checks/badge.svg)](https://github.com/robertgauld/gandi_v5/actions?query=workflow%3A%22Commit+Checks%22)
 [![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=main)](https://coveralls.io/r/robertgauld/gandi_v5)
 [![Code Climate](https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=main)](https://codeclimate.com/github/robertgauld/gandi_v5)
 
@@ -10,9 +10,12 @@ This gem supports the following versions of ruby, it may work on other versions
   * 2.6.0 - 2.6.6
   * 2.7.0 - 2.7.2
   * 3.0.0
-  * truffleruby 20.1.0 - 20.2.0
-* jruby, once it's reached parity with ruby 2.6.x
-* rubinius, once it's reached parity with ruby 2.6.x
+  * truffleruby 20.1.0 - 20.3.0
+
+This gem doesn't yet support the following versions of ruby, although hopefully it soon will.
+
+* jruby - not yet at parity with ruby 2.6.x
+* rubinius - not yet at parity with ruby 2.6.x
 
 
 ## Gandi V5
@@ -37,12 +40,12 @@ Details of the gem's API can be found at <https://rubydoc.info/github/robertgaul
 If you're using bundler then add it to your Gemfile and run the bundle command.
 
 ```ruby
-gem 'gandi_v5', '~> 0.8'
+gem 'gandi_v5', '~> 0.10'
 ```
 
 If you're not using bundler then install it from the command line.
 ```bash
-gem install gandi_v5 -v '~> 0.8'
+gem install gandi_v5 -v '~> 0.10'
 ```
 
 ## Usage
@@ -121,6 +124,7 @@ We follow the [Semantic Versioning](http://semver.org/) concept.
 
 | Gem Version     | Gandi API Release Date   |
 | --------------- | ------------------------ |
+| 0.10.0          | 2020-12-10               |
 | 0.9.0           | 2020-07-29               |
 | 0.8.0           | 2020-07-10               |
 | 0.7.0           | 2020-05-07               |

data/lib/gandi_v5.rb

@@ -14,6 +14,8 @@ class MyInflector < Zeitwerk::Inflector
   # @return [String] the class name
   def camelize(basename, _abspath)
     case basename
+    when 'dns_record'
+      'DNSRecord'
     when 'live_dns'
       'LiveDNS'
     when 'tld'

data/lib/gandi_v5/domain.rb

@@ -181,7 +181,7 @@ class GandiV5
         admin: admin.respond_to?(:to_gandi) ? admin.to_gandi : admin,
         bill: bill.respond_to?(:to_gandi) ? bill.to_gandi : bill,
         tech: tech.respond_to?(:to_gandi) ? tech.to_gandi : tech
-      }.reject { |_k, v| v.nil? }.to_json
+      }.compact { |_k, v| v.nil? }.to_json
 
       GandiV5.patch url('contacts'), body
       fetch_contacts
@@ -252,6 +252,29 @@ class GandiV5
       data['message']
     end
 
+    # Lock this domain - preventing it from being transfered.
+    # @see https://api.gandi.net/docs/domains/#patch-v5-domain-domains-domain-status
+    # Most extensions have a transfer protection mechanism, that consists of a lock that can be put
+    # on the domain. When the transfer lock is enabled, the domain can't be transferred.
+    # @params lock [Boolean] whether the domain should be locked (true) or unlocked (false)
+    # @return [String] The confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    # rubocop:disable Style/OptionalBooleanParameter
+    def transfer_lock(lock = true)
+      _response, data = GandiV5.patch url('status'), { 'clientTransferProhibited' => lock }.to_json
+      @status = lock ? 'clientTransferProhibited' : nil
+      data['message']
+    end
+    # rubocop:enable Style/OptionalBooleanParameter
+
+    # Unlock this domain - allowing it to be transfered.
+    # @see https://api.gandi.net/docs/domains/#patch-v5-domain-domains-domain-status
+    # @return [String] The confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def transfer_unlock
+      transfer_lock false
+    end
+
     # Requery Gandi fo this domain's information.
     # @return [GandiV5::Domain]
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -417,6 +440,19 @@ class GandiV5
       GandiV5::Email::Forward.list(**params, fqdn: fqdn)
     end
 
+    # Get web forwardings for the domain.
+    # @see GandiV5::Domain::WebRedirection.list
+    def web_forwardings(**params)
+      GandiV5::Domain::WebForwarding.list(fqdn, **params)
+    end
+
+    # Get a web forwarding.
+    # @see GandiV5::Domain::WebRedirection.fetch
+    # @param host [String, #to_s] the host the redirection is setup on.
+    def web_forwarding(host)
+      GandiV5::Domain::WebForwarding.fetch(fqdn, host)
+    end
+
     # Create (register) a new domain.
     # @note This is not a free operation. Please ensure your prepaid account has enough credit.
     # @see https://api.gandi.net/docs/domains#post-v5-domain-domains
@@ -458,6 +494,8 @@ class GandiV5
     #   List of nameservers. Gandi's LiveDNS nameservers are used if omitted..
     # @param price [Numeric, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
     # @param resellee_id [String, #to_gandi, #to_json] (optional) unknown - not documented at Gandi.
+    # @param template_id [String, #to_gandi] (optional)
+    #   Template to be applied when the domain is created.
     # @param smd [String, #to_gandi, #to_json] (optional)
     #   Contents of a Signed Mark Data file (used for newgtld sunrises, tld_period must be sunrise).
     # @param tld_period ["sunrise", "landrush", "eap1", "eap2", "eap3", "eap4", "eap5", "eap6",

data/lib/gandi_v5/domain/transfer_in.rb

@@ -105,6 +105,8 @@ class GandiV5
       # @param change_owner [Boolean] (optional)
       #   whether the change the domain's owner during the transfer.
       # @param auth_code [String] (optional) authorization code (if required).
+      # @param template_id [String, #to_gandi] (optional)
+      #   Template to be applied when the transfer is done.
       # @return [String] the confirmation message from Gandi
       # @return [Hash] if doing a dry run, you get what Gandi returns
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error

data/lib/gandi_v5/domain/web_forwarding.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Domain
+    # Manage web forwarding.
+    # @!attribute [r] created_at
+    #   @return [Time, nil]
+    # @!attribute [r] updated_at
+    #   @return [Time, nil]
+    # @!attribute [r] type
+    #   @return [:cloak, :http301, :http302]
+    # @!attribute [r] fqdn
+    #   @return [String]
+    # @!attribute [r] protocol
+    #   @return [:http, :https, :https_only, nil]
+    # @!attribute [r] target
+    #   @return [String]
+    # @!attribute [r] cert_status
+    #   @return [String, nil]
+    # @!attribute [r] cert_uuid
+    #   @return [String, nil]
+    class WebForwarding
+      include GandiV5::Data
+
+      members :cert_uuid, :cert_status
+      member :target, gandi_key: 'url'
+      member :fqdn, gandi_key: 'host'
+      member :type, converter: GandiV5::Data::Converter::Symbol
+      member :created_at, converter: GandiV5::Data::Converter::Time
+      member :updated_at, converter: GandiV5::Data::Converter::Time
+      member(
+        :protocol,
+        converter: GandiV5::Data::Converter.new(
+          from_gandi: lambda { |value|
+            {
+              'http' => :http,
+              'https' => :https,
+              'httpsonly' => :https_only
+            }.fetch(value)
+          }
+        )
+      )
+
+      # Update the redirection in Gandi.
+      # @see https://api.gandi.net/docs/domains/#patch-v5-domain-domains-domain-webredirs-host
+      # @param target [String, #to_s] the url to redirect to (e.g. www.example.com/path).
+      # @param protocol [:http, :https, :https_only]
+      # @param type [:cloak, :http301, :http302]
+      # @param override [Boolean] If true, a DNS record will be created.
+      #   When the value is false and no matching DNS record exists, it will trigger an error.
+      # @return [GandiV5::Domain::WebRedirection]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def update(target: nil, protocol: nil, type: nil, override: nil)
+        body = {}
+        body['url'] = target.to_s unless target.nil?
+        body['protocol'] = protocol.to_s.delete('_') unless protocol.nil?
+        body['type'] = type.to_s unless type.nil?
+        body['override'] = override unless override.nil?
+
+        GandiV5.patch url, body.to_json
+        refresh
+      end
+
+      # Delete this web redirection from Gandi.
+      # @see https://api.gandi.net/docs/domains/#delete-v5-domain-domains-domain-webredirs-host
+      # @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
+
+      # Check if this is an HTTP 301 (permanent) redirection.
+      def http301?
+        type == :http301
+      end
+
+      # Check if this is an HTTP 302 (found) redirection.
+      def http302?
+        type == :http302
+      end
+
+      # Check if this is an HTTP 301 (permanent) redirection.
+      def permanent?
+        type == :http301
+      end
+
+      # Check if this is an HTTP 302 (found) redirection.
+      def found?
+        type == :http302
+      end
+
+      # Check if this is a temporary redirection.
+      def temporary?
+        type == :http302
+      end
+
+      # Check if it's an http end point
+      def http?
+        protocol == :http || protocol == :https
+      end
+
+      # Check if it's an https end point
+      def https?
+        protocol == :https || protocol == :https_only
+      end
+
+      # Check if it's an https only
+      def https_only?
+        protocol == :https_only
+      end
+
+      # Create a new web redirection.
+      # @see https://api.gandi.net/docs/domains/#post-v5-domain-domains-domain-webredirs
+      # @param domain [String, #to_s] the domain name to create the redirection in.
+      # @param host [String, #to_s] the host name to redirect from.
+      # @param target [String, #to_s] the url to redirect to (e.g. www.example.com/path).
+      # @param protocol [:http, :https, :https_only]
+      # @param type [:cloak, :http301, :http302]
+      # @param override [Boolean] When you create a redirection on a domain, a DNS record is created
+      #   if it does not exist. When the record already exists and this parameter is set to true it
+      #   will overwrite the record. Otherwise it will trigger an error.
+      # @return [GandiV5::Domain::WebRedirection] the created redirection
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def self.create(domain:, host:, target:, protocol:, type:, override: false)
+        body = {
+          'host' => host.to_s,
+          'protocol' => protocol.to_s.delete('_'),
+          'type' => type.to_s,
+          'url' => target.to_s,
+          'override' => override
+        }.to_json
+
+        GandiV5.post url(domain), body
+        fetch domain, host
+      end
+
+      # Get web redirect for a host in a domain.
+      # @see https://api.gandi.net/docs/domains/#get-v5-domain-domains-domain-webredirs-host
+      # @param domain [String, #to_s] the domain to get the web redirection for.
+      # @param host [String, #to_s] the host name to get the web redirection for.
+      # @return [GandiV5::Domain::WebRedirect]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.fetch(domain, host)
+        _response, data = GandiV5.get url(domain, host)
+        redirect = from_gandi data
+        redirect.instance_exec { @domain = domain }
+        redirect
+      end
+
+      # List web redirects for a domain.
+      # @see https://api.gandi.net/docs/domains/#get-v5-domain-domains-domain-webredirs-host
+      # @param domain [String, #to_s] the domain to get the web redirections 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.
+      # @return [Array<GandiV5::Domain::WebRedirect>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list(domain, page: (1..), per_page: 100)
+        redirects = []
+        GandiV5.paginated_get(url(domain), page, per_page) do |data|
+          redirects += data.map { |redirect| from_gandi redirect }
+        end
+        redirects.each { |redirect| redirect.instance_exec { @domain = domain } }
+        redirects
+      end
+
+      private
+
+      def url
+        "#{BASE}domain/domains/#{CGI.escape @domain}/webredirs/#{fqdn}"
+      end
+
+      def self.url(domain, host = nil)
+        "#{BASE}domain/domains/#{CGI.escape domain}/webredirs" +
+          (host ? "/#{CGI.escape host}.#{CGI.escape domain}" : '')
+      end
+      private_class_method :url
+    end
+  end
+end

data/lib/gandi_v5/email.rb

@@ -3,6 +3,8 @@
 class GandiV5
   # Gandi Email Mailbox Management API.
   # @see https://api.gandi.net/docs/email/
+  # rubocop:disable Lint/EmptyClass
   class Email
   end
+  # rubocop:enable Lint/EmptyClass
 end

data/lib/gandi_v5/email/forward.rb

@@ -77,7 +77,7 @@ class GandiV5
       # @return [Array<GandiV5::Email::Forward>]
       # @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? }
+        params.compact! { |_k, v| v.nil? }
 
         mailboxes = []
         GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|

data/lib/gandi_v5/email/mailbox.rb

@@ -199,7 +199,7 @@ class GandiV5
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.list(fqdn, page: (1..), per_page: 100, **params)
         params['~login'] = params.delete(:login)
-        params.reject! { |_k, v| v.nil? }
+        params.compact! { |_k, v| v.nil? }
 
         mailboxes = []
         GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|

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

@@ -60,7 +60,7 @@ class GandiV5
         # @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? }
+          params.compact! { |_k, v| v.nil? }
 
           snapshots = []
           GandiV5.paginated_get(url(fqdn), page, per_page, params: params) do |data|

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

@@ -23,7 +23,7 @@ class GandiV5
           gandi_key: 'config_samples',
           converter: GandiV5::Data::Converter.new(
             from_gandi: ->(value) { value.transform_keys(&:to_sym) },
-            to_gandi: ->(_value) { nil }
+            to_gandi: ->(_value) {}
           )
         )
 

data/lib/gandi_v5/simple_hosting/instance.rb

@@ -146,6 +146,12 @@ class GandiV5
         data
       end
 
+      # @see GandiV5::SimpleHosting::Instance::VirtualHost.create
+      def create_virtual_host(fqdn, **params)
+        GandiV5::SimpleHosting::Instance::VirtualHost.create(uuid, fqdn, **params)
+        refresh
+      end
+
       # Requery Gandi fo this instance's information.
       # @return [GandiV5::SimpleHosting::Instance]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.

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

@@ -57,7 +57,7 @@ class GandiV5
           converter: GandiV5::SimpleHosting::Instance::VirtualHost::LinkedDnsZone
         )
 
-        # Requery Gandi fo this hosts's information.
+        # Requery Gandi fo this virtual hosts's information.
         # @return [GandiV5::SimpleHosting::Instance::VirtualHost]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def refresh
@@ -65,6 +65,59 @@ class GandiV5
           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?
@@ -148,7 +201,39 @@ class GandiV5
           from_gandi data.merge('instance_uuid' => instance_uuid)
         end
 
-        # List instances.
+        # 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.