sym 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b37f317d0ff96c9cf5a96c63df07c09bb44b416
-  data.tar.gz: cc8ca5879102dffbdc67e4c6e813a6d7711bd3aa
+  metadata.gz: 6053432fc439cae6524efafc83f10ef5eba1478b
+  data.tar.gz: 07a5849debd54dbbbe0716ec72ce21de69b8947e
 SHA512:
-  metadata.gz: c638780011463e131e754ec7fc0ee5a1d71f8b3ab6063c3c117123a24639f5e9fb8da981c6e81781681fd966380571ba0fccf5b9883f885ec5b21bf9e8697b7c
-  data.tar.gz: 82ada53242e4d3ae2350c893edec7da3446e0a740357fda4e11d3e4a2ebb53c29597f429f6ee54c110aefcca86c50b1967eaf3706eaa1ed27c82bff5a0a3dc52
+  metadata.gz: 05dd00292348432a11a38fa22964016c949148e093ad8f0f5d71927455024aaf4d7b7ed113f71024d12e62858b9dceb75994f1281b7d0ee09eed4498c6238d6d
+  data.tar.gz: 9f69a6b471db6173ff6e7f57d43e99340ddd3e68805e24374233048c686ed04bbb9bc79c7d2ae0eb5f32ab078c1abd2fdc43d907ba7a65b33dea160fc6a69007

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+      
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+        
+      - run: 
+          name: install memcached
+          command: |
+            sudo apt-get update && sudo apt-get install -y memcached
+            sudo service start memcached || true
+            memcached -d || true
+            echo "checking if memcached is running...."
+            ps -ef | grep [m]emcached
+            # echo 'stats' | nc localhost 11211
+            # echo "if we see the stats, memcached is running!"
+
+      - run:
+          name: install sym bash helpers
+          command: |
+            bundle exec exe/sym -B ~/.bash_profile
+
+      - run:
+          name: run tests
+          command: |
+            [[ -z ${_bash} && -x /usr/local/bin/bash ]] && _bash=/usr/local/bin/bash
+            [[ -z ${_bash} && -x /usr/bin/bash ]] && _bash=/usr/bin/bash
+            [[ -z ${_bash} && -x /bin/bash ]] && _bash=/bin/bash
+            ${_bash} -l -c "
+              export USER=circleci 
+              export HOME=/home/${USER}/repo
+              ruby --version
+              bundle exec rspec --version
+              bundle exec exe/sym --version
+              bundle exec rspec --backtrace --format documentation
+            "
+      

data/.document

@@ -1,2 +1,2 @@
-lib/ exe/ - README.md LICENSE sym-3.0-cli.md
+lib/ exe/ - README.md LICENSE
 

data/.gitignore

@@ -13,3 +13,4 @@
 /*.enc
 **/.DS_Store
 .ruby-version
+temp/

data/.rspec

@@ -1,3 +1,4 @@
 --format progress
 --color
 --order rand
+--profile 2

data/.travis.yml

@@ -1,14 +1,11 @@
 language: ruby
-cache: bundler
 env:
-- CODECLIMATE_REPO_TOKEN=c71874cc22acffe1e2543d3388d3a96c73a65f0cfe17169dadd8de4a6c062c39 TEST_DRB=true
+- CODECLIMATE_REPO_TOKEN=c71874cc22acffe1e2543d3388d3a96c73a65f0cfe17169dadd8de4a6c062c39 TEST_DRB=true HOME=/home/travis USER=travis
 services:
 - memcached
 rvm:
-- 2.2.7
-- 2.3.4
-- 2.4.1
-- jruby-9.1.9.0
+- 2.3.5
+- 2.4.2
 notifications:
   email:
     recipients:
@@ -24,3 +21,11 @@ addons:
 # regular test configuration
 after_success:
   - bundle exec codeclimate-test-reporter
+before_script:
+  - echo stats | nc localhost 11211
+script:
+  - bundle exec exe/sym -B ~/.bash_profile -vTD
+  - ls -alF ~/.sym*
+  - ls -alF .
+  - mkdir -p temp
+  - bundle exec rspec --format documentation

data/CHANGELOG.md

@@ -4,6 +4,17 @@
 
 [Changes since the last tag](https://github.com/kigster/sym/compare/v2.7.0...HEAD)
 
+## [v2.8.0](https://github.com/kigster/sym/tree/v2.8.0) (2018-01-05)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.7.0...v2.8.0)
+
+Version 2.8.0 with several key changes below:
+
+ - Ensuring that Sym exits with a non-zero code when errors occur
+ - Ensuring that coverage, and doc folders are removed before release
+ - Adding sym-encrypt() and sym-decrypt() BASH helpers 
+ - Major update to `sym.symit` to provide easier access to commands.
+ - Cleaning up output of the errors
+
 ## [v2.7.0](https://github.com/kigster/sym/tree/v2.7.0) (2017-06-23)
 [Full Changelog](https://github.com/kigster/sym/compare/v2.6.3...v2.7.0)
 

data/README.md

@@ -1,13 +1,15 @@
 # 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)
+[![Sym Downloads](http://ruby-gem-downloads-badge.herokuapp.com/sym?extension=png)](https://rubygems.org/gems/sym)
 
 [![Build Status](https://travis-ci.org/kigster/sym.svg?branch=master)](https://travis-ci.org/kigster/sym)
 [![Code Climate](https://codeclimate.com/github/kigster/sym/badges/gpa.svg)](https://codeclimate.com/github/kigster/sym)
 [![Test Coverage](https://codeclimate.com/github/kigster/sym/badges/coverage.svg)](https://codeclimate.com/github/kigster/sym/coverage)
 [![Issue Count](https://codeclimate.com/github/kigster/sym/badges/issue_count.svg)](https://codeclimate.com/github/kigster/sym)
 
+**Discuss Sym on Gitter**:
+
 [![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/kigster/sym)
 
 ---
@@ -30,10 +32,24 @@ Your donation of absolutely any amount is very much appreciated.
 
 <p><strong>sym</strong> uses the <em><a href="https://en.wikipedia.org/wiki/Symmetric-key_algorithm">Symmetric Encryption</a></em> algorithm. This means that the same key is used to encrypt and decrypt data. In addition to the key, the encryption uses a randomized IV vector, which is automatically generated  per each encryption and serialized with the data. Result of encryption is zlib-compressed, and base64 encoded, to be suitable for storage as string. The generated keys are also base64-encoded for convenience.</p>
 
-<p>Finally, the library offers encryption using any regular password, and in particular supports password-protected encryption keys. The key can be specified by a filename, environment variable, or OS-X Keychain password entry name, or as is.</p>
+<p>Finally, the library offers encryption using any regular password, and in particular supports password-protected encryption keys. Automatic key detection algorithm attempts to resolve a provided key as a filename, an environment variable name, an OS-X Keychain password entry name, a key itself, or a default key file.</p>
 
 </div>
 
+### Quick Demo of the CLI in Action
+
+[![asciicast](design/ascii-cinema.png)](https://asciinema.org/a/106737)
+
+
+#### Help Screens, Examples and Symit Bash Wrapper
+
+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. Examples can be shown with `-E/--examples` flag. 
+
+Additionally, Sym comes with a helpful BASH wrapper `symit`. 
+
+**Help screens for `sym` and `symit` are shown in full on another page — [Sym Help Screens and Symit](SYM-CLI.md). Please refer to it for complete help screens and the examples.**
+
+
 ## Supported Ruby Versions
 
 [![Build Status](https://travis-ci.org/kigster/sym.svg?branch=master)](https://travis-ci.org/kigster/sym)
@@ -501,12 +517,6 @@ sym -Adf file.enc -o file.original
 sym -Atf file.enc
 ```
 
-#### CLI Help Screen and Examples
-
-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. Examples can be shown with `-E/--examples` flag.
-
-Please take a look at the [SYM-CLI](SYM-CLI.md) for a complete help screen and the examples.
-
 ## Fine Tuning
 
 <a name="rubyapi-config"></a>
@@ -611,4 +621,3 @@ Please submit feature requests, bugs, or donations :)
  * [Barry Anderson](https://twitter.com/z3ndrag0n) (sanity checking, review)
 
  
-

data/Rakefile

@@ -2,13 +2,21 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
 
+
 def shell(*args)
   puts "running: #{args.join(' ')}"
   system(args.join(' '))
 end
 
-task :permissions do 
-  shell('rm -rf pkg/')
+task :clean do
+  shell('rm -rf pkg/ tmp/ coverage/ doc/ ' )
+end
+
+task :gem => [:build] do
+  shell('gem install pkg/*')
+end
+
+task :permissions => [ :clean ] do
   shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
   shell("find . -type d -exec chmod o+x,g+x {} \\;")
 end
@@ -16,7 +24,7 @@ end
 task :build => :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE sym-3.0-cli.md)
+  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') }
 end

data/SYM-CLI.md

@@ -1,143 +1,20 @@
 # Sym CLI Help Screen
 
-```text
-Sym (2.5.1) – encrypt/decrypt data with a private key
+### Sym Help
 
-Usage:
-   Generate a new key, optionally password protected, and save it
-   in one of: keychain, file, or STDOUT (-q turns off STDOUT) 
- 
-       sym -g [ -p/--password ] [-c] [-x keychain | -o file | ] [-q]
+Below is the HELP screen for Sym:
 
-   To specify encryption key, provide the key as 
-      1) a string, 2) a file path, 3) an OS-X Keychain, 4) env variable name 
-      5) use -i to paste/type the key interactively
-      6) default key file (if present) at /Users/kig/.sym.key
- 
-       KEY-SPEC = -k/--key [ key | file | keychain | env variable name ]
-                  -i/--interactive
+![examples](design/sym-help.png)
 
-   Encrypt/Decrypt from STDIN/file/args, to STDOUT/file:
- 
-       sym -e/--encrypt KEY-SPEC [-f [file | - ] | -s string ] [-o file] 
-       sym -d/--decrypt KEY-SPEC [-f [file | - ] | -s string ] [-o file] 
+### Additional Sym Examples
 
-   Auto-detect mode based on a special file extension ".enc"
- 
-       sym -n/--negate  KEY-SPEC file[.enc] 
- 
-   Edit an encrypted file in $EDITOR 
- 
-       sym -t/--edit    KEY-SPEC -f file [ -b/--backup ]
- 
-   Save commonly used flags in a BASH variable. Below we save the KeyChain 
-   "staging" as the default key name, and enable password caching.
- 
-       export SYM_ARGS="-ck staging"
- 
-   Then activate $SYM_ARGS by using -A/--sym-args flag:
- 
-       sym -Aef file
- 
-Modes:
-  -e, --encrypt                     encrypt mode
-  -d, --decrypt                     decrypt mode
-  -t, --edit                        edit encrypted file in an $EDITOR
-  -n, --negate           [file]     encrypts any regular file into file.enc
-                                    conversely decrypts file.enc into file.
- 
-Create a new private key:
-  -g, --generate                    generate a new private key
-  -p, --password                    encrypt the key with a password
-  -x, --keychain         [key-name] write the key to OS-X Keychain
- 
-Read existing private key from:
-  -k, --key              [key-spec] private key, key file, or keychain
-  -i, --interactive                 Paste or type the key interactively
- 
-Password Cache:
-  -c, --cache-passwords             enable password cache
-  -u, --cache-timeout    [seconds]  expire passwords after
-  -r, --cache-provider   [provider] cache provider, one of memcached, drb
- 
-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:
-  -b, --backup                      create a backup file in the edit mode
-  -v, --verbose                     show additional information
-  -q, --quiet                       do not print to STDOUT
-  -T, --trace                       print a backtrace of any errors
-  -D, --debug                       print debugging information
-  -V, --version                     print library version
-  -N, --no-color                    disable color output
-  -A, --sym-args                    read more CLI arguments from $SYM_ARGS
- 
-Utility:
-  -B, --bash-support     [file]     append bash completion & utils to a file
-                                    such as ~/.bash_profile or ~/.bashrc
- 
-Help & Examples:
-  -E, --examples                    show several examples
-  -h, --help                        show help
-```
+![examples](design/sym-examples.png)
 
-## Examples
+### Symit BASH Wrapper
 
-```bash
-# generate a new private key into an environment variable:
-export mykey=$(sym -g)
-echo $mykey
-75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4=
-————————————————————————————————————————————————————————————————————————————————
-# generate a new key with a cached password & save to the default key file
-sym -gcpqo /Users/kig/.sym.key
-New Password     : ••••••••••
-Confirm Password : ••••••••••
-————————————————————————————————————————————————————————————————————————————————
-# encrypt a plain text string with default key file, and immediately decrypt it
-sym -es "secret string" | sym -d
-secret string
-————————————————————————————————————————————————————————————————————————————————
-# encrypt secrets file using key in the environment, and --negate option:
-export PRIVATE_KEY="75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4="
-sym -ck PRIVATE_KEY -n secrets.yml
+Sym comes with the bash wrapper `symit` which is installed whenever you run `sym -B ~/.bash_profile`. 
+Below is the help screen with some of the examples:
 
-————————————————————————————————————————————————————————————————————————————————
-# encrypt a secrets file using the key in the keychain:
-sym -gqx keychain.key
-sym -ck keychain.key -n secrets.yml
-secret string
-————————————————————————————————————————————————————————————————————————————————
-# encrypt/decrypt sym.yml using the default key file
-sym -gcq > /Users/kig/.sym.key
-sym -n secrets.yml
-sym -df secrets.yml.enc
-————————————————————————————————————————————————————————————————————————————————
-# decrypt an encrypted file and print it to STDOUT:
-sym -ck production.key -df secrets.yml.enc
-————————————————————————————————————————————————————————————————————————————————
-# edit an encrypted file in $EDITOR, use default key file, create file backup
-sym -tbf secrets.enc
+![symit](design/sym-symit-help.png)
 
-Private Key: ••••••••••••••••••••••••••••••••••••••••••••
-Saved encrypted content to sym.enc.
 
-Diff:
-3c3
-# (c) 2015 Konstantin Gredeskoul.  All rights reserved.
----
-# (c) 2016 Konstantin Gredeskoul.  All rights reserved.
-————————————————————————————————————————————————————————————————————————————————
-# generate a new password-encrypted key, save it to your Keychain:
-sym -gpcx staging.key
-————————————————————————————————————————————————————————————————————————————————
-# use the new key to encrypt a file:
-sym -e -c -k staging.key -n etc/passwords.enc
-————————————————————————————————————————————————————————————————————————————————
-# use the new key to inline-edit the encrypted file:
-sym -k mykey -t sym.yml.enc
-————————————————————————————————————————————————————————————————————————————————
-```

data/bin/sym.completion

@@ -1,10 +1,25 @@
 #!/usr/bin/env bash
 #
-# Sym command line completion
+# Sym Command Line completion and other utilities
+# 
+# © 2015-2018, Konstantin Gredeskoul,  https://github.com/kigster/sym
 #
-# © 2015-2016, Konstantin Gredeskoul,  https://github.com/kigster/sym
 # MIT LICENSE
 #
+###########################################################################
+
+( [[ -n $ZSH_EVAL_CONTEXT && $ZSH_EVAL_CONTEXT =~ :file$ ]] || \
+  [[ -n $BASH_VERSION && $0 != "$BASH_SOURCE" ]]) && _s_=1 || _s_=0
+
+bash_version=$(/usr/bin/env bash --version | awk '{FS="version"}{print $4}')
+bash_version=${bash_version:0:1}
+
+if [[ "${bash_version}" -lt 4 ]]; then 
+    echo "Sym BASH helpers are incompatible with BASH version 3 or older."
+    echo "Please upgrade your BASH to version 4+ released in 2009. Srsly."
+    (( $_s_ )) && return 1
+    (( $_s_ )) || exit 1
+fi
 
 declare -a bash_completion_locations=(/usr/local/etc/bash_completion /usr/etc/bash_completion /etc/bash_completion)
 loaded=false
@@ -64,6 +79,53 @@ _sym()
     return 0
 } && complete -F _sym $nospace $filenames sym
 
+sym-encrypt() {
+  local key=$1
+  local from=$2
+  local to=$3
+  local args=
+
+  [[ -n $key ]] && args="${args} -ck ${key}"
+
+  if [[ -n $to ]]; then
+    args="${args} -o ${to}"
+    [[ -n $from ]] && args="${args} -f ${from}"
+  else
+    [[ -n $from ]] && args="${args} -n ${from}"
+  fi
+
+  if [[ -z $args ]]; then
+    echo "usage: sym-encrypt key file [ outfile ]"
+  else
+    sym -e ${args}
+  fi
+}
+
+sym-decrypt() {
+  local key=$1
+  local from=$2
+  local to=$3
+  local args=
+
+  [[ -n $key ]] && args="${args} -ck ${key}"
+
+  if [[ -n $to ]]; then
+    args="${args} -o ${to}"
+    [[ -n $from ]] && args="${args} -f ${from}"
+  else
+    [[ -n $from ]] && args="${args} -n ${from}"
+  fi
+
+  if [[ -z $args ]]; then
+    echo "usage: sym-decrypt key file [ outfile ]"
+  else
+    sym -d ${args}
+  fi
+}
+
+alias syme="sym-encrypt"
+alias symd="sym-decrypt"
+
 # Local variables:
 # mode: shell-script
 # sh-basic-offset: 4