cap-recipes 0.3.26 → 0.3.27

data/README.textile

@@ -3,13 +3,14 @@ h1. cap-recipes
 A collection of useful capistrano recipes I have been using in production on a number of sites.
 
 This gem is best suited for ruby (and rails) projects which deploy using Apache and Phusion Passenger.
-Worth noting is that the installation tasks are for linux distributions using apt-get packages.
-Feel free to contribute to this collection and make it even better! 
+Worth noting is that the installation tasks are for systems using aptitude package management.
 
 The overall vision for this project is simply to collect a number of classic, generic recipes 
-for common issues which can then be used by the community.
+for common issues which can then be used by the community. 
 
-Currently included:
+Feel free to improve upon this recipe collection by adding your own! 
+
+Currently included recipes in this gem:
 
  * Ruby Setup  
  * Rubygems Management
@@ -43,7 +44,7 @@ Then, include into your @deploy.rb@ configuration file for Capistrano:
   # tasks for managing and tasks for installing):
   require 'cap_recipes/tasks/memcache'
   require 'cap_recipes/tasks/passenger'
-  # or rails, apache, rubygems, delayed_job, juggernaut, backgroundrb, aptitude, whenever
+  # or ruby, rubygems, rails, apache, delayed_job, juggernaut, backgroundrb, aptitude, whenever
 
   # OR
   # only use managing tasks:
@@ -69,13 +70,13 @@ h4. Configuration
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * apache:stop - stops the apache server
   * apache:start - starts the apache server
   * apache:restart - restarts the apache server
     
-h5. install.rb
+install.rb
 
   * apache:install - installs apache and dependencies onto a debian system
 
@@ -87,7 +88,7 @@ h4. Configuration
   
 h4. Tasks
 
-h5. install.rb
+install.rb
 
   * ruby:setup - Installs ruby 1.8 using standard aptitude packages
 
@@ -100,7 +101,7 @@ h4. Configuration
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * rubygems:full_update - Upgrades rubygems, updates all installed rubygems and performs a cleanup
   * rubygems:upgrade - Upgrades rubygems version (if available)
@@ -109,7 +110,7 @@ h5. manage.rb
   * rubygems:install - Installs a specifed gem from name inputted on console
   * rubygems:uninstall - Removes a specified rubygem from name inputted on console
   
-h5. install.rb
+install.rb
 
  * rubygems:install - Installs rubygems by downloading package and running setup.rb
 
@@ -130,13 +131,13 @@ The following files and folders are expected to exist:
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * deploy:start - Starts the apache server (if needed)
   * deploy:stop  - Stops the apache server (if needed)
   * deploy:restart - Touches the restart.txt file 
       
-h5. install.rb
+install.rb
 
  * passenger:install - Installs the passenger gem, compiles the module silently, and adds the necessary configuration
 
@@ -144,7 +145,7 @@ h3. Aptitude
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * aptitude:install - Installs a specified aptitude package from name inputted on console
   * aptitude:remove  - Removes a specified aptitude package from name inputted on console
@@ -156,7 +157,7 @@ These recipes support rails-specific functionality
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * rails:symlink_db_config - Symlinks the database.yml file from shared/config to release path
   * rails:repair_permissions - Forces the permissions on the rails app to make permission errors a thing of the past
@@ -165,7 +166,7 @@ h5. manage.rb
   * rails:sweep:cache - performs a file cache sweep in production
   * rails:sweep:log - performs a log sweep in production
       
-h5. hooks.rb
+hooks.rb
 
 <pre>
 <code>
@@ -187,13 +188,13 @@ h4. Configuration
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * delayed_job:stop - stops the delayed_job workers
   * delayed_job:start - starts the delayed_job workers
   * delayed_job:restart - restarts the delayed_job workers
 
-h5. hooks.rb
+hooks.rb
 
 <pre>
 <code>
@@ -215,7 +216,7 @@ h4. Configuration
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * backgroundrb:stop - stop backgroundrb workers
   * backgroundrb:start - start backgroundrb workers
@@ -223,7 +224,7 @@ h5. manage.rb
   * backgroundrb:symlink_config - copy backgroundrb.yml from shared/config to release
   * backgroundrb:tail - tails the backgroundrb log file in production
       
-h5. hooks.rb
+hooks.rb
 
 <pre>
 <code>
@@ -245,7 +246,7 @@ h4. Configuration
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * juggernaut:start - starts the juggernaut push server
   * juggernaut:stop  - stop the juggernaut push server
