nesquena-cap-recipes 0.1.5

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-26
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/cap_recipes.rb
+lib/cap_recipes/version.rb
+lib/cap_recipes/tasks/apache.rb
+lib/cap_recipes/tasks/backgroundrb.rb
+lib/cap_recipes/tasks/juggernaut.rb
+lib/cap_recipes/tasks/passenger.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/development.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_cap_recipes.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,95 @@
+= cap_recipes
+
+== DESCRIPTION:
+
+This is a collection of capistrano recipes which will grow to encompass many useful recipes. Currently included:
+
+ * Phusion Passenger (Setup and Deployment)
+ * Apache Server 
+ * Juggernaut Process
+ * Backgroundrb Processes
+ 
+== SYNOPSIS:
+
+To include any of these into your deploy.rb configuration file for Capistrano:
+  
+  require 'cap_recipes/tasks/passenger'
+  require 'cap_recipes/tasks/apache'
+  require 'cap_recipes/tasks/backgroundrb'
+  require 'cap_recipes/tasks/juggernaut'
+  
+== USAGE
+
+Passenger
+
+  deploy
+    :stop
+    :start
+    :restart
+    :with_migrations
+    :copy_config
+    :tail
+    :install
+  sweep
+    :cache
+    :log
+    
+Apache
+  variables: apache_init_path
+  tasks:
+    apache
+      :stop
+      :start
+      :restart
+      :install
+  
+Backgroundrb
+  variables: backgroundrb_log
+  tasks:
+    backgroundrb
+      :stop
+      :start
+      :restart
+      :copy_config
+      :tail
+
+Juggernaut
+  
+  variables: juggernaut_config, juggernaut_pid, juggernaut_log
+  tasks:
+    juggernaut
+      :start
+      :stop
+      :restart
+      :copy_config
+      :tail
+
+== INSTALL:
+
+ * gem sources -a http://gems.github.com/
+ * sudo gem install xgamerx-cap-recipes
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nathan Esquenazi
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'cap_recipes/version'
+
+AUTHOR = 'Nathan Esquenazi'  # can also be an array of Authors
+EMAIL = "xgamerx10@gmail.com"
+DESCRIPTION = "My collection of capistrano recipes"
+GEM_NAME = 'cap-recipes' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'caprecipes' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['capistrano', '>= 2.2.0']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "nesquena"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = CapRecipes::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'cap_recipes documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/cap_recipes.rb

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

data/lib/cap_recipes/tasks/apache.rb

@@ -0,0 +1,38 @@
+Capistrano::Configuration.instance(true).load do
+
+  set :apache_init_path, "/etc/init.d/apache2"
+
+  # ===============================================================
+  # SERVER MANAGEMENT
+  # ===============================================================
+
+  namespace :apache do
+    desc "Stops the apache web server"
+    task :stop, :role => :app do
+      puts "Stopping the apache server"
+      sudo "#{apache_init_path} stop"
+    end
+
+    desc "Starts the apache web server"
+    task :start, :role => :app do
+      puts "Starting the apache server"
+      sudo "#{apache_init_path} start"
+    end
+
+    desc "Restarts the apache web server"
+    task :restart, :role => :app do
+      puts "Restarting the apache server"
+      sudo "#{apache_init_path} restart"
+    end
+
+    # ===============================================================
+    # INSTALLATION
+    # ===============================================================
+
+    desc 'Installs apache 2 and development headers to compile passenger'
+    task :install, :roles => :web do
+      puts 'Installing apache 2'
+      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'
+    end
+  end
+end

data/lib/cap_recipes/tasks/backgroundrb.rb

@@ -0,0 +1,75 @@
+require 'yaml'
+
+Capistrano::Configuration.instance(true).load do
+  set :backgroundrb_host, 'localhost'
+  set :backgroundrb_env , 'production'
+  
+  namespace :backgroundrb do   
+    # ===============================================================
+    # PROCESS MANAGEMENT
+    # ===============================================================  
+    
+    desc "Stops the backgroundrb worker processes"
+    task :stop, :role => :app do
+      run "cd #{current_path} && #{sudo} ruby script/backgroundrb stop -e #{backgroundrb_env}"
+    end
+    
+    desc "Starts the backgroundrb worker processes"
+    task :start, :role => :app do
+      run "cd #{current_path} && #{sudo} nohup ruby script/backgroundrb start -e #{backgroundrb_env}"
+    end
+    
+    desc "Restarts a running backgroundrb server."
+    task :restart, :role => :app do
+      backgroundrb.stop
+      sleep(5)  # sleep for 5 seconds to make sure the server has mopped up everything
+      backgroundrb.start
+    end
+    
+    # ===============================================================
+    # PROCESS CONFIGURATION
+    # ===============================================================  
+    
+    desc "Creates configuration file for the backgroundrb server"
+    task :configure, :role => :app do
+      config = { :backgroundrb => {:ip => backgroundrb_host, :port => backgroundrb_port, :environment => backgroundrb_env} }
+      backgroundrb_yml = config.to_yaml
+      
+      run "if [ ! -d #{shared_path}/config ]; then mkdir #{shared_path}/config; fi"
+      put(backgroundrb_yml, "#{shared_path}/config/backgroundrb.yml", :mode => 0644)
+    end
+    
+    # ===============================================================
+    # FILE MANAGEMENT
+    # ===============================================================  
+    
+    desc "Copies the shared/config/backgroundrb yaml to release/config/"
+    task :copy_config, :role => :app do
+      on_rollback {
+        puts "***** File shared/config/backgroundrb.yml is missing. Make sure you have run backgroundrb:configure first. *****"
+      }
+      
+      run "cp #{shared_path}/config/backgroundrb.yml #{release_path}/config/"
+    end
+    
+    desc "Displays the backgroundrb log from the server"
+    task :tail do
+      stream "tail -f #{shared_path}/log/backgroundrb_#{backgroundrb_port}.log" 
+    end
+    
+    desc "Repair permissions to allow user to perform all actions"
+    task :repair_permissions, :role => :app do
+      puts "Applying correct permissions to allow for proper command execution"
+      sudo "chown -R #{user}:#{user} #{current_path}"
+      sudo "chown -R #{user}:#{user} #{current_path}/tmp"
+    end
+  end
+  
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================  
+  
+  after "deploy:update_code"   , "backgroundrb:copy_config"
+  after "deploy:restart"       , "backgroundrb:restart"
+  after "backgroundrb:restart" , "backgroundrb:repair_permissions"
+end

data/lib/cap_recipes/tasks/juggernaut.rb

@@ -0,0 +1,47 @@
+Capistrano::Configuration.instance(true).load do
+  
+  namespace :juggernaut do            
+    # ===============================================================
+    # PROCESS MANAGEMENT
+    # ===============================================================  
+    
+    desc "Starts the juggernaut push server"
+    task :start, :role => :app do
+      puts "Starting juggernaut push server"
+      sudo "#{sudo} juggernaut -c #{juggernaut_config} -d --pid #{juggernaut_pid} --log #{juggernaut_log}"
+    end
+    
+    desc "Stops the juggernaut push server"
+    task :stop, :role => :app do
+      puts "Stopping juggernaut push server"
+      sudo "#{sudo} juggernaut -c #{juggernaut_config} -k * --pid #{juggernaut_pid} --log #{juggernaut_log}" 
+    end
+    
+    desc "Restarts the juggernaut push server"
+    task :restart, :role => :app do
+      juggernaut.stop
+      juggernaut.start
+    end  
+    
+    # ===============================================================
+    # FILE MANAGEMENT
+    # ===============================================================  
+    
+    desc "Copies the shared/config/juggernaut yaml to release/config/"
+    task :copy_config, :role => :app do
+      sudo "cp #{shared_path}/config/juggernaut.yml #{release_path}/config/"
+    end
+    
+    desc "Displays the juggernaut log from the server"
+    task :tail, :role => :app do
+      stream "tail -f #{shared_path}/log/juggernaut.log" 
+    end
+  end
+  
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================  
+  
+  after "deploy:update_code", "juggernaut:copy_config" # copy juggernaut.yml on update code
+  after "deploy:restart"    , "juggernaut:restart"     # restart juggernaut on app restart
+end

data/lib/cap_recipes/tasks/passenger.rb

@@ -0,0 +1,94 @@
+Capistrano::Configuration.instance(true).load do
+
+  # ===============================================================
+  # DEPLOYMENT SCRIPTS
+  # ===============================================================
+
+  namespace :deploy do
+
+    # ===============================================================
+    # SERVER MANAGEMENT
+    # ===============================================================
+
+    desc "Stops the phusion passenger server"
+    task :stop, :role => :app do
+      puts "Stopping rails web server"
+      apache.stop
+    end
+
+    desc "Starts the phusion passenger server"
+    task :start, :role => :app do
+      puts "Starting rails web server"
+      apache.start
+    end
+
+    desc "Restarts the phusion passenger server"
+    task :restart, :role => :app do
+      puts "Restarting the application"
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+
+    desc "Update code on server, apply migrations, and restart passenger server"
+    task :with_migrations, :role => :app do
+      deploy.update
+      deploy.migrate
+      deploy.restart
+    end
+
+    # ===============================================================
+    # UTILITY TASKS
+    # ===============================================================
+
+    desc "Copies the shared/config/database yaml to release/config/"
+    task :copy_config, :role => :app do
+      puts "Copying database configuration to release path"
+      sudo "cp #{shared_path}/config/database.yml #{release_path}/config/"
+    end
+
+    desc "Repair permissions to allow user to perform all actions"
+    task :repair_permissions, :role => :app do
+      puts "Applying correct permissions to allow for proper command execution"
+      sudo "chmod -R 744 #{current_path}/log #{current_path}/tmp"
+      sudo "chown -R #{user}:#{user} #{current_path}"
+      sudo "chown -R #{user}:#{user} #{current_path}/tmp"
+    end
+
+    desc "Displays the production log from the server locally"
+    task :tail, :role => :app do
+      stream "tail -f #{shared_path}/log/production.log"
+    end
+
+    # ===============================================================
+    # INSTALLATION
+    # ===============================================================
+
+    task :install, :role => :app do
+      puts 'Installing passenger gems'
+      sudo 'gem install fastthread passenger'
+    end
+  end
+
+  # ===============================================================
+  # MAINTENANCE TASKS
+  # ===============================================================
+  namespace :sweep do
+    desc "Clear file-based fragment and action caching"
+    task :log, :role => :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, :role => :app do
+      puts "Sweeping the fragment and action cache stores"
+      run "cd #{release_path} && #{sudo} rake tmp:cache:clear RAILS_ENV=production"
+    end
+  end
+
+  # ===============================================================
+  # TASK CALLBACKS
+  # ===============================================================
+  after "deploy:update_code", "deploy:copy_config" # copy database.yml file to release path
+  after "deploy:update_code", "sweep:cache" # clear cache after updating code
+  after "deploy:restart"    , "deploy:repair_permissions" # fix the permissions to work properly
+end