capistrano-overrides 0.0.1

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+default.vim

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maher Hawash
+
+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,61 @@
+# Capistrano::Overrides
+
+Provides tasks to copy override configuration files for different stages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-overrides'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-overrides
+
+## Usage
+
+### 1. Copying and decrypting secure tokens (encrypted files)
+#### 1.1 Usage
+```ruby
+bundle exec cap production deploy:update_secure_overrides
+```
+* The current state of the gem assumes that your encrypted files are:
+	* In `config/overrides/production`
+	* They have an `asc` extension; e.g., `key.txt.asc`
+* The task first checks whether the `asc` file has changed since the last deploy (using checksums) and only decrypt the `asc` file if the file has changed.
+* It will ask for password during deploy, decrypt the file in memory, and place it in `{shared_path}/config/key.txt`
+
+#### 1.1 Setup of encrypted file
+Encrypt the file `key.txt` using a `symmetric cipher (-c)` and place it in `key.txt.asc (-o)`
+```ruby
+gpg -a -c -o key.txt.asc key.txt
+
+```
+
+### 2. Copying override files for different stages.
+####2.1 Usage
+```ruby
+bundle exec cap production deploy:copy_stage_configs
+```
+* Setup your folder structure as follows:
+
+```
+/config/overrides/
+				 /staging/*
+				 /production/*
+				 /alpha/*
+```
+* Upon deploy of the `stage`, all the files in the `stage` folder will be copied in `/config` and overwrite any files with the same name in that folder.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/capistrano-overrides/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/Rakefile

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

data/capistrano-overrides.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/overrides/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-overrides"
+  spec.version       = Capistrano::Overrides::VERSION
+  spec.authors       = ["Maher Hawash", "Dave Miller"]
+  spec.email         = ["mhawash@renewfund.com", "dave.miller@renewfund.com"]
+  spec.summary       = %q{Capistrano stage configuration overrides.}
+  spec.description   = %q{Capistrano stage configuration overrides.}
+  spec.homepage      = ""
+  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 "gpgme", '~> 2.0'
+
+end

data/lib/capistrano/overrides.rb

@@ -0,0 +1,3 @@
+require "capistrano/overrides/version"
+
+Dir[File.expand_path("../tasks/*.rake", __FILE__)].each { |file| load file }

data/lib/capistrano/overrides/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Overrides
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano/tasks/overrides.rake

@@ -0,0 +1,14 @@
+namespace :deploy do
+  desc 'Copy Stage specific configs into place'
+  task :copy_overrides do
+    on roles(:app), :only => { :primary => true } do
+      within release_path do
+        source = "#{release_path}/config/overrides/#{fetch(:stage)}"
+        target = "#{release_path}/config"
+        execute %Q([ -d #{source} ] && cp -R #{source}/* #{target} || true)
+      end
+    end
+  end
+end
+
+before "deploy:copy_overrides", "deploy:copy_secure_overrides"

data/lib/capistrano/tasks/secure.rake

@@ -0,0 +1,53 @@
+require 'gpgme'
+# Note: to encrypt the file after a change use the command line:
+# gpg -a -c -o config/overrides/#{stage}/filename.yml.asc config/overrides/#{stage}/filename.yml
+
+namespace :deploy do
+  desc "update encrypted files in `stage` overrides, if necessary, and link"
+  task :copy_secure_overrides do
+    on roles(:all) do
+      stage = fetch(:stage)
+      Dir.glob(deploy_config_path.expand_path.dirname.join('overrides',stage.to_s,'*.asc')).each do |local_encrypted_file|
+        filename = File.split(local_encrypted_file).last.chomp('.asc')
+        remote_encrypted_file = "#{shared_path}/config/#{filename}.asc"
+        remote_plaintext_file = "#{shared_path}/config/#{filename}"
+        remote_override_file  = "#{release_path}/config/overrides/#{stage}/#{filename}"
+        if chksums_differ?(local_encrypted_file, remote_encrypted_file)
+          plaintext = decrypt(local_encrypted_file)
+          execute "mkdir -p '#{shared_path}/config'"
+          upload! local_encrypted_file, remote_encrypted_file
+          upload! StringIO.new(plaintext), remote_plaintext_file
+          execute "chmod 600 #{remote_plaintext_file}"
+        end
+        execute "mkdir -p '#{release_path}/config/overrides/#{stage}'"
+        execute "/bin/ln -nsf #{remote_plaintext_file} #{remote_override_file}"
+        execute "rm -f #{remote_override_file}.asc"
+      end
+    end 
+  end
+end
+
+def decrypt(local_encrypted_file)
+  got_it = false
+  while not got_it
+    begin
+      print "\nPlease enter the passphrase to decrypt %s: " % File.split(local_encrypted_file).last
+      password = $stdin.noecho(&:gets).chomp
+      crypto = GPGME::Crypto.new(:password => password)
+      data = crypto.decrypt File.read(local_encrypted_file)
+      plaintext = data.read
+      got_it = true
+    rescue GPGME::Error::DecryptFailed
+      puts "\nInvalid Password, decryption failed"
+      puts
+    end
+  end
+  plaintext
+end
+
+def chksums_differ?(local,remote)
+  local_hasher   = system('which','sha1sum') ? 'sha1sum' : 'shasum'
+  local_chksum   = `#{local_hasher} "#{local}"`.split(' ').first
+  remote_chksum  = capture("[ -f #{remote} ] && sha1sum #{remote} || true").split(' ').first || 'file_not_found'
+  local_chksum != remote_chksum
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-overrides
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maher Hawash
+- Dave Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Capistrano stage configuration overrides.
+email:
+- mhawash@renewfund.com
+- dave.miller@renewfund.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-overrides.gemspec
+- lib/capistrano/overrides.rb
+- lib/capistrano/overrides/version.rb
+- lib/capistrano/tasks/overrides.rake
+- lib/capistrano/tasks/secure.rake
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2059193147161923779
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2059193147161923779
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Capistrano stage configuration overrides.
+test_files: []