@@ -253,7 +254,7 @@ h5. manage.rb
   * juggernaut:symlink_config - copy juggernaut.yml from shared/config to release
   * juggernaut:tail - tails the juggernaut log file in production
 
-h5. hooks.rb
+hooks.rb
 
 <pre>
 <code>
@@ -276,17 +277,17 @@ h4. Configuration
 
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * memcache:start - starts the memcache daemon
   * memcache:stop  - stops the memcache daemon
   * memcache:restart - restarts the memcache daemon
     
-h5. install.rb
+install.rb
 
   * memcache:install - Installs memcache aptitude package and rubygem
     
-h5. hooks
+hooks.rb
 
 <pre>
 <code>
@@ -304,11 +305,11 @@ h4. Configuration
   
 h4. Tasks
 
-h5. manage.rb
+manage.rb
 
   * whenever:update_crontab - Performs an update applying the schedule.rb file to your server's cron
 
-h5. hooks
+hooks.rb
 
 <pre>
 <code>
@@ -401,7 +402,7 @@ to browse all available utility methods. A few are listed below:
  ** Forces tasks in block to execute only within specific role(s)
  ** This is useful because of certain limitations in the role declaration in capistrano
  
- * utilities.with_credentials { ... }
+ * utilities.with_credentials(:user => 'jsmith', :password => 'secret') { ... }
  ** Forces tasks in block to execute using the given user/password credentials
  ** This is useful because of certain limitations in capistrano
 

data/Rakefile

@@ -1,9 +1,12 @@
 =begin
-Using Jeweler for Gem Packaging
-  Update the version and release version to github: 
+Using Jeweler for Gem Packaging...
+
+  * Update the version and release version to github: 
     $ rake version:bump:patch && rake release && rake gemcutter:release
-  Build and install the latest version locally:
-    $ rake build && rake install && sudo gem cleanup
+    
+  * Build and install the latest version locally:
+    $ rake install
+    
 =end
 
 require 'rake'

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 3
-:patch: 26
+:patch: 27

data/cap-recipes.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cap-recipes}
-  s.version = "0.3.26"
+  s.version = "0.3.27"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]

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

@@ -1,3 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+
 Capistrano::Configuration.instance(true).load do
 
   namespace :apache do
@@ -5,7 +7,9 @@ Capistrano::Configuration.instance(true).load do
     desc 'Installs apache 2 and development headers to compile passenger'
     task :install, :roles => :web do
       puts 'Installing apache 2'
-      try_sudo 'apt-get install apache2 apache2.2-common apache2-mpm-prefork apache2-utils libexpat1 ssl-cert libapr1 libapr1-dev   libaprutil1 libmagic1 libpcre3 libpq5 openssl apache2-prefork-dev -y'
+      utilities.apt_install %w[apache2 apache2.2-common apache2-mpm-prefork apache2-utils 
+        libexpat1 ssl-cert libapr1 libapr1-dev   libaprutil1 libmagic1 
+        libpcre3 libpq5 openssl apache2-prefork-dev]
     end
     
   end

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

@@ -1,29 +1,27 @@
-require 'cap_recipes/tasks/utilities.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
 
 Capistrano::Configuration.instance(true).load do
   namespace :aptitude do
-    desc "Updates all installed packages on apt-get package system"
+    desc "Updates all installed packages on aptitude package system"
     task :updates do
       sudo "apt-get -qy update"
-      sudo "apt-get -qy upgrade"
+      utilities.apt_upgrade
       sudo "apt-get -qy autoremove"
     end
 
-    desc "Installs a specified apt-get package"
+    desc "Installs a specified aptitude package"
     task :install do
-      puts "What is the name of the package(s) you wish to install?"
-      deb_pkg_name = $stdin.gets.chomp
+      deb_pkg_name = utilities.ask "Enter name of the package(s) you wish to install:"
       raise "Please specify deb_pkg_name" if deb_pkg_name == ''
       logger.info "Updating packages..."
       sudo "aptitude update"
       logger.info "Installing #{deb_pkg_name}..."
-      utilities.sudo_with_input "apt-get install #{deb_pkg_name}", /^Do you want to continue\?/
+      utilities.apt_install deb_pkg_name
     end
 
-    desc "Removes a specified apt-get package"
+    desc "Removes a specified aptitude package"
     task :remove do
-      puts "What is the name of the package(s) you wish to install?"
-      deb_pkg_name = $stdin.gets.chomp
+      deb_pkg_name = utilities.ask "Enter name of the package(s) you wish to remove:"
       raise "Please specify deb_pkg_name" if deb_pkg_name == ''
       logger.info "Updating packages..."
       sudo "aptitude update"

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

@@ -1,3 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+
 Capistrano::Configuration.instance(true).load do
   set :delayed_script_path, "#{current_path}/script/delayed_job"
   set :delayed_job_env, 'production'

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

@@ -1,3 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+
 Capistrano::Configuration.instance(true).load do
   set :juggernaut_config, "#{current_path}/config/juggernaut.yml"
   set :juggernaut_pid, "#{current_path}/tmp/pids/juggernaut.pid"

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

@@ -1,10 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+
 Capistrano::Configuration.instance(true).load do
   namespace :memcache do
     
     desc 'Installs memcache and the ruby gem'
     task :install, :roles => :app do
       puts 'Installing memcache'
-      try_sudo 'apt-get install memcached'
+      utilities.apt_install 'memcached'
       try_sudo "#{base_ruby_path}/bin/gem install memcache-client --no-ri --no-rdoc"
       memcache.start
     end

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

@@ -1,3 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+
 Capistrano::Configuration.instance(true).load do
 
   set :memcache_init_path, "/etc/init.d/memcached"

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

@@ -1,6 +1,6 @@
-require 'cap_recipes/tasks/utilities.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+require File.expand_path(File.dirname(__FILE__) + '/../apache/manage')
 
-#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'

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

@@ -1,5 +1,3 @@
-require 'cap_recipes/tasks/utilities.rb'
-
 Capistrano::Configuration.instance(true).load do
   namespace :deploy do
     
@@ -17,6 +15,7 @@ Capistrano::Configuration.instance(true).load do
 
     desc "Restarts the phusion passenger server"
     task :restart, :roles => :web do
+      puts "Restarting passenger by touching restart.txt"
       run "touch #{current_path}/tmp/restart.txt"
     end
     

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

@@ -1,5 +1,3 @@
-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

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

@@ -1,5 +1,3 @@
-require 'cap_recipes/tasks/utilities.rb'
-
 Capistrano::Configuration.instance(true).load do
   set :local_ping_path, 'http://localhost'
 

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

@@ -1,5 +1,6 @@
-require 'cap_recipes/tasks/utilities.rb'
- 
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+require File.expand_path(File.dirname(__FILE__) + '/../aptitude/manage')
+
 Capistrano::Configuration.instance(true).load do
  
   namespace :ruby do

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

@@ -1,3 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../utilities')
+
 Capistrano::Configuration.instance(true).load do
   set :rubygem_paths, '/usr/bin/gem'
   

data/lib/cap_recipes/tasks/utilities.rb

@@ -25,12 +25,10 @@ module Utilities
     ask(question).downcase.include? 'y'
   end
   
-  def space(str)
-    "\n#{'=' * 80}\n#{str}"
-  end
-  
   # utilities.apt_install %w[package1 package2]
+  # utilities.apt_install "package1 package2"
   def apt_install(packages)
+    packages = packages.split(/\s+/) if packages.respond_to?(:split)
     packages = Array(packages)
     apt_get="DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get"
     sudo "#{apt_get} -qyu --force-yes install #{packages.join(" ")}"
@@ -70,6 +68,7 @@ module Utilities
     end
   end
 
+  # utilities.with_credentials(:user => 'xxxx', :password => 'secret')
   # options = { :user => 'xxxxx', :password => 'xxxxx' }
   def with_credentials(options={}, &block)
     original_username, original_password = user, password
@@ -83,16 +82,17 @@ module Utilities
     end
   end
   
+  def space(str)
+    "\n#{'=' * 80}\n#{str}"
+  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
@@ -102,9 +102,7 @@ module Utilities
   # 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
@@ -121,7 +119,6 @@ module Utilities
   # 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|
       

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

@@ -1,5 +1,3 @@
-require 'cap_recipes/tasks/utilities.rb'
-
 Capistrano::Configuration.instance(true).load do
   namespace :whenever do
     desc "Update the crontab file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cap-recipes
 version: !ruby/object:Gem::Version 
-  version: 0.3.26
+  version: 0.3.27
 platform: ruby
 authors: 
 - Nathan Esquenazi