dnsmadeeasy 0.3.2 → 0.3.5

data/lib/dnsmadeeasy/credentials.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'dnsmadeeasy'
 require 'hashie/extensions/mash/symbolize_keys'
@@ -71,9 +73,7 @@ module DnsMadeEasy
   # )
 
   module Credentials
-
     class << self
-
       # Create a new instance of Credentials::ApiKeys
       def create(key, secret, encryption_key = nil)
         ApiKeys.new(key, secret, encryption_key)
@@ -83,13 +83,13 @@ module DnsMadeEasy
                          account: nil,
                          encryption_key: nil)
 
-        YamlFile.new(file: file).keys(account:        account,
+        YamlFile.new(file: file).keys(account: account,
                                       encryption_key: encryption_key)
       end
 
       # @return String path to the default credentials file.
       def default_credentials_path(user: nil)
-        user ?
+        user ? # rubocop:todo Style/MultilineTernaryOperator
           File.expand_path(Dir.home(user) + '/.dnsmadeeasy/credentials.yml').freeze :
           File.expand_path('~/.dnsmadeeasy/credentials.yml').freeze
       end

data/lib/dnsmadeeasy/credentials/api_keys.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'dnsmadeeasy'
 require 'hashie/extensions/mash/symbolize_keys'
@@ -11,7 +13,7 @@ module DnsMadeEasy
     # Immutable instance with key and secret.
     #
     class ApiKeys
-      API_KEY_REGEX = /^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{12})$/
+      API_KEY_REGEX = /^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{12})$/.freeze
 
       attr_reader :api_key,
                   :api_secret,
@@ -24,12 +26,12 @@ module DnsMadeEasy
       def initialize(key, secret, encryption_key = nil, default: false, account: nil)
         raise InvalidCredentialKeys, "Key and Secret can not be nil" if key.nil? || secret.nil?
 
-        @default      = default
+        @default = default
         @account = account
 
         if !valid?(key, secret) && encryption_key
           @encryption_key = sym_resolve(encryption_key)
-          @api_key    = decr(key, @encryption_key)
+          @api_key = decr(key, @encryption_key)
           @api_secret = decr(secret, @encryption_key)
         else
           @api_key    = key
@@ -54,10 +56,10 @@ module DnsMadeEasy
       end
 
       def rofl(key)
-        Digest::SHA256::hexdigest(key) if key
+        Digest::SHA256.hexdigest(key) if key
       end
 
-      def valid?(key = self.api_key, secret = self.api_secret)
+      def valid?(key = api_key, secret = api_secret)
         key &&
           secret &&
           API_KEY_REGEX.match(key) &&

data/lib/dnsmadeeasy/credentials/yaml_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'dnsmadeeasy'
 require 'hashie/extensions/symbolize_keys'
@@ -6,7 +8,6 @@ require_relative 'api_keys'
 
 module DnsMadeEasy
   module Credentials
-
     class YamlFile
       attr_accessor :filename, :account, :mash
 
@@ -23,17 +24,23 @@ module DnsMadeEasy
                   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 { |a| a.default_account }
+                              mash.accounts.find(&:default_account)
                             end
 
-                  raise DnsMadeEasy::APIKeyAndSecretMissingError,
-                        (account ? "account #{account} was not found" : 'default account does not exist') unless account
+                  unless account
+                    raise DnsMadeEasy::APIKeyAndSecretMissingError,
+                          (account ? "account #{account} was not found" : 'default account does not exist')
+                  end
 
-                  raise DnsMadeEasy::InvalidCredentialsFormatError,
-                        'Expected account entry to have "credentials" key' unless account.credentials
+                  unless account.credentials
+                    raise DnsMadeEasy::InvalidCredentialsFormatError,
+                          'Expected account entry to have "credentials" key'
+                  end
 
                   account.credentials
 
@@ -45,9 +52,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
       end
 
       def to_s
@@ -69,10 +78,8 @@ module DnsMadeEasy
       end
 
       def load_hash
-        Hashie::Mash.new(YAML.load(contents))
+        Hashie::Mash.new(YAML.safe_load(contents))
       end
-
     end
-
   end
 end

data/lib/dnsmadeeasy/dme.rb

@@ -1,5 +1,3 @@
-require_relative '../dme'
-
-
-
+# frozen_string_literal: true
 
+require_relative '../dme'

data/lib/dnsmadeeasy/runner.rb

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'colored2'
 require 'awesome_print'
 require 'dnsmadeeasy'
 require 'dnsmadeeasy/api/client'
-
+require 'etc'
 
 module DnsMadeEasy
   class Runner
-    SUPPORTED_FORMATS = %w(json json_pretty yaml pp)
+    SUPPORTED_FORMATS = %w(json json_pretty yaml pp).freeze
 
     attr_accessor :format, :argv, :operation
 
@@ -18,7 +19,7 @@ module DnsMadeEasy
     end
 
     def execute!
-      if argv.empty? || argv.size < 1
+      if argv.empty? || argv.empty?
         print_help_message
       else
         configure_authentication
@@ -30,59 +31,62 @@ module DnsMadeEasy
     private
 
     def call_through_client(method)
