capistrano_recipes 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmM2MzhjY2ZhZjY2ZTc4ODhjYzJjY2Q3NWYxZjFkZjZiZjczYWZkMQ==
+  data.tar.gz: !binary |-
+    YmU5OGQ3NjRkMDhmNTczNTQwZjE5MzZhNTlkMjg4MzE2OTY1NjRhZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzRiNDhjZGRmNTRkY2JmNjhjYTBjYWFmZWFmOWY5MjA1Yzc0NmE2Yjc0NGQ1
+    MDgzMzY1Nzg3OGMyZjg0MGE5ZWUwMjBhZDE0NDQ1NTZjNWZlMzM2OTZjYzE1
+    NzcyODljNWRmYTBkMjZjNTM0NDBlNjc4OWRjZDI5NmJkYjFmNDY=
+  data.tar.gz: !binary |-
+    MmE1ZDlhYmZiZDAwMmMzYWU0ZmYyM2ZmNDVkMTRlNWI1ZDNlNmRhNjBmM2Ux
+    MzRmYTUzNDhiOTk3ZTYzODcyODQxZjRjYjgyZTNkN2QyZjgzMDZhYWNiNzZk
+    ZGEyYTE3NDE1ZWFjYmMzMmVkMmU5MTdmZjE0ZGRkMTdiNjMzZmY=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--backtrace
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano_recipes.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Aleman
+
+MIT License
+
+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,89 @@
+# Capistrano Recipes [![Build Status](https://travis-ci.org/fernandoaleman/capistrano_recipes.png?branch=master)](https://travis-ci.org/fernandoaleman/capistrano_recipes) [![Dependency Status](https://gemnasium.com/fernandoaleman/capistrano_recipes.png)](https://gemnasium.com/fernandoaleman/capistrano_recipes)
+
+Powerful capistrano recipes to make your rails deployments fast and easy.
+
+## Quickstart Guide
+
+Create a file called 'Capfile' in your application's root directory.
+
+For a single environment add:
+
+```ruby
+require 'capistrano/recipes'
+
+use_recipes :bundler, :git, :rails_assets
+
+server 'Add your web server domain or ip here', :app, :web, :db, :primary => true
+
+set :application, "Set application name here"
+set :deploy_to,   "/path/to/your/app/here"
+set :repository,  "Set repository location here"
+set :domain,      "Set domain name here"
+```
+
+For a multistage environment add:
+
+```ruby
+require 'capistrano/recipes'
+
+use_recipes :bundler, :git, :multistage, :rails_assets
+
+stage :staging, :branch => :dev, :default => true do
+  server 'Add your web server domain or ip here', :app, :web, :db, :primary => true
+end
+
+stage :production, :branch => :master do
+  server 'Add your web server domain or ip here', :app, :web, :db, :primary => true
+end
+
+set :application, "Set application name here"
+set :deploy_to,   "/path/to/your/app/here"
+set :repository,  "Set repository location here"
+set :domain,      "Set domain name here"
+```
+
+To add a single recipe:
+```ruby
+use_recipe :bundle
+```
+
+To add multiple recipes:
+```ruby
+use_recipes :bundle, :git, :multistage, :rails_assets
+```
+
+## Recipes
+| Recipe        | Documentation |
+| ------------  | ------------- |
+| :bundle       | [Bundle recipe documentation](https://github.com/fernandoaleman/capistrano_recipes/wiki/Bundle) |
+| :git          | [Git recipe documentation](https://github.com/fernandoaleman/capistrano_recipes/wiki/Git) |
+| :multistage   | [Multistage recipe documentation](https://github.com/fernandoaleman/capistrano_recipes/wiki/Multistage) |
+| :mysql        | [Mysql](https://github.com/fernandoaleman/capistrano_recipes/wiki/Mysql) |
+| :nginx        | [Nginx](https://github.com/fernandoaleman/capistrano_recipes/wiki/Nginx) |
+| :rails_assets | [Rails assets recipe documentation](https://github.com/fernandoaleman/capistrano_recipes/wiki/Rails-Assets) |
+| :unicorn      | [Unicorn](https://github.com/fernandoaleman/capistrano_recipes/wiki/Unicorn) |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano_recipes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano_recipes
+
+## Documentation
+For more detailed information, visit the [wiki](https://github.com/fernandoaleman/capistrano_recipes/wiki).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/capistrano_recipes.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'capistrano_recipes'
+  s.version       = '1.0.0'
+  s.authors       = ['Fernando Aleman']
+  s.email         = ['fernandoaleman@mac.com']
+  s.description   = 'Capistrano recipes to make your deployments fast and easy'
+  s.summary       = 'Capistrano deployment recipes'
+  s.homepage      = 'https://github.com/fernandoaleman/capistrano_recipes'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'capistrano',  '~> 2.12'
+  s.add_dependency 'bundler',     '~> 1.3'
+  
+  s.add_development_dependency 'rspec', '~> 2.5'
+end

data/lib/capistrano/recipes/bundle.rb

@@ -0,0 +1,9 @@
+require 'bundler/capistrano'
+
+module CapistranoRecipes
+  module Bundle
+    def self.load_into(configuration)
+      # Nothing to do
+    end
+  end
+end

data/lib/capistrano/recipes/bundler.rb

@@ -0,0 +1,2 @@
+require 'capistrano/recipes/bundle'
+CapistranoRecipes::Bundler = CapistranoRecipes::Bundle

data/lib/capistrano/recipes/git.rb

@@ -0,0 +1,119 @@
+module CapistranoRecipes
+  module Git
+    def self.load_into(configuration)
+      configuration.load do
+        default_run_options[:pty]   = true
+        ssh_options[:forward_agent] = true
+
+        set(:repository)        { abort "Please specify repository, set :repository, 'foo'" }
+        
+        _cset :branch,          'master'
+        _cset :use_sudo,        false
+        _cset :check_repo,      true
+        
+        set :migrate_target,    :current
+
+        set(:latest_release)    { fetch(:current_path) }
+        set(:release_path)      { fetch(:current_path) }
+        set(:releases_path)     { fetch(:current_path) }
+        set(:current_release)   { fetch(:current_path) }
+        set(:current_revision)  { capture("cd #{deploy_to} && git rev-parse --short HEAD").strip }
+        set(:latest_revision)   { capture("cd #{deploy_to} && git rev-parse --short HEAD").strip }
+        set(:previous_revision) { capture("cd #{deploy_to} && git rev-parse --short HEAD@{1}").strip }
+
+        set :local_branch do
+          `git symbolic-ref HEAD 2> /dev/null`.strip.sub('refs/heads/', '')
+        end
+        
+        after 'deploy:setup' do
+          run "git clone --no-checkout #{repository} #{current_path}"
+        end
+        
+        namespace :deploy do
+          desc 'Deploy and start a cold application'
+          task :cold do
+            update
+            migrate
+          end
+
+          desc 'Update the deployed code through transaction to rollback if it has errors'
+          task :update do
+            transaction do
+              update_code
+            end
+          end
+
+          desc 'Update the deployed code'
+          task :update_code, :except => { :no_release => true } do
+            run "cd #{deploy_to} && git fetch origin && git reset --hard origin/#{branch}"
+            finalize_update
+          end
+          
+          desc 'Run migrations'
+          task :migrate, :roles => :db, :only => { :primary => true } do
+            run "cd #{deploy_to} && RAILS_ENV=#{rails_env} #{rake} db:migrate"
+          end
+
+          desc 'Deploy and run migrations'
+          task :migrations do
+            update
+            migrate
+            restart
+          end
+
+          namespace :rollback do
+            desc 'Move repo back to the previous version of HEAD'
+            task :repo, :except => { :no_release => true } do
+              set :branch, "HEAD@{1}"
+              deploy.default
+            end
+
+            desc 'Rewrite reflog so HEAD@{1} will continue to point to the next previous release'
+            task :cleanup, :except => { :no_release => true } do
+              run "cd #{deploy_to}; git reflog delete --rewrite HEAD@{1}; git reflog delete --rewrite HEAD@{1}"
+            end
+
+            desc 'Roll back to the previously deployed version'
+            task :default do
+              rollback.repo
+              rollback.cleanup
+            end
+          end
+
+          namespace :pending do
+            task :diff, :except => { :no_release => true } do
+              # nothing
+            end
+
+            desc 'Show pending commits'
+            task :default do
+              system("git log --pretty=medium --stat #{current_revision}..origin/#{branch}")
+            end
+          end
+
+          desc 'Check that local git repo is in sync with remote'
+          task :check_repo do
+            unless `git rev-parse HEAD` == `git rev-parse origin/#{branch}`
+              puts "WARNING: HEAD is not the same as origin/#{branch}"
+              puts "Run `git push origin #{branch}` to sync changes."
+              exit
+            end if fetch(:check_repo)
+          end
+          %w[deploy deploy:cold deploy:migrations].each do |task|
+            before "#{task}", "deploy:check_repo"
+          end
+          
+          task :symlink do
+            # nothing
+            # if task is not being used, it will not appear in `cap -T`
+          end
+          
+          task :create_symlink do
+            # nothing
+            # if task is not being used, it will not appear in `cap -T`
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/recipes/multistage.rb

@@ -0,0 +1,73 @@
+module CapistranoRecipes
+  module Multistage
+    def self.load_into(configuration)
+      configuration.load do
+        set :multistage_config, Config.new(configuration)
+
+        def stage(name, options={}, &block)
+          set :default_stage, name.to_sym if options.delete(:default)
+          multistage_config.stage(name, options)
+          callbacks[:start].detect { |c| c.source == 'multistage:ensure' }.except << name.to_s
+
+          task(name) do
+            set :current_stage, name.to_s
+            set :rails_env, name.to_s
+            options.each do |k, v|
+              set k, v if v
+            end
+            block.call if block
+          end
+        end
+
+        namespace :multistage do
+          task :ensure do
+            unless exists?(:current_stage)
+              if stage = multistage_config.inferred_stage
+                find_and_execute_task(stage.name)
+              elsif exists?(:default_stage)
+                find_and_execute_task(default_stage)
+              else
+                stage_names = multistage_config.stages.map(&:name)
+                abort "No stage specified. Please specify one of: #{stage_names.join(', ')} (e.g. `cap #{stage_names.first} #{ARGV.last}')"
+              end
+            end
+          end
+        end
+
+        on :start, 'multistage:ensure'
+      end
+    end
+
+    # Handles multistage configuration
+    class Config
+      attr_reader :config
+      attr_reader :stages
+
+      def initialize(config)
+        @config = config
+        @stages = []
+      end
+
+      def stage(name, options={})
+        stages << Stage.new(name, options)
+      end
+
+      def inferred_stage
+        if config.using_recipe?(:git)
+          branch = config.local_branch
+          stages.find { |stage| stage.options[:branch].to_s == branch }
+        end
+      end
+    end
+
+    class Stage
+      attr_reader :name
+      attr_reader :options
+
+      def initialize(name, options={})
+        @name    = name
+        @options = options
+      end
+    end
+  end
+end

data/lib/capistrano/recipes/mysql.rb

@@ -0,0 +1,134 @@
+module CapistranoRecipes
+  module Mysql
+    def self.load_into(configuration)
+      configuration.load do
+        # MySQL admin user with access to create databases and grant permissions
+        _cset :mysql_admin_user, lambda { ask "Enter #{rails_env} database username with access to create database" }
+
+        # Application database adapter
+        _cset :mysql_adapter, lambda { 'mysql2' }
+        
+        # Application database name
+        _cset :mysql_database, lambda { "#{application}_#{rails_env}" }
+        
+        # Application database user
+        _cset :mysql_user, lambda { ask "Enter #{rails_env} database username" }
+
+        # Application database password
+        _cset(:mysql_password) { password_prompt "Enter #{rails_env} database password" }
+
+        # Application database host
+        _cset :mysql_host, lambda { 'localhost' }
+
+        # Application database encoding
+        _cset :mysql_encoding, lambda { 'utf8' }
+
+        # Path to local database config template
+        _cset :mysql_local_config_template, lambda { "#{templates_path}/mysql.yml.erb" }
+
+        # Path to remote database config file
+        _cset :mysql_remote_config_file, lambda { "#{config_path}/database.yml" }
+
+        # Application database backup file
+        _cset :mysql_backup_file, lambda { "#{application}-backup.sql.bz2" }
+
+        # Path to local database backup file
+        _cset :mysql_local_backup_file, lambda { "tmp/#{mysql_backup_file}" }
+
+        # Path to remote database backup file
+        _cset :mysql_remote_backup_file, lambda { "#{backup_path}/#{mysql_backup_file}" }
+
+        namespace :mysql do
+          desc 'Generate the database.yml configuration file'
+          task :setup, :roles => :app, :except => { :no_release => true } do
+            upload_template mysql_local_config_template, mysql_remote_config_file
+          end
+          after 'deploy:setup' do
+            mysql.setup if agree? 'Setup database.yml?'
+            mysql.create if agree? 'Create database?'
+          end
+
+          desc 'Create mysql database'
+          task :create, :roles => :db, :only => { :primary => true } do
+            sql = <<-SQL.gsub(/^ {14}/, '')
+              "CREATE DATABASE #{mysql_database};
+              GRANT ALL PRIVILEGES ON #{mysql_database}.* TO #{mysql_user}@localhost IDENTIFIED BY '#{mysql_password}';"
+            SQL
+
+            mysql_admin = mysql_admin_user
+
+            run "mysql --user=#{mysql_user} -p --execute=#{sql}" do |channel, stream, data|
+              if data =~ /^Enter password:/
+                pass = password_prompt "Enter database password for '#{mysql_admin}'"
+                channel.send_data "#{pass}\n"
+              end
+            end
+          end
+
+          desc 'Symlink the database.yml file into the latest deploy'
+          task :symlink, :roles => :app, :except => { :no_release => true } do
+            run "ln -nfs #{mysql_remote_config} #{release_path}/config/database.yml"
+          end
+          after 'deploy:finalize_update', 'mysql:symlink'
+
+          desc 'Populate the database with seed data'
+          task :seed do
+            run "cd #{current_path} && #{rake} RAILS_ENV=#{rails_env} db:seed"
+          end
+          after 'deploy:cold' do
+            mysql.seed if agree? 'Load seed data into database?'
+          end
+
+          desc 'Performs a mysqldump of the database'
+          task :dump, :roles => :db, :only => { :primary => true } do
+            prepare_from_yaml
+
+            run "mysqldump --user=#{db_user} -p --host=#{db_host} #{db_name} | bzip2 -z9 > #{mysql_remote_backup_file}" do |channel, stream, out|
+            channel.send_data "#{db_pass}\n" if out =~ /^Enter password:/
+              puts out
+            end
+          end
+
+          desc "Download compressed database dump"
+          task :fetch_dump, :roles => :db, :only => { :primary => true } do
+            download mysql_remote_backup_file, mysql_local_backup_file, :via => :scp
+          end
+
+          desc "Restore the database from the latest compressed dump"
+          task :restore, :roles => :db, :only => { :primary => true } do
+            prepare_from_yaml
+
+            run "bzcat #{mysql_remote_backup_file} | mysql --user=#{db_user} -p --host=#{db_host} #{db_name}" do |channel, stream, out|
+            channel.send_data "#{db_pass}\n" if out =~ /^Enter password:/
+              puts out
+            end if agree? 'Are you sure you want to restore your database?'
+          end
+
+          %w[start stop restart status].each do |command|
+            desc "#{command.capitalize} mysql"
+            task command, :roles => :db, :only => { :primary => true } do
+              run "#{sudo} service mysqld #{command}"
+            end
+          end
+        end
+
+        def prepare_from_yaml
+          set(:db_user) { db_config[rails_env]["username"] }
+          set(:db_pass) { db_config[rails_env]["password"] }
+          set(:db_host) { db_config[rails_env]["host"] }
+          set(:db_name) { db_config[rails_env]["database"] }
+        end
+        
+        def db_config
+          @db_config ||= fetch_db_config
+        end
+        
+        def fetch_db_config
+          require 'yaml'
+          file = capture "cat #{mysql_remote_config_file}"
+          db_config = YAML.load(file)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/recipes/nginx.rb

@@ -0,0 +1,75 @@
+module CapistranoRecipes
+  module Nginx
+    def self.load_into(configuration)
+      configuration.load do
+        # Nginx path on server
+        _cset :nginx_path, '/etc/nginx'
+
+        # Nginx http port
+        _cset :nginx_port, '80'
+
+        # Path to local nginx vhost template
+        _cset(:nginx_local_site_available_template) { "#{templates_path}/nginx.vhost.erb" }
+
+        # Path to remote sites-available location
+        _cset :nginx_remote_site_available_file, lambda { "#{nginx_path}/sites-available/#{application}" }
+
+        # Path to remote sites-enabled location
+        _cset :nginx_remote_site_enabled_link, lambda { "#{nginx_path}/sites-enabled/#{application}" }
+
+        # Whether or not to use ssl
+        _cset :use_ssl, false
+
+        # Nginx https port
+        _cset :nginx_ssl_port, '443'
+
+        # Nginx ssl directory on server
+        _cset :nginx_ssl_dir, 'ssl'
+
+        # Nginx ssl path on server
+        _cset :nginx_ssl_path, lambda { File.join nginx_path, nginx_ssl_dir }
+
+        # Nginx ssl certificates directory on server
+        _cset :nginx_ssl_certs_dir, 'certs'
+
+        # Nginx ssl private keys directory on server
+        _cset :nginx_ssl_private_dir, 'private'
+
+        # Nginx ssl certificates path on server
+        _cset :nginx_ssl_certs_path, lambda { File.join nginx_ssl_path, nginx_ssl_certs_dir }
+
+        # Nginx ssl private keys path on server
+        _cset :nginx_ssl_private_path, lambda { File.join nginx_ssl_path, nginx_ssl_private_dir }
+
+        # Nginx ssl certificate file
+        _cset :nginx_ssl_cert, lambda { "#{application}.crt" }
+
+        # Nginx ssl key file
+        _cset :nginx_ssl_key, lambda { "#{application}.key" }
+
+        def using_ssl?
+          fetch(:use_ssl)
+        end
+
+        namespace :nginx do
+          desc 'Create and upload nginx vhost'
+          task :setup, :roles => :web, :except => { :no_release => true } do
+            upload_template nginx_local_site_available_template, nginx_remote_site_available_file
+            run "#{sudo} ln -nfs #{nginx_remote_site_available_file} #{nginx_remote_site_enabled_link}"
+            restart
+          end
+          after 'deploy:setup' do
+            nginx.setup if agree?("Create and upload nginx vhost for #{application}?")
+          end
+
+          %w[start stop restart status].each do |command|
+            desc "#{command.capitalize} nginx"
+            task command, :roles => :app, :except => { :no_release => true } do
+              run "#{sudo} service nginx #{command}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/recipes/rails_assets.rb

@@ -0,0 +1,7 @@
+module CapistranoRecipes
+  module RailsAssets
+    def self.load_into(configuration)
+      configuration.load('deploy/assets')
+    end
+  end
+end

data/lib/capistrano/recipes/templates/mysql.yml.erb

@@ -0,0 +1,7 @@
+<%= rails_env %>:
+  adapter: <%= mysql_adapter %>
+  database: <%= mysql_database %>
+  username: <%= mysql_user %>
+  password: <%= mysql_password %>
+  host: <%= mysql_host %>
+  encoding: <%= mysql_encoding %>