gandi_v5 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77e35cfcd8e9488848bc9a988b8b2e79dea364fc014f0ae6e07335adb0e0b95
-  data.tar.gz: aa3a9b67338ccd330286db829bd593b77a423372175495e30c8098da95713495
+  metadata.gz: ef84fa55ae8d79f2d6fa178db059e4130ff8ae9ba2eb5f5886a57b9f965d8b48
+  data.tar.gz: b5bc9448754bf08ab28c1e3235d01929a6edf3b82f00dbdf935b58d863035de1
 SHA512:
-  metadata.gz: ca79e34d1c4ca0b1cc2b54c58c27b6b7326d5a0568f201229270a89487d641221f4b26deac15494a22869ef91e9e5efe00d50b7652db6249febd31f5abf78514
-  data.tar.gz: 4e87456cd5fde75b7ba2c9fc4076da647c311cfa25ed35e8f85d5406e3766fdd2197210d86e5f81d323c9364cfe79e856e0c7f562a550ff8e8684513ef9f73f8
+  metadata.gz: 90083b929123d60702880dc1fbaa7500c972f38ce1134dbb031d1e5585cad63fbe7265ee38075e5329e2e125f4b441ef0bc02da79137444df4ea27c999c1fa26
+  data.tar.gz: 536d1dae15301728cfda7df6c556913e75025d90f801c5748da598716b887bd0e8c4d25c2f0226ea25d9bab02fa9a3f185d64a5cf9a31694cb21a1ea5f8ac264

data/.gitignore

@@ -16,6 +16,7 @@ InstalledFiles
 lib/bundler/man
 pkg
 rdoc
+doc
 spec/reports
 test/tmp
 test/version_tmp

data/.rubocop.yml

@@ -7,7 +7,7 @@ Gemspec/RequiredRubyVersion:
 Metrics/AbcSize:
   Max: 20
 Metrics/ClassLength:
-  Max: 200
+  Max: 250
 Metrics/LineLength:
   Max: 100
 Metrics/MethodLength:

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.6.1
   - 2.6.2
   - 2.6.3
+  - 2.6.4
 gemfile:
   - Gemfile
 branches:
@@ -12,10 +13,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
   - 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,20 @@
 # Gandi V5 API Gem Changelog
 
+## 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/README.md

