sym 2.8.2 → 3.0.1

data/Rakefile

@@ -1,7 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 require 'yard'
-
+require 'timeout'
 
 def shell(*args)
   puts "running: #{args.join(' ')}"
@@ -24,13 +25,18 @@ end
 task :build => :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE)
-  t.options.unshift('--title','"Sym – Symmetric Key Encryption for Your Data"')
-  t.after = ->() { exec('open doc/index.html') }
+  t.files = %w(lib/**/*.rb exe/*.rb - README.adoc CHANGELOG.md LICENSE)
+  t.options.unshift('--title', '"Sym – Symmetric Encryption for Humins"')
+  t.after = -> { Thread.new { sleep 5; exec('open doc/index.html') }  }
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
+RuboCop::RakeTask.new
+
 task :default => :spec
 
 
+
+
+

data/bin/changelog

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+# vim: ft=bash
+unset DEBUG
+
+[[ -d ~/.bashmatic ]] || bash -c "$(curl -fsSL http://bit.ly/bashmatic-1-2-0)"
+source "${HOME}/.bashmatic/init.sh" 1>/dev/null
+
+function chlog() {
+  run.set-all abort-on-error show-output-on
+  
+  command -v github_changelog_generator >/dev/null || {
+    h1 'Installing changelog ruby gem...'
+    gem.install github_changelog_generator
+  }
+
+  if [[ -z "${GITHUB_TOKEN}" ]]; then
+    error "Please set GITHUB_TOKEN environment variable."
+    return 1
+  else
+    info "GitHub token found, starting CHANGELOG generation..."
+  fi
+
+  run "github_changelog_generator --no-verbose -u kigster -p sym -t ${GITHUB_TOKEN}"
+} 
+    
+chlog "$@"
+    
+    
+    
+    
+    
+    
+    
+

data/bin/sym.completion.bash

@@ -14,14 +14,16 @@
 bash_version=$(bash --version | awk '{FS="version"}{print $4}')
 bash_version=${bash_version:0:1}
 
-declare -a bash_completion_locations=(/usr/local/etc/bash_completion /usr/etc/bash_completion /etc/bash_completion)
-loaded=false
-for file in ${bash_completion_locations[@]}; do
+[[ -z $(type _filedir 2>/dev/null) ]] && {
+  declare -a bash_completion_locations=(/usr/local/etc/bash_completion /usr/etc/bash_completion /etc/bash_completion)
+  loaded=false
+  for file in ${bash_completion_locations[@]}; do
     [[ -s ${file} ]] && {
       source ${file}
       break
     }
-done
+  done
+}
 
 _sym_long_opts() {
     sym -h | grep -- '--' | egrep '^  -' | awk '{print $2}' | sort

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

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
+lib_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
 $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
 
 require 'sym'
@@ -9,7 +9,7 @@ require 'sym/app/keychain'
 require 'colored2'
 
 def usage
-  puts 'Usage: ' + 'keychain'.bold.blue + ' name [ add <contents> | find | delete ]'.bold.green
+  puts "Usage: #{'keychain'.bold.blue}#{' name [ add <contents> | find | delete ]'.bold.green}"
   exit 0
 end
 
@@ -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,18 +1,21 @@
 #!/usr/bin/env ruby
+# vim: ft=ruby
 
-lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
+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)
 
 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."
-  STDERR.flush
+  $stderr.flush
+  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

@@ -16,16 +16,14 @@ module Sym
   #
   module App
     class << self
-      attr_accessor :exit_code
-      attr_accessor :stdin, :stdout, :stderr
-
+      attr_accessor :exit_code, :stdin, :stdout, :stderr
     end
 
     self.exit_code = 0
 
-    self.stdin     = STDIN
-    self.stdout    = STDOUT
-    self.stderr    = STDERR
+    self.stdin     = $stdin
+    self.stdout    = $stdout
+    self.stderr    = $stderr
 
     def self.out
       self.stderr
@@ -45,7 +43,7 @@ module Sym
 
       lines = []
 
-      error_type    = "#{(type || exception.class.name)}"
+      error_type    = "#{type || exception.class.name}"
       error_details = (details || exception.message)
 
       operation = command ? "to #{command.class.short_name.to_s.humanize.downcase}" : ''
@@ -56,7 +54,7 @@ module Sym
         lines << exception.backtrace.join("\n").red.bold if config[:trace]
         lines << "\n"
       else
-        lines << " ✖ Sym Error #{operation}:".bold.red + (reason ? " #{reason} ".red.italic: " #{error_details}")[0..70] + ' '.normal + "\n"
+        lines << "#{" ✖ Sym Error #{operation}:".bold.red}#{(reason ? " #{reason} ".red.italic: " #{error_details}")[0..70]}#{' '.normal}\n"
         lines << "#{comments}" if comments
       end
 
@@ -66,7 +64,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
-
-
-      def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+      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,44 @@ module Sym
 
         begin
           # Re-map any legacy options to the new options
-          self.opts = parse(argv)
-          if opts[:sym_args]
-            append_sym_args(argv)
-            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] && non_empty_array?(sym_args)
+              args << sym_args
+              args.flatten!
+              args.compact!
+              args.delete('-A')
+              args.delete('--sym-args')
+              self.opts = parse(args)
           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 +138,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

@@ -19,7 +19,7 @@ module Sym
           o.separator '      5) use -i to paste/type the key interactively'.dark
           o.separator '      6) default key file (if present) at '.dark + Sym.default_key_file.magenta.bold
           o.separator ' '
-          o.separator '       ' + key_spec + ' = -k/--key [ key | file | keychain | env variable name ]'.green.bold
+          o.separator "       #{key_spec}#{' = -k/--key [ key | file | keychain | env variable name ]'.green.bold}"
           o.separator         '                  -i/--interactive'.green.bold
           o.separator ''
           o.separator '   Encrypt/Decrypt from STDIN/file/args, to STDOUT/file:'.dark
@@ -48,33 +48,34 @@ module Sym
           o.separator 'Modes:'.yellow
           o.bool      '-e', '--encrypt',            '           encrypt mode'
           o.bool      '-d', '--decrypt',            '           decrypt mode'
-          o.string    '-t', '--edit',               '[file]  '.blue + '   edit encrypted file in an $EDITOR', default: nil
+          o.string    '-t', '--edit',               "#{'[file]  '.blue}   edit encrypted file in an $EDITOR", default: nil
           o.string    '-n', '--negate',             '[file]  '.blue + "   encrypts any regular #{'file'.green} into #{'file.enc'.green}" + "\n" +
                                      "                                    conversely decrypts #{'file.enc'.green} into #{'file'.green}."
           o.separator ' '
           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?
-            o.string '-x', '--keychain',            '[key-name] '.blue + 'write the key to OS-X Keychain'
+
+          if Sym::App.osx?
+            o.string '-x', '--keychain',            "#{'[key-name] '.blue}write the key to OS-X Keychain"
           end
 
           o.separator ' '
           o.separator 'Read existing private key from:'.yellow
-          o.string    '-k', '--key',                '[key-spec]'.blue + ' private key, key file, or keychain'
+          o.string    '-k', '--key',                "#{'[key-spec]'.blue} private key, key file, or keychain"
           o.bool      '-i', '--interactive',        '           Paste or type the key interactively'
 
           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 ' '
           o.separator 'Data to Encrypt/Decrypt:'.yellow
-          o.string    '-s', '--string',             '[string]'.blue + '   specify a string to encrypt/decrypt'
-          o.string    '-f', '--file',               '[file]  '.blue + '   filename to read from'
-          o.string    '-o', '--output',             '[file]  '.blue + '   filename to write to'
+          o.string    '-s', '--string',             "#{'[string]'.blue}   specify a string to encrypt/decrypt"
+          o.string    '-f', '--file',               "#{'[file]  '.blue}   filename to read from"
+          o.string    '-o', '--output',             "#{'[file]  '.blue}   filename to write to"
 
           o.separator ' '
           o.separator 'Flags:'.yellow
@@ -89,8 +90,13 @@ module Sym
 
           o.separator ' '
           o.separator 'Utility:'.yellow
-          o.string    '-B', '--bash-support',       '[file]'.blue + '     append bash completion & utils to a file'+ "\n" +
-            '                                    such as ~/.bash_profile or ~/.bashrc'
+          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