capistrano-maintenance 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a51b5180a4cd308b6e52df9e0ac26394757f45c
-  data.tar.gz: 68f9ef18a277466632b508c19ee274b9a71ccb6a
+  metadata.gz: bfa25fd8964b5920d1f82d422f2671eeb7dadd36
+  data.tar.gz: 569d7a6c4610b3f245701ebefce92837b5e2ad8c
 SHA512:
-  metadata.gz: 6decbba0f3ca4bc85b55edfd917e6a0cd9417cdf48b568156dbd7e35c0e5e67861f7373236178f657553636ae4ef6bf95e5913616222bc636e07ab427b9e40b0
-  data.tar.gz: 1cd36c78fce821e39cdeb33e1114a5731f4f39ad65b2abc76728a22acd965668db2ba8ad3029b0cd1054f65f4da5f2dc75b63b742dbebad73cb55f516e401099
+  metadata.gz: 0579666e4ec68db548a31483c4f23e66e7ae42a1c650eb4c73b20e5bd00c6a885682e339fd997c1f4abd8511dd0c2bba5d5ec0d15fd9e58b775d1e4ebf7bcf43
+  data.tar.gz: d57033fe692fb3e19b2e224ab053a4d10de5aac12af5cb4748d86aaef2d5d6440c0725e837de713bf4fd1af944bcc211e3ddabc97ff869a409c11faa0ad6ee6e

data/README.md

@@ -1,53 +1,79 @@
-Capistrano Maintenance Extension
-=================================
+Capistrano 2 Maintenance Extension
+==================================
 
-This gem simply offers the recently removed `deploy:web:disable` and `deploy:web:enable` tasks to your Capistrano deployment.
+This gem simply offers the recently removed `deploy:web:disable` and `deploy:web:enable` tasks to your Capistrano 2  deployment.
+
+**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).
 
 Usage
 -----
 
 Install the gem via rubygems:
 
-    gem install capistrano-maintenance
+```sh
+gem install capistrano-maintenance --version=0.0.5
+```
+
+or use bundler:
+
+```ruby
+# Gemfile
+gem 'capistrano-maintenance', '0.0.5', group: 'development'
+```
+
+```sh
+bundle install
+```
 
 And put this line into your deploy.rb file:
 
-    require 'capistrano/maintenance'
+```ruby
+require 'capistrano/maintenance'
+```
 
 Now, you can disable the web:
 
-    cap deploy:web:disable
+```sh
+cap deploy:web:disable
+```
 
 You can also specify a string to specify reason and how long it is until:
 
-    cap deploy:web:disable REASON="For server upgrades" UNTIL="3AM EST"
-
+```sh
+cap deploy:web:disable REASON="For server upgrades" UNTIL="3AM EST"
+```
 
 When maintenance is done, you can enable the web:
 
-    cap deploy:web:enable
+```sh
+cap deploy:web:enable
+```
 
 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`:
 
-    cap production deploy:web:disable
-    cap production deploy:web:enable
+```sh
+cap production deploy:web:disable
+cap production deploy:web:enable
+```
 
 Configuration
 -------------
 
 Everything should work out of the box general, but there are some additional adjustments you can make in your deploy.rb.
 
-    # change the default filename from maintenance.html to disabled.html
-    set :maintenance_basename, 'disabled'
+```ruby
+# change the default filename from maintenance.html to disabled.html
+set :maintenance_basename, 'disabled'
 
-    # change default directory from default of #{shared_path}/system
-    set :maintenance_dirname, "#{shared_path}/public/system"
+# change default directory from default of #{shared_path}/system
+set :maintenance_dirname, "#{shared_path}/public/system"
 
-    # use local template instead of included one with capistrano-maintenance
-    set :maintenance_template_path, 'app/views/maintenance.html.erb'
+# use local template instead of included one with capistrano-maintenance
+set :maintenance_template_path, 'app/views/maintenance.html.erb'
 
-    # disable the warning on how to configure your server
-    set :maintenance_config_warning, false
+# disable the warning on how to configure your server
+set :maintenance_config_warning, false
+```
 
 For your custom maintenance template, you have access to the following variables, if they're defined:
 

data/capistrano-maintenance.gemspec

@@ -1,6 +1,5 @@
 # encoding: utf-8
 $:.push File.expand_path("../lib", __FILE__)
-require "capistrano"
 require "capistrano/maintenance/version"
 
 Gem::Specification.new do |s|
@@ -17,5 +16,5 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency 'capistrano', ['>= 2.0.0']
+  s.add_dependency 'capistrano', ['~> 2.0']
 end

data/lib/capistrano/maintenance/version.rb

@@ -1,3 +1,5 @@
-module Capistrano::Maintenance
-  VERSION = "0.0.4"
+module Capistrano
+  module Maintenance
+    VERSION = "0.0.5"
+  end
 end

data/lib/capistrano/maintenance.rb

@@ -1,95 +1,92 @@
 require 'capistrano'
 
-module Capistrano::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
+module Capistrano
+  module Maintenance
 
-            reason = ENV['REASON']
-            deadline = ENV['UNTIL']
+    def self.load_into(configuration)
+      configuration.load do
 
-            template = File.read(maintenance_template_path)
-            result = ERB.new(template).result(binding)
+        _cset(:maintenance_dirname) { "#{shared_path}/system" }
+        _cset :maintenance_basename, "maintenance"
+        _cset(:maintenance_template_path) { File.join(File.dirname(__FILE__), "templates", "maintenance.html.erb") }
 
-            put result, "#{maintenance_dirname}/#{maintenance_basename}.html", :mode => 0644
-          end
+        namespace :deploy do
 
-          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
+          namespace :web do
 
-        end
+            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.
 
-      end
+              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:
 
-    end
+                $ cap deploy:web:disable \\
+                      REASON="hardware upgrade" \\
+                      UNTIL="12pm Central Time"
 
-  end
+              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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-maintenance
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 description: The deploy:web tasks where removed from Capistrano core. This extension
   brings them back.
 email: tvd@magiclabs.de
@@ -31,7 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - README.md
 - Rakefile
@@ -49,19 +49,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Offers deploy:web:disable and deploy:web:enable tasks for Capistrano.
 test_files: []
-has_rdoc: