shuttle-deploy 0.2.0.beta1

data/lib/shuttle/deployment/ruby.rb

@@ -0,0 +1,40 @@
+module Shuttle
+  class Ruby < Shuttle::Deploy
+    include Shuttle::Support::Bundler
+    include Shuttle::Support::Thin
+
+    def setup
+      unless ruby_installed?
+        error "Please install Ruby first"
+      end
+      
+      unless bundle_installed?
+        install_bundler 
+      end
+
+      super
+    end
+
+    def deploy
+      setup
+      update_code
+      checkout_code
+      bundle_install
+      thin_restart
+      link_shared_paths
+      link_release
+    end
+
+    def link_shared_paths
+      ssh.run("mkdir -p #{release_path('tmp')}")
+      ssh.run("ln -s #{shared_path('pids')} #{release_path('tmp/pids')}")
+      ssh.run("ln -s #{shared_path('log')} #{release_path('log')}")
+    end
+
+    private
+
+    def ruby_installed?
+      ssh.run("which ruby").success?
+    end
+  end
+end

data/lib/shuttle/deployment/static.rb

@@ -0,0 +1,5 @@
+module Shuttle
+  class Static < Shuttle::Deploy
+    # Does not implement any custom functionality
+  end
+end

data/lib/shuttle/deployment/wordpress/cli.rb

@@ -0,0 +1,27 @@
+module Shuttle
+  module WordpressCli
+    CLI_GIT  = 'https://github.com/wp-cli/wp-cli.git'
+    CLI_PATH = '/usr/local/share/wp-cli'
+
+    # Check if CLI is installed
+    # @return [Boolean]
+    def cli_installed?
+      ssh.run("which wp").success?
+    end
+
+    # Install wordpress CLI
+    # @return [Boolean]
+    def cli_install
+      log "Installing wordpress CLI"
+
+      ssh.run("sudo git clone --recursive --quiet #{CLI_GIT} #{CLI_PATH}")
+      ssh.run("cd #{CLI_PATH} && sudo utils/dev-build")
+      
+      if cli_installed?
+        log "Wordpress CLI installed"
+      else
+        error "Unable to install wordpress CLI"
+      end
+    end
+  end
+end

data/lib/shuttle/deployment/wordpress/core.rb

@@ -0,0 +1,50 @@
+module Shuttle
+  module WordpressCore
+    # Get wordpress shared core path
+    # @return [String]
+    def core_path
+      @core_path ||= shared_path('wordpress/core')
+    end
+
+    # Check if wordpress core is installed
+    # @return [Boolean]
+    def core_installed?
+      ssh.directory_exists?(core_path) &&
+      !ssh.capture("ls #{core_path}").empty?
+    end
+
+    # Install wordpress shared core
+    # @param [Boolean] overwrite existing code
+    # @return [Boolean]
+    def core_install(overwrite=true)
+      if core_installed? && overwrite == true
+        core_remove
+      end
+
+      log "Installing wordpress core"
+
+      unless ssh.directory_exists?(core_path)
+        ssh.run("mkdir -p #{core_path}")
+      end
+
+      result = ssh.run("cd #{core_path} && wp core download")
+
+      if result.success?
+        log "Wordpress core installed"
+      else
+        error "Unable to install wordpress core: #{result.output}"
+      end
+    end
+
+    # Remove wordpress shared core
+    # @return [Boolean]
+    def core_remove
+      if ssh.directory_exists?(core_path)
+        log "Removing wordpress shared core"
+        ssh.run("rm -rf #{core_path}")
+      end
+
+      ssh.directory_exists?(core_path)
+    end
+  end
+end

data/lib/shuttle/deployment/wordpress/plugins.rb

@@ -0,0 +1,112 @@
+module Shuttle
+  module WordpressPlugins
+    # Install wordpresss plugin
+    # @param [String] plugin name slug
+    def plugin_install(name)
+      log "Installing plugin: #{name}"
+
+      res = ssh.run("cd #{release_path} && wp plugin install #{name}")
+      if !res.success?
+        error "Unable to install plugin '#{name}'. Reason: #{res.output}"
+      end
+    end
+
+    def plugin_custom_install(name, url)
+      log "Installing custom plugin: #{name} -> #{url}"
+
+      if git_url?(url)
+        install_git_plugin(name, url)
+      elsif file_url?(url)
+        install_file_plugin(name, url)
+      else
+        error "Valid git URL or archive URL is required for plugin: #{name}"
+      end
+    end
+
+    # Check if wordpress plugin is installed
+    # @return [Boolean]
+    def plugin_installed?(name)
+      raise "Not Implemented"
+    end
+
+    private
+
+    # Check if provided plugin url is a git repository
+    # @return [Boolean]
+    def git_url?(url)
+      url.include?('.git') || url.include?('git@') || url.include?('git://')
+    end
+
+    # Check if provided plugin url is a file
+    # @return [Boolean]
+    def file_url?(url)
+      name = File.basename(url)
+      name.include?('.zip') || name.include?('.tar.gz')
+    end
+
+    def install_git_plugin(plugin_name, url)
+      ssh.run "cd #{release_path}/wp-content/plugins"
+      res = ssh.run "git clone #{url} #{plugin_name}"
+
+      if res.failure?
+        error "Unable to install plugin '#{plugin_name}'. Reason: #{res.output}"
+      end
+
+      # Init submodules if any
+      if ssh.file_exists?("#{release_path}/wp-content/plugins/#{plugin_name}/.gitmodules")
+        log "Initializing git submodules for #{plugin_name}"
+
+        res = ssh.run("cd #{plugin_name} && git submodule update --init --recursive")
+
+        if res.failure?
+          error "Unable to update submodules for #{plugin_name}: #{res.output}"
+        end
+      end
+
+      # Cleanup git folder
+      ssh.run("rm -rf #{release_path}/wp-content/plugins/#{plugin_name}/.git")
+    end
+
+    def install_file_plugin(plugin_name, url)
+      name = File.basename(url)
+      plugin_path = "#{release_path}/wp-content/plugins/"
+
+      if ssh.file_exists?("/tmp/#{name}")
+        ssh.run("rm -f /tmp/#{name}")
+      end
+
+      # Download file first
+      log "Downloading #{url}"
+      result = ssh.run("cd /tmp && wget #{url}")
+
+      if result.failure?
+        error "Unable to download file from #{url}"
+      end
+
+      log "Extracting #{name} to plugins directory"
+
+      if name.include?('.zip')
+        check_unzip
+
+        if ssh.run("unzip /tmp/#{name} -d #{plugin_path}").failure?
+          error "Unable to extract plugin"
+        end
+      elsif name.include?('.tar.gz')
+        if ssh.run("tar -xzf #{name} -C #{plugin_path}").failure?
+          error "Unable to extract plugin"
+        end
+      end
+    end
+
+    def check_unzip
+      if ssh.run("which unzip").failure?
+        log "Unzip utility is missing. Installing..."
+
+        ssh.run("sudo apt-get update")
+        if ssh.run("sudo apt-get -y install unzip").failure?
+          error "Unable to install unzip utility"
+        end
+      end
+    end
+  end
+end

data/lib/shuttle/deployment/wordpress/vip.rb

