turnout 0.2.2 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adf33ca2dc98cb6fa15b8e17290193dd24f16795
+  data.tar.gz: abff4e95ca98a1dc8bc2d10e11eea6e677fb0724
+SHA512:
+  metadata.gz: 9d3f40a2d6701f652ffbddf93cb07f7b2d7ca7ce229b29283ad0079b51b1fbf948fdb597bfd36bd5000746b3dd1d74e3ffc48687c58c0a897f3b5e113ee3e164
+  data.tar.gz: eca42d7c3acb642cc8dc5aa68f5790838756279a74eb143268087172ec1d69c89f4e82486f3c3fdfef8afea462454be53a11d8acbf0cea198a51fadfb698c432

data/README.markdown

@@ -1,4 +1,4 @@
-Turnout
+Turnout [![Build Status](https://travis-ci.org/biola/turnout.png?branch=master)](https://travis-ci.org/biola/turnout)
 =======
 Turnout is a [Ruby on Rails](http://rubyonrails.org) engine with a [Rack](http://rack.rubyforge.org/) component that allows you to put your Rails app in maintenance mode.
 
@@ -11,6 +11,7 @@ Features
 * Allow certain paths to be accessible during maintenance
 * Easily override the default maintenance.html file with your own
 * Simple [YAML](http://yaml.org) based config file for easy activation, deactivation and configuration without the rake commands
+* Supports Rails 2.3 - 3.0 and Ruby 1.8.7 - 1.9.3
 
 Installation
 ============
@@ -23,7 +24,7 @@ In your `Gemfile` add:
 then run
 
     bundle install
-    
+
 Rails 2.3
 ---------
 In your `config/environment.rb` file add:
@@ -37,7 +38,7 @@ then run
 then in your `Rakefile` add:
 
     require 'turnout/rake_tasks'
-    
+
 
 Activation
 ==========
@@ -47,7 +48,7 @@ Activation
 or
 
     rake maintenance:start reason="Somebody googled Google!"
-    
+
 or
 
     rake maintenance:start allowed_paths="/login,^/faqs/[0-9]*"
@@ -78,6 +79,15 @@ Customization
 
 A [default maintenance page](https://github.com/biola/turnout/blob/master/public/maintenance.html) is provided, but you can create your own `public/maintenance.html` instead. If you provide a `reason` to the rake task, Turnout will use [Nokogiri](http://nokogiri.org) to parse the `maintenance.html` file and attempt to find a tag with `id="reason"`. It will replace the `inner_html` of the tag with the reason you provided. So be sure your `maintenance.html` file can be parsed as HTML.
 
+Tips
+====
+
+There is no `denied_paths` feature because turnout denies everyhing by default.
+However you can achieve the same sort of functionality by using
+[negative lookaheads](http://www.regular-expressions.info/lookaround.html) with the `allowed_paths` setting, like so:
+
+    rake maintenance:start allowed_paths="^(?!/your/under/maintenance/path)"
+
 Behind the Scenes
 =================
 On every request the Rack app will check to see if `tmp/maintenance.yml` exists. If the file exists the maintenance page will be shown (unless allowed IPs are given and the requester is in the allowed range).
@@ -96,4 +106,4 @@ Example maintenance.yml File
     - ^/contact_us
     allowed_ips:
     - 127.0.0.1
-    - 192.168.0.0/24
+    - 192.168.0.0/24

data/lib/rack/turnout.rb

@@ -4,7 +4,6 @@ require 'ipaddr'
 require 'nokogiri'
 
 class Rack::Turnout
-
   def initialize(app, config={})
     @app = app
     @config = config
@@ -12,7 +11,7 @@ class Rack::Turnout
 
   def call(env)
     reload_settings
-  
+
     if on?(env)
       [ 503, { 'Content-Type' => 'text/html', 'Content-Length' => content_length }, [content] ]
     else
@@ -21,13 +20,13 @@ class Rack::Turnout
   end
 
   protected
-  
+
   def on?(env)
     request = Rack::Request.new(env)
-    
+
     return false if path_allowed?(request.path)
     return false if ip_allowed?(request.ip)
-    File.exists? settings_file
+    maintenance_file_exists?
   end
 
   def path_allowed?(path)
@@ -68,6 +67,10 @@ class Rack::Turnout
     app_root.join('tmp', 'maintenance.yml')
   end
 
+  def maintenance_file_exists?
+    File.exists? settings_file
+  end
+
   def maintenance_page
     File.exists?(app_maintenance_page) ? app_maintenance_page : default_maintenance_page
   end
@@ -86,14 +89,13 @@ class Rack::Turnout
 
   def content
     content = File.open(maintenance_page, 'rb').read
-    
+
     if settings['reason']
       html = Nokogiri::HTML(content)
-      html.at_css('#reason').inner_html = settings['reason']
+      html.at_css('#reason').inner_html = Nokogiri::HTML.fragment(settings['reason'])
       content = html.to_s
     end
-    
+
     content
   end
-
-end
+end

data/lib/tasks/maintenance.rake

@@ -1,5 +1,4 @@
 namespace :maintenance do
-
   desc 'Enable the maintenance mode page ("reason", "allowed_paths" and "allowed_ips" can be passed as environment variables)'
   task :start do |t, args|
     settings = {
@@ -7,22 +6,22 @@ namespace :maintenance do
       'allowed_paths' => split_paths(ENV['allowed_paths']),
       'allowed_ips' => split_ips(ENV['allowed_ips'])
     }
-     
+
     file = File.open settings_file, 'w'
     file.write settings.to_yaml
     file.close
-    
+
     puts "Created #{settings_file}"
     puts "Run `rake maintenance:end` to stop maintenance mode"
   end
 
   desc 'Disable the maintenance mode page'
-  task :end do 
+  task :end do
     File.delete settings_file
-    
+
     puts "Deleted #{settings_file}"
   end
-  
+
   def settings_file
     Rails.root.join('tmp', 'maintenance.yml')
   end
@@ -42,5 +41,4 @@ namespace :maintenance do
   def split_ips(ips_string)
     ips_string.to_s.split(',')
   end
-
-end
+end

data/lib/turnout.rb

@@ -1,3 +1,3 @@
 module Turnout
-  require 'turnout/engine'
+  require 'turnout/engine' if defined? Rails
 end

data/lib/turnout/engine.rb

@@ -1,12 +1,9 @@
 require 'turnout'
 require 'rack/turnout'
-require 'rails' unless defined? Rails
+require 'rails'
 
 # For Rails 3
 if defined? Rails::Engine
-
-  require 'active_record'
-
   module Turnout
     class Engine < Rails::Engine
       initializer 'turnout.add_to_middleware_stack' do |app|
@@ -14,5 +11,4 @@ if defined? Rails::Engine
       end
     end
   end
-
-end
+end

data/lib/turnout/version.rb

@@ -1,5 +1,3 @@
 module Turnout
-
-  VERSION = '0.2.2'
-
+  VERSION = '0.2.3'
 end

data/public/maintenance.html

@@ -1,19 +1,20 @@
 <!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;
@@ -27,43 +28,43 @@
         -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 id="reason">
           <p>The site is temporarily down for maintenance.</p>
           <p>Please check back soon.</p>
         </div>
       </section>
-    
+
     </section>
-    
+
   </body>
-</html>
+</html>

metadata

@@ -1,28 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: turnout
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 0.2.3
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-29 00:00:00.000000000 -07:00
-default_executable: 
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &72111600 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *72111600
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
 description: Turnout makes it easy to put your Rails application into maintenance
   mode
 email: adam.crownoble@biola.edu
@@ -36,33 +79,31 @@ files:
 - lib/turnout.rb
 - lib/rack/turnout.rb
 - lib/turnout/version.rb
-- lib/turnout/rake_tasks.rb
 - lib/turnout/engine.rb
+- lib/turnout/rake_tasks.rb
 - lib/tasks/maintenance.rake
 - public/maintenance.html
-has_rdoc: true
 homepage: https://github.com/biola/turnout
 licenses: []
+metadata: {}
 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.6.2
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Rack based maintenance mode plugin for Rails
 test_files: []