encrypt_env 1.3.1 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240ef0cad26ca9e4a003b59ed55a25ec1e40b749dfa489dde2dfbaf0079d6fc0
-  data.tar.gz: 3f2d327a4009e6ec03d99dd96a9149de9cf578d490b43c0897f2746fb7e7584f
+  metadata.gz: '0108116f53998a69c29a421d3f0726cbaeb9affa7a194b891a4bcec681d0823e'
+  data.tar.gz: 0e13e28fa7e990f0ffc3950fbe429e1c5b49b0f986c8ee26e6a45f7da3007b66
 SHA512:
-  metadata.gz: d47f5c3671c2e6a5ebba7626e20ac5de43c3f86ab08101253ab1f41f6094b5610a3e7dce373f86571eec8a7792fa62905ce285590b2cba310fae9cb89d6f8db7
-  data.tar.gz: f2dd54d20b33f8116fbd9c4e2f58ed00d92f30a85bb45db3525dacfd2b226dd01ff91635ddac3e32a8ddc7a2eb33c424301c99240beacc609afe17cf2a0f4b97
+  metadata.gz: 5c0ad88fdf14079b84b9a0364a8ef1e1381e1862083b608adc15706f2bcbdcc305de6cd943d5cd49b6b4d2b947458ea222da9105cd686a86d447e01fff29f56b
+  data.tar.gz: 4ae071fc5a3ce618cec111bb75b665f084def3e75debee1da01f445c555e46d56f91c88af521b9c5ff48421e94397b22645e6ec545483e76a0f5c72b0646dd6e

data/bin/encrypt_env

@@ -3,61 +3,85 @@
 # frozen_string_literal: true
 
 require 'encrypt_env'
+require 'optparse'
+require_relative '../lib/encrypt_env/version'
+
+options = {}
+parsers = OptionParser.new do |parser|
+  parser.on('-e', '--environment ENVIRONMENT', 'environment')
+  parser.on('-s', '--set VALUE', 'value')
+  parser.on('-t', '--type TYPE', 'type of variable')
+  parser.on('-a', '--all', 'show all') do
+    EncryptEnv.show('all')
+    exit
+  end
+  parser.on('-v', '--version', 'version') do
+    puts Version::VERSION
+    exit
+  end
+  parser.on('-h', '--help', 'help') do
+    puts <<~HELP
+      Usage:
+        encrypt_env setup                                  # To setup for the firt time
+
+        encrypt_env show                                   # To show environment variables of current environment
+        encrypt_env show -a                                # To show all environment variables
+        encrypt_env show -e [environment]                  # To show specific environment variables
+        encrypt_env show [variable_name] -e [environment]  # To show value of specific variable
+
+        encrypt_env edit                                   # To edit environment variables of current environment
+        encrypt_env edit -e [environment]                  # To edit specific environment variables
+        encrypt_env edit [variable_name] -e [environment]  # To edit value of specific variable
+
+        encrypt_env create variable_name                   # To create environment variable in current environment
+        encrypt_env create variable_name -e [environment]  # To create environment variable in specific environment
+        # To create environment variable in specific environment with value and type
+        encrypt_env create variable_name -s [value] -e [environment]
+        encrypt_env create variable_name -s [value] -e [environment] -t [type]
+
+        encrypt_env delete variable_name                   # To delete environment variable in current environment
+        encrypt_env delete variable_name -e [environment]  # To delete environment variable in specific environment
+
+      Or: Visit "https://github.com/nnhutan/encrypt_env" for more information
+    HELP
+    exit
+  end
+end
+
+parsers.parse!(into: options)
 
 argv = ARGV
 action = argv.shift
+variable_name = argv.shift
 
-if action == 'setup'
+case action
+when 'setup'
   EncryptEnv.setup
-  exit 0
-elsif action == 'show'
-  if argv[0]
-    EncryptEnv.show(argv[0])
-  else
-    EncryptEnv.show
+
+when 'show', 'edit'
+  EncryptEnv.send(action, options[:environment], variable_name)
+
+when 'create'
+  unless variable_name
+    puts "Please provide 'variable's name'!"
+    exit
   end
-  exit 0
-elsif action == 'all'
-  EncryptEnv.show('all')
-  exit 0
-elsif action == 'edit'
-  if argv[0]
-    EncryptEnv.edit(argv[0])
+
+  if options[:set]
+    EncryptEnv.create_with_value(variable_name, options[:set], options[:environment], options[:type])
   else
-    EncryptEnv.edit
+    EncryptEnv.send(action, variable_name, options[:environment])
+  end
+
+when 'delete'
+  unless variable_name
+    puts "Please provide 'variable's name'!"
+    exit
   end
-  exit 0
-elsif action == 'get'
-  key = argv[0]
-  env = argv[1]
-  EncryptEnv.valueof(key, env)
-  exit 0
-elsif action == 'new'
-  key = argv[0]
-  env = argv[1]
-  EncryptEnv.update_variable(key, env, true)
-  exit 0
-elsif action == 'update'
-  key = argv[0]
-  env = argv[1]
-  EncryptEnv.update_variable(key, env, false)
-  exit 0
-elsif action == 'delete'
-  key = argv[0]
-  env = argv[1]
-  EncryptEnv.delete_variable(key, env)
-  exit 0
-elsif ['help', '--help', '-h'].include?(action)
-  puts <<~HELP
-    Usage:
-      encrypt_env setup
-      encrypt_env secrets
-      encrypt_env secrets_all
-      encrypt_env edit
-  HELP
-
-  exit 0
+
+  EncryptEnv.send(action, variable_name, options[:environment])
 else
   puts "Unknown action: #{action}"
-  exit 1
+  puts "Use 'encrypt_env -h' for more help"
+  exit
 end

data/lib/encrypt_env/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Version
+  VERSION = '1.3.4'
+end

data/lib/encrypt_env.rb

@@ -11,6 +11,8 @@ require 'json'
 # rubocop:disable Metrics/ClassLength
 # rubocop:disable Metrics/MethodLength
 class EncryptEnv
+  @root_path = Dir.pwd
+
   private_class_method def self.define_option
     puts "Options to 'encrypt secrets.yml' file"
     puts '1. Generate only one master.key and one encrypted file for all environment'
@@ -27,9 +29,9 @@ class EncryptEnv
   end
 
   private_class_method def self.load_curr_opt
-    if File.file?("#{Dir.pwd}/config/secrets.yml.enc")
+    if File.file?("#{@root_path}/config/secrets.yml.enc")
       @opt = 1
-    elsif Dir["#{Dir.pwd}/config/secrets_*.yml.enc"].length.positive?
+    elsif Dir["#{@root_path}/config/secrets_*.yml.enc"].length.positive?
       @opt = 2
     else
       raise 'You must setup first to encrypt file!'
@@ -46,7 +48,7 @@ class EncryptEnv
 
   private_class_method def self.check_key_existence(env = nil)
     file_name = env.nil? ? 'master.key' : "master_#{env}.key"
-    return if File.file?("#{Dir.pwd}/config/#{file_name}")
+    return if File.file?("#{@root_path}/config/#{file_name}")
     return if ENV.key?('MASTER_KEY')
 
     message = env ? "Missing key of #{env} environment!" : 'Missing master key!'
@@ -60,7 +62,7 @@ class EncryptEnv
       raise e.message
     end
 
-    file_path = env ? "#{Dir.pwd}/config/master_#{env}.key" : "#{Dir.pwd}/config/master.key"
+    file_path = env ? "#{@root_path}/config/master_#{env}.key" : "#{@root_path}/config/master.key"
     key = File.file?(file_path) ? File.read(file_path).strip : ENV['MASTER_KEY']
     @master_key = [key].pack('H*')
   end
@@ -68,19 +70,19 @@ class EncryptEnv
   private_class_method def self.generate_keys
     if @opt == 1
       key = OpenSSL::Random.random_bytes(16)
-      File.open("#{Dir.pwd}/config/master.key", 'w') { |file| file.write(key.unpack('H*')[0]) }
+      File.open("#{@root_path}/config/master.key", 'w') { |file| file.write(key.unpack('H*')[0]) }
     else
       to_hash_type(@content_to_encrypt).each_key do |env|
         next if env == 'default'
 
         key = OpenSSL::Random.random_bytes(16)
-        File.open("#{Dir.pwd}/config/master_#{env}.key", 'w') { |file| file.write(key.unpack('H*')[0]) }
+        File.open("#{@root_path}/config/master_#{env}.key", 'w') { |file| file.write(key.unpack('H*')[0]) }
       end
     end
   end
 
   private_class_method def self.load_content_to_encrypt
-    secret_file = File.expand_path("#{Dir.pwd}/config/secrets.yml")
+    secret_file = File.expand_path("#{@root_path}/config/secrets.yml")
     @content_to_encrypt = File.read(secret_file)
   end
 
@@ -89,7 +91,7 @@ class EncryptEnv
   end
 
   private_class_method def self.load_encrypted_data(env = nil)
-    file_path = env ? "#{Dir.pwd}/config/secrets_#{env}.yml.enc" : "#{Dir.pwd}/config/secrets.yml.enc"
+    file_path = env ? "#{@root_path}/config/secrets_#{env}.yml.enc" : "#{@root_path}/config/secrets.yml.enc"
     hex_string = File.read(file_path)
     raw_data = [hex_string].pack('H*')
 
@@ -100,7 +102,7 @@ class EncryptEnv
   end
 
   private_class_method def self.encrypt(content, typ = nil)
-    file_path = typ ? "#{Dir.pwd}/config/secrets_#{typ}.yml.enc" : "#{Dir.pwd}/config/secrets.yml.enc"
+    file_path = typ ? "#{@root_path}/config/secrets_#{typ}.yml.enc" : "#{@root_path}/config/secrets.yml.enc"
     cipher = OpenSSL::Cipher.new('aes-128-gcm')
     cipher.encrypt
     cipher.key = @master_key
@@ -119,6 +121,7 @@ class EncryptEnv
       raise e.message
     end
 
+    puts 'Decrypting...'
     decipher = OpenSSL::Cipher.new('aes-128-gcm')
     decipher.decrypt
     data = load_encrypted_data(env)
@@ -138,7 +141,7 @@ class EncryptEnv
 
   private_class_method def self.all_decrypted_object
     obj = {}
-    env_lst = Dir["#{Dir.pwd}/config/secrets_*.yml.enc"].map do |path|
+    env_lst = Dir["#{@root_path}/config/secrets_*.yml.enc"].map do |path|
       path.scan(/secrets_(.*)\.yml\.enc/).flatten.first
     end
     env_lst.each do |e|
@@ -151,19 +154,23 @@ class EncryptEnv
   def self.secrets_all
     return all_decrypted_object if @opt == 2
 
-    decrypt
+    decrypt unless @decrypted
     @decrypted
   end
 
   def self.secrets(env = nil)
     load_curr_opt unless @opt
-    return secrets_all if env == 'all'
+    if env == 'all'
+      result = secrets_all
+      @decrypted = nil
+      return result
+    end
 
     if @opt == 1
-      decrypt
+      decrypt unless @decrypted
       @decrypted[env || current_env]
     else
-      decrypt(env || current_env)
+      decrypt(env || current_env) unless @decrypted
       @decrypted
     end
   rescue StandardError => e
@@ -189,13 +196,15 @@ class EncryptEnv
       end
     end
 
-    File.rename("#{Dir.pwd}/config/secrets.yml", "#{Dir.pwd}/config/secrets.yml.old")
-    system("echo '/config/master*.key' >> #{Dir.pwd}/.gitignore")
-    system("echo '/config/secrets.yml.old' >> #{Dir.pwd}/.gitignore")
+    File.rename("#{@root_path}/config/secrets.yml", "#{@root_path}/config/secrets.yml.old")
+    system("echo '/config/master*.key' >> #{@root_path}/.gitignore")
+    system("echo '/config/secrets.yml.old' >> #{@root_path}/.gitignore")
     system("echo 'Set up complete!'")
   end
 
-  def self.edit(env = nil)
+  def self.edit(env = nil, variable_name = nil)
+    variable_name && (return create(variable_name, env, true))
+
     load_curr_opt unless @opt
     env ||= current_env if @opt == 2
     return unless decrypt(env)
@@ -212,33 +221,36 @@ class EncryptEnv
     puts e.message
   end
 
-  def self.show(env = nil)
-    # require "awesome_print"
+  def self.show(env = nil, variable_name = nil)
+    variable_name && (return valueof(variable_name, env))
+
+    require 'awesome_print'
+    require 'date'
     value = secrets(env)
-    # ap({})
-    # ap(value) unless @have_error
-    jj value unless @have_error
+    ap(value) unless @have_error
+    # jj value unless @have_error
     @have_error = false
   end
 
   def self.valueof(key, env = nil)
+    tail_msg = env ? " in '#{env}' environent" : nil
     value = secrets(env)
     unless value.key?(key)
-      puts "key '#{key}' does not exist!"
+      puts "key '#{key}' does not exist#{tail_msg}!"
       return
     end
     puts value[key]
   end
 
-  def self.delete_variable(key, env = nil)
+  def self.delete(key, env = nil)
     load_curr_opt unless @opt
     if @opt == 1
       puts 'Only for option 2!'
       return
     end
 
-    tail_confirm = env ? " in '#{env}' environent" : nil
-    confirm = "Really? You want to delete '#{key}'#{tail_confirm}? (y/n)"
+    tail_msg = env ? " in '#{env}' environent" : nil
+    confirm = "Really? You want to delete '#{key}'#{tail_msg}? (y/n)"
     puts confirm
     a = $stdin.gets.chomp
     return unless a == 'y'
@@ -246,38 +258,108 @@ class EncryptEnv
     value = secrets(env)
 
     unless value.key?(key)
-      puts "#{key} does not exist!"
+      puts "#{key} does not exist#{tail_msg}!"
       return
     end
 
+    tmp_value = value[key]
     value.delete(key)
     encrypt(value.to_hash.to_yaml, env || current_env)
-    puts "delete '#{key}' successfully!"
+    puts "Delete '#{key}' with value '#{tmp_value}' successfully!"
+  end
+
+  private_class_method def self.define_type_new_variable
+    types = {
+      '1' => 'integer',
+      '2' => 'float',
+      '3' => 'string',
+      '4' => 'boolean'
+    }
+    puts 'What is the type of variable? (1/2/3/4)'
+    puts "1.\t integer"
+    puts "2.\t float"
+    puts "3.\t string"
+    puts "4.\t boolean"
+    puts "Or enter 'q' to cancle!"
+
+    loop do
+      type = $stdin.gets.chomp
+      return types[type] if %w[1 2 3 4].include?(type)
+
+      exit if type == 'q'
+
+      puts 'Just "1", "2", "3", "4" or "q" to cancel!'
+    end
+  end
+
+  private_class_method def self.type_coercion(value, type)
+    unless %w[integer float string boolean].include?(type)
+      puts "Variable's type must be 'interger', 'float', 'string' or 'boolean'!"
+      exit
+    end
+
+    type = define_type_new_variable if type.nil?
+
+    case type
+    when 'integer'
+      value.to_i
+    when 'float'
+      value.to_f
+    when 'string'
+      value
+    when 'boolean'
+      (value == 'true')
+    end
+  end
+
+  def self.create_with_value(key, new_value, env = nil, type = nil)
+    load_curr_opt unless @opt
+    if @opt == 1
+      puts 'Only for option 2!'
+      return
+    end
+
+    new_value = type_coercion(new_value, type)
+
+    tail_msg = env ? " in '#{env}' environment" : nil
+
+    value = secrets(env)
+
+    if value.key?(key)
+      puts "Key existed#{tail_msg}!"
+      return
+    end
+
+    value[key] = new_value
+    encrypt(value.to_hash.to_yaml, env || current_env)
+    @decrypted = nil
+    puts "#{key}\t=>\t#{value[key]}"
   end
 
-  def self.update_variable(key, env = nil, add_variable = false)
+  def self.create(key, env = nil, is_edit = false)
     load_curr_opt unless @opt
     if @opt == 1
       puts 'Only for option 2!'
       return
     end
+    tail_msg = env ? " in '#{env}' environment" : nil
 
     value = secrets(env)
-    if add_variable && value.key?(key)
-      puts 'Key existed!'
+
+    if !is_edit && value.key?(key)
+      puts "Key existed#{tail_msg}!"
       return
     end
 
-    if !value.key?(key) && !add_variable
-      tail_msg = env ? " in #{env} environment" : nil
-      puts "'#{key}' does not exist#{tail_msg}. You want to add '#{key}' as the new key? (y/n)"
+    if !value.key?(key) && is_edit
+      puts "'#{key}' does not exist#{tail_msg}. You want to create '#{key}' as the new key? (y/n)"
       a = $stdin.gets.chomp
       return unless a == 'y'
 
-      add_variable = false
+      is_edit = false
     end
 
-    action = add_variable && 'add' || 'edit'
+    action = is_edit && 'edit' || 'create'
     file_name = env ? "#{action}_#{key}_#{env}" : "#{action}_#{key}"
 
     Tempfile.create(file_name) do |f|
@@ -285,11 +367,24 @@ class EncryptEnv
       f.flush
       f.rewind
       system("vim #{f.path}")
-      new_value = File.read(f.path)
-      value[key] = new_value.strip
+      # new_value = File.read(f.path)
+      new_value = YAML.load_file(f.path)
+      # value[key] = new_value.strip
+      value[key] = new_value
       encrypt(value.to_hash.to_yaml, env || current_env)
       @decrypted = nil
     end
+
+    puts "#{key}\t=>\t#{value[key]}"
+  end
+
+  # def self.get
+  #   self
+  # end
+
+  def self.method_missing(key, *_args)
+    secrets unless @decrypted
+    @decrypted[key]
   end
 end
 # rubocop:enable Metrics/ClassLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encrypt_env
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.4
 platform: ruby
 authors:
 - Nhu Tan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -39,6 +39,7 @@ extra_rdoc_files: []
 files:
 - bin/encrypt_env
 - lib/encrypt_env.rb
+- lib/encrypt_env/version.rb
 homepage: https://github.com/nnhutan/encrypt_env.git
 licenses:
 - MIT