railsmachine-railsmachine 1.0.3

data/lib/railsmachine/generators/railsmachine/templates/deploy.rb

@@ -0,0 +1,108 @@
+require 'railsmachine/recipes'
+
+# This defines a deployment "recipe" that you can feed to capistrano
+# (http://manuals.rubyonrails.com/read/book/17). It allows you to automate
+# (among other things) the deployment of your application.
+
+# =============================================================================
+# REQUIRED VARIABLES
+# =============================================================================
+# You must always specify the application and repository for every recipe. The
+# repository must be the URL of the repository you want this recipe to
+# correspond to. The deploy_to path must be the path on each machine that will
+# form the root of the application path.
+
+# The name of your application. Used for directory and file names associated with
+# the application.
+set :application, "<%= singular_name %>"
+
+# Target directory for the application on the web and app servers.
+set :deploy_to, "/var/www/apps/#{application}"
+
+# Primary domain name of your application. Used as a default for all server roles.
+set :domain, "<%= domain_name %>"
+
+# Login user for ssh.
+set :user, "deploy"
+set :runner, user
+set :admin_runner, user
+
+# Rails environment. Used by application setup tasks and migrate tasks.
+set :rails_env, "production"
+
+# Automatically symlink these directories from curent/public to shared/public.
+# set :app_symlinks, %w{photo document asset}
+
+# =============================================================================
+# ROLES
+# =============================================================================
+# You can define any number of roles, each of which contains any number of
+# machines. Roles might include such things as :web, or :app, or :db, defining
+# what the purpose of each machine is. You can also specify options that can
+# be used to single out a specific subset of boxes in a particular role, like
+# :primary => true.
+
+# Modify these values to execute tasks on a different server.
+role :web, domain
+role :app, domain
+role :db,  domain, :primary => true
+role :scm, domain
+
+
+# =============================================================================
+# APPLICATION SERVER OPTIONS
+# ============================================================================= 
+# set :app_server, "passenger"  # mongrel or passenger
+
+# =============================================================================
+# WEB SERVER OPTIONS
+# =============================================================================
+# set :httpd, "apache"   # apache 
+# set :apache_server_name, domain
+# set :apache_server_aliases, %w{alias1 alias2}
+# set :apache_default_vhost, true # force use of  apache_default_vhost_config
+# set :apache_default_vhost_conf, "/etc/httpd/conf/default.conf"
+# set :apache_conf, "/etc/httpd/conf/apps/#{application}.conf"
+# set :apache_proxy_port, 8000
+# set :apache_proxy_servers, 2
+# set :apache_proxy_address, "127.0.0.1"
+# set :apache_ssl_enabled, false
+# set :apache_ssl_ip, "127.0.0.1"
+# set :apache_ssl_forward_all, false
+# set :apache_ctl, "/etc/init.d/httpd"
+
+
+
+# =============================================================================
+# MONGREL OPTIONS
+# =============================================================================
+# set :mongrel_servers,  apache_proxy_servers
+# set :mongrel_port,  apache_proxy_port
+# set :mongrel_address,  apache_proxy_address
+# set :mongrel_environment, "production"
+# set :mongrel_pid_file, "/var/run/mongrel_cluster/#{application}.pid"
+# set :mongrel_conf, "/etc/mongrel_cluster/#{application}.conf"
+# set :mongrel_user, user
+# set :mongrel_group, group
+
+# =============================================================================
+# DATABASE OPTIONS
+# =============================================================================
+# set :database, "mysql"   # mysql or postgresql
+
+# =============================================================================
+# SCM OPTIONS
+# =============================================================================
+# set :scm, :subversion    # :subversion or :git
+
+# =============================================================================
+# SSH OPTIONS
+# =============================================================================
+# ssh_options[:keys] = %w(/path/to/my/key /path/to/another/key)
+# ssh_options[:port] = 25
+
+# =============================================================================
+# CAPISTRANO OPTIONS
+# =============================================================================
+# default_run_options[:pty] = true
+# set :keep_releases, 3

data/lib/railsmachine/recipes/app/deploy.rb

@@ -0,0 +1,28 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  load    'config/deploy'
+  namespace :deploy do
+  
+    desc <<-DESC
+    #{app_server.to_s == 'mongrel' ? "Start the mongrel processes on the app server." : "This task no effect when using Passenger as your application server."}
+    DESC
+    task :start, :roles => :app do
+      application_servlet.start
+    end
+
+    desc <<-DESC
+    Restart the #{app_server} processes on the app server.
+    DESC
+    task :restart, :roles => :app do
+      application_servlet.restart
+    end
+
+    desc <<-DESC
+    #{app_server.to_s == 'mongrel' ? "Stop the mongrel processes on the app server." : "This task no effect when using Passenger as your application server."} 
+    DESC
+    task :stop, :roles => :app do
+      application_servlet.stop
+    end
+
+  end
+
+end

data/lib/railsmachine/recipes/app/mongrel.rb

@@ -0,0 +1,120 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set :mongrel_servers, 2
+  set :mongrel_port, 8000
+  set :mongrel_address, "127.0.0.1"
+  set :mongrel_environment, "production"
+  set :mongrel_conf, nil
+  set :mongrel_user, nil
+  set :mongrel_group, nil
+  set :mongrel_prefix, nil
+  set :mongrel_rails, 'mongrel_rails'
+  set :mongrel_clean, false
+  set :mongrel_pid_file, nil
+  set :mongrel_log_file, nil
+  set :mongrel_config_script, nil
+ 
+  load    'config/deploy'
+ 
+  namespace :mongrel do
+  
+    namespace :cluster do
+    
+      desc <<-DESC
+      Configure Mongrel processes on the app server. This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :configure, :roles => :app do
+        set_mongrel_conf
+        set_mongrel_pid_file
+            
+        argv = []
+        argv << "#{mongrel_rails} cluster::configure"
+        argv << "-N #{mongrel_servers.to_s}"
+        argv << "-p #{mongrel_port.to_s}"
+        argv << "-e #{mongrel_environment}"
+        argv << "-a #{mongrel_address}"
+        argv << "-c #{current_path}"
+        argv << "-C #{mongrel_conf}"
+        argv << "-P #{mongrel_pid_file}"
+        argv << "-l #{mongrel_log_file}" if mongrel_log_file
+        argv << "--user #{mongrel_user}" if mongrel_user
+        argv << "--group #{mongrel_group}" if mongrel_group
+        argv << "--prefix #{mongrel_prefix}" if mongrel_prefix
+        argv << "-S #{mongrel_config_script}" if mongrel_config_script
+        cmd = argv.join " "
+        send(run_method, cmd)
+      end
+      
+      desc <<-DESC
+      Start Mongrel processes on the app server.  This uses the :use_sudo variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :start, :roles => :app do
+        set_mongrel_conf
+        cmd = "#{mongrel_rails} cluster::start -C #{mongrel_conf}"
+        cmd += " --clean" if mongrel_clean    
+        send(run_method, cmd)
+      end
+      
+      desc <<-DESC
+      Restart the Mongrel processes on the app server by starting and stopping the cluster. This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is set to true.
+      DESC
+      task :restart, :roles => :app do
+        set_mongrel_conf
+        cmd = "#{mongrel_rails} cluster::restart -C #{mongrel_conf}"
+        cmd += " --clean" if mongrel_clean    
+        send(run_method, cmd)
+      end
+      
+      desc <<-DESC
+      Stop the Mongrel processes on the app server.  This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :stop, :roles => :app do
+        set_mongrel_conf
+        cmd = "#{mongrel_rails} cluster::stop -C #{mongrel_conf}"
+        cmd += " --clean" if mongrel_clean    
+        send(run_method, cmd)
+      end
+
+      desc <<-DESC
+      Check the status of the Mongrel processes on the app server.  This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :status, :roles => :app do
+        set_mongrel_conf
+        send(run_method, "#{mongrel_rails} cluster::status -C #{mongrel_conf}")
+      end
+      
+      desc <<-DESC
+      Remove the mongrel cluster configuration from the app server.
+      DESC
+      task :remove, :roles => :app do 
+        set_mongrel_conf
+        alt_mongrel_conf = mongrel_conf.gsub('.conf','.yml')
+        run("[ -f #{mongrel_conf} ] || [ -f #{alt_mongrel_conf} ] && echo \"yes\" || echo \"no\"") do |c, s, o|
+          if o =~ /yes?/
+            exit if Capistrano::CLI.ui.ask("WARNING: You are about to remove your mongrel cluster configuration. Are you sure you want to proceed? [y/N]").upcase != "Y"
+            mongrel.cluster.stop
+            sudo("rm -f #{mongrel_conf}")
+            sudo("rm -f #{alt_mongrel_conf}")
+          end
+        end
+      end
+  
+    end
+    
+  end
+  
+  def set_mongrel_conf
+    set :mongrel_conf, "/etc/mongrel_cluster/#{application}.conf" unless mongrel_conf
+  end
+
+  def set_mongrel_pid_file
+    set :mongrel_pid_file, "/var/run/mongrel_cluster/#{application}.pid" unless mongrel_pid_file
+  end
+end

