capistrano-tools 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Arturs Kreipans
+
+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,57 @@
+# Capistrano::Tools
+
+It is a collection of scripts for capistrano
+* unicorn deploy script
+* script to manage config yml fails (prompt paswords on deploy:setup)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-tools', :git => 'git@github.com:fragallia/capistrano-tools.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+### Unicorn
+Require the gem in your deploy script
+~~~
+require 'capistrano-tools'
+~~~
+add deploy restart after callback for unicorn
+~~~
+after 'deploy:restart', 'unicorn:reload'
+~~~
+
+You can set following variables for unicorn:
+
+- unicorn\_env   : unicron environment, defaults to **rails_env** or **env**.
+- unicorn\_pid   : location of unicron pid file, defaults to **shared/pids** folder
+- unicorn\_bundle : path to bundle library, defaults to **bundle\_cmd** or "bundle"
+- unicorn\_bin : path to unicron library, defaults to 'unicron'
+
+** If your are using unicron with unix socket file, do not locate it in to current directory. **
+
+### Templater
+Require the gem in your deploy script
+~~~
+require 'capistrano-tools'
+~~~
+Create template and set templater variable:
+~~~
+set :templater, :template_dir => "lib/capistrano/templates", :templates => ['database']
+~~~
+
+## TODO
+
+* create generator to create default files (config/unicorn/production.rb, config/deploy.rb, config/deploy/production.rb, Capfile)
+
+## 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/capistrano-tools.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-tools/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-tools"
+  gem.version       = Capistrano::Tools::VERSION
+  gem.authors       = ["Arturs Kreipans"]
+  gem.email         = ["arturs.kreipans@gmail.com"]
+  gem.description   = %q{Integration scripts for Capistrano}
+  gem.summary       = %q{Integration scripts for Capistrano}
+  gem.homepage      = ""
+
+  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_development_dependency 'rake'
+
+  gem.add_runtime_dependency 'capistrano'
+end

data/lib/capistrano-tools/templater.rb

@@ -0,0 +1,43 @@
+module Capistrano::Tools
+  class Templater
+    TASKS = [
+      'templater:setup',
+      'templater:symlink'
+    ]
+    def self.load_into(capistrano_config)
+      capistrano_config.load do
+        namespace :templater do
+          task :setup, :except => { :no_release => true } do
+            templater = fetch(:templater, {})
+            location = templater.fetch(:template_dir, "templates")
+
+            templater.fetch(:templates, []).each do | template |
+              path_to_template = File.join(File.expand_path('../../', __FILE__), "#{location}/#{template}.yml.erb")
+              if File.file?(path_to_template) 
+                config = ERB.new(File.read(path_to_template))
+
+                run "mkdir -p #{shared_path}/config"
+                put config.result(binding), "#{shared_path}/config/#{template}.yml"
+              else
+                puts "[WARNING] template #{path_to_template} not found"
+                next
+              end
+            end
+          end
+
+          task :symlink, :except => { :no_release => true } do
+            templater = fetch(:templater, {})
+            templater.fetch(:templates, []).each do | template |
+              run "ln -nfs #{shared_path}/config/#{template}.yml #{release_path}/config/#{template}.yml"
+            end
+          end
+
+        end
+
+        after "deploy:setup",           "templater:setup"   unless fetch(:skip_templater_setup, false)
+        after "deploy:finalize_update", "templater:symlink"
+
+      end
+    end
+  end
+end

data/lib/capistrano-tools/unicorn.rb

@@ -0,0 +1,194 @@
+require 'capistrano'
+require 'capistrano/version'
+
+module Capistrano::Tools
+  class Unicorn
+    TASKS = [
+      'unicorn:start',
+      'unicorn:stop',
+      'unicorn:restart',
+      'unicorn:reload', 
+      'unicorn:shutdown',
+      'unicorn:add_worker',
+      'unicorn:remove_worker'
+    ]
+
+    def self.load_into(capistrano_config)
+      capistrano_config.load do
+        before(Capistrano::Tools::Unicorn::TASKS) do
+          _cset(:unicorn_pid)    { fetch(:unicorn_pid, "#{shared_path}/pids/unicorn.pid") }
+          _cset(:unicorn_env)    { fetch(:unicorn_env, fetch(:rails_env, fetch(:env, 'production'))) }
+          _cset(:unicorn_bin)    { fetch(:unicorn_bin, "unicorn") }
+          _cset(:unicorn_bundle) { fetch(:unicorn_bundle, fetch(:bundle_cmd, 'bundle')) }
+        end
+
+        # Check if a remote process exists using its pid file
+        #
+        def remote_process_exists?(pid_file)
+          "[ -e #{pid_file} ] && kill -0 `cat #{pid_file}` > /dev/null 2>&1"
+        end
+
+        # Stale Unicorn process pid file
+        #
+        def old_unicorn_pid
+          "#{unicorn_pid}.oldbin"
+        end
+
+        # Command to check if Unicorn is running
+        #
+        def unicorn_is_running?
+          remote_process_exists?(unicorn_pid)
+        end
+
+        # Command to check if stale Unicorn is running
+        #
+        def old_unicorn_is_running?
+          remote_process_exists?(old_unicorn_pid)
+        end
+
+        # Get unicorn master process PID (using the shell)
+        #
+        def get_unicorn_pid(pid_file=unicorn_pid)
+          "`cat #{pid_file}`"
+        end
+
+        # Get unicorn master (old) process PID
+        #
+        def get_old_unicorn_pid
+          get_unicorn_pid(old_unicorn_pid)
+        end
+
+        # Send a signal to a unicorn master processes
+        #
+        def unicorn_send_signal(signal, pid=get_unicorn_pid)
+          "#{try_sudo} kill -s #{signal} #{pid}"
+        end
+
+        # Kill Unicorns in multiple ways O_O
+        #
+        def kill_unicorn(signal)
+          script = <<-END
+            if #{unicorn_is_running?}; then
+              echo "Stopping Unicorn...";
+              #{unicorn_send_signal(signal)};
+            else
+              echo "Unicorn is not running.";
+            fi;
+          END
+
+          script
+        end
+
+        # Start the Unicorn server
+        #
+        def start_unicorn
+          primary_config_path = "#{current_path}/config/unicorn.rb"
+          secondary_config_path = "#{current_path}/config/unicorn/#{unicorn_env}.rb"
+
+          script = <<-END
+            if [ -e #{primary_config_path} ]; then
+              UNICORN_CONFIG_PATH=#{primary_config_path};
+            else
+              if [ -e #{secondary_config_path} ]; then
+                UNICORN_CONFIG_PATH=#{secondary_config_path};
+              else
+                echo "Config file for \"#{unicorn_env}\" environment was not found at either \"#{primary_config_path}\" or \"#{secondary_config_path}\"";
+                exit 1;
+              fi;
+            fi;
+
+            if [ -e #{unicorn_pid} ]; then
+              if kill -0 `cat #{unicorn_pid}` > /dev/null 2>&1; then
+                echo "Unicorn is already running!";
+                exit 0;
+              fi;
+
+              rm #{unicorn_pid};
+            fi;
+
+            echo "Starting Unicorn...";
+            cd #{current_path} && BUNDLE_GEMFILE=#{current_path}/Gemfile #{unicorn_bundle} exec #{unicorn_bin} -c $UNICORN_CONFIG_PATH -E #{unicorn_env} -D;
+          END
+
+          script
+        end
+
+        #
+        # Unicorn cap tasks
+        #
+        namespace :unicorn do
+          desc 'Start Unicorn master process'
+          task :start, :roles => :app, :except => {:no_release => true} do
+            run start_unicorn
+          end
+
+          desc 'Stop Unicorn'
+          task :stop, :roles => :app, :except => {:no_release => true} do
+            run kill_unicorn('QUIT')
+          end
+
+          desc 'Immediately shutdown Unicorn'
+          task :shutdown, :roles => :app, :except => {:no_release => true} do
+            run kill_unicorn('TERM')
+          end
+
+          desc 'Restart Unicorn'
+          task :restart, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              if #{unicorn_is_running?}; then
+                echo "Restarting Unicorn...";
+                #{unicorn_send_signal('USR2')};
+              else
+                #{start_unicorn}
+              fi;
+
+              sleep 2; # in order to wait for the (old) pidfile to show up
+
+              if #{old_unicorn_is_running?}; then
+                #{unicorn_send_signal('QUIT', get_old_unicorn_pid)};
+              fi;
+            END
+          end
+
+          desc 'Reload Unicorn'
+          task :reload, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              if #{unicorn_is_running?}; then
+                echo "Reloading Unicorn...";
+                #{unicorn_send_signal('HUP')};
+              else
+                #{start_unicorn}
+              fi;
+            END
+          end
+
+          desc 'Add a new worker'
+          task :add_worker, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              if #{unicorn_is_running?}; then
+                echo "Adding a new Unicorn worker...";
+                #{unicorn_send_signal('TTIN')};
+              else
+                echo "Unicorn is not running.";
+              fi;
+            END
+          end
+
+          desc 'Remove amount of workers'
+          task :remove_worker, :roles => :app, :except => {:no_release => true} do
+            run <<-END
+              if #{unicorn_is_running?}; then
+                echo "Removing a Unicorn worker...";
+                #{unicorn_send_signal('TTOU')};
+              else
+                echo "Unicorn is not running.";
+              fi;
+            END
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/lib/capistrano-tools/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Tools
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano-tools.rb

@@ -0,0 +1,15 @@
+require "capistrano-tools/version"
+
+module Capistrano
+  module Tools
+    unless Capistrano::Configuration.respond_to?(:instance)
+      abort "This extension requires Capistrano 2"
+    end
+
+    require 'capistrano-tools/unicorn'
+    require 'capistrano-tools/templater'
+
+    Capistrano::Tools::Unicorn.load_into(Capistrano::Configuration.instance)
+    Capistrano::Tools::Templater.load_into(Capistrano::Configuration.instance)
+  end
+end

data/lib/templates/database.yml.erb

@@ -0,0 +1,9 @@
+production:
+  adapter:  <%= Capistrano::CLI.ui.ask("Enter database adapter: ") %>
+  database: <%= Capistrano::CLI.ui.ask("Enter database name: ") %>
+  username: <%= Capistrano::CLI.ui.ask("Enter database username: ") %>
+  password: <%= Capistrano::CLI.ui.ask("Enter database password: ") %>
+  host:     <%= Capistrano::CLI.ui.ask("Enter database host: ") %>
+  encoding: utf8
+  timeout: 5000
+

data/lib/templates/mailer.yml.erb

@@ -0,0 +1,9 @@
+production:
+  address:              <%= Capistrano::CLI.ui.ask("Enter SMTP option address: ") %>
+  port:                 <%= Capistrano::CLI.ui.ask("Enter SMTP option port: ") %>
+  domain:               <%= Capistrano::CLI.ui.ask("Enter SMTP option domain: ") %>
+  user_name:            <%= Capistrano::CLI.ui.ask("Enter SMTP option user_name: ") %>
+  password:             <%= Capistrano::CLI.ui.ask("Enter SMTP option password: ") %>
+  authentication:       <%= Capistrano::CLI.ui.ask("Enter SMTP option authentication: ") %>
+  enable_starttls_auto: <%= Capistrano::CLI.ui.ask("Enter SMTP option enable_starttls_auto: ") %>
+

data/lib/templates/unicorn.rb.erb

@@ -0,0 +1,27 @@
+# Set your full path to application.
+app_path = "<%= fetch(:deploy_to, "/var/www/#{fetch(:application, "app")}") %>/current"
+
+# Set unicorn options
+worker_processes 2
+
+timeout 30
+
+# socket for nginx
+listen "/tmp/#{fetch(:application, 'app')}.unicorn.sock", :backlog => 64
+
+# Spawn unicorn master worker for user deploy (group: deploy)
+user 'deploy', 'deploy'
+
+# Fill path to your app
+working_directory app_path
+
+# Should be 'production' by default, otherwise use other env 
+rails_env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'production'
+
+# Set the path of the log files inside the log folder of the testapp
+stderr_path "#{app_path}/log/unicorn.stderr.log"
+stdout_path "#{app_path}/log/unicorn.stdout.log"
+
+pid "#{app_path}/tmp/pids/unicorn.pid"
+
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arturs Kreipans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integration scripts for Capistrano
+email:
+- arturs.kreipans@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-tools.gemspec
+- lib/capistrano-tools.rb
+- lib/capistrano-tools/templater.rb
+- lib/capistrano-tools/unicorn.rb
+- lib/capistrano-tools/version.rb
+- lib/templates/database.yml.erb
+- lib/templates/mailer.yml.erb
+- lib/templates/unicorn.rb.erb
+homepage: ''
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Integration scripts for Capistrano
+test_files: []