capistrano-secret 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a4c1fd2482f46d94f7a8c46258af5ebbaffb0f0
-  data.tar.gz: 889fb344037a19edb3c807af048398af5cf1d447
+  metadata.gz: d1efd5ae4212ee3a81cf676d6ce77a24460fb6e5
+  data.tar.gz: aeb27f2d1281a4c9ff09c1c7492a92b1d5d38aa8
 SHA512:
-  metadata.gz: 8099c64da791cd6c5680734be431d329375ee973df56cc2dd9aef657d2e10d9f9ede5f92cc5f4261809e14aaaa190ded5ff21deea45d65a7945d608b9f2c8a18
-  data.tar.gz: 689386968bad3c37e489caf228427f291ce7674384edda1c02862844271e47e038d9eb58d51942ca2910c58a8d515cee72e277e83ceb0b9247a566dd08029eb6
+  metadata.gz: bd3f80b96fa4afc6fdb5f97b324a89c314557f16273ac954af6a8abd9b626364f8ca707f7fb5876572dfe3e5933b7a1d15d450182dd8e1ba556c5509f3a48f93
+  data.tar.gz: 7f4396210c43944e488576f0dbb6e754395b8bca87d9d24a9df98e269f81b2878e5ccfeb5f480d236cae0011f8f28448440b0e71a9762cf2f1cdf33a312f2549

data/README.md

@@ -1,4 +1,4 @@
-# capistrano-secret
+# Capistrano::Secret
 
 A [Capistrano](http://capistranorb.com/) gem to isolate secret information.
 
@@ -7,32 +7,28 @@ This usually leads to cumbersome and risky setups, especially when combined with
 
 This tiny gem provides methods to **easily** do the **right thing**: conveniently tuck all secrets in a JSON file in a dedicated folder, and easily the information from the rest of the Capistrano tasks.
 
+
 ## Quick start
 
-Get the library:
-```ruby
+In a shell:
+```bash
 gem install capistrano-secret
+echo "require 'capistrano/secret'" >> Capfile
+mkdir config/secret
+echo "config/secret" >> .gitignore
+echo '{"secret":{"of": {"life": 42}}}' > config/secret/production.json
+echo '{"secret":{"of": {"life": "partying like crazy"}}}' > config/secret/staging.json
 ```
 
-Load it into your `Capfile`:
+Then in any Capistrano task:
 ```ruby
-require 'capistrano/secret'
-```
-
-Create secret directory and add it to `.gitignore`:
-```
-config/secret
+puts "I know the secret, it is #{secret('secret.of.life')}";
 ```
 
-Then in Capistrano access any secret with:
-
-```ruby
-secret('path.to.example.key');
-```
 
 ## Features
 
-Here are capistrano-secret's advantages over alternatives (like keeping whole config files out of repository)
+Capistrano::Secret advantages:
 
 * All secret information in one unique place: no duplication, easy to keep out of repository.
 * Files contain only secret: no mixing with other, non-sensitive information (like configuration directives).
@@ -40,7 +36,8 @@ Here are capistrano-secret's advantages over alternatives (like keeping whole co
 * Each stages has its own set of secrets.
 * Method name makes it explicit to developer this is sensitive information (it's called `secret()`!).
 
-Full power shows when used in conjunction with a templating library like [capistrano-template](https://github.com/xavierpriour/capistrano-template), to generate configuration files at deployment.
+It really shines when used in conjunction with a templating library like [capistrano-template](https://github.com/xavierpriour/capistrano-template),
+to generate configuration files at deployment. Check it out!
 
 ## Requirements
 
@@ -48,38 +45,46 @@ Full power shows when used in conjunction with a templating library like [capist
 
 All dependencies are listed in the .gemspec file so if using `bundler` you just need to `bundle install` in your project directory.
 
-## Usage
 
-Get the gem, either manually:
-```ruby
-gem install capistrano-secret
+## Installation
+
+Add this line to your application's Gemfile:
+```
+gem 'capistrano-template'
 ```
 
-Or using `bundler`, add the library to your `Gemfile`:
-```ruby
-gem 'capistrano-secret', require: false
+And then execute:
+```bash
+$ bundle
 ```
 
+Or install it yourself as:
+```bash
+$ gem install capistrano-template
+```
+
+
+## Usage
+
 Include gem in your `Capfile`:
 ```ruby
 require 'capistrano/secret'
 ```
 
 Create directory where secret information will be stored.
-Default is `config/secret`, to change it update `deploy.rb`:
+Default is `config/secret`, to use a different one define `secret_dir` in `deploy.rb`:
 ```ruby
-set :secret_dir, '.secrets'
+set :secret_dir, 'new/secret/dir'
 ```
 
-Ensure the directory stays out of repository.
-For example, with git, add it to `.gitignore`:
-```
-config/secret
+Ensure the directory stays out of repository (for git, add it to `.gitignore`):
+```bash
+echo 'config/secret' >> .gitignore
 ```
 
 Then in the directory, create one JSON file per stage (same name as the stage):
-```
-config/secret/production.json
+```bash
+touch config/secret/production.json
 ```
 
 In the files, define keys as needed, using JSON syntax. For example:
@@ -107,4 +112,11 @@ So you can test the return value of any part of the path to see if an option is
 if secret('mail') then
     # do something with mail info, like send a msg after deploy
 end
-```
+```
+
+## Contributing
+1. Fork it ( https://github.com/xavierpriour/capistrano-secret/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/capistrano/secret/tasks/secret.cap

@@ -2,8 +2,12 @@ require 'json'
 
 # - key: (string), can be a dot notation
 def secret(key)
+  result = fetch(:secret);
+  if result.nil? #lazy load
+    Rake::Task['secret:load'].invoke
+    result = fetch(:secret);
+  end
   parts = key.split('.');
-  result = fetch(:secret, {});
   parts.each {|k|
     if result.has_key?(k);
       result = result[k];
@@ -35,6 +39,4 @@ DESC
     end
     set :secret, secret
   end
-end
-
-before 'deploy:starting', 'secret:load'
+end

data/lib/capistrano/secret/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Secret
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-secret
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Xavier Priour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler