capistrano-simple-permissions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2609529d7ff410333fa821951894f3faa8742e3584b520f287b25cd324bd389
+  data.tar.gz: 3fbb64452c686899b882f1d9dc6ece667b006e0c5e4f9bf055ba5a4fbf550e95
+SHA512:
+  metadata.gz: 5ed3fb416c844f5eeff2367bdcb63987ce2b111e6fe31278b130701e8aa5b38ee9f505fe6b920b5e4e48dccb8ef2bdf79ae131b1d6c976d966547ea2f880b1d8
+  data.tar.gz: 2854e0bd8e11d2bd800b7222e32d2ad579989a6eb2d66e82605fe2b05dfb954ad34b0f85c0d3b29e95cca93cf5c4a24d302b8c1c10adb61be00f597a1747ecdd

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor/ruby
+.idea

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+### master
+
+### v0.1.0, 2019-03-06
+
+- Initial version

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 DaMoo
+
+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,71 @@
+# Capistrano::SimplePermissions
+
+Capistrano task for ensuring specific permissions (including owner and group) on files and folders on deploy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-simple-permissions'
+```
+
+Then add it to your `Capfile`:
+
+```ruby
+require 'capistrano/simple_permissions'
+```
+
+And then:
+
+```sh
+$ bundle install
+```
+
+## How it works
+
+This gem hooks into Capistrano's deploy process by executing several `chmod` and `chown` commands after the
+`deploy:log_revision` portion of Capistrano's [flow](https://capistranorb.com/documentation/getting-started/flow/). See
+the source for more details.
+
+## Options
+
+- ```ruby
+    set :permissions_folders, []
+  ```
+
+  - Sets the folders that should be recursively affected by both `chmod` and `chown`. A sensible setting to use would be
+    `set :permissions_folders, [fetch(:deploy_to)]` in your `deploy.rb`
+
+- ```ruby
+  set :chmod_folder_permissions, "775"
+  ```
+
+  - Sets the permissions for folders that `chmod` will affect
+
+- ```ruby
+  set :chmod_file_permissions, "664"
+  ```
+
+  - Sets the permissions for files that `chmod` will affect
+
+- ```ruby
+  set :chown_owner, ""
+  ```
+
+  - Sets the owner of the files for `chown`. Note that the command isn't run as root so changing this to anything other
+    than the default of `""` might cause errors unless your deploy user has the correct permissions.
+
+- ```ruby
+  set :chown_group, "web"
+  ```
+
+  - Sets the group of the files for `chown`.
+
+## Contributing
+
+Bug reports and pull requests are welcome!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/capistrano-simple-permisions.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/simple_permissions/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-simple-permissions"
+  spec.version       = Capistrano::SimplePermissions::VERSION
+  spec.authors       = ["DaMoo"]
+  spec.email         = ["git@damoo.zone"]
+
+  spec.summary       = %q{Capistrano task for ensuring specific permissions on files and folders on deploy.}
+  spec.homepage      = "https://github.com/da-moo/capistrano-simple-permissions"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 3.11"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/simple_permissions.rb

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

data/lib/capistrano/simple_permissions/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module SimplePermissions
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/capistrano/tasks/simple_permissions.rake

@@ -0,0 +1,24 @@
+namespace :load do
+  task :defaults do
+    set :permissions_folders, []
+    set :chmod_folder_permissions, "775"
+    set :chmod_file_permissions, "664"
+    set :chown_owner, ""
+    set :chown_group, "web"
+  end
+end
+
+namespace :deploy do
+  namespace :simple_permissions do
+
+    task :set_permissions do
+      on roles(:web) do
+        execute :find, *fetch(:permissions_folders), '-type', :d, '-exec', :chmod, fetch(:chmod_folder_permissions), '{}', '\\;'
+        execute :find, *fetch(:permissions_folders), '-type', :f, '-exec', :chmod, fetch(:chmod_file_permissions), '{}', '\\;'
+        execute :chown, '-R', "#{fetch(:chown_owner)}:#{fetch(:chown_group)}", *fetch(:permissions_folders)
+      end
+    end
+  end
+end
+
+after "deploy:log_revision", "deploy:simple_permissions:set_permissions"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-simple-permissions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DaMoo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-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.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- git@damoo.zone
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-simple-permisions.gemspec
+- lib/capistrano/simple_permissions.rb
+- lib/capistrano/simple_permissions/version.rb
+- lib/capistrano/tasks/simple_permissions.rake
+homepage: https://github.com/da-moo/capistrano-simple-permissions
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Capistrano task for ensuring specific permissions on files and folders on
+  deploy.
+test_files: []