sym 2.8.1 → 3.0.0

data/codecov.yml

@@ -0,0 +1,29 @@
+codecov:
+  require_ci_to_pass: no
+
+  notify:
+    wait_for_ci: yes
+
+parsers:
+  v1:
+    include_full_missed_files: true # To use with Ruby so we see files that have NO tests written
+
+coverage:
+  range: 50..75
+  round: down
+  precision: 1
+  status:
+    project:
+      default: off
+      sym:
+        target: 70%
+        threshold: 10%
+        informational: true
+        if_not_found: success
+        if_ci_failed: error
+        paths:
+          - lib/
+flags:
+  sym:
+    paths:
+      - lib/

data/exe/keychain

@@ -32,7 +32,7 @@ puts data ? \
   Sym::App::KeyChain.new(key_name).send(action.to_sym, data) :
   Sym::App::KeyChain.new(key_name).send(action.to_sym)
 rescue StandardError => e
-  STDERR.puts "#{e.message.red}"
+  warn "#{e.message.red}"
 end
 
 

data/exe/sym

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+# vim: ft=ruby
+
+require_relative '../lib/ruby_warnings'
 
 lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
@@ -6,12 +9,12 @@ $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path
 require 'sym'
 require 'sym/app'
 
-#ARGV.any?{ |a| a =~ /^-/ } ?
+# ARGV.any?{ |a| a =~ /^-/ } ?
 begin
   exit ::Sym::App::CLI.new(ARGV.dup).execute
 rescue Interrupt => e
   STDERR.flush
-  STDERR.puts "Interrupt, #{e.message}, exiting."
+  warn "Interrupt, #{e.message}, exiting."
   STDERR.flush
   exit 1
 end

data/lib/ruby_warnings.rb

@@ -0,0 +1,7 @@
+ruby_version = RbConfig::CONFIG['MAJOR'].to_i * 10 + RbConfig::CONFIG['MINOR'].to_i
+if ruby_version >= 27
+  Warning[:deprecated] = false
+  ENV['RUBYOPT'] = '-W:no-deprecated'
+else
+  ENV['RUBYOPT']="-W0"
+end

data/lib/sym.rb

@@ -14,24 +14,18 @@ Sym::Configuration.configure do |config|
   config.compression_enabled      = true
   config.compression_level        = Zlib::BEST_COMPRESSION
   config.encrypted_file_extension = 'enc'
-  config.default_key_file         = Sym::Constants::SYM_KEY_FILE
+  config.default_key_file         = Sym::Constants.sym_key_file
 
   config.password_cache_timeout          = 300
 
   # When nil is selected, providers are auto-detected.
   config.password_cache_default_provider = nil
   config.password_cache_arguments        = {
-    drb:       {
-      opts: {
-        uri: 'druby://127.0.0.1:24924'
-      }
-    },
     memcached: {
       args: %w(127.0.0.1:11211),
       opts: { namespace:  'sym',
               compress:   true,
-              expires_in: config.password_cache_timeout
-      }
+              expires_in: config.password_cache_timeout}
 
     }
   }

data/lib/sym/app.rb

@@ -18,7 +18,6 @@ module Sym
     class << self
       attr_accessor :exit_code
       attr_accessor :stdin, :stdout, :stderr
-
     end
 
     self.exit_code = 0
@@ -66,7 +65,7 @@ module Sym
       self.exit_code = 1
     end
 
-    def self.is_osx?
+    def self.osx?
       Gem::Platform.local.os.eql?('darwin')
     end
 

data/lib/sym/app/args.rb

@@ -12,7 +12,7 @@ module Sym
 
       def initialize(opts)
         self.opts             = opts
-        self.selected_options = opts.keys.reject { |k| !opts[k] }
+        self.selected_options = opts.keys.select { |k| opts[k] }
       end
 
       def specify_key?
@@ -33,10 +33,11 @@ module Sym
       end
 
       def provided_options
-        opts.to_hash.keys.reject { |k| !opts[k] }
+        opts.to_hash.keys.select { |k| opts[k] }
       end
 
       private
+
       def do?(list)
         !(list & selected_options).empty?
       end

data/lib/sym/app/cli.rb

@@ -56,11 +56,10 @@ module Sym
       # brings in #parse(Array[String] args)
       include CLISlop
 
-      attr_accessor :opts, :application, :outputs, :stdin, :stdout, :stderr, :kernel
-
+      attr_accessor :opts, :application, :outputs, :stdin, :stdout, :stderr, :kernel, :args
 
       def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
-
+        self.args   = argv
         self.stdin  = stdin
         self.stdout = stdout
         self.stderr = stderr
@@ -72,37 +71,46 @@ module Sym
 
         begin
           # Re-map any legacy options to the new options
-          self.opts = parse(argv)
+          self.opts = parse(args)
+
+          if opts[:user_home]
+            Constants.user_home = opts[:user_home]
+            raise InvalidSymHomeDirectory, "#{opts[:user_home]} does not exist!" unless Dir.exist?(Constants.user_home)
+          end
+
+          # Deal with SYM_ARGS and -A
           if opts[:sym_args]
-            append_sym_args(argv)
-            self.opts = parse(argv)
+            if non_empty_array?(sym_args)
+              args << sym_args
+              args.flatten!
+              args.compact!
+              args.delete('-A')
+              args.delete('--sym-args')
+              self.opts = parse(args)
+            end
           end
 
           # Disable coloring if requested, or if piping STDOUT
           if opts[:no_color] || !self.stdout.tty?
             Colored2.disable! # reparse options without the colors to create new help msg
-            self.opts = parse(argv)
+            self.opts = parse(args)
           end
 
         rescue StandardError => e
           log :error, "#{e.message}" if opts
           error exception: e
-          exit 127 if stdin == STDIN
+          quit!(127) if stdin == STDIN
         end
 
-        self.application = ::Sym::Application.new(opts, stdin, stdout, stderr, kernel)
+        self.application = ::Sym::Application.new(self.opts, stdin, stdout, stderr, kernel)
       end
 
-      def append_sym_args(argv)
-        if env_args = sym_args
-          argv << env_args.split(' ')
-          argv.flatten!
-          argv.compact!
-        end
+      def quit!(code = 0)
+        exit(code)
       end
 
       def sym_args
-        ENV[Sym::Constants::ENV_ARGS_VARIABLE_NAME]
+        (ENV['SYM_ARGS']&.split(/\s+/) || [])
       end
 
       def execute!
@@ -132,15 +140,20 @@ module Sym
       end
 
       def opts_present
-        o = opts.to_hash
-        o.keys.map { |k| opts[k] ? nil : k }.compact.each { |k| o.delete(k) }
-        o
+        opts.to_hash.tap do |o|
+          o.keys.map { |k| opts[k] ? nil : k }.compact.each { |k| o.delete(k) }
+        end
+      end
+
+      def log(*args)
+        Sym::App.log(*args, **opts.to_hash)
       end
 
+
       private
 
-      def log(*args)
-        Sym::App.log(*args, **(opts.to_hash))
+      def non_empty_array?(object)
+        object.is_a?(Array) && !object.empty?
       end
 
       def error(hash)

data/lib/sym/app/cli_slop.rb

@@ -55,7 +55,8 @@ module Sym
           o.separator 'Create a new private key:'.yellow
           o.bool      '-g', '--generate',           '           generate a new private key'
           o.bool      '-p', '--password',           '           encrypt the key with a password'
-          if Sym::App.is_osx?
+
+          if Sym::App.osx?
             o.string '-x', '--keychain',            '[key-name] '.blue + 'write the key to OS-X Keychain'
           end
 
@@ -67,7 +68,7 @@ module Sym
           o.separator ' '
           o.separator 'Password Cache:'.yellow
           o.bool      '-c', '--cache-passwords',     '           enable password cache'
-          o.integer   '-u', '--cache-timeout',       '[seconds]'.blue + '  expire passwords after'
+          o.integer   '-z', '--cache-timeout',       '[seconds]'.blue + '  expire passwords after'
           o.string    '-r', '--cache-provider',      '[provider]'.blue + ' cache provider, one of ' + "#{Sym::App::Password::Providers.provider_list}"
 
           o.separator ' '
@@ -89,8 +90,14 @@ module Sym
 
           o.separator ' '
           o.separator 'Utility:'.yellow
+          o.separator   "   The following flag helps with Sym installation by hooking to \n" +
+                        "   your #{'~/.bashrc'.bold.yellow}. If you are running Sym on an environment without \n" +
+                        "   user home available, you may need to force set user's home to any existing\n" +
+                        "   directory using the #{'--user-home'.bold.blue} flag.\n"
+
           o.string    '-B', '--bash-support',       '[file]'.blue + '     append bash completion & utils to a file'+ "\n" +
             '                                    such as ~/.bash_profile or ~/.bashrc'
+          o.string    '-u', '--user-home',       '[DIR]'.blue + "      Overrides #{'${HOME}'.green} ==> supports AWS Lambda\n"
 
           o.separator ' '
           o.separator 'Help & Examples:'.yellow

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

@@ -73,7 +73,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,7 +43,7 @@ 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

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

@@ -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

@@ -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/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