capistrano-file-permissions 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Peter Mitchell (peterjmit@gmail.com)
+
+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,75 @@
+# Capistrano::FilePermissions
+
+File permissions handling for Capistrano v3.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.0.0'
+gem 'capistrano-file-permissions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-file-permissions
+
+## Usage
+
+Require the module in your `Capfile`:
+
+```ruby
+require 'capistrano/file-permissions'
+```
+
+Set the (relative) paths to the files you want to be handled during deployment,
+and optionally add a user to give access.
+
+```ruby
+set :file_permissions_paths, ["app/logs", "app/cache"]
+set :file_permissions_users, ["www-data"]
+```
+
+### Acl
+
+Add the acl task to the deployment flow
+
+```ruby
+before "deploy:updated", "deploy:set_permissions:acl"
+```
+
+Assume `app/logs` is a shared directory, and `app/cache` is part of the normal
+release, this gem would execute the following:
+
+```
+[..] setfacl -m u:www-data:rwx,u:<deploy-user>:rwx <path-to-app>/shared/app/logs <path-to-app>/<release>/app/cache
+```
+
+### Other tasks
+* deploy:set_permissions:chmod
+* deploy:set_permissions:chgrp
+
+### Configuration
+
+The gem makes the following configuration variables available (shown with defaults)
+
+```ruby
+set :file_permissions_roles, :all
+set :file_permissions_paths, []
+set :file_permissions_users, []
+set :file_permissions_groups, []
+set :file_permissions_chmod_mode, "0777"
+```
+
+## 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-file-permissions.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-file-permissions'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Peter Mitchell']
+  spec.email         = ['peterjmit@gmail.com']
+  spec.description   = %q{File permissions management for Capistrano 3.x}
+  spec.summary       = %q{File permissions management for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/peterjmit/capistrano-file-permissions'
+  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.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/file-permissions.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/file-permissions.rake', __FILE__)

data/lib/capistrano/tasks/file-permissions.rake

@@ -0,0 +1,86 @@
+module Capistrano
+  class FileNotFound < StandardError
+  end
+end
+
+def absolute_writable_paths
+  linked_dirs = fetch(:linked_dirs)
+  fetch(:file_permissions_paths).map do |d|
+    linked_dirs.include?(d) ? shared_path.join(d) : release_path.join(d)
+  end
+end
+
+def acl_entries(items, type = 'u', permissions = 'rwx')
+  items.map { |item| "#{type}:#{item}:#{permissions}" }
+end
+
+namespace :deploy do
+  namespace :set_permissions do
+    task :check do
+      on roles fetch(:file_permissions_roles) do
+        absolute_writable_paths.each do |path|
+          unless test "[ -d #{path} ]" or test "[ -e #{path} ]"
+            msg = "Cannot change permissions: #{path} is not a file or directory"
+            error msg
+            fail Capistrano::FileNotFound, msg
+          end
+        end
+      end
+    end
+
+    desc "Set user/group permissions on configured paths with setfacl"
+    task :acl => [:check] do
+      next unless any? :file_permissions_paths
+      on roles fetch(:file_permissions_roles) do |host|
+        users = fetch(:file_permissions_users).push(host.user)
+        entries = acl_entries(users);
+        paths = absolute_writable_paths
+
+        if any? :file_permissions_groups
+          entries.push(*acl_entries(fetch(:file_permissions_groups), 'g'))
+        end
+
+        entries = entries.join(',')
+
+        execute :setfacl, "-m", entries, *paths
+        execute :setfacl, "-dm", entries, *paths
+      end
+    end
+
+    desc "Recursively set mode (from \"file_permissions_chmod_mode\") on configured paths with chmod"
+    task :chmod => [:check] do
+      next unless any? :file_permissions_paths
+      on roles fetch(:file_permissions_roles) do |host|
+        execute :chmod, "-R", fetch(:file_permissions_chmod_mode), *absolute_writable_paths
+      end
+    end
+
+    desc "Recursively change group ownership for configured paths, and make them group writable"
+    task :chgrp => [:check] do
+      next unless any? :file_permissions_paths
+      next unless any? :file_permissions_groups
+
+      groups = fetch(:file_permissions_groups)
+      if groups.length > 1
+        warn "More than one group configured, using the first group only"
+      end
+
+      on roles fetch(:file_permissions_roles) do |host|
+        paths = absolute_writable_paths
+        execute :sudo, :chgrp, "-R", groups.first, *paths
+        # make sure all child directories inherit group writable
+        execute :sudo, :chmod, "-R", "g+rws", *paths
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :file_permissions_roles, :all
+    set :file_permissions_paths, []
+    set :file_permissions_users, []
+    set :file_permissions_groups, []
+    set :file_permissions_chmod_mode, "0777"
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-file-permissions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: File permissions management for Capistrano 3.x
+email:
+- peterjmit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-file-permissions.gemspec
+- lib/capistrano-file-permissions.rb
+- lib/capistrano/file-permissions.rb
+- lib/capistrano/tasks/file-permissions.rake
+homepage: https://github.com/peterjmit/capistrano-file-permissions
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: File permissions management for Capistrano 3.x
+test_files: []