capistrano-exts 1.0.0

data/lib/capistrano-exts/receipts/servers/web_server/nginx.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require 'capistrano'
+
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    namespace :server do
+      namespace :web_server do
+        namespace :nginx do
+
+          _cset :nginx_init_path, "/etc/init.d/nginx"
+
+          desc "[internal] Generate Nginx configuration"
+          task :generate_configuration do
+            web_server_mode = fetch :web_server_mode
+            nginx = Capistrano::Extensions::Server::Nginx.new web_server_mode
+
+            nginx.application = fetch :application
+            nginx.public_path = fetch :public_path
+            nginx.logs_path   = fetch :logs_path
+            nginx.application_url = fetch :application_url
+
+            nginx.listen_port = fetch(:web_server_listen_port) if exists?(:web_server_listen_port)
+
+            if exists?(:web_server_auth_file)
+              nginx.authentification_file = fetch :web_server_auth_file
+            end
+
+            nginx.indexes = fetch(:web_server_indexes) if exists?(:web_server_indexes)
+
+            if exists?(:web_server_mod_rewrite)
+              nginx.mod_rewrite = fetch :web_server_mod_rewrite
+            end
+
+            if exists?(:php_fpm_host)
+              nginx.php_fpm_host = fetch :php_fpm_host
+              nginx.php_fpm_port = fetch :php_fpm_port
+            end
+
+            set :web_conf, nginx
+            set :web_conf_contents, nginx.render
+          end
+
+          desc "Start nginx web server"
+          task :start do
+            run <<-CMD
+              #{try_sudo} #{fetch :nginx_init_path} start
+            CMD
+          end
+
+          desc "Stop nginx web server"
+          task :stop do
+            run <<-CMD
+              #{try_sudo} #{fetch :nginx_init_path} stop
+            CMD
+          end
+
+          desc "Restart nginx web server"
+          task :restart do
+            run <<-CMD
+              #{try_sudo} #{nginx_init_path} restart
+            CMD
+          end
+
+          desc "Resload nginx web server"
+          task :reload do
+            run <<-CMD
+              #{try_sudo} #{nginx_init_path} reload
+            CMD
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-exts/receipts/servers/web_server.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+
+require 'capistrano'
+require 'digest/sha1'
+
+# Require all specific web_server files
+Dir["#{File.dirname(__FILE__)}/web_server/*.rb"].each {|f| require f}
+
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    namespace :server do
+      namespace :web_server do
+        desc "Setup web server"
+        task :setup, :roles => :web do
+          # Empty task, server preparation goes into callbacks
+        end
+
+        desc "[internal] Generate Web configuration"
+        task :generate_web_configuration do
+          if exists?(:web_server_app)
+            web_server_app = fetch :web_server_app
+
+            case web_server_app
+            when :nginx
+              find_and_execute_task 'deploy:server:web_server:nginx:generate_configuration'
+            when :apache
+              find_and_execute_task 'deploy:server:web_server:generate_apache_configuration'
+            else
+              abort "I don't know how to build '#{web_server_app}' configuration."
+            end
+          end
+        end
+
+        desc "[internal] Generate authentification"
+        task :generate_authentification do
+          if exists?(:web_server_auth_credentials)
+            web_server_auth_credentials = fetch :web_server_auth_credentials
+            contents = Array.new
+
+            web_server_auth_credentials.each do |credentials|
+              if credentials[:password].is_a?(Proc)
+                password = credentials[:password].call.crypt(gen_pass(8))
+              else
+                password = credentials[:password].crypt(gen_pass(8))
+              end
+              contents << "#{credentials[:user]}:#{password}"
+            end
+
+            set :web_server_auth_file_contents, contents.join("\n")
+          end
+        end
+
+        desc "[internal] Generate Apache configuration"
+        task :generate_apache_configuration do
+          # TODO: Write Apache config generator
+        end
+
+        desc "[internal] Write authentification file"
+        task :write_web_server_auth_file do
+          if exists?(:web_server_auth_file)
+            web_server_auth_file = fetch :web_server_auth_file
+            web_server_auth_file_contents = fetch :web_server_auth_file_contents
+            random_file = "/tmp/#{fetch :application}_#{Digest::SHA1.hexdigest web_server_auth_file_contents}"
+
+            run <<-CMD
+              #{try_sudo} mkdir -p #{File.dirname web_server_auth_file}
+            CMD
+
+            put web_server_auth_file_contents, random_file
+
+            run <<-CMD
+              #{try_sudo} mv #{random_file} #{web_server_auth_file}
+            CMD
+          end
+        end
+
+        desc "[internal] Write web configuration file"
+        task :write_web_conf_file do
+          if exists?(:web_conf_file)
+            web_conf_file = fetch :web_conf_file
+            random_file = "/tmp/#{fetch :application}_#{Digest::SHA1.hexdigest web_conf_contents}"
+
+            run <<-CMD
+              #{try_sudo} mkdir -p #{File.dirname web_conf_file}
+            CMD
+
+            put web_conf_contents, random_file
+
+            run <<-CMD
+              #{try_sudo} mv #{random_file} #{web_conf_file}
+            CMD
+          end
+        end
+
+        task :finish do
+          # Empty task for callbacks
+        end
+      end
+    end
+  end
+
+  before "deploy:server:web_server:setup", "deploy:server:web_server:generate_web_configuration"
+  after  "deploy:server:web_server:setup", "deploy:server:web_server:finish"
+  after "deploy:server:web_server:generate_web_configuration", "deploy:server:web_server:generate_authentification"
+  after "deploy:server:web_server:generate_web_configuration", "deploy:server:web_server:write_web_conf_file"
+  after "deploy:server:web_server:generate_authentification", "deploy:server:web_server:write_web_server_auth_file"
+end

data/lib/capistrano-exts/receipts/servers.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+# Requirements
+require 'capistrano'
+require 'capistrano-exts/receipts/base'
+require 'capistrano-exts/receipts/mysql'
+require 'capistrano-exts/receipts/servers/web_server'
+require 'capistrano-exts/receipts/servers/db_server'
+
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    namespace :server do
+      namespace :setup do
+        desc "Prepare the server (database server, web server and folders)"
+        task :default do
+          # Empty task, server preparation goes into callbacks
+        end
+
+        task :folders, :roles => :app do
+          run <<-CMD
+            mkdir -p #{fetch :deploy_to} &&
+            mkdir -p #{fetch :deploy_to}/backups
+          CMD
+
+          if exists? :logs_path
+            run <<-CMD
+              mkdir -p #{fetch :logs_path}
+            CMD
+          end
+        end
+
+        task :finish do
+          # Empty task for callbacks
+        end
+
+      end
+    end
+  end
+
+  # Callbacks
+  before "deploy:server:setup", "deploy:server:setup:folders"
+  after  "deploy:server:setup", "deploy:server:setup:finish"
+
+  after "deploy:server:setup:folders", "deploy:server:db_server:setup"
+  after "deploy:server:setup:folders", "deploy:server:web_server:setup"
+end

data/lib/capistrano-exts/receipts/unicorn.rb

@@ -0,0 +1,27 @@
+namespace :unicorn do
+  desc "start unicorn"
+  task :start, :roles => :app, :except => {:no_release => true} do
+    run "cd #{current_path} && #{unicorn_binary} -c #{unicorn_config} -E #{rails_env} -D"
+  end
+
+  desc "stop unicorn"
+  task :stop, :roles => :app, :except => {:no_release => true} do
+    run "#{try_sudo} kill `cat #{unicorn_pid}`"
+  end
+
+  desc "unicorn reload"
+  task :reload, :roles => :app, :except => {:no_release => true} do
+    run "#{try_sudo} kill -s USR2 `cat #{unicorn_pid}`"
+  end
+
+  desc "graceful stop unicorn"
+  task :graceful_stop, :roles => :app, :except => {:no_release => true} do
+    run "#{try_sudo} kill -s QUIT `cat #{unicorn_pid}`"
+  end
+
+  desc "restart unicorn"
+  task :restart, :roles => :app, :except => {:no_release => true} do
+    stop
+    start
+  end
+end

data/lib/capistrano-exts/receipts.rb

@@ -0,0 +1,17 @@
+require 'capistrano'
+require 'capistrano-exts/receipts/functions'
+
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  on :load do
+    if exists?(:capistrano_extensions)
+      capistrano_extensions.each do |receipt|
+        require "capistrano-exts/receipts/#{receipt.to_s}"
+      end
+    end
+  end
+end

