cap-recipes 0.3.18

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg*
+.svn

data/LICENSE

@@ -0,0 +1,20 @@
+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/README.textile

@@ -0,0 +1,357 @@
+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.
+Feel free to contribute to this collection and make it even better! 
+
+The overall vision for this project being to collect a number of classic, generic recipes which can
+be used by the community.
+
+Currently included:
+
+ * Apache Server
+ * Rubygems Package Management
+ * Phusion Passenger (Setup and Deployment)
+ * Memcache Process (Setup and Deployment)
+ * Juggernaut Daemon
+ * Backgroundrb Server
+ * DelayedJob Worker
+ * Whenever Cron Scheduling
+ * Aptitude Package Management 
+
+h2. INSTALLATION
+
+   sudo gem install nesquena-cap-recipes -s http://gems.github.com/
+
+Include into your deploy.rb configuration file for Capistrano:
+
+<pre>
+<code>
+  # use the complete deployment process (NOT RECOMMENDED)
+  require 'cap_recipes'
+
+  # RECOMMENDED
+  # require necessary recipes according to your needs
+  # (use hooks which tie all the recipes into the deployment process,
+  # 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
+  # only use managing tasks:
+  require 'cap_recipes/tasks/memcache/manage'
+
+  # OR
+  #only use install tasks:
+  require 'cap_recipes/tasks/memcache/install'
+</code>
+</pre>
+
+h2. USAGE
+
+h3. Apache
+
+These recipes manage the apache web server
+
+h4. Configuration
+
+  * apache_init_path - the path to the init.d apache file [default: '/etc/init.d/apache2']
+
+h4. Tasks
+
+h5. manage.rb
+
+  apache
+    :stop
+    :start
+    :restart
+    
+h5. install.rb
+
+  apache
+    :install
+  
+h3. Rubygems
+
+h4. Configuration
+
+  * rubygem_paths - a path or array of paths to your gem binaries [default '/usr/bin/gem' ]
+
+h4. Tasks
+
+h5. manage.rb
+
+  rubygems
+    :full_update
+    :upgrade
+    :update
+    :cleanup
+    :install
+    :uninstall
+
+h3. Passenger
+
+These recipes manage the passenger module for apache
+
+h4. Configuration
+
+ * base_ruby_path - the base path to the ruby installation [default: '/usr']
+ * local_ping_path - the localhost path to ping to start passenger [default: "http://localhost"]
+
+The following files and folders are expected to exist:
+ * "#{base_ruby_path}/lib/ruby"
+ * "#{base_ruby_path}/bin/ruby"
+ * "#{base_ruby_path}/bin/gem"
+
+h4. Tasks
+
+h5. manage.rb
+
+  deploy
+    :start
+    :stop
+    :restart
+    :with_migrations
+      
+h5. install.rb
+
+ passenger
+   :install
+
+h3. Aptitude
+
+h4. Tasks
+
+h5. manage.rb
+
+  aptitude
+    :install
+    :remove
+    :updates
+
+h3. Rails
+
+These recipes support rails-specific functionality
+
+h4. Tasks
+
+h5. manage.rb
+
+  rails
+    :symlink_db_config
+    :repair_permissions
+    :tail - tail production log
+    :ping - ping the server to start it
+    sweep
+      :cache
+      :log
+      
+h5. hooks.rb
+
+  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
+
+h3. DelayedJob
+
+These recipes are for tobi's delayed_job plugin for background job queue processing
+
+h4. Configuration
+
+  * delayed_script_path - the path to the delayed job script [default: 'script/delayed_job']
+  * delayed_job_env - the rails environment [default: 'production']
+
+h4. Tasks
+
+h5. manage.rb
+
+  delayed_job
+    :stop
+    :start
+    :restart
+
+h5. hooks.rb
+
+  after "deploy:start",   "delayed_job:start"
+  after "deploy:stop",    "delayed_job:stop"
+  after "deploy:restart", "delayed_job:restart"
+
+h3. Backgroundrb
+
+These recipes are for backgroundrb job queue processing
+
+h4. Configuration
+
+  * backgroundrb_log - the path to the backgroundrb log file
+  * backgroundrb_host - the background host machine ip [default: 'localhost']
+  * backgroundrb_env - the rails environment [default: 'production']
+
+h4. Tasks
+
+h5. manage.rb
+
+  backgroundrb
+    :stop
+    :start
+    :restart
+    :symlink_config
+    :tail
+      
+h5. hooks.rb
+
+  after "deploy:update_code"   , "backgroundrb:symlink_config" # copy backgroundrb config to release
+  after "deploy:restart"       , "backgroundrb:restart"     # restart backgroundrb daemon
+  after "backgroundrb:restart" , "backgroundrb:repair_permissions" # restart backgroundrb damon
+
+h3. Juggernaut
+
+These recipes are for managing the juggernaut push server
+
+h4. Configuration
+
+  * juggernaut_config - path to juggernaut config file [default: "#{current_path}/config/juggernaut.yml"]
+  * juggernaut_pid - path to juggernaut pid file [default: "#{current_path}/tmp/pids/juggernaut.pid"]
+  * juggernaut_log - path to juggernaut log file [default: "#{current_path}/log/juggernaut.log"]
+
+h4. Tasks
+
+h5. manage.rb
+
+  juggernaut
+    :start
+    :stop
+    :restart
+    :symlink_config
+    :tail
+
+h5. hooks.rb
+
+  after "deploy:update_code", "juggernaut:symlink_config" # copy juggernaut.yml to release
+  after "deploy:restart"    , "juggernaut:restart"     # restart juggernaut daemon
+
+h3. Memcache
+
+These recipes are for managing the memcached caching mechanism
+
+h4. Configuration
+
+  * memcache_init_path - path to memcache config file [default: "/etc/init.d/memcache"]
+  * memcache_size - the total size of memory to use [default: 64]
+  * memcache_port - the port to start memcache [default: '11211']
+  * memcache_host - the host for memcache [default: '127.0.0.1']
+  * memcache_user - the user to run memcache [default: 'nobody']
+
+h4. Tasks
+
+h5. manage.rb
+
+  memcache
+    :start
+    :stop
+    :restart
+    
+h5. install.rb
+
+  memcache
+    :install
+    
+h5. hooks
+
+  after "deploy:restart", "memcache:restart" # clear cache after updating code
+
+h3. Whenever
+
+These recipes are for managing whenever cron job scheduling
+
+h4. Configuration
+
+  * None necessary yet
+  
+h4. Tasks
+
+h5. manage.rb
+
+  whenever
+    :update_crontab
+
+h5. hooks
+
+  after "deploy:symlink", "whenever:update_crontab"
+  
+h2. EXAMPLE
+
+Here is a sample deploy.rb file using cap_recipes:
+
+<pre>
+<code>
+# =============================================================================
+# GENERAL SETTINGS
+# =============================================================================
+
+set :application,  "app_name"
+set :deploy_to,  "/var/apps/#{application}"
+set :scm, :git
+set :repository, "git@repos.site.com:/home/git/repos.git"
+
+# =============================================================================
+# CAP RECIPES
+# =============================================================================
+
+# Note this happens after the general settings have been defined
+require 'rubygems'
+
+# PASSENGER
+require 'cap_recipes/tasks/passenger'
+set :base_ruby_path, '/opt/ruby-enterprise' # defaults to "/usr"
+set :apache_init_path, '/etc/init.d/apache2' # defaults to "/etc/init.d/apache2"
+
+# BACKGROUNDRB
+require 'cap_recipes/tasks/backgroundrb'
+set :backgroundrb_log, "/var/log/backgroundrb.log" # defaults to "#{release_path}/log/backgroundrb.log"
+set :backgroundrb_host, "worker.site.com" # defaults to localhost
+set :backgroundrb_env, "staging" # defaults to production
+
+# DELAYED_JOB
+require 'cap_recipes/tasks/delayed_job'
+set :delayed_script_path, 'script/djworker' # defaults to 'script/delayed_job'
+set :delayed_job_env, 'staging' # defaults to production
+
+# JUGGERNAUT
+require 'cap_recipes/tasks/juggernaut'
+set :juggernaut_config, "/some/path/juggernaut.yml" # defaults to "#{current_path}/config/juggernaut.yml"
+set :juggernaut_pid, "/some/path/juggernaut.pid" # defaults to "#{current_path}/tmp/pids/juggernaut.pid"
+set :juggernaut_log, "/var/log/juggernaut.log" # defaults to #{release_path}/log/juggernaut.log
+
+# MEMCACHE
+require 'cap_recipes/tasks/memcache'
+set :memcache_init_path, "/etc/init.d/memcache" # defaults to "/etc/init.d/memcache"
+</code>
+</pre>
+
+h2. 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,45 @@
+# rake version:bump:patch && rake release && rake build && rake install && sudo gem cleanup
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "cap-recipes"
+    s.summary = %Q{Battle-tested capistrano recipes for passenger, delayed_job, and more}
+    s.email = "nesquena@gmail.com"
+    s.homepage = "http://github.com/nesquena/cap-recipes"
+    s.description = "Battle-tested capistrano recipes for debian, passenger, apache, delayed_job, juggernaut, rubygems, backgroundrb, rails and more"
+    s.authors = ["Nathan Esquenazi"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'cap-recipes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+end
+
+desc "Run all specs in spec directory"
+task :spec do |t|
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+task :default => :spec

data/VERSION.yml

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

data/cap-recipes.gemspec

@@ -0,0 +1,87 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cap-recipes}
+  s.version = "0.3.18"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Esquenazi"]
+  s.date = %q{2009-06-15}
+  s.description = %q{Battle-tested capistrano recipes for debian, passenger, apache, delayed_job, juggernaut, rubygems, backgroundrb, rails and more}
+  s.email = %q{nesquena@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://github.com/nesquena/cap-recipes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Battle-tested capistrano recipes for passenger, delayed_job, and more}
+  s.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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end