capistrano-cookbook 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35eb6b3a910ba77b7eb89ce34b18a058c3b3be03
+  data.tar.gz: a953b777c7e7d98576cd022be446b29e9be8fca4
+SHA512:
+  metadata.gz: 85b4b56e0ae319ec6e4d23fd4896a880eefc3be20ed9429345da128a95d656d742a4d503033c1201bb6cf044b00b8a6dc6551004bb3359b7a21dda7c822ac1a1
+  data.tar.gz: 9fc81774aeda29f06691d0932bf6e3d3ab7dfce740e7ba53bd518632ef09679b5f4de2501de37d1801968f35d659451ef1f1c3a29a2e0da53bc7acf85028c715

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
+DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-cookbook.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Dixon
+
+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,246 @@
+# Capistrano::Cookbook
+
+A collection of Capistrano 3 Compatible tasks to make deploying Rails and Sinatra based applications easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-cookbook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-cookbook
+
+## Usage
+
+### Including Tasks
+
+To include all tasks from the gem, add the following to your `Capfile`:
+
+```ruby
+require 'capistrano/cookbook'
+```
+
+Otherwise you can include tasks individually:
+
+```ruby
+require 'capistrano/cookbook/check_revision'
+require 'capistrano/cookbook/compile_assets_locally'
+require 'capistrano/cookbook/create_database'
+require 'capistrano/cookbook/logs'
+require 'capistrano/cookbook/monit'
+require 'capistrano/cookbook/nginx'
+require 'capistrano/cookbook/restart'
+require 'capistrano/cookbook/run_tests'
+require 'capistrano/cookbook/setup_config'
+```
+
+### The Tasks
+
+#### Check Revision
+
+Checks that the remote branch the selected stage deploys from, matches the current local version, if it doesn't the deploy will be halted with an error. 
+
+Add the following to `deploy.rb`
+
+```ruby
+before :deploy, 'deploy:check_revision'
+```
+
+#### Compile Assets Locally
+
+Compiles local assets and then rsyncs them to the production server. Avoids the need for a javascript runtime on the target machine and saves a significant amount of time when deploying to multiple web frontends.
+
+Add the following to `deploy.rb`
+
+``` ruby
+ after 'deploy:symlink:shared', 'deploy:compile_assets_locally'
+ ```
+
+#### Create Database
+
+Currently only works with Postgresql on configurations where your web server and db server are the same machine, e.g. single box deployments. This task will:
+
+* Check to see if a remote `database.yml` exists in `APP_PATH/shared/config`, if not attempt to copy one from `APP_PATH/shared/config`.
+* Download the remote `database.yml`
+* Create the Postgres user specified in `database.yml` if it doesn't already exist
+* Create the Database specified in `database.yml` if it doesn't already exist
+* Grant the user all permissions on that database
+
+Run using:
+
+``` bash
+cap STAGE database:create
+```
+
+#### Logs
+
+Allows remote log files (anything in `APP_PATH/shared/log`) to be tailed locally with Capistrano rather than SSHing in.
+
+To tail the log file `APP_PATH/shared/log/production.log` on the `production` stage:
+
+``` bash
+cap production 'logs:tail[production]'
+```
+
+To tail the log file `APP_PATH/shared/log/unicorn.log`
+
+``` bash
+cap production 'logs:tail[unicorn]'
+```
+
+#### Monit
+
+Provides convenience tasks for restarting the Monit service.
+
+Available actions are `start`, `stop` and `restart`.
+
+Usage:
+
+```bash
+cap STAGE monit:start
+cap STAGE monit:stop
+cap STAGE monit:restart
+```
+
+#### Nginx
+
+Provides convenience tasks for interacting with Nginx using its `init.d` script as well as an additional task to remove the `default` virtualhost from `/etc/nginx/sites-enabled`
+
+Available actions are `start`, `stop`, `restart`, `reload`, `remove_default_vhost`.
+
+`reload` will reload the nginx virtualhosts without restarting the server.
+
+Usage:
+
+```bash
+cap STAGE nginx:start
+cap STAGE nginx:stop
+cap STAGE nginx:restart
+cap STAGE nginx:remove_default_vhost
+```
+
+#### Restart
+
+Provides Commands for interacting with the Unicorn app server via an `init.d` script.
+
+Usage:
+
+``` bash
+cap STAGE deploy:start
+cap STAGE deploy:stop
+cap STAGE deploy:force-stop
+cap STAGE deploy:restart
+cap STAGE deploy:upgrade
+```
+
+#### Run Tests
+
+Allows a test suite to be automatically run with `rspec`, if the tests pass the deploy will continue, if they fail, the deploy will halt and the test output will be displayed.
+
+Usage:
+
+Define the tests to be run in `deploy.rb`
+
+``` ruby
+set(:tests, ['spec'])
+```
+
+and add a hook in `deploy.rb` to run them automatically:
+
+``` ruby
+before "deploy", "deploy:run_tests"
+```
+
+#### Setup Config
+
+The `deploy:setup_config` tasks provides a simple way to automate the generation of server specific configuration files and the setting up of any required symlinks outside of the applications normal directory structure.
+
+If no values are provided in `deploy.rb` to override the defaults then this task includes opinionated defaults to setup a server for deployment as explained in the book [Reliably Deploying Rails Applications](https://leanpub.com/deploying_rails_applications) and [this tutorial](http://www.talkingquickly.co.uk/2014/01/deploying-rails-apps-to-a-vps-with-capistrano-v3/).
+
+Each of the `config_files` will be created in `APP_PATH/shared.config`.
+
+The task looks in the following locations for a template file with a corresponding name with a `.erb` extension:
+
+* `config/deploy/STAGE/FILENAME.erb`
+* `config/deploy/shared/FILENAME.erb`
+* `templates/FILENAME.erb` directory of this gem ([github link](https://github.com/TalkingQuickly/capistrano-cookbook/tree/master/lib/capistrano/cookbook/templates))  
+
+For any config files included in the `source` part of an entry in the `symlinks` array, a symlink will be created to the corresponding `link` location on the target machine.
+
+Finally any config files included in `executable_config_files` will be marked as executable.
+
+This task will also automatically invoke the following tasks:
+
+* `nginx:remove_default_vhost`
+* `nginx:reload`
+* `monit:restart`
+
+To ensure configuration file changes are picked up correctly.
+
+The defaults are:
+
+Config Files:
+
+``` ruby
+set(
+  :config_files,
+  %w(
+  nginx.conf
+  database.example.yml
+  log_rotation
+  monit
+  unicorn.rb
+  unicorn_init.sh
+))
+```
+
+Symlinks:
+
+```ruby
+set(
+  :symlinks,
+  [
+    {
+      source: "nginx.conf",
+      link: "/etc/nginx/sites-enabled/{{full_app_name}}"
+    },
+    {
+      source: "unicorn_init.sh",
+      link: "/etc/init.d/unicorn_{{full_app_name}}"
+    },
+    {
+      source: "log_rotation",
+     link: "/etc/logrotate.d/{{full_app_name}}"
+    },
+    {
+      source: "monit",
+      link: "/etc/monit/conf.d/{{full_app_name}}.conf"
+    }
+  ]
+)
+```
+
+Executable Config Files:
+
+```ruby
+set(
+  :executable_config_files,
+  w(
+    unicorn_init.sh
+  )
+)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/capistrano-cookbook/fork )
+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 @@
+require "bundler/gem_tasks"

data/capistrano-cookbook.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/cookbook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-cookbook"
+  spec.version       = Capistrano::Cookbook::VERSION
+  spec.authors       = ["Ben Dixon"]
+  spec.email         = ["ben@talkingquickly.co.uk"]
+  spec.summary       = %q{Selection of Capistrano 3 tasks to reduce boilerplate required when deploying Rails and Sinatra applications}
+  spec.homepage      = "https://github.com/TalkingQuickly/capistrano-cookbook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "capistrano", ['~> 3.1', '> 3.1.0']
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/cookbook/check_revision.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/check_revision.cap",File.dirname(__FILE__))

data/lib/capistrano/cookbook/compile_assets_locally.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/compile_assets_locally.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/create_database.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/create_database.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/helpers/setup_config_values.rb

@@ -0,0 +1,57 @@
+module Capistrano
+  module Cookbook
+    class SetupConfigValues
+      def symlinks
+        fetch(:symlinks) || symlinks_defaults
+      end
+
+      def executable_config_files
+        fetch(:executable_config_files) || executable_config_files_defaults
+      end
+
+      def config_files
+        fetch(:config_files) || config_files_defaults
+      end
+
+      private
+
+      def symlinks_defaults
+        [
+          {
+            source: "nginx.conf",
+            link: "/etc/nginx/sites-enabled/{{full_app_name}}"
+          },
+          {
+            source: "unicorn_init.sh",
+            link: "/etc/init.d/unicorn_{{full_app_name}}"
+          },
+          {
+            source: "log_rotation",
+           link: "/etc/logrotate.d/{{full_app_name}}"
+          },
+          {
+            source: "monit",
+            link: "/etc/monit/conf.d/{{full_app_name}}.conf"
+          }
+        ]
+      end
+
+      def executable_config_files_defaults
+        %w(
+          unicorn_init.sh
+        )
+      end
+
+      def config_files_defaults
+        %w(
+          nginx.conf
+          database.example.yml
+          log_rotation
+          monit
+          unicorn.rb
+          unicorn_init.sh
+        )
+      end
+    end
+  end
+end

data/lib/capistrano/cookbook/helpers/substitute_strings.rb

@@ -0,0 +1,12 @@
+# we often want to refer to variables which
+# are defined in subsequent stage files. This
+# let's us use the {{var}} to represent fetch(:var)
+# in strings which are only evaluated at runtime.
+
+def sub_strings(input_string)
+  output_string = input_string
+  input_string.scan(/{{(\w*)}}/).each do |var|
+    output_string.gsub!("{{#{var[0]}}}", fetch(var[0].to_sym))
+  end
+  output_string
+end

data/lib/capistrano/cookbook/helpers/template.rb

@@ -0,0 +1,35 @@
+# will first try and copy the file:
+# config/deploy/#{full_app_name}/#{from}.erb
+# to:
+# shared/config/to
+# if the original source path doesn exist then it will
+# search in:
+# config/deploy/shared/#{from}.erb
+# otherwise it will search in the gems template directory
+# this allows files which are common to all enviros to
+# come from a single source while allowing specific
+# ones to be over-ridden
+# if the target file name is the same as the source then
+# the second parameter can be left out
+def smart_template(from, to=nil)
+  to ||= from
+  full_to_path = "#{shared_path}/config/#{to}"
+  if from_erb_path = template_file(from)
+    from_erb = StringIO.new(ERB.new(File.read(from_erb_path)).result(binding))
+    upload! from_erb, full_to_path
+    info "copying: #{from_erb} to: #{full_to_path}"
+  else
+    error "error #{from} not found"
+  end
+end
+
+def template_file(name)
+  if File.exist?((file = "config/deploy/#{fetch(:full_app_name)}/#{name}.erb"))
+    return file
+  elsif File.exist?((file = "config/deploy/shared/#{name}.erb"))
+    return file
+  elsif File.exist?(file = File.expand_path("../templates/#{name}.erb",File.dirname(__FILE__)))
+    return file    
+  end
+  return nil
+end

data/lib/capistrano/cookbook/logs.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/logs.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/monit.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/monit.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/nginx.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/nginx.cap",File.dirname(__FILE__))

data/lib/capistrano/cookbook/restart.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/restart.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/run_tests.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/run_tests.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/setup_config.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/setup_config.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/tasks/check_revision.cap

@@ -0,0 +1,14 @@
+namespace :deploy do
+  desc "checks whether the currently checkout out revision matches the
+        remote one we're trying to deploy from"
+  task :check_revision do
+    branch = fetch(:branch)
+    unless `git rev-parse HEAD` == `git rev-parse origin/#{branch}`
+      puts "WARNING: HEAD is not the same as origin/#{branch}"
+      puts "Run `git push` to sync changes or make sure you've"
+      puts "checked out the branch: #{branch} as you can only deploy"
+      puts "if you've got the target branch checked out"
+      exit
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/compile_assets_locally.cap

@@ -0,0 +1,16 @@
+namespace :deploy do
+  desc "compiles assets locally then rsyncs"
+  task :compile_assets_locally do
+    run_locally do
+      execute "RAILS_ENV=#{fetch(:rails_env)} bundle exec rake assets:precompile"
+    end
+    on roles(:app) do |role|
+      run_locally do
+        execute"rsync -av ./public/assets/ #{role.user}@#{role.hostname}:#{release_path}/public/assets/;"
+      end
+    end
+    run_locally do
+      execute "rm -rf ./public/assets"
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/create_database.cap

@@ -0,0 +1,32 @@
+# Inspired by https://gist.github.com/dv/10370719
+
+namespace :database do
+  desc "fetches the remote database.yml and creates the user and database specified in it currently postgres only. Will only work if your db server also has your rails app on it."
+  task :create do
+    on primary(:db) do |host|
+      unless test("[ -f #{shared_path}/config/database.yml ]")
+        execute "cp #{shared_path}/config/database.example.yml #{shared_path}/config/database.yml"
+      end
+      system("scp #{fetch(:deploy_user)}@#{host}:#{shared_path}/config/database.yml db.tmp.yml")
+      yaml =  YAML.load_file("db.tmp.yml")
+      system("rm db.tmp.yml")
+      puts yaml
+      puts fetch(:rails_env)
+      database_config = yaml[fetch(:rails_env).to_s]
+
+      if test %Q{sudo -u postgres psql postgres -tAc "SELECT 1 FROM pg_roles WHERE rolname='#{database_config["username"]}';" | grep -q 1}
+        info "Role #{database_config['username']} already exists"
+      else
+        execute %Q{sudo -u postgres psql -c "create user #{database_config["username"]} with password '#{database_config["password"]}';"}
+      end
+
+      # Create the database
+      if test %Q{sudo -u postgres psql -lqt | cut -d \\| -f 1 | grep -wq #{database_config["database"]}}
+        info "Database #{database_config['database']} already exists"
+      else
+        execute %Q{sudo -u postgres psql -c "create database #{database_config["database"]};"}
+        execute %Q{sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE #{database_config["database"]} to #{database_config["username"]};"}
+      end
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/logs.cap

@@ -0,0 +1,14 @@
+namespace :logs do
+  task :tail, :file do |t, args|
+    if args[:file]
+      on roles(:app) do
+        execute "tail -f #{shared_path}/log/#{args[:file]}.log"
+      end
+    else
+      puts "please specify a logfile e.g: 'rake logs:tail[logfile]"
+      puts "will tail 'shared_path/log/logfile.log'"
+      puts "remember if you use zsh you'll need to format it as:"
+      puts "rake 'logs:tail[logfile]' (single quotes)"
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/monit.cap

@@ -0,0 +1,10 @@
+namespace :monit do
+  %w(start stop restart).each do |task_name|
+    desc "#{task_name} Monit"
+    task task_name do
+      on roles(:app), in: :sequence, wait: 5 do
+        sudo "service monit #{task_name}"
+      end
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/nginx.cap

@@ -0,0 +1,22 @@
+namespace :nginx do
+  %w(start stop restart reload).each do |task_name|
+    desc "#{task } Nginx"
+    task task_name do
+      on roles(:app), in: :sequence, wait: 5 do
+        sudo "/etc/init.d/nginx #{task_name}"
+      end
+    end
+  end
+
+  desc "Remove default Nginx Virtual Host"
+  task "remove_default_vhost" do 
+    on roles(:app) do
+      if test("[ -f /etc/nginx/sites-enabled/default ]")
+      sudo "rm /etc/nginx/sites-enabled/default"
+      puts "removed default Nginx Virtualhost"
+      else
+        puts "No default Nginx Virtualhost to remove"
+      end
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/restart.cap

@@ -0,0 +1,10 @@
+namespace :deploy do
+  desc 'Commands for unicorn application'
+  %w(start stop force-stop restart upgrade reopen-logs).each do |command|
+    task command.to_sym do
+      on roles(:app), in: :sequence, wait: 5 do
+        sudo "/etc/init.d/unicorn_#{fetch(:full_app_name)} #{command}"
+      end
+    end
+  end
+end

data/lib/capistrano/cookbook/tasks/run_tests.cap

@@ -0,0 +1,18 @@
+namespace :deploy do
+  desc "Runs test before deploying, can't deploy unless they pass"
+  task :run_tests do
+    test_log = "log/capistrano.test.log"
+    tests = fetch(:tests)
+    tests.each do |test|
+      puts "--> Running tests: '#{test}', please wait ..."
+      unless system "bundle exec rspec #{test} > #{test_log} 2>&1"
+        puts "--> Tests: '#{test}' failed. Results in: #{test_log} and below:"
+        system "cat #{test_log}"
+        exit;
+      end
+      puts "--> '#{test}' passed"
+    end
+    puts "--> All tests passed"
+    system "rm #{test_log}"
+  end
+end

data/lib/capistrano/cookbook/tasks/setup_config.cap

@@ -0,0 +1,45 @@
+require 'capistrano/cookbook/helpers/setup_config_values'
+require 'capistrano/cookbook/helpers/substitute_strings'
+require 'capistrano/cookbook/helpers/template'
+require 'capistrano/cookbook/nginx'
+require 'capistrano/cookbook/monit'
+require 'securerandom'
+
+namespace :deploy do
+  task :setup_config do
+    conf = ::Capistrano::Cookbook::SetupConfigValues.new
+    on roles(:app) do
+      # make the config dir
+      execute :mkdir, "-p #{shared_path}/config"
+      full_app_name = fetch(:full_app_name)
+
+      # config files to be uploaded to shared/config, see the
+      # definition of smart_template for details of operation.
+      conf.config_files.each do |file|
+        smart_template file
+      end
+
+      # which of the above files should be marked as executable
+      conf.executable_config_files.each do |file|
+        execute :chmod, "+x #{shared_path}/config/#{file}"
+      end
+
+      # symlink stuff which should be... symlinked
+      conf.symlinks.each do |symlink|
+        sudo "ln -nfs #{shared_path}/config/#{symlink[:source]} #{sub_strings(symlink[:link])}"
+      end
+    end
+  end
+end
+
+# remove the default nginx configuration as it will tend
+# to conflict with our configs.
+before 'deploy:setup_config', 'nginx:remove_default_vhost'
+
+# reload nginx to it will pick up any modified vhosts from
+# setup_config
+after 'deploy:setup_config', 'nginx:reload'
+
+# Restart monit so it will pick up any monit configurations
+# we've added
+after 'deploy:setup_config', 'monit:restart'

data/lib/capistrano/cookbook/templates/database.example.yml.erb

@@ -0,0 +1,11 @@
+<%= fetch(:rails_env) %>:
+  adapter: postgresql
+  timeout: 5000
+  encoding: utf8
+  reconnect: false
+  database: <%= "#{fetch(:application)}_#{fetch(:rails_env)}" %>
+  pool: 5
+  username: <%= "#{fetch(:application)}_#{fetch(:rails_env)}" %>
+  password: <%= SecureRandom.hex(12) %>
+  host: 127.0.0.1
+  port: 5432

data/lib/capistrano/cookbook/templates/log_rotation.erb

@@ -0,0 +1,11 @@
+<%= fetch(:deploy_to) %>/shared/log/*.log {
+    daily
+    missingok
+    rotate 52
+    compress
+    delaycompress
+    notifempty
+    sharedscripts
+    endscript
+    copytruncate
+}

data/lib/capistrano/cookbook/templates/mongoid.example.yml.erb

@@ -0,0 +1,69 @@
+<%= fetch(:rails_env) %>:
+  # Configure available database sessions. (required)
+  sessions:
+    # Defines the default session. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: <%= "#{fetch(:applocation)}_#{fetch(:rails_env)}" %>
+      # Provides the hosts the default session can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost
+      options:
+        # Change whether the session persists in safe mode by default.
+        # (default: false)
+         safe: true
+
+        # Change the default consistency model to :eventual or :strong.
+        # :eventual will send reads to secondaries, :strong sends everything
+        # to master. (default: :eventual)
+        # consistency: :eventual
+
+        # How many times Moped should attempt to retry an operation after
+        # failure. (default: 30)
+        # max_retries: 30
+
+        # The time in seconds that Moped should wait before retrying an
+        # operation on failure. (default: 1)
+        # retry_interval: 1
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Configuration for whether or not to allow access to fields that do
+    # not have a field definition on the model. (default: true)
+    # allow_dynamic_fields: true
+
+    # Enable the identity map, needed for eager loading. (default: false)
+     identity_map_enabled: true
+
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serializaion. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    # preload_models: false
+
+    # Protect id and type from mass assignment. (default: true)
+    # protect_sensitive_fields: true
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    # raise_not_found_error: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Skip the database version check, used when connecting to a db without
+    # admin access. (default: false)
+    # skip_version_check: false
+
+    # User Active Support's time zone in conversions. (default: true)
+
+    # Ensure all times are UTC in the app side. (default: false)
+     use_utc: true
+
+

data/lib/capistrano/cookbook/templates/monit.erb

@@ -0,0 +1,22 @@
+<% application = fetch(:application) %>
+set mail-format { subject: <%= "#{fetch(:full_app_name)} - #{fetch(:rails_env)}" %> $SERVICE $EVENT at $DATE }
+
+check process unicorn
+  with pidfile <%= current_path %>/tmp/pids/unicorn.pid
+  start program = "/etc/init.d/unicorn_<%= application %>_<%= fetch(:rails_env)%> start"
+  stop program = "/etc/init.d/unicorn_<%= application %>_<%= fetch(:rails_env)%> stop"
+  if mem is greater than 300.0 MB for 1 cycles then restart       # eating up memory?
+  if cpu is greater than 50% for 2 cycles then alert                  # send an email to admin
+  if cpu is greater than 80% for 30 cycles then restart                # hung process?
+  group unicorn
+
+<% (0..(fetch(:unicorn_worker_count) -1)).each do |worker| %>
+  check process unicorn_worker_<%= (5000 + worker).to_s %>
+    with pidfile <%= current_path %>/tmp/pids/unicorn.<%= (5000 + worker).to_s %>.pid
+    start program = "/bin/true"
+    stop program = "/etc/init.d/unicorn_<%= application %>_<%= fetch(:rails_env)%> kill_worker <%= (5000 + worker).to_s %>"
+    if mem is greater than 350.0 MB for 1 cycles then restart
+    if cpu is greater than 80% for 30 cycles then restart
+
+    group unicorn_workers
+<% end %>

data/lib/capistrano/cookbook/templates/nginx.conf.erb

@@ -0,0 +1,57 @@
+upstream unicorn {
+  server unix:/tmp/unicorn.<%= fetch(:full_app_name) %>.sock fail_timeout=0;
+}
+
+server {
+  server_name <%= fetch(:server_name) %>;
+  listen 80;
+  root <%= fetch(:deploy_to) %>/current/public;
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  try_files $uri/index.html $uri @unicorn;
+  location @unicorn {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://unicorn;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+}
+
+<% if fetch(:enable_ssl) %>
+server {
+  server_name <%= fetch(:server_name) %>;
+  listen 443;
+  root <%= fetch(:deploy_to) %>/current/public;
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  try_files $uri/index.html $uri @unicorn;
+  location @unicorn {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header   X-Forwarded-Proto https;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://unicorn;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+  ssl on;
+  ssl_certificate <%= fetch(:deploy_to) %>/shared/ssl_cert.crt;
+  ssl_certificate_key <%= fetch(:deploy_to) %>/shared/ssl_private_key.key;
+}#
+<% end %>

data/lib/capistrano/cookbook/templates/sidekiq.yml.erb

@@ -0,0 +1,2 @@
+<%= fetch(:rails_env) %>:
+  concurrency: 5

data/lib/capistrano/cookbook/templates/sidekiq_init.sh.erb

@@ -0,0 +1,40 @@
+#!/bin/sh
+set -e
+
+APP_ROOT=<%= current_path %>
+PID=$APP_ROOT/tmp/pids/sidekiq.pid
+CMD="cd $APP_ROOT; RAILS_ENV=<%= "#{fetch(:rails_env)}" %> nohup bundle exec sidekiq -e <%= "#{fetch(:rails_env)}" %> -C <%= current_path %>/config/sidekiq.yml -i 0 -P $PID >> <%= current_path %>/log/sidekiq.log 2>&1 &"
+AS_USER="deploy"
+
+run () {
+  if [ "$(id -un)" = "$AS_USER" ]; then
+    eval $1
+  else
+    su -c "$1" - $AS_USER
+  fi
+}
+
+sig () {
+  test -s "$PID" && kill -$1 `cat $PID`
+}
+
+case "$1" in
+  start)
+    sig 0 && echo >&2 "Already Running" && exit 0
+    run "$CMD"
+    ;;
+  stop)
+    if kill -0 `cat $PID`
+    then
+        cd $APP_ROOT
+        bundle exec sidekiqctl stop $APP_ROOT/tmp/pids/sidekiq.pid 10
+        echo "stopping...."
+    else
+        echo "not running"
+    fi
+    ;;
+  *)
+    echo >&2 "Usage: $0 <start|stop>"
+    exit 1
+    ;;
+esac

data/lib/capistrano/cookbook/templates/unicorn.rb.erb

@@ -0,0 +1,41 @@
+root = "<%= current_path %>"
+working_directory root
+pid "#{root}/tmp/pids/unicorn.pid"
+stderr_path "#{root}/log/unicorn.log"
+stdout_path "#{root}/log/unicorn.log"
+
+listen "/tmp/unicorn.<%= fetch(:full_app_name) %>.sock"
+worker_processes <%= fetch(:unicorn_worker_count) %>
+timeout 40
+preload_app true
+
+# Force unicorn to look at the Gemfile in the current_path
+# otherwise once we've first started a master process, it
+# will always point to the first one it started.
+before_exec do |server|
+  ENV['BUNDLE_GEMFILE'] = "<%= current_path %>/Gemfile"
+end
+
+before_fork do |server, worker|
+   defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
+  # Quit the old unicorn process
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if File.exists?(old_pid) && server.pid != old_pid
+    puts "We've got an old pid and server pid is not the old pid"
+    begin
+      Process.kill("QUIT", File.read(old_pid).to_i)
+      puts "killing master process (good thing tm)"
+    rescue Errno::ENOENT, Errno::ESRCH
+      puts "unicorn master already killed"
+    end
+  end
+end
+
+after_fork do |server, worker|
+  port = 5000 + worker.nr
+  child_pid = server.config[:pid].sub('.pid', ".#{port}.pid")
+  system("echo #{Process.pid} > #{child_pid}")
+   defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.establish_connection
+end

data/lib/capistrano/cookbook/templates/unicorn_init.sh.erb

@@ -0,0 +1,86 @@
+#!/bin/sh
+set -e
+
+# Feel free to change any of the following variables for your app:
+TIMEOUT=${TIMEOUT-60}
+APP_ROOT=<%= current_path %>
+PID_DIR=$APP_ROOT/tmp/pids
+PID=$PID_DIR/unicorn.pid
+CMD="cd $APP_ROOT;  bundle exec unicorn -D -c <%= "#{shared_path}/config/unicorn.rb" %> -E <%= fetch(:rails_env) %>"
+AS_USER=deploy
+set -u
+
+OLD_PIN="$PID.oldbin"
+
+sig () {
+  test -s "$PID" && kill -$1 `cat $PID`
+}
+
+oldsig () {
+  test -s $OLD_PIN && kill -$1 `cat $OLD_PIN`
+}
+
+workersig () {
+  workerpid="$APP_ROOT/tmp/pids/unicorn.$2.pid"
+  
+  test -s "$workerpid" && kill -$1 `cat $workerpid`
+}
+
+run () {
+  if [ "$(id -un)" = "$AS_USER" ]; then
+    eval $1
+  else
+    su -c "$1" - $AS_USER
+  fi
+}
+
+case "$1" in
+start)
+  sig 0 && echo >&2 "Already running" && exit 0
+  run "$CMD"
+  ;;
+stop)
+  sig QUIT && exit 0
+  echo >&2 "Not running"
+  ;;
+force-stop)
+  sig TERM && exit 0
+  echo >&2 "Not running"
+  ;;
+kill_worker)
+  workersig QUIT $2 && exit 0
+  echo >&2 "Worker not running"
+  ;;
+restart|reload)
+  sig USR2 && echo reloaded OK && exit 0
+  echo >&2 "Couldn't reload, starting '$CMD' instead"
+  run "$CMD"
+  ;;
+upgrade)
+  if sig USR2 && sleep 2 && sig 0 && oldsig QUIT
+  then
+    n=$TIMEOUT
+    while test -s $OLD_PIN && test $n -ge 0
+    do
+      printf '.' && sleep 1 && n=$(( $n - 1 ))
+    done
+    echo
+
+    if test $n -lt 0 && test -s $OLD_PIN
+    then
+      echo >&2 "$OLD_PIN still exists after $TIMEOUT seconds"
+      exit 1
+    fi
+    exit 0
+  fi
+  echo >&2 "Couldn't upgrade, starting '$CMD' instead"
+  run "$CMD"
+  ;;
+reopen-logs)
+  sig USR1
+  ;;
+*)
+  echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop|reopen-logs>"
+  exit 1
+  ;;
+esac

data/lib/capistrano/cookbook/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Cookbook
+    VERSION = "0.0.2"
+  end
+end

data/lib/capistrano/cookbook.rb

@@ -0,0 +1,15 @@
+require "capistrano/cookbook/version"
+
+module Capistrano
+  module Cookbook
+    require 'capistrano/cookbook/check_revision'
+    require 'capistrano/cookbook/compile_assets_locally'
+    require 'capistrano/cookbook/logs'
+    require 'capistrano/cookbook/monit'
+    require 'capistrano/cookbook/nginx'
+    require 'capistrano/cookbook/restart'
+    require 'capistrano/cookbook/run_tests'
+    require 'capistrano/cookbook/setup_config'
+    require 'capistrano/cookbook/create_database'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-cookbook
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ben Dixon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben@talkingquickly.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-cookbook.gemspec
+- lib/capistrano/.DS_Store
+- lib/capistrano/cookbook.rb
+- lib/capistrano/cookbook/.DS_Store
+- lib/capistrano/cookbook/check_revision.rb
+- lib/capistrano/cookbook/compile_assets_locally.rb
+- lib/capistrano/cookbook/create_database.rb
+- lib/capistrano/cookbook/helpers/setup_config_values.rb
+- lib/capistrano/cookbook/helpers/substitute_strings.rb
+- lib/capistrano/cookbook/helpers/template.rb
+- lib/capistrano/cookbook/logs.rb
+- lib/capistrano/cookbook/monit.rb
+- lib/capistrano/cookbook/nginx.rb
+- lib/capistrano/cookbook/restart.rb
+- lib/capistrano/cookbook/run_tests.rb
+- lib/capistrano/cookbook/setup_config.rb
+- lib/capistrano/cookbook/tasks/check_revision.cap
+- lib/capistrano/cookbook/tasks/compile_assets_locally.cap
+- lib/capistrano/cookbook/tasks/create_database.cap
+- lib/capistrano/cookbook/tasks/logs.cap
+- lib/capistrano/cookbook/tasks/monit.cap
+- lib/capistrano/cookbook/tasks/nginx.cap
+- lib/capistrano/cookbook/tasks/restart.cap
+- lib/capistrano/cookbook/tasks/run_tests.cap
+- lib/capistrano/cookbook/tasks/setup_config.cap
+- lib/capistrano/cookbook/templates/database.example.yml.erb
+- lib/capistrano/cookbook/templates/log_rotation.erb
+- lib/capistrano/cookbook/templates/mongoid.example.yml.erb
+- lib/capistrano/cookbook/templates/monit.erb
+- lib/capistrano/cookbook/templates/nginx.conf.erb
+- lib/capistrano/cookbook/templates/sidekiq.yml.erb
+- lib/capistrano/cookbook/templates/sidekiq_init.sh.erb
+- lib/capistrano/cookbook/templates/unicorn.rb.erb
+- lib/capistrano/cookbook/templates/unicorn_init.sh.erb
+- lib/capistrano/cookbook/version.rb
+homepage: https://github.com/TalkingQuickly/capistrano-cookbook
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Selection of Capistrano 3 tasks to reduce boilerplate required when deploying
+  Rails and Sinatra applications
+test_files: []
+has_rdoc: