capistrano-master-key 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97629d569521ff07823c184db72810db16ed8ac5273f4caf7ffcb17117b6b6b2
+  data.tar.gz: abe35f10f5cd65de426c5bc959ed5318ebcc048505862369d52b599c708ad06e
+SHA512:
+  metadata.gz: f92c4558867ba744888ccb882d6eee2e7870e1d72c9d22c84c104dac665ceeffedbe1b6073dedf06cdb23bea6e292bc060cd4d514a07e347e0daebfd330e3c0d
+  data.tar.gz: fb9f2a2f3ef9fafb6489119d268ac1a2812595f15b7830a389c2ee18068f42d577a4fe8496ad41a423d9bbacdf5e42a2fd182921fe50664250c7977bffad0f6a

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### First Fork from capistrano-secrets.yml -> capistrano-master-key
+- v1.0.2 working for our use case
+

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2014 Bruno Sutic, 2018 Virgoproz
+
+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,35 @@
+# Capistrano:MasterKey
+
+Capistrano tasks for handling `master.key` when deploying Rails 5.2+ apps.
+
+### Install
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.11.0'
+      gem 'capistrano-master-key', '~> 1.0.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+- Make sure your local `config/master.key` is not git tracked. It **should be on
+  the disk**, but gitignored.
+
+- Add to `Capfile`:
+
+        require 'capistrano/master_key'
+
+- Add your master_key_local_path setting to your deploy.rb file (or wherever you need if you have multi-repo setup)
+
+    `set :master_key_local_path, "/home/myname/mycode/repo_path/config/master.key"
+
+- You will have now a working master_key:setup
+
+### License
+
+[MIT](LICENSE.md)

data/Rakefile

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

data/capistrano-master-key.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/master_key/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'capistrano-master-key'
+  gem.version       = Capistrano::MasterKey::VERSION
+  gem.authors       = ['Bruno Sutic, Virgoproz']
+  gem.email         = ['bruno.sutic@gmail.com']
+  gem.description   = <<-EOF.gsub(/^\s+/, '')
+    Capistrano tasks for automating `master.key` file handling for Rails 5.2+ apps.
+
+    This plugins syncs contents of your local master key and copies that to
+    the remote server.
+  EOF
+  gem.summary       = 'Capistrano tasks for automating `master.key` file handling for Rails 5.2+ apps.'
+  gem.homepage      = 'https://github.com/virgoproz/capistrano-master-key'
+
+  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.license       = 'MIT'
+
+  gem.add_dependency 'capistrano', '~> 3.11'
+  gem.add_dependency 'sshkit', '~> 1.17'
+
+  gem.add_development_dependency 'rake', '~> 12.3'
+end

data/lib/capistrano-master-key.rb

@@ -0,0 +1 @@
+

data/lib/capistrano/master_key.rb

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

data/lib/capistrano/master_key/helpers.rb

@@ -0,0 +1,40 @@
+require "yaml"
+
+module Capistrano
+  module MasterKey
+    module Helpers
+
+      def master_key_env
+        fetch(:master_key_env).to_s
+      end
+
+      # error helpers
+      def check_git_tracking_error
+        puts
+        puts "Error - please remove '#{fetch(:master_key_local_path)}' from git:"
+        puts
+        puts "    $ git rm --cached #{fetch(:master_key_local_path)}"
+        puts
+        puts "and gitignore it:"
+        puts
+        puts "    $ echo '#{fetch(:master_key_local_path)}' >> .gitignore"
+        puts
+      end
+
+      def check_config_present_error
+        puts
+        puts "Error - '#{master_key_env}' config not present in '#{fetch(:master_key_local_path)}'."
+        puts "Please populate it."
+        puts
+      end
+
+      def check_master_file_exists_error
+        puts
+        puts "Error - '#{fetch(:master_key_local_path)}' file does not exists, and it's required."
+        puts
+      end
+
+    end
+  end
+end
+

data/lib/capistrano/master_key/paths.rb

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

data/lib/capistrano/master_key/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module MasterKey
+    VERSION = '1.0.2'
+  end
+end

data/lib/capistrano/tasks/master_key.rake

@@ -0,0 +1,47 @@
+include Capistrano::MasterKey::Paths
+include Capistrano::MasterKey::Helpers
+
+namespace :load do task :defaults do
+    set :master_key_local_path, 'config/master.key'
+    set :master_key_remote_path, 'config/master.key'
+    set :master_key_env, -> { fetch(:rails_env) || fetch(:stage) }
+  end
+end
+
+namespace :master_key do
+
+  task :check_master_file_exists do
+    next if File.exist?(master_key_local_path)
+    check_master_file_exists_error
+    exit 1
+  end
+
+  task :check_git_tracking do
+    next unless system("git ls-files #{fetch(:master_key_local_path)} --error-unmatch >/dev/null 2>&1")
+    check_git_tracking_error
+    exit 1
+  end
+
+  desc "master.key file checks"
+  task :check do
+    raise(":deploy_to in your app/config/deploy/\#{environment}.rb file cannot contain ~") if shared_path.to_s.include?('~') # SCP doesn't support ~ in the path
+    invoke "master_key:check_master_file_exists"
+    invoke "master_key:check_git_tracking"
+  end
+
+  desc "Setup `master.key` file on the server(s)"
+  task setup: [:check] do
+    on release_roles :all do
+      execute :mkdir, "-pv", File.dirname(master_key_remote_path)
+      Net::SCP.upload!(self.host.hostname, fetch(:user), StringIO.new(File.read(master_key_local_path)), master_key_remote_path)
+    end
+  end
+
+  # Update `linked_files` after the deploy starts so that users'
+  # `master_key_remote_path` override is respected.
+  task :master_key_symlink do
+    set :linked_files, fetch(:linked_files, []).push(fetch(:master_key_remote_path))
+  end
+  after "deploy:started", "master_key:master_key_symlink"
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-master-key
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Bruno Sutic, Virgoproz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: |
+  Capistrano tasks for automating `master.key` file handling for Rails 5.2+ apps.
+  This plugins syncs contents of your local master key and copies that to
+  the remote server.
+email:
+- bruno.sutic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-master-key.gemspec
+- lib/capistrano-master-key.rb
+- lib/capistrano/master_key.rb
+- lib/capistrano/master_key/helpers.rb
+- lib/capistrano/master_key/paths.rb
+- lib/capistrano/master_key/version.rb
+- lib/capistrano/tasks/master_key.rake
+homepage: https://github.com/virgoproz/capistrano-master-key
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Capistrano tasks for automating `master.key` file handling for Rails 5.2+
+  apps.
+test_files: []