sym 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0d5e823703d09fb437c0b9f8e11b55dd1a0e204
-  data.tar.gz: 42f5145f34d3d0779422e3c2511d35580d85c033
+  metadata.gz: dba3a8013e135db50a8294dd619302d1c10b8109
+  data.tar.gz: 28cc2c0edbff0ecec89e265109c11e3c9c67da01
 SHA512:
-  metadata.gz: 3b007deff2a49f8a31d451fd433eebc7cca83e8ff28a733b8d37a2b34ca5288460e93aa3e8b078442e6c680296fc19b1152f5deac81c2775acc57f79710478b1
-  data.tar.gz: 1c89daa41bbf54b754e203a65720f452e96546e79825924f8d670f11ef392e8c04ca34a85a706b3aba4c6f081870f08189239b3a5fdf7c2a473fec1e51ca47bc
+  metadata.gz: f78ca029db09962c423fb57e38c86e03b8417977714c6e087a80b31f0b9f6392ec7c6f2f8ebd1c41d9b7d75c82e0755f4ac37fd68393090c2a2eb17a81909d25
+  data.tar.gz: 1d6c15f15761ceb1187e45455408a27b371a15a798d139a840614427fd52ac0a4574c5475d83a7d483e2b3f4d6e4c321cdc5beddbd89d6e943066f9972d9c984

data/CHANGELOG.md

@@ -1,28 +1,90 @@
-**2.1.0** (January 22, 2017)
+# Change Log
 
-* Added two sub-commands to handle updating and moving existing keys:
-  - adding a password to an existing key
-  - adding an existing key to the keychain.
-  
-To add a password to an existing key: 
+## [HEAD](https://github.com/kigster/sym/tree/HEAD)
 
-> `sym [ -k key | -K keyfile | -i | -x <name> ] -p `
+[Changes since the last tag](https://github.com/kigster/sym/compare/v2.2.1...HEAD)
 
-To add existing key to a keychain:  
- 
-> `sym [ -k key | -K keyfile | -i ] -x <name> `
+## [v2.2.1](https://github.com/kigster/sym/tree/v2.2.1) (2017-02-15)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.2.0...v2.2.1)
 
-**2.0.3** (January 22, 2017)
+* [`53bb95f`](https://github.com/kigster/sym/commit/53bb95f) Ability to read flags from SYM_ARGS environment
+* [`c3d0b86`] (https://github.com/kigster/sym/commit/c3d0b86) Switched to using bash-completion-style syntax
+* [`9368bf5`] (https://github.com/kigster/sym/commit/9368bf5) Adding CHANGELOG.md
 
-* 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
+## [v2.2.0](https://github.com/kigster/sym/tree/v2.2.0) (2017-02-14)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.1.2...v2.2.0)
 
-**2.0.2** (January 20, 2017)
+**API CHANGE**:
 
-* Added bash-completion installation
-* Fixed a bug where a newline was added to file redirects, making
-  redirecting encrypted data or keys unusable.
+* Turn off password caching by default, enable with `-C`
+* `-P < memcached | drb >` specifies caching mechanism
+
+**Changes:**
+
+* [`b470245`](https://github.com/kigster/sym/commit/b470245/) Turn off password caching by default, enable with `-C`, timeout with `-T`
+* [`ca3a903`](https://github.com/kigster/sym/commit/ca3a903/) Adding -C flag
+* [`949b2ae`](https://github.com/kigster/sym/commit/949b2ae/) Updating README
+* [`513f849`](https://github.com/kigster/sym/commit/513f849/) Adding MemCached provider; ability to specify provider with `-P`
+* [`571e668`](https://github.com/kigster/sym/commit/571e668/) Split up Coin off to a cache provider
+* [`7afeccc`](https://github.com/kigster/sym/commit/7afeccc/) Better messaging when password server times out
+* [`cf226f9`](https://github.com/kigster/sym/commit/cf226f9/) Implement fast timeout for password caching providers, fixes [\#3](https://github.com/kigster/sym/issues/3)
+
+**Closed Issues:**
+
+- make sure drb is not already running/handle exception [\#3](https://github.com/kigster/sym/issues/3)
+
+
+
+## [v2.1.2](https://github.com/kigster/sym/tree/v2.1.2) (2017-02-11)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.1.1...v2.1.2)
+
+* [`dce9b05`](https://github.com/kigster/sym/commit/dce9b05/) Updating gems summary/desription; bump version 2.1.2
+* [`ba60592`](https://github.com/kigster/sym/commit/ba60592/) Adding TOC
+* [`7b04ea9`](https://github.com/kigster/sym/commit/7b04ea9/) Updating README for the gem;
+* [`52efdb4`](https://github.com/kigster/sym/commit/52efdb4/) Updating the 3.0 usage
+
+## [v2.1.1](https://github.com/kigster/sym/tree/v2.1.1) (2017-02-05)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.1.0...v2.1.1)
+
+* [`d503c1c`](https://github.com/kigster/sym/commit/d503c1c/) Fix bug with -E flag exploding; version 2.1.1
+
+## [v2.1.0](https://github.com/kigster/sym/tree/v2.1.0) (2017-01-23)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.0.3...v2.1.0)
+
+* [`a7f3239`](https://github.com/kigster/sym/commit/a7f3239/) Proposed CLI for version 3.0
+* [`3a706ce`](https://github.com/kigster/sym/commit/3a706ce/) Rename Command to BaseCommand; use require
+* [`77936ee`](https://github.com/kigster/sym/commit/77936ee/) Existing keys can be password-prot, and keychained
+
+## [v2.0.3](https://github.com/kigster/sym/tree/v2.0.3) (2017-01-22)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.0.2...v2.0.3)
+
+* [`342ecb7`](https://github.com/kigster/sym/commit/342ecb7/) Disable some checks.
+* [`984ec27`](https://github.com/kigster/sym/commit/984ec27/) Adding CHANGELOG.
+* [`4fc7983`](https://github.com/kigster/sym/commit/4fc7983/) Removing clipboard copy feature: its easy enough.
+* [`4f38aa5`](https://github.com/kigster/sym/commit/4f38aa5/) Removing unnecessary file.
+* [`4ff0412`](https://github.com/kigster/sym/commit/4ff0412/) Updating README with latest help
+* [`787116c`](https://github.com/kigster/sym/commit/787116c/)  rm NLP module, rm keychain del, add bash-comp.
+* [`bf70e30`](https://github.com/kigster/sym/commit/bf70e30/) Update repo token
+
+## [v2.0.2](https://github.com/kigster/sym/tree/v2.0.2) (2017-01-21)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.0.1...v2.0.2)
+
+* [`c586299`](https://github.com/kigster/sym/commit/c586299/) Better gem description; Bump version
+
+## [v2.0.1](https://github.com/kigster/sym/tree/v2.0.1) (2017-01-20)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.0.0...v2.0.1)
+
+* [`96add73`](https://github.com/kigster/sym/commit/96add73/) Travis teset coverage, etc
+* [`8f0209e`](https://github.com/kigster/sym/commit/8f0209e/) Updating README badges
+* [`0c6a612`](https://github.com/kigster/sym/commit/0c6a612/) Only use github for coin on OSX
+* [`3afe846`](https://github.com/kigster/sym/commit/3afe846/) Fixed a bug with >> redirects adding newline
+* [`9409cdb`](https://github.com/kigster/sym/commit/9409cdb/) Fixing bash completion for sym.
+* [`7cdb062`](https://github.com/kigster/sym/commit/7cdb062/) Add .ruby-version to gitignore
+* [`488cd73`](https://github.com/kigster/sym/commit/488cd73/) Using a fork of coin from github
+* [`a13eb55`](https://github.com/kigster/sym/commit/a13eb55/) Adding .DS_Store to .gitignore
+
+## [v2.0.0](https://github.com/kigster/sym/tree/v2.0.0) (2016-11-11)
+[Full Changelog](https://github.com/kigster/sym/compare/v1.1.2...v2.0.0)
+
+Commits between version 1.1.2 and 2.0.0 were not tracked in the changelog.
 

data/README.md

@@ -68,13 +68,18 @@ BAhTOh1TeW06OkRhdGE6OldyYXBFefDFFD.....
 
 ❯ sym -dx my-new-key -f secret.enc -C
 My secret data
+
+# Lets now save common flags in the SYM_ARGS bash variable:
+❯ export SYM_ARGS="-x my-new-key -C"
+❯ sym -d -f secret.enc 
+My secret data
 ```
 
 The line that says `Coin::Vault listening at: druby://127.0.0.1:24924` is the indication that the local dRB server used for caching passwords has been started. Password caching is off by default, but is enabled with `-C` flag. In the example above, the decryption step fetched the password from the cache, and so the user was not required to re-enter the password.
 
 __Direct Editing Encrypted Files__
 
-Instead of decrypting data anytime you need to change it, you can use the shortcut flag `-t` (for "edi__T__"), which decrypts your data into a temporary file, automatically opening it with an `$EDITOR`. 
+Instead of decrypting data anytime you need to change it, you can use the shortcut flag `-t` (for "edi**t**"), which decrypts your data into a temporary file, automatically opening it with an `$EDITOR`. 
 
 Example:
 
@@ -209,27 +214,56 @@ In order to control password caching, the following flags are available:
  * `-T seconds` sets the expiration for cached passwords
  * `-P memcached | drb` controls which of the providers is used. Without this flag, *sym* auto-detects caching provider by first checking for `memcached`, and then starting the `dRB` server.
 
-#### Encryption and Decryption
+#### Saving Common Flags in an Environment Variable
+
+You can optionally store frequently used flags for `sym` in the `SYM_ARGS` environment variable. For example, to always cache passwords, and to always use the same encryption key from the keychain named "production", set the following in your `~/.bashrc`:
+
+```
+export SYM_ARGS="-x production -C"
+```
+
+This will always be appended to the command line, and so to encrypt/decrypt anything with password caching enabled and using that particular key, you would simply type:
+
+```bash
+# -x production -C are added from SYM_ARGS
+sym -ef file -o file.enc
+
+# And to decrypt:
+sym -df file.enc -o file.original
+
+# Or edit the encrypted file:
+sym -tf file.enc
+```
+
+#### Complete CLI Usage
 
 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 (2.2.0) – encrypt/decrypt data with a private key
+Sym (2.2.1) – encrypt/decrypt data with a private key
 
 Usage:
-   # Generate a new key:
+   # Generate a new key...
    sym -g [ -p ] [ -x keychain | -o keyfile | -q | ]  
 
-   # To specify a key for an operation use any one of:
+   # To specify a key for an operation use one of...
    <key-spec> = -k key | -K file | -x keychain | -i 
 
-   # Encrypt/Decrypt to STDOUT or output file 
+   # Encrypt/Decrypt to STDOUT or an output file 
    sym -e <key-spec> [-f <file> | -s <string>] [-o <file>] 
    sym -d <key-spec> [-f <file> | -s <string>] [-o <file>] 
  
    # Edit an encrypted file in $EDITOR 
    sym -t <key-spec>  -f <file> [ -b ]
  
+   # Specify any common flags in the BASH variable:
+   export SYM_ARGS="-x staging -C"
+ 
+   # And now encrypt without having to specify key location:
+   sym -e -f <file>
+   # May need to disable SYM_ARGS with -M, eg for help:
+   sym -h -M 
+ 
 Modes:
   -e, --encrypt                     encrypt mode
   -d, --decrypt                     decrypt mode
@@ -248,8 +282,7 @@ Read existing private key from:
 Password Cache:
   -C, --cache-password              enable the cache (off by default)
   -T, --cache-for        [seconds]  to cache the password for
-  -P, --cache-provider   [provider] type of cache, one of: 
-				    [ memcached, drb ]
+  -P, --cache-provider   [provider] type of cache, one of memcached, drb
  
 Data to Encrypt/Decrypt:
   -s, --string           [string]   specify a string to encrypt/decrypt
@@ -264,6 +297,7 @@ Flags:
   -q, --quiet                       do not print to STDOUT
   -V, --version                     print library version
   -N, --no-color                    disable color output
+  -M, --no-environment              disable reading flags from SYM_ARGS
  
 Utility:
   -a, --bash-completion  [file]     append shell completion to a file
@@ -271,7 +305,6 @@ Utility:
 Help & Examples:
   -E, --examples                    show several examples
   -h, --help                        show help
-
 ```
 
 ### CLI Usage Examples

data/bin/sym.completion

@@ -5,28 +5,75 @@
 # © 2015-2016, Konstantin Gredeskoul,  https://github.com/kigster/sym
 # MIT LICENSE
 #
+ [[ -z "$(type _filedir 2>/dev/null)" ]] && {
+  _filedir ()
+  {
+      local i IFS='
+  ' xspec;
+      _tilde "$cur" || return 0;
+      local -a toks;
+      local quoted tmp;
+      _quote_readline_by_ref "$cur" quoted;
+      toks=(${toks[@]-} $(
+          compgen -d -- "$cur" | {
+              while read -r tmp; do
+                  # TODO: I have removed a "[ -n $tmp ] &&" before 'printf ..',
+                  #       and everything works again. If this bug suddenly
+                  #       appears again (i.e. "cd /b<TAB>" becomes "cd /"),
+                  #       remember to check for other similar conditionals (here
+                  #       and _filedir_xspec()). --David
+                  printf '%s\n' $tmp
+              done
+          }
+      ));
+      if [[ "$1" != -d ]]; then
+          [[ ${BASH_VERSINFO[0]} -ge 4 ]] && xspec=${1:+"!*.@($1|${1^^})"} || xspec=${1:+"!*.@($1|$(printf %s $1 | tr '[:lower:]' '[:upper:]'))"};
+          toks=(${toks[@]-} $( compgen -f -X "$xspec" -- $quoted));
+      fi;
+      [ ${#toks[@]} -ne 0 ] && _compopt_o_filenames;
+      COMPREPLY=("${COMPREPLY[@]}" "${toks[@]}")
+  }
+}
 
-_sym() {
-    local SYM_OPTS SYM_POINTS cur prev
-
-    cur="${COMP_WORDS[COMP_CWORD]}"
-    prev="${COMP_WORDS[COMP_CWORD-1]}"
+_sym()
+{
+    local cur prev shell i path
 
     COMPREPLY=()
+    cur=`_get_cword`
+    prev=${COMP_WORDS[COMP_CWORD-1]}
 
-    #[[ $COMP_CWORD == 1 ]] && SYM_COMP_OPTIONS="${SYM_COMP_OPTIONS} ${SYM_COMMANDS}"
-    if [[ $prev =~ "-f" || $prev =~ "-o" || $prev =~ "-K" || $prev == "--keyfile" ]] ; then 
-      SYM_COMP_OPTIONS="$(find . -type f -depth 1 | sed 's#^.\/##g')"
-    elif  [[ "${cur}" == '-' || "${cur}" == -* ]] ; then 
-      export DICT_SYM_COMP_OPTIONS=${DICT_SYM_COMP_OPTIONS:-$(sym --dictionary | sed -E 's/ /\n/g')}
-      SYM_COMP_OPTIONS=${DICT_SYM_COMP_OPTIONS}
-    else 
-      SYM_COMP_OPTIONS="$(find . -type f -depth 1 -name "${prev}*" | sed 's#^.\/##g')"
-    fi
+    _expand || return 0
 
-    COMPREPLY=( $(compgen -W "${SYM_COMP_OPTIONS}" -- ${cur}) )
-    return 0
-}
+    case "$prev" in
+    --@(key-file|file|output|))
+        _filedir
+        return 0
+        ;;
+    -@(f|K|o))
+        _filedir
+        return 0
+        ;;
+    esac
+
+    case "$cur" in
+    -*)
+        export DICT_SYM_COMP_OPTIONS=${DICT_SYM_COMP_OPTIONS:-$(sym --dictionary | sed -E 's/ /\n/g')}
+        COMPREPLY=( $( compgen -W "$DICT_SYM_COMP_OPTIONS" -- "$cur" ))
+        ;;
+    *)
+        _filedir
+        ;;
+    esac
 
-complete -F _sym sym
+    return 0
+} &&
+complete -F _sym $nospace $filenames sym
 
+# Local variables:
+# mode: shell-script
+# sh-basic-offset: 4
+# sh-indent-comment: t
+# indent-tabs-mode: nil
+# End:
+# ex: ts=4 sw=4 et filetype=sh

data/lib/sym.rb

@@ -11,7 +11,7 @@ Sym::Configuration.configure do |config|
   config.compression_enabled = true
   config.compression_level   = Zlib::BEST_COMPRESSION
 
-  config.password_cache_timeout = 300
+  config.password_cache_timeout          = 300
 
   # When nil is selected, providers are auto-detected.
   config.password_cache_default_provider = nil
@@ -131,14 +131,14 @@ module Sym
     end
   end
 
-  COMPLETION_FILE = '.sym.completion'
-  COMPLETION_PATH = "#{ENV['HOME']}/#{COMPLETION_FILE}"
+  COMPLETION_FILE        = '.sym.completion'.freeze
+  COMPLETION_PATH        = "#{ENV['HOME']}/#{COMPLETION_FILE}".freeze
+  LOGGER                 = Logger.new(nil).freeze # empty logger
+  ENV_ARGS_VARIABLE_NAME = 'SYM_ARGS'.freeze
 
-  BASH_COMPLETION = {
+  BASH_COMPLETION        = {
     file:   File.expand_path('../../bin/sym.completion', __FILE__),
     script: "[[ -f '#{COMPLETION_PATH}' ]] && source '#{COMPLETION_PATH}'",
-  }
-
-  LOGGER = Logger.new(nil) # empty logger
+  }.freeze
 end
 

data/lib/sym/app/cli.rb

@@ -61,8 +61,11 @@ module Sym
       attr_accessor :opts, :application, :outputs, :output_proc
 
       def initialize(argv_original)
+        env_args = ENV[ENV_ARGS_VARIABLE_NAME]
         begin
-          argv      = argv_original.dup
+          argv = argv_original.dup
+          argv << env_args.split(' ') if env_args && !(argv.include?('-M') or argv.include?('--no-environment'))
+          argv.flatten!
           dict      = argv.delete('--dictionary')
           self.opts = parse(argv)
           command_dictionary if dict

data/lib/sym/app/cli_slop.rb

@@ -6,19 +6,28 @@ 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 '   # Generate a new key...'.dark
           o.separator '   sym -g '.green.bold + '[ -p ] [ -x keychain | -o keyfile | -q | ]  '.green
           o.separator ''
-          o.separator '   # To specify a key for an operation use any one of:'.dark
+          o.separator '   # To specify a key for an operation use one of...'.dark
           o.separator '   ' + key_spec + ' = -k key | -K file | -x keychain | -i '.green.bold
           o.separator ''
-          o.separator '   # Encrypt/Decrypt to STDOUT or output file '.dark
+          o.separator '   # Encrypt/Decrypt to STDOUT or an output file '.dark
           o.separator '   sym -e '.green.bold + key_spec + ' [-f <file> | -s <string>] [-o <file>] '.green
           o.separator '   sym -d '.green.bold + key_spec + ' [-f <file> | -s <string>] [-o <file>] '.green
           o.separator ' '
           o.separator '   # Edit an encrypted file in $EDITOR '.dark
           o.separator '   sym -t '.green.bold + key_spec + '  -f <file> [ -b ]'.green.bold
 
+          o.separator ' '
+          o.separator '   # Specify any common flags in the BASH variable:'.dark
+          o.separator '   export SYM_ARGS="'.green + '-x staging -C'.bold.green + '"'.green
+          o.separator ' '
+          o.separator '   # And now encrypt without having to specify key location:'.dark
+          o.separator '   sym -e '.green.bold '-f <file>'.green.bold
+          o.separator '   # May need to disable SYM_ARGS with -M, eg for help:'.dark
+          o.separator '   sym -h -M '.green.bold
+
           o.separator ' '
           o.separator 'Modes:'.yellow
           o.bool      '-e', '--encrypt',            '           encrypt mode'
@@ -61,6 +70,7 @@ module Sym
           o.bool      '-q', '--quiet',              '           do not print to STDOUT'
           o.bool      '-V', '--version',            '           print library version'
           o.bool      '-N', '--no-color',           '           disable color output'
+          o.bool      '-M', '--no-environment',     '           disable reading flags from SYM_ARGS'
 
           o.separator ' '
           o.separator 'Utility:'.yellow

data/lib/sym/version.rb

@@ -1,5 +1,5 @@
 module Sym
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
   DESCRIPTION = <<-eof
     Sym is a command line utility and a Ruby API that makes it trivial to encrypt and decrypt 
     sensitive data. Unlike many other existing encryption tools, sym focuses on usability and 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sym
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2