sym 2.8.2 → 3.0.1

data/lib/sym/app/commands.rb

@@ -37,7 +37,7 @@ module Sym
         # Sort commands based on the #dependencies array, which itself is sorted
         # based on command dependencies.
         def sorted_commands
-          @sorted_commands ||= self.commands.to_a.sort_by{|klass| dependencies.index(klass.short_name) }
+          @sorted_commands ||= self.commands.to_a.sort_by{ |klass| dependencies.index(klass.short_name) }
           @sorted_commands
         end
 

data/lib/sym/app/commands/base_command.rb

@@ -50,6 +50,7 @@ module Sym
         extend Forwardable
 
         attr_accessor :application
+
         def_delegators :@application, :opts, :opts_slop, :key, :stdin, :stdout, :stderr, :kernel
 
         def initialize(application)
@@ -73,7 +74,7 @@ module Sym
         end
 
         def add_to_keychain_if_needed(key)
-          if opts[:keychain] && Sym::App.is_osx?
+          if opts[:keychain] && Sym::App.osx?
             Sym::App::KeyChain.new(opts[:keychain], opts).add(key)
           else
             key

data/lib/sym/app/commands/bash_completion.rb

@@ -15,7 +15,7 @@ module Sym
           file = opts[:bash_support]
 
           out = ''
-          Sym::Constants::Bash::Config.each_pair do |key, config|
+          Sym::Constants.config.each_pair do |key, config|
             script_name = key.to_s
 
             # This removes the old version of this file.
@@ -43,14 +43,14 @@ module Sym
           out << "\nPlease reload your terminal session to activate bash completion\n"
           out << "and other installed BASH utilities.\n"
           out << "\nAlternatively, just type #{"source #{file}".bold.green} to reload BASH.\n"
-          out << "Also — go ahead and try running #{"sym -h".bold.blue} and #{"symit -h".bold.blue}.\n"
+          out << "Also — go ahead and try running #{'sym -h'.bold.blue} and #{'symit -h'.bold.blue}.\n"
         end
 
         private
 
         def append_completion_script(file, script)
           File.open(file, 'a') do |fd|
-            fd.write(script + "\n")
+            fd.write("#{script}\n")
           end
         end
 

data/lib/sym/app/commands/keychain_add_key.rb

@@ -13,7 +13,7 @@ module Sym
 
         def execute
           if Sym.default_key? && Sym.default_key == self.key
-            raise 'Refusing to import key specified in the default key file ' + Sym.default_key_file.italic
+            raise "Refusing to import key specified in the default key file #{Sym.default_key_file.italic}"
           end
           raise Sym::Errors::NoPrivateKeyFound.new("Unable to resolve private key from argument '#{opts[:key]}'") if self.key.nil?
           add_to_keychain_if_needed(self.key)

data/lib/sym/app/commands/open_editor.rb

@@ -48,7 +48,7 @@ module Sym
         end
 
         def timestamp
-          @timestamp ||= Time.now.to_a.select { |d| d.is_a?(Fixnum) }.map { |d| '%02d' % d }[0..-3].reverse.join
+          @timestamp ||= Time.now.to_a.select { |d| d.is_a?(Integer) }.map { |d| '%02d' % d }[0..-3].reverse.join
         end
 
         def process(code)

data/lib/sym/app/commands/password_protect_key.rb

@@ -16,10 +16,10 @@ module Sym
           the_key = self.key
 
           if opts[:password]
-             encrypted_key, password = encrypt_with_password(the_key)
-             add_password_to_the_cache(encrypted_key, password)
-             the_key = encrypted_key
-           end
+            encrypted_key, password = encrypt_with_password(the_key)
+            add_password_to_the_cache(encrypted_key, password)
+            the_key = encrypted_key
+          end
 
           add_to_keychain_if_needed(the_key)
 

data/lib/sym/app/commands/show_examples.rb

@@ -16,12 +16,12 @@ module Sym
                             result:  '75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4='.green)
 
           output << example(comment: 'generate a new key with a cached password & save to the default key file',
-                            command: 'sym -gcpqo ' + Sym.default_key_file,
-                            echo:    'New Password     : ' + '••••••••••'.green,
-                            result:  'Confirm Password : ' + '••••••••••'.green)
+                            command: "sym -gcpqo #{Sym.default_key_file}",
+                            echo:    "New Password     : #{'••••••••••'.green}",
+                            result:  "Confirm Password : #{'••••••••••'.green}")
 
           output << example(comment: 'encrypt a plain text string with default key file, and immediately decrypt it',
-                            command: 'sym -es ' + '"secret string"'.bold.yellow + ' | sym -d',
+                            command: "sym -es #{'"secret string"'.bold.yellow} | sym -d",
                             result:  'secret string'.green)
 
           output << example(comment: 'encrypt secrets file using key in the environment, and --negate option:',
@@ -35,7 +35,7 @@ module Sym
                             result:  'secret string'.green)
 
           output << example(comment: 'encrypt/decrypt sym.yml using the default key file',
-                            command: 'sym -gcq > ' + Sym.default_key_file,
+                            command: "sym -gcq > #{Sym.default_key_file}",
                             echo:    'sym -n secrets.yml',
                             result:  'sym -df secrets.yml.enc',
           )
@@ -56,7 +56,7 @@ Diff:
 # (c) 2016 Konstantin Gredeskoul.  All rights reserved.'.green.bold)
 
 
-          if Sym::App.is_osx?
+          if Sym::App.osx?
           output << example(comment: 'generate a new password-encrypted key, save it to your Keychain:',
                             command: 'sym -gpcx staging.key')
 

data/lib/sym/app/input/handler.rb

@@ -6,7 +6,7 @@ module Sym
       class Handler
         attr_accessor :stdin, :stdout, :stderr, :kernel
 
-        def initialize(stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+        def initialize(stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
           self.stdin  = stdin
           self.stdout = stdout
           self.stderr = stderr
@@ -27,7 +27,13 @@ module Sym
         end
 
         def prompt(message, color)
-          raise Sym::Errors::CantReadPasswordNoTTY.new('key requires a password, however STDIN is not a TTY') unless stdin.tty?
+          unless $stdin.isatty && $stdin.tty?
+            raise Sym::Errors::CantReadPasswordNoTTY.new('key requires a password, however STDIN is not a TTY')
+          end
+          highline(message, color)
+        end
+
+        def highline(message, color)
           HighLine.new(stdin, stderr).ask(message.bold) { |q| q.echo = '•'.send(color) }
         end
 

data/lib/sym/app/keychain.rb

@@ -39,11 +39,13 @@ module Sym
         self.key_name = key_name
         self.opts     = opts
         self.class.validate!
-        stderr_off
+        opts[:trace] ? stderr_on : stderr_off
       end
 
       def add(password)
-        execute command(:add, "-U -w '#{password}' ")
+        delete rescue nil
+        sleep 0.1
+        execute command(:add, " -T /usr/bin/security -w '#{password}' ")
       end
 
       def find
@@ -56,10 +58,14 @@ module Sym
 
       def execute(command)
         command += ' 2>/dev/null' if stderr_disabled
-        puts "> #{command.yellow.green}" if opts[:verbose]
+        puts "> #{command.yellow}" if opts[:verbose]
         output = `#{command}`
         result = $?
-        raise Sym::Errors::KeyChainCommandError.new("Command error: #{result}, command: #{command}") unless result.success?
+        unless result.success?
+          warn "> ERROR running command:\n>   $ #{output.red}" if !stderr_disabled && opts[:verbose]
+          raise Sym::Errors::KeyChainCommandError.new("Command error: #{result}, command: #{command}")
+        end
+
         output.chomp
       rescue Errno::ENOENT => e
         raise Sym::Errors::KeyChainCommandError.new("Command error: #{e.message}, command: #{command}")
@@ -80,16 +86,16 @@ module Sym
         out << extras if extras
         out = out.join
         # Do not actually ever run these commands on non MacOSX
-        out = "echo Run this –\"#{out}\", on #{Sym::App.this_os}?\nAre you sure?" unless Sym::App.is_osx?
+        out = "echo Run this –\"#{out}\", on #{Sym::App.this_os}?\nAre you sure?" unless Sym::App.osx?
         out
       end
 
       def base_command(action)
         [
-          "security #{action}-#{self.class.sub_section} ",
-          "-a '#{self.class.user}' ",
-          "-D '#{self.class.kind}' ",
-          "-s '#{self.key_name}' "
+          "/usr/bin/security #{action}-#{self.class.sub_section} ",
+          "-a #{self.class.user} ",
+          "-D #{self.class.kind} ",
+          "-s #{self.key_name} "
         ]
       end
     end

data/lib/sym/app/output/base.rb

@@ -6,7 +6,7 @@ module Sym
 
         attr_accessor :opts, :stdin, :stdout, :stderr, :kernel
 
-        def initialize(opts, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+        def initialize(opts, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
           self.opts   = opts
           self.stdin  = stdin
           self.stdout = stdout

data/lib/sym/app/output/noop.rb

@@ -7,7 +7,8 @@ module Sym
         required_option :quiet
 
         def output_proc
-          ->(*) { ; }
+          ->(*) do
+          end
         end
       end
     end

data/lib/sym/app/password/cache.rb

@@ -36,7 +36,7 @@ module Sym
           self.enabled = opts[:enabled]
           self.verbose = opts[:verbose]
           self.timeout = opts[:timeout] || ::Sym::Configuration.config.password_cache_timeout
-          self.provider = Providers.provider(opts[:provider], opts[:provider_opts] || {})
+          self.provider = Providers.provider(opts[:provider], **(opts[:provider_opts] || {}))
           self.enabled = false unless self.provider
           self
         end

data/lib/sym/app/password/providers.rb

@@ -4,9 +4,7 @@ module Sym
       module Providers
 
         class << self
-          attr_accessor :registry
-          attr_accessor :providers
-          attr_accessor :detected
+          attr_accessor :registry, :providers, :detected
 
           def register(provider_class)
             self.registry                        ||= {}
@@ -15,7 +13,7 @@ module Sym
             self.providers << provider_class
           end
 
-          # Detect first instance that is "alive?" and return it.
+          # Detect first instance tht is "alive?" and return it.
           def detect
             self.detected ||= self.providers.inject(nil) do |instance, provider_class|
               instance || (p = provider_class.new; p.alive? ? p : nil)
@@ -38,7 +36,7 @@ module Sym
 
           def provider_from_argument(p, **opts, &block)
             case p
-              when String, Symbol
+            when String, Symbol
                 provider_class_name = "#{p.to_s.capitalize}Provider"
                 Sym::App::Password::Providers.const_defined?(provider_class_name) ?
                   Sym::App::Password::Providers.const_get(provider_class_name).new(**opts, &block) :
@@ -53,4 +51,3 @@ end
 
 # Order is important — they are tried in this order for auto detect
 require 'sym/app/password/providers/memcached_provider'
-require 'sym/app/password/providers/drb_provider'

data/lib/sym/app/private_key/decryptor.rb

@@ -31,10 +31,10 @@ module Sym
             rescue ::OpenSSL::Cipher::CipherError => e
               input_handler.puts 'Invalid password. Please try again.'
 
-              if ((retries += 1) < 3)
+              if (retries += 1) < 3
                 retry
               else
-                raise(Sym::Errors::InvalidPasswordProvidedForThePrivateKey.new('Invalid password.'))
+                raise(Sym::Errors::WrongPasswordForKey.new('Invalid password.'))
               end
             end
           else

data/lib/sym/app/private_key/detector.rb

@@ -23,11 +23,10 @@ module Sym
         # procs on a given string.
         def read!
           KeySourceCheck::CHECKS.each do |source_check|
-            if result = source_check.detect(self) rescue nil
-              if key_ = normalize_key(result.key)
-                key_source_ = result.to_s
-                return key_, key_source_
-              end
+            next unless result = source_check.detect(self) rescue nil
+            if key_ = normalize_key(result.key)
+              key_source_ = result.to_s
+              return key_, key_source_
             end
           end
           nil
@@ -51,8 +50,6 @@ module Sym
             rescue
               nil
             end
-          else
-            nil
           end
         end
       end

data/lib/sym/app/private_key/key_source_check.rb

@@ -16,9 +16,8 @@ module Sym
         attr_accessor :name, :reducted, :input, :output
 
         def initialize(name:,
-                       reducted: false,
-                       input: ->(detector) { detector.opts[:key] },
-                       output:)
+                       output:, reducted: false,
+                       input: ->(detector) { detector.opts[:key] })
 
           self.name     = name
           self.reducted = reducted

data/lib/sym/application.rb

@@ -31,8 +31,7 @@ module Sym
                   :password_cache,
                   :stdin, :stdout, :stderr, :kernel
 
-    def initialize(opts, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
-
+    def initialize(opts, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
       self.stdin  = stdin
       self.stdout = stdout
       self.stderr = stderr
@@ -111,16 +110,12 @@ module Sym
     end
 
     def editor
-      editors_to_try.find { |editor| File.exist?(editor) }
+      editors_to_try.compact.find { |editor| File.exist?(editor) }
     end
 
     def process_output(result)
-      unless result.is_a?(Hash)
-        self.output.call(result)
-        result
-      else
-        result
-      end
+      self.output.call(result) unless result.is_a?(Hash)
+      result
     end
 
     private
@@ -182,7 +177,7 @@ module Sym
       args[:verbose]  = opts[:verbose]
       args[:provider] = opts[:cache_provider] if opts[:cache_provider]
 
-      self.password_cache = Sym::App::Password::Cache.instance.configure(args)
+      self.password_cache = Sym::App::Password::Cache.instance.configure(**args)
     end
 
     def process_edit_option
@@ -207,7 +202,7 @@ module Sym
     end
 
     def initialize_action
-      self.action = if opts[:encrypt] then
+      self.action = if opts[:encrypt]
                       :encr
                     elsif opts[:decrypt]
                       :decr
@@ -217,7 +212,7 @@ module Sym
     # If we are encrypting or decrypting, and no data has been provided, check if we
     # should read from STDIN
     def initialize_data_source
-      if self.action && opts[:string].nil? && opts[:file].nil? && !(self.stdin.tty?)
+      if self.action && opts[:string].nil? && opts[:file].nil? && !self.stdin.tty?
         opts[:file] = '-'
       end
     end
@@ -229,9 +224,9 @@ module Sym
       detect_key_source
       if args.require_key? && !self.key
         log :error, 'Unable to determine the key, which appears to be required with current args'
-        raise Sym::Errors::NoPrivateKeyFound, 'Private key is required when ' + (self.action ? self.action.to_s + 'ypting' : provided_flags.join(', '))
+        raise Sym::Errors::NoPrivateKeyFound, "Private key is required when #{self.action ? "#{self.action.to_s}ypting" : provided_flags.join(', ')}"
       end
-      log :debug, "initialize_key_source: detected key ends with [...#{(key ? key[-5..-1] : 'nil').bold.magenta}]"
+      log :debug, "initialize_key_source: detected key ends with [...#{(key ? key[-5..] : 'nil').bold.magenta}]"
       log :debug, "opts: #{self.provided_value_options.to_s.green.bold}"
       log :debug, "flags: #{self.provided_flags.to_s.green.bold}"
     end

data/lib/sym/configuration.rb

@@ -35,10 +35,6 @@ module Sym
 
     # See file +lib/sym.rb+ where these values are defined.
 
-    attr_accessor :data_cipher, :password_cipher, :private_key_cipher
-    attr_accessor :compression_enabled, :compression_level
-    attr_accessor :password_cache_default_provider, :password_cache_timeout
-    attr_accessor :password_cache_arguments
-    attr_accessor :default_key_file, :encrypted_file_extension
+    attr_accessor :data_cipher, :password_cipher, :private_key_cipher, :compression_enabled, :compression_level, :password_cache_default_provider, :password_cache_timeout, :password_cache_arguments, :default_key_file, :encrypted_file_extension
   end
 end

data/lib/sym/constants.rb

@@ -1,43 +1,59 @@
 require 'logger'
 module Sym
+  #
+  # This module is responsible for installing Sym BASH extensions.
+  #
   module Constants
-    module Bash
 
-      BASH_FILES = Dir.glob("#{File.expand_path('../../../bin', __FILE__)}/sym.*.bash").freeze
+    BASH_FILES = Dir.glob("#{File.expand_path('../../bin', __dir__)}/sym.*.bash").freeze
 
-      Config = {}
+    class << self
+      attr_reader :user_home
 
-      class << self
-        def register_bash_files!
-          BASH_FILES.each do |bash_file|
-            register_bash_extension bash_file, Config
-          end
-        end
+      def user_home=(value)
+        @user_home = value
+        register_bash_files!
+      end
 
-        private
+      def config
+        @config ||= {}
+      end
 
-        def register_bash_extension(bash_file, hash)
-          source_file = File.basename(bash_file)
-          home_file   = "#{Dir.home}/.#{source_file}"
+      def sym_key_file
+        "#{user_home}/.sym.key"
+      end
 
-          hash[source_file.gsub(/sym\./, '').gsub(/\.bash/, '').to_sym] = {
-              dest:   home_file,
-              source: bash_file,
-              script: "[[ -f #{home_file} ]] && source #{home_file}"
-          }
+      def register_bash_files!
+        BASH_FILES.each do |bash_file|
+          register_bash_extension bash_file
         end
       end
 
-      self.register_bash_files!
+      private
+
+      def register_bash_extension(bash_file)
+        return unless user_home && Dir.exist?(user_home)
+
+        source_file = File.basename(bash_file)
+        home_file   = "#{user_home}/.#{source_file}"
+        config_key  = source_file.gsub(/sym\./, '').gsub(/\.bash/, '').to_sym
+
+        config[config_key] = {
+          dest:   home_file,
+          source: bash_file,
+          script: "[[ -f #{home_file} ]] && source #{home_file}"
+        }
+      end
     end
 
+    self.user_home ||= ::Dir.home rescue nil
+    self.user_home ||= '/tmp'
+
+    self.register_bash_files!
+
     module Log
       NIL = Logger.new(nil).freeze # empty logger
-      LOG = Logger.new(STDERR).freeze
+      LOG = Logger.new($stderr).freeze
     end
-
-    ENV_ARGS_VARIABLE_NAME = 'SYM_ARGS'.freeze
-    SYM_KEY_FILE           = "#{ENV['HOME']}/.sym.key"
-
   end
 end