chicken_soup 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,17 @@
 Chicken Soup... for the Deployment Soul
 ================================
 
-TODO
+Installation
+------
+Add `require 'chicken_soup'` to your deploy.rb file.
+
+Assumptions
+------
+You're deploying with RVM
+You have a `db:backup` task (link to mine)
+You have a `db:seed` task (link to mine)
+You have a `db:samplize` task (link to mine)
+You have a non-priviledged `deployment` user and a priviledged `manager` user.  The `manager` user has sudo capabilities.
 
 Issues
 ------

data/chicken_soup.gemspec

@@ -28,10 +28,7 @@ Gem::Specification.new do |s|
   s.require_paths         = ["lib"]
   #= Manifest =#
 
-  s.add_dependency('capistrano',            '~> 3.0.3')
+  s.add_dependency('capistrano',            '~> 2.5.19')
 
   s.add_development_dependency('bundler',   '~> 1.0.10')
-  s.add_development_dependency('rspec',     '~> 2.4')
-  s.add_development_dependency('rake',      '~> 0.8.7')
-  s.add_development_dependency('simplecov', '~> 0.3.9')
 end

data/lib/chicken_soup/capabilities/apache.rb

@@ -0,0 +1,235 @@
+######################################################################
+#                            APACHE TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  on        :start,                       'apache:environment_detection'
+
+  run_task  'web_server:stop',            :as => 'manager'
+  run_task  'web_server:start',           :as => 'manager'
+  run_task  'web_server:restart',         :as => 'manager'
+
+  run_task  'website:install',            :as => 'manager'
+  run_task  'website:remove',             :as => 'manager'
+  run_task  'website:enable',             :as => 'manager'
+  run_task  'website:disable',            :as => 'manager'
+
+  namespace :deploy do
+    namespace :web do
+      desc <<-DESC
+        Enables the website's application by removing the maintenance page.
+      DESC
+      task :enable do
+        website.maintenance_mode.disable
+      end
+
+      desc <<-DESC
+        Disables the website's application by installing the maintenance page.
+      DESC
+      task :disable do
+        website.maintenance_mode.enable
+      end
+    end
+  end
+
+  namespace :web_server do
+    desc "Stop Apache"
+    task :stop do
+      apache.stop
+    end
+
+    desc "Start Apache"
+    task :start do
+      apache.start
+    end
+
+    desc "Restart Apache"
+    task :restart do
+      apache.restart
+    end
+  end
+
+  namespace :website do
+    desc "Creates the site configuration for the files."
+    task :create do
+      apache.virtual_host.install
+    end
+
+    desc "Completely removes the site configuration from the server (but leaves the files.)"
+    task :remove do
+      apache.virtual_host.remove
+    end
+
+    desc "Enable Site"
+    task :enable do
+      apache.website.enable
+    end
+
+    desc "Disable Site"
+    task :disable do
+      apache.website.disable
+    end
+
+    namespace :maintenance_mode do
+      desc <<-DESC
+        Makes the application web-accessible again. Removes the \
+        "maintenance.html" page generated by deploy:web:disable, which (if your \
+        web servers are configured correctly) will make your application \
+        web-accessible again.
+      DESC
+      task :disable, :except => { :no_release => true } do
+        run "rm #{shared_path}/system/maintenance.html"
+      end
+
+      desc <<-DESC
+        Present a maintenance page to visitors. Disables your application's web \
+        interface by writing a "maintenance.html" file to each web server. The \
+        servers must be configured to detect the presence of this file, and if \
+        it is present, always display it instead of performing the request.
+
+        By default, the maintenance page will just say the site is down for \
+        "maintenance", and will be back "shortly", but you can customize the \
+        page by specifying the REASON and UNTIL environment variables:
+
+          $ cap deploy:web:disable \\
+                REASON="hardware upgrade" \\
+                UNTIL="12pm Central Time"
+
+        Further customization will require that you write your own task.
+      DESC
+      task :enable, :except => { :no_release => true } do
+        on_rollback { rm "#{shared_path}/system/maintenance.html" }
+
+        require 'erb'
+        deadline, reason = ENV['UNTIL'], ENV['REASON']
+
+        template = File.read("./app/views/layouts/maintenance.html.erb")
+        maintenance_page = ERB.new(template).result(binding)
+
+        put maintenance_page, "#{shared_path}/system/maintenance.html", :mode => 0644
+      end
+    end
+  end
+
+  namespace :apache do
+    desc "[internal] Checks to see what type of Apache installation is running on the remote."
+    task :environment_detection do
+      find_apache_control_script
+
+      if apache_control_script =~ /apache2/
+        set :apache_enable_script,    "a2ensite"
+        set :apache_disable_script,   "a2dissite"
+      end
+    end
+
+    desc "[internal] Starts the Apache webserver"
+    task :start do
+      run "#{sudo} #{apache_control_script} start"
+    end
+
+    desc "[internal] Stops the Apache webserver"
+    task :stop do
+      run "#{sudo} #{apache_control_script} stop"
+    end
+
+    desc "[internal] Stops the Apache webserver"
+    task :restart do
+      run "#{sudo} #{apache_control_script} restart"
+    end
+
+    desc "[internal] Reloads the Apache configurations."
+    task :reload do
+      run "#{sudo} #{apache_control_script} reload"
+    end
+
+    namespace :website do
+      desc "[internal] Enables the Apache site on the server level."
+      task :enable do
+        abort "Sorry, auto-enabling sites is not supported on your version of Apache." unless exists?(:apache_enable_script)
+
+        run "#{sudo} #{apache_enable_script} #{deploy_name}"
+        apache.reload
+      end
+
+      desc "[internal] Disables the Apache site on the server level."
+      task :disable do
+        abort "Sorry, auto-disabling sites is not supported on your version of Apache." unless exists?(:apache_disable_script)
+
+        run "#{sudo} #{apache_disable_script} #{deploy_name}"
+        apache.reload
+      end
+    end
+
+    namespace :virtual_host do
+      desc "[internal] Install Virtual Host"
+      task :install do
+        abort "Sorry, auto-installing sites is not supported on your version of Apache." unless exists?(:apache_disable_script)
+
+        virtual_host_config = <<-VHOST
+          <VirtualHost #{web_server_ip}:443>
+            ServerName #{deploy_name}
+            DocumentRoot #{deploy_to}/current/public
+
+            SSLEngine on
+            SSLCertificateFile       /etc/ssl/certs/#{domain}.crt
+            SSLCertificateKeyFile    /etc/ssl/certs/#{domain}.key
+
+            RailsEnv #{rails_env}
+            RackEnv #{rails_env}
+
+            <Directory "#{deploy_to}/current/public">
+              Options FollowSymLinks -MultiViews
+              AllowOverride all
+              Order allow,deny
+              Allow from all
+            </Directory>
+
+            RewriteEngine On
+
+            ErrorDocument 503 /system/maintenance.html
+            RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
+            RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+            RewriteCond %{REQUEST_URI} !^/images/
+            RewriteCond %{REQUEST_URI} !^/robots.txt
+            RewriteCond %{REQUEST_URI} !^/sitemap
+            RewriteRule ^.*$ - [redirect=503,last]
+
+            ErrorLog /var/log/apache2/#{application}-errors.log
+
+            LogLevel warn
+
+            CustomLog /var/log/apache2/#{application}-access.log combined
+            ServerSignature On
+          </VirtualHost>
+
+          <VirtualHost #{web_server_ip}:80>
+            ServerName #{deploy_name}
+
+            Redirect   permanent / https://#{deploy_name}
+          </VirtualHost>
+        VHOST
+
+        put virtual_host_config, "#{user_home}/#{deploy_name}"
+        run "#{sudo} mv #{user_home}/#{deploy_name} /etc/apache2/sites-available"
+        run "#{sudo} /etc/init.d/apache2 reload"
+      end
+
+      desc "[internal] Remove Virtual Host"
+      task :remove do
+        abort "Sorry, auto-removing sites is not supported on your version of Apache." unless exists?(:apache_disable_script)
+
+        run "#{sudo} rm /etc/apache2/sites-available/#{deploy_name}"
+        run "#{sudo} /etc/init.d/apache2 reload"
+      end
+    end
+  end
+end
+
+def find_apache_control_script
+  if remote_file_exists?("/usr/sbin/apachectl")
+    set :apache_control_script,   "/usr/sbin/apachectl"
+  elsif remote_file_exists?("/usr/sbin/apache2")
+    set :apache_control_script,   "/usr/sbin/apache2"
+  end
+
+  abort "Couldn't figure out your version of Apache" unless exists?(:apache_control_script)
+end

