gandi_v5 0.6.0 → 0.10.0

data/.gitignore

@@ -1,26 +0,0 @@
-# Because this is a gem, ignore Gemfile.lock:
-
-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
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-doc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-gemfiles/*.lock
-.yardoc

data/.rspec

@@ -1,3 +0,0 @@
---color
---format documentation
---require spec_helper

data/.rubocop.yml

@@ -1,30 +0,0 @@
-require:
-- rubocop-performance
-AllCops:
-  TargetRubyVersion: 2.6.0
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-Metrics/AbcSize:
-  Max: 20
-Metrics/ClassLength:
-  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

@@ -1,38 +0,0 @@
-language: ruby
-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:
-  only:
-    - master
-    - 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:
-  - 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
-    on_failure: always
-    rooms:
-    - secure: Nx1TmVs32ILAvH3Cv+jX6rZh1hgx3YaY9azC3PIaJba/bF9xXY1l8L4wF0dJGupQlFP3lWN3Y/aPIJo3SNbH+qll9o317105FfTecPWloyiDgWvz5qPz+oh5MImBUs220jW2XsaACfZkGTUsQt8OUCfhtUeUiW+YqqfAZEwnl+0TyTSFBSLKSNdMcT0sKYPb0IuX5WrOspokSoE9+QL5k0cNN8d78MvtUIC6Em5/ffKVbk4TulQhbzyUhIlPDoxVELq16dQ7njyWJb58khOCaJGV7a2NdFvFCJqImFVQPRT5Ad6EJMQ461cdPY5+ZwxDGlIkA5Srt1L+CyV2wJtMarCIPoGQaxuOTVjNiedEmzblg3K9VXkI7Q5LupJ+vOBhtUS54ODYVBnQgoNVPuRe6T81VZ7NCejeest9bqga8QAVVNhKvMvb6l+YXabnPo7okDZM4+4AlaG/pBKWKjxDJ5QXlbRUZqnJt36sA7y3wvIxnYMX45oaqLD9OS8DQ7Va9+9bsPGZnI0oQrkoPGazGnCryvNtEdl+Qy2KSFaocJL7XLavmAYCmqnNGIaO0eiI+VoX9rvOadDNaPJoa6G4YpO+yTBlx1mxLjneY3FfCHZ1lma7UxzV0t0AVYZtnYBalXbw3mvIWEg6PPRI2uXGCvwUBrNCQqonULsRTFSseMw=

data/FUNDING.yml

@@ -1,10 +0,0 @@
-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/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in gandi_v5.gemspec
-gemspec

data/Guardfile

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-guard :bundler do
-  watch(/^Gemfile(?:\.lock)$/)
-  watch(/^.+\.gemspec$/)
-end
-
-# rubocop:disable Metrics/BlockLength
-group :red_green_refactor, halt_on_fail: true do
-  group :rspec do
-    guard(
-      :rspec,
-      all_on_start: true,
-      all_after_pass: false,
-      notification: :failed,
-      cmd: 'bundle exec rspec'
-    ) do
-      watch(%r{^spec/.+_spec\.rb$})
-      watch(%r{^lib/(.+)\.rb$})       { |m| "spec/units/#{m[1]}_spec.rb" }
-      watch('spec/spec_helper.rb')    { 'spec' }
-      watch(%r{^spec/.+_shared\.rb$}) { 'spec' }
-    end
-  end
-
-  group :rubocop do
-    guard(
-      :rubocop,
-      all_on_start: true,
-      all_after_pass: false,
-      notification: :failed,
-      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"] }
-      watch(%r{^(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
-    end
-  end
-end
-# rubocop:enable Metrics/BlockLength

data/Rakefile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-Dotenv.load
-
-unless ENV.key?('GANDI_API_KEY')
-  puts 'YOU MUST SET YOUR API KEY -> GandiV5.api_key = \'…\''
-  puts 'You can avoid having to do this by'
-  puts 'setting the environment variable GANDI_API_KEY.'
-end
-
-require 'irb'
-IRB.start

data/gandi_v5.gemspec

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-require File.join(File.dirname(__FILE__), 'lib', 'gandi_v5', 'version')
-
-Gem::Specification.new do |gem|
-  gem.name        = 'gandi_v5'
-  gem.license     = 'BSD 3 clause'
-  gem.version     = GandiV5::VERSION
-  gem.authors     = ['Robert Gauld']
-  gem.email       = ['robert@robertgauld.co.uk']
-  gem.homepage    = 'https://github.com/robertgauld/gandi_v5'
-  gem.summary     = 'Make use of Gandi\'s V5 API.'
-
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  gem.require_paths = ['lib']
-
-  gem.required_ruby_version     = '>= 2.4'
-  gem.required_rubygems_version = '>= 2.6.14'
-
-  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.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'
-  gem.add_development_dependency 'guard-rubocop', '~> 1.3'
-  gem.add_development_dependency 'rake', '~> 12.0'
-  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 'simplecov', '~> 0.7'
-  gem.add_development_dependency 'timecop', '~> 0.5'
-  gem.add_development_dependency 'vcr', '~> 4.0'
-  gem.add_development_dependency 'webmock', '~> 3.6'
-end

data/lib/gandi_v5/domain/sharing_space.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class Domain
-    # Sharing space which contains a domain.
-    # @!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::Domain::SharingSpace
-      )
-      alias sharing_space_uuid uuid
-    end
-  end
-end

data/lib/gandi_v5/live_dns/has_zone_records.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # Methods for handling record related requests in both
-    # GandiV5::LiveDNS::Domain and GandiV5::LiveDNS::Zone.
-    module HasZoneRecords
-      # @overload fetch_records()
-      #   Fetch all records for this domain.
-      # @overload fetch_records(name)
-      #   Fetch records for a name.
-      #   @param name [String] the name to fetch records for.
-      # @overload fetch_records(name, type)
-      #   Fetch records of a type for a name.
-      #   @param name [String] the name to fetch records for.
-      #   @param type [String] the record type to fetch.
-      # @return [Array<GandiV5::LiveDNS::RecordSet>]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def fetch_records(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type type if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-
-        _response, data = GandiV5.get url_
-        data = [data] unless data.is_a?(Array)
-        data.map { |item| GandiV5::LiveDNS::RecordSet.from_gandi item }
-      end
-
-      # @overload fetch_zone_lines()
-      #   Fetch all records for this domain.
-      # @overload fetch_zone_lines(name)
-      #   Fetch records for a name.
-      #   @param name [String] the name to fetch records for.
-      # @overload fetch_zone_lines(name, type)
-      #   Fetch records of a type for a name.
-      #   @param name [String] the name to fetch records for.
-      #   @param type [String] the record type to fetch.
-      # @return [String]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def fetch_zone_lines(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type type if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-
-        GandiV5.get(url_, accept: 'text/plain').last
-      end
-
-      # Add record to this domain.
-      # @param name [String]
-      # @param type [String]
-      # @param ttl [Integer]
-      # @param values [Array<String>]
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def add_record(name, type, ttl, *values)
-        GandiV5::LiveDNS.require_valid_record_type type
-        fail ArgumentError, 'ttl must be positive and non-zero' unless ttl.positive?
-        fail ArgumentError, 'there must be at least one value' if values.none?
-
-        body = {
-          rrset_name: name,
-          rrset_type: type,
-          rrset_ttl: ttl,
-          rrset_values: values
-        }.to_json
-        _response, data = GandiV5.post "#{url}/records", body
-        data['message']
-      end
-
-      # @overload delete_records()
-      #   Delete all records for this domain.
-      # @overload delete_records(name)
-      #   Delete records for a name.
-      #   @param name [String] the name to delete records for.
-      # @overload delete_records(name, type)
-      #   Delete records of a type for a name.
-      #   @param name [String] the name to delete records for.
-      #   @param type [String] the record type to delete.
-      # @return [nil]
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def delete_records(name = nil, type = nil)
-        GandiV5::LiveDNS.require_valid_record_type(type) if type
-
-        url_ = "#{url}/records"
-        url_ += "/#{CGI.escape name}" if name
-        url_ += "/#{CGI.escape type}" if type
-        GandiV5.delete(url_).last
-      end
-
-      # Replace all records for this domain.
-      # @param records
-      #   [Array<Hash<:name, :type => String, :ttl => Integer, :values => Array<String>>>]
-      #   the records to add.
-      # @param text [String] zone file lines to replace the records with.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [ArgumentError] if neither/both of records & test are passed.
-      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def replace_records(records: nil, text: nil)
-        unless [records, text].count(&:nil?).eql?(1)
-          fail ArgumentError, 'you must pass ONE of records: or text:'
-        end
-
-        if records
-          body = {
-            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-          }.to_json
-          _response, data = GandiV5.put "#{url}/records", body
-        elsif text
-          _response, data = GandiV5.put "#{url}/records", text, 'content-type': 'text/plain'
-        end
-        data['message']
-      end
-
-      # @override replace_records_for(name, records)
-      #   Replace records for a name in this domain.
-      #   @param name [String]
-      #   @param records
-      #     [Array<Hash<type: String, ttl: Integer, values: Array<String>>>]
-      #     the records to add.
-      # @override replace_records_for(name, values, type: nil, ttl: nil)
-      #   Replace records for a name in this domain.
-      #   @param name [String]
-      #   @param type [String] the record type.
-      #   @param ttl [Integer] the TTL to set for the record.
-      #   @param values [Array<String>] the values to set for the record.
-      #   @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.
-      def replace_records_for(name, records, type: nil, ttl: nil)
-        fail ArgumentError, 'missing keyword: type' if ttl && type.nil?
-
-        if type
-          GandiV5::LiveDNS.require_valid_record_type type
-          body = { rrset_values: records, rrset_ttl: ttl }
-          # body[:rrset_ttl] = ttl if ttl
-          _response, data = GandiV5.put "#{url}/records/#{name}/#{type}", body.to_json
-
-        else
-          body = {
-            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-          }
-          _response, data = GandiV5.put "#{url}/records/#{name}", body.to_json
-        end
-
-        data['message']
-      end
-    end
-  end
-end

data/lib/gandi_v5/live_dns/record_set.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class LiveDNS
-    # A record set which comes from either a domain or zone.
-    # @!attribute [r] type
-    #   @return [String]
-    # @!attribute [r] ttl
-    #   @return [Integer]
-    # @!attribute [r] name
-    #   @return [String]
-    # @!attribute [r] values
-    #   @return [Array<String>]
-    class RecordSet
-      include GandiV5::Data
-
-      member :type, gandi_key: 'rrset_type'
-      member :ttl, gandi_key: 'rrset_ttl', converter: GandiV5::Data::Converter::Integer
-      member :name, gandi_key: 'rrset_name'
-      member :values, gandi_key: 'rrset_values'
-
-      # Generate zone file lines for the record.
-      # @return [String]
-      def to_s
-        values.map do |value|
-          "#{name}\t#{ttl}\tIN\t#{type}\t#{value}"
-        end.join("\n")
-      end
-
-      GandiV5::LiveDNS::RECORD_TYPES.each do |t|
-        # Check the record type.
-        # @return [Boolean]
-        define_method "#{t.downcase}?" do
-          type.eql?(t)
-        end
-      end
-
-      # Check the TTL's value in seconds.
-      # @param number [Integer] the number of second(s) to check against.
-      # @return [Boolean]
-      def second?(number = 1)
-        ttl == number
-      end
-      alias seconds? second?
-
-      # Check the TTL's value in minutes.
-      # @param number [Integer] the number of minute(s) to check against.
-      # @return [Boolean]
-      def minute?(number = 1)
-        ttl == number * 60
-      end
-      alias minutes? minute?
-
-      # Check the TTL's value in hours.
-      # @param number [Integer] the number of hour(s) to check against.
-      # @return [Boolean]
-      def hour?(number = 1)
-        ttl == number * 3_600
-      end
-      alias hours? hour?
-
-      # Check the TTL's value in days.
-      # @param number [Integer] the number of day(s) to check against.
-      # @return [Boolean]
-      def day?(number = 1)
-        ttl == number * 86_400
-      end
-      alias days? day?
-
-      # Check the TTL's value in weeks.
-      # @param number [Integer] the number of week(s) to check against.
-      # @return [Boolean]
-      def week?(number = 1)
-        ttl == number * 604_800
-      end
-      alias weeks? day?
-    end
-  end
-end