secret-keeper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb41f3ee6ff58c816d18e1f424cc5abd800df058
-  data.tar.gz: dcb36b9f0f983d79369d7d1a51b393486400b3cb
+  metadata.gz: bbd2fa36c693a0c02dfdb01eece37e1f0467d78a
+  data.tar.gz: c1ae32d09ed3d1ac0cff3af984c5bd68b62af31f
 SHA512:
-  metadata.gz: 2814775b46269013b94356ea9dd8982161aa657d5fec7da696820462712f12903cdbf6c6b55c5b56cf17fdfa9ecf1c02705d6af4ffa477787e76e50826e9873b
-  data.tar.gz: 4fbb767f3696a876f6d41e00eb345c287c87e822a4bb019ab3115027169850937b569b24834a7e82ab1bb2de88284aaaea4280938563b8fd422f342b6504620b
+  metadata.gz: 4a0ac28f552387514b3e0dbe85983debd485b670172f635d04a82b548a60e9ebed7136d3d41122fc328ddbb7e1dff0562df9a3fcc4216eeedc4ded007be7bcce
+  data.tar.gz: 50bc5aac70bd82875d69d6153a6f18745608c993933dc2d1c4237127ac9d33255be9e4b0eae383160a67b05389fb8d6a91785625bc9d0c1a318ca42b76485d7b

data/README.md

@@ -0,0 +1,63 @@
+# Secret Keeper
+
+Keep all your secret files within openssl
+
+## Install
+
+from console
+
+    gem install secret-keeper
+
+with bundler, write follwing line in your Gemfile
+
+    gem 'secret-keeper', require: false
+
+
+## Usage
+using environment variable OPENSSL_PASS to be your key of cipher
+
+    $> OPENSSL_PASS=[YOUR-CIPHER-KEY-HERE] irb
+
+require on demand
+
+    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
+    # Over!
+
+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
+    # Over!
+
+## Available Ciphers
+
+    OpenSSL::Cipher.ciphers
+
+## Config Example
+
+    development: &development
+      cipher: AES-256-CBC
+      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
+    test:
+      <<: *development
+    production:
+      <<: *development

data/spec/secret-keeper_spec.rb

@@ -0,0 +1,50 @@
+describe SecretKeeper do
+  before(:each) do
+    ENV['OPENSSL_PASS'] = 'PASSWORD'
+  end
+
+  describe '.encrypt_files' do
+    it 'should return true' do
+      result = SecretKeeper.encrypt_files
+      expect(result).to eq(true)
+    end
+  end
+
+  describe '.decrypt_files' do
+    it 'should return true' do
+      result = SecretKeeper.decrypt_files
+      expect(result).to eq(true)
+    end
+
+    it 'should be false, if OPENSSL_PASS incorrect' do
+      ENV['OPENSSL_PASS'] = 'incorrect'
+      result = SecretKeeper.decrypt_files
+      expect(result).to eq(false)
+    end
+
+    it 'should raise error, if OPENSSL_PASS nil' do
+      ENV['OPENSSL_PASS'] = nil
+      expect{ SecretKeeper.decrypt_files }.to raise_error(RuntimeError)
+    end
+
+    it 'should raise error, if config file not found' do
+      FileUtils.mv('config/secret-keeper.yml', 'config/secret-keeper-tmp.yml')
+      expect{ SecretKeeper.decrypt_files }.to raise_error(Errno::ENOENT)
+      FileUtils.mv('config/secret-keeper-tmp.yml', 'config/secret-keeper.yml')
+    end
+
+    it 'should raise error, if config file format incorrect' do
+      FileUtils.mv('config/secret-keeper.yml', 'config/secret-keeper-tmp.yml')
+      FileUtils.cp('config/secret-keeper-incorrect-format.yml', 'config/secret-keeper.yml')
+      expect{ SecretKeeper.decrypt_files }.to raise_error(Psych::SyntaxError)
+      FileUtils.mv('config/secret-keeper-tmp.yml', 'config/secret-keeper.yml')
+    end
+
+    it 'should raise error, if config file lack enviorment' do
+      FileUtils.mv('config/secret-keeper.yml', 'config/secret-keeper-tmp.yml')
+      FileUtils.cp('config/secret-keeper-lack-env.yml', 'config/secret-keeper.yml')
+      expect{ SecretKeeper.decrypt_files }.to raise_error(RuntimeError)
+      FileUtils.mv('config/secret-keeper-tmp.yml', 'config/secret-keeper.yml')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secret-keeper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ray Lee
@@ -14,36 +14,40 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: A Secret keeper
 email: ray-lee@kdanmobile.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - lib/secret-keeper.rb
+- spec/secret-keeper_spec.rb
 homepage: https://github.com/redtear1115/secret-keeper
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -55,4 +59,5 @@ rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Keep all your secret files within openssl
-test_files: []
+test_files:
+- spec/secret-keeper_spec.rb