capistrano-secret 1.0.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-secret.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Xavier Priour
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# capistrano-secret
+
+A [Capistrano](http://capistranorb.com/) gem to isolate secret information.
+
+When developing, it is imperative to keep secret information (server names, login, passwords,...) out of source control.
+This usually leads to cumbersome and risky setups, especially when combined with a deployment tool (like Capistrano).
+
+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
+gem install capistrano-secret
+```
+
+Load it into your `Capfile`:
+```ruby
+require 'capistrano/secret'
+```
+
+Create secret directory and add it to `.gitignore`:
+```
+config/secret
+```
+
+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)
+
+* 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).
+* Standard JSON syntax.
+* 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.
+
+## Requirements
+
+* [Capistrano 3](http://capistranorb.com/)
+
+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
+```
+
+Or using `bundler`, add the library to your `Gemfile`:
+```ruby
+gem 'capistrano-secret', require: false
+```
+
+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`:
+```ruby
+set :secret_dir, '.secrets'
+```
+
+Ensure the directory stays out of repository.
+For example, with git, add it to `.gitignore`:
+```
+config/secret
+```
+
+Then in the directory, create one JSON file per stage (same name as the stage):
+```
+config/secret/production.json
+```
+
+In the files, define keys as needed, using JSON syntax. For example:
+```JSON
+{
+    "db" : {
+        "user" : "user_db",
+        "password" : "srwhntseithenrsnrsnire",
+        "host" : "sql.yourdomain.com",
+        "name" : "yourDB"
+    },
+    "mail" : {
+        "mode" : "smtp",
+        "user" : "myapp@yourdomain.com",
+        "password" : "rastenhrtrethernhtr",
+        "host" : "ssl://smtp.yourdomain.com",
+    }
+}
+```
+
+Then in your Capistrano tasks you can access any value using `secret('path.to.key')`.
+The call is safe and will just return `nil` if all or part of the path leads nowhere.
+So you can test the return value of any part of the path to see if an option is present - for example:
+```ruby
+if secret('mail') then
+    # do something with mail info, like send a msg after deploy
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano-secret.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/secret/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-secret"
+  spec.version       = Capistrano::Secret::VERSION
+  spec.authors       = ["Xavier Priour"]
+  spec.email         = ["xavier.priour@bubblyware.com"]
+  spec.summary       = %q{Capistrano extension to isolate secret information}
+#  spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/xavierpriour/capistrano-secret"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  
+  spec.add_dependency "capistrano", "~> 3"
+end

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

@@ -0,0 +1,40 @@
+require 'json'
+
+# - key: (string), can be a dot notation
+def secret(key)
+  parts = key.split('.');
+  result = fetch(:secret, {});
+  parts.each {|k|
+    if result.has_key?(k);
+      result = result[k];
+    else
+      result = nil;
+      break;
+    end
+  }
+  return result;
+end
+
+namespace :secret do
+  desc <<-DESC
+    Load secrets from :secret_dir (defaults to config/secret).
+    
+    They are then available by calling secret('path.in.dot.notation').
+DESC
+  task :load do
+    my_stage = fetch(:stage)
+    secret = {}
+    my_dir = fetch(:secret_dir) || "config/secret"
+    secret_file = "#{my_dir}/#{my_stage}.json"
+    if (File.exists? secret_file) 
+      File.open( secret_file, "r" ) do |f|
+        secret = JSON.load( f )
+      end
+    else
+      secret = {}
+    end
+    set :secret, secret
+  end
+end
+
+before 'deploy:starting', 'secret:load'

data/lib/capistrano/secret/version.rb

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

data/lib/capistrano/secret.rb

@@ -0,0 +1,9 @@
+require "capistrano/secret/version"
+
+module Capistrano
+  module Secret
+    # Your code goes here...
+  end
+end
+
+load File.expand_path('../secret/tasks/secret.cap', __FILE__)

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-secret
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Xavier Priour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- xavier.priour@bubblyware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-secret.gemspec
+- lib/capistrano/secret.rb
+- lib/capistrano/secret/tasks/secret.cap
+- lib/capistrano/secret/version.rb
+homepage: https://github.com/xavierpriour/capistrano-secret
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano extension to isolate secret information
+test_files: []