sym 2.7.0 → 2.8.0

data/exe/sym

@@ -8,11 +8,12 @@ require 'sym/app'
 
 #ARGV.any?{ |a| a =~ /^-/ } ?
 begin
-  ::Sym::App::CLI.new(ARGV.dup).execute
+  exit ::Sym::App::CLI.new(ARGV.dup).execute
 rescue Interrupt => e
   STDERR.flush
   STDERR.puts "Interrupt, #{e.message}, exiting."
   STDERR.flush
+  exit 1
 end
 
 

data/lib/sym/app.rb

@@ -52,11 +52,11 @@ module Sym
       reason    = exception.message if exception
 
       if exception && (config && config[:trace] || reason == 'Unknown Error')
-        lines << "#{error_type.red.on.white.bold}:\n#{error_details.white.on.red}\n" + ''.normal
+        lines << "#{error_type.bold.red}:\n#{error_details.red.italic}\n" + ''.normal
         lines << exception.backtrace.join("\n").red.bold if config[:trace]
         lines << "\n"
       else
-        lines << "| SYM Error #{operation} → |".white.on.red + (reason ? " #{reason} ".bold.black.on.white : " #{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
 

data/lib/sym/app/cli.rb

@@ -87,7 +87,7 @@ module Sym
         rescue StandardError => e
           log :error, "#{e.message}" if opts
           error exception: e
-          return
+          exit 127 if stdin == STDIN
         end
 
         self.application = ::Sym::Application.new(opts, stdin, stdout, stderr, kernel)

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

@@ -7,26 +7,40 @@ module Sym
         required_options [:bash_support]
         try_after :generate_key, :open_editor, :encrypt, :decrypt
 
+        def ok
+          '[OK]'.bold.green
+        end
+
         def execute
           file = opts[:bash_support]
 
           out = ''
           Sym::Constants::Bash::Config.each_pair do |key, config|
             script_name = key.to_s
-            FileUtils.cp(config[:source], config[:dest])
+            if (!File.exist?(config[:dest])) ||
+                (File.exist?(config[:dest]) && !FileUtils.identical?(config[:source], config[:dest]))
+              FileUtils.cp(config[:source], config[:dest])
+              out << "#{} installing #{config[:dest].bold.blue }...\n"
+            else
+              out << "#{ok} file #{config[:dest].bold.blue } exists, and is up to date.\n"
+            end
+
             out << if File.exist?(file)
                      if File.read(file).include?(config[:script])
-                       "#{'OK'.bold.green}, #{file.bold.yellow} already has #{script_name.bold.blue} installed\n"
+                       "#{ok} BASH script #{file.bold.yellow} already sources #{script_name.bold.blue}.\n"
                      else
                        append_completion_script(file, config[:script])
-                       "#{'OK'.bold.green}, appended initialization for #{script_name.bold.blue} to #{file.bold.yellow}\n"
+                       "#{ok} BASH script #{script_name.bold.blue} is now sourced from #{file.bold.yellow}\n"
                      end
                    else
                      append_completion_script(file, config[:script])
-                     "#{'OK'.bold.green}, created new file #{file.bold.yellow}, added #{script_name.bold.blue} initialization.\n"
+                     "#{ok}, created new file #{file.bold.yellow}, added #{script_name.bold.blue} initialization.\n"
                    end
           end
-          out + "Please reload your terminal session to activate bash completion and other installed utilities.\n"
+          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"
         end
 
         private

data/lib/sym/version.rb

@@ -1,5 +1,5 @@
 module Sym
-  VERSION     = '2.7.0'
+  VERSION     = '2.8.0'
   DESCRIPTION = <<-eof
 Sym is a ruby library (gem) that offers both the command line interface (CLI) and a set of rich Ruby APIs, which make it rather trivial to add encryption and decryption of sensitive data to your development or deployment flow. As a layer of additional security, you can encrypt the private key itself with a password.  Unlike many other existing encryption tools, Sym focuses on getting out of the way — by offering its streamlined interface, hoping to make encryption of application secrets nearly completely transparent to the developers.  For the data encryption Sym uses a symmetric 256-bit key with the AES-256-CBC cipher, same cipher as used by the US Government. For password-protecting the key Sym uses AES-128-CBC cipher. The resulting data is zlib-compressed and base64-encoded. The keys are also base64 encoded for easy copying/pasting/etc.
   

data/sym.gemspec

@@ -30,17 +30,18 @@ http://kig.re/2017/03/10/dead-simple-encryption-with-sym.html
 
 BASH COMPLETION
 ===============
-To enable bash command line completion, please run the following 
-command, which appends sym's shell completion wrapper to the file 
-specified in arguments to -B/--bash-support flag.
+To enable bash command line completion and install highly useful
+command line BASH wrapper 'symit', please run the following 
+command after installing the gem. It appends sym's shell completion 
+wrapper to the file specified in arguments to -B flag.
 
   sym -B ~/.bash_profile
   source ~/.bash_profile
+  # then:
+  sym --help
+  symit --help
  
-Thank you for using Sym and happy crypting :)
-
-For bonus points, run 'symit -h' after installing and loading bash
-completion.
+Thank you for using Sym and happy encrypting :)
 
 @kigster on Github, 
     @kig on Twitter.
@@ -57,7 +58,7 @@ EOF
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'irbtools'
   spec.add_development_dependency 'aruba'
-  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sym
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -154,16 +154,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +254,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".document"
 - ".gitignore"
@@ -271,10 +272,14 @@ files:
 - bin/setup
 - bin/sym.completion
 - bin/sym.symit
+- design/ascii-cinema.png
 - design/sym-class-dependency-future-refactor.png
 - design/sym-class-dependency.graffle
 - design/sym-class-dependency.pdf
 - design/sym-class-dependency.png
+- design/sym-examples.png
+- design/sym-help.png
+- design/sym-symit-help.png
 - exe/keychain
 - exe/sym
 - lib/sym.rb
@@ -328,18 +333,17 @@ files:
 - lib/sym/extensions/with_timeout.rb
 - lib/sym/magic_file.rb
 - lib/sym/version.rb
-- sym-3.0-cli.md
 - sym.gemspec
 homepage: https://github.com/kigster/sym
 licenses: []
 metadata: {}
 post_install_message: "\nThank you for installing Sym! \n\nBLOG POST\n=========\nhttp://kig.re/2017/03/10/dead-simple-encryption-with-sym.html\n\nBASH
-  COMPLETION\n===============\nTo enable bash command line completion, please run
-  the following \ncommand, which appends sym's shell completion wrapper to the file
-  \nspecified in arguments to -B/--bash-support flag.\n\n  sym -B ~/.bash_profile\n
-  \ source ~/.bash_profile\n \nThank you for using Sym and happy crypting :)\n\nFor
-  bonus points, run 'symit -h' after installing and loading bash\ncompletion.\n\n@kigster
-  on Github, \n    @kig on Twitter.\n\n"
+  COMPLETION\n===============\nTo enable bash command line completion and install
+  highly useful\ncommand line BASH wrapper 'symit', please run the following \ncommand
+  after installing the gem. It appends sym's shell completion \nwrapper to the file
+  specified in arguments to -B flag.\n\n  sym -B ~/.bash_profile\n  source ~/.bash_profile\n
+  \ # then:\n  sym --help\n  symit --help\n \nThank you for using Sym and happy encrypting
+  :)\n\n@kigster on Github, \n    @kig on Twitter.\n\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -355,7 +359,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Dead-simple and easy to use encryption library on top of OpenSSL, offering

data/sym-3.0-cli.md

@@ -1,168 +0,0 @@
-
-# Sym 
-
-## Table of Contents
-
-[TOC]
-
-__Sym__ is a versatile encryption gem, based on the symmetric encryption cipher provided by the OpenSSL. It provides easy to remember commands to manage encryption key: you can generate a key, import an existing key, password protect an open key, store the key in OS-X KeyChain, and use it for encryption/decryption later. The key is used to encrypt, decrypt and edit any sensitive information, such application secrets.
-
-## Usage
-
-    sym [ global options ] [ sub command ] [ command options ] 
-    
-## Global Options
-    
-```bash
--t, --password-timeout   [timeout]  when passwords expire (in seconds)
--p, --no-password-cache             disables caching of key passwords   
--v, --verbose                       show additional information
--T, --trace                         print a backtrace of any errors
--q, --quiet                         silence all output
--V, --version                       print library version
--N, --no-color                      disable color output
-```
-
-## Help & Examples:
-
-```bash
--h, --help                          show help
--l, --long                          show help and detailed examples
-```
-
-## Commands
-
-### Genereate a new key
-```bash
-sym key [ [ --out      | -o ] uri ] # or STDOUT by default
-# eg.
-> sym key -o stdout
-> sym key -o file://~/.key
-```
-
-### Copy or Re-Import a Key
-
-Typically applied to an existing key, optionally password-protecting it:
-
-```bash
-sym key   [ --in       | -k ] uri 
-        [ [ --out      | -o ] uri ] # or STDOUT by default
-          [ --password | -p ] 
-# eg.
-> sym key -k file://~/.key -o keychain://mykey -p 
-
-> sym key -k stdin -o keychain://mykey -p           
-Please enter the encryption key: 75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4=
-Please enter new password:
-Please confirm the new password: 
-```
-
-### Delete an existing key (assuming URI supports deletion):
-
-```bash
-sym key   [ --delete   | -d ] uri
-
-# eg.
-> sym key -d keychain://mykey
-> sym key -d redis://127.0.0.1:6379/1/symkey
-```
-
-### Encrypt or Decrypt a Resource
-
-```bash
-sym decrypt   [ --key      | -k ] uri 
-              [ --data     | -d ] uri
-            [ [ --out      | -o ] uri ]
-
-sym encrypt   [ --key      | -k ] uri 
-              [ --data     | -d ] uri
-            [ [ --out      | -o ] uri ]
-```
-
-### Open Encrypted Resource in an Editor
-
-```bash
-sym edit      [ --key      | -k ] uri 
-              [ --data     | -d ] uri
-            [ [ --backup   | -b ] data-backup-uri
-```
-### Re-encrypt data, and rotate the key
-
-For key and data URIs that support update operation (eg, `file://`, `keychain://`)
-this operation decrypts the resource with the current key, generates
-a new key, re-encrypts the data, and updates both the resource and the 
-key URIs.
-
-```bash
-sym cycle     [ --key      | -k ] uri 
-              [ --data     | -d ] uri
-            [ [ --out      | -o ] uri ]
-# eg:
-sym cycle -k file://~/.key -d file://./secrets.yml
-```
-
-### Installation, Help, and Other Commands
-
-```bash            
-sym install bash-completion
-
-sym --help | -h
-
-sym command --help | -h
-   
-sym examples
-```
-
-### Arguments via Environment
-
-Common arguments can be passed in an environment variable called `SYM_ARGS`:
-
-    export SYM_ARGS='-k file://~/.sym.key'
-    
-The name of the variable can be read from the `-B <name>` argument, eg:
-
-    SYM_ARGUMENTS='-k 75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4'
-    sym -B SYM_ARGUMENS -d file://file.enc
-
-### Reading and Writing Data and Keys
-
-The new CLI for Sym uses a consistent naming for reading in the data and the key, and for writing out the key and/or data. The scheme is based on URI.
-
-Each URI type is supported by a corresponding plugin, and new ones can be easily defined.  
-
-Some examples:
-   
-```bash   
- string://234234234          # read from the literal data
- env://MY_VARIABLE           # read from environment variable
- 
- file://home/kig/.mykey      # read/write from/to file
- stdio://                    # read/write using stdin/out
-
- # Real URLs could potentially support writes with PUT or POST
- https://mysite.com/remote/secrets.json.enc
- 
- # Files support read/write
- file:///usr/local/etc/secrets.json
-```
-
-Below is the list of supported types planned for 3.0:
-
-#### Supported Types
-
-```bash
- URI:                                   Read? Write? Delete?
- 
- string://value                          yes      
- env://variable                          yes    
- stdio://                                yes
- shell://command                         yes   yes   yes
- file://filename                         yes   yes   yes
- keychain://name                         yes   yes   yes
- redis://127.0.0.1:6397/1/mykey          yes   yes   yes
- memcached://127.0.0.1:11211/mykey       yes   yes   yes
- scp://user@host/path/file               yes   yes   yes
- http[s]://user@host/path/file           yes   yes   yes
- ftp[s]://user@host/path/file            yes   yes   yes
-
-```