capistrano-custom-maintenance 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-custom-maintenance.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yamashita Yuu
+
+MIT License
+
+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.md

@@ -0,0 +1,67 @@
+# capistrano-custom-maintenance
+
+a customizable capistrano maintenance recipe.
+
+this recipe has backward compatibility with original capistrano's maintenance features.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-custom-maintenance'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-custom-maintenance
+
+## Usage
+
+Add following in you `config/deploy.rb`.
+
+    # in "config/deploy.rb"
+    require 'capistrano-custom-maintenance'
+
+Now you can entering/leaving maintenance
+
+    $ cap deploy:web:disable # <-- entering maintenance
+    $ cap deploy:web:enable # <-- leaving maintenance
+
+If you prefer JSON response for maintenance page, you can do it with configuring as following.
+
+    # in "config/deploy.rb"
+    require 'capistrano-custom-maintenance'
+    set(:maintenance_content_type, 'application/json')
+
+Following options are available to manage your maintenance.
+
+ * `:maintenance_basename` - basename of your maintenance page. use `maintenance` by default.
+ * `:maintenance_filename` - filename of maintenance document, not including path part.
+ * `:maintenance_suffix` - suffix of maintenance document. guessed from content-type by default.
+ * `:maintenance_content_type` - the `Content-Type` of maintenance page. use `text/html` by default.
+ * `:maintenance_reason` - the reason of maintenance. use `ENV['REASON']` by default.
+ * `:maintenance_deadline` - the deadline of maintenance. use `ENV['UNTIL']` by default.
+ * `:maintenance_document_path` - the path to the maintenance page on httpd.
+ * `:maintenance_system_path` - the path to the maintenance page.
+ * `:maintenance_template_path` - the path to the maintenance templates.
+ * `:maintenance_template` - the path to the template of maintenance page.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Author
+
+- YAMASHITA Yuu (https://github.com/yyuu)
+- Geisha Tokyo Entertainment Inc. (http://www.geishatokyo.com/)
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/capistrano-custom-maintenance.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano-custom-maintenance/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yamashita Yuu"]
+  gem.email         = ["yamashita@geishatokyo.com"]
+  gem.description   = %q{a customizable capistrano maintenance recipe.}
+  gem.summary       = %q{a customizable capistrano maintenance recipe.}
+  gem.homepage      = "https://github.com/yyuu/capistrano-custom-maintenance"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "capistrano-custom-maintenance"
+  gem.require_paths = ["lib"]
+  gem.version       = Capistrano::CustomMaintenance::VERSION
+
+  gem.add_dependency("capistrano")
+  gem.add_dependency("json")
+  gem.add_dependency("mime-types")
+end

data/lib/capistrano-custom-maintenance.rb

@@ -0,0 +1,8 @@
+require "capistrano-custom-maintenance/deploy"
+require "capistrano-custom-maintenance/version"
+
+module Capistrano
+  module CustomMaintenance
+    # Your code goes here...
+  end
+end

data/lib/capistrano-custom-maintenance/deploy.rb

@@ -0,0 +1,78 @@
+
+require 'erb'
+require 'json'
+require 'mime/types'
+
+module Capistrano
+  module CustomMaintenance
+    def self.extended(configuration)
+      configuration.load {
+        namespace(:deploy) {
+          _cset(:maintenance_template_path, File.dirname(__FILE__), 'templates')
+          _cset(:maintenance_template) {
+            ts = [
+              File.join(maintenance_template_path, "#{maintenance_basename}.#{maintenance_suffix}.erb"),
+              File.join(maintenance_template_path, "#{maintenance_basename}.erb"),
+            ]
+            ts << File.join(maintenance_template_path, "#{maintenance_basename}.rhtml") if maintenance_suffix == 'html'
+            xs = ts.select { |t| File.exist?(t) }
+            unless xs.empty?
+              xs.first
+            else
+              abort("No such template found: #{ts.join(', ')}")
+            end
+          }
+          _cset(:maintenance_content_type, 'text/html')
+          _cset(:maintenance_suffix) { # suffix of maintenance document. guessed from content-type by default.
+            type, = MIME::Types[maintenance_content_type]
+            type.extensions.first
+          }
+          _cset(:maintenance_filename) { # filename of maintenance document, not including path part
+            "#{maintenance_basename}.#{maintenance_suffix}"
+          }
+          _cset(:maintenance_system_path) { # actual path
+            File.join(shared_path, maintenance_document_path)
+          }
+          _cset(:maintenance_document_path) { # virtual path on httpd
+            File.join('/system', maintenance_filename)
+          }
+
+          _cset(:maintenance_timestamp) {
+            Time.now
+          }
+          _cset(:maintenance_reason) {
+            ENV.fetch('REASON', "maintenance")
+          }
+          _cset(:maintenance_deadline) {
+            ENV.fetch('UNTIL', "shortly")
+          }
+
+          namespace(:web) {
+            task(:disable, :roles => :web, :except => { :no_release => true }) {
+              on_rollback {
+                run("rm -f #{maintenance_system_path}")
+              }
+
+              reason = maintenance_reason
+              deadline = maintenance_deadline
+              template = File.read(maintenance_template)
+              result = ERB.new(template).result(binding)
+
+              put(result, maintenance_system_path, :mode => 0644)
+            }
+
+            task(:enable, :roles => :web, :except => { :no_release => true }) {
+              run("rm -f #{maintenance_system_path}")
+            }
+          }
+        }
+      }
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Configuration.instance.extend(Capistrano::CustomMaintenance)
+end
+
+# vim:set ft=ruby :

data/lib/capistrano-custom-maintenance/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 <%= maintenance_reason %>
+           as of <%= maintenance_timestamp.strftime("%H:%M %Z") %>.
+         </p>
+         <p style="color: #666;">
+           It'll be back <%= maintenance_deadline %>.
+         </p>
+       </div>
+     </div>
+  </div>
+
+</body>
+</html>

data/lib/capistrano-custom-maintenance/templates/maintenance.json.erb

@@ -0,0 +1,8 @@
+<%=
+  {
+    "type" => "maintenance",
+    "timestamp" => maintenance_timestamp,
+    "reason" => maintenance_reason,
+    "deadline" => maintenance_deadline,
+  }.to_json()
+ %>

data/lib/capistrano-custom-maintenance/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module CustomMaintenance
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-custom-maintenance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yamashita Yuu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a customizable capistrano maintenance recipe.
+email:
+- yamashita@geishatokyo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-custom-maintenance.gemspec
+- lib/capistrano-custom-maintenance.rb
+- lib/capistrano-custom-maintenance/deploy.rb
+- lib/capistrano-custom-maintenance/templates/maintenance.html.erb
+- lib/capistrano-custom-maintenance/templates/maintenance.json.erb
+- lib/capistrano-custom-maintenance/version.rb
+homepage: https://github.com/yyuu/capistrano-custom-maintenance
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: a customizable capistrano maintenance recipe.
+test_files: []
+has_rdoc: