turnout 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c460890aea93aba76cd44000ff00038bbdca6b66
-  data.tar.gz: 7c409dc5de8a7ff7ebc6bffb7856aa37bec4dda5
+  metadata.gz: ac9fdc9be27c958015627a4af77649b9f0287522
+  data.tar.gz: af03a4ad0d8f762d8c64f456657455485f2b691e
 SHA512:
-  metadata.gz: b3e4086a25d42b4e838942c343e41f09c3fbf173a14cc509cf7f86611b42fbd22918fe919dda8c0092ed7c3d484e2fd99f80a2a57be42188dda42eee8e8e9832
-  data.tar.gz: 893483ca56460d50171c99520856c7e7434a303122aa3eda3d42c16bc5be018db4ee15d25cc6b15e1fcc65af05dfcab5274f6f873538d2e616ddf6b3ef828b2b
+  metadata.gz: 51ce8e2be2187cef06016585b2bb460fd2089d4ed7dacf6108ab5237d1742959aae542850bcb8e2da61e1bdfa41b32de780b5dcac64f8cfede82f02fb923e620
+  data.tar.gz: 08130e4a99769e06319e514d893991adc1451c965fcc155a5d5b08ba5f4510aa625f83498490211a5d445dd81d206fe996922587810b9f3c862262afc4df1a24

data/README.md

@@ -66,7 +66,7 @@ or
 or
 
     rake maintenance:start reason="Someone told me I should type <code>sudo rm -rf /</code>" allowed_paths="^/help,^/contact_us" allowed_ips="127.0.0.1,192.168.0.0/24"
-    
+
 or if you've configured `named_maintenance_file_paths` with a path named `server`
 
     rake maintenance:server:start
@@ -99,6 +99,7 @@ Turnout can be configured in two different ways:
     use Rack::Turnout,
       app_root: '/some/path',
       named_maintenance_file_paths: {app: 'tmp/app.yml', server: '/tmp/server.yml'},
+      maintenance_pages_path: 'app/views/maintenance',
       default_maintenance_page: Turnout::MaintenancePage::JSON,
       default_reason: 'Somebody googled Google!',
       default_allowed_paths: ['^/admin/'],
@@ -112,6 +113,7 @@ Turnout can be configured in two different ways:
     Turnout.configure do |config|
       config.app_root = '/some/path'
       config.named_maintenance_file_paths = {app: 'tmp/app.yml', server: '/tmp/server.yml'}
+      config.maintenance_pages_path = 'app/views/maintenance'
       config.default_maintenance_page = Turnout::MaintenancePage::JSON
       config.default_reason = 'Somebody googled Google!'
       config.default_allowed_paths = ['^/admin/']
@@ -129,6 +131,7 @@ Default Configuration
 Turnout.configure do |config|
   config.app_root = '.'
   config.named_maintenance_file_paths = {default: config.app_root.join('tmp', 'maintenance.yml').to_s}
+  config.maintenance_pages_path = config.app_root.join('public').to_s
   config.default_maintenance_page = Turnout::MaintenancePage::HTML
   config.default_reason = "The site is temporarily down for maintenance.\nPlease check back soon."
   config.default_allowed_paths = []
@@ -140,7 +143,10 @@ end
 Customization
 =============
 
-[Default maintenance pages](https://github.com/biola/turnout/blob/master/public/) are provided, but you can create your own `public/maintenance.[html|json]` files instead. If you provide a `reason` to the rake task, Turnout will parse the maintenance page file and attempt to replace a [Liquid](http://liquidmarkup.org/)-style `{{ reason }}` tag with the provided reason. So be sure to include a `{{ reason }}` tag in your `maintenance.html` file.
+[Default maintenance pages](https://github.com/biola/turnout/blob/master/public/) are provided, but you can create your own `public/maintenance.[html|json|html.erb]` files instead. If you provide a `reason` to the rake task, Turnout will parse the maintenance page file and attempt to replace a [Liquid](http://liquidmarkup.org/)-style `{{ reason }}` tag with the provided reason. So be sure to include a `{{ reason }}` tag in your `maintenance.html` file. In the case of a `.html.erb` file, `reason` will be a local variable.
+
+__WARNING:__
+The source code of any custom maintenance files you created in the `/public` directory will be able to be viewed by visiting that URL directly (i.e. `http://example.com/maintenance.html.erb`). This shouldn't be an issue with HTML and JSON files but with ERB files, it could be. If you're going to use a custom `.erb.html` file, we recommend you change the `maintenance_pages_path` setting to something other than the `/public` directory.
 
 Tips
 ====

data/lib/rack/turnout.rb

@@ -18,7 +18,7 @@ class Rack::Turnout
 
     if settings && !request.allowed?(settings)
       page_class = Turnout::MaintenancePage.best_for(env)
-      page = page_class.new(settings.reason)
+      page = page_class.new(settings.reason, env: env)
 
       page.rack_response(settings.response_code, settings.retry_after)
     else

data/lib/turnout/configuration.rb

@@ -1,7 +1,8 @@
 module Turnout
   class Configuration
-    SETTINGS = [:app_root, :named_maintenance_file_paths, :default_maintenance_page, :default_reason,
-                :default_allowed_paths, :default_response_code, :default_retry_after]
+    SETTINGS = [:app_root, :named_maintenance_file_paths,
+      :maintenance_pages_path, :default_maintenance_page, :default_reason,
+      :default_allowed_paths, :default_response_code, :default_retry_after]
 
     SETTINGS.each do |setting|
       attr_accessor setting
@@ -10,6 +11,7 @@ module Turnout
     def initialize
       @app_root = '.'
       @named_maintenance_file_paths = {default: app_root.join('tmp', 'maintenance.yml').to_s}
+      @maintenance_pages_path = app_root.join('public').to_s
       @default_maintenance_page = Turnout::MaintenancePage::HTML
       @default_reason = "The site is temporarily down for maintenance.\nPlease check back soon."
       @default_allowed_paths = []
@@ -36,4 +38,4 @@ module Turnout
       end
     end
   end
-end
+end

data/lib/turnout/maintenance_file.rb

@@ -36,7 +36,7 @@ module Turnout
     end
 
     def write
-      FileUtils.mkdir_p(dir_path) unless Dir.exists? dir_path
+      FileUtils.mkdir_p(dir_path) unless Dir.exist? dir_path
 
       File.open(path, 'w') do |file|
         file.write to_yaml
@@ -116,4 +116,4 @@ module Turnout
       Turnout.config.named_maintenance_file_paths
     end
   end
-end
+end

data/lib/turnout/maintenance_page.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 module Turnout
   module MaintenancePage
     require 'rack/accept'
@@ -11,14 +12,13 @@ module Turnout
 
       all_types = all.map(&:media_types).flatten
       best_type = request.best_media_type(all_types)
-
-      best = all.find { |page| page.media_types.include? best_type }
-
+      best = all.find { |page| page.media_types.include?(best_type) && File.exist?(page.new.custom_path) }
       best || Turnout.config.default_maintenance_page
     end
 
     require 'turnout/maintenance_page/base'
+    require 'turnout/maintenance_page/erb'
     require 'turnout/maintenance_page/html'
     require 'turnout/maintenance_page/json'
   end
-end
+end

data/lib/turnout/maintenance_page/base.rb

@@ -3,7 +3,8 @@ module Turnout
     class Base
       attr_reader :reason
 
-      def initialize(reason = nil)
+      def initialize(reason = nil, options = {})
+        @options = options.is_a?(Hash) ? options : {}
         @reason = reason
       end
 
@@ -24,6 +25,10 @@ module Turnout
       end
       def extension() self.class.extension end
 
+      def custom_path
+        Pathname.new(Turnout.config.maintenance_pages_path).join(filename)
+      end
+
       protected
 
       def self.inherited(subclass)
@@ -46,7 +51,7 @@ module Turnout
       end
 
       def content
-        file_content.gsub /{{\s?reason\s?}}/, reason
+         file_content.gsub /{{\s?reason\s?}}/, reason
       end
 
       def file_content
@@ -65,9 +70,6 @@ module Turnout
         File.expand_path("../../../../public/#{filename}", __FILE__)
       end
 
-      def custom_path
-        Turnout.config.app_root.join('public', filename)
-      end
 
       def filename
         "maintenance.#{extension}"

data/lib/turnout/maintenance_page/erb.rb

@@ -0,0 +1,18 @@
+require 'erb'
+require 'tilt'
+require 'tilt/erb'
+require_relative './html'
+module Turnout
+  module MaintenancePage
+    class Erb < Turnout::MaintenancePage::HTML
+
+      def content
+        Tilt.new(File.expand_path(path)).render(nil, {reason: reason}.merge(@options))
+      end
+
+      def self.extension
+        'html.erb'
+      end
+    end
+  end
+end

data/lib/turnout/maintenance_page/html.rb

@@ -1,3 +1,4 @@
+require_relative './base'
 module Turnout
   module MaintenancePage
     class HTML < Base
@@ -17,4 +18,4 @@ module Turnout
       end
     end
   end
-end
+end

data/lib/turnout/version.rb

@@ -1,3 +1,3 @@
 module Turnout
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/public/maintenance.html.erb

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Down for Maintenance</title>
+
+    <style type="text/css">
+
+      *{
+        font-family: Arial, Helvetica, sans-serif;
+      }
+
+      body{
+        margin: 0;
+        background-color: #fff;
+      }
+
+      #page{
+        position: relative;
+        width: 550px;
+        margin: 200px auto;
+        padding: 75px 0;
+        text-align: center;
+        background-color: #eaeaea;
+        border: solid 1px #ccc;
+        border-top: solid 10px #666;
+        -moz-box-shadow: inset 0 2px 10px #ccc;
+        -webkit-box-shadow: inset 0 2px 10px #ccc;
+        box-shadow: inset 0 2px 10px #ccc;
+      }
+
+      header, #body{
+        width: 400px;
+        margin: 0 auto;
+      }
+
+      h1{
+        margin: 0;
+        color: #CC3601;
+        font-size: 26pt;
+        border-bottom: solid 4px #666;
+      }
+
+      #reason{
+        margin: 10px 0;
+        color: #333;
+      }
+
+    </style>
+
+  </head>
+  <body>
+
+    <section id="page">
+
+      <header>
+        <h1>Down for Maintenance</h1>
+      </header>
+
+      <section id="body">
+        <div>
+          <%= reason %>
+        </div>
+      </section>
+
+    </section>
+
+  </body>
+</html>

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: turnout
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -97,12 +117,14 @@ files:
 - lib/turnout/maintenance_file.rb
 - lib/turnout/maintenance_page.rb
 - lib/turnout/maintenance_page/base.rb
+- lib/turnout/maintenance_page/erb.rb
 - lib/turnout/maintenance_page/html.rb
 - lib/turnout/maintenance_page/json.rb
 - lib/turnout/rake_tasks.rb
 - lib/turnout/request.rb
 - lib/turnout/version.rb
 - public/maintenance.html
+- public/maintenance.html.erb
 - public/maintenance.json
 homepage: https://github.com/biola/turnout
 licenses:
@@ -124,9 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Rack based maintenance mode plugin for Rails
 test_files: []
-has_rdoc: