dnsmadeeasy 0.3.5 → 0.4.0

data/dnsmadeeasy.gemspec

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# vim: ft=ruby
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dnsmadeeasy/version'
@@ -34,7 +36,6 @@ Gem::Specification.new do |spec|
   spec.email         = %w(kigster@gmail.com letuboy@gmail.com hjhart@gmail.com)
   spec.summary       = DnsMadeEasy::DESCRIPTION
   spec.description   = DnsMadeEasy::DESCRIPTION
-  # 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

data/lib/dme.rb

@@ -7,15 +7,10 @@ module DME
     def [](key, secret)
       ::DnsMadeEasy::Api::Client.new(key, secret)
     end
-
-    # rubocop:todo Style/MissingRespondToMissing
-    # rubocop:todo Style/MethodMissingSuper
     def method_missing(method, *args, &block)
       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

@@ -92,8 +92,6 @@ module DnsMadeEasy
     # 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)
@@ -101,7 +99,5 @@ module DnsMadeEasy
         super(method, *args, &block)
       end
     end
-    # rubocop:enable Style/MethodMissingSuper
-    # rubocop:enable Style/MissingRespondToMissing
   end
 end

data/lib/dnsmadeeasy/api/client.rb

@@ -169,17 +169,10 @@ module DnsMadeEasy
         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 }

data/lib/dnsmadeeasy/credentials.rb

@@ -89,9 +89,9 @@ module DnsMadeEasy
 
       # @return String path to the default credentials file.
       def default_credentials_path(user: nil)
-        user ? # rubocop:todo Style/MultilineTernaryOperator
-          File.expand_path(Dir.home(user) + '/.dnsmadeeasy/credentials.yml').freeze :
-          File.expand_path('~/.dnsmadeeasy/credentials.yml').freeze
+        File.expand_path(
+          user ? Dir.home(user) + '/.dnsmadeeasy/credentials.yml' : '~/.dnsmadeeasy/credentials.yml'
+        )
       end
     end
   end

data/lib/dnsmadeeasy/credentials/yaml_file.rb

@@ -21,28 +21,7 @@ module DnsMadeEasy
         return nil if mash.nil?
 
         creds = if mash.accounts.is_a?(Array)
-                  account = if account
-                              mash.accounts.find { |a| a.name == account.to_s }
-                            elsif
-                              # rubocop:todo Layout/ConditionPosition
-                              mash.accounts.size == 1
-                              # rubocop:enable Layout/ConditionPosition
-                              mash.accounts.first
-                            else
-                              mash.accounts.find(&:default_account)
-                            end
-
-                  unless account
-                    raise DnsMadeEasy::APIKeyAndSecretMissingError,
-                          (account ? "account #{account} was not found" : 'default account does not exist')
-                  end
-
-                  unless account.credentials
-                    raise DnsMadeEasy::InvalidCredentialsFormatError,
-                          'Expected account entry to have "credentials" key'
-                  end
-
-                  account.credentials
+                  credentials_from_array(mash.accounts, account&.to_s)
 
                 elsif mash.credentials
                   mash.credentials
@@ -52,11 +31,11 @@ module DnsMadeEasy
                         'expected either "accounts" or "credentials" as the top-level key'
                 end
 
-        # rubocop:todo Style/MultilineTernaryOperator
-        creds ? ApiKeys.new(creds.api_key,
-                            creds.api_secret,
-                            encryption_key || creds.encryption_key) : nil
-        # rubocop:enable Style/MultilineTernaryOperator
+        return nil unless creds
+
+        ApiKeys.new creds.api_key,
+                    creds.api_secret,
+                    encryption_key || creds.encryption_key
       end
 
       def to_s
@@ -65,6 +44,28 @@ module DnsMadeEasy
 
       private
 