data/lib/railsmachine/recipes/app/passenger.rb

@@ -0,0 +1,20 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set :use_mod_rewrite, false
+  load    'config/deploy'
+  namespace :passenger do
+
+    [:start, :stop].each do |t|
+      task t, :roles => :app do
+        puts "The :#{t} task no effect when using Passenger as your application server."
+      end
+    end
+
+    desc <<-DESC
+    Restart the Passenger processes on the app server by touching tmp/restart.txt.
+    DESC
+    task :restart, :roles => :app do
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+
+  end
+end

data/lib/railsmachine/recipes/db/mysql.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+require 'capistrano'
+require 'capistrano/cli'
+
+module MySQLMethods
+  
+  def execute(sql, user)
+    run "mysql --user=#{user} -p --execute=\"#{sql}\"" do |channel, stream, data|
+      handle_mysql_password(user, channel, stream, data)
+    end
+  end
+  
+  private
+  def handle_mysql_password(user, channel, stream, data)
+    logger.info data, "[database on #{channel[:host]} asked for password]"
+    if data =~ /^Enter password:/
+      pass = Capistrano::CLI.password_prompt "Enter database password for '#{user}':"
+      channel.send_data "#{pass}\n" 
+    end
+  end
+end
+
+Capistrano.plugin :mysql_helper, MySQLMethods
+
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  set :mysql_admin, nil
+  
+  namespace :db do
+  
+    desc "Execute MySQL statements using --execute option. Set the 'sql' variable."
+    task :execute, :roles => :db, :only => { :primary => true } do
+      set_mysql_admin
+      mysql_helper.execute sql, mysql_admin
+    end
+    
+    desc "Create MySQL database and user based on config/database.yml"
+    task :setup, :roles => :db, :only => { :primary => true } do
+      # on_rollback {}
+      
+      set_mysql_admin
+      read_config
+      
+      sql = "CREATE DATABASE #{db_name};"
+      sql += "GRANT ALL PRIVILEGES ON #{db_name}.* TO #{db_user}@localhost IDENTIFIED BY '#{db_password}';"  
+      mysql_helper.execute sql, mysql_admin
+    end
+  
+  end
+  
+  def read_config
+    db_config = YAML.load_file('config/database.yml')
+    set :db_user, db_config[rails_env]["username"]
+    set :db_password, db_config[rails_env]["password"] 
+    set :db_name, db_config[rails_env]["database"]
+  end
+  
+  def set_mysql_admin
+    set :mysql_admin, user unless mysql_admin
+  end
+  
+end

data/lib/railsmachine/recipes/db/postgresql.rb

@@ -0,0 +1,62 @@
+# CentOS install for Rails Machine
+# sudo su -
+# yum install postgresql-client postgresql-server postgresql-devel
+# chkconfig postgresql on
+# service postgresql start
+# gem install postgres
+# su - postgres
+# createuser deploy -a -d 
+# exit
+
+require 'yaml'
+require 'capistrano'
+require 'capistrano/cli'
+
+module PostgreSQLMethods
+  
+  def createdb(db, user)
+    run "createdb -O #{user} #{db}"  
+  end
+  
+  def createuser(user, password)
+    cmd = "createuser -P -D -A -E #{user}"
+    run cmd do |channel, stream, data|
+      if data =~ /^Enter password for new user:/
+        channel.send_data "#{password}\n" 
+      end
+      if data =~ /^Enter it again:/
+        channel.send_data "#{password}\n" 
+      end
+    end
+  end
+  
+  def command(sql, database)
+    run "psql --command=\"#{sql}\" #{database}" 
+  end
+   
+end
+
+Capistrano.plugin :pgsql, PostgreSQLMethods
+
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :db do
+  
+    desc "Create PosgreSQL database and user based on config/database.yml"
+    task :setup, :roles => :db, :only => { :primary => true } do
+      # on_rollback {} TODO
+      read_config
+      pgsql.createuser db_user, db_password
+      pgsql.createdb db_name, db_user
+    end
+  
+  end
+  
+  def read_config
+    db_config = YAML.load_file('config/database.yml')
+    set :db_user, db_config[rails_env]["username"]
+    set :db_password, db_config[rails_env]["password"] 
+    set :db_name, db_config[rails_env]["database"]
+  end
+  
+end

data/lib/railsmachine/recipes/db/sqlite3.rb

@@ -0,0 +1,14 @@
+require 'capistrano'
+require 'capistrano/cli'
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  namespace :db do
+
+    desc "Do nothing when using sqlite3."
+    task :setup, :roles => :db, :only => { :primary => true } do
+    end
+
+  end
+
+end

data/lib/railsmachine/recipes/scm/git.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+Capistrano::Configuration.instance(:must_exist).load do
+ 
+  namespace :localrepo do
+     
+    desc "Setup directory structure and initialize git repository on remote server"
+    task :setup, :roles => :scm do
+      dir =  "#{deploy_to}/repos/#{application}.git"
+      run   "mkdir -p #{dir}"
+      sudo  "chown -R #{user}:#{user} #{dir}"
+      run   "cd #{dir} && git --bare init"
+      run   "chmod 770 #{dir}"
+    end
+
+    desc "Import code into remote git repository."
+    task :import  do
+      puts    "Initializing local git repository"
+      system  "git init"
+
+      puts    "Adding remote server pointing to #{repository}"
+      system  "git remote add origin #{repository}"
+
+      puts "Adding .gitignore file"
+      system "echo 'log/*'>> .gitignore"
+      system "echo 'tmp/*'>> .gitignore"
+      system "echo '.DS_Store'>> .gitignore"
+      system "echo 'public/cache/**/*'>> .gitignore"
+      system "git add .gitignore"
+
+      puts "Committing application locally"
+      system "git add *"
+      system 'git commit -a -v -m "initial import of site"'
+
+      puts "Pushing application to the remote server.  The name of the branch is:"
+      system  "git remote"
+      system  "git push origin master"
+    
+      puts "git setup complete"
+      puts "You can clone this repository with git clone #{repository} #{application}"
+    end
+ 
+  end
+ 
+end

data/lib/railsmachine/recipes/scm/subversion.rb

