capistrano-maintenance 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/README.md

@@ -0,0 +1,13 @@
+Capistrano Maintenenace Extension
+=================================
+
+This gem simply offers the recently removed `deploy:web:disable` and `deploy:web:enable` tasks to your Capistrano deployment.
+
+Usage
+-----
+
+Put this line into your deploy.rb file:
+
+`require 'capistrano/maintenance'`
+
+That's it. Everthing works like expected.

data/capistrano-maintenance.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "capistrano"
+require "capistrano/maintenance/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'capistrano-maintenance'
+  s.version     = Capistrano::Maintenance::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
+  s.author      = 'Thomas von Deyen'
+  s.email       = 'tvd@magiclabs.de'
+  s.homepage    = 'https://github.com/tvdeyen/capistrano-maintenance'
+  s.summary     = %q{Offers deploy:web:disable and deploy:web:enable tasks for Capistrano.}
+  s.description = %q{The deploy:web tasks where removed from Capistrano core. This extension brings them back.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'capistrano', ['>= 2.0.0']
+end

data/lib/capistrano/maintenance.rb

@@ -0,0 +1,94 @@
+require 'capistrano'
+
+module Capistrano::Maintenance
+
+  def self.load_into(configuration)
+    configuration.load do
+
+      _cset :maintenance_basename, "maintenance"
+      _cset(:maintenance_template_path) { File.join(File.dirname(__FILE__), "templates", "maintenance.html.erb") }
+
+      namespace :deploy do
+
+        namespace :web do
+
+          desc <<-DESC
+            Present a maintenance page to visitors. Disables your application's web \
+            interface by writing a "#{maintenance_basename}.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"
+
+            You can use a different template for the maintenance page by setting the \
+            :maintenance_template_path variable in your deploy.rb file. The template file \
+            should either be a plaintext or an erb file.
+
+            Further customization will require that you write your own task.
+          DESC
+          task :disable, :roles => :web, :except => { :no_release => true } do
+            require 'erb'
+            on_rollback { run "rm -f #{shared_path}/system/#{maintenance_basename}.html" }
+
+            warn <<-EOHTACCESS
+
+              # Please add something like this to your site's Apache htaccess to redirect users to the maintenance page.
+              # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
+
+              ErrorDocument 503 /system/#{maintenance_basename}.html
+              RewriteEngine On
+              RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
+              RewriteCond %{DOCUMENT_ROOT}/system/#{maintenance_basename}.html -f
+              RewriteCond %{SCRIPT_FILENAME} !#{maintenance_basename}.html
+              RewriteRule ^.*$  -  [redirect=503,last]
+
+              # Or if you are using Nginx add this to your server config:
+
+              if (-f $document_root/system/maintenance.html) {
+                return 503;
+              }
+              error_page 503 @maintenance;
+              location @maintenance {
+                rewrite  ^(.*)$  /system/maintenance.html last;
+                break;
+              }
+            EOHTACCESS
+
+            reason = ENV['REASON']
+            deadline = ENV['UNTIL']
+
+            template = File.read(maintenance_template_path)
+            result = ERB.new(template).result(binding)
+
+            put result, "#{shared_path}/system/#{maintenance_basename}.html", :mode => 0644
+          end
+
+          desc <<-DESC
+            Makes the application web-accessible again. Removes the \
+            "#{maintenance_basename}.html" page generated by deploy:web:disable, which (if your \
+            web servers are configured correctly) will make your application \
+            web-accessible again.
+          DESC
+          task :enable, :roles => :web, :except => { :no_release => true } do
+            run "rm -f #{shared_path}/system/#{maintenance_basename}.html"
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Maintenance.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/maintenance/version.rb

@@ -0,0 +1,3 @@
+module Capistrano::Maintenance
+  VERSION = "0.0.1"
+end

data/lib/capistrano/templates/maintenance.html.erb

@@ -0,0 +1,53 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>System down for maintenance</title>
+
+  <style type="text/css">
+    div.outer {
+      position: absolute;
+      left: 50%;
+      top: 50%;
+      width: 500px;
+      height: 300px;
+      margin-left: -260px;
+      margin-top: -150px;
+    }
+
+    .DialogBody {
+      margin: 0;
+      padding: 10px;
+      text-align: left;
+      border: 1px solid #ccc;
+      border-right: 1px solid #999;
+      border-bottom: 1px solid #999;
+      background-color: #fff;
+    }
+
+    body { background-color: #fff; }
+  </style>
+</head>
+
+<body>
+
+  <div class="outer">
+     <div class="DialogBody" style="text-align: center;">
+       <div style="text-align: center; width: 200px; margin: 0 auto;">
+         <p style="color: red; font-size: 16px; line-height: 20px;">
+           The system is down for <%= reason ? reason : "maintenance" %>
+           as of <%= Time.now.strftime("%H:%M %Z") %>.
+         </p>
+         <p style="color: #666;">
+           It'll be back <%= deadline ? deadline : "shortly" %>.
+         </p>
+       </div>
+     </div>
+  </div>
+
+</body>
+</html>

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-maintenance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: The deploy:web tasks where removed from Capistrano core. This extension
+  brings them back.
+email: tvd@magiclabs.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- capistrano-maintenance.gemspec
+- lib/capistrano/maintenance.rb
+- lib/capistrano/maintenance/version.rb
+- lib/capistrano/templates/maintenance.html.erb
+homepage: https://github.com/tvdeyen/capistrano-maintenance
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Offers deploy:web:disable and deploy:web:enable tasks for Capistrano.
+test_files: []
+has_rdoc: