turnout 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 093d5c969fb4f0ea26db9679f85d1eca0319f165
-  data.tar.gz: 42b2239d5572ec322177e82e321546402e0adf17
+  metadata.gz: 8033fc6c8101025a040f77b47beba1f1c709d544
+  data.tar.gz: 99ef866a762fa021409acd0fc5cebc55e0906b99
 SHA512:
-  metadata.gz: 3706cb1f72548de9f327ceac66c3e207b9820439789f66e338a4d0eaf8a6dfdd3b92acea36cf4dc1101dfbfed70dd2b28657dc976334ebf21c11311e8bf5dfe1
-  data.tar.gz: bc623d45eecb3f4ee28dfa26c6d28d276ffae6cfb17c662c0ce23e37c922288f9105af2695de9ea6187e4ee3e757fcbdded4a848ce6365b2ef3e5a7e58b6a1e6
+  metadata.gz: 904759426bb7b76da10209669cca7c0212819f929103ead32f19dd5c3dee93000f8573b71fa837bfdb3d5a485700706d01eaf2054693568d0760630b6e693080
+  data.tar.gz: b2f4de219c7c83a2ca2304354a608533a5b53ae1747a853557ccb398491bf0dce7f264775c6d27793f53f08a349283176070c21e9946d4ee009ae9ee38c9a394

data/README.md

@@ -101,7 +101,8 @@ Turnout can be configured in two different ways:
       named_maintenance_file_paths: {app: 'tmp/app.yml', server: '/tmp/server.yml'},
       default_maintenance_page: Turnout::MaintenancePage::JSON,
       default_reason: 'Somebody googled Google!',
-      default_response_code: 418
+      default_response_code: 418,
+      default_retry_after: 3600
     ```
 
 2. __Using a config block__
@@ -113,6 +114,7 @@ Turnout can be configured in two different ways:
       config.default_maintenance_page = Turnout::MaintenancePage::JSON
       config.default_reason = 'Somebody googled Google!'
       config.default_response_code = 418
+      config.default_retry_after = 3600
     end
     ```
 
@@ -128,6 +130,7 @@ Turnout.configure do |config|
   config.default_maintenance_page = Turnout::MaintenancePage::HTML
   config.default_reason = "The site is temporarily down for maintenance.\nPlease check back soon."
   config.default_response_code = 503
+  config.default_retry_after = 7200
 end
 ```
 
@@ -168,4 +171,5 @@ allowed_ips:
 - 127.0.0.1
 - 192.168.0.0/24
 response_code: 503
+retry_after: 3600
 ```

data/lib/rack/turnout.rb

@@ -20,7 +20,7 @@ class Rack::Turnout
       page_class = Turnout::MaintenancePage.best_for(env)
       page = page_class.new(settings.reason)
 
-      page.rack_response(settings.response_code)
+      page.rack_response(settings.response_code, settings.retry_after)
     else
       @app.call(env)
     end

data/lib/turnout/configuration.rb

@@ -1,6 +1,7 @@
 module Turnout
   class Configuration
-    SETTINGS = [:app_root, :named_maintenance_file_paths, :default_maintenance_page, :default_reason, :default_response_code]
+    SETTINGS = [:app_root, :named_maintenance_file_paths, :default_maintenance_page, :default_reason,
+                :default_response_code, :default_retry_after]
 
     SETTINGS.each do |setting|
       attr_accessor setting
@@ -12,6 +13,7 @@ module Turnout
       @default_maintenance_page = Turnout::MaintenancePage::HTML
       @default_reason = "The site is temporarily down for maintenance.\nPlease check back soon."
       @default_response_code = 503
+      @default_retry_after = 7200 # 2 hours by default
     end
 
     def app_root

data/lib/turnout/maintenance_file.rb

@@ -5,7 +5,7 @@ module Turnout
   class MaintenanceFile
     attr_reader :path
 
-    SETTINGS = [:reason, :allowed_paths, :allowed_ips, :response_code]
+    SETTINGS = [:reason, :allowed_paths, :allowed_ips, :response_code, :retry_after]
     attr_reader *SETTINGS
 
     def initialize(path)
@@ -14,6 +14,7 @@ module Turnout
       @allowed_paths = []
       @allowed_ips = []
       @response_code = Turnout.config.default_response_code
+      @retry_after = Turnout.config.default_retry_after
 
       import_yaml if exists?
     end
@@ -72,6 +73,10 @@ module Turnout
 
     private
 
+    def retry_after=(value)
+      @retry_after = value
+    end
+
     def reason=(reason)
       @reason = reason.to_s
     end

data/lib/turnout/maintenance_page/base.rb

@@ -7,8 +7,9 @@ module Turnout
         @reason = reason
       end
 
-      def rack_response(code = Turnout.config.default_response_code)
-        [code, headers, body]
+      def rack_response(code = nil, retry_after = nil)
+        code ||= Turnout.config.default_response_code
+        [code, headers(retry_after), body]
       end
 
       # Override with an array of media type strings. i.e. text/html
@@ -29,8 +30,11 @@ module Turnout
         MaintenancePage.all << subclass
       end
 
-      def headers
-        {'Content-Type' => media_types.first, 'Content-Length' => length}
+      def headers(retry_after = nil)
+        headers = {'Content-Type' => media_types.first, 'Content-Length' => length}
+        # Include the Retry-After header unless it wasn't specified
+        headers['Retry-After'] = retry_after.to_s unless retry_after.nil?
+        headers
       end
 
       def length

data/lib/turnout/version.rb

@@ -1,3 +1,3 @@
 module Turnout
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnout
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -129,4 +129,3 @@ signing_key:
 specification_version: 4
 summary: A Rack based maintenance mode plugin for Rails
 test_files: []
-has_rdoc: