secret-keeper 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 993613940fe2fd54b0db8ea676aeaeb82a1de574b6d986a904f14e166d9826a2
-  data.tar.gz: 92c2b76672090397d60871cf438fc597877351ae74c09cd4f43d927d2c3de0b1
+  metadata.gz: 1a314a84c5cdc4c6ef06e417d3c638186eafdaeb522936e97c87a54f7050940a
+  data.tar.gz: 2e40a932f8d0c92aa78fea56401f4c115862c302e0c584cc8cf5f95d06faf09a
 SHA512:
-  metadata.gz: a3c9d114ab4bcd7b0958ff3fa999e2b2ffb3c4bda4eeab15e54841daa9596d24ec6c7323893d07995e8fe6f4c7fb47ccc082e88b5c89513fe12010a350ba1b84
-  data.tar.gz: 9a6e63acc12ef13e56237e8dde65e28b45a47423a700b71c6d79486fabcf89dbd3f13426f26e23ab08f54a9ca09fb186b00bcdefab19f6a3c1bc1e27c8682719
+  metadata.gz: 877c488a822ec78ca1ef89b2f58c1461de62a866bf5625954a8cb0772af3d1ba6fb789f05802c885eb6841857d4a6e5599af18e0abe129987f13777b86de9e22
+  data.tar.gz: 3d580b41a2585c1c2977affbad1ef8ac443b20b59074ce715265b57fc2879da1a6f848702fff8dea3fbf7ca443e70a2cf21ac5d65bf71a3edf99db2267d7f8f5

data/README.md

@@ -6,73 +6,89 @@ Keep all your secret files within openssl
 
 from console
 
-    gem install secret-keeper
+```bash
+gem install secret-keeper
+```
 
 with bundler, write follwing line in your Gemfile
 
-    gem 'secret-keeper', require: false
+```bash
+gem 'secret-keeper', require: false
+```
 
 ## Upgrade from v1 to v2
 
 The *remove_production* parameter of *decrypt_files* has been removed after version 2.0.0.
 If you wants to remove *production* settings after decrypt files, you can set *remove_production* option to *true* in *secret-keeper.yml*:
 
-```
-  options:
-    remove_production: false
+```yaml
+options:
+  remove_production: false
 ```
 
 ## Usage
 setup files need to be encrypted in config/secret-keeper.yml
 
-    # config/secret-keeper.yml example
-    development:
-      ev_name: SECRET_KEEPER
-      cipher: AES-256-CBC
-      options:
-        slience: false
-        remove_production: false
-        remove_source: false
-      tasks:
-        -
-          encrypt_from: example/database.yml
-          encrypt_to: example/database.yml.enc
-          # decrypt_from: example/database.yml.enc
-          # decrypt_to: example/database.yml
-        -
-          encrypt_from: example/secrets_from_other_source.yml
-          encrypt_to: example/secrets.yml.enc
-          # decrypt_from: example/secrets.yml.enc
-          decrypt_to: example/secrets.yml
+```yaml
+# config/secret-keeper.yml example
+development:
+  ev_name: SECRET_KEEPER
+  cipher: AES-256-CBC
+  options:
+    slience: false
+    remove_production: false
+    remove_source: false
+  tasks:
+    -
+      encrypt_from: example/database.yml
+      encrypt_to: example/database.yml.enc
+      # decrypt_from: example/database.yml.enc
+      # decrypt_to: example/database.yml
+    -
+      encrypt_from: example/secrets_from_other_source.yml
+      encrypt_to: example/secrets.yml.enc
+      # decrypt_from: example/secrets.yml.enc
+      decrypt_to: example/secrets.yml
+```
 
 using environment variable SECRET_KEEPER to be your key of cipher
 
-    $> SECRET_KEEPER=[YOUR-CIPHER-KEY-HERE] irb
+```bash
+$> SECRET_KEEPER=[YOUR-CIPHER-KEY-HERE] irb
+```
 
 require on demand
 
-    irb> require 'secret-keeper'
+```bash
+irb> require 'secret-keeper'
+```
 
 encrypt files based on your tasks defined in config/secret-keeper.yml
 
-    irb> SecretKeeper.encrypt_files
-    # Encrypting...
-    #   * example/database.yml --> example/database.yml.enc, ok
-    #   * example/secrets.yml --> example/secrets.yml.enc, ok
-    # Done!
+```bash
+irb> SecretKeeper.encrypt_files
+# Encrypting...
+#   * example/database.yml --> example/database.yml.enc, ok
+#   * example/secrets.yml --> example/secrets.yml.enc, ok
+# Done!
+```
 
 decrypt files based on your tasks defined in config/secret-keeper.yml
 
-    irb> SecretKeeper.decrypt_files
-    # Decrypting...
-    #   * example/database.yml.enc --> example/database.yml, ok
-    #   * example/secrets.yml.enc --> example/secrets.yml, ok
-    # Done!
+```bash
+irb> SecretKeeper.decrypt_files
+# Decrypting...
+#   * example/database.yml.enc --> example/database.yml, ok
+#   * example/secrets.yml.enc --> example/secrets.yml, ok
+# Done!
+```
 
 ## Available Ciphers
 
-    irb> require 'openssl'
-    irb> OpenSSL::Cipher.ciphers
+```bash
+irb> require 'openssl'
+irb> OpenSSL::Cipher.ciphers
+```
 
 ## Options
 

data/lib/secret-keeper.rb

@@ -11,7 +11,7 @@ class SecretKeeper
     printer << '(source files removed)' if sk.options['remove_source']
     ok_queue = []
     sk.tasks.each do |task|
-      from = File.exists?(task['encrypt_from']) ? task['encrypt_from'] : task['decrypt_to']
+      from = File.exist?(task['encrypt_from']) ? task['encrypt_from'] : task['decrypt_to']
       to = task['encrypt_to']
 
       result = sk.encrypt_file(from, to)
@@ -58,8 +58,12 @@ class SecretKeeper
     env = ENV['RAILS_ENV'] || 'development'
     string = File.open('config/secret-keeper.yml', 'rb') { |f| f.read }
     fail 'config/secret-keeper.yml not existed nor not readable' if string.nil?
-    config = YAML.load(string)[env]
-    fail 'config/secret-keeper.yml incorrect or environment not exist' if config.nil?
+    begin
+      config = YAML.load(string, aliases: true)[env] || {}
+    rescue ArgumentError
+      config = YAML.load(string)[env] || {}
+    end
+    fail 'config/secret-keeper.yml incorrect or environment not exist' if config.nil? || config.empty?
     ev_name = config['ev_name'] || 'SECRET_KEEPER'
     fail "environment variable #{ev_name} not exist" if ENV[ev_name].nil?
 
@@ -88,7 +92,11 @@ class SecretKeeper
 
   def remove_production_config(file_path)
     return :ok unless file_path =~ /\.yml/
-    hash = YAML.load_file(file_path)
+    begin
+      hash = YAML.load_file(file_path, aliases: true)
+    rescue ArgumentError
+      hash = YAML.load_file(file_path)
+    end
     hash.delete('production')
     File.write(file_path, YAML.dump(hash))
     :ok

data/spec/secret-keeper_spec.rb

@@ -28,8 +28,8 @@ describe SecretKeeper do
       SecretKeeper.new.tasks.each do |task|
         source_file = task['encrypt_from']
         target_file = task['encrypt_to']
-        expect(File.exists?(source_file)).to eq(false)
-        expect(File.exists?(target_file)).to eq(true)
+        expect(File.exist?(source_file)).to eq(false)
+        expect(File.exist?(target_file)).to eq(true)
       end
     end
   end
@@ -38,7 +38,11 @@ describe SecretKeeper do
     it 'should return true' do
       result = SecretKeeper.decrypt_files
       expect(result).to eq(true)
-      hash = YAML.load_file('example/secrets.yml')
+      begin
+        hash = YAML.load_file('example/secrets.yml', aliases: true)
+      rescue ArgumentError
+        hash = YAML.load_file('example/secrets.yml')
+      end
       expect(hash['development']['secret_key_base']).to eq('e8310af93d52f174f475940c41fbfb90417b300ebc19e1b24bd5639f4fe35c5ffaa5775a347ace9732958f656a47f6bb8e1fd0760b12e51b0b4fe1f65ef0a1d6')
       expect(hash['production']['secret_key_base']).to eq('339f639f4fe35c5ffaa47ace973260b12e51b0b4fe1f65effd283a5f054f47594b24bd565779e351a20dfd4ada4f777958f0417b305c06cdedbde392b8e1fd07')
     end
@@ -71,8 +75,8 @@ describe SecretKeeper do
       SecretKeeper.new.tasks.each do |task|
         source_file = task['decrypt_from'] || task['encrypt_to']
         target_file = task['decrypt_to'] || task['encrypt_from']
-        expect(File.exists?(source_file)).to eq(false)
-        expect(File.exists?(target_file)).to eq(true)
+        expect(File.exist?(source_file)).to eq(false)
+        expect(File.exist?(target_file)).to eq(true)
       end
     end
 
@@ -92,8 +96,8 @@ describe SecretKeeper do
       SecretKeeper.new.tasks.each do |task|
         source_file = task['decrypt_from'] || task['encrypt_to']
         target_file = task['decrypt_to'] || task['encrypt_from']
-        expect(File.exists?(source_file)).to eq(false)
-        expect(File.exists?(target_file)).to eq(true)
+        expect(File.exist?(source_file)).to eq(false)
+        expect(File.exist?(target_file)).to eq(true)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret-keeper
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Ray Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -37,7 +37,9 @@ files:
 homepage: https://github.com/kdan-mobile-software-ltd/secret-keeper
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/kdan-mobile-software-ltd/secret-keeper
+  changelog_uri: https://github.com/kdan-mobile-software-ltd/secret-keeper/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -54,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Keep all your secret files within openssl