deployable 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/deployable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "deployable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "deployable"
+  s.version     = Deployable::VERSION
+  s.authors     = ["Digitpaint", "Flurin Egger"]
+  s.email       = ["info@digitpaint.nl", "flurin@digitpaint.nl"]
+  s.homepage    = ""
+  s.summary     = %q{A collection of handy capistrano deploy recipes}
+  s.description = s.summary
+
+  s.rubyforge_project = "deployable"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/examples/scripts/initd.rb

@@ -0,0 +1,190 @@
+#!/usr/bin/env ruby
+
+# chkconfig: - 85 15
+# description:  Passenger Standalone
+require 'yaml'
+require 'pathname'
+
+# The user the applications run as.
+USER = "admin"
+USER_HOME_PATH = File.expand_path("~#{USER}")
+RVM_PATH = USER_HOME_PATH + "/.rvm/"
+
+# The place where all your applications reside. This scripts assumes that
+# you have the following structure in your APPLICATIONS_PATH:
+# APPLICATIONS_PATH
+# |- APPLICATION_NAME
+#    |- STAGE
+#        |- server.yml (REQUIRED)
+#        |- current     
+APPLICATIONS_PATH = USER_HOME_PATH + "/applications/"
+
+# Example :Server.yml
+#
+# passenger:
+#   port: 10001 # The port number passenger standalone will be ran on
+# rvm:
+#   rvm_ruby_string: "rubyversion@gemsetname" # The ruby version and gemset RVM will use
+# callbacks: # All callbacks are optional and are references to scripts relative to APPLICATIONS_PATH/APPLICATION_NAME/STAGE
+#   start:
+#     before: # Ran before passenger has started
+#     after:  # Ran after passenger has started 
+#   stop:
+#     before: # Ran before passenger has been stopped
+#     after:  # Ran after passenger has been stopped
+
+# ======================================================
+# Shouldn't be necessary to change stuff below this line
+# ======================================================
+
+# Main start routine.
+def run!
+  command = ARGV.first
+  available_commands = %w{start stop list}
+  raise "Use one of #{available_commands.join("|")} as first argument" unless available_commands.include?(command)
+
+  applications = Dir.glob("#{APPLICATIONS_PATH}*/*").inject({}){|mem, dir| parts = dir.split("/"); mem[parts[-2]] ||= []; mem[parts[-2]] << parts[-1]; mem}
+
+  if command == "list"
+    str = "All applications for #{USER}"
+    puts str
+    puts "=" * str.size
+    
+    applications.each do |application, stages|
+      puts "#{application} (#{APPLICATIONS_PATH}/#{application})"
+      stages.each do |stage|
+        puts "    - #{stage}"
+      end
+    end
+  else
+    if application = ARGV[1]
+      unless applications.has_key?(application)
+        raise "Can't find application #{application}"
+      end
+
+      if stage = ARGV[2]
+        unless applications[application].include?(stage)
+          raise "Stage #{stage} not found for application #{application}"
+        end
+        Application.new(application,stage).start_or_stop!(command)
+      else
+        applications[application].each do |stage|
+          Application.new(application,stage).start_or_stop!(command)
+        end
+      end
+    else
+      applications.each do |application, stages|
+        stages.each do |stage|
+          Application.new(application,stage).start_or_stop!(command)
+        end
+      end
+    end
+  end
+  true
+end
+
+# Wrapper class to handle application specific start and stop methods
+# including callbacks
+class Application
+  
+  attr_reader :config, :path, :name, :stage
+  
+  def initialize(application_name,stage)
+    @path = Pathname.new("#{APPLICATIONS_PATH}#{application_name}/#{stage}")
+    @name = application_name
+    @stage = start_or_stop
+    
+    # Sanity check!
+    raise "No server.yml found in '#{@path}'" unless File.exist?(@path +"server.yml")
+    
+    # Load config
+    @config = YAML.load(File.read((@path +"server.yml").to_s))
+  end
+  
+  def start_or_stop!(command)
+    case command
+    when "start" then self.start!
+    when "stop"  then self.stop!
+    end    
+  end
+  
+  def start!
+    say "Start #{USER} #{self.name} #{self.stage}"
+    
+    # Check for passenger gem.
+    unless rvm_execute(self.config, "gem list passenger") =~ /passenger/
+      say "Installing Passenger..."
+      rvm_execute(self.config, "gem install passenger")
+    end
+    
+    # Run the before start callback
+    run_callback(:start, :before)
+    
+    # Start the server
+    puts rvm_execute(self.config, "passenger start #{self.path + "current"} --user #{user} --port #{server_config['passenger']['port']} --environment production -d --pid-file #{self.path + "passenger.pid"}")
+    
+    # Run the after start callback
+    run_callback(:start, :after)    
+  end
+  
+  def stop!
+    say "Stop #{USER} #{self.name} #{self.stage}"
+    
+    # Run the before :stop callback
+    run_callback(:stop, :before)
+    
+    puts rvm_execute(self.config, "passenger stop --pid-file #{self.path + "passenger.pid"}")
+    
+    # Run the after :stop callback
+    run_callback(:stop, :after)    
+  end
+  
+  # Simple output wrapper
+  def say(msg)
+    puts msg
+  end
+  
+  protected
+  
+  def callback(key, time)
+    return unless self.config.has_key?("callbacks")
+    
+    callbacks = self.config["callbacks"]
+    
+    if callback = (callbacks[key.to_s] && callbacks[key.to_s][time.to_s])
+      if File.exists?(self.path + callback)
+        say "Running #{time} #{key} callback '#{callback}'"
+        say rvm_execute(self.config, "bash #{self.path + callback}")
+      else
+        raise "Defined callback #{time} #{key} '#{callback}' does not exist!"
+      end      
+    end
+  end
+  
+end
+
+# Helper method to run within an RVM environment
+def rvm_execute(server_config, command)
+  execute("rvm_path=#{RVM_PATH} #{RVM_PATH}bin/rvm-shell '#{server_config['rvm']['rvm_ruby_string']}' -c '#{command}'")
+end
+
+# Execute command and decide wether or not to SUDO
+def execute(command)
+  whoami = `whoami`.strip
+  if whoami == USER
+    `#{command} 2>&1`
+  else
+    `sudo -u #{USER} -H #{command} 2>&1`
+  end
+end
+
+begin
+  if run!
+    puts "Done!"
+  else
+    puts "Usage: passenger-standalone {start|stop|list} [application] [stage]"
+  end
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  puts "Usage: passenger-standalone {start|stop|list} [application] [stage]"
+end

data/lib/deployable/bundler-0.7.rb

@@ -0,0 +1,23 @@
+# = Bundler 0.7.x related tasks
+# 
+# Warning: Do not load 0.7.x AND 1.0.x tasks at the same time!
+Capistrano::Configuration.instance(true).load do
+  namespace :bundler do
+    desc "Setup bundler dirs in shared"
+    task :setup, :roles => [:app] do
+      run "mkdir -p #{deploy_to}/shared/bundler_gems/gems #{deploy_to}/shared/bundler_gems/specifications"
+    end
+  
+    desc "Bundle gems in release_path/vendor/bundler_gems (symlinked to shared)"
+    task :bundle, :roles => [:app] do
+      run "cd #{release_path}/vendor/bundler_gems; ln -fs #{deploy_to}/shared/bundler_gems/gems"
+      run "cd #{release_path}/vendor/bundler_gems; ln -fs #{deploy_to}/shared/bundler_gems/specifications"
+      run "cd #{release_path}; gem bundle --cached"
+    end
+    
+    desc "Install bundler"
+    task :install, :roles => [:app] do
+      run "gem install bundler --version=0.7.2"
+    end    
+  end
+end

data/lib/deployable/database.rb

@@ -0,0 +1,121 @@
+# = Database.yml related tasks
+#
+# == Usage
+# 
+# * Include this file in your <tt>deploy.rb</tt> configuration file.
+# * Setup the required variables (see below)
+# * After deploy:setup run database:setup
+# * After deploy:update_code run database:copy_config_to_release
+#
+# == Setting variables
+# 
+# The recipe uses the variable :database_config. You can put in there whatever you like but these are the defaults:
+#
+#  set :database_config, {
+#        :username => "", 
+#        :host => "",
+#        :development => "", 
+#        :production => "",
+#        :test => ""
+#  }
+#
+# == Password
+# 
+# Because you definitely don't want the password for the database in your SCM the recipe
+# asks you for it.
+# 
+# == Custom template
+# 
+# By default, this script creates the database.yml below. 
+#
+# If you want to overwrite the default template, simply create a custom Erb template
+# called <tt>database.yml.erb</tt> and save it into <tt>config/deploy/templates</tt> folder.
+# 
+# Although the name of the file can't be changed, you can customize the directory
+# where it is stored defining a variable called <tt>:template_dir</tt>.
+# 
+#   # store your custom template at foo/bar/database.yml.erb
+#   set :template_dir, "foo/bar"
+# 
+#   # example of database template
+#   
+#   # MySQL (default setup).  Versions 4.1 and 5.0 are recommended.
+#   
+#   db: &db
+#     adapter: mysql2
+#     username: <%= db[:username] %>
+#     password: <%= db[:password] %>
+#     host: <%= db[:host] %>
+#   
+#   development:
+#     <<: *db
+#     database: <%= db[:development] %>
+#   
+#   test:
+#     <<: *db
+#     database: <%= db[:test] %>
+#   
+#   production:
+#     <<: *db
+#     database: <%= db[:production] %>
+# 
+#
+# Because this is an Erb template, you can place variables and Ruby scripts
+# within the file.
+# For instance, the template above takes advantage of Capistrano CLI
+# to ask for a MySQL database password instead of hard coding it into the template.
+require 'ostruct'
+
+Capistrano::Configuration.instance.load do
+  namespace :database do
+    desc <<-DESC
+      Creates the database.yml configuration file in deploy path.
+      It asks for a database password.
+
+      By default, this task uses a template unless a template \
+      called database.yml.erb is found either is :template_dir \
+      or /config/deploy folders. The default template matches \
+      the template for config/database.yml file shipped with Rails.
+
+    DESC
+    task :setup, :except => { :no_release => true } do
+
+      default_template = <<-EOF
+# MySQL (default setup).  Versions 4.1 and 5.0 are recommended.
+
+db: &db
+  adapter: <%= config[:adapter] || "mysql2" %>
+  username: <%= config[:username] %>
+  password: <%= Capistrano::CLI.ui.ask("Database password: ") %>
+  host: <%= config[:host] %>
+
+development:
+  <<: *db
+  database: <%= config[:development] %>
+
+test:
+  <<: *db
+  database: <%= config[:test] %>
+
+production:
+  <<: *db
+  database: <%= config[:production] %>
+EOF
+
+      location = fetch(:template_dir, "config/deploy/templates") + '/database.yml.erb'
+      template = File.file?(location) ? File.read(location) : default_template
+
+
+      view = ERB.new(template)
+      put view.result(OpenStruct.new(:config => fetch(:database_config)).send(:binding)), "#{deploy_to}/database.yml"
+    end
+
+    desc <<-DESC
+      Copies the setup database.yml to the just deployed release.
+    DESC
+    task :copy_config_to_release, :except => { :no_release => true } do
+      run "cp #{deploy_to}/database.yml #{release_path}/config/database.yml"
+    end
+
+  end
+end

data/lib/deployable/passenger.rb

@@ -0,0 +1,24 @@
+# = Passenger related recipes
+#
+# These tasks overwrite the default start/stop/restart tasks for deployment
+# With passenger we only need to touch 'CURRENT_PATH/tmp/restart.txt'
+#
+# Warning: This overwrites the default deploy:restart, deploy:start and deploy:stop tasks
+Capistrano::Configuration.instance(true).load do
+  
+  namespace :deploy do
+    task :restart, :roles => [:app] do
+      run "touch #{current_path}/tmp/restart.txt"  
+    end      
+    
+    task :start, :roles => [:app] do
+      # do nothing
+    end
+
+    task :stop, :roles => [:app] do
+      # do nothing
+    end
+    
+  end
+  
+end

data/lib/deployable/passenger_standalone.rb

@@ -0,0 +1,34 @@
+# = Passenger Standalone related recipes
+#
+# These tasks handle setup of server.yml to use in combination
+# with the DP init.d script for passenger standalone installations (see examples/scripts/initd.rb)
+#
+# 
+require 'yaml'
+Capistrano::Configuration.instance(true).load do
+  namespace :passenger_standalone do
+    desc "Setup server.yml in the 'deploy_to' directory"
+    task :setup, :roles => [:app] do    
+      config = fetch(:passenger_standalone)
+      config = deep_stringify_keys(config)
+      unless config["rvm"] && config["rvm"]["rvm_ruby_string"]
+        config["rvm"] ||= {}
+        config["rvm"]["rvm_ruby_string"] = fetch(:rvm_ruby_string)
+      end
+      
+      put config.to_yaml, "#{deploy_to}/server.yml"      
+    end
+  end
+  
+  # Helper method to make all keys of the config strings
+  def deep_stringify_keys(hash)
+    hash.inject({}) do |mem, (k,v)|
+      if v.kind_of?(Hash)
+        mem[k.to_s] = deep_stringify_keys(v)
+      else
+        mem[k.to_s] = v
+      end
+      mem
+    end
+  end
+end

