kompanee-recipes 0.0.10 → 0.1.0

data/lib/kompanee-recipes/git.rb

@@ -0,0 +1,40 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  run_task 'git:install', :as => "manager"
+
+  namespace :deploy do
+    desc <<-DESC
+      Tags the deployed Git commit with the timestamp and environment it was deployed to.
+
+      The tag is auto-pushed to whatever `remote` is set to as well as `origin`.
+      Tag push happens in the background so it won't slow down deployment.
+    DESC
+    task :tag do
+      timestamp_string_without_seconds = Time.now.strftime("%Y%m%d%H%M")
+      tag_name = "deployed_to_#{rails_env}_#{timestamp_string_without_seconds}"
+
+      `git tag -a -m "Tagging deploy to #{rails_env} at #{timestamp_string_without_seconds}" #{tag_name} #{branch}`
+      `git push #{remote} --tags > /dev/null 2>&1 &`
+      `git push origin --tags > /dev/null 2>&1 &`
+    end
+  end
+
+  namespace :git do
+    desc "[internal] Installs Git on Ubuntu systems using apt-get."
+    task :install_on_ubuntu do
+      set :dependencies, %w{git-core git-svn}
+      os.package_manager.install
+    end
+
+    desc "[internal] Installs Git on the server."
+    task :install do
+      git.send("install_on_#{os_type}")
+
+      puts "Git installed.  If you're using Github, here's the key you'll need to add:"
+      public_key = capture "cat /home/deploy/.ssh/id_rsa.pub"
+      puts public_key
+
+      puts "Go ahead and log into your server and type: ssh git@github.com"
+      puts "Follow the on-screen instructions and you should see \"You've successfully authenticated\""
+    end
+  end
+end

data/lib/kompanee-recipes/heroku.rb

@@ -0,0 +1,243 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  heroku_tasks = [
+    "heroku:credentials",
+    "heroku:credentials:default",
+    "deploy",
+    "deploy:default",
+    "deploy:initial",
+    "deploy:restart",
+    "deploy:migrate",
+    "deploy:rollback",
+    "deploy:rollback:default",
+    "deploy:web:enable",
+    "deploy:web:disable",
+    "website:install",
+    "website:remove",
+    "db:drop",
+    "db:backup",
+    "db:reset_and_seed",
+    "db:seed",
+    "shell",
+    "invoke"
+  ]
+
+  on :start, "heroku:credentials", :only => heroku_tasks
+  on :start, "heroku:raise_error", :except => heroku_tasks
+
+  namespace :heroku do
+    namespace :domain do
+      desc <<-DESC
+        Installs a new domain for the application on the Heroku server.
+      DESC
+      task :install do
+        `heroku domains:add #{deploy_name}`
+      end
+
+      desc <<-DESC
+        Removes the domain for the application from the Heroku server.
+      DESC
+      task :remove do
+        `heroku domains:remove #{deploy_name}`
+      end
+
+      namespace :addon do
+        desc <<-DESC
+          Add the Custom Domain Addon to the server.
+        DESC
+        task :install do
+          `heroku addons:add custom_domains:basic`
+        end
+
+        desc <<-DESC
+          Removes the Custom Domain Addon from the server.
+        DESC
+        task :remove do
+          `heroku addons:remove custom_domains:basic`
+        end
+      end
+    end
+
+    namespace :credentials do
+      desc <<-DESC
+        Selects the correct Heroku credentials for use given the current user.
+
+        If a credentials file already exists, it is backed up.
+      DESC
+      task :default do
+        if File.exist? heroku_credentials_file
+          heroku.credentials.backup
+        end
+
+        if File.exist? "#{heroku_credentials_path}/#{user}_credentials"
+          heroku.credentials.switch
+        else
+          heroku.credentials.create
+        end
+      end
+
+      desc <<-DESC
+        [internal] Backs up the current credentials file.
+      DESC
+      task :backup do
+        account = File.readlines(heroku_credentials_file)[0].chomp
+        File.rename(heroku_credentials_file, "#{heroku_credentials_path}/#{account}_credentials")
+      end
+
+      desc <<-DESC
+        [internal] Creates a Heroku credentials file.
+      DESC
+      task :create do
+        `if [ ! -d #{heroku_credentials_path} ]; then mkdir -p #{heroku_credentials_path}; fi`
+        `echo #{user} > #{heroku_credentials_file}`
+        `echo #{password} >> #{heroku_credentials_file}`
+      end
+
+      desc <<-DESC
+        [internal] Switches the credentials file to either the current use or the
+        name specified by the `HEROKU_ACCOUNT` environment variable.
+      DESC
+      task :switch do
+        account_to_switch_to = ENV['HEROKU_ACCOUNT'] || user
+        File.rename("#{heroku_credentials_path}/#{account_to_switch_to}_credentials", heroku_credentials_file)
+      end
+    end
+
+    desc <<-DESC
+      [internal] Raises an error if someone tries to run a task other than those
+      that are valid for a Heroku deployment.
+    DESC
+    task :raise_error do
+      raise "Deploying the #{rails_env} environment to Heroku.  This command is invalid."
+    end
+  end
+
+  namespace :deploy do
+    desc <<-DESC
+      The standard deployment task.
+
+      It will check out a new release of the code, run any pending migrations and
+      restart the application.
+    DESC
+    task :default do
+      `git push heroku #{branch}`
+      deploy.migrate
+      deploy.restart
+    end
+
+    desc <<-DESC
+      Restarts the application.
+    DESC
+    task :restart do
+      `heroku restart`
+    end
+
+    desc <<-DESC
+      Runs the migrate rake task.
+    DESC
+    task :migrate do
+      `heroku rake db:migrate`
+    end
+
+    desc <<-DESC
+      Rolls back to a previous version and restarts.
+    DESC
+    namespace :rollback do
+      task :default do
+        `heroku rollback`
+        deploy.restart
+      end
+    end
+
+    namespace :web do
+      desc "Removes the maintenance page to resume normal site operation."
+      task :enable do
+        `heroku maintenance:off`
+      end
+
+      desc "Diplays the maintenance page."
+      task :disable do
+        `heroku maintenance:on`
+      end
+    end
+
+    desc "Prepare the server for deployment."
+    task :initial do
+      website.install
+
+      heroku.domain.addon.install
+      db.backup.addon.install
+
+      heroku.domain.install
+
+      `heroku config:add BUNDLE_WITHOUT="development:test"`
+      deploy.default
+    end
+  end
+
+  namespace :website do
+    desc "Installs the application on Heroku"
+    task :install do
+      `heroku create #{application_underscored}`
+    end
+
+    desc "Completely removes application from Heroku"
+    task :remove do
+      `heroku destroy --confirm #{application_underscored}`
+    end
+  end
+
+  namespace :db do
+    desc "Removes the DB from the Server.  Also removes the user."
+    task :drop do
+      `heroku pg:reset`
+    end
+
+    namespace :backup do
+      desc "Backup the database"
+      task :default do
+        `heroku pgbackups:capture`
+      end
+
+      namespace :addon do
+        desc <<-DESC
+          Add the Postgres Backups Addon to the server.
+        DESC
+        task :install do
+          `heroku addons:add pgbackups:basic`
+        end
+
+        desc <<-DESC
+          Removes the Postgres Backups Addon from the server.
+        DESC
+        task :remove do
+          `heroku addons:remove pgbackups:basic`
+        end
+      end
+    end
+
+    desc "Reset database and seed fresh"
+    task :reset_and_seed do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      db.backup
+      `heroku pg:reset`
+      `heroku rake db:seed`
+    end
+
+    desc "Seed database"
+    task :seed do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      db.backup
+      `heroku rake db:seed`
+    end
+  end
+
+  desc "Begin an interactive Heroku session."
+  task :shell do
+    `heroku shell`
+  end
+
+  desc "Invoke a single command on the Heroku server."
+  task :invoke do
+    `heroku invoke #{ENV['COMMAND']}`
+  end
+end

data/lib/kompanee-recipes/mysql.rb

