capistrano-secrets-yml 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92c88d7979d7b310daac29ae043c02b728a8c085
-  data.tar.gz: de32134712eadaf043ec6333dd540d354c8366a8
+  metadata.gz: f46c44749e9fcebe92a01299f3efb8f8d0ab06e6
+  data.tar.gz: 00676a1660ab65452ecf72599997a448b700abcb
 SHA512:
-  metadata.gz: 6f79f1eb349ed50b9997e3cfa4b01956175cdf874e0aa68b635fe9da88e526cb5eab764a933a8b9208c64d37d4cd8580462a4fa1f08afe9e2f03b5a1d8cc1702
-  data.tar.gz: 98d72f548463a9f78e1c3adfff6cefa904856667043470f0007754ce9212840ef96f46a9c54e84400b1f2c505506cbad4284484efdb22034f05f0a30b0fbff5b
+  metadata.gz: b6d082628416e66f917c3a4dfda4a12ce31b89de606b737c48abce2a21f757d795f3a8dc203dad9b762ffebb186eba29b6ae49327fa0fea78f3f7734c1921f0a
+  data.tar.gz: 4eabb79353d80269863b4dae6b824cddc528573349f4a7b8b654cf26fb3ceda0402a5b63f02660b65a81febbeedffea06c1a20583f0433aa992cfb20c324497b

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 # Changelog
 
 ### master
+
+### v1.0.0, 2014-10-07
+- added a check if `secrets.yml` is removed from git
+- add content to the README
+- improve checks for `secrets.yml`
+
+### v0.0.1, 2014-10-07
 - started the project
+- first working version

data/README.md

@@ -1,3 +1,81 @@
 # Capistrano::SecretsYml
 
-Capistrano tasks for handling `secrets.yml` file in Rails 4+.
+Capistrano tasks for handling `secrets.yml` when deploying Rails 4+ apps.
+
+### Install
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.2.1'
+      gem 'capistrano-secrets-yml', '~> 1.0.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+- make sure your local `config/secrets.yml` is not git tracked. It **should be on
+  the disk**, but gitignored.
+
+- populate production secrets in local `config/secrets.yml`:
+
+        production:
+          secret_key_base: d6ced...
+
+- add to `Capfile`:
+
+        require 'capistrano/secrets_yml'
+
+- create `secrets.yml` file on the remote server by executing this task:
+
+        $ bundle exec cap production setup
+
+You can now proceed with other deployment tasks.
+
+#### What if a new config is added to secrets file?
+
+- add it in local `config/secrets.yml`:
+
+        production:
+          secret_key_base: d6ced...
+          foobar: some_other_secret
+
+- and copy to the server:
+
+        $ bundle exec cap production setup
+
+### How it works
+
+When you execute `$ bundle exec production setup`:
+
+- secrets from your local `secrets.yml` are copied to the server.<br/>
+- only "stage" secrets are copied: if you are deploying to `production`,
+  only production secrets are copied there
+- on the server secrets file is located  in `#{shared_path}/config/secrets.yml`
+
+On deployment:
+
+- secrets file is automatically symlinked to `#{current_path}/config/secrets.yml`
+
+### Configuration
+
+None.
+
+### FAQ
+
+- shouldn't we be keeping configuration in environment variables as per
+  [12 factor app rules](http://12factor.net/config)?
+
+  On Heroku, yes.<br/>
+  With Capistrano, those env vars still have to be written somewhere on the disk
+  and used with a tool like [dotenv](https://github.com/bkeepers/dotenv).
+
+  Since we have to keep configuration on the disk anyway, it probably makes
+  sense to use Rails 4 built-in `secrets.yml` mechanism.
+
+### License
+
+[MIT](LICENSE.md)

data/lib/capistrano/secrets_yml/helpers.rb

@@ -1,16 +1,47 @@
+require "yaml"
+
 module Capistrano
   module SecretsYml
     module Helpers
 
-      def read_local_secrets_yml
+      def local_secrets_yml(env)
         @local_secrets_yml ||= YAML.load_file(secrets_yml_local_path)
+        @local_secrets_yml[env]
+      end
+
+      def secrets_yml_env
+        fetch(:secrets_yml_env).to_s
       end
 
       def secrets_yml_content
-        @content ||= begin
-          env = fetch(:secrets_yml_env).to_s
-          Hash[env => read_local_secrets_yml.fetch(env)].to_yaml
-        end
+        { secrets_yml_env => local_secrets_yml(secrets_yml_env) }.to_yaml
+      end
+
+      # error helpers
+
+      def check_git_tracking_error
+        puts
+        puts "Error - please remove '#{fetch(:secrets_yml_local_path)}' from git:"
+        puts
+        puts "    $ git rm --cached #{fetch(:secrets_yml_local_path)}"
+        puts
+        puts "and gitignore it:"
+        puts
+        puts "    $ echo '#{fetch(:secrets_yml_local_path)}' >> .gitignore"
+        puts
+      end
+
+      def check_config_present_error
+        puts
+        puts "Error - '#{secrets_yml_env}' config not present in '#{fetch(:secrets_yml_local_path)}'."
+        puts "Please populate it."
+        puts
+      end
+
+      def check_secrets_file_exists_error
+        puts
+        puts "Error - '#{fetch(:secrets_yml_local_path)}' file does not exists, and it's required."
+        puts
       end
 
     end

data/lib/capistrano/secrets_yml/paths.rb

@@ -1,3 +1,5 @@
+require "pathname"
+
 module Capistrano
   module SecretsYml
     module Paths

data/lib/capistrano/secrets_yml/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module SecretsYml
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/capistrano/tasks/secrets_yml.rake

@@ -1,8 +1,6 @@
 include Capistrano::SecretsYml::Paths
 include Capistrano::SecretsYml::Helpers
-
-namespace :load do
-  task :defaults do
+namespace :load do task :defaults do
     set :secrets_yml_local_path, "config/secrets.yml"
     set :secrets_yml_remote_path, "config/secrets.yml"
     set :secrets_yml_env, -> { fetch(:rails_env) || fetch(:stage) }
@@ -11,8 +9,33 @@ end
 
 namespace :secrets_yml do
 
+  task :check_secrets_file_exists do
+    next if File.exists?(secrets_yml_local_path)
+    check_secrets_file_exists_error
+    exit 1
+  end
+
+  task :check_git_tracking do
+    next unless system("git ls-files #{fetch(:secrets_yml_local_path)} --error-unmatch >/dev/null 2>&1")
+    check_git_tracking_error
+    exit 1
+  end
+
+  task :check_config_present do
+    next unless local_secrets_yml(secrets_yml_env).nil?
+    check_config_present_error
+    exit 1
+  end
+
+  desc "secrets.yml file checks"
+  task :check do
+    invoke "secrets_yml:check_secrets_file_exists"
+    invoke "secrets_yml:check_git_tracking"
+    invoke "secrets_yml:check_config_present"
+  end
+
   desc "Setup `secrets.yml` file on the server(s)"
-  task :setup do
+  task setup: [:check] do
     content = secrets_yml_content
     on release_roles :all do
       execute :mkdir, "-pv", File.dirname(secrets_yml_remote_path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-secrets-yml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bruno Sutic