@@ -0,0 +1,47 @@
+require 'fileutils'
+Capistrano::Configuration.instance(:must_exist).load do
+ 
+  namespace :localrepo do
+
+    desc "Setup svn repository"
+    task :setup, :roles => :scm do
+     dir = "#{deploy_to}/repos"
+     run "mkdir -p #{dir}"
+     sudo  "chown -R #{user}:#{user} #{dir}"
+     run "chmod 770 #{dir}"
+     run "svnadmin create #{dir}"
+    end
+
+    desc "Import code into svn repository."
+    task :import  do
+      new_path = Dir.pwd + "_machine"
+      tags = repository.sub("trunk", "tags")
+      branches = repository.sub("trunk", "branches")
+      puts "Adding branches and tags"
+      system "svn mkdir -m 'Adding tags and branches directories' #{tags} #{branches}"
+      puts "Importing application."
+      system "svn import #{repository} -m 'Import'"
+      puts "Checking out to new directory."
+      system "svn co #{repository} #{new_path}"
+      cwd = Dir.getwd
+      Dir.chdir new_path
+      puts "removing log directory contents from svn"
+      system "svn remove log/*"
+      puts "ignoring log directory"
+      system "svn propset svn:ignore '*.log' log/"
+      system "svn update log/"
+      puts "removing tmp directory from svn"
+      system "svn remove tmp/"
+      puts "ignoring tmp directory"
+      system "svn propset svn:ignore '*' tmp/"
+      system "svn update tmp/"
+      puts "committing changes"
+      system "svn commit -m 'Removed and ignored log files and tmp'"
+      Dir.chdir cwd
+      puts "Your repository is: #{repository}" 
+      puts "Please change to your new working directory: #{new_path}"
+    end
+
+  end
+ 
+end

data/lib/railsmachine/recipes/web/apache.rb

@@ -0,0 +1,87 @@
+require 'erb'
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  
+  set :apache_server_name, nil            
+  set :apache_conf, nil
+  set :apache_default_vhost, false
+  set :apache_default_vhost_conf, nil
+  set :apache_ctl, "/etc/init.d/httpd"
+  set :apache_server_aliases, []
+  set :apache_proxy_port, 8000
+  set :apache_proxy_servers, 2
+  set :apache_proxy_address, "127.0.0.1"
+  set :apache_ssl_enabled, false
+  set :apache_ssl_ip, nil
+  set :apache_ssl_forward_all, false
+  
+  load    'config/deploy'
+  
+  namespace :apache do
+  
+    desc "Configure Apache. This uses the :use_sudo
+    variable to determine whether to use sudo or not. By default, :use_sudo is
+    set to true."
+    task :configure, :roles => :web do      
+      set_apache_conf
+      
+      run("[ -f #{ apache_conf} ] && echo \"yes\" || echo \"no\"") do |c, s, o|
+        if o =~ /yes?/
+          backup = "#{ apache_conf}.old.#{Time.now.strftime('%Y%m%d%H%M%S')}"
+          send(run_method, "cp #{ apache_conf} #{backup}")
+          exit if Capistrano::CLI.ui.ask("WARNING: You are about to change your existing Apache configuration. A backup has been created at #{backup}. Are you sure you want to proceed? [y/N]").upcase != "Y"
+        end
+      end
+      
+      server_aliases = []
+      server_aliases << "www.#{ apache_server_name}"
+      server_aliases.concat  apache_server_aliases
+      set :apache_server_aliases_array, server_aliases
+      
+      file = File.join(File.dirname(__FILE__), "templates", app_server.to_s, "httpd.conf")
+      template = File.read(file)
+      buffer = ERB.new(template).result(binding)
+      
+      if  apache_ssl_enabled
+        file = File.join(File.dirname(__FILE__), "templates", app_server.to_s, "httpd-ssl.conf")
+        template = File.read(file)
+        ssl_buffer = ERB.new(template).result(binding)
+        buffer += ssl_buffer
+      end
+      
+      put buffer, "#{shared_path}/httpd.conf", :mode => 0444
+      send(run_method, "cp #{shared_path}/httpd.conf #{ apache_conf}")
+      send(run_method, "rm -f #{shared_path}/httpd.conf")
+    end
+    
+    desc "Start Apache "
+    task :start, :roles => :web do
+      send(run_method, "#{ apache_ctl} start")
+    end
+    
+    desc "Restart Apache "
+    task :restart, :roles => :web do
+      send(run_method, "#{ apache_ctl} restart")
+    end
+    
+    desc "Stop Apache "
+    task :stop, :roles => :web do
+      send(run_method, "#{ apache_ctl} stop")
+    end
+    
+    desc "Reload Apache "
+    task :reload, :roles => :web do
+      send(run_method, "#{ apache_ctl} reload")
+    end
+  
+  end
+  
+  def set_apache_conf
+    if  apache_default_vhost
+      set :apache_conf, "/etc/httpd/conf/default.conf" unless  apache_default_vhost_conf
+    else 
+      set :apache_conf, "/etc/httpd/conf/apps/#{application}.conf" unless  apache_conf
+    end
+  end
+  
+end

