crossroads_capistrano 1.3.0 → 1.3.2

data/crossroads_capistrano.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "crossroads_capistrano"
-  s.version     = "1.3.0"
+  s.version     = "1.3.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Steve Kenworthy", "Ben Tillman", "Nathan Broadbent"]
   s.email       = ["it_dept@crossroads.org.hk"]

data/lib/crossroads_capistrano.rb

@@ -1,19 +1,27 @@
-# crossroads_recipes for using RVM on a server with capistrano.
-unless Capistrano::Configuration.respond_to?(:instance)
-  abort "rvm/capistrano requires Capistrano >= 2."
-end
+if defined? Capistrano
+  # Crossroads shared capistrano recipes
+  require 'capistrano/ext/multistage'
+  require 'bundler/capistrano' unless $no_bundler rescue LoadError
+  require 'capistrano_colors' rescue LoadError puts "Capistrano Colors is not installed."
+
+  unless Capistrano::Configuration.respond_to?(:instance)
+    abort "rvm/capistrano requires Capistrano >= 2."
+  end
+
+  Capistrano::Configuration.instance(:must_exist).load do
+    set :rails_root, Dir.pwd   # For tasks that need the root directory
 
-Capistrano::Configuration.instance(:must_exist).load do
-  def load_crossroads_recipes(recipes)
-    if recipes == :all
-      # Load all available crossroads_recipes.
-      recipes = Dir.glob(File.join(File.dirname(__FILE__),
-                                   'crossroads_capistrano', 'recipes', '*.rb'))
-      recipes.each{|f| load f}
-    else
-      # Load each specified recipe.
-      recipes.each{|r| load File.join(File.dirname(__FILE__),
-                                      "crossroads_capistrano/recipes/#{r}.rb")}
+    def load_crossroads_recipes(recipes)
+      if recipes == :all
+        # Load all available crossroads_recipes.
+        recipes = Dir.glob(File.join(File.dirname(__FILE__),
+                                     'crossroads_capistrano', 'recipes', '*.rb'))
+        recipes.each{|f| load f}
+      else
+        # Load each specified recipe.
+        recipes.each{|r| load File.join(File.dirname(__FILE__),
+                                        "crossroads_capistrano/recipes/#{r}.rb")}
+      end
     end
   end
 end

data/lib/crossroads_capistrano/recipes/cache.rb

@@ -0,0 +1,22 @@
+namespace :cache do
+  namespace :clear do
+    desc "Clear view cache and memcache but NOT page cache (images/videos). Usually called after a restart."
+    task :all do
+      view
+      memcache
+    end
+    desc "Clear memcache"
+    task :memcache, :only => { :primary => true } do
+      run "cd #{current_path} && RAILS_ENV=production rake cache:clear"
+    end
+    desc "Clear view cache (tmp/cache/) used when memcached is unavailable"
+    task :view do
+      run "cd #{current_path} && rm -rf tmp/cache/views/"
+    end
+    desc "Clear page cache (public/en/) used for images and videos"
+    task :page do
+      run "cd #{current_path} && rm -rf public/en/"
+    end
+  end
+end
+

data/lib/crossroads_capistrano/recipes/delayed_job.rb

@@ -1,17 +1,17 @@
 namespace :delayed_job do
   desc "Stop the delayed_job process"
   task :stop, :roles => :app do
-    run "cd #{current_path}; RAILS_ENV=production script/delayed_job stop"
+    run "cd #{current_path}; RAILS_ENV=production bundle exec ./script/delayed_job stop"
   end
 
   desc "Start the delayed_job process"
   task :start, :roles => :app do
-    run "cd #{current_path}; RAILS_ENV=production script/delayed_job start"
+    run "cd #{current_path}; RAILS_ENV=production bundle exec ./script/delayed_job start"
   end
 
   desc "Restart the delayed_job process"
   task :restart, :roles => :app do
-    run "cd #{current_path}; RAILS_ENV=production script/delayed_job restart"
+    run "cd #{current_path}; RAILS_ENV=production bundle exec ./script/delayed_job restart"
   end
 
   desc "delayed_job status"
@@ -19,3 +19,4 @@ namespace :delayed_job do
     run "ps aux | grep 'delayed_job'"
   end
 end
+

data/lib/crossroads_capistrano/recipes/deploy_permissions.rb

@@ -0,0 +1,34 @@
+# For apps that are deployed with user permissions.
+# ----------------------------------------------------------
+
+# Our developers use different users on their local machines.
+set :user, case sysuser = `echo $USER`.strip
+when 'warp'  then 'bstillman'
+when 'steve' then 'swkenworthy'
+else sysuser
+end
+
+namespace :deploy do
+  desc "Deploy permissions (give user access to everything)"
+  task :user_permissions do
+    sudo "chown -R #{user} #{deploy_to}"
+    $apache_permissions = false
+  end
+  desc "Apache permissions (for passenger)"
+  task :apache_permissions do
+    unless $apache_permissions
+      sudo "chown -R #{httpd_user}:#{httpd_grp} #{current_path}/"
+      sudo "chown -R #{httpd_user}:#{httpd_grp} #{deploy_to}/shared/"
+      $apache_permissions = true
+    end
+  end
+end
+
+# Set user permissions before running each task, and apache permission when tasks finish.
+(ARGV - %w(preview live)).each do |t|
+  before t, "deploy:user_permissions"
+  after  t, "deploy:apache_permissions"
+end
+
+before "deploy:restart", "deploy:apache_permissions"
+

data/lib/crossroads_capistrano/recipes/hoptoad.rb

@@ -0,0 +1,33 @@
+# Faster deploy:notify_hoptoad (without extra rake task)
+# Sends information about the deploy to Hoptoad.
+
+namespace :deploy do
+  desc "Notify Hoptoad of the deployment"
+  task :notify_hoptoad, :except => { :no_release => true } do
+    require 'active_support/core_ext/string' rescue false
+    require 'hoptoad_notifier'
+    require File.join(rails_root,'config','initializers','hoptoad')
+    require 'hoptoad_tasks'
+
+    rails_env = fetch(:hoptoad_env, fetch(:rails_env, "production"))
+    local_user = ENV['USER'] || ENV['USERNAME']
+
+    puts %Q{
+  * \033[0;32m== Notifying Hoptoad of Deploy\033[0m
+      - \033[0;33mUser:\033[0m #{local_user}
+      - \033[0;33mRails Environment:\033[0m #{rails_env}
+      - \033[0;33mRevision:\033[0m #{current_revision}
+      - \033[0;33mRepository:\033[0m #{repository}\n\n}
+
+    HoptoadTasks.deploy(:rails_env      => rails_env,
+                        :scm_revision   => current_revision,
+                        :scm_repository => repository,
+                        :local_username => local_user)
+
+    puts "\n    Hoptoad Notification Complete.\n\n"
+  end
+end
+
+after "deploy",            "deploy:notify_hoptoad"
+after "deploy:migrations", "deploy:notify_hoptoad"
+

data/lib/crossroads_capistrano/recipes/ldap.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), 'prompt')
+
+namespace :ldap do
+  desc "Create the LDAP configuration file"
+  task :config do
+    prompt_with_default("LDAP host", :ldap_host, "ldap.crossroadsint.org")
+    prompt_with_default("LDAP domain", :ldap_domain, "crossroadsint")
+    prompt_with_default("LDAP username", :ldap_bind_username, "ldapuser")
+    prompt_with_default("LDAP password", :ldap_bind_password, "")
+    prompt_with_default("LDAP search base", :ldap_base_dn, "dc=crossroadsint,dc=org")
+    prompt_with_default("LDAP port", :ldap_port, "389")
+    ldap_yml = <<-EOF
+host: #{ldap_host}
+port: #{ldap_port}
+domain: #{ldap_domain}
+base: #{ldap_base_dn}
+username: #{ldap_bind_username}
+password: #{ldap_bind_password}
+    EOF
+
+    put ldap_yml, "/tmp/ldap.yml"
+    sudo "mv /tmp/ldap.yml #{deploy_to}/shared/config/ldap.yml"
+  end
+
+  task :symlink do
+    sudo "ln -sf #{deploy_to}/shared/config/ldap.yml #{release_path}/config/ldap.yml"
+  end
+
+end
+
+before "deploy:cold",        "ldap:config"
+after  "deploy:update_code", "ldap:symlink"
+

data/lib/crossroads_capistrano/recipes/log.rb

@@ -1,12 +1,34 @@
 namespace :log do
-
-  desc "tail production log files"
-  task :tail, :roles => :app do
-    run "tail -f #{shared_path}/log/production.log" do |channel, stream, data|
-      puts  # for an extra line break before the host name
-      puts "#{channel[:host]}: #{data}"
-      break if stream == :err
+  namespace :tail do
+    desc "Tail Rails production log file"
+    task :production, :roles => :app do
+      run "tail -f #{shared_path}/log/production.log" do |channel, stream, data|
+        puts "\n#{channel[:host]}: #{data}"
+        break if stream == :err
+      end
+    end
+    desc "Tail Apache access log file"
+    task :access, :roles => :app do
+      run "tail -f #{shared_path}/log/access_log" do |channel, stream, data|
+        puts "\n#{channel[:host]}: #{data}"
+        break if stream == :err
+      end
     end
   end
 
+  namespace :pull do
+    desc "Pull production log file to /tmp/production.log"
+    task :production, :roles => :app do
+      run "gzip -c #{shared_path}/log/production.log > #{shared_path}/log/production.log.gz"
+      `rm -f /tmp/production.log.gz`
+      puts "Downloading #{shared_path}/log/production.log...\n"
+      download("#{shared_path}/log/production.log.gz", "/tmp/production.log.gz", :via => :scp)  do |channel, name, received, total|
+        print "\r   #{name}: #{(Float(received)/total*100).to_i}% complete..."
+      end
+      run "rm -f #{shared_path}/log/production.log.gz"
+      `gzip -fd /tmp/production.log.gz`
+      puts "File can be accessed at /tmp/production.log"
+    end
+  end
 end
+

data/lib/crossroads_capistrano/recipes/newrelic.rb

@@ -1,5 +1,4 @@
 namespace :newrelic do
-
   task :default do
     newrelic.yml
   end
@@ -8,7 +7,7 @@ namespace :newrelic do
   task :yml do
     run "ln -sf #{deploy_to}/shared/config/newrelic.yml #{release_path}/config/newrelic.yml"
   end
-
 end
 
 before "deploy:symlink", "newrelic:yml"
+

data/lib/crossroads_capistrano/recipes/passenger.rb

@@ -13,25 +13,20 @@
 #
 
 namespace :deploy do
-
   %w(start stop restart reload).each do |t|
     desc "#{t.capitalize} passenger using httpd"
-    task "#{t.to_sym}", :roles => :app, :except => { :no_release => true } do
-      run "/etc/init.d/httpd #{t}"
+    task t, :roles => :app, :except => { :no_release => true } do
+      sudo "/etc/init.d/httpd #{t}"
     end
   end
-
 end
 
 namespace :passenger do
-
   desc "Install Passenger"
   task :install, :roles => :web do
     install_deps
-
     run "if ! (gem list | grep passenger | grep #{passenger_version}); then gem install passenger --no-rdoc --no-ri --version #{passenger_version} && passenger-install-apache2-module --auto; fi"
     run "rvm wrapper #{rvm_ruby_string} passenger" if defined?(:rvm_ruby_string) # sets up wrapper for passenger so it can find bundler etc...
-
   end
 
   task :install_deps, :roles => :web do
@@ -40,14 +35,21 @@ namespace :passenger do
 
   desc "Apache config files: uses special variables @DEPLOY_TO@ @IP_ADDR@ @SERVER_NAME@ @PASSENGER_ROOT@ @RUBY_ROOT@"
   task :config, :roles => :web do
-    run "sed -e 's,@DEPLOY_TO@,#{deploy_to},g' -e 's,@IP_ADDR@,#{ip_address},g' -e 's,@SERVER_NAME@,#{site_domain_name},g' #{release_path}/config/httpd-rails.conf > /etc/httpd/sites-enabled/010-#{application}-#{stage}.conf"
-    passenger_root = capture("pass_path=`gem which phusion_passenger` && echo ${pass_path%/lib/phusion_passenger.rb}")
-    ruby_root =  respond_to?(:rvm_ruby_string) ? "/usr/local/rvm/wrappers/#{rvm_ruby_string}/ruby" : capture("which ruby")
-    sed_args = "-e 's,@PASSENGER_ROOT@,#{passenger_root.strip},g' -e 's,@RUBY_ROOT@,#{ruby_root.strip},g'"
-    run "sed #{sed_args} #{release_path}/config/passenger.conf > /etc/httpd/mods-enabled/passenger.conf"
-  end
+    sudo "bash -c \"sed -e 's,@DEPLOY_TO@,#{deploy_to},g' -e 's,@IP_ADDR@,#{ip_address},g' -e 's,@SERVER_NAME@,#{site_domain_name},g' #{release_path}/config/httpd-rails.conf > /etc/httpd/sites-enabled/010-#{application}-#{stage}.conf\""
+
+    if respond_to?(:rvm_ruby_string)  # Deploying with RVM
+      ruby_root = "/usr/local/rvm/wrappers/#{rvm_ruby_string}/ruby"
+      passenger_root = "/usr/local/rvm/gems/#{rvm_ruby_string}/gems/passenger-#{passenger_version}"
+    else  # System Ruby
+      ruby_root = capture("which ruby")
+      passenger_root = capture("pass_path=`gem which phusion_passenger` && echo ${pass_path%/lib/phusion_passenger.rb}")
+    end
+    sed_args = "-e 's%@PASSENGER_ROOT@%#{passenger_root.strip}%g' -e 's%@RUBY_ROOT@%#{ruby_root.strip}%g'"
 
+    sudo "bash -c \"sed #{sed_args} #{release_path}/config/passenger.conf > /etc/httpd/mods-enabled/passenger.conf\""
+  end
 end
 
 before "deploy:cold",        "passenger:install"
 after  "deploy:update_code", "passenger:config"
+

data/lib/crossroads_capistrano/recipes/postgresql.rb

@@ -1,5 +1,4 @@
 namespace :postgresql do
-
   task :symlink do
     sudo "ln -sf #{deploy_to}/shared/config/database.yml #{release_path}/config/database.yml"
   end
@@ -23,7 +22,29 @@ namespace :postgresql do
   task :reload, :roles => :db do
     send(run_method, "/etc/init.d/postgresql reload")
   end
+end
 
+namespace :db do
+  desc "Download production database to local machine"
+  task :pull do
+    prompt_with_default("Database", :dbname, "#{application}_#{default_stage}")
+    prompt_with_default("Database user", :username, "postgres")
+    prompt_with_default("Local role", :local_role, "postgres")
+    prompt_with_default("Overwrite local db? (y/n)", :overwrite, "y")
+    host = find_servers(:roles => :db).map(&:to_s).first
+    run "pg_dump -U #{username} #{dbname} > /tmp/dump.sql", :hosts => host
+    get "/tmp/dump.sql", "tmp/dump.sql", :via => :scp, :hosts => host do |channel, name, received, total|
+      print "\r#{name}: #{(Float(received)/total*100).to_i}% complete"
+    end
+    run "rm -rf /tmp/dump.sql", :hosts => host
+    `sed -i s/stockit/#{local_role}/g tmp/dump.sql`
+    # Import data.
+    if overwrite.to_s.downcase[0,1] == "y"
+      `psql -d stockit_development < tmp/dump.sql`
+    end
+  end
 end
 
+
 after "deploy:update_code", "postgresql:symlink"
+

data/lib/crossroads_capistrano/recipes/rvm.rb

@@ -1,9 +1,11 @@
+require 'rvm/capistrano'
+
 namespace :rvm do
 
   desc "Install rvm"
   task :install, :roles => :web do
     install_deps
-    run "if ! (which rvm); then curl -s https://rvm.beginrescueend.com/install/rvm | bash; fi", :shell => 'sh'
+    run "if ! (which rvm); then bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-head ); fi", :shell => 'sh'
     run "if ! (rvm list | grep #{rvm_ruby_string}); then rvm install #{rvm_ruby_string}; fi", :shell => 'sh'
   end
 
@@ -14,3 +16,4 @@ namespace :rvm do
 end
 
 before "deploy:cold", "rvm:install"
+

data/lib/crossroads_capistrano/recipes/thinking_sphinx.rb

@@ -0,0 +1,49 @@
+namespace :ts do
+
+  desc "Links the sphinx database files by inserting magic code"
+  task :symlink do
+    run "sed -i 's,@DEPLOY_TO@,#{deploy_to},g' #{release_path}/script/link_sphinx.rb"
+    run "#{release_path}/script/runner -e production #{release_path}/script/link_sphinx.rb"
+  end
+
+  desc "Index data for Sphinx using Thinking Sphinx's settings"
+  task :in do
+    run "cd #{current_path} && RAILS_ENV=production rake ts:in"
+  end
+
+  desc "Stop sphinx"
+  task :stop do
+    run "cd #{current_path} && RAILS_ENV=production rake ts:stop"
+  end
+
+  desc "Start sphinx"
+  task :start do
+    run "cd #{current_path} && RAILS_ENV=production rake ts:start"
+    run "chown apache:apache #{deploy_to}/shared/log/searchd.production.pid"
+  end
+
+  desc "Restart sphinx"
+  task :restart do
+    stop
+    start
+  end
+
+  desc "Stop sphinx, delete index files, reindex, and restart sphinx (last resort)"
+  task :recover do
+    stop
+    run "cd #{deploy_to}/shared/db/sphinx/ && rm -rf production"
+    run "cd #{current_path} && RAILS_ENV=production rake ts:in"
+    start
+  end
+
+  desc """Try to discover if the indexes are corrupted. Checks for index filenames containing 'new'. \
+If they exist then either the files are currently being rotated (after a reindex) or they \
+are stale and need removing with ts:recover. Run this command a few times over a period of \
+a minute to determine if the files disappear - indicating a successfully completed rotation \
+and no need for recovery."""
+  task :recovery_required? do
+    run "if [ x`find #{deploy_to}/shared/db/sphinx/production/ -name \*.new.\* | wc -l` == x\"0\" ]; then echo \"Sphinx indexes look intact. Run ts:in to regenerate.\"; else echo \"Sphinx index files *may* be stale. Wait 1 minute and run this command again. Consider running ts:recover if this message appears again\"; fi"
+  end
+
+end
+

metadata

@@ -1,43 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: crossroads_capistrano
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 1
-  - 3
-  - 0
-  version: 1.3.0
+version: !ruby/object:Gem::Version
+  version: 1.3.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Steve Kenworthy
 - Ben Tillman
 - Nathan Broadbent
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-19 00:00:00 +08:00
+date: 2011-05-19 00:00:00.000000000 +08:00
 default_executable: 
 dependencies: []
-
 description: A Crossroads Foundation collection of generic capistrano recipes.
-email: 
+email:
 - it_dept@crossroads.org.hk
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.textile
 - Rakefile
 - crossroads_capistrano.gemspec
 - lib/crossroads_capistrano.rb
+- lib/crossroads_capistrano/recipes/cache.rb
 - lib/crossroads_capistrano/recipes/delayed_job.rb
+- lib/crossroads_capistrano/recipes/deploy_permissions.rb
+- lib/crossroads_capistrano/recipes/hoptoad.rb
+- lib/crossroads_capistrano/recipes/ldap.rb
 - lib/crossroads_capistrano/recipes/log.rb
 - lib/crossroads_capistrano/recipes/newrelic.rb
 - lib/crossroads_capistrano/recipes/passenger.rb
@@ -46,41 +40,32 @@ files:
 - lib/crossroads_capistrano/recipes/revisions.rb
 - lib/crossroads_capistrano/recipes/rvm.rb
 - lib/crossroads_capistrano/recipes/stack.rb
+- lib/crossroads_capistrano/recipes/thinking_sphinx.rb
 - lib/crossroads_capistrano/recipes/whenever.rb
 - lib/crossroads_capistrano/recipes/yum.rb
 has_rdoc: true
 homepage: http://www.crossroads.org.hk
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: crossroads_capistrano
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Crossroads capistrano recipes
 test_files: []
-