+      def credentials_from_array(accounts, account_name = nil)
+        account = if account_name
+                    accounts.find { |a| a.name == account_name }
+                  elsif accounts.size == 1
+                    accounts.first
+                  else
+                    accounts.find(&:default_account)
+                  end
+
+        unless account
+          raise DnsMadeEasy::APIKeyAndSecretMissingError,
+                (account ? "account #{account} was not found" : 'Default account does not exist')
+        end
+
+        unless account.credentials
+          raise DnsMadeEasy::InvalidCredentialsFormatError,
+                'Expected an account entry to have the "credentials" key'
+        end
+
+        account.credentials
+      end
+
       def parse!
         self.mash = Hashie::Extensions::SymbolizeKeys.symbolize_keys(load_hash)
       end

data/lib/dnsmadeeasy/runner.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# vim: ft=ruby
+
 require 'colored2'
 require 'awesome_print'
 require 'dnsmadeeasy'
@@ -10,11 +12,12 @@ require 'etc'
 module DnsMadeEasy
   class Runner
     SUPPORTED_FORMATS = %w(json json_pretty yaml pp).freeze
+    SUPPORTED_FORMAT_FLAGS = SUPPORTED_FORMATS.map { |f| "--#{f}" }.freeze
 
     attr_accessor :format, :argv, :operation
 
     def initialize(argv = nil)
-      self.argv   = argv || ARGV.dup
+      self.argv = argv || ARGV.dup
       self.format = process_flags_format
     end
 
@@ -44,12 +47,10 @@ module DnsMadeEasy
       end
       0
     rescue ArgumentError => e
+      STDERR.puts(e.backtrace.join("\n").yellow)
       sig = method_signature(e, method)
-      # rubocop:todo Style/MultilineTernaryOperator
-      sig.shift == method.to_s ?
-        print_signature(method, sig) :
-        print_error('Action', method.to_s.bold.yellow.to_s, 'has generated an error'.red, exception: e)
-      # rubocop:enable Style/MultilineTernaryOperator
+      print_signature(method, sig) if sig.shift == method.to_s
+      print_error('Action', method.to_s.bold.yellow.to_s, 'has generated an error'.red, exception: e)
       1
     rescue NoMethodError => e
       print_error('Action', method.to_s.bold.yellow.to_s, 'is not valid.'.red)
@@ -62,58 +63,57 @@ module DnsMadeEasy
 
     def print_error(*args, exception: nil)
       unless args.empty?
-        # rubocop:todo Naming/HeredocDelimiterNaming
         puts <<~EOF
-          # rubocop:enable Naming/HeredocDelimiterNaming
-            #{'Error:'.bold.red} #{args.join(' ').red}
+          #{'Error:'.bold.red} #{args.join(' ').red}
         EOF
       end
 
       if exception
-        # rubocop:todo Naming/HeredocDelimiterNaming
         puts <<~EOF
-          # rubocop:enable Naming/HeredocDelimiterNaming
-            #{'Exception: '.bold.red}#{exception.inspect.red}
+          #{'Exception: '.bold.red}#{exception.inspect.red}
         EOF
       end
     end
 
     def print_signature(method, sig)
-      # rubocop:todo Naming/HeredocDelimiterNaming
-      puts <<~EOF # rubocop:todo Naming/HeredocDelimiterNaming
-        # rubocop:enable Naming/HeredocDelimiterNaming
-          #{'Error: '.bold.yellow}
-                #{'You are missing some arguments for this operation:'.red}
+      puts <<~EOF
+        #{'Error: '.bold.yellow}
+        #{'You are missing some arguments for this operation:'.red}
 
-                #{'Correct Usage: '.bold.yellow}
-                #{method.to_s.bold.green} #{sig.join(' ').blue}
+        #{'Correct Usage: '.bold.yellow}
+        #{method.to_s.bold.green} #{sig.join(' ').blue}
 
       EOF
     end
 
     def process_flags_format
-      if argv.first&.start_with?('--')
-        format = argv.shift.gsub(/^--/, '')
-        if format =~ /^h(elp)?$/i
-          print_help_message
-        end
+      if argv.first =~ /^op(erations)?$/i
+        print_supported_operations
+
+      elsif argv.include?('--help') || argv.include?('-h')
+        print_help_message
+
+      elsif !(argv & SUPPORTED_FORMAT_FLAGS).empty?
+        format_flag = (argv & SUPPORTED_FORMAT_FLAGS).first
+        format = format_flag.delete '--'
+        argv.delete(format_flag)
         unless SUPPORTED_FORMATS.include?(format)
-          puts "Error: format #{format.bold.red} is not supported."
-          puts "Supported values are: #{SUPPORTED_FORMATS.join(', ')}"
+          warn "Error: format #{format.bold.red} is not supported."
+          warn "Supported values are: #{SUPPORTED_FORMATS.join(', ')}"
           exit 1
         end
-      elsif argv.first =~ /^op(erations)?$/i
-        print_supported_operations
-        exit 0
+        format
       end
-      format
     end
 
     def configure_authentication
-      credentials_file = ENV['DNSMADEEASY_CREDENTIALS_FILE'] || DnsMadeEasy::Credentials.default_credentials_path(user: Etc.getlogin)
+      credentials_file = ENV['DNSMADEEASY_CREDENTIALS_FILE'] ||
+        DnsMadeEasy::Credentials.default_credentials_path(user: Etc.getlogin)
+
       if ENV['DNSMADEEASY_API_KEY'] && ENV['DNSMADEEASY_API_SECRET']
         DnsMadeEasy.api_key = ENV['DNSMADEEASY_API_KEY']
         DnsMadeEasy.api_secret = ENV['DNSMADEEASY_API_SECRET']
+
       elsif credentials_file && ::File.exist?(credentials_file)
         keys = DnsMadeEasy::Credentials.keys_from_file(file: credentials_file)
         if keys
@@ -125,61 +125,70 @@ module DnsMadeEasy
       if DnsMadeEasy.api_key.nil?
         print_error('API Key/Secret was not detected or read from file')
         puts('You can also set two environment variables: ')
-        puts('  DNSMADEEASY_API_KEY and DNSMADEEASY_API_SECRET')
+        puts('    • DNSMADEEASY_API_KEY and ')
+        puts('    • DNSMADEEASY_API_SECRET')
         exit 123
       end
     end
 
     def print_usage_message
-      # rubocop:todo Naming/HeredocDelimiterNaming
       puts <<~EOF
-        # rubocop:enable Naming/HeredocDelimiterNaming
-          #{'Usage:'.bold.yellow}
-                #{'# Execute an API call:'.dark}
-                #{"dme [ #{SUPPORTED_FORMATS.map { |f| "--#{f}" }.join(' | ')} ] operation [ arg1 arg2 ... ] ".bold.green}
-
-                #{'# Print suported operations:'.dark}
-                #{'dme op[erations]'.bold.green}
+        #{'Usage:'.bold.yellow}
+          #{'# Execute an API call:'.dark}
+          #{"dme [ #{SUPPORTED_FORMATS.map { |f| "--#{f}" }.join(' | ')} ] operation [ arg1 arg2 ... ] ".bold.green}
 
+          #{'# Print suported operations:'.dark}
+          #{'dme op[erations]'.bold.green}
       EOF
     end
 
     def print_help_message
       print_usage_message
-
-      # rubocop:todo Naming/HeredocDelimiterNaming
       puts <<~EOF
-        # rubocop:enable Naming/HeredocDelimiterNaming
-          #{header 'Credentials'}
-            Store your credentials in a YAML file
-            #{DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER'])} as follows:
 
+        #{header 'Credentials'}
+          Store your credentials in a YAML file #{DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER']).blue}
+          as follows:
+
+            #{'# ~/.dnsmadeeasy/credentials.yml'.bold.black}
             #{'credentials:
-              api_key: XXXX
-              api_secret: YYYY'.bold.magenta}
-
-            Or a multi-account version:
-
-            #{'accounts:
-              - name: production
-                credentials:
-                  api_key: XXXX
-                  api_secret: YYYY
-                  encryption_key: my_key
-              - name: development
-                default_account: true
-                credentials:
-                  api_key: ZZZZ
-                  api_secret: WWWW'.bold.magenta}
-
-          #{header 'Examples:'}
-             #{'dme domain moo.com
-             dme --json domain moo.com
-             dme find_all moo.com A www
-             dme find_first moo.com CNAME vpn-west
-             dme --yaml find_first moo.com CNAME vpn-west'.green}
+        api_key: XXXX
+        api_secret: YYYY'.cyan}
+
+          Or, you can use a multi-account version, but in that case it helps if you
+          specify which of the accounts is the default:
 
       EOF
+
+      puts <<-YAML
+    #{'# ~/.dnsmadeeasy/credentials.yml'.bold.black}
+    #{'accounts:
+    - name: production
+      credentials:
+        api_key: XXXX
+        api_secret: YYYY
+        encryption_key: my_key
+    - name: development
+      default_account: true
+      credentials:
+        api_key: ZZZZ
+        api_secret: WWWW'.cyan}
+      YAML
+
+      puts header 'Examples:'
+
+      puts '
+  $ dme domain moo.com
+  $ dme domain moo.com --yaml > moo.yml
+
+  $ dme all            moo.com
+  $ dme find_all       moo.com A          www
+  $ dme find_first     moo.com CNAME      vpn-west
+
+  $ dme update_record  moo.com www    A   11.3.43.56
+  $ dme create_record  moo.com ftp CNAME  www.moo.com.
+
+  $ dme --yaml find_first moo.com CNAME vpn-west'.green
       exit 1
     end
 
@@ -188,17 +197,14 @@ module DnsMadeEasy
     end
 
     def print_supported_operations
-      # rubocop:todo Naming/HeredocDelimiterNaming
       puts <<~EOF
-        # rubocop:enable Naming/HeredocDelimiterNaming
-          #{header 'Actions:'}
-            Checkout the README and RubyDoc for the arguments to each operation,
-            which is basically a method on a DnsMadeEasy::Api::Client instance.
-            #{'http://www.rubydoc.info/gems/dnsmadeeasy/DnsMadeEasy/Api/Client'.blue.bold.underlined}
-
-          #{header 'Valid Operations Are:'}
-            #{DnsMadeEasy::Api::Client.public_operations.join("\n  ").green.bold}
+        #{header 'Actions:'}
+          Checkout the README and RubyDoc for the arguments to each operation,
+          which is basically a method on a DnsMadeEasy::Api::Client instance.
+          #{'http://www.rubydoc.info/gems/dnsmadeeasy/DnsMadeEasy/Api/Client'.blue.bold.underlined}
 
+        #{header 'Valid Operations Are:'}
+          #{DnsMadeEasy::Api::Client.public_operations.join("\n  ").green.bold}
       EOF
     end
 
@@ -220,10 +226,9 @@ module DnsMadeEasy
 
     # e.backtrack.first looks like this:
     # ..../dnsmadeeasy/lib/dnsmadeeasy/api/client.rb:143:in `create_a_record'
-    # rubocop:todo Naming/MethodParameterName
     def method_signature(e, method)
       file, line, call_method = e.backtrace.first.split(':')
-      call_method             = call_method.gsub(/[']/, '').split('`').last
+      call_method = call_method.gsub(/[']/, '').split('`').last
       if call_method && call_method.to_sym == method.to_sym
         source_line = File.open(file).to_a[line.to_i - 1].chomp!
         if source_line =~ /def #{method}/
@@ -236,7 +241,6 @@ module DnsMadeEasy
     rescue StandardError
       []
     end
-    # rubocop:enable Naming/MethodParameterName
 
     def puts(*args)
       super(*args)

data/lib/dnsmadeeasy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DnsMadeEasy
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnsmadeeasy
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -227,6 +227,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".dme-help.png"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -234,7 +236,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.adoc
 - Rakefile
 - bin/console
 - bin/setup
@@ -277,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: 'This is an authoratative and fully-featured API client for the DNS Provider