secret_env 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1e1505edb2746b3c514bcfc4d63a55932bac752
-  data.tar.gz: 8caaa36d3a22b33d9d7765298239da62df506724
+  metadata.gz: da53d177eb5d09cf20c548bdb1e6133f3b3b9bd5
+  data.tar.gz: 381545548cdfd4ef862c7297c094217de18979d1
 SHA512:
-  metadata.gz: f7875732f6642c3da35395258b837ff955368002094eefce272ce3acd06b945bb47689ec661604e4962aa4551333dd8f68406e17eb833f551ee9ebab81d43fad
-  data.tar.gz: 7b99d06bea62e93ba190d134c0fedfd86ffebdf9c0930dc0b683e1090c4b2f7d17e1c4e27f8373ec979272ccef38d60198d5cd36cf562e81f68685da813fe988
+  metadata.gz: 19ee8fa8dda27709ad24efb0594f3ba0ad7b86a061adeb28007cee1beed5a87e01d94090a15e9c7678f5723d6912b1b007b0f5d3dec5fa05b123f51fb3e09d2c
+  data.tar.gz: 5aa50c61ab6766be2984edc91a7496574032bc38348e8e9d9021af539ac41c507b7629041ece8055c74d376169f36fa7218284ac4207862be743c4881120bd24

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.12.5
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6

data/README.md

@@ -1,8 +1,32 @@
-# SecretEnv
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/secret_env`. To experiment with that code, run `bin/console` for an interactive prompt.
+# SecretEnv [![Build Status](https://travis-ci.org/adorechic/secret_env.svg?branch=master)](https://travis-ci.org/adorechic/secret_env)
+SecretEnv is a environment variables manager for rails. SecretEnv can resolve secret variables from storages.
+
+```yaml
+development:
+  env:
+    AUTH_SECRET: secret
+    DATABASE_URL: 'mysql2://local_user@localhost:3306'
+
+staging:
+  storage:
+    type: credstash
+    namespace: awesome_app.staging.
+  env:
+    AUTH_SECRET: '#{auth_secret}'
+    DATABASE_URL: 'mysql2://db_user:#{db_password}@db-staging:3306/main?read_timeout=10&encoding=utf8'
+
+production:
+  storage:
+    type: credstash
+    namespace: awesome_app.production.
+  env:
+    AUTH_SECRET: '#{auth_secret}'
+    DATABASE_URL: 'mysql2://db_user:#{db_password}@db-production:3306/main?read_timeout=10&encoding=utf8'
+```
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+- Put secrets out of a config file in repository. You can choose backend storages.
+- Configure multi environments via one file.
 
 ## Installation
 
@@ -16,26 +40,36 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Put config/secret_env.yml in your application.
 
-    $ gem install secret_env
+## Storages
+SecretEnv resolves keys in given namespace. If you set `some.namespace`, SecretEnv finds `some.namespace.super_secret` key from storages.
 
-## Usage
+### type: plain
+This is default storage type. This type does not retrieve secrets, just extract it as full namespaced key.
 
-TODO: Write usage instructions here
+### type: credstash
+This type finds secrets via credstash. You have to bundle 'rcredstash'.
 
-## Development
+```ruby
+gem 'secret_env'
+gem 'rcredstash'
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### type: file
+This type finds secrets from local file. Put your secrets in config/secret_env.local, and add it to your gitignores.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+# config/secret_env.local
+foo=1
+bar=2
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/secret_env.
+Bug reports and pull requests are welcome on GitHub at https://github.com/adorechic/secret_env.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/secret_env/storage.rb

@@ -17,6 +17,8 @@ module SecretEnv
           Storage::Plain
         when 'credstash'
           Storage::CredStash
+        when 'file'
+          Storage::File
         else
           raise "Unknown storage type: #{type}"
         end
@@ -52,5 +54,18 @@ module SecretEnv
         ::CredStash.get(full_key(secret_key))
       end
     end
+
+    class File < Base
+      LOCAL_FILE_PATH = 'config/secret_env.local'
+
+      def initialize(namespace: '')
+        super
+        @secrets = Hash[*::File.readlines(LOCAL_FILE_PATH).map(&:strip).map {|line| line.split("=", 2) }.flatten]
+      end
+
+      def retrieve(secret_key)
+        @secrets[full_key(secret_key)]
+      end
+    end
   end
 end

data/lib/secret_env/version.rb

@@ -1,3 +1,3 @@
 module SecretEnv
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret_env
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - adorechic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: SecretEnv retrieves secrets and export to ENV