cap-recipes 0.3.18

data/lib/cap_recipes/tasks/passenger.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'passenger/*.rb')].sort.each { |lib| require lib }

data/lib/cap_recipes/tasks/passenger/install.rb

@@ -0,0 +1,62 @@
+require 'cap_recipes/tasks/utilities.rb'
+
+#TODO add something like require that a task named apache:restart exists
+Capistrano::Configuration.instance(true).load do
+  set :base_ruby_path, '/usr'
+  set :confd_passenger_filename, 'passenger'
+
+  namespace :passenger do
+    desc "Installs Phusion Passenger"
+    task :install, :roles => :web do
+      puts 'Installing passenger module'
+      enable_apache_module
+      update_config
+    end
+
+    desc "Setup Passenger Module"
+    task :enable_apache_module, :roles => :web do
+      sudo "#{base_ruby_path}/bin/gem install passenger --no-ri --no-rdoc"
+      sudo "#{base_ruby_path}/bin/passenger-install-apache2-module --auto"
+    end
+
+    desc "Configure Passenger"
+    task :update_config, :roles => :web do
+      version = 'ERROR' # default
+
+      # passenger (2.X.X, 1.X.X)
+      run("gem list | grep passenger") do |ch, stream, data|
+        version = data.sub(/passenger \(([^,]+).*?\)/,"\\1").strip
+      end
+
+      puts "  passenger version #{version} configured"
+
+      passenger_config =<<-EOF
+        LoadModule passenger_module #{base_ruby_path}/lib/ruby/gems/1.8/gems/passenger-#{version}/ext/apache2/mod_passenger.so
+        PassengerRoot #{base_ruby_path}/lib/ruby/gems/1.8/gems/passenger-#{version}
+        PassengerRuby #{base_ruby_path}/bin/ruby
+      EOF
+
+      put passenger_config, "/tmp/passenger"
+      sudo "mv /tmp/passenger /etc/apache2/conf.d/#{confd_passenger_filename}"
+      apache.restart
+    end
+
+    # if you want to add more options, try this, in your own conifg
+    # read this first... http://www.modrails.com/documentation/Users%20guide.html
+    #    namespace :passenger do
+    #      task :add_custom_configuration, :roles=>:web do
+    #        #512 - 100(stack) - 4*100(instance)
+    #        passenger_config = <<EOF
+    #    PassengerMaxPoolSize 4
+    #    PassengerPoolIdleTime 3000
+    #    EOF
+    #        put passenger_config, "/tmp/passenger"
+    #        sudo "cat /tmp/passenger >> /etc/apache2/conf.d/passenger"
+    #        apache.restart
+    #      end
+    #    end
+    #    after "passenger:update_config", *%w(
+    #      passenger:add_custom_configuration
+    #    )
+  end
+end

data/lib/cap_recipes/tasks/passenger/manage.rb

@@ -0,0 +1,24 @@
+require 'cap_recipes/tasks/utilities.rb'
+
+Capistrano::Configuration.instance(true).load do
+  namespace :deploy do
+    
+    desc "Stops the phusion passenger server"
+    task :stop, :roles => :web do
+      puts "Stopping rails web server"
+      apache.stop
+    end
+
+    desc "Starts the phusion passenger server"
+    task :start, :roles => :web do
+      puts "Starting rails web server"
+      apache.start
+    end
+
+    desc "Restarts the phusion passenger server"
+    task :restart, :roles => :web do
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+    
+  end
+end

data/lib/cap_recipes/tasks/rails.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'rails/*.rb')].sort.each { |lib| require lib }

data/lib/cap_recipes/tasks/rails/hooks.rb

@@ -0,0 +1,8 @@
+require 'cap_recipes/tasks/utilities.rb'
+
+Capistrano::Configuration.instance(true).load do
+  after "deploy:update_code", "rails:symlink_db_config" # copy database.yml file to release path
+  after "deploy:update_code", "rails:sweep:cache" # clear cache after updating code
+  after "deploy:restart"    , "rails:repair_permissions" # fix the permissions to work properly
+  after "deploy:restart"    , "rails:ping" # ping passenger to start the rails instance
+end

data/lib/cap_recipes/tasks/rails/manage.rb

@@ -0,0 +1,53 @@
+require 'cap_recipes/tasks/utilities.rb'
+
+Capistrano::Configuration.instance(true).load do
+  set :local_ping_path, 'http://localhost'
+
+  namespace :rails do
+    # ===============================================================
+    # UTILITY TASKS
+    # ===============================================================
+    desc "Symlinks the shared/config/database yaml to release/config/"
+    task :symlink_db_config, :roles => :app do
+      puts "Copying database configuration to release path"
+      try_sudo "rm #{release_path}/config/database.yml -f"
+      try_sudo "ln -s #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+    end
+
+    desc "Repair permissions to allow user to perform all actions"
+    task :repair_permissions, :roles => :app do
+      puts "Applying correct permissions to allow for proper command execution"
+      try_sudo "chmod -R 744 #{current_path}/log #{current_path}/tmp"
+      try_sudo "chown -R #{user}:#{user} #{current_path}"
+      try_sudo "chown -R #{user}:#{user} #{current_path}/tmp"
+    end
+
+    desc "Displays the production log from the server locally"
+    task :tail, :roles => :app do
+      stream "tail -f #{shared_path}/log/production.log"
+    end
+
+    desc "Pings localhost to startup server"
+    task :ping, :roles => :app do
+      puts "Pinging the web server to start it"
+      run "wget -O /dev/null #{local_ping_path} 2>/dev/null"
+    end
+    
+    # ===============================================================
+    # MAINTENANCE TASKS
+    # ===============================================================
+    namespace :sweep do
+      desc "Clear file-based fragment and action caching"
+      task :log, :roles => :app  do
+        puts "Sweeping all the log files"
+        run "cd #{current_path} && #{sudo} rake log:clear RAILS_ENV=production"
+      end
+
+      desc "Clear file-based fragment and action caching"
+      task :cache, :roles => :app do
+        puts "Sweeping the fragment and action cache stores"
+        run "cd #{release_path} && #{sudo} rake tmp:cache:clear RAILS_ENV=production"
+      end
+    end
+  end
+end

data/lib/cap_recipes/tasks/rubygems.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'rubygems/*.rb')].sort.each { |lib| require lib }

data/lib/cap_recipes/tasks/rubygems/manage.rb

@@ -0,0 +1,43 @@
+Capistrano::Configuration.instance(true).load do
+  set :rubygem_paths, '/usr/bin/gem'
+  
+  namespace :rubygems do
+    desc "Performs a rubygems upgrade, updates all gems and cleans up old ones"
+    task :full_update, :roles => :app do
+      rubygems.upgrade
+      rubygems.update
+      rubygems.cleanup
+    end
+
+    desc "Upgrades the rubygem package installation"
+    task :upgrade, :roles => :app do
+      Array(rubygem_paths).each { |path| sudo "#{path} update --system" }
+    end
+
+    desc "Updates all installed gems"
+    task :update, :roles => :app do
+      Array(rubygem_paths).each { |path| sudo "#{path} update" }
+    end
+
+    desc "Removes old gems which are now outdated"
+    task :cleanup, :roles => :app do
+      Array(rubygem_paths).each { |path| sudo "#{path} cleanup" }
+    end
+
+    desc "Install a gem on your servers servers"
+    task :install, :roles => :app do
+      puts "Enter the name of the gem you'd like to install:"
+      gem_name = $stdin.gets.chomp
+      logger.info "trying to install '#{gem_name}'"
+      Array(rubygem_paths).each {|path| sudo "#{path} install #{gem_name} --no-ri --no-rdoc" }
+    end
+
+    desc "Uninstall a gem from the release servers"
+    task :uninstall, :roles => :app do
+      puts "Enter the name of the gem you'd like to remove:"
+      gem_name = $stdin.gets.chomp
+      logger.info "trying to remove '#{gem_name}'"
+      Array(rubygem_paths).each { |path| sudo "#{path} uninstall #{gem_name} -x" }
+    end
+  end
+end

data/lib/cap_recipes/tasks/utilities.rb

@@ -0,0 +1,114 @@
+require 'fileutils'
+ 
+module Utilities 
+  # utilities.config_gsub('/etc/example', /(.*)/im, "\\1")
+  def config_gsub(file, find, replace)
+    tmp="/tmp/#{File.basename(file)}"
+    get file, tmp
+    content=File.open(tmp).read
+    content.gsub!(find,replace)
+    put content, tmp
+    sudo "mv #{tmp} #{file}"
+  end
+    
+  def sudo_upload(from, to, options={}, &block)
+    top.upload from, "/tmp/#{File.basename(to)}", options, &block
+    sudo "mv /tmp/#{File.basename(to)} #{to}"
+    sudo "chmod #{options[:mode]} #{to}" if options[:mode]
+    sudo "chown #{options[:owner]} #{to}" if options[:owner]
+  end
+  
+  def adduser(user, options={})
+    options[:shell] ||= '/bin/bash' # new accounts on ubuntu 6.06.1 have been getting /bin/sh
+    switches = '--disabled-password --gecos ""'
+    switches += " --shell=#{options[:shell]} " if options[:shell]
+    switches += ' --no-create-home ' if options[:nohome]
+    switches += " --ingroup #{options[:group]} " unless options[:group].nil?
+    invoke_command "grep '^#{user}:' /etc/passwd || sudo /usr/sbin/adduser #{user} #{switches}",
+    :via => run_method
+  end
+  
+  # role = :app
+  def with_role(role, &block)
+    original, ENV['HOSTS'] = ENV['HOSTS'], find_servers(:roles => role).map{|d| d.host}.join(",")
+    begin
+      yield
+    ensure
+      ENV['HOSTS'] = original
+    end
+  end
+
+  # options = { :user => 'xxxxx', :password => 'xxxxx' }
+  def with_credentials(options={}, &block)
+    original_username, original_password = user, password
+    begin
+      set :user,     options[:user] || original_username
+      set :password, options[:password] || original_password
+      yield
+    ensure
+      set :user,     original_username
+      set :password, original_password
+    end
+  end
+  
+  ##
+  # Run a command and ask for input when input_query is seen.
+  # Sends the response back to the server.
+  #
+  # +input_query+ is a regular expression that defaults to /^Password/.
+  #
+  # Can be used where +run+ would otherwise be used.
+  #
+  # run_with_input 'ssh-keygen ...', /^Are you sure you want to overwrite\?/
+ 
+  def run_with_input(shell_command, input_query=/^Password/, response=nil)
+    handle_command_with_input(:run, shell_command, input_query, response)
+  end
+ 
+  ##
+  # Run a command using sudo and ask for input when a regular expression is seen.
+  # Sends the response back to the server.
+  #
+  # See also +run_with_input+
+  #
+  # +input_query+ is a regular expression
+ 
+  def sudo_with_input(shell_command, input_query=/^Password/, response=nil)
+    handle_command_with_input(:sudo, shell_command, input_query, response)
+  end
+ 
+  def invoke_with_input(shell_command, input_query=/^Password/, response=nil)
+    handle_command_with_input(run_method, shell_command, input_query, response)
+  end
+  
+  private
+  
+  ##
+  # Does the actual capturing of the input and streaming of the output.
+  #
+  # local_run_method: run or sudo
+  # shell_command: The command to run
+  # input_query: A regular expression matching a request for input: /^Please enter your password/
+ 
+  def handle_command_with_input(local_run_method, shell_command, input_query, response=nil)
+    send(local_run_method, shell_command, {:pty => true}) do |channel, stream, data|
+      
+      if data =~ input_query
+        if response
+          logger.info "#{data} #{"*"*(rand(10)+5)}", channel[:host]
+          channel.send_data "#{response}\n"
+        else
+          logger.info data, channel[:host]
+          response = ::Capistrano::CLI.password_prompt "#{data}"
+          channel.send_data "#{response}\n"
+        end
+      else
+        logger.info data, channel[:host]
+      end
+    end
+  end
+  
+  
+end
+ 
+Capistrano.plugin :utilities, Utilities

data/lib/cap_recipes/tasks/whenever.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'whenever/*.rb')].sort.each { |lib| require lib }

data/lib/cap_recipes/tasks/whenever/hooks.rb

@@ -0,0 +1,5 @@
+Capistrano::Configuration.instance(true).load do
+  
+  after "deploy:symlink", "whenever:update_crontab" # update crontab after symlink
+  
+end

data/lib/cap_recipes/tasks/whenever/manage.rb

@@ -0,0 +1,10 @@
+require 'cap_recipes/tasks/utilities.rb'
+
+Capistrano::Configuration.instance(true).load do
+  namespace :whenever do
+    desc "Update the crontab file"
+    task :update_crontab, :roles => :db do
+      run "cd #{release_path} && whenever --update-crontab #{application}"
+    end
+  end
+end

data/spec/cap/all/Capfile

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__),'..','helper')
+require 'cap_recipes'

data/spec/cap/helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__),'..','..','lib')
+def current_path;end

data/spec/cap_recipes_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe 'loading everything' do
+  def run_cap(folder,task)
+    folder = File.join(File.dirname(__FILE__),'cap',folder)
+    `cd #{folder} && #{task}`
+  end
+
+  it "finds all tasks" do
+    tasks = run_cap 'all', 'cap -T'
+    tasks.split("\n").size.should >= 20
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+# ---- bugfix
+#`exit?': undefined method `run?' for Test::Unit:Module (NoMethodError)
+#can be solved with require test/unit but this will result in extra test-output
+module Test
+  module Unit
+    def self.run?
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: cap-recipes
+version: !ruby/object:Gem::Version 
+  version: 0.3.18
+platform: ruby
+authors: 
+- Nathan Esquenazi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Battle-tested capistrano recipes for debian, passenger, apache, delayed_job, juggernaut, rubygems, backgroundrb, rails and more
+email: nesquena@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
+- cap-recipes.gemspec
+- examples/advanced/deploy.rb
+- examples/advanced/deploy/experimental.rb
+- examples/advanced/deploy/production.rb
+- examples/simple/deploy.rb
+- lib/cap_recipes.rb
+- lib/cap_recipes/tasks/apache.rb
+- lib/cap_recipes/tasks/apache/install.rb
+- lib/cap_recipes/tasks/apache/manage.rb
+- lib/cap_recipes/tasks/aptitude.rb
+- lib/cap_recipes/tasks/aptitude/manage.rb
+- lib/cap_recipes/tasks/backgroundrb.rb
+- lib/cap_recipes/tasks/backgroundrb/hooks.rb
+- lib/cap_recipes/tasks/backgroundrb/manage.rb
+- lib/cap_recipes/tasks/delayed_job.rb
+- lib/cap_recipes/tasks/delayed_job/hooks.rb
+- lib/cap_recipes/tasks/delayed_job/manage.rb
+- lib/cap_recipes/tasks/juggernaut.rb
+- lib/cap_recipes/tasks/juggernaut/hooks.rb
+- lib/cap_recipes/tasks/juggernaut/manage.rb
+- lib/cap_recipes/tasks/memcache.rb
+- lib/cap_recipes/tasks/memcache/hooks.rb
+- lib/cap_recipes/tasks/memcache/install.rb
+- lib/cap_recipes/tasks/memcache/manage.rb
+- lib/cap_recipes/tasks/passenger.rb
+- lib/cap_recipes/tasks/passenger/install.rb
+- lib/cap_recipes/tasks/passenger/manage.rb
+- lib/cap_recipes/tasks/rails.rb
+- lib/cap_recipes/tasks/rails/hooks.rb
+- lib/cap_recipes/tasks/rails/manage.rb
+- lib/cap_recipes/tasks/rubygems.rb
+- lib/cap_recipes/tasks/rubygems/manage.rb
+- lib/cap_recipes/tasks/utilities.rb
+- lib/cap_recipes/tasks/whenever.rb
+- lib/cap_recipes/tasks/whenever/hooks.rb
+- lib/cap_recipes/tasks/whenever/manage.rb
+- spec/cap/all/Capfile
+- spec/cap/helper.rb
+- spec/cap_recipes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nesquena/cap-recipes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Battle-tested capistrano recipes for passenger, delayed_job, and more
+test_files: 
+- spec/cap/helper.rb
+- spec/cap_recipes_spec.rb
+- spec/spec_helper.rb
+- examples/advanced/deploy/experimental.rb
+- examples/advanced/deploy/production.rb
+- examples/advanced/deploy.rb
+- examples/simple/deploy.rb