capistrano-sumo 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b15ee4713f41f06b6adcc2680e500e2d50aa163
-  data.tar.gz: 3156f2070432d23a1316106b9ec16f6bd8843e48
+  metadata.gz: 0bf87dd89c5c2962bf76386a18b2fba63043c371
+  data.tar.gz: 272acb6133c86bb063d5aed37e2fcf07afd13ea5
 SHA512:
-  metadata.gz: 2d45d9bb7c080b1bce2df4e8a7add1a7437ae63a2ba442c720a911e53ecd65e6cf3c73ea109f80adc11a2dd16b409a913427f923e4fd415f4d8650b819483364
-  data.tar.gz: 4be0ac8b676c734c7dc453728ce5bdc2530d3fb46c3c81f6a37da119b39dcda3d82d28d27dd63d42107e9b1b6fe9c4b6d5fce8b48b54f96a98fbe1c9ff6de709
+  metadata.gz: c75aa34cf39b0a38691215bbdabc1e0e178ae1dfc77fb41b488c11f99c1a094bed72927a0adff9b9144c9940d5505992bc655dd123dd7df2684f4095f4d4e42b
+  data.tar.gz: e697d889c7c83186d99a6c4ef6e950eae3f08e3f6ba95196cc93e285ded2314f25585e317e58673d8fbac2cca94d80c3a2cb5668d42d9bac26e9d1aa6f080cfe

data/Gemfile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 group :development do
-    gem 'rake', '~> 12.0'
-    gem 'rspec', '~> 3.0'
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.0'
 end

data/README.md

@@ -22,13 +22,130 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+# Capistrano::Forkcms
 
-## Development
+Fork CMS specific Capistrano tasks
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Capistrano ForkCMS - Easy deployment of ForkCMS 5+ apps with Ruby over SSH.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-forkcms'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Require the module in your Capfile:
+
+    require "capistrano/sumo"
+    
+The plugin comes with some tasks:
+
+* `sumo:db:create`, which will create the database if it doesn't exists yet, works only on staging.
+* `sumo:db:get`, which will replace the local database with the remote database.
+* `sumo:db:info`, which will get info about the database, works only on staging.
+* `sumo:db:put`, which will replace the remote database with the local database.
+* `sumo:files:get`, which will downloads the remote files to the local instance.
+* `sumo:files:put`, which will upload the local files to the remote server.
+* `sumo:notifications:deploy`, which will notify our webhooks on a deploy.
+* `sumo:redirect:enable`, which will enable a redirect page, all traffic will be redirected to this page.
+
+But you won't need any of them as everything is wired automagically if you follow the steps below
+
+
+## Configuration
+
+Configuration options:
+
+...
+
+## How to use with a fresh Fork install
+
+1. Create a Capfile with the content below:
+
+```
+set :deploy_config_path, 'app/config/capistrano/deploy.rb'
+set :stage_config_path, 'app/config/capistrano/stages'
+
+require 'capistrano/setup'
+require 'capistrano/deploy'
+require 'capistrano/scm/git'
+install_plugin Capistrano::SCM::Git
+require 'capistrano/forkcms'
+require 'capistrano/sumo'
+require 'capistrano/deploytags'
+
+set :format_options, log_file: 'app/logs/capistrano.log'
+
+Dir.glob('app/config/capistrano/tasks/*.rake').each { |r| import r }
+```
+
+2. Create a file called `app/config/capistrano/deploy.rb`, with the content below:
+
+```
+set :client,  "$the-clients-name"
+set :project, "$the-project-name"
+set :repo_url, "$the-repo-url"
+set :production_url, "$the-production-url"
+
+### DO NOT EDIT BELOW ###
+set :application, "#{fetch :project}"
+
+set :deploytag_utc, false
+set :deploytag_time_format, "%Y%m%d-%H%M%S"
+
+set :files_dir, %w(src/Frontend/Files)
+```
+
+3. Create a file called `app/config/capistrano/stages/production.rb`, with the content below:
+
+```
+server "php71-001.sumohosting.be", user: "$production-user", roles: %w{app db web}
+
+set :document_root, "/home/$production-user/domains/$domain/public_html"
+set :deploy_to, "/home/$production-user/apps/#{fetch :project}"
+
+set :opcache_reset_strategy, "file"
+set :opcache_reset_base_url, "#{fetch :production_url}"
+
+### DO NOT EDIT BELOW ###
+set :keep_releases, 3
+set :php_bin, "php"
+
+SSHKit.config.command_map[:composer] = "#{fetch :php_bin} #{shared_path.join("composer.phar")}"
+SSHKit.config.command_map[:php] = fetch(:php_bin)
+```
+
+4. Create a file called `app/config/capistrano/stages/staging.rb`, with the content below:
+
+```
+
+### DO NOT EDIT BELOW ###
+set :branch, "staging"
+set :document_root, "/home/sites/php71/#{fetch :client}/#{fetch :project}"
+set :deploy_to, "/home/sites/apps/#{fetch :client}/#{fetch :project}"
+set :keep_releases,  2
+set :url, "http://#{fetch :project}.#{fetch :client}.php71.sumocoders.eu"
+set :fcgi_connection_string, "/var/run/php_71_fpm_sites.sock"
+set :php_bin, "php7.1"
+set :php_bin_custom_path, fetch(:php_bin)
+set :opcache_reset_strategy, "fcgi"
+set :opcache_reset_fcgi_connection_string, "/var/run/php_71_fpm_sites.sock"
+
+server "dev02.sumocoders.eu", user: "sites", roles: %w{app db web}
+
+SSHKit.config.command_map[:composer] = "#{fetch :php_bin} #{shared_path.join("composer.phar")}"
+SSHKit.config.command_map[:php] = fetch(:php_bin)
+```
 
 ## Contributing
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:test) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
 task :default => :test

data/capistrano-sumo.gemspec

@@ -4,22 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "capistrano/sumo/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "capistrano-sumo"
-  spec.version       = Capistrano::Sumo::VERSION
-  spec.authors       = ["Tijs Verkoyen"]
-  spec.email         = ["tijs@verkoyen.eu"]
+  spec.name = 'capistrano-sumo'
+  spec.version = Capistrano::Sumo::VERSION
+  spec.authors = ['Tijs Verkoyen']
+  spec.email = ['capistrano-sumo@verkoyen.eu']
 
-  spec.summary       = %q{Sumo specific task for Capistrano 3.x.}
-  spec.description   = %q{Sumo specific task for Capistrano 3.x.}
-  spec.homepage      = "https://github.com/tijsverkoyen/capistrano-sumo"
-  spec.license       = "MIT"
+  spec.summary = %q{SumoCoders specific task for Capistrano 3.x.}
+  spec.description = %q{SumoCoders specific task for Capistrano 3.x.}
+  spec.homepage = 'https://github.com/tijsverkoyen/capistrano-sumo'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+end

data/lib/capistrano/sumo/defaults.rb

@@ -1,6 +1,6 @@
-# Make sure the composer executable is installed
 namespace :deploy do
-  after :finished, "sumo:notifications:deploy"
+  # notify our bot about the deploy
+  after :finished, 'sumo:notifications:deploy'
 end
 
 # Load the tasks

data/lib/capistrano/sumo/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Sumo
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/capistrano/tasks/db.rake

@@ -1,9 +1,9 @@
 namespace :sumo do
   namespace :db do
-    desc "Create the database if it doesn't exists yet"
+    desc 'Create the database if it doesn\'t exists yet'
     task :create do
-      if fetch(:stage).to_s != "staging"
-        warn Airbrussh::Colors.red('✘') + " This task will only work on staging"
+      if fetch(:stage).to_s != 'staging'
+        warn Airbrussh::Colors.red('✘') + ' This task will only work on staging.'
         exit 1
       end
 
@@ -12,10 +12,10 @@ namespace :sumo do
       end
     end
 
-    desc "Get info about the database"
+    desc 'Get info about the database'
     task :info do
-      if fetch(:stage).to_s != "staging"
-        warn Airbrussh::Colors.red('✘') + " This task will only work on staging"
+      if fetch(:stage).to_s != 'staging'
+        warn Airbrussh::Colors.red('✘') + ' This task will only work on staging.'
         exit 1
       end
 
@@ -24,19 +24,31 @@ namespace :sumo do
       end
     end
 
-    desc "Replace the remote database with the local database"
+    desc 'Replace the remote database with the local database'
     task :put do
       on roles(:db) do
-        execute :mysqldump, "--lock-tables=false --set-charset #{remote_db_options} #{extract_from_remote_parameters('database.name')} > #{shared_path}/backup_#{Time.now.strftime('%Y%m%d%H%M')}.sql"
+        execute :mysqldump,
+                '--lock-tables=false',
+                '--set-charset',
+                remote_db_options,
+                extract_from_remote_parameters('database.name'),
+                "> #{shared_path}/backup_#{Time.now.strftime('%Y%m%d%H%M')}.sql"
       end
 
       run_locally do
-        execute :mysqldump, "--lock-tables=false --set-charset #{extract_from_local_parameters('database.name')} > ./db_upload.tmp.sql"
+        execute :mysqldump,
+                '--lock-tables=false',
+                '--set-charset',
+                extract_from_local_parameters('database.name'),
+                '> ./db_upload.tmp.sql'
       end
 
       on roles(:db) do
         upload! File.open('./db_upload.tmp.sql'), "#{shared_path}/db_upload.tmp.sql"
-        execute :mysql, "#{remote_db_options} #{extract_from_remote_parameters('database.name')} < #{shared_path}/db_upload.tmp.sql"
+        execute :mysql,
+                remote_db_options,
+                extract_from_remote_parameters('database.name'),
+                "< #{shared_path}/db_upload.tmp.sql"
         execute :rm, "#{shared_path}/db_upload.tmp.sql"
       end
 
@@ -45,15 +57,22 @@ namespace :sumo do
       end
     end
 
