kapify 0.0.1

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
+/vendor

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivan Tkalin
+
+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,51 @@
+# Kapify
+
+Provides several useful capistrano recipes, that can be used for deployment of Ruby on Rails applications with rbenv.
+
+* [Logrotate](https://github.com/ivalkeen/kapify/tree/master/lib/kapify/logrotate)
+    + set up logs rotation
+* [Nginx](https://github.com/ivalkeen/kapify/tree/master/lib/kapify/nginx)
+    + config site
+    + reload
+* [PostgreSQL](https://github.com/ivalkeen/kapify/tree/master/lib/kapify/pg)
+    + link database.yml from template
+    + create pg user for application
+* [Resque](https://github.com/ivalkeen/kapify/tree/master/lib/kapify/resque)
+    + create and register init script
+    + start/stop/restart using init script
+* [Unicorn](https://github.com/ivalkeen/kapify/tree/master/lib/kapify/unicorn)
+  (with zero downtime deployments with nginx)
+    + create and register init script
+    + start/stop/restart using init script
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kapify', group: :development, require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kapify
+
+## Usage
+
+Require each recipe in `deploy.rb` file.
+All recipes could be customized using variables.
+Also there are template generators for deep customization.
+See README for recipes for details.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/kapify.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kapify/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kapify"
+  gem.version       = Kapify::VERSION
+  gem.authors       = ["Ivan Tkalin"]
+  gem.email         = ["itkalin@gmail.com"]
+  gem.description   = %q{Capistrano recipes useful for rails app deployment. Includes repices for nginx, unicorn, postgres, logrotate, resque}
+  gem.summary       = %q{Capistrano recipes useful for rails app deployment}
+  gem.homepage      = "https://github.com/ivalkeen/kapify"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '>= 2.0'
+  gem.add_development_dependency "rake"
+end

data/lib/generators/kapify/base.rb

@@ -0,0 +1,9 @@
+module Kapify
+  module Generators
+    class Base < Rails::Generators::Base
+      argument :templates_path, :type => :string,
+        :default => "config/deploy/templates",
+        :banner => "path to templates"
+    end
+  end
+end

data/lib/generators/kapify/logrotate/USAGE

@@ -0,0 +1,9 @@
+To create local logrotate configuration file call
+
+    rails generate kapify:logrotate [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate kapify:logrotate "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/kapify/logrotate/logrotate_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/kapify/base'
+
+module Kapify
+  module Generators
+    class LogrotateGenerator < Kapify::Generators::Base
+      desc "Create logrotate configuration files for customization"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        copy_file "logrotate.erb", "#{templates_path}/logrotate.erb"
+      end
+    end
+  end
+end

data/lib/generators/kapify/logrotate/templates/logrotate.erb

@@ -0,0 +1,8 @@
+<%= shared_path %>/log/*.log {
+  daily
+  missingok
+  rotate 180
+  compress
+  dateext
+  delaycompress
+}

data/lib/generators/kapify/nginx/USAGE

@@ -0,0 +1,9 @@
+To create local nginx configuration file call
+
+    rails generate kapify:nginx [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate kapify:nginx "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/kapify/nginx/nginx_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/kapify/base'
+
+module Kapify
+  module Generators
+    class NginxGenerator < Kapify::Generators::Base
+      desc "Create local nginx configuration files for customization"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        copy_file "nginx_conf.erb", "#{templates_path}/nginx_conf.erb"
+      end
+    end
+  end
+end

data/lib/generators/kapify/nginx/templates/nginx_conf.erb

@@ -0,0 +1,85 @@
+upstream <%= application %> {
+  server unix:/tmp/<%= application %>.sock fail_timeout=0;
+}
+
+<% if nginx_use_ssl %>
+server {
+  listen 80;
+  rewrite ^(.*) https://$host$1 permanent;
+}
+<% end %>
+
+server {
+<% if nginx_use_ssl %>
+  listen 443;
+  ssl on;
+  ssl_certificate /etc/ssl/certs/<%= nginx_ssl_certificate %>;
+  ssl_certificate_key /etc/ssl/private/<%= nginx_ssl_certificate_key %>;
+<% else %>
+  listen 80;
+<% end %>
+
+  server_name <%= nginx_server_name %>;
+  root <%= current_path %>/public;
+  try_files $uri/index.html $uri @<%= application %>;
+
+  location @<%= application %> {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+<% if nginx_use_ssl %>
+    proxy_set_header X-Forwarded-Proto https;
+<% end %>
+    proxy_pass http://<%= application %>;
+    # limit_req zone=one;
+    access_log <%= shared_path %>/log/nginx.access.log;
+    error_log <%= shared_path %>/log/nginx.error.log;
+  }
+
+  location ~ ^/(assets|images|javascripts|stylesheets|swfs|system)/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+    add_header Last-Modified "";
+    add_header ETag "";
+
+    open_file_cache max=1000 inactive=500s;
+    open_file_cache_valid 600s;
+    open_file_cache_errors on;
+    break;
+  }
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  location = /50x.html {
+    root html;
+  }
+
+  location = /404.html {
+    root html;
+  }
+
+  location @503 {
+    error_page 405 = /system/maintenance.html;
+    if (-f $document_root/system/maintenance.html) {
+      rewrite ^(.*)$ /system/maintenance.html break;
+    }
+    rewrite ^(.*)$ /503.html break;
+  }
+
+  if ($request_method !~ ^(GET|HEAD|PUT|POST|DELETE|OPTIONS)$ ){
+    return 405;
+  }
+
+  if (-f $document_root/system/maintenance.html) {
+    return 503;
+  }
+
+  location ~ \.(php|html)$ {
+    return 405;
+  }
+}

data/lib/generators/kapify/pg/USAGE

@@ -0,0 +1,9 @@
+To create local database.yml.erb configuration file call
+
+    rails generate kapify:pg [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate kapify:pg "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/kapify/pg/pg_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/kapify/base'
+
+module Kapify
+  module Generators
+    class PgGenerator < Kapify::Generators::Base
+      desc "Create local database.yml.erb configuration files for customization"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        copy_file "database.yml.erb", "#{templates_path}/database.yml.erb"
+      end
+    end
+  end
+end

data/lib/generators/kapify/pg/templates/database.yml.erb

@@ -0,0 +1,8 @@
+production:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= pg_database %>
+  pool: <%= pg_pool %>
+  username: <%= pg_user %>
+  password: <%= pg_password %>
+  host: <%= pg_host %>

data/lib/generators/kapify/resque/USAGE

@@ -0,0 +1,9 @@
+To create local resque configuration files call
+
+    rails generate kapify:resque [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate kapify:resque "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/kapify/resque/resque_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/kapify/base'
+
+module Kapify
+  module Generators
+    class ResqueGenerator < Kapify::Generators::Base
+      desc "Create local resque configuration files for customization"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        copy_file "resque_init.erb", "#{templates_path}/resque_init.erb"
+      end
+    end
+  end
+end

data/lib/generators/kapify/resque/templates/resque_init.erb

@@ -0,0 +1,89 @@
+#!/bin/sh -e
+### BEGIN INIT INFO
+# Provides:		resque
+# Required-Start:	$local_fs $remote_fs
+# Required-Stop:	$local_fs $remote_fs
+# Should-Start:		$local_fs
+# Should-Stop:		$local_fs
+# Default-Start:	2 3 4 5
+# Default-Stop:		0 1 6
+# Short-Description:	resque - a Redis-backed Ruby library for creating background jobs
+# Description:		resque - a Redis-backed Ruby library for creating background jobs, placing those jobs on multiple queues, and processing them later.
+### END INIT INFO
+
+set -e
+
+. /lib/lsb/init-functions
+
+NAME="<%= application %>"
+ROOT=<%= current_path %>
+USER="<%= resque_user %>"
+GROUP="<%= resque_user %>"
+ENVIRONMENT="production"
+QUEUES="<%= resque_queue %>"
+COUNT=<%= resque_workers %>
+TASK="<%= resque_task %>"
+PIDFILE="$ROOT/tmp/pids/resque_worker.%d.pid"
+
+BUNDLE="<%= resque_bundle %>"
+
+start() {
+local program
+local options
+
+program=$BUNDLE
+options="exec rake $TASK"
+options="$options RACK_ENV=$ENVIRONMENT QUEUES=$QUEUES"
+
+for i in $(seq 1 $COUNT); do
+pidfile=$(printf "$PIDFILE" $i)
+
+if start-stop-daemon --start --background --quiet --pidfile $pidfile --chdir $ROOT --chuid $USER:$GROUP --exec $program -- $options PIDFILE=$pidfile
+then
+log_daemon_msg "Starting worker #$i for $NAME ..."
+else
+log_failure_msg "Failed to start worker #$i for $NAME!"
+fi
+done
+}
+
+stop() {
+local pidfile
+
+for i in $(seq 1 $COUNT); do
+pidfile=$(printf "$PIDFILE" $i)
+
+if start-stop-daemon --stop --quiet --oknodo --pidfile $pidfile
+then
+log_daemon_msg "Stopped Resque worker #$i for $NAME"
+rm -f $pidfile
+else
+log_failure_msg "Failed to stop Resque worker #$i for $NAME!" >&2
+fi
+done
+}
+
+status() {
+local pidfile
+
+for i in $(seq 1 $COUNT); do
+pidfile=$(printf "$PIDFILE" $i)
+
+status_of_proc -p $pidfile "rake $TASK" "$NAME worker #$i"
+done
+}
+
+case "$1" in
+start)	start ;;
+stop)	stop ;;
+restart|force-reload)
+stop
+sleep 1
+start
+;;
+status) status ;;
+*)
+echo "Usage: $0 {start|stop|restart|force-reload|status}" >&2
+exit 1
+;;
+esac

data/lib/generators/kapify/unicorn/USAGE

@@ -0,0 +1,9 @@
+To create local unicorn configuration files call
+
+    rails generate kapify:unicorn [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate kapify:unicorn "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/kapify/unicorn/templates/unicorn.rb.erb

@@ -0,0 +1,48 @@
+working_directory "<%= current_path %>"
+pid "<%= unicorn_pid %>"
+stderr_path "<%= unicorn_log %>"
+stdout_path "<%= unicorn_log %>"
+
+listen "/tmp/<%= application %>.sock"
+worker_processes <%= unicorn_workers %>
+timeout 30
+
+preload_app true
+
+before_exec do |server|
+  ENV["BUNDLE_GEMFILE"] = "<%= current_path %>/Gemfile"
+end
+
+before_fork do |server, worker|
+  # Disconnect since the database connection will not carry over
+  if defined? ActiveRecord::Base
+    ActiveRecord::Base.connection.disconnect!
+  end
+
+  # Quit the old unicorn process
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if File.exists?(old_pid) && server.pid != old_pid
+    begin
+      Process.kill("QUIT", File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+      # someone else did our job for us
+    end
+  end
+
+  if defined?(Resque)
+    Resque.redis.quit
+  end
+
+  sleep 1
+end
+
+after_fork do |server, worker|
+  # Start up the database connection again in the worker
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.establish_connection
+  end
+
+  if defined?(Resque)
+    Resque.redis = 'localhost:6379'
+  end
+end

data/lib/generators/kapify/unicorn/templates/unicorn_init.erb

@@ -0,0 +1,84 @@
+#!/bin/sh
+### BEGIN INIT INFO
+# Provides: unicorn
+# Required-Start: $remote_fs $syslog
+# Required-Stop: $remote_fs $syslog
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: Manage unicorn server
+# Description: Start, stop, restart unicorn server for a specific application.
+### END INIT INFO
+set -e
+
+# Feel free to change any of the following variables for your app:
+TIMEOUT=${TIMEOUT-60}
+APP_ROOT=<%= current_path %>
+PID=<%= unicorn_pid %>
+CMD="cd <%= current_path %>; bundle exec unicorn -D -c <%= unicorn_config %> -E production"
+AS_USER=<%= unicorn_user %>
+set -u
+
+OLD_PIN="$PID.oldbin"
+
+sig () {
+  test -s "$PID" && kill -$1 `cat $PID`
+}
+
+oldsig () {
+  test -s $OLD_PIN && kill -$1 `cat $OLD_PIN`
+}
+
+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"
+  ;;
+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/generators/kapify/unicorn/unicorn_generator.rb

@@ -0,0 +1,15 @@
+require 'generators/kapify/base'
+
+module Kapify
+  module Generators
+    class UnicornGenerator < Kapify::Generators::Base
+      desc "Create local unicorn configuration files for customization"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        copy_file "unicorn.rb.erb", "#{templates_path}/unicorn.rb.erb"
+        copy_file "unicorn_init.erb", "#{templates_path}/unicorn_init.erb"
+      end
+    end
+  end
+end

data/lib/kapify/base.rb

@@ -0,0 +1,17 @@
+Capistrano::Configuration.instance.load do
+  def set_default(name, *args, &block)
+    set(name, *args, &block) unless exists?(name)
+  end
+
+  set_default(:templates_path, "config/deploy/templates")
+
+  def kapify_template(generator, template_name, target)
+    config_file = "#{templates_path}/#{template_name}"
+    # if no customized file, proceed with default
+    unless File.exists?(config_file)
+      config_file = File.join(File.dirname(__FILE__), "../generators/kapify/#{generator}/templates/#{template_name}")
+    end
+    put ERB.new(File.read(config_file)).result(binding), target
+  end
+
+end