sym 2.10.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56818db540e6c43dd9825242a599ea43813fbc032bb2b2dc548750f4a523c154
-  data.tar.gz: b8bdb57e5cd45d2b6d3bd7c5af2112a34a920451c7b6a2b0fdeae22618827241
+  metadata.gz: 96b146e9f4e68299d11d3aa550f32cf34c85de0ce8b91829e2d7db0e39d9da8a
+  data.tar.gz: c55848a53c59090e471b207d3e170fa803aa61969f4689c4cdffe507ebe8babf
 SHA512:
-  metadata.gz: 9538a2c263afcb8b85ab4c9e6045333245b1ec91a9a35d3eeb83109f802be6663d3c66dfc5218f17df634925f74fe1407be4ef1a177d877e7fe1b2e5a6840883
-  data.tar.gz: aab737dcbc3da264f6d11b7a5b56a35cf5bba196663eeefcb808e81f93d4226ad3a53b025887f6e961d601b316236e806bf9ca5c26d7d1721bbf4ed31775cef6
+  metadata.gz: 1a577c64acd5fb45c06526757602810b210c9fc4af413961be85618abdb88754e3689b4e7d78ed1dd3714abb22484bae86d7111b6a6c887568ab57c818cdc94e
+  data.tar.gz: dd26342b6c02825c85f847268f4a69f0da85dd42bcae7e6064515bf88c32f17eb08e19e9b65758825dbb28ff5b7fd0a878dcc9b2e0fb83be915120b0ce0284ae

data/CHANGELOG.md

@@ -1,16 +1,30 @@
 # Changelog
 
-## [Unreleased](https://github.com/kigster/sym/tree/HEAD)
+## [v2.10.1](https://github.com/kigster/sym/tree/v2.10.1) (2020-08-15)
 
-[Full Changelog](https://github.com/kigster/sym/compare/v2.8.5...HEAD)
+[Full Changelog](https://github.com/kigster/sym/compare/v2.10.0...v2.10.1)
 
 **Closed issues:**
 
+- This gem is failing on environment without HOME \(like AWS Lambda\) [\#25](https://github.com/kigster/sym/issues/25)
+
+**Merged pull requests:**
+
+- Refactor and changes to support custom user\_home. [\#30](https://github.com/kigster/sym/pull/30) ([kigster](https://github.com/kigster))
+
+## [v2.10.0](https://github.com/kigster/sym/tree/v2.10.0) (2020-08-14)
+
+[Full Changelog](https://github.com/kigster/sym/compare/v2.8.5...v2.10.0)
+
+**Closed issues:**
+
+- Switch to Codecov for test coverage [\#29](https://github.com/kigster/sym/issues/29)
 - Ruby 2.7 warnings [\#24](https://github.com/kigster/sym/issues/24)
 - Error and process hang on Windows [\#17](https://github.com/kigster/sym/issues/17)
 
 **Merged pull requests:**
 
+- Switch to Codecov for test coverage; version bump 2.10.0 [\#28](https://github.com/kigster/sym/pull/28) ([kigster](https://github.com/kigster))
 - Fix remaining 2.7 warnings; memcached & keychain [\#27](https://github.com/kigster/sym/pull/27) ([kigster](https://github.com/kigster))
 - Adding Rubocop, and fixing minor issues. [\#21](https://github.com/kigster/sym/pull/21) ([kigster](https://github.com/kigster))
 - First pass on Version 2.9.0 — dropping the coin gem [\#20](https://github.com/kigster/sym/pull/20) ([kigster](https://github.com/kigster))
@@ -27,6 +41,7 @@
 
 **Merged pull requests:**
 
+- Fix error when ENV\[EDITOR\] is nil [\#18](https://github.com/kigster/sym/pull/18) ([JustinNazari](https://github.com/JustinNazari))
 - README: Use SVG badge \[ci skip\] [\#16](https://github.com/kigster/sym/pull/16) ([olleolleolle](https://github.com/olleolleolle))
 
 ## [v2.8.4](https://github.com/kigster/sym/tree/v2.8.4) (2018-04-13)
@@ -184,7 +199,6 @@
 
 **Merged pull requests:**
 
-- Fix error when ENV\[EDITOR\] is nil [\#18](https://github.com/kigster/sym/pull/18) ([JustinNazari](https://github.com/JustinNazari))
 - added require to fix loading issue on ubuntu [\#4](https://github.com/kigster/sym/pull/4) ([bosswissam](https://github.com/bosswissam))
 
 ## [v1.6.4](https://github.com/kigster/sym/tree/v1.6.4) (2016-08-23)

data/LICENSE

@@ -1,6 +1,6 @@
-Copyright © 2016 Konstantin Gredeskoul, all rights reserved.
+Copyright © 2016-2020 Konstantin Gredeskoul, All Rights Reserved.
 
-MIT License
+Distributed under MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.adoc

@@ -16,17 +16,16 @@ image:https://ruby-gem-downloads-badge.herokuapp.com/sym?extension=svg[Sym Downl
 image:https://codecov.io/gh/kigster/sym/branch/master/graphs/sunburst.svg[Coverage Map,link=https://codecov.io/gh/kigster/sym]
 ====
 
-Please checkout the following post — _http://kig.re/2017/03/10/dead-simple-encryption-with-sym.html[Dead Simple Encryption with Sym]_ — that announced the initial release of this library, and provides further in-depth discussion. Your donation of absolutely any amount is very much appreciated but never required.
+Please checkout the following post — _http://kig.re/2017/03/10/dead-simple-encryption-with-sym.html[Dead Simple Encryption with Sym]_ — that announced the initial release of this library, and provides further in-depth discussion. Your donation of absolutely any amount is much appreciated but never required.
 
-image::https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif[Donate,link=https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FSFYYNEQ8RKWU]
+image:https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif[Donate,link=https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FSFYYNEQ8RKWU]
 
 == Introduction
 
-====
-*sym* is an open source command line utility and Ruby API which makes it very _easy to add reliable encryption and decryption_ of sensitive data to an application or a project written in any language.
-====
+NOTE: *SYM* is an open source command line utility and a Ruby library, which makes it _trivial to encrypt your application secrets with mathematically proven models and ciphers offered in a much larger project — Open SSL.
 
-* Unlike many existing encryption tools, *sym* focuses on narrowing the gap between convenience and security, by offering enhanced usability and a streamlined ruby API and a CLI. The primary goal of the library is to make encryption very easy and transparent. +
+
+Unlike many existing encryption tools, *sym* focuses on narrowing the gap between convenience and security, by offering enhanced usability and a streamlined ruby API and a CLI. The primary goal of the library is to make encryption very easy and transparent. +
 
 * *sym* uses the _https://en.wikipedia.org/wiki/Symmetric-key_algorithm[Symmetric Encryption]_ 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. +
 
@@ -85,7 +84,6 @@ Most common use-cases include:
 This gem includes two primary components:
 
 . *<<cli,Rich command line interface CLI>>* with many features to streamline encryption/decryption, and to be integrated into the deployment flow. +
- +
 . Ruby APIs:
  ** *<<rubyapi,Key Generation, Encryption & Decryption API>>*
   *** is activated by including `Sym` module in a class, it adds easy to use `encr`/`decr` methods.
@@ -192,7 +190,8 @@ My secret data
 
 # Lets now save common flags in the SYM_ARGS bash variable:
 ❯ export SYM_ARGS="-ck my-new-key"
-❯ sym -df secret.enc
+# To have sym parse the SYM_ARGS variable, we must activate this feature with -A
+❯ sym -Adf secret.enc
 My secret data
 ----
 
@@ -235,6 +234,11 @@ Example: here we edit an encrypted file in `vim`, while using interactive mode t
 
 Note the `diff` shown after save.
 
+==== CLI Help Reference
+
+image::design/sym-help.png[Sym Help,width=651]
+
+
 +++<a name="rubyapi">++++++</a>+++
 
 == Ruby API
@@ -621,7 +625,23 @@ To release a new version, update the version number in `version.rb`, and then ru
 [discrete]
 ==== Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/sym
+Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/sym.
+
+===== UML
+
+Here are a couple of UML diagrams depicting the current, and possibly future state of the codebase.
+
+''''
+
+===== Current Design 
+
+image::design/sym-class-dependency-vertical.png[UML Vertical]
+
+''''
+
+===== Future  Design 
+
+image::design/sym-class-dependency-future-refactor.png[UML Refactor]
 
 === License
 

data/Rakefile

@@ -25,9 +25,9 @@ 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)

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/lib/sym.rb

@@ -14,7 +14,7 @@ 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
 

data/lib/sym/app.rb

@@ -18,7 +18,6 @@ module Sym
     class << self
       attr_accessor :exit_code
       attr_accessor :stdin, :stdout, :stderr
-
     end
 
     self.exit_code = 0

data/lib/sym/app/cli.rb

@@ -56,10 +56,10 @@ module Sym
       # brings in #parse(Array[String] args)
       include CLISlop
 
-      attr_accessor :opts, :application, :outputs, :stdin, :stdout, :stderr, :kernel
-
+      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
@@ -71,37 +71,46 @@ module Sym
 
         begin
           # Re-map any legacy options to the new options
-          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]
-            append_sym_args(argv)
-            self.opts = parse(argv)
+            if non_empty_array?(sym_args)
+              args << sym_args
+              args.flatten!
+              args.compact!
+              args.delete('-A')
+              args.delete('--sym-args')
+              self.opts = parse(args)
+            end
           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!
@@ -131,17 +140,22 @@ 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
 
-      private
-
       def log(*args)
         Sym::App.log(*args, **opts.to_hash)
       end
 
+
+      private
+
+      def non_empty_array?(object)
+        object.is_a?(Array) && !object.empty?
+      end
+
       def error(hash)
         hash.merge!(config: opts.to_hash) if opts
         hash.merge!(command: @command) if @command

data/lib/sym/app/cli_slop.rb

@@ -55,6 +55,7 @@ module Sym
           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.osx?
             o.string '-x', '--keychain',            '[key-name] '.blue + 'write the key to OS-X Keychain'
           end
@@ -67,7 +68,7 @@ module Sym
           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 ' '
@@ -89,8 +90,14 @@ module Sym
 
           o.separator ' '
           o.separator 'Utility:'.yellow
+          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

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

@@ -15,7 +15,7 @@ module Sym
           file = opts[:bash_support]
 
           out = ''
-          Sym::Constants::Bash::CONFIG.each_pair do |key, config|
+          Sym::Constants.config.each_pair do |key, config|
             script_name = key.to_s
 
             # This removes the old version of this file.

data/lib/sym/constants.rb

@@ -1,43 +1,59 @@
 require 'logger'
 module Sym
+  #
+  # This module is responsible for installing Sym BASH extensions.
+  #
   module Constants
-    module Bash
 
-      BASH_FILES = Dir.glob("#{File.expand_path('../../../bin', __FILE__)}/sym.*.bash").freeze
+    BASH_FILES = Dir.glob("#{File.expand_path('../../bin', __dir__)}/sym.*.bash").freeze
 
-      CONFIG = {}
+    class << self
+      attr_reader :user_home
 
-      class << self
-        def register_bash_files!
-          BASH_FILES.each do |bash_file|
-            register_bash_extension bash_file, CONFIG
-          end
-        end
+      def user_home=(value)
+        @user_home = value
+        register_bash_files!
+      end
 
-        private
+      def config
+        @config ||= {}
+      end
 
-        def register_bash_extension(bash_file, hash)
-          source_file = File.basename(bash_file)
-          home_file   = "#{Dir.home}/.#{source_file}"
+      def sym_key_file
+        "#{user_home}/.sym.key"
+      end
 
-          hash[source_file.gsub(/sym\./, '').gsub(/\.bash/, '').to_sym] = {
-            dest:   home_file,
-              source: bash_file,
-              script: "[[ -f #{home_file} ]] && source #{home_file}"
-          }
+      def register_bash_files!
+        BASH_FILES.each do |bash_file|
+          register_bash_extension bash_file
         end
       end
 
-      self.register_bash_files!
+      private
+
+      def register_bash_extension(bash_file)
+        return unless user_home && Dir.exist?(user_home)
+
+        source_file = File.basename(bash_file)
+        home_file   = "#{user_home}/.#{source_file}"
+        config_key  = source_file.gsub(/sym\./, '').gsub(/\.bash/, '').to_sym
+
+        config[config_key] = {
+          dest:   home_file,
+          source: bash_file,
+          script: "[[ -f #{home_file} ]] && source #{home_file}"
+        }
+      end
     end
 
+    self.user_home ||= ::Dir.home rescue nil
+    self.user_home ||= '/tmp'
+
+    self.register_bash_files!
+
     module Log
       NIL = Logger.new(nil).freeze # empty logger
       LOG = Logger.new(STDERR).freeze
     end
-
-    ENV_ARGS_VARIABLE_NAME = 'SYM_ARGS'.freeze
-    SYM_KEY_FILE           = "#{Dir.home}/.sym.key".freeze
-
   end
 end

data/lib/sym/errors.rb

@@ -10,6 +10,8 @@ module Sym
 
     class PasswordError < Sym::Errors::Error; end
 
+    class InvalidSymHomeDirectory < Sym::Errors::Error; end
+
     class NoPasswordProvided < Sym::Errors::PasswordError; end
 
     class PasswordsDontMatch < Sym::Errors::PasswordError; end

data/lib/sym/version.rb

@@ -1,33 +1,57 @@
 module Sym
-  VERSION     = '2.10.0'.freeze
+  VERSION     = '3.0.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 workflow.
-    
-    For additional security the private key itself can be encrypted with a user-generated password. For decryption using the key the password can be input into STDIN, or be defined by an ENV variable, or an OS-X Keychain Entry. 
-    
-    Unlike many other existing encryption tools, Sym focuses on getting out of your way by offering a streamlined interface with password caching (if MemCached is installed and running locally) in hopes to make encryption of application secrets nearly completely transparent to the developers. 
-    
-    Sym uses symmetric 256-bit key encryption 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.
-    
-    Sym accomplishes encryption transparency by combining several convenient features:
+
+     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 
+     workflow.
      
-      1. Sym can read the private key from multiple source types, such as pathname, an environment variable name, a keychain entry, or CLI argument. You simply pass either of these to the -k flag — one flag that works for all source types.
+     For additional security the private key itself can be encrypted with a 
+     user-generated password. For decryption using the key the password can be 
+     input into STDIN, or be defined by an ENV variable, or an OS-X Keychain Entry. 
      
-      2. By utilizing OS-X Keychain on a Mac, Sym offers truly secure way of storing the key on a local machine, much more secure then storing it on a file system,
+     Unlike many other existing encryption tools, Sym focuses on getting out of 
+     your way by offering a streamlined interface with password caching (if 
+     MemCached is installed and running locally) in hopes to make encryption of 
+     application secrets nearly completely transparent to the developers. 
      
-      3. By using a local password cache (activated with -c) via an in-memory provider such as memcached, sym invocations take advantage of password cache, and only ask for a password once per a configurable time period, 
-    
-      4. By using SYM_ARGS environment variable, where common flags can be saved. This is activated with sym -A,
+     Sym uses symmetric 256-bit key encryption with the AES-256-CBC cipher, 
+     same cipher as used by the US Government. 
      
-      5. By reading the key from the default key source file ~/.sym.key which requires no flags at all,
+     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.
      
-      6. By utilizing the --negate option to quickly encrypt a regular file, or decrypt an encrypted file with extension .enc
+     Sym accomplishes encryption transparency by combining several convenient features:
+      
+       1. Sym can read the private key from multiple source types, such as pathname, 
+          an environment variable name, a keychain entry, or CLI argument. You simply 
+          pass either of these to the -k flag — one flag that works for all source types.
+      
+       2. By utilizing OS-X Keychain on a Mac, Sym offers truly secure way of 
+          storing the key on a local machine, much more secure then storing it on a file system,
+      
+       3. By using a local password cache (activated with -c) via an in-memory provider 
+          such as memcached, sym invocations take advantage of password cache, and 
+          only ask for a password once per a configurable time period, 
      
-      7. By implementing the -t (edit) mode, that opens an encrypted file in your $EDITOR, and replaces the encrypted version upon save & exit, optionally creating a backup.
+       4. By using SYM_ARGS environment variable, where common flags can be saved. This 
+          is activated with sym -A,
+      
+       5. By reading the key from the default key source file ~/.sym.key which 
+          requires no flags at all,
+      
+       6. By utilizing the --negate option to quickly encrypt a regular file, or decrypt 
+          an encrypted file with extension .enc
+      
+       7. By implementing the -t (edit) mode, that opens an encrypted file in your $EDITOR, 
+          and replaces the encrypted version upon save & exit, optionally creating a backup.
+      
+       8. By offering the Sym::MagicFile ruby API to easily read encrypted files into memory.
+
+    Please refer the module documentation available here:
+    https://www.rubydoc.info/gems/sym
      
-      8. By offering the Sym::MagicFile ruby API to easily read encrypted files into memory.
-    
   eof
 end

data/sym.gemspec

@@ -52,6 +52,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'highline'
   spec.add_dependency 'dalli'
 
+  spec.add_development_dependency 'asciidoctor'
   spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'irbtools'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sym
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -234,35 +248,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "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 workflow.\n\nFor
-  additional security the private key itself can be encrypted with a user-generated
-  password. For decryption using the key the password can be input into STDIN, or
-  be defined by an ENV variable, or an OS-X Keychain Entry. \n\nUnlike many other
-  existing encryption tools, Sym focuses on getting out of your way by offering a
-  streamlined interface with password caching (if MemCached is installed and running
-  locally) in hopes to make encryption of application secrets nearly completely transparent
-  to the developers. \n\nSym uses symmetric 256-bit key encryption with the AES-256-CBC
-  cipher, same cipher as used by the US Government. \n\nFor 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.\n\nSym accomplishes
-  encryption transparency by combining several convenient features:\n \n  1. Sym can
-  read the private key from multiple source types, such as pathname, an environment
-  variable name, a keychain entry, or CLI argument. You simply pass either of these
-  to the -k flag — one flag that works for all source types.\n \n  2. By utilizing
-  OS-X Keychain on a Mac, Sym offers truly secure way of storing the key on a local
-  machine, much more secure then storing it on a file system,\n \n  3. By using a
-  local password cache (activated with -c) via an in-memory provider such as memcached,
-  sym invocations take advantage of password cache, and only ask for a password once
-  per a configurable time period, \n\n  4. By using SYM_ARGS environment variable,
-  where common flags can be saved. This is activated with sym -A,\n \n  5. By reading
-  the key from the default key source file ~/.sym.key which requires no flags at all,\n
-  \n  6. By utilizing the --negate option to quickly encrypt a regular file, or decrypt
-  an encrypted file with extension .enc\n \n  7. By implementing the -t (edit) mode,
-  that opens an encrypted file in your $EDITOR, and replaces the encrypted version
-  upon save & exit, optionally creating a backup.\n \n  8. By offering the Sym::MagicFile
-  ruby API to easily read encrypted files into memory.\n\n"
+description: "\n Sym is a ruby library (gem) that offers both the command line interface
+  \n (CLI) and a set of rich Ruby APIs, which make it rather trivial to add \n encryption
+  and decryption of sensitive data to your development or deployment \n workflow.\n
+  \n For additional security the private key itself can be encrypted with a \n user-generated
+  password. For decryption using the key the password can be \n input into STDIN,
+  or be defined by an ENV variable, or an OS-X Keychain Entry. \n \n Unlike many other
+  existing encryption tools, Sym focuses on getting out of \n your way by offering
+  a streamlined interface with password caching (if \n MemCached is installed and
+  running locally) in hopes to make encryption of \n application secrets nearly completely
+  transparent to the developers. \n \n Sym uses symmetric 256-bit key encryption with
+  the AES-256-CBC cipher, \n same cipher as used by the US Government. \n \n For password-protecting
+  the key Sym uses AES-128-CBC cipher. The resulting \n data is zlib-compressed and
+  base64-encoded. The keys are also base64 encoded \n for easy copying/pasting/etc.\n
+  \n Sym accomplishes encryption transparency by combining several convenient features:\n
+  \ \n   1. Sym can read the private key from multiple source types, such as pathname,
+  \n      an environment variable name, a keychain entry, or CLI argument. You simply
+  \n      pass either of these to the -k flag — one flag that works for all source
+  types.\n  \n   2. By utilizing OS-X Keychain on a Mac, Sym offers truly secure way
+  of \n      storing the key on a local machine, much more secure then storing it
+  on a file system,\n  \n   3. By using a local password cache (activated with -c)
+  via an in-memory provider \n      such as memcached, sym invocations take advantage
+  of password cache, and \n      only ask for a password once per a configurable time
+  period, \n \n   4. By using SYM_ARGS environment variable, where common flags can
+  be saved. This \n      is activated with sym -A,\n  \n   5. By reading the key from
+  the default key source file ~/.sym.key which \n      requires no flags at all,\n
+  \ \n   6. By utilizing the --negate option to quickly encrypt a regular file, or
+  decrypt \n      an encrypted file with extension .enc\n  \n   7. By implementing
+  the -t (edit) mode, that opens an encrypted file in your $EDITOR, \n      and replaces
+  the encrypted version upon save & exit, optionally creating a backup.\n  \n   8.
+  By offering the Sym::MagicFile ruby API to easily read encrypted files into memory.\n\nPlease
+  refer the module documentation available here:\nhttps://www.rubydoc.info/gems/sym\n
+  \n"
 email:
 - kigster@gmail.com
 executables:
@@ -285,6 +302,7 @@ files:
 - README.adoc
 - Rakefile
 - SYM-CLI.md
+- bin/changelog
 - bin/console
 - bin/setup
 - bin/sym.completion.bash
@@ -292,6 +310,7 @@ files:
 - codecov.yml
 - design/ascii-cinema.png
 - design/sym-class-dependency-future-refactor.png
+- design/sym-class-dependency-vertical.png
 - design/sym-class-dependency.graffle
 - design/sym-class-dependency.pdf
 - design/sym-class-dependency.png