capistrano-recipes 0.4.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Webficient LLC, Phil Misiowiec
+
+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.rdoc

@@ -0,0 +1,37 @@
+=Capistrano Recipes
+
+Useful Capistrano recipes including:
+
+* Create MySQL database and user on server (via prompts)
+* Create standalone copy of database.yml in shared path (via prompts)
+* Log rotation and tailing commands
+* Restart and profile Phusion Passenger application server
+
+==Installation
+
+Easy as pie...
+
+Ensure you have the Capistrano and Capistrano extensions gems installed:
+
+  sudo gem install capistrano
+  sudo gem install capistrano-ext
+
+Install this gem:
+
+  sudo gem install webficient-capistrano-recipes --source=http://gems.github.com
+
+To setup the initial Capistrano deploy file, go to your Rails app folder via command line and enter:
+
+  capify .
+
+Inside the newly created config/deploy.rb, add:
+
+  require 'capistrano_recipes'
+
+If you're running Phusion Passenger (http://www.modrails.com) be sure you add this line to config/deploy.rb:
+
+  set :server, :passenger
+  
+==Copyright
+
+Copyright (c) 2009 Webficient LLC, Phil Misiowiec. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "capistrano-recipes"
+    gem.summary = %Q{Capistrano recipes}
+    gem.email = "phil@webficient.com"
+    gem.homepage = "http://github.com/webficient/capistrano-recipes"
+    gem.authors = ["Phil Misiowiec"]
+    gem.add_dependency('capistrano', ['>= 2.5.5'])
+    gem.add_dependency('capistrano-ext', ['>= 1.2.1'])
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'capistrano-recipes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

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

data/capistrano-recipes.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano-recipes}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Misiowiec"]
+  s.date = %q{2009-09-29}
+  s.email = %q{phil@webficient.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "capistrano-recipes.gemspec",
+     "lib/capistrano_recipes.rb",
+     "lib/helpers.rb",
+     "lib/recipes/db.rb",
+     "lib/recipes/deploy.rb",
+     "lib/recipes/log.rb",
+     "lib/recipes/passenger.rb",
+     "lib/recipes/symlink.rb"
+  ]
+  s.homepage = %q{http://github.com/webficient/capistrano-recipes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Capistrano recipes}
+
+  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
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.5.5"])
+      s.add_runtime_dependency(%q<capistrano-ext>, [">= 1.2.1"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.5.5"])
+      s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.5.5"])
+    s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
+  end
+end

data/lib/capistrano_recipes.rb

@@ -0,0 +1,10 @@
+require 'capistrano'
+require 'capistrano/cli'
+require 'capistrano/ext/multistage'
+require 'helpers'
+
+@@cap_config = Capistrano::Configuration.respond_to?(:instance) ? 
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+  
+Dir.glob(File.join(File.dirname(__FILE__), '/recipes/*.rb')).each { |f| load f }

data/lib/helpers.rb

@@ -0,0 +1,9 @@
+# =========================================================================
+# These are helper methods that will be available to your recipes.
+# =========================================================================
+
+# Execute a rake task, example:
+#   run_rake log:clear
+def run_rake(task)
+  run "cd #{current_path} && rake #{task} RAILS_ENV=#{stage}"
+end

data/lib/recipes/db.rb

@@ -0,0 +1,60 @@
+require 'erb'
+
+@@cap_config.load do
+    
+  namespace :db do
+    namespace :mysql do
+      desc "Create MySQL database and user for this environment using prompted values"
+      task :setup, :roles => :db, :only => { :primary => true } do
+        prepare_for_db_command
+
+        sql = <<-SQL
+        CREATE DATABASE #{db_name};
+        GRANT ALL PRIVILEGES ON #{db_name}.* TO #{db_user}@localhost IDENTIFIED BY '#{db_pass}';
+        SQL
+
+        run "mysql --user=#{db_admin_user} -p --execute=\"#{sql}\"" do |channel, stream, data|
+          if data =~ /^Enter password:/
+            pass = Capistrano::CLI.password_prompt "Enter database password for '#{db_admin_user}':"
+            channel.send_data "#{pass}\n" 
+          end
+        end
+      end      
+    end
+    
+    desc "Create database.yml in shared path with settings for current stage and test env"
+    task :create_yaml do      
+      set(:db_user) { Capistrano::CLI.ui.ask "Enter #{stage} database username:" }
+      set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{stage} database password:" }
+      
+      db_config = ERB.new <<-EOF
+      base: &base
+        adapter: mysql
+        username: #{db_user}
+        password: #{db_pass}
+
+      #{stage}:
+        database: #{application}_#{stage}
+        <<: *base
+
+      test:
+        database: #{application}_test
+        <<: *base
+      EOF
+
+      put db_config.result, "#{shared_path}/config/database.yml"
+    end
+      
+    desc "Create symlink for database yaml stored in shared path" 
+    task :symlink do
+      run "#{sudo} ln -nfs #{shared_path}/config/database.yml #{current_release}/config/database.yml" 
+    end
+  end
+    
+  def prepare_for_db_command
+    set :db_name, "#{application}_#{stage}"
+    set(:db_admin_user) { Capistrano::CLI.ui.ask "Username with priviledged database access (to create db):" }
+    set(:db_user) { Capistrano::CLI.ui.ask "Enter #{stage} database username:" }
+    set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{stage} database password:" }
+  end
+end

data/lib/recipes/deploy.rb

@@ -0,0 +1,39 @@
+@@cap_config.load do
+  
+  set :shared_children, %w(system log pids config)
+  
+  after "deploy:setup" do
+    db.create_yaml if Capistrano::CLI.ui.agree("Create database.yml in app's shared path?")  
+  end
+  
+  after "deploy:update_code", "db:symlink"
+  
+  namespace :deploy do
+    
+    desc <<-DESC
+      Restarts your application. If you are running Phusion Passenger, you can \
+      explicitly set the server type:
+      
+        set :server, :passenger
+      
+      ...which will touch tmp/restart.txt, a file monitored by Passenger.
+      Otherwise, this command will call the script/process/reaper \
+      script under the current path.
+
+      By default, this will be invoked via sudo as the `app' user. If \
+      you wish to run it as a different user, set the :runner variable to \
+      that user. If you are in an environment where you can't use sudo, set \
+      the :use_sudo variable to false:
+
+        set :use_sudo, false
+    DESC
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      if exists?(:server) && fetch(:server).to_s.downcase == 'passenger'
+        passenger.bounce
+      else
+        try_runner "#{current_path}/script/process/reaper"
+      end
+    end
+    
+  end
+end

data/lib/recipes/log.rb

@@ -0,0 +1,30 @@
+@@cap_config.load do
+  namespace :log do
+    
+    desc "Tail application log file for the specified environment, e.g. cap staging log:tail"
+    task :tail, :roles => :app do
+      run "tail -f #{shared_path}/log/#{stage}.log" do |channel, stream, data|
+        puts "#{channel[:host]}: #{data}"
+        break if stream == :err
+      end
+    end
+    
+    desc <<-DESC
+    Install log rotation script; optional args: days=7, size=5M, group (defaults to same value as :user)
+    DESC
+    task :rotate, :roles => :app do
+      rotate_script = %Q{#{shared_path}/log/#{stage}.log {
+        daily
+        rotate #{ENV['days'] || 7}
+        size #{ENV['size'] || "5M"}
+        compress
+        create 640 #{user} #{ENV['group'] || user}
+        missingok
+      }}
+      put rotate_script, "#{shared_path}/logrotate_script"
+      "#{sudo} cp #{shared_path}/logrotate_script /etc/logrotate.d/#{application}"
+      run "rm #{shared_path}/logrotate_script"
+    end
+
+  end
+end

data/lib/recipes/passenger.rb

@@ -0,0 +1,20 @@
+@@cap_config.load do
+  namespace :passenger do
+    
+    desc "Restart Rails app running under Phusion Passenger by touching restart.txt"
+    task :bounce, :roles => :app do
+      run "#{sudo} touch #{current_path}/tmp/restart.txt"
+    end
+
+    desc "Inspect Phusion Passenger's memory usage. Assumes binaries are located in /opt/ruby-enterprise."
+    task :memory, :roles => :app do
+      run "#{sudo} /opt/ruby-enterprise/bin/passenger-memory-stats"
+    end
+        
+    desc "Inspect Phusion Passenger's internal status. Assumes binaries are located in /opt/ruby-enterprise."
+    task :status, :roles => :app do
+      run "#{sudo} /opt/ruby-enterprise/bin/passenger-status"
+    end
+    
+  end
+end

data/lib/recipes/symlink.rb

@@ -0,0 +1,22 @@
+@@cap_config.load do
+  namespace :symlink do
+    
+    desc <<-DESC
+    Create shared directories
+    DESC
+    task :create_shared_dirs, :roles => :app do
+      symlinks.each { |link| run "mkdir -p #{shared_path}/#{link}" } if symlinks
+    end
+    
+    desc <<-DESC
+    Create links to shared directories from current deployment's public directory
+    DESC
+    task :create_links, :roles => :app do
+      symlinks.each { |link| 
+        run "rm -rf #{release_path}/public/#{link}"
+        run "ln -nfs #{shared_path}/#{link} #{release_path}/public/#{link}" 
+      } if symlinks
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-recipes
+version: !ruby/object:Gem::Version 
+  version: 0.4.0
+platform: ruby
+authors: 
+- Phil Misiowiec
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano-ext
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
+description: 
+email: phil@webficient.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- capistrano-recipes.gemspec
+- lib/capistrano_recipes.rb
+- lib/helpers.rb
+- lib/recipes/db.rb
+- lib/recipes/deploy.rb
+- lib/recipes/log.rb
+- lib/recipes/passenger.rb
+- lib/recipes/symlink.rb
+has_rdoc: true
+homepage: http://github.com/webficient/capistrano-recipes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Capistrano recipes
+test_files: []
+