@@ -0,0 +1,84 @@
+module Shuttle
+  module WordpressVip
+    VIP_URL = "https://vip-svn.wordpress.com/plugins/"
+
+    # Get wordpress VIP shared path
+    # @return [String]
+    def vip_path
+      @vip_path ||= shared_path('wordpress/vip')
+    end
+
+    # Check if wordpress VIP is required
+    # @return [Boolean]
+    def vip_required?
+      !config.wordpress.vip.nil?
+    end
+
+    # Check if wordpress VIP is installed
+    # @return [Boolean]
+    def vip_installed?
+      ssh.directory_exists?(vip_path)
+    end
+
+    # Update wordpress VIP
+    def vip_update
+      if vip_installed?
+        ssh.run("rm -rf #{vip_path}")
+      end
+
+      vip_install
+    end
+
+    def vip_install
+      log "Installing wordpress VIP"
+
+      vip = vip_get_config
+
+      options = [
+        "--username #{vip.user}",
+        "--password #{vip.password}",
+        "--non-interactive",
+        VIP_URL,
+        vip_path
+      ].join(' ')
+
+      cmd = "svn co #{options}"
+
+      res = ssh.run(cmd, &method(:stream_output))
+
+      if res.success?
+        log "Wordpress VIP installed"
+      else
+        raise DeployError, "Unable to install wordpress VIP. Reason: #{res.output}"
+      end
+    end
+
+    def vip_get_config
+      data = config.wordpress.vip
+      if data.nil?
+       error "Please add VIP credentials to config."
+      end
+
+      if !data.user
+        error "VIP user is empty. Please set :user parameter"
+      end
+
+      if !data.password
+        error "VIP password is empty. Please set :password parameter"
+      end
+
+      data
+    end
+
+    def vip_link
+      ssh.run("mkdir -p #{release_path}/wp-content/themes/vip")
+      result = ssh.run("cp -a #{vip_path} #{release_path('wp-content/themes/vip/plugins')}")
+      
+      if result.success?
+        log "Wordpress VIP is linked"
+      else
+        error "Unable to link VIP: #{result.output}"
+      end
+    end
+  end
+end

data/lib/shuttle/deployment/wordpress.rb

@@ -0,0 +1,191 @@
+require 'shuttle/deployment/wordpress/core'
+require 'shuttle/deployment/wordpress/cli'
+require 'shuttle/deployment/wordpress/vip'
+require 'shuttle/deployment/wordpress/plugins'
+
+module Shuttle
+  class Wordpress < Php
+    include WordpressCli
+    include WordpressCore
+    include WordpressVip
+    include WordpressPlugins
+
+    def setup
+      if config.wordpress.nil?
+        error "Please add :wordpress section to your config"
+      end
+
+      super
+
+      setup_shared_dirs
+      check_dependencies
+      cli_install if !cli_installed?
+      core_install if !core_installed?
+      check_config
+    end
+
+    def deploy
+      setup
+      update_code
+      link_shared_data
+      checkout_theme
+
+      if vip_required?
+        vip_install if !vip_installed?
+        vip_link
+      end
+
+      if !site_installed?
+        site_install
+        network_install
+      end
+
+      check_plugins
+      activate_theme
+
+      link_release
+    end
+
+    def check_dependencies
+      if !svn_installed?
+        log "Installing Subversion"
+        if ssh.run("sudo apt-get install -y subversion").success?
+          log "Subversion installed"
+        end
+      end
+    end
+
+    def setup_shared_dirs
+      dirs = [
+        'wordpress',
+        'wordpress/uploads',
+        'wordpress/core',
+        'wordpress/plugins'
+      ]
+
+      dirs.each do |path|
+        ssh.run("mkdir -p #{shared_path(path)}")
+      end
+    end
+
+    def generate_config
+      mysql = config.wordpress.mysql
+      if mysql.nil?
+        error "Missing :mysql section of the config."
+      end
+
+      cmd = [
+        "wp core config",
+        "--dbname=#{mysql.database}",
+        "--dbhost=#{mysql.host || 'localhost'}",
+        "--dbuser=#{mysql.user}"
+      ]
+
+      cmd << "--dbpass=#{mysql.password}" if mysql.password
+
+      res = ssh.run("cd #{core_path} && #{cmd.join(' ')}")
+      if res.success?
+        log "A new wordpress config has been generated"
+      else
+        error "Unable to generate config"
+      end
+    end
+
+    def check_config
+      if !ssh.file_exists?(shared_path('wp-config.php'))
+        log "Creating wordpress config at 'shared/wp-config.php'"
+        generate_config
+      end
+    end
+
+    def site_installed?
+      ssh.run("cd #{release_path} && wp").success?
+    end
+
+    def site_install
+      if config.wordpress.site
+        site = config.wordpress.site
+
+        cmd = [
+          "wp core install",
+          "--url=#{site.url}",
+          "--title=#{site.title}",
+          "--admin_name=#{site.admin_name}",
+          "--admin_email=#{site.admin_email}",
+          "--admin_password=#{site.admin_password}"
+        ].join(' ')
+
+        result = ssh.run("cd #{release_path} && #{cmd}")
+        if result.failure?
+          error "Failed to setup site. #{result.output}"
+        end
+      else
+        error "Please define :site section"
+      end
+    end
+
+    def network_install
+      if config.wordpress.network
+        network = config.wordpress.network
+
+        cmd = [
+          "wp core install-network",
+          "--title=#{network.title}",
+        ].join(' ')
+
+        result = ssh.run("cd #{release_path} && #{cmd}")
+        if result.failure?
+          error "Failed to setup WP network. #{result.output}"
+        end
+      end
+    end
+
+    def link_shared_data
+      log "Linking shared data"
+
+      ssh.run("cp -a #{core_path} #{release_path}")
+      ssh.run("cp #{shared_path('wp-config.php')} #{release_path('wp-config.php')}")
+      ssh.run("ln -s #{shared_path('wordpress/uploads')} #{release_path('wp-content/uploads')}")
+    end
+
+    def check_plugins
+      plugins = config.wordpress.plugins
+
+      if plugins
+        if plugins.kind_of?(Array)
+          plugins.each do |p|
+            if p.kind_of?(String)
+              plugin_install(p)
+            elsif p.kind_of?(Hash)
+              name, url = p.to_a.flatten.map(&:to_s)
+              plugin_custom_install(name, url)
+            end
+          end
+        else
+          error "Config file has invalid plugins section"
+        end
+      end
+    end
+
+    def checkout_theme
+      if config.wordpress
+        if config.wordpress.theme
+          checkout_code("wp-content/themes/#{config.wordpress.theme}")
+        else
+          error "Theme name is not defined."
+        end
+      else
+        error "Config does not contain 'wordpress' section"
+      end
+    end
+
+    def activate_theme
+      name = config.wordpress.theme
+      result = ssh.run("cd #{release_path} && wp theme activate #{name}")
+
+      if result.failure?
+        error "Unable to activate theme. Error: #{result.output}"
+      end
+    end
+  end
+end

data/lib/shuttle/errors.rb

@@ -0,0 +1,5 @@
+module Shuttle
+  class Error       < StandardError ; end
+  class ConfigError < Error ; end
+  class DeployError < Error ; end
+end

data/lib/shuttle/helpers.rb

@@ -0,0 +1,50 @@
+module Shuttle
+  module Helpers
+    LEVEL_COLORS = {
+      'info'    => :green,
+      'warning' => :yellow,
+      'error'   => :red
+    }
+
+    def log(message, level='info')
+      prefix = "----->".send(LEVEL_COLORS[level])
+      STDOUT.puts("#{prefix} #{message}")
+    end
+
+    def error(message)
+      log("ERROR: #{message}", 'error')
+      raise DeployError, message
+    end
+
+    def git_installed?
+      ssh.run("which git").success?
+    end
+
+    def svn_installed?
+      ssh.run("which svn").success?
+    end
+
+    def release_exists?
+      ssh.directory_exists?(release_path)
+    end
+
+    def stream_output(buff)
+      str = buff.split("\n").map { |str| "       #{str}"}.join("\n")
+      STDOUT.puts(str)
+    end
+
+    def git_remote
+      result = ssh.run("cd #{scm_path} && git remote -v")
+
+      if result.success?
+        result.output.scan(/^origin\t(.+)\s\(fetch\)/).flatten.first
+      else
+        nil
+      end
+    end
+
+    def deployer_hostname
+      `hostname`.strip
+    end
+  end
+end