capistrano-safe-deploy-to 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f76c0eef83bde034164be33283e133d5f25006b
+  data.tar.gz: 4cdbfdb575c7a26e0f5cc510607359225440c37f
+SHA512:
+  metadata.gz: bbebe4775b6cacd8dda20e314f81915de4ea15b60b15afcb29f5e9caaee72ce6f78ef1eb5f230d59fafe906ceb7d32038b3aa79bdf8d9676c05bcbb2274650ce
+  data.tar.gz: 05b0d52f46b6f13da465e9c6bf8ab272639b4bce4d2d9ad48c58636bc541e0ef196de6482b9821cb4110675081c73105dc83b40f7122f66449ccd200f14c9acd

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+*.rbc
+.bundle

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
+
+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,66 @@
+# Capistrano::SafeDeployTo
+
+A simple Capistrano plugin that:
+- ensures the deployment directory exists on the server
+- ensures proper deployment directory ownership
+
+With this, your deployment should **never fail** because you forgot to create a
+deployment directory for your new app on the server.
+
+Works with Capistrano 3. Does **not work** with Capistrano 2.
+
+### About
+
+You set a Capistrano deployment directory with a `deploy_to` setting. By default
+the value of `deploy_to` is `"/var/www/#{app_name}"`.
+
+Your first deploy will **fail** if the `deploy_to` directory does not exist,
+you're not deploying as `root` and your deploy user does not have rights to
+create a deploy directory.
+
+And yes, deployment to default `deploy_to` directory **will most likely fail**.
+
+That is easy to fix, right? A quick:
+- `ssh yourserver`
+- `sudo mkdir -p /var/www/app_name`
+- `sudo chown deploy:deploy /var/www/app_name`
+
+Except that is painful, unnecessary and I refuse to manually `ssh` to the
+server to deploy apps!
+
+There are other solutions to this problem (Chef, Ansible), but if you'd like to
+solve it via Capistrano, read on.
+
+### Usage
+
+Install with:
+
+    gem 'capistrano', '~> 3.1'
+    gem 'capistrano-safe-deploy-to'
+
+then:
+
+    $ bundle install
+
+and then add to `Capfile`:
+
+    require 'capistrano/safe_deploy_to'
+
+And you're done. `$ bundle exec cap production deploy` should just work!
+(or at least it won't fail because directories don't exist).
+
+There are no configuration options (thank God!)
+
+### How it works
+
+`capistrano-safe-deploy-to` hooks to `before 'deploy:check'` task. It:
+1. creates s `deploy_to` directory with `sudo mkdir -p <your_deploy_dir>`
+2. gives proper ownership to deploy dir with
+`sudo chown <deploy_user>:<deploy_user_group> <your_deploy_dir>`
+
+It's simple, but you don't have to do or think about it. Let the computers
+slave for you!
+
+### License
+
+[MIT](LICENSE.md)

data/Rakefile

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

data/capistrano-safe-deploy-to.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/safe_deploy_to/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-safe-deploy-to"
+  gem.version       = Capistrano::SafeDeployTo::VERSION
+  gem.authors       = ["Bruno Sutic"]
+  gem.email         = ["bruno.sutic@gmail.com"]
+  gem.description   = "Capistrano plugin that ensures the `deploy_to` deployment path exists and has the right permissions."
+  gem.summary       = "Capistrano plugin that ensures the `deploy_to` deployment path exists and has the right permissions."
+  gem.homepage      = "https://github.com/bruno-/capistrano-safe-deploy-to"
+
+  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_dependency "capistrano", ">= 3.0"
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/safe_deploy_to.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/safe_deploy_to.rake", __FILE__)

data/lib/capistrano/safe_deploy_to/version.rb

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

data/lib/capistrano/tasks/safe_deploy_to.rake

@@ -0,0 +1,30 @@
+namespace :load do
+  task :defaults do
+    set :safe_deploy_to_owner, nil
+    set :safe_deploy_to_path, -> { fetch(:deploy_to) }
+  end
+end
+
+namespace :safe_deploy_to do
+  task :create do
+    on roles :all do
+      sudo :mkdir, '-pv', fetch(:safe_deploy_to_path)
+    end
+  end
+
+  task ensure_owner: [:create] do
+    on roles :all do
+      unless fetch(:safe_deploy_to_owner)
+        user = capture :id, '-un'
+        group = capture :id, '-gn'
+        set :safe_deploy_to_owner, "#{user}:#{group}"
+      end
+      sudo :chown, fetch(:safe_deploy_to_owner), fetch(:safe_deploy_to_path)
+    end
+  end
+
+  desc "Ensures deploy_to directory exists and has the right owner"
+  task ensure: [:create, :ensure_owner]
+end
+
+before "deploy:check", "safe_deploy_to:ensure"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-safe-deploy-to
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bruno Sutic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-22 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: 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 plugin that ensures the `deploy_to` deployment path exists
+  and has the right permissions.
+email:
+- bruno.sutic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-safe-deploy-to.gemspec
+- lib/capistrano-safe-deploy-to.rb
+- lib/capistrano/safe_deploy_to.rb
+- lib/capistrano/safe_deploy_to/version.rb
+- lib/capistrano/tasks/safe_deploy_to.rake
+homepage: https://github.com/bruno-/capistrano-safe-deploy-to
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin that ensures the `deploy_to` deployment path exists and
+  has the right permissions.
+test_files: []