gandi_v5 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77e35cfcd8e9488848bc9a988b8b2e79dea364fc014f0ae6e07335adb0e0b95
-  data.tar.gz: aa3a9b67338ccd330286db829bd593b77a423372175495e30c8098da95713495
+  metadata.gz: 6873be5c700e1ef88075c90b71361bb9568b11661661dd0bc4f7d77cfdefd6f0
+  data.tar.gz: 13aac04c42357193607cff0f55c0502253fb6b527475e40ad5cb5d53011268ce
 SHA512:
-  metadata.gz: ca79e34d1c4ca0b1cc2b54c58c27b6b7326d5a0568f201229270a89487d641221f4b26deac15494a22869ef91e9e5efe00d50b7652db6249febd31f5abf78514
-  data.tar.gz: 4e87456cd5fde75b7ba2c9fc4076da647c311cfa25ed35e8f85d5406e3766fdd2197210d86e5f81d323c9364cfe79e856e0c7f562a550ff8e8684513ef9f73f8
+  metadata.gz: 46afb560fe574db5bf9d47e3e5bbce0843acef12edd132e26cba685608e4b1fa2dc1579dc30e287128ef6462924d56c14856168bcc2d277dededbf9360c45d0b
+  data.tar.gz: 9e35714cdb2ad68d57d11f4bdd689a6fc0103d155827682bb6a2f66340e8054af328761827f13e7af857c5c41263568daed84805e20b90e5b580917dea502eab

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
@@ -16,6 +17,7 @@ InstalledFiles
 lib/bundler/man
 pkg
 rdoc
+doc
 spec/reports
 test/tmp
 test/version_tmp

data/.rubocop.yml

@@ -7,14 +7,24 @@ Gemspec/RequiredRubyVersion:
 Metrics/AbcSize:
   Max: 20
 Metrics/ClassLength:
-  Max: 200
-Metrics/LineLength:
-  Max: 100
+  Max: 250
+Metrics/CyclomaticComplexity:
+  Max: 8
 Metrics/MethodLength:
   Max: 15
 Metrics/ModuleLength:
   Max: 200
+Metrics/ParameterLists:
+  Max: 6
 Style/DocumentationMethod:
   Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
 Style/SignalException:
   Enabled: false
+Layout/LineLength:
+  Max: 100

data/.travis.yml

@@ -4,6 +4,12 @@ rvm:
   - 2.6.1
   - 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:
@@ -12,10 +18,18 @@ branches:
     - staging
     - /gh(?:\d)+(?:-.+)?/
     - /dev_ver_\d+\.\d+/
+env:
+  global:
+    # CC_TEST_REPORTER_ID for reporting test coverage to code climate
+    - secure: "C3AcK+/2A4h2+ZayJXc89EQp76o8/2RL03PdtVjWPI6cfBSwN174ImWSdIcs6+Bjv8GH+bADsM4epkTjI7H24wh80If/4jAZJMB6LsAxVC3rZVx2UfDghp1Lwcy6BkNx4VVXMQJUR4rA8fXNd1l6n2a72RbPhTaGYxggw+yiKYNjj5m/u3HWPzTQ9wIx/rLzb2shQU1P9tDX4eRqJixYsd8LvStvXewUKlTQSaxNczzfcSOmeJrrytJGuPQxgBx67hlN40cs84oEbhndjlekZRwYepsRcan9umJEDHnE+k0wLlz/vb2cshYp5tdcfkqspaEhUSV7Vr7ZQNIppI3XyY1hs/pTYc2Vytp3OiY0EXBjKRmiHcnmA8EIkrV9i4OSt6Af3EQJaYU56a0BCaEqzRoQJWOZDS8bVowuO4rY8/xINQBwTojIYAplI/vqX/7xvlRbzIgeWdpvQipPC01d2JtmI/5D1FdGWtzYcDCTRTbHyWmjhr7Jt8qEDMFkbpkcAQiS61baEQ0p4CxaLYm/lpPco1U3e/gMOb/EXDhOrF1I8lSBmVJE/Uz2/3kfOa1DQSxDSRmV1nU3pSd7PUi25Pdx0rezJjRl1UC2gnsNZrCLbplk+VkImXTt3iirV/RuHDo+YVT0efaws7TVH7Uf87jqWf4VZEw/KI3tzfF43CE="
 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
 notifications:
   slack:
     on_success: always

data/CHANGELOG.md

@@ -1,5 +1,68 @@
 # Gandi V5 API Gem Changelog
 
+## 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
+  * Glue record management
+  * LiveDNS management
+  * Name server management
+* Update GandiV5::Domain.create to allow purchasing as a reseller and billing to a different organization
+* Add forwarding address management to GandiV5::Email::Forwarding
+* Add GandiV5::Organization.list
+* Uses Zeitwerk for auto loading
+* Add aliasing methods:
+  * GandiV5::Domain.mailboxes -> GandiV5::Email::Mailbox.list
+  * GandiV5::Domain.mailbox_slots -> GandiV5::Email::Slot.list
+  * GandiV5::Domain.email_forwards -> GandiV5::Email::Forward.list
+
 ## Version 0.2.0
 
 * Enhancements to GandiV5::Domain

data/FUNDING.yml

@@ -0,0 +1,10 @@
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: robertgauld
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

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

@@ -1,29 +1,18 @@
 [![Gem Version](https://badge.fury.io/rb/gandi_v5.png)](http://badge.fury.io/rb/gandi_v5)
-
-Master branch:
 [![Build Status](https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=master)](http://travis-ci.org/robertgauld/gandi_v5)
 [![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=master)](https://coveralls.io/r/robertgauld/gandi_v5)
 [![Code Climate](https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=master)](https://codeclimate.com/github/robertgauld/gandi_v5)
-
-Staging branch:
-[![Build Status](https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=staging)](http://travis-ci.org/robertgauld/gandi_v5)
-[![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=staging)](https://coveralls.io/r/robertgauld/gandi_v5)
-
-
-## Build State
-This project uses continuous integration to help ensure that a quality product is delivered.
-Travis CI monitors two branches (versions) of the code:
-
-* Master (which is what gets released)
-* Staging (which is what is currently being developed ready for moving to master).
-
+[![security](https://hakiri.io/github/robertgauld/gandi_v5/master.svg)](https://hakiri.io/github/robertgauld/gandi_v5/master)
 
 ## Ruby Versions
 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.3
+  * 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
+* rubinius, once it's reached parity with ruby 2.6.x
 
 
 ## Gandi V5
@@ -47,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
@@ -86,9 +75,15 @@ TODO: More examples!
 
 We follow the [Semantic Versioning](http://semver.org/) concept.
 
-| Gem Version     | Gandi API Release Date | 
-| --------------- | ---------------------- |
-| 0.1.0           | 2019-05-16             |
+| Gem Version     | Gandi API Release Date   |
+| --------------- | ------------------------ |
+| 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

@@ -22,8 +22,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'dotenv', '~> 2.5'
   gem.add_dependency 'rest-client', '>= 2', '< 3'
+  gem.add_dependency 'zeitwerk', '~> 2.1'
 
-  gem.add_development_dependency 'coveralls', '~> 0.7'
+  gem.add_development_dependency 'coveralls', '~> 0.8'
   gem.add_development_dependency 'guard', '~> 2.15'
   gem.add_development_dependency 'guard-bundler', '~> 2.2'
   gem.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.5'
@@ -37,5 +38,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'simplecov', '~> 0.7'
   gem.add_development_dependency 'timecop', '~> 0.5'
   gem.add_development_dependency 'vcr', '~> 4.0'
-  gem.add_development_dependency 'webmock', '~> 3.5'
+  gem.add_development_dependency 'webmock', '~> 3.6'
 end

data/lib/gandi_v5.rb

@@ -1,17 +1,33 @@
 # frozen_string_literal: true
 
-require_relative 'gandi_v5/version'
-require_relative 'gandi_v5/data'
-require_relative 'gandi_v5/error'
-
-require_relative 'gandi_v5/billing'
-require_relative 'gandi_v5/domain'
-require_relative 'gandi_v5/email'
-require_relative 'gandi_v5/live_dns'
-require_relative 'gandi_v5/organization'
-
 require 'rest_client'
 require 'securerandom'
+require 'zeitwerk'
+
+# Custom inflector for Zeitwerk.
+class MyInflector < Zeitwerk::Inflector
+  # Convert file's base name to class name when
+  # Zeitwerk's included inflector gets it wrong.
+  # @param basename [String] the file's base name (no path or extension)
+  # @param abspath [String] the file's absolute path
+  # @return [String] the class name
+  def camelize(basename, _abspath)
+    case basename
+    when 'live_dns'
+      'LiveDNS'
+    when 'tld'
+      'TLD'
+    when 'version'
+      'VERSION'
+    else
+      super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector = MyInflector.new
+loader.setup
 
 # Namespace for classes which access the Gandi V5 API.
 # Also provides useful methods and constants for them.
@@ -66,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
@@ -79,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
@@ -150,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
@@ -177,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/billing.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'billing/info'
-
 class GandiV5
   # Gandi Billing API.
   # @see https://api.gandi.net/docs/billing

data/lib/gandi_v5/billing/info.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'info/prepaid'
-
 class GandiV5
   class Billing
     # Account's information.

data/lib/gandi_v5/data.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'data/converter'
-
 class GandiV5
   # Addin providing a DSL to manage declaring attributes and how to map
   # and convert to/from Gandi's fields.
@@ -181,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.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'converter/array_of'
-require_relative 'converter/symbol'
-require_relative 'converter/time'
-
 class GandiV5
   module Data
     # Namespace for converters to/from Gandi's format.

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