@@ -1,29 +1,17 @@
 [![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.4
 * 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
 
 
 ## Gandi V5
@@ -86,8 +74,10 @@ TODO: More examples!
 
 We follow the [Semantic Versioning](http://semver.org/) concept.
 
-| Gem Version     | Gandi API Release Date | 
+| Gem Version     | Gandi API Release Date |
 | --------------- | ---------------------- |
+| 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

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,31 @@
 # 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'
+    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.

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.

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

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'domain/auto_renew'
-require_relative 'domain/availability'
-require_relative 'domain/contact'
-require_relative 'domain/contract'
-require_relative 'domain/dates'
-require_relative 'domain/renewal_information'
-require_relative 'domain/restore_information'
-require_relative 'domain/sharing_space'
-require_relative 'domain/tld'
-
 class GandiV5
   # Gandi Domain Management API.
   # @see https://api.gandi.net/docs/domains
@@ -280,10 +270,163 @@ class GandiV5
                                    .prices.first
     end
 
+    # LiveDNS information for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
+    # @return [GandiV5::Domain::LiveDNS]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def livedns
+      @livedns ||= fetch_livedns
+    end
+
+    # Requery Gandi for the domain's LiveDNS information.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-livedns
+    # @return [GandiV5::Domain::LiveDNS]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def fetch_livedns
+      _response, data = GandiV5.get url('livedns')
+      @livedns = GandiV5::Domain::LiveDNS.from_gandi data
+      @name_server = @livedns.current
+      @name_servers = @livedns.name_servers
+      @livedns
+    end
+
+    # Enable LiveDNS for the domain.
+    # If you want to disable LiveDNS, change the nameservers.
+    # Please note that if the domain is on the classic Gandi DNS,
+    # this will also perform a copy of all existing records immediately afterwards.
+    # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-livedns
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def enable_livedns
+      _response, data = GandiV5.post url('livedns')
+      data['message']
+    end
+
+    # Name servers for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
+    # @return [Array<String>]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def name_servers
+      @name_servers ||= fetch_name_servers
+    end
+
+    # Requery Gandi for the domain's name servers.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-nameservers
+    # @return [Array<String>]
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def fetch_name_servers
+      _response, data = GandiV5.get url('nameservers')
+      @name_servers = data
+    end
+
+    # Update name servers in Gandi.
+    # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-nameservers
+    # @param nameservers [Array<String>] the name servers to use.
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def update_name_servers(nameservers)
+      _response, data = GandiV5.put url('nameservers'), { 'nameservers' => nameservers }.to_json
+      @name_servers = nameservers
+      data['message']
+    end
+
+    # Glue records for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
+    # @return [Hash<String => Array<String>>] name to list of IPs
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def glue_records
+      @glue_records ||= fetch_glue_records
+    end
+
+    # Requery Gandi for the domain's glue records.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
+    # @return [Hash<String => Array<String>>] name to list of IPs
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def fetch_glue_records
+      _response, data = GandiV5.get url('hosts')
+      @glue_records = data.map { |record| record.values_at('name', 'ips') }.to_h
+    end
+
+    # Add a new glue record to the domain in Gandi.
+    # @see https://api.gandi.net/docs/domains#post-v5-domain-domains-domain-hosts
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
+    # @param ips [Array<String>] the IPs for the name.
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def add_glue_record(name, *ips)
+      _response, data = GandiV5.post url('hosts'), { 'name' => name, 'ips' => ips }.to_json
+      @glue_records ||= {}
+      @glue_records[name] = ips
+      data['message']
+    end
+
+    # Get a specific glue record for the domain.
+    # @see https://api.gandi.net/docs/domains#get-v5-domain-domains-domain-hosts
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to add (e.g. 'ns1').
+    # @return [Hash<String => Array<String>>] name to list of IPs
+    # @return [nil] name was not found
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def glue_record(name)
+      records = @glue_records.key?(name) ? @glue_records : fetch_glue_records
+      records.key?(name) ? records.select { |k, _v| k == name } : nil
+    end
+
+    # Update a specific glue record for the domain.
+    # @see https://api.gandi.net/docs/domains#put-v5-domain-domains-domain-hosts-name
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
+    # @param ips [Array<String>] the IPs for the name.
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def update_glue_record(name, *ips)
+      _response, data = GandiV5.put url('hosts', name), { 'ips' => ips }.to_json
+      @glue_records ||= {}
+      @glue_records[name] = ips
+      data['message']
+    end
+
+    # Delete a specific glue record for the domain.
+    # @see https://api.gandi.net/docs/domains#delete-v5-domain-domains-domain-hosts-name
+    # @param name [String] the DNS name (excluding FQDN) for the glue record to update (e.g. 'ns1').
+    # @return [String] confirmation message from Gandi.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+    def delete_glue_record(name)
+      _response, data = GandiV5.delete url('hosts', name)
+      @glue_records ||= {}
+      @glue_records.delete(name)
+      data['message']
+    end
+
+    # @see GandiV5::Email::Mailbox.list
+    def mailboxes(**params)
+      GandiV5::Email::Mailbox.list(**params, fqdn: fqdn)
+    end
+
+    # @see GandiV5::Email::Slot.list
+    def mailbox_slots(**params)
+      GandiV5::Email::Slot.list(**params, fqdn: fqdn)
+    end
+
+    # @see GandiV5::Email::Forward.list
+    def email_forwards(**params)
+      GandiV5::Email::Forward.list(**params, fqdn: fqdn)
+    end
+
     # Create (register) a new domain.
     # Warning! 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
     # @param fqdn [String, #to_s] the fully qualified domain name to create.
+    # @param dry_run [Boolean]
+    #   whether the details should be checked instead of actually creating the domain.
+    # @param sharing_id [String] either:
+    #   * nil (default) - nothing special happens
+    #   * an organization ID - pay using another organization
+    #     (you need to have billing permissions on the organization
+    #     and use the same organization name for the domain name's owner).
+    #     The invoice will be edited using this organization's information.
+    #   * a reseller ID - buy a domain for a customer using a reseller account
+    #     (you need to have billing permissions on the reseller organization
+    #     and have your customer's information for the owner).
+    #     The invoice will be edited using the reseller organization's information.
     # @param owner [GandiV5::Domain::Contact, #to_gandi, #to_h] (required)
     #   the owner of the new domain.
     # @param admin [GandiV5::Domain::Contact, #to_gandi, #to_h] (optional, defaults to owner)
@@ -308,25 +451,24 @@ class GandiV5
     # @param nameservers [Array<String>, #to_gandi, #to_json] (optional)
     #   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 reselle_id [String, #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 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",
     #   "eap7", "eap8", "eap9", "golive", #to_gandi, #to_json] (optional)
     #   @see https://docs.gandi.net/en/domain_names/register/new_gtld.html
-    # @param dry_run [Boolean] whether the details should be checked
-    #   instead of actually creating the domain
     # @return [GandiV5::Domain] the created domain
     # @return [Hash] if doing a dry run, you get what Gandi returns
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error
-    def self.create(fqdn, dry_run: false, **params)
+    def self.create(fqdn, dry_run: false, sharing_id: nil, **params)
       fail ArgumentError, 'missing keyword: owner' unless params.key?(:owner)
 
       body = params.merge(fqdn: fqdn)
                    .transform_values { |val| val.respond_to?(:to_gandi) ? val.to_gandi : val }
                    .to_json
+      url_ = sharing_id ? "#{url}?sharing_id=#{sharing_id}" : url
 
-      response, data = GandiV5.post(url, body, 'Dry-Run': dry_run ? 1 : 0)
+      response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
       dry_run ? data : fetch(response.headers[:location].split('/').last)
     end
 
@@ -371,10 +513,10 @@ class GandiV5
 
     private
 
-    def url(extra = nil)
+    def url(*extra)
       "#{BASE}domain/domains/" +
         CGI.escape(fqdn) +
-        (extra ? "/#{extra}" : '')
+        (extra.empty? ? '' : "/#{extra.join('/')}")
     end
 
     def self.url(fqdn = nil)