capistrano-olympus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b6fb26fc2208fdd0d630569d8235abf08708abb
+  data.tar.gz: 82159cff48c798f9607cb6159d02a1f09b9fb330
+SHA512:
+  metadata.gz: a2ada5f75daf5386bd90b26bb53356b2ca144524bf46e9bef379e86aba5f86a08798bd6865c1373a15c3c0aeebbfeca171450a7e4756536a954afbda1f35faae
+  data.tar.gz: 7343e6d5517a76cff830601cfb41b379b075d4e274518f3102e1cb5250f95f36f1c9a50f02f0b3f8cb76b5ff7d028f4989c4186bd224eebe4489818264225b02

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.0.1 (March 31, 2016)
+**INITIAL RELEASE**

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (C) 2016, Achraf Chouk - achrafchouk@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,63 @@
+# Capistrano Olympus  
+
+---
+
+_in progress_  
+
+---
+
+[![Total Downloads](https://img.shields.io/packagist/dt/crewstyle/capistrano-olympus.svg?style=flat-square)](https://packagist.org/packages/crewstyle/capistrano-olympus) 
+[![GitHub version](https://img.shields.io/github/tag/crewstyle/capistrano-olympus.svg?style=flat-square)](https://github.com/crewstyle/capistrano-olympus) 
+![For WordPress](https://img.shields.io/badge/for-WordPress-00aadc.svg?style=flat-square)  
+
+---
+
+To follow more about the project and help if you want:
+
+[Github project repository](https://github.com/crewstyle/Olympus)  
+[Salt Bountysource page](https://salt.bountysource.com/teams/olympus)  
+[Bountysource page](https://www.bountysource.com/teams/olympus)  
+[Documentation](https://olympus.readme.io/)
+
+---
+
+### Installation
+
+```
+# Gemfile
+gem 'capistrano',  '~> 3.4'
+gem 'capistrano-olympus', '~> 0.0.1'
+```
+
+### Usage
+
+Require capistrano-olympus in your cap file
+
+```
+# Capfile
+require 'capistrano/olympus'
+```
+
+---
+
+### All we need is looooooooooooove :)
+
+[![Salt Bountysource page](https://img.shields.io/badge/Salt%20Bountysource-♥-brightgreen.svg?style=flat-square)](https://salt.bountysource.com/teams/olympus) [![Bountysource page](https://img.shields.io/badge/Bountysource-♥-brightgreen.svg?style=flat-square)](https://www.bountysource.com/teams/olympus)  
+Guys, do **not** hesitate to spread your love about the **Olympus WordPress framework** and **all its packages** ;)
+
+---
+
+### Authors and Copyright
+
+**Achraf Chouk**
+
++ http://fr.linkedin.com/in/achrafchouk/
++ http://twitter.com/crewstyle
++ http://github.com/crewstyle
+
+Please, read [LICENSE](https://github.com/crewstyle/capistrano-olympus/blob/master/LICENSE "LICENSE") for more details.  
+[![MIT](https://img.shields.io/badge/license-MIT_License-blue.svg?style=flat-square)](http://opensource.org/licenses/MIT "MIT")  
+
+---
+
+**Built with ♥ by [Achraf Chouk](http://github.com/crewstyle "Achraf Chouk") ~ (c) since 2015.**

data/capistrano-olympus.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'capistrano-olympus'
+  gem.version       = '0.0.1'
+  gem.date          = '2016-03-31'
+  gem.authors       = ['Achraf Chouk']
+  gem.email         = ['achrafchouk@gmail.com']
+  gem.description   = "Capistrano 3.x deployment processes for WordPress and Olympus framework"
+  gem.summary       = "Gem especially made to build WordPress and Olympus framework websites with Capistrano 3.x"
+  gem.homepage      = 'http://github.com/crewstyle/capistrano-olympus'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  # no tests as of yet
+  #gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'capistrano', '~> 3.4'
+  gem.add_dependency 'capistrano-composer', '~> 0.0.6'
+  gem.add_dependency 'sshkit-sudo', '~> 0.1.0'
+end

data/lib/capistrano/capistrano-olympus.rb

@@ -0,0 +1,11 @@
+# Core tasks for deploying Olympus framework with WordPress
+load File.expand_path("../tasks/capistrano-deploy.rake", __FILE__)
+
+# Load defaults variables
+namespace :load do
+
+  task :defaults do
+    load "capistrano/vars/defaults.rb"
+  end
+
+end

data/lib/capistrano/tasks/capistrano-deploy.rake

@@ -0,0 +1,48 @@
+module Capistrano
+  class FileNotFound < StandardError
+  end
+end
+
+# Deploy
+namespace :deploy do
+
+  desc "Create files and dirs when its needed"
+  task :setup do
+    on release_roles(:all) do
+
+      # Check the very last action made: it means all setup processes are done!
+      if test "[ ! -f \"#{shared_path}/web/robots.txt\" ]"
+        puts "Create directories"
+        invoke "directories:do_actions"
+
+        puts "Create files"
+        invoke "files:do_actions"
+      end
+
+    end
+  end
+
+  desc "Restart services and clear caches"
+  task :clear do
+    on release_roles(:all) do
+
+      puts "Restart all services"
+      invoke "server:stop"
+      invoke "php:restart"
+      invoke "server:start"
+
+      puts "Clear all caches"
+      invoke "redis:flushall"
+      invoke "pagespeed:flushall"
+      invoke "varnish:restart"
+
+    end
+  end
+
+  # Create files and dirs when its needed
+  before 'deploy:starting', 'deploy:setup'
+
+  # Restart services and clear caches
+  after :publishing, 'deploy:clear'
+
+end

data/lib/capistrano/tasks/database.rake

@@ -0,0 +1,100 @@
+# Database
+namespace :database do
+
+  desc "Creates files"
+  task :do_actions do
+    on release_roles(:all) do
+
+      # Ask configs
+      set :database_host, ask('Enter the database hostname:', 'localhost')
+      set :database_name, ask('Enter the database name:', 'database_name_here')
+      set :database_user, ask('Enter the database user:', 'username_here')
+      set :database_pass, ask('Enter the database password:', 'username_here', echo: false)
+
+      set :wordpress_name, ask('Enter the admin username:', 'admin')
+      set :wordpress_mail, ask('Enter the admin email address:', 'admin@domain.tld')
+      set :wordpress_pass, ask('Enter the admin password:', 'password', echo: false)
+
+
+      if File.exists?("#{release_path}/tmp/database.sql")
+        puts "Copy database.sql file"
+        upload! StringIO.new(File.read("#{release_path}/tmp/database.sql")), "#{shared_path}/tmp/database.sql"
+      else
+        puts "Create database.sql file"
+        io = StringIO.new("CREATE DATABASE IF NOT EXISTS `#{fetch(:database_name)}`")
+        upload! io, File.join(shared_path, "database.sql")
+        execute :chmod, "644 #{shared_path}/database.sql"
+
+        # Execute SQL request and remove temporary file
+        execute :mysql, "-u #{fetch(:database_user)} -p#{fetch(:database_pass)} -h #{fetch(:database_host)} < #{shared_path}/database.sql"
+        execute :rm, "#{shared_path}/database.sql"
+      end
+
+
+      if File.exists?("#{release_path}/app/config/env.php")
+        puts "Copy env.php file"
+        upload! StringIO.new(File.read("#{release_path}/app/config/env.php")), "#{shared_path}/app/config/env.php"
+      else
+        puts "Create env.php file"
+
+        if fetch(:stage) == :production then
+          debug = StringIO.new("  'debug' => false,")
+        else
+          debug = StringIO.new("  'debug' => [
+    'savequeries' => true,
+    'script_debug' => true,
+    'wp_debug_display' => true,
+    'wp_debug' => true,
+  ],")
+        end
+
+        io = StringIO.new("<?php
+
+/**
+ * File auto-generated while first deploy.
+ */
+return [
+  //Database
+  'database' => [
+    'host' => '#{fetch(:database_host)}',
+    'name' => '#{fetch(:database_name)}',
+    'user' => '#{fetch(:database_user)}',
+    'pass' => '#{fetch(:database_pass)}',
+  ],
+
+  //WordPress URLs
+  'wordpress' => [
+    'home' => '#{fetch(:localurl)}',
+    'siteurl' => '#{fetch(:localurl)}/cms',
+  ],
+
+  //Secure?
+  'https' => false,
+
+  //Debug
+#{fetch(:debug)}
+];
+
+")
+        upload! io, File.join(shared_path, "env.php")
+        execute :chmod, "644 #{shared_path}/env.php"
+        execute :mv, "#{shared_path}/env.php", "#{shared_path}/app/config/"
+      end
+
+
+      puts "Execute wp-cli commands to create database"
+      execute :mkdir, '-p', "#{shared_path}/tmp/wpcli"
+      execute "wp core download --path=#{shared_path}/tmp/wpcli --force"
+
+      unless File.exists?("#{shared_path}/tmp/wpcli/wp-config.php")
+        execute "wp core config --path=#{shared_path}/tmp/wpcli --dbname=#{fetch(:database_name)} --dbuser=#{fetch(:database_user)} --dbpass=#{fetch(:database_pass)}"
+      end
+
+      execute "wp core install --path=#{shared_path}/tmp/wpcli --url=#{fetch(:localurl)} --title=#{fetch(:application)} --admin_user=#{fetch(:wordpress_name)} --admin_password=#{fetch(:wordpress_pass)} --admin_email=#{fetch(:wordpress_mail)}"
+
+      execute :rm, '-rf', "#{shared_path}/tmp"
+
+    end
+  end
+
+end

data/lib/capistrano/tasks/directories.rake

@@ -0,0 +1,31 @@
+# Directories
+namespace :directories do
+
+  desc "Creates directories"
+  task :do_actions do
+    on release_roles(:all) do
+
+      if test "[ ! -d \"#{shared_path}/tmp\" ]"
+        execute :mkdir, '-p', "#{shared_path}/tmp"
+      end
+
+      if test "[ ! -d \"#{shared_path}/app/config/env\" ]"
+        execute :mkdir, '-p', "#{shared_path}/app/config/env"
+      end
+
+      if test "[ ! -d \"#{shared_path}/web/statics/languages\" ]"
+        execute :mkdir, '-p', "#{shared_path}/web/statics/languages"
+      end
+
+      if test "[ ! -d \"#{shared_path}/web/statics/plugins\" ]"
+        execute :mkdir, '-p', "#{shared_path}/web/statics/plugins"
+      end
+
+      if test "[ ! -d \"#{shared_path}/web/statics/uploads\" ]"
+        execute :mkdir, '-p', "#{shared_path}/web/statics/uploads"
+      end
+
+    end
+  end
+
+end

data/lib/capistrano/tasks/files.rake

@@ -0,0 +1,25 @@
+# Files
+namespace :files do
+
+  desc "Creates files"
+  task :do_actions do
+    on release_roles(:all) do
+
+      if File.exists?("#{release_path}/app/config/common.php")
+        puts "Copy common.php file"
+        upload! StringIO.new(File.read("#{release_path}/app/config/common.php")), "#{shared_path}/app/config/common.php"
+      end
+
+      # Create DB files, and install data
+      invoke "database:do_actions"
+
+      # Create .htaccess
+      invoke "htaccess:do_actions"
+
+      # Create robots.txt
+      invoke "robots:do_actions"
+
+    end
+  end
+
+end

data/lib/capistrano/tasks/htaccess.rake

@@ -0,0 +1,35 @@
+# Htaccess
+namespace :htaccess do
+
+  desc "Creates files"
+  task :do_actions do
+    on release_roles(:all) do
+
+      if File.exists?("#{release_path}/web/.htaccess")
+        puts "Copy .htaccess file"
+        upload! StringIO.new(File.read("#{release_path}/web/.htaccess")), "#{shared_path}/web/.htaccess"
+      else
+        puts "Create .htaccess file"
+        io = StringIO.new("
+# BEGIN WordPress
+
+<IfModule mod_rewrite.c>
+  RewriteEngine On
+  RewriteBase /
+  RewriteRule ^index\.php$ - [L]
+  RewriteCond %{REQUEST_FILENAME} !-f
+  RewriteCond %{REQUEST_FILENAME} !-d
+  RewriteRule . /index.php [L]
+</IfModule>
+
+# END WordPress
+")
+        upload! io, File.join(shared_path, ".htaccess")
+        execute :chmod, "644 #{shared_path}/.htaccess"
+        execute :mv, "#{shared_path}/.htaccess", "#{shared_path}/web/"
+      end
+
+    end
+  end
+
+end

data/lib/capistrano/tasks/pagespeed.rake

@@ -0,0 +1,11 @@
+# PageSpeed
+namespace :pagespeed do
+
+  desc "PageSpeed data flush"
+  task :flushall do
+    on roles(:app) do
+      sudo :touch, '/var/cache/mod_pagespeed/cache.flush'
+    end
+  end
+
+end

data/lib/capistrano/tasks/php.rake

@@ -0,0 +1,37 @@
+# PHP
+namespace :php do
+
+  desc "PHP restart"
+  task :restart do
+    on roles(:app) do
+      if test("[ -f /etc/init.d/php7.0-fpm ]")
+        sudo :service, 'php7.0-fpm', :restart
+      elsif test("[ -f /etc/init.d/php5-fpm ]")
+        sudo :service, 'php5-fpm', :restart
+      end
+    end
+  end
+
+  desc "PHP start"
+  task :start do
+    on roles(:app) do
+      if test("[ -f /etc/init.d/php7.0-fpm ]")
+        sudo :service, 'php7.0-fpm', :start
+      elsif test("[ -f /etc/init.d/php5-fpm ]")
+        sudo :service, 'php5-fpm', :start
+      end
+    end
+  end
+
+  desc "PHP stop"
+  task :stop do
+    on roles(:app) do
+      if test("[ -f /etc/init.d/php7.0-fpm ]")
+        sudo :service, 'php7.0-fpm', :stop
+      elsif test("[ -f /etc/init.d/php5-fpm ]")
+        sudo :service, 'php5-fpm', :stop
+      end
+    end
+  end
+
+end

data/lib/capistrano/tasks/redis.rake

@@ -0,0 +1,19 @@
+# Redis
+namespace :redis do
+
+  desc "Redis data flush"
+  task :flushall do
+    on roles(:app) do
+      sudo 'redis-cli', 'flushall'
+    end
+  end
+
+  desc "Redis restart"
+  task :restart do
+    on roles(:app) do
+      sudo '/etc/init.d/redis-server', 'stop'
+      sudo '/etc/init.d/redis-server', 'start'
+    end
+  end
+
+end

data/lib/capistrano/tasks/robots.rake

@@ -0,0 +1,60 @@
+# Robots
+namespace :robots do
+
+  desc "Creates files"
+  task :do_actions do
+    on release_roles(:all) do
+
+      if File.exists?("#{release_path}/web/robots.txt")
+        puts "Copy robots.txt file"
+        upload! StringIO.new(File.read("#{release_path}/web/robots.txt")), "#{shared_path}/web/robots.txt"
+      else
+        puts "Create robots.txt file"
+        if fetch(:stage) == :production then
+          io = StringIO.new("Sitemap: #{fetch(:localurl)}/sitemap.xml
+
+User-agent: *
+Disallow: /*?
+
+User-agent: Googlebot
+User-agent: Googlebot-News
+User-agent: Googlebot-Image
+User-agent: Googlebot-Video
+User-agent: Googlebot-Mobile
+User-agent: Mediapartners-Google
+User-agent: Mediapartners
+User-agent: AdsBot-Google
+User-agent: Bingbot
+User-agent: Twitterbot
+Crawl-delay: 5
+
+User-agent: CCBot
+Crawl-delay: 10
+
+User-agent: Yandex
+Crawl-delay: 10
+
+User-agent: Applebot
+Crawl-delay: 10
+
+User-agent: archive.org_bot
+Crawl-delay: 10
+
+User-agent: ia_archiver
+Crawl-delay: 10
+")
+        else
+          io = StringIO.new("User-agent: *
+Disallow: /
+")
+        end
+
+        upload! io, File.join(shared_path, "robots.txt")
+        execute :chmod, "644 #{shared_path}/robots.txt"
+        execute :mv, "#{shared_path}/robots.txt", "#{shared_path}/web/robots.txt"
+      end
+
+    end
+  end
+
+end

data/lib/capistrano/tasks/server.rake

@@ -0,0 +1,37 @@
+# Server Nginx or Apache
+namespace :server do
+
+  desc "Server restart"
+  task :restart do
+    on roles(:app) do
+      if test("[ -f /etc/init.d/nginx ]")
+        sudo :service, :nginx, :restart
+      elsif test("[ -f /etc/init.d/apache2 ]")
+        sudo :service, :apache2, :restart
+      end
+    end
+  end
+
+  desc "Server start"
+  task :start do
+    on roles(:app) do
+      if test("[ -f /etc/init.d/nginx ]")
+        sudo :service, :nginx, :start
+      elsif test("[ -f /etc/init.d/apache2 ]")
+        sudo :service, :apache2, :start
+      end
+    end
+  end
+
+  desc "Server stop"
+  task :stop do
+    on roles(:app) do
+      if test("[ -f /etc/init.d/nginx ]")
+        sudo :service, :nginx, :stop
+      elsif test("[ -f /etc/init.d/apache2 ]")
+        sudo :service, :apache2, :stop
+      end
+    end
+  end
+
+end

data/lib/capistrano/tasks/varnish.rake

@@ -0,0 +1,11 @@
+# Varnish
+namespace :varnish do
+
+  desc "Varnish restart"
+  task :restart do
+    on roles(:app) do
+      sudo :service, :varnish, :restart
+    end
+  end
+
+end

data/lib/capistrano/vars/defaults.rb

@@ -0,0 +1,39 @@
+# config valid only for current version of Capistrano
+lock '3.4.0'
+
+# ~~~~
+
+# Setup Capistrano
+set :log_level, :debug
+set :keep_releases, 3
+
+# Setup Project ~ Update these settings
+set :application, 'olympus-capified'
+set :localurl, 'http://www.domain.tld'
+
+# Setup Git
+set :repo_url, 'git@github.com:crewstyle/Olympus.git'
+set :scm, :git
+set :git_enable_submodules, true
+
+# Setup SSH
+set :copy_exclude, ['.git', '.DS_Store', '.gitignore', '.gitmodules']
+set :use_sudo, false
+set :ssh_options, {
+  forward_agent: true
+}
+
+# ~~~~
+
+# Setup Composer
+set :composer_install_flags, '--no-dev --no-interaction --quiet --optimize-autoloader'
+set :composer_roles, :all
+set :composer_working_dir, -> { fetch(:release_path) }
+set :composer_dump_autoload_flags, '--optimize'
+set :composer_download_url, 'https://getcomposer.org/installer'
+
+# ~~~~
+
+# Setup Symlinks
+set :linked_files, ["app/config/env.php", "web/.htaccess", "web/robots.txt"]
+set :linked_dirs, ["web/statics/languages", "web/statics/plugins", "web/statics/uploads"]

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-olympus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Achraf Chouk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: capistrano-composer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: sshkit-sudo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Capistrano 3.x deployment processes for WordPress and Olympus framework
+email:
+- achrafchouk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- capistrano-olympus.gemspec
+- lib/capistrano-olympus.rb
+- lib/capistrano/capistrano-olympus.rb
+- lib/capistrano/tasks/capistrano-deploy.rake
+- lib/capistrano/tasks/database.rake
+- lib/capistrano/tasks/directories.rake
+- lib/capistrano/tasks/files.rake
+- lib/capistrano/tasks/htaccess.rake
+- lib/capistrano/tasks/pagespeed.rake
+- lib/capistrano/tasks/php.rake
+- lib/capistrano/tasks/redis.rake
+- lib/capistrano/tasks/robots.rake
+- lib/capistrano/tasks/server.rake
+- lib/capistrano/tasks/varnish.rake
+- lib/capistrano/vars/defaults.rb
+homepage: http://github.com/crewstyle/capistrano-olympus
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Gem especially made to build WordPress and Olympus framework websites with
+  Capistrano 3.x
+test_files: []