capistrano-secrets-generate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41ee61b439747eddd49dd8c2f82936f9f0d000dc
+  data.tar.gz: db75248b4689fe90cee52546b3d3e0531249a6e3
+SHA512:
+  metadata.gz: 7daeee58fb6602908511d48823770389132bc525167c26e167afbe84849fc008da77873d2c01e6c5732f58437efc8bad921797f1a8b18a18b96b13cda515e598
+  data.tar.gz: 8d2781ff694274c0cd5ff009adf31b7a79dcdd5863b8a69bc7495a8b067d43dcaade5bd90fcffce217f5058170ae2413c2675b8032015887e20c71e5fb96ad68

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2017 Mike Crockett
+
+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,40 @@
+# Capistrano::SecretsGenerate
+
+Capistrano tasks for handling generating a `secret.token` when deploying Rails 4+ apps.
+
+### Install
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.2.1'
+      gem 'capistrano-secrets-generate', '~> 1.0.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+- make secret.yml load file `config/secret.token`:
+
+        production: &production
+          <% if ((false == Rails.env.test?) && (false == Rails.env.development?)) %>
+            secret_key_base: <%= File.read(File.join(Rails.application.config.root, "config", "secret.token")) %>
+          <% end %>
+
+- add to `Capfile`:
+
+        require 'capistrano/secrets_generate'
+
+You can now proceed with other deployment tasks.
+
+### How it works
+
+On deployment:
+
+- we look for `secret.token` file on the server shared dir<br/>
+- if it exists, we add to linked files<br/>
+- if not we look for file in current deployment, if it exists, we copy to shared and add to linked<br/>
+- if nothing exists, then we use `rake secret` to create a new secret.<br/>

data/Rakefile

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

data/capistrano-secrets-generate.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/secrets_generate/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-secrets-generate"
+  gem.version       = Capistrano::SecretsGenerate::VERSION
+  gem.authors       = ["Mike Crockett"]
+  gem.email         = ["rubygems@mmcrockett.com"]
+  gem.description   = <<-EOF.gsub(/^\s+/, "")
+    Capistrano tasks for automating generating or linking a secret in Rails 4+.
+
+    This plugin generates a secret if one doesn't exist on a remote server.
+
+    If a secret is already found on remote server, then it copies to shared
+    location and links.
+  EOF
+  gem.summary       = "Capistrano tasks for automating generating/linking a secret."
+  gem.homepage      = "https://github.com/mmcrockett/capistrano-secrets-generate"
+
+  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.licenses      = ['MIT']
+
+  gem.add_dependency "capistrano", "~> 3.1"
+  gem.add_development_dependency "rake", "~> 0"
+end

data/lib/capistrano/secrets_generate/helpers.rb

@@ -0,0 +1,6 @@
+module Capistrano
+  module SecretsGenerate
+    module Helpers
+    end
+  end
+end

data/lib/capistrano/secrets_generate/paths.rb

@@ -0,0 +1,23 @@
+require "pathname"
+
+module Capistrano
+  module SecretsGenerate
+    module Paths
+      def secret_token_path
+        return Pathname.new(fetch(:secret_file))
+      end
+
+      def secret_token_linked_path
+        return shared_path.join(secret_token_path)
+      end
+
+      def secret_token_linked_dir
+        return secret_token_linked_path.join('..')
+      end
+
+      def secret_token_current_path
+        return current_path.join(secret_token_path)
+      end
+    end
+  end
+end

data/lib/capistrano/secrets_generate/version.rb

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

data/lib/capistrano/secrets_generate.rb

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

data/lib/capistrano/tasks/secrets_generate.rake

@@ -0,0 +1,48 @@
+include Capistrano::SecretsGenerate::Paths
+include Capistrano::SecretsGenerate::Helpers
+
+namespace :load do task :defaults do
+    set(:secret_file, File.join("config", "secret.token"))
+  end
+end
+
+namespace :secrets_generate do
+  desc "Generate `secret.token` if none exists, otherwise copy and append to soft-link list."
+  task :check_secret do
+    on release_roles :all do
+      secret_token_linked_exists  = test("[ -f #{secret_token_linked_path} ]")
+      secret_token_current_exists = test("[ -f #{secret_token_current_path} ]")
+
+      if ((false == secret_token_current_exists) && (false == secret_token_linked_exists))
+        after("deploy:published", "secrets_generate:generate_secret")
+      else
+        if (true == secret_token_current_exists)
+          if (false == test("[ -d #{secret_token_linked_dir} ]"))
+            execute(:mkdir, secret_token_linked_dir)
+          end
+
+          execute(:cp, secret_token_current_path, secret_token_linked_path)
+        end
+
+        append(:linked_files, secret_token_path)
+      end
+    end
+  end
+
+  desc "Use rake to generate new secret."
+  task :generate_secret do
+    on release_roles :all do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          # Test that it works so we don't create bad file and it shows error.
+          execute(:rake, 'secret')
+
+          # Now run for real
+          execute(:rake, 'secret', '>', secret_token_path)
+        end
+      end
+    end
+  end
+end
+
+before("deploy:check:linked_files", "secrets_generate:check_secret")

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-secrets-generate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Crockett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-06 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: 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 generating or linking a secret in Rails 4+.
+  This plugin generates a secret if one doesn't exist on a remote server.
+  If a secret is already found on remote server, then it copies to shared
+  location and links.
+email:
+- rubygems@mmcrockett.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-secrets-generate.gemspec
+- lib/capistrano/capistrano-secrets-generate.rb
+- lib/capistrano/secrets_generate.rb
+- lib/capistrano/secrets_generate/helpers.rb
+- lib/capistrano/secrets_generate/paths.rb
+- lib/capistrano/secrets_generate/version.rb
+- lib/capistrano/tasks/secrets_generate.rake
+homepage: https://github.com/mmcrockett/capistrano-secrets-generate
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for automating generating/linking a secret.
+test_files: []