-    desc "Replace the local database with the remote database"
+    desc 'Replace the local database with the remote database'
     task :get do
       on roles(:db) do
-        execute :mysqldump, "--lock-tables=false --set-charset #{remote_db_options} #{extract_from_remote_parameters('database.name')} > #{shared_path}/db_download.tmp.sql"
+        execute :mysqldump,
+                '--lock-tables=false',
+                '--set-charset',
+                remote_db_options,
+                extract_from_remote_parameters('database.name'),
+                " > #{shared_path}/db_download.tmp.sql"
         download! "#{shared_path}/db_download.tmp.sql", './db_download.tmp.sql'
       end
 
       run_locally do
-        execute :mysql, extract_from_local_parameters('database.name'), "< ./db_download.tmp.sql"
+        execute :mysql,
+                extract_from_local_parameters('database.name'),
+                '< ./db_download.tmp.sql'
       end
 
       on roles(:db) do
@@ -69,9 +88,9 @@ namespace :sumo do
     private
     def remote_db_options
       data = {
-          'host' => extract_from_remote_parameters("database.host"),
-          'user' => extract_from_remote_parameters("database.user"),
-          'password' => extract_from_remote_parameters("database.password"),
+          'host' => extract_from_remote_parameters('database.host'),
+          'user' => extract_from_remote_parameters('database.user'),
+          'password' => extract_from_remote_parameters('database.password'),
       }
       options = ''
 

data/lib/capistrano/tasks/files.rake

@@ -1,6 +1,6 @@
 namespace :sumo do
   namespace :files do
-    desc "Uploads the local files to the remote server"
+    desc 'Uploads the local files to the remote server'
     task :put do
       on roles(:web) do
         fetch(:files_dir).each do |path|
@@ -9,7 +9,7 @@ namespace :sumo do
       end
     end
 
-    desc "Downloads the remote files to the local instance"
+    desc 'Downloads the remote files to the local instance'
     task :get do
       on roles(:web) do
         fetch(:files_dir).each do |path|

data/lib/capistrano/tasks/notifications.rake

@@ -1,15 +1,15 @@
 namespace :sumo do
   namespace :notifications do
-    desc "Notify our webhooks on a deploy"
+    desc 'Notify our webhooks on a deploy'
     task :deploy do
       on roles(:web) do
         execute :curl,
-                "-sS",
+                '-sS',
                 "--data local_username=#{ENV["USER"]}",
                 "--data stage=#{fetch(:stage)}",
                 "--data repo=#{fetch(:repo_url)}",
                 "--data revision=#{capture("cat #{current_path}/REVISION")}",
-                "http://bot.sumo.sumoapp.be:3001/deploy/hook"
+                'http://bot.sumo.sumoapp.be:3001/deploy/hook'
       end
     end
   end

data/lib/capistrano/tasks/redirect.rake

@@ -1,14 +1,14 @@
 namespace :sumo do
   namespace :redirect do
-    desc "Enable a redirect page, all traffic will be redirected to this page."
+    desc 'Enable a redirect page, all traffic will be redirected to this page.'
     task :enable do
       on roles(:web) do
-        execute :mkdir, "-p", "#{shared_path}/redirect"
-        execute :wget, "-qO", "#{shared_path}/redirect/index.php http://static.sumocoders.be/redirect/index.phps"
-        execute :wget, "-qO", "#{shared_path}/redirect/.htaccess http://static.sumocoders.be/redirect/htaccess"
-        execute :sed, "-i", "'s|<real-url>|#{fetch :production_url}|' #{shared_path}/redirect/index.php"
-        execute :rm, "-f", "#{fetch :deploy_to}/current"
-        execute :ln, "-s", "#{shared_path}/redirect #{fetch :deploy_to}/current"
+        execute :mkdir, '-p', "#{shared_path}/redirect"
+        execute :wget, '-qO', "#{shared_path}/redirect/index.php http://static.sumocoders.be/redirect/index.phps"
+        execute :wget, '-qO', "#{shared_path}/redirect/.htaccess http://static.sumocoders.be/redirect/htaccess"
+        execute :sed, '-i', "'s|<real-url>|#{fetch :production_url}|' #{shared_path}/redirect/index.php"
+        execute :rm, '-f', "#{fetch :deploy_to}/current"
+        execute :ln, '-s', "#{shared_path}/redirect #{fetch :deploy_to}/current"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sumo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Tijs Verkoyen
@@ -30,31 +30,31 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Sumo specific task for Capistrano 3.x.
+        version: '3.6'
+description: SumoCoders specific task for Capistrano 3.x.
 email:
-- tijs@verkoyen.eu
+- capistrano-sumo@verkoyen.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,7 +64,6 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.md
-- LICENSE.txt
 - README.md
 - Rakefile
 - capistrano-sumo.gemspec
@@ -98,5 +97,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Sumo specific task for Capistrano 3.x.
+summary: SumoCoders specific task for Capistrano 3.x.
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Tijs Verkoyen
-
-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.