dnsmadeeasy 0.3.2 → 0.3.5

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'dnsmadeeasy'

data/dnsmadeeasy.gemspec

@@ -1,37 +1,50 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dnsmadeeasy/version'
 
-DnsMadeEasy::DESCRIPTION = <<-eof
-This is a fully-featured DNS API client for DnsMadeEasy.com, that includes
-both the Ruby API and a corresponding CLI interface. This gem is based on the 
-"dnsmadeeasy-rest-api". We also wish to thank the original author Phil Cohen who 
-kindly passed on the RubyGems namespace, and now you can install just plain simple
-install "dnsmadeeasy" gem. The gem additionally supports storing credentials in the
-~/.dnsmadeeasy/credentials.yml file, supports multiple accounts, encryption, and more.
+# rubocop:todo Naming/HeredocDelimiterCase
+DnsMadeEasy::DESCRIPTION = <<~eof
+    This is an authoratative and fully-featured API client for the DNS Provider "DnsMadeEasy.com".
+
+    This library offers both a rich Ruby API that you can use to automate DNS record management, as well
+    as a rich CLI interface with the command line executable "dme" installed when you install the gem.
+    The gem additionally supports storing credentials in the ~/.dnsmadeeasy/credentials.yml
+    file, supports multiple accounts, encryption, and more.
+
+    If you are using Chef consider using the "dnsmadeeasy" Chef Cookbook, while uses this gem behind
+    the scenes: https://supermarket.chef.io/cookbooks/dnsmadeeasy<br />
+
+    ACKNOWLEDGEMENTS:
+
+    1. This gem is based on the original work contributed by Wanelo.com to the
+       now abandonded "dnsmadeeasy-rest-api" client.
+
+    2. We also wish to thank the gem author Phil Cohen who
+       kindly yielded the "dnsmadeeasy" RubyGems namespace to this gem.
+
+    3. We also thank Praneeth Are for contributing the support for secondary domains in 0.3.5.
 eof
 
 Gem::Specification.new do |spec|
   spec.name          = 'dnsmadeeasy'
   spec.version       = DnsMadeEasy::VERSION
-  spec.authors       = ['Konstantin Gredeskoul', 'Arnoud Vermeer', 'Paul Henry', 'James Hart', 'Phil Cohen']
+  spec.authors       = ['Konstantin Gredeskoul', 'Arnoud Vermeer', 'Paul Henry', 'James Hart', 'Phil Cohen', 'Praneeth Are']
   spec.email         = %w(kigster@gmail.com letuboy@gmail.com hjhart@gmail.com)
   spec.summary       = DnsMadeEasy::DESCRIPTION
   spec.description   = DnsMadeEasy::DESCRIPTION
-  spec.post_install_message = <<-EOF
-
-Thank you for using the DnsMadeEasy ruby gem, the Ruby client 
-API for DnsMadeEasy.com's SDK v2. Please note that this gem 
-comes with a command line utility 'dme' which you can use 
-instead of the ruby API if you prefer. Run `dme` with no
-arguments to see the help message.
-
-You can store your credentials in a YAML file in your home
-directory. For more information, please see README at:
-https://github.com/kigster/dnsmadeeasy
+  # rubocop:todo Naming/HeredocDelimiterNaming
+  spec.post_install_message = <<~EOF
+      Thank you for using the DnsMadeEasy ruby gem, the Ruby client
+      API for DnsMadeEasy.com's SDK v2. Please note that this gem
+      comes with a rich command line utility 'dme' which you can use
+      instead of the ruby API if you prefer. Run `dme` with no
+      arguments to see the help message.
 
+      You can also store (multi-account) credentials in a YAML file in
+      your home directory. For more information, please see README at:
+      https://github.com/kigster/dnsmadeeasy
   EOF
 
   spec.homepage      = 'https://github.com/kigster/dnsmadeeasy'
@@ -40,24 +53,25 @@ https://github.com/kigster/dnsmadeeasy
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'sym'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'colored2'
   spec.add_dependency 'awesome_print'
+  spec.add_dependency 'colored2'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'sym'
 
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'relaxed-rubocop'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
 
   # spec.add_development_dependency 'aruba'
 end

data/exe/dme

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'dnsmadeeasy/runner'
 
 DnsMadeEasy::Runner.new(ARGV).execute!
-
-
-

data/lib/dme.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dnsmadeeasy'
 
 module DME
@@ -6,12 +8,14 @@ module DME
       ::DnsMadeEasy::Api::Client.new(key, secret)
     end
 
+    # rubocop:todo Style/MissingRespondToMissing
+    # rubocop:todo Style/MethodMissingSuper
     def method_missing(method, *args, &block)
-      begin
-        DnsMadeEasy.send(method, *args, &block)
-      rescue NameError => e
-        puts "Error: #{e.message}"
-      end
+      DnsMadeEasy.send(method, *args, &block)
+    rescue NameError => e
+      puts "Error: #{e.message}"
     end
+    # rubocop:enable Style/MethodMissingSuper
+    # rubocop:enable Style/MissingRespondToMissing
   end
 end

data/lib/dnsmadeeasy.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module DnsMadeEasy
   API_BASE_URL_PRODUCTION = 'https://api.dnsmadeeasy.com/V2.0'
-  API_BASE_URL_SANDBOX    = 'https://sandboxapi.dnsmadeeasy.com/V2.0'
+  API_BASE_URL_SANDBOX    = 'https://api.sandbox.dnsmadeeasy.com/V2.0'
 end
 
 require 'dnsmadeeasy/version'
@@ -22,6 +24,8 @@ module DnsMadeEasy
   end
   class NoSuchAccountError < Error;
   end
+  class NoDomainError < Error;
+  end
 
   class << self
     attr_accessor :default_api_key,
@@ -36,9 +40,10 @@ module DnsMadeEasy
                             encryption_key = nil)
 
       credentials = ::DnsMadeEasy::Credentials.keys_from_file(
-        file:           file || ::DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER']),
-        account:        account,
-        encryption_key: encryption_key)
+        file: file || ::DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER']),
+        account: account,
+        encryption_key: encryption_key
+      )
       if credentials
         configure do |config|
           config.api_key    = credentials.api_key
@@ -53,8 +58,8 @@ module DnsMadeEasy
                               account: nil,
                               encryption_key: nil)
 
-      DnsMadeEasy::Credentials.keys_from_file file:           file,
-                                              account:        account,
+      DnsMadeEasy::Credentials.keys_from_file file: file,
+                                              account: account,
                                               encryption_key: encryption_key
     end
 
@@ -75,17 +80,20 @@ module DnsMadeEasy
     end
 
     def create_client(sandbox = false,
-                      api_key: self.default_api_key,
-                      api_secret: self.default_api_secret,
+                      api_key: default_api_key,
+                      api_secret: default_api_secret,
 
                       **options)
       raise APIKeyAndSecretMissingError, 'Please set #api_key and #api_secret' unless api_key && api_secret
+
       ::DnsMadeEasy::Api::Client.new(api_key, api_secret, sandbox, **options)
     end
 
     # Basically delegate it all to the Client instance
     # if the method call is supported.
     #
+    # rubocop:todo Style/MissingRespondToMissing
+    # rubocop:todo Style/MethodMissingSuper
     def method_missing(method, *args, &block)
       if client.respond_to?(method)
         client.send(method, *args, &block)
@@ -93,5 +101,7 @@ module DnsMadeEasy
         super(method, *args, &block)
       end
     end
+    # rubocop:enable Style/MethodMissingSuper
+    # rubocop:enable Style/MissingRespondToMissing
   end
 end

data/lib/dnsmadeeasy/api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 require 'openssl'
 require 'json'
@@ -9,7 +11,6 @@ require 'dnsmadeeasy/credentials'
 module DnsMadeEasy
   module Api
     class Client
-
       class << self
         def public_operations
           (new('a', 'b').methods - Object.methods).map(&:to_s).reject { |r| r =~ /[=]$|^(api_|on_|request)/ }.sort
@@ -22,7 +23,6 @@ module DnsMadeEasy
                   :api_key,
                   :api_secret
 
-
       def initialize(api_key, api_secret, sandbox = false, options = {})
         fail 'api_key is undefined' unless api_key
         fail 'api_secret is undefined' unless api_secret
@@ -36,17 +36,14 @@ module DnsMadeEasy
         sandbox ? on_sandbox : on_production
       end
 
-
       def on_sandbox(&block)
         with_url(::DnsMadeEasy::API_BASE_URL_SANDBOX, &block)
       end
 
-
       def on_production(&block)
         with_url(::DnsMadeEasy::API_BASE_URL_PRODUCTION, &block)
       end
 
-
       # -----------------------------------
       # ------------- DOMAINS -------------
       # -----------------------------------
@@ -55,32 +52,26 @@ module DnsMadeEasy
         get("/dns/managed/id/#{domain_name}")['id']
       end
 
-
       def domains
         get '/dns/managed/'
       end
 
-
       def domain(domain_name)
         get "/dns/managed/#{get_id_by_domain(domain_name)}"
       end
 
-
       def delete_domain(domain_name)
         delete "/dns/managed/#{get_id_by_domain(domain_name)}"
       end
 
-
       def create_domains(names)
         post('/dns/managed/', names: names)
       end
 
-
       def create_domain(domain_name)
         create_domains([domain_name])
       end
 
-
       # -----------------------------------
       # ------------- RECORDS -------------
       # -----------------------------------
@@ -89,55 +80,49 @@ module DnsMadeEasy
         get "/dns/managed/#{get_id_by_domain(domain_name)}/records"
       end
 
-
       alias all records_for
 
-
       def find_all(domain_name, name, type)
         records = records_for(domain_name)
         return nil unless records
+
         records['data'].select { |r| r['name'] == name && r['type'] == type }
       end
 
-
       def find_first(domain_name, name, type)
         records = records_for(domain_name)
         return nil unless records
+
         records['data'].detect { |r| r['name'] == name && r['type'] == type }
       end
 
-
       def find_record_ids(domain_name, name, type)
         records = records_for(domain_name)
         records['data'].select { |r| r['name'] == name && r['type'] == type }.map { |r| r['id'] }
       end
 
-
       def delete_record(domain_name, record_id)
         delete "/dns/managed/#{get_id_by_domain(domain_name)}/records/#{record_id}/"
       end
 
-
       def delete_records(domain_name, ids = [])
         return if ids.empty?
+
         domain_id = get_id_by_domain(domain_name)
 
         delete "/dns/managed/#{domain_id}/records?ids=#{ids.join(',')}"
       end
 
-
       def delete_all_records(domain_name)
         domain_id = get_id_by_domain(domain_name)
         delete "/dns/managed/#{domain_id}/records"
       end
 
-
       def create_record(domain_name, name, type, value, options = {})
         body = { 'name' => name, 'type' => type, 'value' => value, 'ttl' => 3600, 'gtdLocation' => 'DEFAULT' }
         post "/dns/managed/#{get_id_by_domain(domain_name)}/records/", body.merge(options)
       end
 
-
       # Specific record types
 
       def create_a_record(domain_name, name, value, options = {})
@@ -145,81 +130,141 @@ module DnsMadeEasy
         create_record domain_name, name, 'A', value, options
       end
 
-
       def create_aaaa_record(domain_name, name, value, options = {})
         # TODO: match IPv6 for value
         create_record domain_name, name, 'AAAA', value, options
       end
 
-
       def create_ptr_record(domain_name, name, value, options = {})
         # TODO: match PTR value
         create_record domain_name, name, 'PTR', value, options
       end
 
-
       def create_txt_record(domain_name, name, value, options = {})
         # TODO: match TXT value
         create_record domain_name, name, 'TXT', value, options
       end
 
-
       def create_cname_record(domain_name, name, value, options = {})
         # TODO: match CNAME value
         create_record domain_name, name, 'CNAME', value, options
       end
 
-
       def create_ns_record(domain_name, name, value, options = {})
         # TODO: match domainname for value
         create_record domain_name, name, 'NS', value, options
       end
 
-
       def create_spf_record(domain_name, name, value, options = {})
         create_record domain_name, name, 'SPF', value, options
       end
 
-
       def create_mx_record(domain_name, name, priority, value, options = {})
         options.merge!('mxLevel' => priority)
 
         create_record domain_name, name, 'MX', value, options
       end
 
-
       def create_srv_record(domain_name, name, priority, weight, port, value, options = {})
         options.merge!('priority' => priority, 'weight' => weight, 'port' => port)
         create_record domain_name, name, 'SRV', value, options
       end
 
-
+      # rubocop:todo Naming/MethodParameterName
+      # rubocop:todo Naming/VariableName
       def create_httpred_record(domain_name, name, value, redirectType = 'STANDARD - 302', description = '', keywords = '', title = '', options = {})
+        # rubocop:enable Naming/VariableName
+        # rubocop:todo Naming/VariableName
         options.merge!('redirectType' => redirectType, 'description' => description, 'keywords' => keywords, 'title' => title)
+        # rubocop:enable Naming/VariableName
         create_record domain_name, name, 'HTTPRED', value, options
       end
-
+      # rubocop:enable Naming/MethodParameterName
 
       def update_record(domain, record_id, name, type, value, options = {})
         body = { 'name' => name, 'type' => type, 'value' => value, 'ttl' => 3600, 'gtdLocation' => 'DEFAULT', 'id' => record_id }
         put "/dns/managed/#{get_id_by_domain(domain)}/records/#{record_id}/", body.merge(options)
       end
 
-
       def update_records(domain, records, options = {})
         body = records.map do |record|
           {
-            'id'          => record['id'],
-            'name'        => record['name'],
-            'type'        => record['type'],
-            'value'       => record['value'],
+            'id' => record['id'],
+            'name' => record['name'],
+            'type' => record['type'],
+            'value' => record['value'],
             'gtdLocation' => record['gtdLocation'],
-            'ttl'         => record['ttl']
+            'ttl' => record['ttl']
           }.merge(options)
         end
         put "/dns/managed/#{get_id_by_domain(domain)}/records/updateMulti/", body
       end
 
