capistrano-maintenance 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfa25fd8964b5920d1f82d422f2671eeb7dadd36
-  data.tar.gz: 569d7a6c4610b3f245701ebefce92837b5e2ad8c
+  metadata.gz: 4840f0379ec3fc55ca13c69663bfc4cd14132c76
+  data.tar.gz: 6fa9b428b819ad1619a86882820622857b41b420
 SHA512:
-  metadata.gz: 0579666e4ec68db548a31483c4f23e66e7ae42a1c650eb4c73b20e5bd00c6a885682e339fd997c1f4abd8511dd0c2bba5d5ec0d15fd9e58b775d1e4ebf7bcf43
-  data.tar.gz: d57033fe692fb3e19b2e224ab053a4d10de5aac12af5cb4748d86aaef2d5d6440c0725e837de713bf4fd1af944bcc211e3ddabc97ff869a409c11faa0ad6ee6e
+  metadata.gz: 978014eaa1c344105af9f482b0e26894fecac52add57f45a12c9636138d5eba52357fed2398cb27bb410dfb18bd50aa6dbc98ce9cba21f06d54c96cfb344d31f
+  data.tar.gz: f24d03db3e71fe4416d5297df6ba6ae95af58136a1a1a0394fa7ff6a7cdd07a2d22f9d53392a2bb99742b52e07ff2167cca223a38604bc47a3f779cbfb746df0

data/.gitignore

@@ -2,8 +2,12 @@
 *.rbc
 .bundle
 .config
-coverage
+.yardoc
+Gemfile.lock
 InstalledFiles
+_yardoc
+coverage
+doc/
 lib/bundler/man
 pkg
 rdoc
@@ -11,9 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-Gemfile.lock

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
-gemspec
 
-group :development do
-  gem 'bumpy'
-end
+# Specify your gem's dependencies in capistrano-maintenance.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kir Shatrov
+
+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

@@ -1,83 +1,102 @@
-Capistrano 2 Maintenance Extension
-==================================
+# Capistrano::Maintenance
 
-This gem simply offers the recently removed `deploy:web:disable` and `deploy:web:enable` tasks to your Capistrano 2  deployment.
+## Installation
 
-**NOTE** This version only works with Capistrano 2.x. For a Capistrano 3 compatible version please use [the official extension](https://github.com/capistrano/maintenance).
+Add this line to your application's Gemfile:
 
-Usage
------
+    gem 'capistrano', '~> 3.0'
+    gem 'capistrano-maintenance', github: "capistrano/maintenance", require: false 
 
-Install the gem via rubygems:
 
-```sh
-gem install capistrano-maintenance --version=0.0.5
-```
+And then execute:
 
-or use bundler:
+    $ bundle
 
-```ruby
-# Gemfile
-gem 'capistrano-maintenance', '0.0.5', group: 'development'
-```
+Or install it yourself:
 
-```sh
-bundle install
-```
+    $ gem install capistrano-maintenance
 
-And put this line into your deploy.rb file:
+## Usage
 
-```ruby
-require 'capistrano/maintenance'
-```
+Before using the maintenance tasks, you need to configure your webserver. How you do this depends on how your server is configured, but the following examples should help you on your way.
+
+Application servers such as [Passenger](https://www.phusionpassenger.com) and [unicorn](http://unicorn.bogomips.org) requires you to set your public web directory to `current/public`. Both examples below are compatible with this setup.
 
-Now, you can disable the web:
+Here is an example config for **nginx**. Note that this is just a part of the complete config, and will probably require modifications.
 
-```sh
-cap deploy:web:disable
+```
+error_page 503 @503;
+
+# Return a 503 error if the maintenance page exists.
+if (-f /var/www/domain.com/shared/public/system/maintenance.html) {
+  return 503;
+}
+
+location @503 {
+  # Serve static assets if found.
+  if (-f $request_filename) {
+    break;
+  }
+
+  # Set root to the shared directory.
+  root /var/www/domain.com/shared/public;
+  rewrite ^(.*)$ /system/maintenance.html break;
+}
 ```
 
-You can also specify a string to specify reason and how long it is until:
+And here is an example config for **Apache**. This will also need to be modified.
 
-```sh
-cap deploy:web:disable REASON="For server upgrades" UNTIL="3AM EST"
+```
+# Create an alias to the maintenance page used as error document.
+Alias "/error" "/var/www/domain.com/shared/public/system/"
+ErrorDocument 503 /error/maintenance.html
+
+# Return 503 error if the maintenance page exists.
+RewriteCond /var/www/domain.com/shared/public/system/maintenance.html -f
+RewriteRule !^/error/maintenance.html - [L,R=503]
+
+# Redirect all non-static requests to unicorn (or similar).
+# Will not redirect any requests if the maintenance page exists.
+RewriteCond /var/www/domain.com/shared/public/system/maintenance.html !-f
+RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+RewriteRule ^/(.*)$ balancer://unicornserver%{REQUEST_URI} [P,QSA,L]
 ```
 
-When maintenance is done, you can enable the web:
+You can now require the gem in your `Capfile`:
 
-```sh
-cap deploy:web:enable
-```
+    require 'capistrano/maintenance'
 
-If you are using [multistage capistrano](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension), you'll also need to include the stage before `deploy:web:disable` and `deploy:web:enable`:
+### Enable task
 
-```sh
-cap production deploy:web:disable
-cap production deploy:web:enable
-```
+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.
 
-Configuration
--------------
+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:
 
-Everything should work out of the box general, but there are some additional adjustments you can make in your deploy.rb.
+    cap maintenance:enable REASON="hardware upgrade" UNTIL="12pm Central Time"
 
-```ruby
-# change the default filename from maintenance.html to disabled.html
-set :maintenance_basename, 'disabled'
+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.
 
-# change default directory from default of #{shared_path}/system
-set :maintenance_dirname, "#{shared_path}/public/system"
+Further customization will require that you write your own task.
 
-# use local template instead of included one with capistrano-maintenance
-set :maintenance_template_path, 'app/views/maintenance.html.erb'
+### Disable task
 
-# disable the warning on how to configure your server
-set :maintenance_config_warning, false
-```
+    cap maintenance:disable
 
-For your custom maintenance template, you have access to the following variables, if they're defined:
+Makes the application web-accessible again. Removes the
+"#{maintenance_basename}.html" page generated by maintenance:disable, which (if your
+web servers are configured correctly) will make your application web-accessible again.
 
-* reason
-* deadline
+## Contributing
 
-These are the environment variables passed in via REASON="something" and UNTIL="later"
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,10 +1 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/gem_helper'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
-task :default => :build
+require "bundler/gem_tasks"

data/capistrano-maintenance.gemspec

@@ -1,20 +1,25 @@
-# encoding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
-require "capistrano/maintenance/version"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.}
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-maintenance"
+  spec.version       = CapistranoMaintenance::VERSION
+  spec.authors       = ["Kir Shatrov"]
+  spec.email         = ["shatrov@me.com"]
+  spec.description   = %q{Maintenance Support for Capistrano 3}
+  spec.summary       = %q{Enable and disabled tasks to show when your project is on maintenance}
+  spec.homepage      = "https://github.com/capistrano/capistrano-maintenance"
+  spec.license       = "MIT"
 
-  s.files         = `git ls-files`.split("\n")
-  s.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  s.add_dependency 'capistrano', ['~> 2.0']
+  spec.add_dependency "capistrano", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
 end

data/lib/capistrano-maintenance/version.rb

@@ -0,0 +1,3 @@
+module CapistranoMaintenance
+  VERSION = "1.0.0"
+end

data/lib/capistrano/maintenance.rb

@@ -1,94 +1 @@
-require 'capistrano'
-
-module Capistrano
-  module Maintenance
-
-    def self.load_into(configuration)
-      configuration.load do
-
-        _cset(:maintenance_dirname) { "#{shared_path}/system" }
-        _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 #{maintenance_dirname}/#{maintenance_basename}.html" }
-
-              if fetch(:maintenance_config_warning, true)
-                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
-              end
-
-              reason = ENV['REASON']
-              deadline = ENV['UNTIL']
-
-              template = File.read(maintenance_template_path)
-              result = ERB.new(template).result(binding)
-
-              put result, "#{maintenance_dirname}/#{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 #{maintenance_dirname}/#{maintenance_basename}.html"
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-if Capistrano::Configuration.instance
-  Capistrano::Maintenance.load_into(Capistrano::Configuration.instance)
-end
+load File.expand_path("../tasks/maintenance.rake", __FILE__)

data/lib/capistrano/tasks/maintenance.rake

@@ -0,0 +1,33 @@
+namespace :maintenance do
+  desc "Turn on maintenance mode"
+  task :enable do
+    on roles(:web) do
+      require 'erb'
+
+      reason = ENV['REASON']
+      deadline = ENV['UNTIL']
+
+      default_template = File.join(File.expand_path('../../templates', __FILE__), 'maintenance.html.erb')
+      template = fetch(:maintenance_template_path, default_template)
+      result = ERB.new(File.read(template)).result(binding)
+
+      rendered_path = "#{shared_path}/public/system/"
+      rendered_name = "#{fetch(:maintenance_basename, 'maintenance')}.html"
+
+      if test "[ ! -d #{rendered_path} ]"
+        info 'Creating missing directories.'
+        execute :mkdir, '-pv', rendered_path
+      end
+
+      upload!(StringIO.new(result), rendered_path + rendered_name)
+      execute "chmod 644 #{rendered_path + rendered_name}"
+    end
+  end
+
+  desc "Turn off maintenance mode"
+  task :disable do
+    on roles(:web) do
+      execute "rm -f #{shared_path}/public/system/#{fetch(:maintenance_basename, 'maintenance')}.html"
+    end
+  end
+end

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

@@ -18,8 +18,8 @@
     <h1>Maintenance</h1>
 
     <p>The system is down for <%= reason ? reason : "maintenance" %><br>
-           as of <%= Time.now.strftime("%H:%M %Z") %>.</p>
+           as of <%= Time.now.strftime("%F %H:%M %Z") %>.</p>
 
     <p>It'll be back <%= deadline ? deadline : "shortly" %>.</p>
 </body>
-</html>
+</html>

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-maintenance
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
-- Thomas von Deyen
+- Kir Shatrov
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -14,32 +14,62 @@ dependencies:
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-description: The deploy:web tasks where removed from Capistrano core. This extension
-  brings them back.
-email: tvd@magiclabs.de
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Maintenance Support for Capistrano 3
+email:
+- shatrov@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - capistrano-maintenance.gemspec
+- lib/capistrano-maintenance/version.rb
 - lib/capistrano/maintenance.rb
-- lib/capistrano/maintenance/version.rb
+- lib/capistrano/tasks/maintenance.rake
 - lib/capistrano/templates/maintenance.html.erb
-homepage: https://github.com/tvdeyen/capistrano-maintenance
+homepage: https://github.com/capistrano/capistrano-maintenance
 licenses:
 - MIT
 metadata: {}
@@ -59,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Offers deploy:web:disable and deploy:web:enable tasks for Capistrano.
+summary: Enable and disabled tasks to show when your project is on maintenance
 test_files: []

data/lib/capistrano/maintenance/version.rb

@@ -1,5 +0,0 @@
-module Capistrano
-  module Maintenance
-    VERSION = "0.0.5"
-  end
-end