gandi_v5 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6873be5c700e1ef88075c90b71361bb9568b11661661dd0bc4f7d77cfdefd6f0
-  data.tar.gz: 13aac04c42357193607cff0f55c0502253fb6b527475e40ad5cb5d53011268ce
+  metadata.gz: 5bcedab1f98eded02f20893ca2f4b8c5a47abe1d72d3e055ef5688b2969104df
+  data.tar.gz: 6db74218bd3914c662c2b6cac47c76a4d9497368f80b3ef4f31ad7e6537604a5
 SHA512:
-  metadata.gz: 46afb560fe574db5bf9d47e3e5bbce0843acef12edd132e26cba685608e4b1fa2dc1579dc30e287128ef6462924d56c14856168bcc2d277dededbf9360c45d0b
-  data.tar.gz: 9e35714cdb2ad68d57d11f4bdd689a6fc0103d155827682bb6a2f66340e8054af328761827f13e7af857c5c41263568daed84805e20b90e5b580917dea502eab
+  metadata.gz: 29dad44ec126323a917bcc5c4ac8dd200e1acc7ac32cfdf7c4608a919dd872e9f2071031b371d7ad8bae8a2ed09e6bd2bf660d0095b59999859e91d180b53e70
+  data.tar.gz: 1d2c599205a31b449c003cf4e2628b0326cf90d45ae3c75a68356879e463ee708c6d81f5fb64e1ee75ffe73fbc5402cc3e2fc290fddfe6777c0fb304ccb45a8f

data/.rubocop.yml

@@ -4,6 +4,18 @@ AllCops:
   TargetRubyVersion: 2.6.0
 Gemspec/RequiredRubyVersion:
   Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/AbcSize:
   Max: 20
 Metrics/ClassLength:
@@ -16,15 +28,47 @@ Metrics/ModuleLength:
   Max: 200
 Metrics/ParameterLists:
   Max: 6
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
 Style/DocumentationMethod:
   Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
 Style/HashEachMethods:
   Enabled: true
 Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
   Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
 Style/SignalException:
   Enabled: false
+Style/SlicingWithRange:
+  Enabled: true
 Layout/LineLength:
   Max: 100

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Gandi V5 API Gem Changelog
 
+## Version 0.8.0
+
+* Domain:
+  * .list - add resellee_id filter
+* Added simple hosting: (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)
+  * SimpleHosting::Instance
+  * SimpleHosting::Instance::VirtualHost
+  * SimpleHosting::Instance::Application
+  * SimpleHosting::Instance::Database
+  * SimpleHosting::Instance::Language
+  * SimpleHosting::Instance::Upgrade
+* GandiV5::Domain::SharingSpace moved to GandiV5::SharingSpace
+
 ## Version 0.7.0
 
 * LiveDNS:

data/README.md

@@ -77,6 +77,7 @@ We follow the [Semantic Versioning](http://semver.org/) concept.
 
 | Gem Version     | Gandi API Release Date   |
 | --------------- | ------------------------ |
+| 0.8.0           | 2020-07-10               |
 | 0.7.0           | 2020-05-07               |
 | 0.6.0           | 2020-05-07 (not LiveDNS) |
 | 0.5.0           | 2019-10-01               |

data/gandi_v5.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rb-inotify', '~> 0.9'
   gem.add_development_dependency 'rspec', '>= 3.7', '< 4'
   gem.add_development_dependency 'rspec-its', '~> 1.3'
-  gem.add_development_dependency 'rubocop', '~> 0.73'
-  gem.add_development_dependency 'rubocop-performance', '~> 1.1'
+  gem.add_development_dependency 'rubocop', '~> 0.87'
+  gem.add_development_dependency 'rubocop-performance', '~> 1.7'
   gem.add_development_dependency 'simplecov', '~> 0.7'
   gem.add_development_dependency 'timecop', '~> 0.5'
   gem.add_development_dependency 'vcr', '~> 4.0'

data/lib/gandi_v5/domain.rb

@@ -15,7 +15,7 @@ class GandiV5
   #      gandidns, redirection, gandimail, packmail, dnssec, blog, hosting,
   #      paas, site, certificate, gandilivedns, mailboxv2
   # @!attribute [r] sharing_space
-  #   @return [GandiV5::Domain::SharingSpace]
+  #   @return [GandiV5::SharingSpace]
   # @!attribute [r] status
   #   @return [String] one of: "clientHold", "clientUpdateProhibited", "clientTransferProhibited",
   #     "clientDeleteProhibited", "clientRenewProhibited", "serverHold", "pendingTransfer",
@@ -107,7 +107,7 @@ class GandiV5
     member(
       :sharing_space,
       gandi_key: 'sharing_space',
-      converter: GandiV5::Domain::SharingSpace
+      converter: GandiV5::SharingSpace
     )
 
     member(
@@ -496,8 +496,10 @@ class GandiV5
     # @param fqdn [String, #to_s] (optional)
     #   filters the list by domain name, with optional patterns.
     #   e.g. "example.net", "example.*", "*ample.com"
-    # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
+    # @param resellee_id [String, #to_s] (optional)
+    #   filters the list by resellee_id (from the Organization API).
     # @param tld [String, #to_s] (optional) used to filter by just the top level domain.
+    # @param sort_by [String, #to_s] (optional default "fqdn") how to sort the list.
     # @return [Array<GandiV5::Domain>]
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.list(page: (1..), per_page: 100, **params)

data/lib/gandi_v5/live_dns/domain.rb

@@ -138,7 +138,7 @@ class GandiV5
       #   @raise [ArgumentError] if ttl is present and type is absent.
       # @return [String] The confirmation message from Gandi.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def replace_records(records, name: nil, type: nil)
         if type
           GandiV5::LiveDNS.require_valid_record_type(type) if type
@@ -158,7 +158,7 @@ class GandiV5
         _response, data = GandiV5.put url_, body.to_json
         data['message']
       end
-      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       # Replace all records for this domain.
       # @param text [String] zone file lines to replace the records with.

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