data/lib/railsmachine/recipes/web/templates/mongrel/httpd-ssl.conf

@@ -0,0 +1,80 @@
+<VirtualHost <%=  apache_ssl_ip %>:443>
+
+ServerName <%=  apache_server_name %>
+<%  apache_server_aliases_array.each do |a| %>
+ServerAlias <%= "#{a}" %>
+<% end %>
+
+<IfModule passenger_module>
+  RailsAutoDetect off
+</IfModule>
+
+DocumentRoot <%= "#{current_path}/public" %>
+
+<Directory <%= "#{current_path}/public" %>>
+  Options FollowSymLinks
+  AllowOverride None
+  Order allow,deny
+  Allow from all
+</Directory>
+
+# Configure mongrel_cluster 
+<Proxy balancer://<%= "#{application}_cluster" %>>
+  <% start_port =  apache_proxy_port %>
+  <% end_port =  apache_proxy_port +  apache_proxy_servers - 1 %>
+  <% start_port.upto(end_port) do |port| %>
+  BalancerMember http://<%= "#{ apache_proxy_address}:#{port.to_s}" %>
+  <% end %>
+</Proxy>
+
+RewriteEngine On
+
+# Prevent access to .svn directories
+RewriteRule ^(.*/)?\.svn/ - [F,L]
+ErrorDocument 403 "Access Forbidden"
+
+# Check for maintenance file and redirect all requests
+RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
+RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+RewriteRule ^.*$ /system/maintenance.html [L]
+
+# Rewrite index to check for static
+RewriteRule ^/$ /index.html [QSA] 
+
+# Rewrite to check for Rails cached page
+RewriteRule ^([^.]+)$ $1.html [QSA]
+
+# Redirect all non-static requests to cluster
+RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+# Add header for Mongrel to set HTTPS environment for Rails
+RequestHeader set X-Forwarded-Proto "https"
+RewriteRule ^/(.*)$ balancer://<%= "#{application}_cluster" %>%{REQUEST_URI} [P,QSA,L]
+
+# Deflate
+AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css application/x-javascript
+BrowserMatch ^Mozilla/4 gzip-only-text/html
+BrowserMatch ^Mozilla/4\.0[678] no-gzip
+BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
+
+# SSL Engine Switch
+SSLEngine on
+
+# SSL Cipher Suite:
+SSLProtocol -all +SSLv3
+SSLCipherSuite SSLv3:+HIGH:+MEDIUM
+
+# Server Certificate
+SSLCertificateFile /etc/httpd/conf/ssl.crt/<%= domain %>.crt
+
+# Server Private Key
+SSLCertificateKeyFile /etc/httpd/conf/ssl.key/<%= domain %>.key
+
+BrowserMatch ".*MSIE.*" \
+         nokeepalive ssl-unclean-shutdown \
+         downgrade-1.0 force-response-1.0
+
+ErrorLog logs/<%= domain %>-error_log
+CustomLog logs/<%= domain %>-access_log combined         
+CustomLog logs/<%= domain %>-ssl_log \
+          "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
+</VirtualHost>