data/lib/chicken_soup/capabilities/bundler.rb

@@ -0,0 +1,64 @@
+######################################################################
+#                           BUNDLER TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  _cset :gem_packager_version,  `gem list bundler`.match(/\((.*)\)/)[1]
+  set :rake,                  'bundle exec rake'
+
+  before 'gems:install',      'bundler:install'
+
+  namespace :gems do
+    desc "Install Bundled Gems"
+    task :install do
+      run "cd #{current_release} && bundle install --gemfile #{current_release}/Gemfile --path #{shared_path}/bundle --deployment --quiet --without development test"
+    end
+
+    desc "Update Bundled Gems"
+    task :update do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+
+      run "cd #{current_release} && bundle update"
+    end
+  end
+
+  namespace :bundler do
+    desc "Install Bundler"
+    task :install do
+      run_with_rvm "#{ruby_version}@global", "gem install bundler --version #{gem_packager_version} --no-ri --no-rdoc && gem cleanup bundler"
+    end
+  end
+end
+
+######################################################################
+#                     BUNDLER ENVIRONMENT CHECKS                     #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Bundler environment variables have been set up.
+      DESC
+      task :bundler do
+        required_variables = [
+          :gem_packager_version
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end
+
+######################################################################
+#                         DEFAULT BUNDLER SETUP                      #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for Bundler deployments."
+      task :bundler do
+        _cset :bundler_version,       `gem list bundler`.match(/\((.*)\)/)[1]
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/git.rb

@@ -0,0 +1,65 @@
+######################################################################
+#                              GIT TASKS                             #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  # before  'deploy:cleanup',           'deploy:tag'
+
+  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
+end
+
+######################################################################
+#                        GIT ENVIRONMENT CHECK                       #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :defaults do
+      desc "[internal] Sets intelligent version control defaults for deployments"
+      task :git do
+        _cset :github_account,            ENV["USER"]
+        _cset :deploy_via,                :remote_cache
+
+        set :scm,                         :git
+        set(:repository)                  {"git@github.com:#{github_account}/#{application}.git"}
+        set(:branch)                      { `git branch`.match(/\* (\S+)\s/m)[1] || raise("Couldn't determine current branch") }
+        set(:remote)                      { `git remote`.match(/(\S+)\s/m)[1] || raise("Couldn't determine default remote repository") }
+        ssh_options[:forward_agent]       = true
+      end
+    end
+  end
+end
+
+######################################################################
+#                          DEFAULT GIT SETUP                         #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :defaults do
+      desc "[internal] Sets intelligent version control defaults for deployments"
+      task :git do
+        _cset :github_account,            ENV["USER"]
+        _cset :deploy_via,                :remote_cache
+
+        set :scm,                         :git
+        set(:repository)                  {"git@github.com:#{github_account}/#{application}.git"}
+        set(:branch)                      { `git branch`.match(/\* (\S+)\s/m)[1] || raise("Couldn't determine current branch") }
+        set(:remote)                      { `git remote`.match(/(\S+)\s/m)[1] || raise("Couldn't determine default remote repository") }
+        ssh_options[:forward_agent]       = true
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/heroku.rb

@@ -0,0 +1,286 @@
+######################################################################
+#                            HEROKU TASKS                            #
+######################################################################
+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}`
+    end
+
+    desc "Completely removes application from Heroku"
+    task :remove do
+      `heroku destroy --confirm #{application}`
+    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
+
+######################################################################
+#                     HEROKU ENVIRONMENT CHECKS                      #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Heroku environment variables have been set up.
+      DESC
+      task :heroku do
+        required_variables = [
+          :deploy_name,
+          :user,
+          :heroku_credentials_path,
+          :heroku_credentials_file
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end
+
+######################################################################
+#                  DEFAULT HEROKU ENVIRONMENT SETUP                  #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for Heroku deployments"
+      task :heroku do
+        _cset :heroku_credentials_path,   "#{ENV["HOME"]}/.heroku"
+        _cset :heroku_credentials_file,   "#{heroku_credentials_path}/credentials"
+
+        _cset(:password)                  {Capistrano::CLI.password_prompt("Encrypted Heroku Password: ")}
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/hoptoad.rb

@@ -0,0 +1,6 @@
+######################################################################
+#                           HOPTOAD TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  # require 'hoptoad_notifier/capistrano'
+end