gandi_v5 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d32f073e157edcd88519f82b4dd082943d4ea049e0232de31dc80d6585070fd7
-  data.tar.gz: ed3c8d5156a3efed4980f62775affc680e73c59890c3430740e41e27dca04763
+  metadata.gz: 023623b5d81a2f3acc4a5fee812f0e8ca24dd8735f59a0f12b53ad35ddb7a397
+  data.tar.gz: 3cf89099c45295da9b06a53ad64b601b3a77525a13ddade403d600c382be02d3
 SHA512:
-  metadata.gz: a15a87d90b92a53b37544862adb13cf11d21fa7d3737300f2b392b2abc9fa28cc150da48d40d0bb1d63c9a7f5b65dbf13cde7ed8d002e51ab78aac084fb17567
-  data.tar.gz: 91812fc13dabdb21e84164a478376d411271aaec1a30be651f1c9af78c9c1d0e521a5af5f6b4162adb1e5a46ff1cd0bc6ce6231bc80e41cd86d2a33d45060f38
+  metadata.gz: 5e816b9de44330c832f6591ca6724b44f5b05c6fab53d8fda6d13a9820211292f29ee608953d8a562da97f4bcfee38f24f799b4a68184bba2b0ec751d21b3f61
+  data.tar.gz: 622bded49d8bae3129ad74fae6fcaf1e8d7c3639b40348b7537e0ba46a3d5c668d2a134754dcf1ff31bcffe3cf0797f5c4368cbc849c386b4648f850d9e24117

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

@@ -5,16 +5,26 @@ AllCops:
 Gemspec/RequiredRubyVersion:
   Enabled: false
 Metrics/AbcSize:
-  Max: 17
+  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

@@ -3,6 +3,13 @@ rvm:
   - 2.6.0
   - 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:
@@ -11,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,3 +1,81 @@
-## Version 0.0.1
+# Gandi V5 API Gem Changelog
 
- * Initial release.
+## 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
+  * .availability(fqdn, **options) moved to GandiV5::Domain::Availability.fetch(fqdn, **options)
+  * .create now returns created domain (except in dry-run mode)
+  * .tlds moved to GandiV5::Domain::TLD.list
+  * .tld(name) moved to GandiV5::Domain::TLD.fetch(name)
+  * #renewal_price(currency: 'GBP', period: 1) added
+* Enhancements to GandiV5::Email::Mailbox
+  * .create now returns created mailbox
+  * .create now checks for available slots and a valid type has been passed
+* Enhancements to GandiV5::Email::Mailbox::Responder
+  * Add #enable(message:, ends_at:, starts_at: Time.now) to enable the auto responder in Gandi
+  * Add #disable to disable the auto responder in Gandi
+* Enhancements to GandiV5::Email::Slot
+  * .create now returns created slot
+  * #delete now checks for inactiveness and refundableness
+* Enhancements to GandiV5::LiveDNS::Domain
+  * Add #zone and #fetch_zone
+  * Remove #replace_*_records_for methods
+  * Changes to #replace_records_for to allow calling with name, type, ttl and values. When calling with name and fecords records MUST be passed as an array.
+* Enhancements to GandiV5::LiveDNS::Zone
+  * .create now returns created zone
+  * Remove #replace_*_records_for methods
+  * Changes to #replace_records_for to allow calling with name, type, ttl and values. When calling with name and fecords records MUST be passed as an array.
+* Enhancements to GandiV5::LiveDNS::Zone::Snapshot
+  * Add .list
+  * Add .fetch
+  * Add #zone and #fetch_zone
+* Add support for ruby 2.6.3
+* Add aliasing methods:
+  * GandiV5.domains -> GandiV5::Domain.list
+  * GandiV5.domain -> GandiV5::Domain.fetch
+  * GandiV5.mailboxes -> GandiV5::Email::Mailbox.list
+  * GandiV5.mailbox_slots -> GandiV5::Email::Slot.list
+  * GandiV5::LiveDNS.domains -> GandiV5::LiveDNS::Domain.list
+  * GandiV5::LiveDNS.domain -> GandiV5::LiveDNS::Domain.fetch
+  * GandiV5::LiveDNS.zones -> GandiV5::LiveDNS::Zone.list
+  * GandiV5::LiveDNS.zone -> GandiV5::LiveDNS::Zone.fetch
+
+## Version 0.1.0
+
+* Initial release.

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/Guardfile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 guard :bundler do
-  watch(/^Gemfile(?:\.lock)$'/)
-  watch(/^.+\.gemspec$'/)
+  watch(/^Gemfile(?:\.lock)$/)
+  watch(/^.+\.gemspec$/)
 end
 
 # rubocop:disable Metrics/BlockLength
 group :red_green_refactor, halt_on_fail: true do
   group :rspec do
     guard(
-      'rspec',
+      :rspec,
       all_on_start: true,
       all_after_pass: false,
       notification: :failed,
@@ -24,12 +24,11 @@ group :red_green_refactor, halt_on_fail: true do
 
   group :rubocop do
     guard(
-      'rubocop',
+      :rubocop,
       all_on_start: true,
       all_after_pass: false,
       notification: :failed,
-      keep_failed: false,
-      cmd: 'bundle exec rubocop'
+      keep_failed: false
     ) do
       watch(%r{^lib/(.+)\.rb$}) { |m| [m[0], "spec/units/#{m[1]}_spec.rb"] }
       watch(%r{^spec/.+?/(.+)_spec\.rb$}) { |m| [m[0], "lib/#{m[1]}.rb"] }

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.2
+  * 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
@@ -38,8 +27,8 @@ But then you were going to be careful anyway as this gem is currently in the ver
 
 Details of the API can be found at:
 
-* (https://api.gandi.net/docs/)
-* (https://doc.livedns.gandi.net/)
+* <https://api.gandi.net/docs/>
+* <https://doc.livedns.gandi.net/>
 
 
 ## Installation
@@ -73,7 +62,7 @@ GandiV5.api_key = '…' # Unless you've set it in the environment variable GANDI
 
 ```ruby
 # Get an array of all your domains.
-domains = GandiV5::Domain.list
+domains = GandiV5.domains
 
 # Since each domain has only basic information, lets get all of the information.
 domains.map!(&:refresh)
@@ -86,9 +75,14 @@ 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.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
+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'
@@ -32,10 +33,10 @@ 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.67'
+  gem.add_development_dependency 'rubocop', '~> 0.73'
   gem.add_development_dependency 'rubocop-performance', '~> 1.1'
   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.
@@ -26,6 +42,26 @@ require 'securerandom'
 class GandiV5
   BASE = 'https://api.gandi.net/v5/'
 
+  # @see GandiV5::Domain.fetch
+  def self.domain(fqdn)
+    GandiV5::Domain.fetch(fqdn)
+  end
+
+  # @see GandiV5::Domain.list
+  def self.domains(**params)
+    GandiV5::Domain.list(**params)
+  end
+
+  # @see GandiV5::Email::Mailbox.list
+  def self.mailboxes(fqdn, **params)
+    GandiV5::Email::Mailbox.list(fqdn, **params)
+  end
+
+  # @see GandiV5::Email::Slot.list
+  def self.mailbox_slots(fqdn)
+    GandiV5::Email::Slot.list(fqdn)
+  end
+
   class << self
     attr_writer :api_key
 
@@ -41,7 +77,7 @@ class GandiV5
     def get(url, **headers)
       prepare_headers headers, url
       response = RestClient.get url, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -59,7 +95,10 @@ class GandiV5
     def delete(url, **headers)
       prepare_headers headers, url
       response = RestClient.delete url, **headers
-      parse_response response
+      [
+        response,
+        response.headers.key?(:content_type) ? parse_response(response) : nil
+      ]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -79,7 +118,7 @@ class GandiV5
       prepare_headers headers, url
       headers[:'content-type'] ||= 'application/json'
       response = RestClient.patch url, payload, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -99,7 +138,7 @@ class GandiV5
       prepare_headers headers, url
       headers[:'content-type'] ||= 'application/json'
       response = RestClient.post url, payload, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -119,7 +158,7 @@ class GandiV5
       prepare_headers headers, url
       headers[:'content-type'] ||= 'application/json'
       response = RestClient.put url, payload, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end