@@ -0,0 +1,128 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set(:db_root_password)       {Capistrano::CLI.password_prompt("Root Password For DB: ")} unless exists?(:db_root_password)
+  set(:db_app_password)        {Capistrano::CLI.password_prompt("App Password For DB: ")}  unless exists?(:db_app_password)
+
+  run_task "db:create",  :as => "manager"
+  run_task "db:drop",    :as => "manager"
+  run_task "db:install", :as => "manager"
+
+  namespace :db do
+    desc <<-DESC
+      Installs the MySQL database server on the system.
+    DESC
+    task :install do
+      mysql.send("install_on_#{os_type}")
+    end
+
+    desc <<-DESC
+      Creates the MySQL database and user for the application.
+
+      * Creates a script that is uploaded to the user's home directory.
+      * The script is executed as `root` and as such, the user will be prompted
+        for `root`'s password.
+      * The DB and user name are equivalent to the application_underscored
+        variable.
+      * The DB user will be granted all privileges on the DB.
+    DESC
+    task :create do
+      create_script = <<-CREATESCRIPT
+        create database #{application_underscored} character set utf8;
+        create user '#{application_underscored}'@'localhost' identified by '#{db_app_password}';
+        grant all on #{application_underscored}.* to #{application_underscored}@localhost;
+      CREATESCRIPT
+
+      put create_script, "#{user_home}/create_#{application_underscored}_db_script"
+      run %Q{#{sudo} bash -c "mysql --user=root --password=#{db_root_password} < #{user_home}/create_#{application_underscored}_db_script"}
+      run "rm #{user_home}/create_#{application_underscored}_db_script"
+    end
+
+    desc <<-DESC
+      Drops the MySQL database and user for the application.
+
+      * Creates a script that is uploaded to the user's home directory.
+      * The script is executed as `root` and as such, the user will be prompted
+        for `root`'s password.
+    DESC
+    task :drop do
+      drop_script = <<-DROPSCRIPT
+        drop user #{application_underscored}@localhost;
+        drop database #{application_underscored};
+      DROPSCRIPT
+
+      put drop_script, "#{user_home}/drop_#{application_underscored}_db_script"
+      run %Q{#{sudo} bash -c "mysql --user=root --password=#{db_root_password} < #{user_home}/drop_#{application_underscored}_db_script"}
+      run "rm #{user_home}/drop_#{application_underscored}_db_script"
+    end
+
+    desc <<-DESC
+      Calls the rake task `db:backup` on the server for the given environment.
+
+      * The backup file is placed in a directory called `db_backups` under the `shared`
+        directory by default.
+      * The filenames are formatted with the timestamp of the backup.
+      * After export, each file is zipped up using a bzip2 compression format.
+    DESC
+    task :backup do
+      run "if [ ! -d #{shared_path}/db_backups ]; then mkdir #{shared_path}/db_backups; fi"
+      run "cd #{current_path} && rake BACKUP_DIRECTORY=#{shared_path}/db_backups RAILS_ENV=#{rails_env} db:backup"
+    end
+
+    desc <<-DESC
+      Calls the rake task `db:reset_and_seed` on the server for the given environment.
+
+      Typically, this task will drop the DB, recreate the DB, load the development
+      schema and then populate the DB by calling the `db:seed` task.
+
+      Warning: This task cannot be called in production mode.  If you truely wish
+               to run this in production, you'll need to log into the server and
+               run the rake task manually.
+    DESC
+    task :reset_and_seed do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      db.backup
+      run "cd #{current_path} && rake RAILS_ENV=#{rails_env} db:reset_and_seed"
+    end
+
+    desc <<-DESC
+      Calls the rake task `db:seed` on the server for the given environment.
+
+      Typically, this task will populate the DB with valid data which is necessary
+      for the initial production deployment.  An example may be that the `STATES`
+      table gets populated with all the information about the States.
+
+      Warning: This task cannot be called in production mode.  If you truely wish
+               to run this in production, you'll need to log into the server and
+               run the rake task manually.
+    DESC
+    task :seed do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      db.backup
+      run "cd #{current_path} && rake RAILS_ENV=#{rails_env} db:seed"
+    end
+  end
+
+  namespace :mysql do
+    desc <<-DESC
+      [internal] Install MySQL on an Ubuntu server.
+
+      * Will use `apt-get` to install MySQL.
+      * Will additionally create a debconf answers file so that the installation
+        can be automated.
+      * The Capistrano user will be prompted for the desired `root` password for
+        the DB.
+    DESC
+    task :install_on_ubuntu do
+      mysql_install_answers = <<-INSTALLANSWERS
+        mysql-server mysql-server/root_password select #{db_root_password}
+        mysql-server mysql-server/root_password_again select #{db_root_password}
+      INSTALLANSWERS
+    
+      put mysql_install_answers, "#{user_home}/mysql_install_answers"
+      run "#{sudo} debconf-set-selections #{user_home}/mysql_install_answers"
+      run "rm #{user_home}/mysql_install_answers"
+
+      set :dependencies, %w{mysql-server-5.1 libmysql-ruby}
+      os.package_manager.install
+    end
+  end
+end

data/lib/kompanee-recipes/passenger.rb

@@ -0,0 +1,124 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  run_task "passenger:install:web_server_module", :as => "manager"
+  run_task "passenger:enable",                    :as => "manager"
+  run_task "passenger:disable",                   :as => "manager"
+
+  namespace :deploy do
+    desc <<-DESC
+      Starts/Restarts the application.
+
+      Passenger knows when you'd like to reset by looking at a file in the `tmp`
+      directory called `restart.txt`.  If the Last Access time for `restart.txt`
+      changes, Passenger restarts the app.
+    DESC
+    task :start, :except => { :no_release => true } do
+      run "touch #{File.join(current_path,'tmp','restart.txt')}"
+    end
+    desc <<-DESC
+      There is no way to stop the application via Passenger.
+
+      This task does nothing.
+    DESC
+    task :stop do ; end
+    desc <<-DESC
+      Starts/Restarts the application.
+
+      Passenger knows when you'd like to reset by looking at a file in the `tmp`
+      directory called `restart.txt`.  If the Last Access time for `restart.txt`
+      changes, Passenger restarts the app.
+    DESC
+    task :restart, :except => { :no_release => true } do
+      run "touch #{File.join(current_path,'tmp','restart.txt')}"
+    end
+  end
+
+  namespace :passenger do
+    namespace :install do
+      desc <<-DESC
+        Installs the Passenger gem
+
+        Passenger will be installed via RVM in the `@global` gemset
+        for the default Ruby version.
+      DESC
+      task :gems do
+        run "rvm use #{default_ruby_version}@global && gem install passenger --version #{passenger_version} --no-ri --no-rdoc"
+      end
+
+      desc <<-DESC
+        Installs the Passenger module
+      DESC
+      task :web_server_module do
+        passenger.install.send("#{web_server_name}_module")
+      end
+
+      desc <<-DESC
+        [internal] Installs the Passenger module
+
+        The Passenger Apache module will be installed via RVM from the `@global` gemset for the default Ruby version.
+      DESC
+      task :apache_module do
+        run "rvm use #{default_ruby_version}@global && rvmsudo passenger-install-apache2-module -a"
+
+        apache_passenger_load = <<-PASSLOAD
+          LoadModule passenger_module #{user_home}/.rvm/gems/#{default_ruby_version}@global/gems/passenger-#{passenger_version}/ext/apache2/mod_passenger.so
+        PASSLOAD
+
+        apache_passenger_conf = <<-PASSCONF
+          <IfModule mod_passenger.c>
+              PassengerRoot #{user_home}/.rvm/gems/#{default_ruby_version}@global/gems/passenger-#{passenger_version}
+              PassengerRuby #{user_home}/.rvm/bin/#{default_ruby_version}
+
+              <Directory "#{deploy_dir}">
+                    Order allow,deny
+                    Allow from all
+              </Directory>
+          </IfModule>
+        PASSCONF
+
+        put apache_passenger_load, "#{user_home}/passenger.load"
+        put apache_passenger_conf, "#{user_home}/passenger.conf"
+        run "#{sudo} mv #{user_home}/passenger.load /etc/apache2/mods-available/"
+        run "#{sudo} mv #{user_home}/passenger.conf /etc/apache2/mods-available/"
+        passenger.enable
+      end
+
+      desc <<-DESC
+        Installs the Passenger gem and Apache module.
+      DESC
+      task :default do
+        passenger.install.gems
+        passenger.install.web_server_module
+      end
+    end
+  
+    desc <<-DESC
+      Enables the Passenger module.
+    DESC
+    task :enable do
+      passenger.send("enable_on_#{web_server_name}")
+      web_server.restart
+    end
+
+    desc <<-DESC
+      Disables the Passenger module.
+    DESC
+    task :disable do
+      passenger.send("disable_on_#{web_server_name}")
+      web_server.restart
+    end
+
+    desc <<-DESC
+      [internal] Enables the Passenger module on Apache.
+    DESC
+    task :enable_on_apache do
+      run "#{sudo} a2enmod passenger"
+    end
+
+    desc <<-DESC
+      [internal] Disables the Passenger module on Apache.
+    DESC
+    task :disable_on_apache do
+      run "#{sudo} a2dismod passenger"
+    end
+  end
+end