sym 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b712e7e8491557d2ca064b7864b6bf8b53b908
-  data.tar.gz: 3c867fd002b7597eae078e995b47b47331c6d3d0
+  metadata.gz: 9d1c0e747eef0d680cc7a8f69f01173744c4e29d
+  data.tar.gz: 194dc2f5f74011848f9673bf2d4e5b018baa166f
 SHA512:
-  metadata.gz: 185731d39d78c99cd75899cd1769ee333c1757e0e7df195c1909f3bb3bdb022276fa24d309548cba08bf3f5a5400f2a8e10fe2e2b69118ed0b8b4fbae3954d28
-  data.tar.gz: 56360fe600e09f6d8e6fecb55fd92a69d162b4af507eb0074c7606fe303093c8e3cd61f4d9dcd883ca772197e6930e4352b134de1e6ce82e4958e636e4090a8a
+  metadata.gz: b7bb4fed47d8a416622963d25209033dcf444f505db8c16edd08be6ef8a16beee92762e678cfb6f75f0588c92c2b0ebdb1058e5dd9c96e4382c598cac6a28550
+  data.tar.gz: 3df569a2f8ea1995401c0e916dbfd34bcf8bcb41ca6747fe51918fbe7dc89e3025f8aa4c90dc05997676d5507ea4bba126c5c7e60ea870597d4a0fdd2819daa1

data/.codeclimate.yml

@@ -12,6 +12,11 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+      checks:
+        Rubocop/Metrics/MethodLength:
+          enabled: false
+        Rubocop/Metrics/CyclomaticComplexity:
+          enabled: false
 ratings:
   paths:
   - "**.inc"

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 env:
-- CODECLIMATE_REPO_TOKEN=be1a1a266b0ffc81fa0bd1e432a229f2a4ab420dcb9e9e15c1e75e2acad573b7
+- CODECLIMATE_REPO_TOKEN=c71874cc22acffe1e2543d3388d3a96c73a65f0cfe17169dadd8de4a6c062c39
 rvm:
 - 2.4.0
 - 2.3.3
@@ -16,7 +16,7 @@ notifications:
       secure: GcACCHmcmo99lYE5dgt2TmY4YIPMWr75q0Bkm4Lddegq/1eMXgcZDz00j8iHWtnveyJSjEUpZFQ9uyx+P7dvxT7D5gl43arKZEylS4vMRg9QRgZu7/ROrXbJtrUyKulFRUTdFrmOiK9nDKpAzlvLvMKC4kaQnn88Xtu9pYMU8y4n5fCtl29gZM9ZjVbrBBvV/SumnTDLla2oQ7oFgUZdZhQZ1qsevYknxNq4eIcvPDjbon+bovfsIISEVRSNo2C3yjO+mqWKed3jfuCA4taAZ8/aVVFEKURMH10HFms1CiC3lE/gF4YfBXsqKpjnB+bKjBcWox2FQrp96FulMEIfkKQrnuncO96o7MGHX9oNqKSMoycf3+SZFwNa+5Mfq7SBepbHYCoU7/ow31UTyStrc5idG19XzYgI85yjQHdzQN299Xf0O8cGf9q9qAu7rS7JlM3ekR+3rZYO+OxNYTF8rcW1fYIj6GKcbsV8BvuhAVQRFOsk/ibcIb2N7rGVd/ZbU4HAk3RE1ywt+XowinpIHktu2PQUPDNpgRQwM6xqZHO/7s9r7oW0ULmZCMLZ9CMKNjKzrQ9wfh90+v+FiEiUKsaVj4cCwF3PvhVYvxU2AKbCeHtSEb7K6to86+DYNoIKnGH1ryKoyCtyOTZpNMLGFt34Msv7WfEylhG+DpVMvkM=
 addons:
   code_climate:
-    repo_token: be1a1a266b0ffc81fa0bd1e432a229f2a4ab420dcb9e9e15c1e75e2acad573b7
+    repo_token: c71874cc22acffe1e2543d3388d3a96c73a65f0cfe17169dadd8de4a6c062c39
 # regular test configuration
 after_success:
   - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+**2.0.3** (January 22, 2017)
+
+* Removed clipboard copy functionality, as it's easy to achieve with `pbcopy`.
+* Removed natural language processing stuff
+* Removed `keychain-del` feature
+* Refactored bash-completion to install a separate ~/.sym.completion file
+* Updated README
+
+**2.0.2** (January 20, 2017)
+
+* Added bash-completion installation
+* Fixed a bug where a newline was added to file redirects, making
+  redirecting encrypted data or keys unusable.
+

data/README.md

@@ -1,6 +1,4 @@
-
-
-# Sym — Your Encryption Best Friend
+# Sym — Light Weight Symmetric Encryption for Humans
 
 [![Gem Version](https://badge.fury.io/rb/sym.svg)](https://badge.fury.io/rb/sym)
 [![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/sym?type=total)](https://rubygems.org/gems/sym)
@@ -15,7 +13,7 @@
 
 ### Summary
 
-> __sym__ is little program that makes it _trivial to encrypt and decrypt sensitive data_.  But, unlike many other existing tools, __sym__'s goal is to dramatically simplify the command line interface (CLI), and make symmetric encryption as routine as listing directories in Terminal.
+> __sym__ is a utility and an API that makes it _trivial to encrypt and decrypt sensitive data_. Unlike many other existing tools, __sym__'s goal is to dramatically simplify the command line interface (CLI), and make symmetric encryption as routine as listing directories in Terminal.
 
 With this tool I wanted to make it easy to memorize the most common options, so that there is little no longer a barrier to the full power of encryption offered by [`OpenSSL`](https://www.openssl.org/) library.
 
@@ -73,7 +71,11 @@ Or install it into the global namespace with `gem install` command:
 
 ### BASH Completion (Optional Step)
 
-After gem installation, an message will tell you to install a shown BASH script to your `~/.bashrc` or equivalent.
+After gem installation, an message will tell you to install bash completion into to your `~/.bashrc` or equivalent:
+
+```bash
+sym --bash-completion ~/.bashrc
+```
 
 Should you choose to install it (this part is optional), you will be able to use "tab-tab" after typing `sym` and you'll be able to choose from all supported flags.
 
@@ -85,7 +87,7 @@ This library relies on the existance of the 32-byte private key (aka, *a secret*
 
 The key can be easily:
 
- * generated by this gem and displayed, copied to the clipboard, or saved to the KeyChain
+ * generated by this gem and displayed, or saved to Mac OS-X KeyChain
  * one way or another must be kept very well protected and secure from attackers
  * can be fetched from the the Keychain in subsequent encryption/decryption steps
  * password-protected, which you can enable during the generation with the `-p` flag.
@@ -103,9 +105,9 @@ You can generate using the command line, or in a programmatic way. First we'll d
 
 #### Generating and Using Private Keys
 
-Once the gem is installed you will be able to run an executable `sym`. Now let's generate and copy the new private key to the clipboard. Clipboard copy is activated with the -c flag:
+Once the gem is installed you will be able to run an executable `sym`. Now let's generate and copy the new private key to the clipboard (using `pbcopy` command on Mac OS-X):
 
-    sym -gc
+    sym -g | pbcopy
 
 Or save a new key into a bash variable
 
@@ -161,47 +163,43 @@ You can use this to add an existing key that can be used with the `sym` later. O
 This may be a good time to take a look at the full help message for the `sym` tool, shown naturally with a `-h` or `--help` option.
 
 ```
-Sym (1.7.0) – encrypt/decrypt data with a private key
+Sym (2.0.2) – encrypt/decrypt data with a private key
 
 Usage:
    # Generate a new key:
-   sym -g [ -c ] [ -p ] [ -x keychain ] [ -o keyfile | -q | ]
+   sym -g [ -c ] [ -p ] [ -x keychain ] [ -o keyfile | -q | ]  
 
    # Encrypt/Decrypt 
-   sym [ -d | -e ] [ -f <file> | -s <string> ]
+   sym [ -d | -e ] [ -f <file> | -s <string> ] 
         [ -k key | -K keyfile | -x keychain | -i ] 
         [ -o <output file> ] 
  
    # Edit an encrypted file in $EDITOR 
-   sym -t -f <file> [ -b ][ -k key | -K keyfile | -x keychain | -i ]
+   sym -t -f <file> [ -b ][ -k key | -K keyfile | -x keychain | -i ] 
  
 Modes:
   -e, --encrypt                       encrypt mode
   -d, --decrypt                       decrypt mode
   -t, --edit                          decrypt, open an encr. file in an $EDITOR
  
-Create a private key:
+Create a new private key:
   -g, --generate                      generate a new private key
   -p, --password                      encrypt the key with a password
-  -c, --copy                          copy the new key to the clipboard
   -x, --keychain           [key-name] add to (or read from) the OS-X Keychain
- 
-Password Caching:
   -M, --password-timeout   [timeout]  when passwords expire (in seconds)
-  -P, --no-password-cache             disables key password caching
+  -P, --no-password-cache             disables caching of key passwords
  
-Provide a private key:
+Read existing private key from:
   -i, --interactive                   Paste or type the key interactively
   -k, --private-key        [key]      private key as a string
   -K, --keyfile            [key-file] private key from a file
  
-Data:
+Data to Encrypt/Decrypt:
   -s, --string             [string]   specify a string to encrypt/decrypt
   -f, --file               [file]     filename to read from
   -o, --output             [file]     filename to write to
  
 Flags:
-  --keychain-del           [key-name] delete keychain entry with that name
   -b, --backup                        create a backup file in the edit mode
   -v, --verbose                       show additional information
   -T, --trace                         print a backtrace of any errors
@@ -209,6 +207,9 @@ Flags:
   -V, --version                       print library version
   -N, --no-color                      disable color output
  
+Utility:
+  -a, --bash-completion    [file]     append shell completion to a file
+ 
 Help & Examples:
   -E, --examples                      show several examples
   -L, --language                      natural language examples
@@ -225,9 +226,9 @@ Generate a new private key into an environment variable:
     echo $KEY
     # => 75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4=
 
-Generate a new password-protected key, copy to the clipboard & save to a file:
+Generate a new password-protected key & save to a file:
 
-    sym -gpc -o ~/.key
+    sym -gp -o ~/.key
     New Password     : ••••••••••
     Confirm Password : ••••••••••
 
@@ -274,81 +275,6 @@ To edit an encrypted file in $EDITOR, while asking to paste the key (`-i | --int
     # ---
     # # (c) 2016 Konstantin Gredeskoul.  All rights reserved.
 
-
-### Natural Language Processing
-
-When sym is invoked, and the first argument does not begin with a dash,
-then the the NLP (natural language processing) Translator is invoked.
-The Translator is based on a very simple algorithm:
-
-  * ignore any of the words tagged STRIPPED. These are the ambiguous words, or words with duplicate meaning.
-  * map the remaining arguments to regular double-dashed options using the DICTIONARY
-  * words that are a direct match for a --option are automatically double-dashed
-  * remaining words are left as is (these would be file names, key names, etc).
-  * finally, the resulting "new" command line is parsed with regular options.
-  * When arguments include "verbose", NLP system will print "before" and "after"
-    of the arguments, so that any issues can be debugged and corrected.
-
-#### CURRENTLY IGNORED WORDS:
-
-    and, a, the, it, item, to, key, with, about, for, of, new, make, store, in, print
-
-#### REGULAR WORD MAPPING
-
-```
-________________________________________________________________________
-                          clipboard   ───────➤   --copy
-                             unlock   ───────➤   --decrypt
-                               open   ───────➤   --edit
-                               lock   ───────➤   --encrypt
-                                      ───────➤   --backup
-                                      ───────➤   --keychain
-                               read   ───────➤   --file
-                             create   ───────➤   --generate
-                     ask enter type   ───────➤   --interactive
-                               from   ───────➤   --keyfile
-                         save write   ───────➤   --output
-                      using private   ───────➤   --private_key
-                              value   ───────➤   --string
-       silently quietly silent sym   ───────➤   --quiet
-           secure secured protected   ───────➤   --password
-________________________________________________________________________
-```
-
-#### EXAMPLES
-
-```bash
-# generate a new private key and copy to the clipboard but do not print to terminal
-sym create new key to clipboard quietly
-
-# generate and save to a file a password-protected key, silently
-sym create a secure key and save it to "my.key"
-
-# encrypt a plain text string with a key, and save the output to a file
-sym encrypt string "secret string" using $(cat my.key) save to file.enc
-
-# decrypt a previously encrypted string:
-sym decrypt string $ENC using $(cat my.key)
-
-# encrypt "file.txt" with key from my.key and save it to file.enc
-sym encrypt file file.txt with key from my.key and save it to file.enc
-
-# decrypt an encrypted file and print it to STDOUT:
-sym decrypt file file.enc with key from "my.key"
-
-# edit an encrypted file in $EDITOR, ask for key, and create a backup upon save
-sym edit file file.enc ask for a key and make a backup
-
-# generate a new password-encrypted key, save it to your Keychain:
-sym create a new protected key store in keychain "my-keychain-key"
-
-# print the key stored in the keychain item "my-keychain-key"
-sym print keychain "my-keychain-key"
-
-# use the new key to encrypt a file:
-sym encrypt with keychain "my-keychain-key" file "password.txt" and write to "passwords.enc"
-```
-
 ### Ruby API
 
 To use this library you must include the main `Sym` module into your library.
@@ -444,19 +370,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/sym.
-
-## Feature Ideas
-
-### Natural Language Based API
-
-This is the proposed mini-idea/specification for an alternative CLI that is at a feature parity with the standard flag-based CLI.
-
-    sym generate key to the clipboard and keychain
-    sym encrypt file 'hello' using $key [to output.enc]
-    sym edit 'passwords.enc' using $key
-    sym decrypt /etc/secrets encrypted with $key save to ./secrets
-    sym encrypt with keychain $item file $input
+Bug reports and pull requests are welcome on GitHub at (https://github.com/kigster/sym)[https://github.com/kigster/sym].
 
 ## License
 
@@ -464,5 +378,5 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Author
 
-This library is the work of [Konstantin Gredeskoul](http:/kig.re), &copy; 2016, distributed under the MIT license.
+This library is the work of [Konstantin Gredeskoul](http:/kig.re), &copy; 2016-2017, distributed under the MIT license.
 

data/bin/{sym.bash-completion → sym.completion}

@@ -1,4 +1,3 @@
-
 #!/usr/bin/env bash
 #
 # Sym command line completion

data/exe/keychain

@@ -9,7 +9,7 @@ require 'sym/app/keychain'
 require 'colored2'
 
 def usage
-  puts 'Usage: ' + 'keychain'.bold.blue + ' item [ add <contents> | find | delete ]'.bold.green
+  puts 'Usage: ' + 'keychain'.bold.blue + ' name [ add <contents> | find | delete ]'.bold.green
   exit 0
 end
 

data/exe/sym

@@ -8,9 +8,7 @@ require 'sym/app'
 
 #ARGV.any?{ |a| a =~ /^-/ } ?
 begin
-ARGV.first =~ /^-/  ?
-  ::Sym::App::CLI.new(ARGV.dup).execute :
-  ::Sym::App::NLP::Translator.new(ARGV.dup).translate.and.execute
+  ::Sym::App::CLI.new(ARGV.dup).execute
 rescue Interrupt => e
   STDERR.flush
   STDERR.puts "Interrupt, #{e.message}, exiting."

data/lib/sym/app/cli.rb

@@ -9,7 +9,6 @@ require 'sym/errors'
 require 'sym/app/commands'
 require 'sym/app/keychain'
 require 'sym/app/private_key/handler'
-require 'sym/app/nlp/constants'
 require 'highline'
 
 require_relative 'output/file'
@@ -124,7 +123,7 @@ module Sym
           o.banner = "Sym (#{Sym::VERSION}) – encrypt/decrypt data with a private key\n".bold.white
           o.separator 'Usage:'.yellow
           o.separator '   # Generate a new key:'.dark
-          o.separator '   sym -g '.green.bold + '[ -c ] [ -p ] [ -x keychain ] [ -o keyfile | -q | ]  '.green
+          o.separator '   sym -g '.green.bold + '[ -p ] [ -x keychain ] [ -o keyfile | -q | ]  '.green
           o.separator ''
           o.separator '   # Encrypt/Decrypt '.dark
           o.separator '   sym [ -d | -e ] '.green.bold + '[ -f <file> | -s <string> ] '.green
@@ -142,37 +141,30 @@ module Sym
           o.bool '-t', '--edit',    '           decrypt, open an encr. file in an $EDITOR'
 
           o.separator ' '
-          o.separator 'Create a private key:'.yellow
+          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'
-          o.bool '-c', '--copy',     '           copy the new key to the clipboard'
 
           if Sym::App.is_osx?
             o.string '-x', '--keychain', '[key-name] '.blue + 'add to (or read from) the OS-X Keychain'
           end
 
-          o.separator ' '
-          o.separator 'Password Caching:'.yellow
-
           o.integer '-M', '--password-timeout', '[timeout]'.blue + '  when passwords expire (in seconds)'
-          o.bool '-P', '--no-password-cache', '           disables key password caching'
+          o.bool    '-P', '--no-password-cache', '           disables caching of key passwords'
 
           o.separator ' '
-          o.separator 'Provide a private key:'.yellow
-          o.bool '-i', '--interactive', '           Paste or type the key interactively'
-          o.string '-k', '--private-key', '[key]   '.blue + '   private key as a string'
-          o.string '-K', '--keyfile', '[key-file]'.blue + ' private key from a file'
+          o.separator 'Read existing private key from:'.yellow
+          o.bool      '-i', '--interactive', '           Paste or type the key interactively'
+          o.string    '-k', '--private-key', '[key]   '.blue + '   private key as a string'
+          o.string    '-K', '--keyfile', '[key-file]'.blue + ' private key from a file'
           o.separator ' '
-          o.separator 'Data:'.yellow
+          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.separator ' '
           o.separator 'Flags:'.yellow
-          if Sym::App.is_osx?
-            o.string '--keychain-del', '[key-name] '.blue + 'delete keychain entry with that name'
-          end
           o.bool '-b', '--backup', '           create a backup file in the edit mode'
           o.bool '-v', '--verbose', '           show additional information'
           o.bool '-T', '--trace', '           print a backtrace of any errors'
@@ -180,9 +172,11 @@ module Sym
           o.bool '-V', '--version', '           print library version'
           o.bool '-N', '--no-color', '           disable color output'
           o.separator ' '
+          o.separator 'Utility:'.yellow
+          o.string '-a', '--bash-completion',    '[file]'.blue + '     append shell completion to a file'
+          o.separator ' '
           o.separator 'Help & Examples:'.yellow
           o.bool '-E', '--examples', '           show several examples'
-          o.bool '-L', '--language', '           natural language examples'
           o.bool '-h', '--help', '           show help'
 
         end

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

@@ -0,0 +1,39 @@
+require_relative 'command'
+module Sym
+  module App
+    module Commands
+      class BashCompletion < Command
+
+        required_options [:bash_completion]
+        try_after :generate_key, :open_editor, :encrypt_decrypt
+
+
+        def execute
+          install_completion_file
+          file = opts[:bash_completion]
+          if File.exist?(file)
+            if File.read(file).include?(Sym::BASH_COMPLETION[:script])
+              "#{'Hmmm'.bold.yellow}: #{file.bold.yellow} had completion for #{'sym'.bold.red} already installed\n"
+            else
+              append_completion_script(file)
+              "#{'OK'.bold.green}: appended completion for #{'sym'.bold.red} to #{file.bold.yellow}\n"
+            end
+          else
+            append_completion_script(file)
+            "#{'OK'.bold.green}: created new file #{file.bold.yellow} and installed BASH completion for #{'sym'.bold.red}\n"
+          end
+        end
+
+        def install_completion_file
+          FileUtils.cp(Sym::BASH_COMPLETION[:file], Sym::COMPLETION_PATH)
+        end
+
+        def append_completion_script(file)
+          File.open(file, 'a') do |fd|
+            fd.write(Sym::BASH_COMPLETION[:script])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,8 +14,6 @@ module Sym
           new_private_key = encr_password(new_private_key,
                                           application.input_handler.new_password) if opts[:password]
 
-          clipboard_copy(new_private_key) if opts[:copy]
-
           Sym::App::KeyChain.new(opts[:keychain], opts).
             add(new_private_key) if opts[:keychain] && Sym::App.is_osx?
 
@@ -25,12 +23,6 @@ module Sym
           retry if (retries += 1) < 3
         end
 
-        private
-
-        def clipboard_copy(key)
-          require 'clipboard'
-          Clipboard.copy(key)
-        end
       end
     end
   end

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

@@ -15,8 +15,8 @@ module Sym
                             echo:    'echo $KEY',
                             result:  '75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4='.green)
 
-          output << example(comment: 'generate a new password-protected key, copy to the clipboard & save to a file',
-                            command: 'sym -gpc -o ~/.key',
+          output << example(comment: 'generate a new password-protected key & save to a file',
+                            command: 'sym -gp -o ~/.key',
                             echo:    'New Password     : ' + '••••••••••'.green,
                             result:  'Confirm Password : ' + '••••••••••'.green)
 
@@ -35,7 +35,7 @@ module Sym
           output << example(comment: 'decrypt an encrypted file and print it to STDOUT:',
                             command: 'sym -df sym.enc -k $KEY')
 
-          output << example(comment: 'edit an encrypted file in $EDITOR, ask for key, create a backup',
+          output << example(comment: 'edit an encrypted file in $EDITOR, ask for key, create file backup',
                             command: 'sym -tibf ecrets.enc',
                             result:  '
 Private Key: ••••••••••••••••••••••••••••••••••••••••••••

data/lib/sym/version.rb

@@ -1,3 +1,3 @@
 module Sym
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

data/lib/sym.rb

@@ -5,11 +5,11 @@ require 'coin'
 require_relative 'sym/configuration'
 
 Sym::Configuration.configure do |config|
-  config.password_cipher = 'AES-128-CBC'
-  config.data_cipher = 'AES-256-CBC'
-  config.private_key_cipher = config.data_cipher
+  config.password_cipher     = 'AES-128-CBC'
+  config.data_cipher         = 'AES-256-CBC'
+  config.private_key_cipher  = config.data_cipher
   config.compression_enabled = true
-  config.compression_level = Zlib::BEST_COMPRESSION
+  config.compression_level   = Zlib::BEST_COMPRESSION
 end
 
 #
@@ -109,5 +109,13 @@ module Sym
       end
     end
   end
+
+  COMPLETION_FILE = '.sym.completion'
+  COMPLETION_PATH = "#{ENV['HOME']}/#{COMPLETION_FILE}"
+
+  BASH_COMPLETION = {
+    file:   File.expand_path('../../bin/sym.completion', __FILE__),
+    script: "[[ -f '#{COMPLETION_PATH}' ]] && source '#{COMPLETION_PATH}'",
+  }
 end
 

data/sym.gemspec

@@ -27,20 +27,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.2'
-  spec.post_install_message = "
+  spec.post_install_message = <<-EOF
+Thank you for installing this gem! 
+To enable bash command line completion, please run the following 
+command, which appends sym's shell completion to the specified file:
 
-Please copy and paste the following BASH function into your ~/.bashrc or
-equivalent, in order to enable command completion:
+  sym --bash-completion ~/.bash_profile 
 
-Thank you for installing Sym!
-   -- KG (github.com/kigster)
-"
+(or any other shell initialization file of your preference).
 
+Thank you for checking out Sym and happy crypting :)
+   -- KG ( github.com/kigster | twitter.com/kig )
+EOF
   spec.add_dependency 'colored2', '~> 2.0'
   spec.add_dependency 'slop', '~> 4.3'
   spec.add_dependency 'activesupport'
   spec.add_dependency 'highline', '~> 1.7'
-  spec.add_dependency 'clipboard', '~> 1.1'
   spec.add_dependency 'coin', '~> 0.1.8'
 
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sym
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-21 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: clipboard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: coin
   requirement: !ruby/object:Gem::Requirement
@@ -215,14 +201,14 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
-- MANAGING-KEYS.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- bin/sym.bash-completion
+- bin/sym.completion
 - exe/keychain
 - exe/sym
 - lib/sym.rb
@@ -230,22 +216,17 @@ files:
 - lib/sym/app/args.rb
 - lib/sym/app/cli.rb
 - lib/sym/app/commands.rb
+- lib/sym/app/commands/bash_completion.rb
 - lib/sym/app/commands/command.rb
-- lib/sym/app/commands/delete_keychain_item.rb
 - lib/sym/app/commands/encrypt_decrypt.rb
 - lib/sym/app/commands/generate_key.rb
 - lib/sym/app/commands/open_editor.rb
 - lib/sym/app/commands/print_key.rb
 - lib/sym/app/commands/show_examples.rb
 - lib/sym/app/commands/show_help.rb
-- lib/sym/app/commands/show_language_examples.rb
 - lib/sym/app/commands/show_version.rb
 - lib/sym/app/input/handler.rb
 - lib/sym/app/keychain.rb
-- lib/sym/app/nlp.rb
-- lib/sym/app/nlp/constants.rb
-- lib/sym/app/nlp/translator.rb
-- lib/sym/app/nlp/usage.rb
 - lib/sym/app/output.rb
 - lib/sym/app/output/base.rb
 - lib/sym/app/output/file.rb
@@ -273,14 +254,11 @@ files:
 homepage: https://github.com/kigster/sym
 licenses: []
 metadata: {}
-post_install_message: |2
-
-
-  Please copy and paste the following BASH function into your ~/.bashrc or
-  equivalent, in order to enable command completion:
-
-  Thank you for installing Sym!
-     -- KG (github.com/kigster)
+post_install_message: "Thank you for installing this gem! \nTo enable bash command
+  line completion, please run the following \ncommand, which appends sym's shell completion
+  to the specified file:\n\n  sym --bash-completion ~/.bash_profile \n\n(or any other
+  shell initialization file of your preference).\n\nThank you for checking out Sym
+  and happy crypting :)\n   -- KG ( github.com/kigster | twitter.com/kig )\n"
 rdoc_options: []
 require_paths:
 - lib

data/MANAGING-KEYS.md

@@ -1,67 +0,0 @@
-# Managing Private Keys
-
-In this document we discuss several methods of keeping the private keys safe and yet conveniently available when needed. We also note the possible security implications of each method.
-
-We assume that you have some data or files that have been previously encrypted with a 32-byte key using this library, and that you want to be able to access the data easily with your private key, but at the same time not make it too easy for an attacker to find the keys.
-
-## Method 1.<br>Keychain Access on Mac OS-X
-
-How you store the secret, is up to you, but here is one way that leverages Mac OS-X Keychain. In fact you can store multiple keys if you like. In the example below we'll store two separate keys, one for staging and one for production:
-
-In your terminal, type these two commands. Note that the `-s` parameter is something you might want to customize, and make it easy to find. For example, instead of using `production` you could use `big-corp-django-secret-production`. The name should be such that it's easy to find once you open KeyChain Editor later.
-
-```bash
-security add-generic-password -a $USER -D "secret-cipher-base64" -s "staging"
-security add-generic-password -a $USER -D "secret-cipher-base64" -s "production"
-```
-
-This step does not actually store any key, it simply creates a KeyChain placeholder for it. We'll generate and add the key next.
-
-Finally, to make this a bit more efficient, I recommend listing the key names in an array-type environment variable set in your `~/.bashrc` file, for example:
-
-```bash
-# ~/.bashrc
-declare -a secret_names=(production staging)
-```
-
-After declaring this array, you can even rewrite the above command as a loop, which could be handy if you are storing not 2 or 3 but 10+ keys.
-
-```bash
-for secret_name in ${secret_names[@]}; do
-  security add-generic-password -a $USER \ 
-      -D "secret-cipher-base64" -s $secret_name
-done
-```
- 
-### Saving the Secret to KeyChain
-
-* Open `KeyChain Access` application 
-* Search for the token you specified, for example `production`
-* Double-click on the matching entry
-* Click "Show password"
-* Paste the copied value in that field
-* Click "Save Changes"
-* Repeat for `staging` or any other key you want to save.
-
-### Retrieving Secret from the KeyChain
-
-Using the below bash function, you can retrieve and export the sym as environment variables, which can later be read by your code:
-
-```bash
-# append this function to your ~/.bashrc or ~/.bash_profile
-function load_keys() {
-  declare -a secret_names=(production staging)
-  for secret_name in ${secret_names[@]}; do
-    varname="secret_${secret_name}"  # eg, $secret_production 
-    secret=`security find-generic-password -g -a $USER -w -D "secret-cipher-base64" -s "$secret_name"`
-    eval "export $varname=$secret"
-  done
-}  
-```
-
-With this out of the way, we just need to type `load_keys` in Terminal to get our keys automatically exported.
-
-### Security
-
-In this model, an attacker who obtains login access to your account will be able to quickly examine the local environment to discover one or more private keys already exported.
-

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

@@ -1,17 +0,0 @@
-require_relative 'command'
-require 'sym/app/keychain'
-module Sym
-  module App
-    module Commands
-      class DeleteKeychainItem < Command
-
-        required_options :keychain_del
-        try_after :generate_key, :open_editor, :encrypt_decrypt
-
-        def execute
-          Sym::App::KeyChain.new(opts[:keychain_del]).delete
-        end
-      end
-    end
-  end
-end

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

@@ -1,81 +0,0 @@
-require 'colored2'
-require_relative 'command'
-require_relative '../nlp'
-module Sym
-  module App
-    module Commands
-      class ShowLanguageExamples < Command
-        required_options :language
-        try_after :show_help
-
-
-
-        def execute
-          output = []
-
-          output << Sym::App::NLP::Base.usage
-
-          output << example(comment: 'generate a new private key and copy to the clipboard but do not print to terminal',
-                            command: 'sym create new key to clipboard quietly'
-          )
-
-          output << example(comment: 'generate and save to a file a password-protected key, silently',
-                            command: 'sym create a secure key and save it to "my.key"',
-          )
-
-          output << example(comment: 'encrypt a plain text string with a key, and save the output to a file',
-                            command: 'sym encrypt string "secret string" using $(cat my.key) save to file.enc')
-
-          output << example(comment: 'decrypt a previously encrypted string:',
-                            command: 'sym decrypt string $ENC using $(cat my.key)')
-
-          output << example(comment: 'encrypt "file.txt" with key from my.key and save it to file.enc',
-                            command: 'sym encrypt file file.txt with key from my.key and save it to file.enc')
-
-          output << example(comment: 'decrypt an encrypted file and print it to STDOUT:',
-                            command: 'sym decrypt file file.enc with key from "my.key"')
-
-          output << example(comment: 'edit an encrypted file in $EDITOR, ask for key, and create a backup upon save',
-                            command: 'sym edit file file.enc ask for a key and make a backup',
-          )
-
-          if Sym::App.is_osx?
-            output << example(comment: 'generate a new password-encrypted key, save it to your Keychain:',
-                              command: 'sym create a new protected key store in keychain "my-keychain-key"')
-
-            output << example(comment: 'print the key stored in the keychain item "my-keychain-key"',
-                              command: 'sym print keychain "my-keychain-key"')
-
-            output << example(comment: 'use the new key to encrypt a file:',
-                              command: 'sym encrypt with keychain "my-keychain-key" file "password.txt" and write to "passwords.enc"')
-
-          end
-
-          output.flatten.compact.join("\n")
-        end
-
-        def example(comment: nil, command: nil, echo: nil, result: nil)
-          @dict   ||= ::Sym::App::NLP::Constants::DICTIONARY.to_a.flatten!
-          _command = command.split(' ').map do |w|
-            _w = w.to_sym
-            if w == 'sym'
-              w.italic.yellow
-            elsif ::Sym::App::NLP::Constants::STRIPPED.include?(_w)
-              w.italic.red
-            elsif @dict.include?(_w)
-              w.blue
-            else
-              w
-            end
-          end.join(' ') if command
-          out     = []
-          out << "# #{comment}".white.dark.italic if comment
-          out << "#{_command}" if command
-          out << "#{echo}" if echo
-          out << "#{result}" if result
-          out << (' '*80).dark
-        end
-      end
-    end
-  end
-end

data/lib/sym/app/nlp/constants.rb

@@ -1,32 +0,0 @@
-module Sym
-  module App
-    module NLP
-      module Constants
-        STRIPPED = %i(and a the it item to key with about for of new make store in print)
-
-        DICTIONARY = {
-          # option (Slop)
-          #               list of english words that map to it
-          :copy        => [:clipboard],
-          :decrypt     => [:unlock],
-          :edit        => [:open],
-          :encrypt     => [:lock],
-          :backup      => [],
-          :keychain    => [],
-          :file        => [:read],
-          :generate    => [:create],
-          :interactive => [:ask, :enter, :type],
-          :keyfile     => [:from],
-          :output      => [:save, :write],
-          :private_key => [:using, :private],
-          :string      => [:value],
-          :quiet       => [:silently, :quietly, :silent, :sym],
-          :password    => [:secure, :secured, :protected]
-        }
-
-      end
-
-    end
-  end
-end
-

data/lib/sym/app/nlp/translator.rb

@@ -1,61 +0,0 @@
-require_relative 'constants'
-module Sym
-  module App
-    module NLP
-      class Translator
-
-        attr_accessor :argv, :translated_argv, :opts
-
-        def initialize(argv)
-          self.argv            = argv
-          self.opts            = CLI.new(%w(-E)).opts.to_hash
-          self.translated_argv = []
-        end
-
-        def dict
-          ::Sym::App::NLP::Constants::DICTIONARY
-        end
-
-        def stripped
-          ::Sym::App::NLP::Constants::STRIPPED
-        end
-
-        def translate
-          self.translated_argv = argv.map do |value|
-            nlp_argument = value.to_sym
-            arg = nil
-            arg ||= dict.keys.find do |key|
-              dict[key].include?(nlp_argument) || key == nlp_argument
-            end
-            arg ||= nlp_argument
-
-            if stripped.include?(arg)
-              # nada
-            elsif opts.to_hash.key?(arg)
-              '--' + "#{arg.to_s.gsub(/_/, '-')}"
-            else
-              arg.to_s
-            end
-          end.compact
-
-          counts = {}
-          translated_argv.each{ |arg| counts.key?(arg) ? counts[arg] += 1 : counts[arg] = 1 }
-          translated_argv.delete_if{ |arg| counts[arg] > 1 }
-          self
-        end
-
-        def and
-          translate if translated_argv.empty?
-          if self.translated_argv.include?('--verbose')
-            STDERR.puts 'Original arguments: '.dark + "#{argv.join(' ').green}"
-            STDERR.puts '   Translated argv: '.dark + "#{translated_argv.join(' ').blue}"
-          end
-          ::Sym::App::CLI.new(self.translated_argv)
-        end
-
-        alias_method :application, :and
-
-      end
-    end
-  end
-end

data/lib/sym/app/nlp/usage.rb

@@ -1,72 +0,0 @@
-require 'pp'
-module Sym
-  module App
-    #     sym generate key to the clipboard and keychain
-    #     sym encrypt file 'hello' using $key [to output.enc]
-    #     sym edit 'passwords.enc' using $key
-    #     sym decrypt /etc/secrets encrypted with $key save to ./secrets
-    #     sym encrypt file $input with keychain $item
-    module NLP
-      module Usage
-
-        def usage
-          out = ''
-          out << %Q`
-#{header('Natural Language Processing')}
-
-#{'When '.dark.normal}#{'sym'.bold.blue} #{'is invoked, and the first argument does not begin with a dash,
-then the the NLP (natural language processing) Translator is invoked.
-The Translator is based on a very simple algorithm:
-
- * ignore any of the words tagged STRIPPED. These are the ambiguous words,
-   or words with duplicate meaning.
-
- * map the remaining arguments to regular double-dashed options using the DICTIONARY
-
- * words that are a direct match for a --option are automatically double-dashed
-
- * remaining words are left as is (these would be file names, key names, etc).
-
- * finally, the resulting "new" command line is parsed with regular options.
-
- * When arguments include "verbose", NLP system will print "before" and "after"
-   of the arguments, so that any issues can be debugged and corrected.
-
-'.dark.normal}
-
-#{header('Currently ignored words:')}
-    #{Constants::STRIPPED.join(', ').red.italic}
-
-#{header('Regular Word Mapping')}
-#{Constants::DICTIONARY.pretty_inspect.split(/\n/).map do |line|
-            line.gsub(
-              /[\:\}\,\[\]]/, ''
-            ).gsub(
-              /[ {](\w+)=>([^\n]*)/, '\2|\1'
-            )
-          end.map { |line| convert_dictionary(*line.split('|')) }.join}
-
-#{header('Examples')}
-`
-          out
-        end
-
-        def convert_dictionary(left = '', right = '')
-          [
-            sprintf('%35.35s', left.gsub(/ /, ' ')).italic.yellow,
-            '   ───────➤   '.dark,
-            sprintf('--%-20.20s', right).blue,
-
-            "\n"
-          ].join
-        end
-
-        private
-        def header(title)
-          title.upcase.bold.underlined
-        end
-
-      end
-    end
-  end
-end

data/lib/sym/app/nlp.rb

@@ -1,18 +0,0 @@
-require_relative 'cli'
-require_relative 'nlp/constants'
-require_relative 'nlp/usage'
-require_relative 'nlp/translator'
-module Sym
-  module App
-    #     sym generate key to the clipboard and keychain
-    #     sym encrypt file 'hello' using $key [to output.enc]
-    #     sym edit 'passwords.enc' using $key
-    #     sym decrypt /etc/secrets encrypted with $key save to ./secrets
-    #     sym encrypt file $input with keychain $item
-    module NLP
-      class Base
-        extend Usage
-      end
-    end
-  end
-end