+      # -----------------------------------
+      # ------- Secondary Domains ---------
+      # -----------------------------------
+
+      def secondary_domains
+        get '/dns/secondary'
+      end
+
+      def secondary_domain(domain_id)
+        get "/dns/secondary/#{domain_id}"
+      end
+
+      def create_secondary_domains(domain_names, ip_set_id)
+        body = { names: domain_names, ipSetId: ip_set_id }
+        post '/dns/secondary', body
+      end
+
+      def create_secondary_domain(domain_name, ip_set_id)
+        domains = [domain_name]
+        create_secondary_domains(domains, ip_set_id)
+      end
+
+      def update_secondary_domains(domain_ids, ip_set_id)
+        body = { ids: domain_ids, ipSetId: ip_set_id }
+        put '/dns/secondary', body
+      end
+
+      def get_id_by_secondary_domain(domain_name)
+        domain_data = secondary_domains['data'].find do |domain|
+          domain['name'] == domain_name
+        end
+        raise NoDomainError, "#{domain_name} does not exist" unless domain_data
+
+        domain_data['id']
+      end
+
+      def delete_secondary_domain(domain_name)
+        delete "/dns/secondary/#{get_id_by_secondary_domain(domain_name)}"
+      end
+
+      # -----------------------------------
+      # ------- Secondary IpSet -----------
+      # -----------------------------------
+
+      def secondary_ip_sets
+        get '/dns/secondary/ipSet'
+      end
+
+      def secondary_ip_set(ip_set_id)
+        get "/dns/secondary/ipSet/#{ip_set_id}"
+      end
+
+      def create_secondary_ip_set(name, ips)
+        body = { name: name, ips: ips }
+        post '/dns/secondary/ipSet', body
+      end
+
+      def update_secondary_ip_set(ip_set_id, name, ips)
+        body = { name: name, id: ip_set_id, ips: ips }
+        put "/dns/secondary/ipSet/#{ip_set_id}", body
+      end
+
+      def delete_secondary_ip_set(ip_set_id)
+        delete "/dns/secondary/ipSet/#{ip_set_id}"
+      end
 
       private
 
@@ -229,7 +274,6 @@ module DnsMadeEasy
         end
       end
 
-
       def delete(path, body = nil)
         request(path) do |uri|
           req      = Net::HTTP::Delete.new(uri)
@@ -238,7 +282,6 @@ module DnsMadeEasy
         end
       end
 
-
       def put(path, body = nil)
         request(path) do |uri|
           req      = Net::HTTP::Put.new(uri)
@@ -247,7 +290,6 @@ module DnsMadeEasy
         end
       end
 
-
       def post(path, body)
         request(path) do |uri|
           req      = Net::HTTP::Post.new(uri)
@@ -256,7 +298,6 @@ module DnsMadeEasy
         end
       end
 
-
       def request(path)
         uri = URI("#{base_uri}#{path}")
 
@@ -275,7 +316,6 @@ module DnsMadeEasy
         process_response!(http.request(request))
       end
 
-
       def process_response!(response)
         response.value # raise Net::HTTPServerException unless response was 2xx
         process_rate_limits(response)
@@ -283,13 +323,12 @@ module DnsMadeEasy
         Hashie::Mash.new(JSON.parse(unparsed_json))
       rescue Net::HTTPServerException => e
         if e.message =~ /403.*forbidden/i
-          raise ::DnsMadeEasy::AuthenticationError.new(e)
+          raise ::DnsMadeEasy::AuthenticationError, e
         else
           raise e
         end
       end
 
-
       def process_rate_limits(response)
         response.each_header do |header, value|
           @requests_remaining = value.to_i if header == 'x-dnsme-requestsremaining'
@@ -297,21 +336,19 @@ module DnsMadeEasy
         end
       end
 
-
       def request_headers
         request_date = Time.now.httpdate
         hmac         = OpenSSL::HMAC.hexdigest('sha1', @api_secret, request_date)
         {
-          'Accept'              => 'application/json',
-          'x-dnsme-apiKey'      => @api_key,
+          'Accept' => 'application/json',
+          'x-dnsme-apiKey' => @api_key,
           'x-dnsme-requestDate' => request_date,
-          'x-dnsme-hmac'        => hmac
+          'x-dnsme-hmac' => hmac
         }
       end
 
-
       def with_url(url)
-        old_value     = self.base_uri
+        old_value     = base_uri
         self.base_uri = url
         if block_given?
           yield