-      begin
-        result = DnsMadeEasy.client.send(method, *argv)
-        case result
-          when NilClass
-            puts 'No records returned.'
-          when Hashie::Mash
-            print_formatted(result.to_hash, format)
-          when Array
-            print_formatted(result, format)
-          else
-            print_formatted(result, format)
-        end
-        0
-      rescue ArgumentError => e
-        sig = method_signature(e, method)
-        (sig.shift == method.to_s) ?
-          print_signature(method, sig) :
-          print_error('Action', "#{method.to_s.bold.yellow}", 'has generated an error'.red, exception: e)
-        1
-      rescue NoMethodError => e
-
-        puts e.backtrace.reverse.join("\n").red
-
-        print_error('Action', "#{method.to_s.bold.yellow}", 'is not valid.'.red)
-        puts 'HINT: try running ' + 'dme operations'.bold.green + ' to see the list of valid operations.'
-        2
-      rescue Net::HTTPServerException => e
-        print_error(exception: e)
-        3
+      result = DnsMadeEasy.client.send(method, *argv)
+      case result
+      when NilClass
+        puts 'No records returned.'
+      when Hashie::Mash
+        print_formatted(result.to_hash, format)
+      when Array
+        print_formatted(result, format)
+      else
+        print_formatted(result, format)
       end
+      0
+    rescue ArgumentError => e
+      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
+      1
+    rescue NoMethodError => e
+      print_error('Action', method.to_s.bold.yellow.to_s, 'is not valid.'.red)
+      puts 'HINT: try running ' + 'dme operations'.bold.green + ' to see the list of valid operations.'
+      2
+    rescue Net::HTTPServerException => e
+      print_error(exception: e)
+      3
     end
 
     def print_error(*args, exception: nil)
       unless args.empty?
-        puts <<-EOF
-#{'Error:'.bold.red} #{args.join(' ').red}
+        # rubocop:todo Naming/HeredocDelimiterNaming
+        puts <<~EOF
+          # rubocop:enable Naming/HeredocDelimiterNaming
+            #{'Error:'.bold.red} #{args.join(' ').red}
         EOF
       end
 
       if exception
-        puts <<-EOF
-#{'Exception: '.bold.red}#{exception.inspect.red}
+        # rubocop:todo Naming/HeredocDelimiterNaming
+        puts <<~EOF
+          # rubocop:enable Naming/HeredocDelimiterNaming
+            #{'Exception: '.bold.red}#{exception.inspect.red}
         EOF
       end
     end
 
     def print_signature(method, sig)
-      puts <<-EOF
-#{'Error: '.bold.yellow}
-      #{'You are missing some arguments for this operation:'.red}
+      # 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}
 
-      #{'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
@@ -98,7 +102,7 @@ module DnsMadeEasy
           puts "Supported values are: #{SUPPORTED_FORMATS.join(', ')}"
           exit 1
         end
-      elsif argv.first =~ /^ope?r?a?t?i?o?n?$/i
+      elsif argv.first =~ /^op(erations)?$/i
         print_supported_operations
         exit 0
       end
@@ -106,32 +110,36 @@ module DnsMadeEasy
     end
 
     def configure_authentication
-      keys = DnsMadeEasy::Credentials.keys_from_file(
-        file: ENV['DNSMADEEASY_CREDENTIALS_FILE'] || DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER'])
-      )
-      if keys
-        DnsMadeEasy.api_key = keys.api_key
-        DnsMadeEasy.api_secret = keys.api_secret
-      else
-        raise DnsMadeEasy::APIKeyAndSecretMissingError
+      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
+          DnsMadeEasy.api_key = keys.api_key
+          DnsMadeEasy.api_secret = keys.api_secret
+        end
       end
-    rescue DnsMadeEasy::APIKeyAndSecretMissingError => e
-      print_error(e.message)
-
-      puts('You can also set two environment variables: ')
-      puts('  DNSMADEEASY_API_KEY and DNSMADEEASY_API_SECRET')
 
-      exit 123
+      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')
+        exit 123
+      end
     end
 
     def print_usage_message
-      puts <<-EOF
-#{'Usage:'.bold.yellow}
-      #{'# Execute an API call:'.dark}
-      #{"dme [ #{SUPPORTED_FORMATS.map { |f| "--#{f}" }.join(' | ')} ] operation [ arg1 arg2 ... ] ".bold.green}
+      # 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}
+                #{'# Print suported operations:'.dark}
+                #{'dme op[erations]'.bold.green}
 
       EOF
     end
@@ -139,53 +147,57 @@ module DnsMadeEasy
     def print_help_message
       print_usage_message
 
-      puts <<-EOF
-#{header 'Credentials'}
-  Store your credentials in a YAML file 
-  #{DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER'])} as follows:
-
-  #{'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}
+      # 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:
+
+            #{'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}
 
       EOF
       exit 1
     end
 
     def header(message)
-      "#{message.bold.yellow}"
+      message.bold.yellow.to_s
     end
 
     def print_supported_operations
-      puts <<-EOF
-#{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}
+      # 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 'Valid Operations Are:'}
+            #{DnsMadeEasy::Api::Client.public_operations.join("\n  ").green.bold}
 
       EOF
     end
@@ -208,23 +220,26 @@ 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
       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}/
-          signature = source_line.strip.gsub(/,/, '').split(%r{[ ()]})
+          signature = source_line.strip.gsub(/,/, '').split(/[ ()]/)
           signature.shift # remove def
           return signature.reject { |a| a =~ /^([={}\)\(])*$/ }
         end
       end
       []
-    rescue
+    rescue StandardError
       []
     end
+    # rubocop:enable Naming/MethodParameterName
+
+    def puts(*args)
+      super(*args)
+    end
   end
 end
-
-
-