cap-recipes 0.3.25 → 0.3.26

data/README.textile

@@ -11,6 +11,7 @@ for common issues which can then be used by the community.
 
 Currently included:
 
+ * Ruby Setup  
  * Rubygems Management
  * Apache Server     
  * Phusion Passenger
@@ -77,12 +78,25 @@ h5. manage.rb
 h5. install.rb
 
   * apache:install - installs apache and dependencies onto a debian system
+
+h3. Ruby
+
+h4. Configuration
+
+  * None required
   
+h4. Tasks
+
+h5. install.rb
+
+  * ruby:setup - Installs ruby 1.8 using standard aptitude packages
+
 h3. Rubygems
 
 h4. Configuration
 
   * rubygem_paths - a path or array of paths to your gem binaries [default '/usr/bin/gem' ]
+  * rubygems_version - which version of rubygems to install [default '1.3.5']
 
 h4. Tasks
 
@@ -94,6 +108,10 @@ h5. manage.rb
   * rubygems:cleanup - Performs a cleanup for all outdated rubygems
   * 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
+
+ * rubygems:install - Installs rubygems by downloading package and running setup.rb
 
 h3. Passenger
 
@@ -348,6 +366,45 @@ set :memcache_init_path, "/etc/init.d/memcache" # defaults to "/etc/init.d/memca
 </code>
 </pre>
 
+You can find more examples of what your @deploy.rb@ file should look like in the @examples@ folder.
+
+h2. UTILITIES
+
+In addition to the recipes themselves, this gem provides a bunch of useful utility methods
+which make writing your own recipes or extending existing ones much easier by creating reusable
+commands for common subtasks in a recipe.
+
+There are too many to mention all of them directly, but check out @lib/cap_recipes/tasks/utilities.rb@
+to browse all available utility methods. A few are listed below:
+
+ * utilities.config_gsub(file, findPattern, replaceString)
+ ** Replaces the @findPattern@ with @replaceString@ within specified file on server
+ ** # utilities.config_gsub('/etc/example', /\#(option:.*?\n)/im, "\\1")
+ 
+ * utilities.ask(question, default) 
+ ** Asks the user a question on the command-line and returns the response
+ ** utilities.ask('What is your name?', 'John')
+ 
+ * utilities.yes?(question) 
+ ** Asks the user a yes or no question on the command-line and returns boolean result
+ ** utilities.yes?('Proceed with installation?')
+ 
+ * utilities.apt_install(packages)
+ ** Installs all specified aptitude packages silently without user intervention
+ ** utilities.apt_install %w[package1 package2]
+ 
+ * utilities.sudo_upload(local_path, remote_dest, options)
+ ** Uploads a file to a temporary location and then sudo moves it to specified remote destination
+ ** utilities.sudo_upload('/local/path/to/file', '/remote/path/to/destination', :mode => 'u+rwx')
+ 
+ * utilities.with_role(role) { ... }
+ ** 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 { ... }
+ ** Forces tasks in block to execute using the given user/password credentials
+ ** This is useful because of certain limitations in capistrano
+
 h2. LICENSE:
 
 (The MIT License)

data/VERSION.yml

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

data/cap-recipes.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cap-recipes}
-  s.version = "0.3.25"
+  s.version = "0.3.26"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]
@@ -52,7 +52,10 @@ Gem::Specification.new do |s|
      "lib/cap_recipes/tasks/rails.rb",
      "lib/cap_recipes/tasks/rails/hooks.rb",
      "lib/cap_recipes/tasks/rails/manage.rb",
+     "lib/cap_recipes/tasks/ruby.rb",
+     "lib/cap_recipes/tasks/ruby/install.rb",
      "lib/cap_recipes/tasks/rubygems.rb",
+     "lib/cap_recipes/tasks/rubygems/install.rb",
      "lib/cap_recipes/tasks/rubygems/manage.rb",
      "lib/cap_recipes/tasks/utilities.rb",
      "lib/cap_recipes/tasks/whenever.rb",

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

@@ -12,6 +12,12 @@ Capistrano::Configuration.instance(true).load do
       enable_apache_module
       update_config
     end
+    
+    desc "install build-essentials package"
+    task :install_build_essential do
+      utilities.apt_install 'build-essential'
+    end
+    before "passenger:install", "passenger:install_build_essential"
 
     desc "Setup Passenger Module"
     task :enable_apache_module, :roles => :web do

data/lib/cap_recipes/tasks/ruby.rb

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

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

@@ -0,0 +1,15 @@
+require 'cap_recipes/tasks/utilities.rb'
+ 
+Capistrano::Configuration.instance(true).load do
+ 
+  namespace :ruby do
+ 
+    desc "install ruby"
+    task :setup, :roles => :app do
+      utilities.apt_install %w[ruby ri rdoc ruby1.8-dev irb1.8 libreadline-ruby1.8
+            libruby1.8 rdoc1.8 ri1.8 ruby1.8 irb libopenssl-ruby libopenssl-ruby1.8]
+    end
+    before "ruby:setup", "aptitude:updates"
+ 
+  end
+end

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

@@ -0,0 +1,23 @@
+Capistrano::Configuration.instance(true).load do
+  set :rubygems_version, "1.3.5"
+
+  namespace :rubygems do
+    before "rubygems:setup", "ruby:setup"
+
+    desc "install rubygems"
+    task :setup, :roles => :app do
+      run "wget http://rubyforge.org/frs/download.php/60718/rubygems-#{rubygems_version}.tgz"
+      run "tar xvzf rubygems-#{rubygems_version}.tgz"
+      run "cd rubygems-#{rubygems_version}; sudo ruby setup.rb"
+      run "#{sudo} rm /usr/bin/gem; #{sudo} ln -s /usr/bin/gem1.8 /usr/bin/gem"
+    end
+
+    desc "cleanup the files"
+    task :cleanup do
+      run "cd; rm -rf rubygems-#{rubygems_version}; rm -rf rubygems-#{rubygems_version}.*"
+    end
+    before "rubygems:setup", "rubygems:cleanup"
+    after "rubygems:setup", "rubygems:cleanup"
+
+  end
+end

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

@@ -26,16 +26,14 @@ Capistrano::Configuration.instance(true).load do
 
     desc "Install a gem on the app servers"
     task :install, :roles => :app do
-      puts "Enter the name of the gem you'd like to install:"
-      gem_name = $stdin.gets.chomp
+      gem_name = utilities.ask "Enter the name of the gem you'd like to install:"
       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 app servers"
     task :uninstall, :roles => :app do
-      puts "Enter the name of the gem you'd like to remove:"
-      gem_name = $stdin.gets.chomp
+      gem_name = utilities.ask "Enter the name of the gem you'd like to remove:"
       logger.info "trying to remove '#{gem_name}'"
       Array(rubygem_paths).each { |path| sudo "#{path} uninstall #{gem_name} -x" }
     end

data/lib/cap_recipes/tasks/utilities.rb

@@ -10,7 +10,38 @@ module Utilities
     put content, tmp
     sudo "mv #{tmp} #{file}"
   end
-    
+  
+  # utilities.ask('What is your name?', 'John')
+  def ask(question, default='')
+    question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+    answer = Capistrano::CLI.ui.ask(space(question)).strip
+    answer.empty? ? default : answer
+  end
+
+  # utilities.yes?('Proceed with install?')
+  def yes?(question)
+    question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+    question += ' (y/n)'
+    ask(question).downcase.include? 'y'
+  end
+  
+  def space(str)
+    "\n#{'=' * 80}\n#{str}"
+  end
+  
+  # utilities.apt_install %w[package1 package2]
+  def apt_install(packages)
+    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(" ")}"
+  end
+  
+  def apt_upgrade
+    apt_get="DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get"
+    sudo "#{apt_get} -qyu --force-yes upgrade"
+  end
+  
+  # utilities.sudo_upload('/local/path/to/file', '/remote/path/to/destination', options)
   def sudo_upload(from, to, options={}, &block)
     top.upload from, "/tmp/#{File.basename(to)}", options, &block
     sudo "mv /tmp/#{File.basename(to)} #{to}"
@@ -18,6 +49,7 @@ module Utilities
     sudo "chown #{options[:owner]} #{to}" if options[:owner]
   end
   
+  # utilities.adduser('deploy')
   def adduser(user, options={})
     options[:shell] ||= '/bin/bash' # new accounts on ubuntu 6.06.1 have been getting /bin/sh
     switches = '--disabled-password --gecos ""'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cap-recipes
 version: !ruby/object:Gem::Version 
-  version: 0.3.25
+  version: 0.3.26
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -58,7 +58,10 @@ files:
 - lib/cap_recipes/tasks/rails.rb
 - lib/cap_recipes/tasks/rails/hooks.rb
 - lib/cap_recipes/tasks/rails/manage.rb
+- lib/cap_recipes/tasks/ruby.rb
+- lib/cap_recipes/tasks/ruby/install.rb
 - lib/cap_recipes/tasks/rubygems.rb
+- lib/cap_recipes/tasks/rubygems/install.rb
 - lib/cap_recipes/tasks/rubygems/manage.rb
 - lib/cap_recipes/tasks/utilities.rb
 - lib/cap_recipes/tasks/whenever.rb