gandi_v5 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef84fa55ae8d79f2d6fa178db059e4130ff8ae9ba2eb5f5886a57b9f965d8b48
-  data.tar.gz: b5bc9448754bf08ab28c1e3235d01929a6edf3b82f00dbdf935b58d863035de1
+  metadata.gz: 5bcedab1f98eded02f20893ca2f4b8c5a47abe1d72d3e055ef5688b2969104df
+  data.tar.gz: 6db74218bd3914c662c2b6cac47c76a4d9497368f80b3ef4f31ad7e6537604a5
 SHA512:
-  metadata.gz: 90083b929123d60702880dc1fbaa7500c972f38ce1134dbb031d1e5585cad63fbe7265ee38075e5329e2e125f4b441ef0bc02da79137444df4ea27c999c1fa26
-  data.tar.gz: 536d1dae15301728cfda7df6c556913e75025d90f801c5748da598716b887bd0e8c4d25c2f0226ea25d9bab02fa9a3f185d64a5cf9a31694cb21a1ea5f8ac264
+  metadata.gz: 29dad44ec126323a917bcc5c4ac8dd200e1acc7ac32cfdf7c4608a919dd872e9f2071031b371d7ad8bae8a2ed09e6bd2bf660d0095b59999859e91d180b53e70
+  data.tar.gz: 1d2c599205a31b449c003cf4e2628b0326cf90d45ae3c75a68356879e463ee708c6d81f5fb64e1ee75ffe73fbc5402cc3e2fc290fddfe6777c0fb304ccb45a8f

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 # And because this is Ruby, ignore the following
 #  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
 
+.ruby-version
 notes.txt
 todo.txt
 *.gem

data/.rubocop.yml

@@ -4,17 +4,71 @@ 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:
   Max: 250
-Metrics/LineLength:
-  Max: 100
+Metrics/CyclomaticComplexity:
+  Max: 8
 Metrics/MethodLength:
   Max: 15
 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/.travis.yml

@@ -5,6 +5,11 @@ rvm:
   - 2.6.2
   - 2.6.3
   - 2.6.4
+  - 2.6.5
+  - 2.6.6
+  - 2.7.0
+  - 2.7.1
+  - truffleruby-20.1.0
 gemfile:
   - Gemfile
 branches:
@@ -21,7 +26,7 @@ before_install: gem update bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter && chmod +x ./cc-test-reporter && ./cc-test-reporter before-build
 script:
-  - bundle exec rubocop
+  - if [[ $(echo $TRAVIS_JOB_NUMBER | awk -F . '{ print $2 }') == '1' ]]; then bundle exec rubocop; fi
   - bundle exec rspec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,5 +1,66 @@
 # 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:
+  * Rename LiveDNS::RecordSet to LiveDNS::Domain::Record
+  * Domains:
+    * .list now returns an array of strings
+    * Can no longer change the zone used by a domain
+    * Added automatic_snapshots attribute for whether snapshots are automatically created when a modification is made to this domain's records
+    * #replace_records and #replace_records_for merged into #replace_records
+      * If replacing with a zone file use the new #replace_zone_lines
+    * Added:
+      * .create
+      * .record_types
+      * .generic_name_servers(fqdn)
+      * #name_servers and #fetch_name_servers
+      * #tsig_keys, #fetch_tsig_keys, #add_tsig_key, #remove_tsig_key
+      * #axfr_clients, #fetch_axfr_clients, #add_axfr_client, #remove_axfr_client
+      * ::DnssecKeys, #dnssec_keys, #fetch_dnssec_keys
+  * Snapshots:
+    * Moved to live under LiveDNS::Domain not LiveDNS::Zone
+    * Are now accessed via the fully qualified domain name NOT the zone's UUID
+    * Ability to access the zone from a snapshot is removed
+    * Taking a snapshot now allows for named snapshots
+    * Added automatic attribute for when a snapshot was taken due to a zone change
+    * .list now returns an array of snapshots (records are fetched in a seperate request when first needed)
+  * Zone removed.
+
+## Version 0.6.0
+
+* GandiV5::Email::Slot.create now supports sharing_id
+* GandiV5::Email::Slot.create's type argument is now named not positional
+* Add reseller information to GandiV5::Domain
+
+## Version 0.5.0
+
+* Add support for truffleruby 20.1.0
+* Fix issue with rails in production
+
+## Version 0.4.0
+
+* Fix exception when delete returns no content-type
+* Add support for ruby 2.7.0
+* Add up/downgrading mailbox offer
+* Add dry run option to creating a mailbox
+* Add sharing_id & dry run option for renewing domain
+* Add listing customers under a reseller organization (GandiV5::Organization::Customer.list and GandiV5::Organization#customers)
+* Add creating customer under a reseller organization (GandiV5::Organization::Customer.create and GandiV5::Organization#create_customer)
+
 ## Version 0.3.0
 
 * Additions to GandiV5::Domain

data/LICENSE.md

@@ -1,14 +1,10 @@
-##Copyright
-Copyright (c) 2018, Robert Gauld. All rights reserved.
-
-
-##License
+## License
 This code can be used under the BSD License (reproduced below).
 Commiters to the project give Robert Gauld the right to redistribute their commits
 under the BSD license.
 
 
-###BSD License
+### BSD License
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 

data/README.md

@@ -8,9 +8,10 @@
 This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.
 
 * ruby:
-  * 2.6.0 - 2.6.4
+  * 2.6.0 - 2.6.6
+  * 2.7.0 - 2.7.1
+  * truffleruby 20.1.0
 * jruby, once it's reached parity with ruby 2.6.x
-* truffleruby, once it's reached parity with ruby 2.6.x
 * rubinius, once it's reached parity with ruby 2.6.x
 
 
@@ -35,12 +36,12 @@ Details of the API can be found at:
 If you're using bundler then add it to your Gemfile and run the bundle command.
 
 ```ruby
-gem 'gandi_v5', '~> 0.1'
+gem 'gandi_v5', '~> 0.7'
 ```
 
 If you're not using bundler then install it from the command line.
 ```bash
-gem install gandi_v5 -v '~> 0.1'
+gem install gandi_v5 -v '~> 0.7'
 ```
 
 ## Usage
@@ -74,11 +75,16 @@ TODO: More examples!
 
 We follow the [Semantic Versioning](http://semver.org/) concept.
 
-| Gem Version     | Gandi API Release Date |
-| --------------- | ---------------------- |
-| 0.3.0           | 2019-08-22             |
-| 0.2.0           | 2019-05-16             |
-| 0.1.0           | 2019-05-16             |
+| 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               |
+| 0.4.0           | 2019-10-01               |
+| 0.3.0           | 2019-08-22               |
+| 0.2.0           | 2019-05-16               |
+| 0.1.0           | 2019-05-16               |
 
 See <https://api.gandi.net/docs/reference#API-Changelog> to find out what
 Gandi changed on each date.

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.rb

@@ -17,6 +17,8 @@ class MyInflector < Zeitwerk::Inflector
       'LiveDNS'
     when 'tld'
       'TLD'
+    when 'version'
+      'VERSION'
     else
       super
     end
@@ -80,6 +82,36 @@ class GandiV5
       handle_bad_request(e)
     end
 
+    # Might raise:
+    #  * RestClient::NotFound
+    #  * RestClient::Unauthorized
+    #      Bad authentication attempt because of a wrong API Key.
+    #  * RestClient::Forbidden
+    #      Access to the resource is denied.
+    #      Mainly due to a lack of permissions to access it.
+    #  * GandiV5::Error
+    #  * JSON::ParserError
+    def paginated_get(url, page = (1..), per_page = 100, **headers)
+      unless page.respond_to?(:each)
+        fail ArgumentError, 'page must be positive' unless page.positive?
+
+        page = [page]
+      end
+
+      headers[:params] ||= {}
+      headers[:params].transform_keys!(&:to_s)
+      headers[:params]['per_page'] = per_page
+
+      page.each do |page_number|
+        headers[:params]['page'] = page_number
+        _resp, this_data = get(url, **headers)
+        break if this_data.empty?
+
+        yield this_data
+        break if this_data.count < per_page
+      end
+    end
+
     # Might raise:
     #  * RestClient::NotFound
     #  * RestClient::Unauthorized
@@ -93,7 +125,10 @@ class GandiV5
     def delete(url, **headers)
       prepare_headers headers, url
       response = RestClient.delete url, **headers
-      [response, parse_response(response)]
+      [
+        response,
+        response.headers.key?(:content_type) ? parse_response(response) : nil
+      ]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -164,16 +199,6 @@ class GandiV5
       @api_key ||= ENV.fetch('GANDI_API_KEY')
     end
 
-    def authorisation_header(url)
-      if url.start_with?(BASE)
-        { Authorization: "Apikey #{api_key}" }
-      elsif url.start_with?(GandiV5::LiveDNS::BASE)
-        { 'X-Api-Key': api_key }
-      else
-        fail ArgumentError, "Don't know how to authorise for url: #{url}"
-      end
-    end
-
     def parse_response(response)
       type = response.headers.fetch(:content_type).split(';').first.chomp
       case type
@@ -191,10 +216,11 @@ class GandiV5
       end
     end
 
-    def prepare_headers(headers, url)
-      headers.transform_keys!(&:to_sym)
+    def prepare_headers(headers, _url)
+      headers.transform_keys! { |key| key.to_s.downcase.to_sym }
       headers[:accept] ||= 'application/json'
-      headers.merge!(authorisation_header(url))
+      headers[:authorization] = "Apikey #{api_key}"
+      headers
     end
 
     def handle_bad_request(exception)

data/lib/gandi_v5/data.rb

@@ -179,9 +179,8 @@ class GandiV5
         define_method "#{name}=" do |value|
           instance_variable_set("@#{name}", value)
         end
-        # rubocop:disable Style/AccessModifierDeclarations
+
         private "#{name}="
-        # rubocop:enable Style/AccessModifierDeclarations
       end
 
       # @api private

data/lib/gandi_v5/data/converter/integer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class GandiV5
+  module Data
+    class Converter
+      # Methods for converting strings to/from integerss.
+      class Integer
+        # @param value [Integer]
+        # @return [String]
+        def self.to_gandi(value)
+          return nil if value.nil?
+
+          value.to_s
+        end
+
+        # @param [String]
+        # @return value [Integer]
+        def self.from_gandi(value)
+          return nil if value.nil?
+
+          value.to_i
+        end
+      end
+    end
+  end
+end

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(
@@ -211,10 +211,13 @@ class GandiV5
     # @param duration [Integer, #to_s] how long to renew for (in years).
     # @return [String] confirmation message from Gandi.
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-    def renew_for(duration = 1)
+    def renew_for(duration = 1, sharing_id: nil, dry_run: false)
       body = { duration: duration }.to_json
-      _response, data = GandiV5.post url('renew'), body
-      data['message']
+      url_ = url('renew')
+      url_ = sharing_id ? "#{url_}?sharing_id=#{sharing_id}" : url_
+
+      _response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
+      dry_run ? data : data['message']
     end
 
     # Restoration information for the domain.
@@ -489,24 +492,20 @@ class GandiV5
     # @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 ot get per page.
+    # @param per_page [Integer, #to_s] (optional default 100) how many results to get per page.
     # @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)
-      page = [page.to_i] unless page.respond_to?(:each)
-
       domains = []
-      page.each do |page_number|
-        _resp, data = GandiV5.get url, params: params.merge(page: page_number, per_page: per_page)
-        break if data.empty?
-
+      GandiV5.paginated_get(url, page, per_page, params: params) do |data|
         domains += data.map { |domain| from_gandi domain }
-        break if data.count < per_page
       end
       domains
     end