data/lib/capistrano-exts/servers/utils/erb.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'erb'
+
+module Capistrano
+  module Extensions
+    module Erb
+      def render
+        sanity_check
+
+        erb_template = ::ERB.new(File.read(@template))
+        erb_template.result(binding).strip_empty_lines
+      end
+    end
+  end
+end

data/lib/capistrano-exts/servers/utils/variables.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'erb'
+
+module Capistrano
+  module Extensions
+    module Variables
+
+      # Instead of defining a whole lot of attr_accessor, let's be smart about
+      # templates, right ?
+      def method_missing(method, *args, &block)
+        if method =~ /(.+)=$/
+          # Method 1: works but the attr_accessor would be set on all instances
+          # Which is not good
+          #
+          # self.class.__send__(:attr_accessor, $1.to_sym)
+          # self.__send__(method, *args, &block)
+
+          # Method 2: Just set the instance variable, works better
+          self.send(:instance_variable_set, "@#{$1.to_sym}", *args)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-exts/servers/web_server/nginx.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Capistrano
+  module Extensions
+    module Server
+      class Nginx < WebServer
+
+        AVAILABLE_MODES = [:rails_passenger, :rails_reverse_proxy, :php_fpm]
+        NGINX_TEMPLATE_PATH = ROOT_PATH + '/capistrano-exts/templates/web_servers/nginx.conf.erb'
+
+        def initialize(mode, template_path = NGINX_TEMPLATE_PATH)
+          raise ArgumentError, "The requested mode is not supported" unless AVAILABLE_MODES.include?(mode)
+          raise ArgumentError, "The template file is not found or not readable" unless File.exists?(template_path)
+          @mode = mode.to_sym
+          @template = template_path
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-exts/servers/web_server.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require 'capistrano-exts/servers/utils/erb'
+require 'capistrano-exts/servers/utils/variables'
+
+module Capistrano
+  module Extensions
+    module Server
+      class WebServer
+
+        include Erb
+        include Variables
+
+        protected
+          def authentification?
+            @authentification_file.present?
+          end
+
+          def reverse_proxy?
+            @mode == :rails_reverse_proxy
+          end
+
+          def mod_rewrite?
+            (
+              @mod_rewrite.present? and
+              @mod_rewrite == true
+            ) or
+            (
+              @mod_rewrite.blank?
+            )
+          end
+
+          def php_fpm?
+            @mode == :php_fpm
+          end
+
+          def passenger?
+            @mode == :rails_passenger
+          end
+
+          def php_build_with_force_cgi_redirect?
+            # required if PHP was built with --enable-force-cgi-redirect
+            @php_build_with_force_cgi_redirect.present? and @php_build_with_force_cgi_redirect == true
+          end
+
+          def sanity_check
+            [:application_url, :application].each do |var|
+              unless instance_variable_get("@#{var.to_s}")
+                raise ArgumentError, "#{var.to_s} is required, please define it."
+              end
+            end
+
+            if php_fpm?
+              [:php_fpm_host, :php_fpm_port, :public_path].each do |var|
+                unless instance_variable_get("@#{var.to_s}")
+                  raise ArgumentError, "#{var.to_s} is required, please define it."
+                end
+              end
+            end
+
+          end
+
+      end
+    end
+  end
+end
+
+# Require all web servers
+Dir["#{File.dirname __FILE__}/web_server/*.rb"].each { |f| require f }

data/lib/capistrano-exts/templates/multistage.rb

@@ -0,0 +1,118 @@
+# Here you can set the server which you would like to, each server
+# each role can have multiple servers, each server defined as user@server.com:port
+# => port can be omiped and it defaults to 22
+role :web, 'root@nasreddine.com:22'
+role :app, 'root@nasreddine.com:22'
+role :db, 'root@nasreddine.com:22', primary: true
+
+# The project's branch to use
+# Uncomment and edit this if you're using git, for other SCM's please refer
+# to capistrano's documentation
+set :branch, "master"
+
+# Use sudo ?
+set :use_sudo, false
+
+# Define deployments options
+set :deploy_to,   "/home/vhosts/#{application}"
+set :deploy_via,  :remote_cache
+set :logs_path,   "#{deploy_to}/logs"
+set :public_path, -> { "#{current_path}/public" }
+
+# Keep only the last 5 releases
+set :keep_releases, 5
+
+# Using RVM? Set this to the ruby version/gemset to use
+set :rvm_ruby_string, "1.9.2"
+
+# Mysql credentials
+set :mysql_credentials_file,                  -> { "#{deploy_to}/.mysql_password"}
+set :mysql_credentials_host_regex,            /hostname: (.*)$/o
+set :mysql_credentials_host_regex_match,      1
+set :mysql_credentials_user_regex,            /username: (.*)$/o
+set :mysql_credentials_user_regex_match,      1
+set :mysql_credentials_pass_regex,            /password: (.*)$/o
+set :mysql_credentials_pass_regex_match,      1
+set :mysql_root_credentials_file,             "/root/.mysql_password"
+set :mysql_root_credentials_host_regex,       /hostname: (.*)$/o
+set :mysql_root_credentials_host_regex_match, 1
+set :mysql_root_credentials_user_regex,       /username: (.*)$/o
+set :mysql_root_credentials_user_regex_match, 1
+set :mysql_root_credentials_pass_regex,       /password: (.*)$/o
+set :mysql_root_credentials_pass_regex_match, 1
+
+#############
+# Web server
+#
+
+# Which web server to use?
+# valid options: :nginx and :apache
+set :web_server_app, :nginx
+
+# Server specific configurations
+# Uncomment as necessary, default option are as follow
+# set :nginx_init_path, '/etc/init.d/nginx'
+# set :apache_init_path, '/etc/init.d/apache2'
+
+# Absolute path to this application's web server configuration
+# This gem suppose that you are already including files from the folder you're placing
+# the config file in, if not the application won't be up after deployment
+set :web_conf_file, -> { "/etc/nginx/#{fetch(:stage).to_s}/#{fetch :application}.conf" }
+
+# Which port does the server runs on ?
+set :web_server_listen_port, 80
+
+# What is the application url ?
+# THis is used for Virtual Hosts
+set :application_url, %w(example.com www.example.com)
+
+# What are the names of the indexes
+set :web_server_indexes, %w(index.php index.html)
+
+# HTTP Basic Authentifications
+# Uncomment this if you would like to add HTTP Basic authentifications,
+#
+# Change the 'web_server_auth_file' to the absolute path of the htpasswd file
+# web_server_auth_credentials is an array of user/password hashes, you can use
+# gen_pass(length) in a Proc to generate a new password as shown below
+#
+# set :web_server_auth_file,        -> { "/etc/nginx/htpasswds/#{fetch :application}.crypt" }
+# set :web_server_auth_credentials, [
+#                                     {user: 'user1', password: 'pass1'},
+#                                     {user: 'user2', password: -> { gen_pass(8) } },
+#                                   ]
+
+# Enable mode rewrite ?
+set :web_server_mod_rewrite, true
+
+# Which server mode to operate on?
+# Valid options:
+#
+# For Nginx:
+# => :rails_reverse_proxy, :rails_passenger, :php_fpm
+# => :rails_reverse_proxy is used for unicorn (Rack apps)
+# => :rails_passenger runs rails apps
+# => :php_fpm is used to deliver websites written using PHP
+#
+# For Apache
+# =>
+set :web_server_mode, :rails_reverse_proxy
+
+# Server mode specific configurations
+# Uncomment and edit the one depending on the enabled mode
+# php_fpm settings
+# => On which host, php-fpm is running ?
+# set :php_fpm_host, 'localhost'
+# => Which port ?
+# set :php_fpm_port, '9000'
+
+# reverse_proxy settings (Unicorn for example)
+# => On which host the proxy is running ?
+# set :reverse_proxy_server_address, 'localhost'
+# => On which port ?
+# set :reverse_proxy_server_port, 45410
+# => What is the path to the socket file
+# set :reverse_proxy_socket, -> { "#{shared_path}/sockets/unicorn.sock"}
+
+#
+#############

data/lib/capistrano-exts/templates/web_servers/nginx.conf.erb

@@ -0,0 +1,95 @@
+server {
+  listen <%= @listen_port || 80 %>;
+  server_name <%= @application_url.join(' ') %>;
+
+<% if authentification? %>
+  # Authentification
+  auth_basic "Valid user required to access this server";
+  auth_basic_user_file <%= @authentification_file %>;
+<% end %>
+
+<% if @logs_path %>
+  access_log <%= @logs_path %>/access.log;
+  error_log <%= @logs_path %>/error.log;
+<% end %>
+
+<% unless reverse_proxy? %>
+  root <%= @public_path %>;
+<% end %>
+
+<% if @indexes.present? %>
+  index <%= @indexes.join(' ') %>;
+<% end %>
+
+  location / {
+  <% if mod_rewrite? %>
+    # this serves static files that exist without running other rewrite tests
+    if (-f $request_filename) {
+      expires 30d;
+      break;
+    }
+
+    # this sends all non-existing file or directory requests to index.php
+    if (!-e $request_filename) {
+      rewrite ^(.+)$ /index.php?q=$1 last;
+    }
+  <% end %>
+
+  <% if reverse_proxy? %>
+    proxy_pass http://<%= @application %>_reverse_proxy;
+    proxy_set_header Host $host;
+  <% end %>
+  }
+
+  location ~ /\.ht {
+    deny  all;
+  }
+
+<% if php_fpm? %>
+  location ~ .php$ {
+    fastcgi_pass   <%= @php_fpm_host %>:<%= @php_fpm_port %>;
+    fastcgi_index  index.php;
+    fastcgi_param  SCRIPT_FILENAME    <%= @public_path %>$fastcgi_script_name;
+
+    fastcgi_param  QUERY_STRING       $query_string;
+    fastcgi_param  REQUEST_METHOD     $request_method;
+    fastcgi_param  CONTENT_TYPE       $content_type;
+    fastcgi_param  CONTENT_LENGTH     $content_length;
+
+    fastcgi_param  SCRIPT_NAME        $fastcgi_script_name;
+    fastcgi_param  REQUEST_URI        $request_uri;
+    fastcgi_param  DOCUMENT_URI       $document_uri;
+    fastcgi_param  DOCUMENT_ROOT      $document_root;
+    fastcgi_param  SERVER_PROTOCOL    $server_protocol;
+
+    fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;
+    fastcgi_param  SERVER_SOFTWARE    nginx/$nginx_version;
+
+    fastcgi_param  REMOTE_ADDR        $remote_addr;
+    fastcgi_param  REMOTE_PORT        $remote_port;
+    fastcgi_param  SERVER_ADDR        $server_addr;
+    fastcgi_param  SERVER_PORT        $server_port;
+    fastcgi_param  SERVER_NAME        $server_name;
+
+  <% if php_build_with_force_cgi_redirect? %>
+    fastcgi_param  REDIRECT_STATUS    200;
+  <% end %>
+  }
+<% end %>
+
+<% if passenger? %>
+  passenger_enabled on;
+<% end %>
+}
+
+<% if reverse_proxy? %>
+upstream <%= @application %>_reverse_proxy {
+<% if @reverse_proxy_server_address.present? %>
+  server <%= @reverse_proxy_server_address %>:<%= @reverse_proxy_server_port %> fail_timeout=0;
+<% end %>
+
+<% if @reverse_proxy_socket.blank? %>
+  server unix:<%= @reverse_proxy_socket %>;
+<% end %>
+}
+<% end %>

data/lib/capistrano-exts/version.rb

@@ -0,0 +1,12 @@
+module Capistrano
+  module Extensions
+    module Version #:nodoc:
+      MAJOR = 1
+      MINOR = 0
+      TINY = 0
+
+      ARRAY  = [MAJOR, MINOR, TINY]
+      STRING = ARRAY.join(".")
+    end
+  end
+end

data/lib/capistrano-exts.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+# Add it to PATH
+ROOT_PATH = File.expand_path(File.dirname(__FILE__))
+$: << ROOT_PATH if File.directory?(ROOT_PATH) and not $:.include?(ROOT_PATH)
+
+# Require our core extensions
+require 'capistrano-exts/core_ext'
+
+# Require requested receipts
+require 'capistrano-exts/receipts' if defined?(Capistrano::Configuration)
+
+# Require all servers
+Dir["#{ROOT_PATH}/capistrano-exts/servers/*.rb"].each { |f| require f }