capistrano-figaro-yml 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acd8542d1af7042c405f56d0be4131db6d592f4b
+  data.tar.gz: 31e26c3b4feb60ec37de44795e4ada4750c3a490
+SHA512:
+  metadata.gz: a44198b2827828e484323955e26494ab9273b6695aab66300e905ed3aed119f6c6c50e8522a5f4cd44a734dd72dec3fe6e8688efabbc4e9efb32d27c6300149c
+  data.tar.gz: f516bec0959ac2d41c8e46cb5c86a3847ab98ceb704f16db4b6c4cddab81eb924f7d0573ad8faee28cce7f8ee4466b8dbdfee29ec0f59d3e748cd3ce590f4a6b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### v1.0.0, 2015-01-24
+- started the project
+- first working version

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2015 ChouAndy
+
+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,80 @@
+# Capistrano::FigaroYml
+
+Capistrano tasks for handling figaro `application.yml` when deploying Rails 4+ apps.
+
+### Install
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.2.1'
+      gem 'capistrano-figaro-yml', '~> 1.0.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+- make sure your local `config/application.yml` is not git tracked. It **should be on
+  the disk**, but gitignored.
+
+- populate production figaro settings in local `config/application.yml`:
+
+        production:
+          secret_key_base: "d6ced..."
+
+- add to `Capfile`:
+
+        require 'capistrano/figaro_yml'
+
+- create figaro `application.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 figaro file?
+
+- add it to local `config/application.yml`:
+
+        production:
+          secret_key_base: "d6ced..."
+          foobar: "some_other_secret"
+
+- if you're working in a team where other people have the deploy rights, compare
+  you local `application.yml` with the one on the server. This is to ensure you
+  didn't miss an update.
+- copy to the server:
+
+        $ bundle exec cap production setup
+
+- notify your colleagues that have the deploy rights that the remote
+  `application.yml` has been updated so they can change their copy.
+
+
+### How it works
+
+When you execute `$ bundle exec production setup`:
+
+- figaro settings from your local `application.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/application.yml`
+
+On deployment:
+
+- secrets file is automatically symlinked to `#{current_path}/config/application.yml`
+
+### Configuration
+
+None.
+
+### More Capistrano automation?
+
+Check out [capistrano-plugins](https://github.com/capistrano-plugins) github org.
+
+### License
+
+[MIT](LICENSE.md)

data/Rakefile

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

data/capistrano-figaro-yml.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/figaro_yml/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-figaro-yml"
+  gem.version       = Capistrano::FigaroYml::VERSION
+  gem.authors       = ["Chia-Hui Chou"]
+  gem.email         = ["chouandy625@gmail.com"]
+  gem.description   = <<-EOF.gsub(/^\s+/, "")
+    Capistrano tasks for automating figaro `application.yml` file handling for Rails 4+ apps.
+
+    This plugins syncs contents of your local figaro file and copies that to
+    the remote server.
+  EOF
+  gem.summary       = "Capistrano tasks for automating figaro `application.yml` file handling for Rails 4+ apps."
+  gem.homepage      = "https://github.com/ChouAndy/capistrano-figaro-yml"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'capistrano', '~> 3.1'
+  gem.add_runtime_dependency 'sshkit', '~> 1.2', '>= 1.2.0'
+
+  gem.add_development_dependency 'rake', '~> 0'
+end

data/lib/capistrano/figaro_yml.rb

@@ -0,0 +1,3 @@
+require "capistrano/figaro_yml/paths"
+require "capistrano/figaro_yml/helpers"
+load File.expand_path("../tasks/figaro_yml.rake", __FILE__)

data/lib/capistrano/figaro_yml/helpers.rb

@@ -0,0 +1,49 @@
+require "yaml"
+
+module Capistrano
+  module FigaroYml
+    module Helpers
+
+      def local_figaro_yml(env)
+        @local_figaro_yml ||= YAML.load_file(figaro_yml_local_path)
+        @local_figaro_yml[env]
+      end
+
+      def figaro_yml_env
+        fetch(:figaro_yml_env).to_s
+      end
+
+      def figaro_yml_content
+        { figaro_yml_env => local_figaro_yml(figaro_yml_env) }.to_yaml
+      end
+
+      # error helpers
+
+      def check_git_tracking_error
+        puts
+        puts "Error - please remove '#{fetch(:figaro_yml_local_path)}' from git:"
+        puts
+        puts "    $ git rm --cached #{fetch(:figaro_yml_local_path)}"
+        puts
+        puts "and gitignore it:"
+        puts
+        puts "    $ echo '#{fetch(:figaro_yml_local_path)}' >> .gitignore"
+        puts
+      end
+
+      def check_config_present_error
+        puts
+        puts "Error - '#{figaro_yml_env}' config not present in '#{fetch(:figaro_yml_local_path)}'."
+        puts "Please populate it."
+        puts
+      end
+
+      def check_figaro_file_exists_error
+        puts
+        puts "Error - '#{fetch(:figaro_yml_local_path)}' file does not exists, and it's required."
+        puts
+      end
+
+    end
+  end
+end

data/lib/capistrano/figaro_yml/paths.rb

@@ -0,0 +1,17 @@
+require "pathname"
+
+module Capistrano
+  module FigaroYml
+    module Paths
+
+      def figaro_yml_local_path
+        Pathname.new fetch(:figaro_yml_local_path)
+      end
+
+      def figaro_yml_remote_path
+        shared_path.join fetch(:figaro_yml_remote_path)
+      end
+
+    end
+  end
+end

data/lib/capistrano/figaro_yml/version.rb

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

data/lib/capistrano/tasks/figaro_yml.rake

@@ -0,0 +1,60 @@
+include Capistrano::FigaroYml::Paths
+include Capistrano::FigaroYml::Helpers
+
+namespace :load do task :defaults do
+    set :figaro_yml_local_path, "config/application.yml"
+    set :figaro_yml_remote_path, "config/application.yml"
+    set :figaro_yml_env, -> { fetch(:rails_env) || fetch(:stage) }
+  end
+end
+
+namespace :figaro_yml do
+
+  task :check_figaro_file_exists do
+    next if File.exists?(figaro_yml_local_path)
+    check_figaro_file_exists_error
+    exit 1
+  end
+
+  task :check_git_tracking do
+    next unless system("git ls-files #{fetch(:figaro_yml_local_path)} --error-unmatch >/dev/null 2>&1")
+    check_git_tracking_error
+    exit 1
+  end
+
+  task :check_config_present do
+    next unless local_figaro_yml(figaro_yml_env).nil?
+    check_config_present_error
+    exit 1
+  end
+
+  desc "figaro `application.yml` file checks"
+  task :check do
+    invoke "figaro_yml:check_figaro_file_exists"
+    invoke "figaro_yml:check_git_tracking"
+    invoke "figaro_yml:check_config_present"
+  end
+
+  desc "Setup figaro `application.yml` file on the server(s)"
+  task setup: [:check] do
+    content = figaro_yml_content
+    on release_roles :all do
+      execute :mkdir, "-pv", File.dirname(figaro_yml_remote_path)
+      upload! StringIO.new(content), figaro_yml_remote_path
+    end
+  end
+
+  # Update `linked_files` after the deploy starts so that users'
+  # `figaro_yml_remote_path` override is respected.
+  task :figaro_yml_symlink do
+    set :linked_files, fetch(:linked_files, []).push(fetch(:figaro_yml_remote_path))
+  end
+  after "deploy:started", "figaro_yml:figaro_yml_symlink"
+
+end
+
+desc "Server setup tasks"
+task :setup do
+  invoke "secrets_yml:setup"
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-figaro-yml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chia-Hui Chou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !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 tasks for automating figaro `application.yml` file handling for Rails 4+ apps.
+  This plugins syncs contents of your local figaro file and copies that to
+  the remote server.
+email:
+- chouandy625@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-figaro-yml.gemspec
+- lib/capistrano-figaro-yml.rb
+- lib/capistrano/figaro_yml.rb
+- lib/capistrano/figaro_yml/helpers.rb
+- lib/capistrano/figaro_yml/paths.rb
+- lib/capistrano/figaro_yml/version.rb
+- lib/capistrano/tasks/figaro_yml.rake
+homepage: https://github.com/ChouAndy/capistrano-figaro-yml
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for automating figaro `application.yml` file handling for
+  Rails 4+ apps.
+test_files: []