capistrano-upload-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dde3a6365279fc68794a1c8cc8938d6b0f042373
+  data.tar.gz: c67453f9d0ffa572d0c23f01922396ba7b00919e
+SHA512:
+  metadata.gz: 6a99074b5c47f0fb34abc3525973a0474237d2566deea9d26f731fd8a852d8a86780ea1c740bc55f42f11031e6122e9e53c9ccc565bede8aaa9b1c2540c043ea
+  data.tar.gz: 81324123e0ff7512c6e634836ba9e977a4559977261cd9a53a0365d4dc6f2644a4b8ddad657e3478657054be45655603464e15c9c41e0b5cf226e926edb2c124

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Coleman
+
+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,133 @@
+# Capistrano-Upload-Config
+
+Upload, initialize and maintain configuration files for Capistrano 3.x outside of SCM.
+(or in SCM just different files for different stages - the choice is yours!)
+
+Say you're working in a small team on a Rails app, you've got a couple of environments and you have a `config/database.yml` that's got some secrets that differ per stage in it.
+You'd like to maintain these secrets outside of source control but placing a `config/database.yml` on the server manually makes you nervous. What happens if it's lost? Did you upload the right one? Chaos. Stress. Sad face.
+
+Capistrano-upload-config to the rescue. You can maintain a version of `config/database.yml` per stage, with different contents if you wish, keep these outside of your source control and still upload them without manual fiddling.
+
+Equally this could be used to manage many other text based configuration files and used if you're in a team or not.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.1.0'
+gem 'capistrano-upload-config'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install capistrano-upload-config`
+
+## Usage
+
+Require the module in your `Capfile`:
+
+```ruby
+require 'capistrano-upload-config'
+```
+
+`capistrano-upload-config` comes with 3 tasks:
+
+* `config:check`
+* `config:init`
+* `config:push`
+
+
+#### config:check
+
+This task checks to see if all your set configuration files exist for the current stage:
+
+```shell
+$ cap staging config:check
+ INFO Found: config/database.staging.yml
+ WARN Not found: config/example.staging.yml
+```
+
+
+#### config:init
+
+This creates the configured config files for the current stage if it doesn't already exist.
+Bonus: It copies from an example file if one exists.
+
+
+```shell
+$ cap staging config:init
+ WARN Already Exists: config/database.staging.yml
+ INFO Copied: config/example.yml-example to config/example.staging.yml
+ Created: config/foobar.staging.yml as empty file
+```
+
+
+#### config:push
+
+This task creates the config on the remote server.
+
+
+```shell
+$ cap staging config:init
+ WARN Already Exists: config/database.staging.yml
+ INFO Copied: config/example.yml-example to config/example.staging.yml
+ Created: config/foobar.staging.yml as empty file
+```
+
+Can be used during a deploy, If your `:config_files` and `:linked_files` are going to be the same I suggest hooking in before
+`deploy:starting` to that the config files exist before symlinks are created:
+
+```ruby
+# add to config/deploy.rb
+
+before 'deploy:starting', 'config:push'
+```
+
+
+### Configuration
+
+Configurable options, shown here with defaults:
+
+```ruby
+set :config_files, fetch(:linked_files)
+set :config_example_prefix, '-example'
+```
+
+By default your `:linked_files` are assumed to be config files, this might be totally wrong for your environment, never fear just:
+
+```ruby
+# in deploy.rb (or similar)
+
+set :config_files, %w{dir1/config.toml config/example.ini hidden/secrets.json}
+
+```
+
+Note, capistrano-upload-config can only upload confir to your shared folder (and it's sub directories) so it's likely that `:config_files` will be a subset of `:linked_files`.
+
+#### Example files
+
+Do you use example files checked into your source control? e.g. `config/database.yml-example`
+These will be used when running `config:init`. If your prefix differs, e.g. `config/database.yml.eg` set this as:
+
+```ruby
+# in deploy.rb (or similar)
+
+set :config_example_prefix, '.eg'
+
+```
+
+Note, only prefixes (i.e. after the whole filename) are supported.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-upload-config.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-upload-config'
+  spec.version       = '0.1.0'
+  spec.authors       = 'Robert Coleman'
+  spec.email         = 'github@robert.net.nz'
+  spec.description   = %q{Capistrano 3.x tasks to upload shared config that is stored outside of SCM}
+  spec.summary       = %q{Capistrano 3.x tasks to upload shared config that is stored outside of SCM}
+  spec.homepage      = 'https://github.com/rjocoleman/capistrano-upload-config'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'capistrano', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano-upload-config.rb

@@ -0,0 +1,18 @@
+load File.expand_path('../upload-config/tasks.rake', __FILE__)
+
+module CapistranoUploadConfig
+  class Helpers
+    class << self
+
+      def get_local_config_name(config, stage)
+        path = File.dirname(config)
+        extension = File.extname(config)
+        filename = File.basename(config, extension)
+        extension.sub!(/^\./, '')
+        local_file = [filename, stage, extension].join('.')
+        local_path = File.join(path, local_file)
+      end
+
+    end
+  end
+end

data/lib/upload-config/tasks.rake

@@ -0,0 +1,64 @@
+namespace :config do
+
+  desc 'Initialize local configuration files for each stage'
+  task :init do
+    run_locally do
+      fetch(:config_files).each do |config|
+        local_path = CapistranoUploadConfig::Helpers.get_local_config_name(config, fetch(:stage).to_s)
+        if File.exists?(local_path)
+          warn "Already Exists: #{local_path}"
+        else
+          example_prefix = fetch(:config_example_prefix, '')
+          if File.exists?("#{config}#{example_prefix}")
+            FileUtils.cp "#{config}#{example_prefix}", local_path
+            info "Copied: #{config}#{example_prefix} to #{local_path}"
+          else
+            File.open(local_path, "w") {}
+            info "Created: #{local_path} as empty file"
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Check local configuration files for each stage'
+  task :check do
+    run_locally do
+      fetch(:config_files).each do |config|
+        local_path = CapistranoUploadConfig::Helpers.get_local_config_name(config, fetch(:stage).to_s)
+        if File.exists?(local_path)
+          info "Found: #{local_path}"
+        else
+          warn "Not found: #{local_path}"
+        end
+      end
+    end
+  end
+
+  desc 'Push configuration to the remote server'
+  task :push do
+    on release_roles :all do
+      within shared_path do
+        fetch(:config_files).each do |config|
+          local_path = CapistranoUploadConfig::Helpers.get_local_config_name(config, fetch(:stage).to_s)
+          if File.exists?(local_path)
+            info "Uploading config #{local_path} as #{config}"
+            upload! StringIO.new(local_path), File.join(shared_path, config)
+          else
+            fail "#{local_path} doesn't exist"
+          end
+        end
+      end
+    end
+  end
+
+end
+
+namespace :load do
+  task :defaults do
+
+    set :config_files, -> { fetch(:linked_files) }
+    set :config_example_prefix, '-example'
+
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-upload-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Capistrano 3.x tasks to upload shared config that is stored outside of
+  SCM
+email: github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-upload-config.gemspec
+- lib/capistrano-upload-config.rb
+- lib/upload-config/tasks.rake
+homepage: https://github.com/rjocoleman/capistrano-upload-config
+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 3.x tasks to upload shared config that is stored outside of SCM
+test_files: []