capistrano-ejson 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9366476c75176473e7c18a3af1c77d8f0b306d3
-  data.tar.gz: 83e0c2bafbc10b927f0cf99a5845bc2f5b941a19
+  metadata.gz: c75a5ea99c26f925da5027f2c67c87fdef37a224
+  data.tar.gz: 6c608aeca7b796b3513a353e41405d7e830d70d3
 SHA512:
-  metadata.gz: a51bbc6ddb7be7d1c865996260c102fbc27ea9772a20641c8e8ee147465e6425c70f89656f070b1bc70bff9ae94959a90d28c22ae73df652f98e24d18a0dfaf5
-  data.tar.gz: 0aa7dbba021fdf1cbcc540d509d3b58442b2cd21203b781c18de4060952102c069e7078762c63b460127c30aaaafbf94cb6bb08af1733fbe890c66f2812cbe9e
+  metadata.gz: 7983e551b2b57f5035af6f2e7d1ccaa6df4e9f5e038b954cb1e21eba5c2e38e17752af06c49f2ec4651e67f88b68955aa2f1cbb7240c32d9e7ea0bc42e31cbbc
+  data.tar.gz: 4d40a140b7857823171a366e9416c8de0dcf6798011689f70f23b199b721641f75611050aadb45a9ec058fdbf778b46da185c9f6d0efbe5c7ba14d89db159874

data/README.md

@@ -26,14 +26,17 @@ Require in `Capfile` to use the default task:
 require 'capistrano/ejson'
 ```
 
-The task `ejson:upload_config_files` will run after `deploy:updated`.
+The task `ejson:upload_config_file` will run after `deploy:updated`.
 
-By default any file ending in `.ejson` will be decrypted and uploaded. You can set which files to upload manually by doing
+By default the file `config/secrets.ejson` will be decrypted to `config/secrets.json`. You can change this behavior by specifying the following config variables:
 
 ```ruby
-set :ejson_files, %w{config/keys.ejson}
+set :ejson_file, "config/secrets.ejson"
+set :ejson_output_file, "config/secrets.json"
 ```
 
+By default `capistrano-ejson` decrypts the secrets file from the machine that does the deploy and then uploads the resulting config to the servers. You can set `:ejson_deploy_mode` to `:remote` to perform the decryption remotely, which will run something like `ejson decrypt -o config/secrets.json config/secrets.ejson` on the remote hosts. If you need to use `sudo` or `bundle exec`, you should use the [SSHKit command map](https://github.com/capistrano/sshkit#the-command-map).
+
 ## Contributing
 
 1. Fork it

data/capistrano-ejson.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-ejson"
-  spec.version       = "0.0.2"
+  spec.version       = "0.1.0"
   spec.authors       = ["Bouke van der Bijl"]
   spec.email         = ["bouke@shopify.com"]
   spec.description = spec.summary = %q{Automatic EJSON decryption for Capistrano}

data/lib/capistrano/tasks/ejson.cap

@@ -3,28 +3,41 @@ require 'open3'
 namespace :ejson do
   desc "Decrypt and upload ejson config files"
 
-  task :upload_config_files do
-    fetch(:ejson_files).each do |ejson_file|
-      json_file = ejson_file.sub(/\.ejson\z/, '.json')
+  task :upload_config_file do
+    ejson_file = fetch(:ejson_file)
+    ejson_output_file = fetch(:ejson_output_file)
+    ejson_deploy_mode = fetch(:ejson_deploy_mode)
 
+    case ejson_deploy_mode
+    when :local
       Open3.popen3('bundle', 'exec', 'ejson', 'decrypt', ejson_file) do |stdin, stdout, stderr, wait_thr|
         if wait_thr.value == 0
           contents = stdout.read
           on roles(:all) do
-            upload! StringIO.new(contents), File.join(release_path, json_file)
+            upload! StringIO.new(contents), File.join(release_path, ejson_output_file)
           end
         else
           raise "Failed to decrypt file #{stderr.read}"
         end
       end
+    when :remote
+      on roles(:all) do
+        within release_path do
+          execute :ejson, :decrypt, "-o", ejson_output_file, ejson_file
+        end
+      end
+    else
+      raise "Unknown ejson_deploy_mode: #{ejson_deploy_mode.inspect}"
     end
   end
 
-  after 'deploy:updated', 'ejson:upload_config_files'
+  after 'deploy:updated', 'ejson:upload_config_file'
 end
 
 namespace :load do
   task :defaults do
-    set :ejson_files, -> { Dir["**/*.ejson"] }
+    set :ejson_file, 'config/secrets.ejson'
+    set :ejson_output_file, 'config/secrets.json'
+    set :ejson_deploy_mode, :local
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ejson
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Bouke van der Bijl