capistrano-rainbows 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15f96b073a2639f6c611f1f30d27caf731a9fbb5
+  data.tar.gz: 0e97d69816bbc08d08df1098bba3cef9f2cf68e2
+SHA512:
+  metadata.gz: b174dd2ea24620c640cce9213883fb57cf967642b5c963e99fbf4d3766891a9d8c4e90f23b976b8d64e7072f6bf9a556f540fab3a4600e7d8ddf7d9b0ac9753b
+  data.tar.gz: 8875bc3ab395a9d0ab14422ed4a5d1857345423d6860638e5cdb858cf9a7c87e1eae5efc73f6e6219f738b4bd9f2b5057f4126a8ac8439aa56fdbfd8e2ef9715

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2013 H2ocube.com
+
+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,87 @@
+# Capistrano Rainbows
+
+Capistrano plugin that integrates Rainbows tasks into capistrano deployment script.
+
+## Installation
+
+Install library from rubygems:
+
+```
+gem install capistrano-rainbows
+```
+
+## Usage
+
+### Setup
+
+Add the library to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'capistrano-rainbows', require: false
+end
+```
+
+And load it into your deployment script `config/deploy.rb`:
+
+```ruby
+require 'capistrano-rainbows'
+```
+
+Add rainbows restart task hook:
+
+```ruby
+after 'deploy:restart', 'rainbows:reload' # app IS NOT preloaded
+after 'deploy:restart', 'rainbows:restart'  # app preloaded
+```
+
+Create a new configuration file `config/rainbows/rainbows.rb` or `config/rainbows/STAGE.rb`, where stage is your deployment environment.
+
+Example config - [examples/rails3.rb](https://github.com/sosedoff/capistrano-rainbows/blob/master/examples/rails3.rb). Please refer to rainbows documentation for more examples and configuration options.
+
+### Test
+
+First, make sure you're running the latest release:
+
+```
+cap deploy
+```
+
+Then you can test each individual task:
+
+```
+cap rainbows:start
+cap rainbows:stop
+cap rainbows:reload
+```
+
+## Configuration
+
+You can modify any of the following options in your `deploy.rb` config.
+
+- `rainbows_env`             - Set rainbows environment. Default to `rails_env` variable.
+- `rainbows_pid`             - Set rainbows PID file path. Default to `current_path/tmp/pids/rainbows.pid`
+- `rainbows_bin`             - Set rainbows executable file. Default to `rainbows`.
+- `rainbows_bundle`          - Set bundler command for rainbows. Default to `bundle`.
+- `rainbows_user`            - Launch rainbows master as the specified user. Default to `user` variable.
+- `rainbows_roles`           - Define which roles to perform rainbows recpies on. Default to `:app`.
+- `rainbows_config_path`     - Set the directory where rainbows config files reside. Default to `current_path/config`.
+- `rainbows_config_filename` - Set the filename of the rainbows config file. Not used in multistage installations. Default to `rainbows.rb`.
+
+## Available Tasks
+
+To get a list of all capistrano tasks, run `cap -T`:
+
+```
+cap rainbows:add_worker                # Add a new worker
+cap rainbows:remove_worker             # Remove amount of workers
+cap rainbows:reload                    # Reload rainbows
+cap rainbows:restart                   # Restart rainbows
+cap rainbows:shutdown                  # Immediately shutdown rainbows
+cap rainbows:start                     # Start rainbows master process
+cap rainbows:stop                      # Stop rainbows
+```
+
+## License
+
+See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+require 'bundler/gem_tasks'

data/capistrano-rainbows.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name        = 'capistrano-rainbows'
+  gem.version     = '0.0.1'
+  gem.author      = 'Ben'
+  gem.email       = 'ben@h2ocube.com'
+  gem.homepage    = 'https://github.com/h2ocube/capistrano-rainbows'
+  gem.summary     = %q{Rainbows integration for Capistrano}
+  gem.description = %q{Capistrano plugin that integrates Rainbows server tasks.}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+
+  gem.add_runtime_dependency 'capistrano'
+end

data/examples/rails3.rb

@@ -0,0 +1,45 @@
+# ------------------------------------------------------------------------------
+# Sample rails 3 config
+# ------------------------------------------------------------------------------
+
+# Set your full path to application.
+app_path = "/path/to/app"
+
+# Set rainbows options
+worker_processes 1
+preload_app true
+timeout 180
+listen "127.0.0.1:9000"
+
+# Spawn rainbows master worker for user apps (group: apps)
+user 'apps', 'apps'
+
+# Fill path to your app
+working_directory app_path
+
+# Should be 'production' by default, otherwise use other env
+rails_env = ENV['RAILS_ENV'] || 'production'
+
+# Log everything to one file
+stderr_path "log/rainbows.log"
+stdout_path "log/rainbows.log"
+
+# Set master PID location
+pid "#{app_path}/tmp/pids/rainbows.pid"
+
+before_fork do |server, worker|
+  ActiveRecord::Base.connection.disconnect!
+
+  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
+end
+
+after_fork do |server, worker|
+  ActiveRecord::Base.establish_connection
+end

data/lib/capistrano-rainbows.rb

@@ -0,0 +1 @@
+require 'capistrano-rainbows/capistrano_integration'

data/lib/capistrano-rainbows/capistrano_integration.rb

@@ -0,0 +1,225 @@
+require 'capistrano'
+
+module CapistranoRainbows
+  class CapistranoIntegration
+    TASKS = [
+      'rainbows:start',
+      'rainbows:stop',
+      'rainbows:restart',
+      'rainbows:duplicate',
+      'rainbows:reload',
+      'rainbows:shutdown',
+      'rainbows:add_worker',
+      'rainbows:remove_worker'
+    ]
+
+    def self.load_into(capistrano_config)
+      capistrano_config.load do
+        before(CapistranoIntegration::TASKS) do
+          _cset(:app_env)                    { (fetch(:rails_env) rescue 'production') }
+          _cset(:rainbows_pid)                { "#{fetch(:current_path)}/tmp/pids/rainbows.pid" }
+          _cset(:rainbows_env)                { fetch(:app_env) }
+          _cset(:rainbows_bin)                { "rainbows" }
+          _cset(:rainbows_bundle)             { fetch(:bundle_cmd) rescue 'bundle' }
+          _cset(:rainbows_restart_sleep_time) { 2 }
+          _cset(:rainbows_user)               { nil }
+          _cset(:rainbows_config_path)        { "#{fetch(:current_path)}/config" }
+          _cset(:rainbows_config_filename)    { "rainbows.rb" }
+        end
+
+        # Check if a remote process exists using its pid file
+        #
+        def remote_process_exists?(pid_file)
+          "[ -e #{pid_file} ] && #{try_rainbows_user} kill -0 `cat #{pid_file}` > /dev/null 2>&1"
+        end
+
+        # Stale rainbows process pid file
+        #
+        def old_rainbows_pid
+          "#{rainbows_pid}.oldbin"
+        end
+
+        # Command to check if rainbows is running
+        #
+        def rainbows_is_running?
+          remote_process_exists?(rainbows_pid)
+        end
+
+        # Command to check if stale rainbows is running
+        #
+        def old_rainbows_is_running?
+          remote_process_exists?(old_rainbows_pid)
+        end
+
+        # Get rainbows master process PID (using the shell)
+        #
+        def get_rainbows_pid(pid_file=rainbows_pid)
+          "`cat #{pid_file}`"
+        end
+
+        # Get rainbows master (old) process PID
+        #
+        def get_old_rainbows_pid
+          get_rainbows_pid(old_rainbows_pid)
+        end
+
+        # Send a signal to a rainbows master processes
+        #
+        def rainbows_send_signal(signal, pid=get_rainbows_pid)
+          "#{try_rainbows_user} kill -s #{signal} #{pid}"
+        end
+
+        # Run a command as the :rainbows_user user if :rainbows_user is a string.
+        # Otherwise run as default (:user) user.
+        #
+        def try_rainbows_user
+          "#{sudo :as => rainbows_user.to_s}" if rainbows_user.kind_of?(String)
+        end
+
+        # Kill rainbowss in multiple ways O_O
+        #
+        def kill_rainbows(signal)
+          script = <<-END
+            if #{rainbows_is_running?}; then
+              echo "Stopping rainbows...";
+              #{rainbows_send_signal(signal)};
+            else
+              echo "rainbows is not running.";
+            fi;
+          END
+
+          script
+        end
+
+        # Start the rainbows server
+        #
+        def start_rainbows
+          primary_config_path = "#{rainbows_config_path}/#{rainbows_config_filename}"
+          secondary_config_path = "#{rainbows_config_path}/rainbows/#{rainbows_env}.rb"
+
+          script = <<-END
+            if [ -e #{primary_config_path} ]; then
+              rainbows_CONFIG_PATH=#{primary_config_path};
+            else
+              if [ -e #{secondary_config_path} ]; then
+                rainbows_CONFIG_PATH=#{secondary_config_path};
+              else
+                echo "Config file for \"#{rainbows_env}\" environment was not found at either \"#{primary_config_path}\" or \"#{secondary_config_path}\"";
+                exit 1;
+              fi;
+            fi;
+
+            if [ -e #{rainbows_pid} ]; then
+              if #{try_rainbows_user} kill -0 `cat #{rainbows_pid}` > /dev/null 2>&1; then
+                echo "rainbows is already running!";
+                exit 0;
+              fi;
+
+              #{try_rainbows_user} rm #{rainbows_pid};
+            fi;
+
+            echo "Starting rainbows...";
+            cd #{current_path} && #{try_rainbows_user} BUNDLE_GEMFILE=#{current_path}/Gemfile #{rainbows_bundle} exec #{rainbows_bin} -c $rainbows_CONFIG_PATH -E #{app_env} -D;
+          END
+
+          script
+        end
+
+        def duplicate_rainbows
+          script = <<-END
+            if #{rainbows_is_running?}; then
+              echo "Duplicating rainbows...";
+              #{rainbows_send_signal('USR2')};
+            else
+              #{start_rainbows}
+            fi;
+          END
+
+          script
+        end
+
+        def rainbows_roles
+          fetch(:rainbows_roles, :app)
+        end
+
+        #
+        # rainbows cap tasks
+        #
+        namespace :rainbows do
+          desc 'Start rainbows master process'
+          task :start, :roles => rainbows_roles, :except => {:no_release => true} do
+            run start_rainbows
+          end
+
+          desc 'Stop rainbows'
+          task :stop, :roles => rainbows_roles, :except => {:no_release => true} do
+            run kill_rainbows('QUIT')
+          end
+
+          desc 'Immediately shutdown rainbows'
+          task :shutdown, :roles => rainbows_roles, :except => {:no_release => true} do
+            run kill_rainbows('TERM')
+          end
+
+          desc 'Restart rainbows'
+          task :restart, :roles => rainbows_roles, :except => {:no_release => true} do
+            run <<-END
+              #{duplicate_rainbows}
+
+              sleep #{rainbows_restart_sleep_time}; # in order to wait for the (old) pidfile to show up
+
+              if #{old_rainbows_is_running?}; then
+                #{rainbows_send_signal('QUIT', get_old_rainbows_pid)};
+              fi;
+            END
+          end
+
+          desc 'Duplicate rainbows'
+          task :duplicate, :roles => rainbows_roles, :except => {:no_release => true} do
+            run duplicate_rainbows()
+          end
+
+          desc 'Reload rainbows'
+          task :reload, :roles => rainbows_roles, :except => {:no_release => true} do
+            run <<-END
+              if #{rainbows_is_running?}; then
+                echo "Reloading rainbows...";
+                #{rainbows_send_signal('HUP')};
+              else
+                #{start_rainbows}
+              fi;
+            END
+          end
+
+          desc 'Add a new worker'
+          task :add_worker, :roles => rainbows_roles, :except => {:no_release => true} do
+            run <<-END
+              if #{rainbows_is_running?}; then
+                echo "Adding a new rainbows worker...";
+                #{rainbows_send_signal('TTIN')};
+              else
+                echo "rainbows is not running.";
+              fi;
+            END
+          end
+
+          desc 'Remove amount of workers'
+          task :remove_worker, :roles => rainbows_roles, :except => {:no_release => true} do
+            run <<-END
+              if #{rainbows_is_running?}; then
+                echo "Removing a rainbows worker...";
+                #{rainbows_send_signal('TTOU')};
+              else
+                echo "rainbows is not running.";
+              fi;
+            END
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  CapistranoRainbows::CapistranoIntegration.load_into(Capistrano::Configuration.instance)
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rainbows
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano plugin that integrates Rainbows server tasks.
+email: ben@h2ocube.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-rainbows.gemspec
+- examples/rails3.rb
+- lib/capistrano-rainbows.rb
+- lib/capistrano-rainbows/capistrano_integration.rb
+homepage: https://github.com/h2ocube/capistrano-rainbows
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rainbows integration for Capistrano
+test_files: []