data/lib/deployable/rvm.rb

@@ -0,0 +1,33 @@
+# = RVM related tasks
+# 
+# These tasks make working with RVM and gemsits a little bit easier. 
+#
+# == Usage
+# We want to be able to set the defined RVMRC in the deploy script
+# on the server too. To achieve this we have to set the RVMRC 
+# after every deploy and we have to trust the just created RVMRC too.
+#
+# == Example
+# require 'deployable/rvm'
+# before "deploy:setup", "rvm:create_gemset"
+# after "deploy:update_code", "rvm:set_rvmrc", "rvm:trust_rvmrc"
+# 
+Capistrano::Configuration.instance(true).load do
+  namespace :rvm do
+    desc "Trust the RVMRC in release_path"
+    task :trust_rvmrc do
+      run "rvm rvmrc trust #{release_path}"
+    end
+  
+    desc "Set an RVMRC according to the rubystring in release_path"
+    task :set_rvmrc, :roles => [:app] do
+      put "rvm use #{rvm_ruby_string}", "#{release_path}/.rvmrc"
+    end
+    
+    desc "Create the gemset"
+    task :create_gemset, :roles => [:app] do
+      ruby,gemset = rvm_ruby_string.split("@")
+      run "rvm gemset create #{gemset}"
+    end
+  end
+end

data/lib/deployable/version.rb

@@ -0,0 +1,3 @@
+module Deployable
+  VERSION = "0.0.1"
+end

data/lib/deployable.rb

@@ -0,0 +1,8 @@
+require "deployable/version"
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+module Deployable
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: deployable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Digitpaint
+- Flurin Egger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000Z
+dependencies: []
+description: A collection of handy capistrano deploy recipes
+email:
+- info@digitpaint.nl
+- flurin@digitpaint.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- deployable.gemspec
+- examples/config/deploy.rb
+- examples/config/deploy/acceptance.rb
+- examples/config/deploy/production.rb
+- examples/scripts/initd.rb
+- lib/deployable.rb
+- lib/deployable/bundler-0.7.rb
+- lib/deployable/database.rb
+- lib/deployable/passenger.rb
+- lib/deployable/passenger_standalone.rb
+- lib/deployable/rvm.rb
+- lib/deployable/version.rb
+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: deployable
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A collection of handy capistrano deploy recipes
+test_files: []