simple-rails-deploy 0.0.1

data/.gitignore

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

data/LICENSE.txt

@@ -0,0 +1,18 @@
+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,135 @@
+Simple rails deploy
+===================
+
+This gem is made to get everything I need for deploy in one place. Such as:
+* capistrano configuration
+* unicorn configuration
+* unicorn startup rake task
+* nginx configuration
+* all stuff and magic to use this all together
+
+Assumptions
+========
+* Project uses ruby 1.9.3 for deployment.
+* Project uses asset pipeline for asset packing.
+* Project uses bundler to handle dependencies.
+* Project uses git.
+* Each project has its own user(all path assumptions are based on this).
+* Nobody likes setting up ruby web servers.
+
+What does it provide
+=======
+Configless unicorn control and configuration: tasks unicorn:start, unicorn:restart, unicorn:stop.
+Small common capistrano recipes.
+
+Limitations
+========
+- Unicorn can be less flexibly configured
+
+Step by step instruction
+======
+
+Server-side:
+(as root)
+```bash
+# Server initial setup
+apt-get install build-essential openssl libreadline6 libreadline6-dev curl git-core zlib1g zlib1g-dev libssl-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt-dev autoconf libc6-dev ncurses-dev automake libtool bison subversion
+#Use other package if using other DB
+apt-get install postgresql libpq-dev
+
+# Creating new ssh user
+adduser <project-name>
+cd ~<project-name>
+mkdir .ssh
+nano .ssh/authorized_keys
+#(paste your public ssh key in editor)
+chmod -R 700 .ssh
+chown -R <project-name>:<project-name> .ssh
+
+# Workaround to add 
+
+# Database credentials
+su postgres
+createuser <project-name>
+# Allow only database creation, not superuser
+```
+
+And you should add nginx config:
+```nginx
+server {
+  server_name <domain to use>;
+
+  root   /home/<projectname>/app/current/public;
+  try_files $uri/index.html $uri.html $uri @app;
+
+        location @app {
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header Host $http_host;
+            proxy_redirect off;
+ 
+            # If you don't find the filename in the static files
+            # Then request it from the unicorn server
+            proxy_pass http://unix:/home/<projectname>/app/shared/tmp/sockets/unicorn.sock:;
+        }
+}
+```
+
+That's all for root. Everything else will be done without superuser privileges.
+
+In application code folder:
+Run 'capify .' command. Replace config/deploy.rb:
+```ruby
+require 'simple-rails-deploy/common'
+
+#Use rvm with ruby 1.9.3 for deployment
+load 'deploy/rvm'
+#Use unicorn as web server
+load 'deploy/unicorn'
+#Uncomment if you want to add 'deny all' robots.txt
+#load 'deploy/robots-deny-all'
+
+#multistaging
+require "capistrano/ext/multistage"
+set :stages, %w(demo)
+set :default_stage, "demo"
+set :keep_releases, 5
+
+set :application, "<application name>"
+set :repository,  "<repo name>"
+
+```
+
+create file config/deploy/[stage-name].rb with contents:
+```ruby
+# Path to deploy folder is calculated based on appication name:
+# "/home/#{application}/app/"
+
+#set rails environment here
+set :rails_env, "production"
+
+#set git branch here
+set :branch, "master"
+
+#set server address here
+set :domain, "<username>@<server-hostname>" # Required for ssh deploy
+
+#Server roles
+role :web, domain
+role :app, domain
+role :db,  domain, :primary => true
+```
+
+And run:
+```bash
+cap <stagename> deploy:setup
+cap <stagename> deploy:create_database #optional
+cap <stagename> deploy:cold
+cap <stagename> deploy:migrate
+cap <stagename> deploy
+```
+
+License
+======
+Copyright 2012, Alexander Rozumiy. Distributed under the MIT license.
+
+Thanks to @Slotos for help with initial configuration files.

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue LoadError => e
+  warn "[WARNING]: It is recommended that you use bundler during development: gem install bundler"
+end

data/lib/configs/unicorn.rb

@@ -0,0 +1,43 @@
+rails_root = ENV['RAILS_PATH'] || raise("Rails path unknown")
+pid_file   = "#{rails_root}/tmp/pids/unicorn.pid"
+socket_file= "#{rails_root}/tmp/unicorn.sock"
+log_file   = "#{rails_root}/log/unicorn.log"
+err_log    = "#{rails_root}/log/unicorn_error.log"
+old_pid    = pid_file + '.oldbin'
+
+timeout 30
+worker_processes ENV['WORKERS_COUNT'].to_i || raise("Workers count not specified") # Based on load and other stuff
+listen socket_file, :backlog => 1024
+pid pid_file
+stderr_path err_log
+stdout_path log_file
+
+#preload_app true # Master loads app before forking
+preload_app false
+
+GC.copy_on_write_friendly = true if GC.respond_to?(:copy_on_write_friendly=) # ree garbage collection tuning
+
+before_exec do |server|
+  ENV["BUNDLE_GEMFILE"] = "#{rails_root}/Gemfile"
+end
+
+before_fork do |server, worker|
+  # Disconnect from DB before forking
+  defined?(ActiveRecord::Base) and
+  ActiveRecord::Base.connection.disconnect!
+
+  #0 downtime deploy magic
+  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
+end
+
+after_fork do |server, worker|
+  # Reconnect to db after forking
+  defined?(ActiveRecord::Base) and
+  ActiveRecord::Base.establish_connection
+end

data/lib/deploy/add-to-autostart.rb

@@ -0,0 +1,30 @@
+namespace :deploy do
+  task :add_to_startup do
+    startup_sh = '#!/bin/bash
+      #Comment this if not using rvm
+      [[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm" # Load RVM function
+      rvm use 1.9.3-falcon
+
+      export rvm_project_rvmrc=0
+
+      #Change this path to rails root
+      cd ~/app/current
+
+      #rvm use 1.9.3-falcon
+      RAILS_ENV=production RAILS_PATH=`pwd` bundle exec rake unicorn:start'
+
+    put startup_sh, "/home/#{application}/startup.sh", :mode => '755'
+
+    begin
+      run "crontab -l > ~/#{application}-cron"
+    rescue
+      #no crontab present
+    end
+
+    run "echo '#Begin reload on reboot task' >> ~/#{application}-cron"
+    run "echo '@reboot /bin/bash /home/#{application}/startup.sh' >> ~/#{application}-cron"
+    run "echo '#End reload on reboot task' >> ~/#{application}-cron"
+    run "crontab ~/#{application}-cron"
+    run "rm ~/#{application}-cron"
+  end
+end

data/lib/deploy/robots-deny-all.rb

@@ -0,0 +1,8 @@
+# This task adds robots.txt with 'deny all' to web root
+after "deploy:finalize_update", "deploy:robots"
+
+namespace :deploy do
+  task :robots do
+    run "echo 'User-Agent: *' > #{release_path}/public/robots.txt&&echo 'Disallow: /' >> #{release_path}/public/robots.txt"
+  end
+end

data/lib/deploy/rvm.rb

@@ -0,0 +1,19 @@
+set :rvm_ruby_string, '1.9.3-falcon'
+set :default_environment, {
+  'RUBY_HEAP_MIN_SLOTS' => 600000,
+  'RUBY_GC_MALLOC_LIMIT' => 59000000,
+  'RUBY_HEAP_FREE_MIN' => 100000
+}
+
+require "rvm/capistrano"
+
+namespace :rvm do
+  task :trust_rvmrc do
+    run "rvm rvmrc trust #{release_path}"
+  end
+end
+
+before 'deploy:setup', 'rvm:install_rvm'
+before 'deploy:setup', 'rvm:install_ruby'
+after "deploy", "rvm:trust_rvmrc"
+

data/lib/deploy/sharing-files.rb

@@ -0,0 +1,54 @@
+#Links files from this list to 'current' folder
+set :normal_symlinks, %w(
+    config/database.yml
+    tmp
+)
+
+namespace :deploy do
+  desc "Use configs"
+  task :app_symlinks do
+    normal_symlinks.map do |path|
+      run "rm -rf #{release_path}/#{path} && ln -nfs #{shared_path}/#{path} #{release_path}/#{path}"
+    end
+  end
+end
+
+after "deploy:finalize_update", "deploy:app_symlinks"
+
+namespace :deploy do
+  task :create_database_yml do
+    db_config = ERB.new <<-EOF
+    base: &base
+      adapter: postgresql
+      encoding: unicode
+      database: #{application}
+      pool: 5
+      min_messages: WARNING
+
+    #{rails_env}:
+      <<: *base
+
+    development:
+      <<: *base
+    EOF
+
+    run "mkdir -p #{shared_path}/config"
+    put db_config.result, "#{shared_path}/config/database.yml"
+  end
+
+  task :create_database do
+    run "psql -c'create database #{application};' postgres"    
+  end
+
+  task :create_shared_tmp_folder do
+    run "mkdir -p #{shared_path}/tmp"
+  end
+
+  task :fix_ssh_git do
+    run "echo 'StrictHostKeyChecking no' > ~/.ssh/config"
+  end
+end
+
+before 'deploy:setup', 'deploy:create_database_yml'
+before 'deploy:setup', 'deploy:create_shared_tmp_folder'
+before 'deploy:setup', 'deploy:fix_ssh_git'

data/lib/deploy/unicorn.rb

@@ -0,0 +1,18 @@
+namespace :deploy do
+  desc "Start unicorn"
+  task :start do
+    run "cd #{current_path} && RAILS_ENV=#{rails_env} RAILS_PATH=#{current_path} bundle exec rake unicorn:start"
+  end
+
+  desc "Restart unicorn"
+  task :restart do
+    run "cd #{current_path} && RAILS_ENV=#{rails_env} RAILS_PATH=#{current_path} bundle exec rake unicorn:restart"
+  end
+
+  desc "Stop unicorn and start again"
+  task :reload do
+    run "cd #{current_path} && RAILS_ENV=#{rails_env} RAILS_PATH=#{current_path} bundle exec rake unicorn:stop"
+    run "cd #{current_path} && RAILS_ENV=#{rails_env} RAILS_PATH=#{current_path} bundle exec rake unicorn:start"
+  end
+end
+

data/lib/simple-rails-deploy/common.rb

@@ -0,0 +1,29 @@
+# Bundler integration - installs same gems as in development
+require 'bundler/capistrano'
+# Colored capistrano output
+require 'capistrano_colors'
+
+Capistrano::Configuration.instance(true).load do
+  @load_paths += [Gem::Specification.find_by_name("simple-rails-deploy").gem_dir+'/lib']
+
+  load 'deploy/assets'
+  load 'deploy/sharing-files'
+  load 'deploy/add-to-autostart'
+
+  # VCS settings
+  set :scm, :git
+  set :deploy_via, :remote_cache
+  set :ssh_options, { :forward_agent => true }
+
+  # Server settings
+  set :use_sudo, false
+
+  # Hack to make forward_agent work
+  on :start do
+    `ssh-add`
+  end
+
+  # Deployment path
+  set(:deploy_to) { "/home/#{application}/app/" }
+end
+

data/lib/simple-rails-deploy/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module SimpleRailsDeploy
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/unicorn.rake'
+    end
+  end
+end

data/lib/simple-rails-deploy.rb

@@ -0,0 +1,3 @@
+if Object.const_defined?(:Rails)
+  require 'simple-rails-deploy/railtie'
+end

data/lib/tasks/unicorn.rake

@@ -0,0 +1,99 @@
+# cpu count code is from https://gist.github.com/1009994
+module System
+  extend self
+  def cpu_count
+    return Java::Java.lang.Runtime.getRuntime.availableProcessors if defined? Java::Java
+    return File.read('/proc/cpuinfo').scan(/^processor\s*:/).size if File.exist? '/proc/cpuinfo'
+    require 'win32ole'
+    WIN32OLE.connect("winmgmts://").ExecQuery("select * from Win32_ComputerSystem").NumberOfProcessors
+  rescue LoadError
+    Integer `sysctl -n hw.ncpu 2>/dev/null` rescue 1
+  end
+end
+
+namespace :unicorn do
+  def rails_root
+    ENV['RAILS_PATH'] || Rails.root
+  end
+
+  def unicorn_pid
+    File.join(rails_root, 'tmp', 'pids', 'unicorn.pid')
+  end
+
+  def unicorn_config
+    gem_path = Gem::Specification.find_by_name("simple-rails-deploy").gem_dir
+    File.join(gem_path, 'lib', 'configs', 'unicorn.rb')
+  end
+
+  def workers_count
+    if Rails.env.staging? || Rails.env.development?
+      return 1
+    elsif Rails.env.production?
+      # workers count == cpu cores count
+      return System.cpu_count
+    else
+      return 2
+    end
+  end
+
+  desc "Start unicorn"
+  task :start do
+    # Get unicorn pid
+    pidfile = unicorn_pid
+    if File.exists? pidfile
+      abort 'Unicorn is already running'
+    else
+      system_call = "env RAILS_PATH=#{rails_root} WORKERS_COUNT=#{workers_count} bundle exec unicorn_rails -c #{unicorn_config} -D"
+      if system(system_call)
+        puts "Started and running with pid: #{File.read pidfile}" 
+      else
+        puts "Unicorn failed to start. System call was: '#{system_call}' "
+      end
+    end
+  end
+
+  desc "Restart unicorn"
+  task :restart do
+    # Get unicorn pid
+    pidfile = unicorn_pid
+    old_pidfile = unicorn_pid + '.oldbin'
+    abort 'unicorn is either restarting or encounetred a serious crash in the previous restart attempt' if File.exists? old_pidfile
+    if File.exists? pidfile
+      begin
+        pid = File.read(pidfile).to_i
+        Process.kill 0, pid
+        Process.kill "USR2", pid
+        puts "Successfully asked unicorn to reload gracefully"
+      rescue Errno::EPERM
+        abort 'Lacking the rights to communicate with unicorn process'
+      rescue Errno::ESRCH
+        puts "Something bad happened in the past. Unicorn PID is here, unicorn is not. Starting a new instance."
+        File.delete pidfile
+        Rake::Task["unicorn:start"].invoke
+      end
+    else
+      puts "Unicorn is not running. Starting a new instance."
+      Rake::Task["unicorn:start"].invoke
+    end
+  end
+
+  desc "Stop unicorn"
+  task :stop do
+    # Get unicorn pid
+    pidfile = unicorn_pid
+    if File.exists? pidfile
+      begin
+        pid = File.read(pidfile).to_i
+        Process.kill 0, pid
+        Process.kill "QUIT", pid
+        puts "Successfully asked unicorn to shut down gracefully"
+      rescue Errno::EPERM
+        abort 'Lacking the rights to communicate with unicorn process'
+      rescue Errno::ESRCH
+        puts "Something bad happened in the past. Unicorn PID is here, unicorn is not"
+      end
+    else
+      puts "Unicorn is not running. Aborting"
+    end
+  end
+end

data/simple-rails-deploy.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "simple-rails-deploy"
+  s.version = '0.0.1'
+
+  s.authors = ["Alex Rozumey"]
+  s.description = "It simplifies rails deployment process a lot"
+  s.email = "brain-geek@yandex.ua"
+
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.homepage = "http://github.com/brain-geek/simple-rails-deploy"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "1.8.15"
+  s.summary = ""
+
+  s.add_dependency(%q<rails>, '>=3.0.0')
+  s.add_dependency(%q<capistrano>)
+  s.add_dependency(%q<rvm-capistrano>)
+  s.add_dependency(%q<capistrano_colors>)
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: simple-rails-deploy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Rozumey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70219440632360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219440632360
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &70219440631060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219440631060
+- !ruby/object:Gem::Dependency
+  name: rvm-capistrano
+  requirement: &70219440629620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219440629620
+- !ruby/object:Gem::Dependency
+  name: capistrano_colors
+  requirement: &70219440628920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219440628920
+description: It simplifies rails deployment process a lot
+email: brain-geek@yandex.ua
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .gitignore
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/configs/unicorn.rb
+- lib/deploy/add-to-autostart.rb
+- lib/deploy/robots-deny-all.rb
+- lib/deploy/rvm.rb
+- lib/deploy/sharing-files.rb
+- lib/deploy/unicorn.rb
+- lib/simple-rails-deploy.rb
+- lib/simple-rails-deploy/common.rb
+- lib/simple-rails-deploy/railtie.rb
+- lib/tasks/unicorn.rake
+- simple-rails-deploy.gemspec
+homepage: http://github.com/brain-geek/simple-rails-deploy
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []