rack-maintenance 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00d9c81cf601e50ec54555b564e842dfff9eaff9
-  data.tar.gz: b95a117e0726e15354f091c1b8a6e1fb6b58fac5
+SHA256:
+  metadata.gz: 3e7ae1d29d3548b2408d75ed5448791d2b0ad2495c09573b822d3d761e5e1c56
+  data.tar.gz: 81f58cd2d0e9980b6c52980390ad55bb591bbe5ee7a53d541d1886c70fa6609d
 SHA512:
-  metadata.gz: 018311df2e17fea006d1e638ee1e0b15c57c9b68ee2cff5d763c74291f9bc4f035a5d65e15baebc4069fffc8ddecd029f4ddfcdbb014c9882a94b178cd7690ca
-  data.tar.gz: 45d6334d82a8fe3a25e87f11c0823b5a24044a7b069feb738b3355905fc9fd494d203744b91e375d29a935250aab633806518c90f984f8d5a09bf3ce752bc3d1
+  metadata.gz: 2742569f5de877db92511d930e763a26a3e98a0717b62d4d787b5b02327272c2de6f9faae4859ab748b1afc31ee074d57854cc3d67998cebfbe7faeef5d78a5a
+  data.tar.gz: 33ce46fd7d5480d5da8d95f97269331fec8bdb29330ba3ffe27b7007f1b6f8474a593091bd61562f44ef6f180e96679b1ed4e28b002415c35fd0240b21f73f1f

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2009 David Dollar
+Copyright (c) 2012 - 2022 Joost Baaij
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -3,7 +3,7 @@
 Rack::Maintenance is a simple Rack middleware to detect the existence of a
 maintenance page and display that instead of incoming requests.
 
-{<img src="https://secure.travis-ci.org/tilsammans/rack-maintenance.png" />}[http://travis-ci.org/tilsammans/rack-maintenance]
+{<img src="https://travis-ci.org/tilsammans/rack-maintenance.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/tilsammans/rack-maintenance]
 
 == Installation
 
@@ -30,6 +30,14 @@ and then run `bundle`.
    :file => Rails.root.join('public', 'maintenance.json'),
    :env  => 'MAINTENANCE'
 
+ # You may provide an object that responds to call to provide
+ # post-processing of the maintenance page such as merging
+ # ENV values into the page through ERB
+ config.middleware.use 'Rack::Maintenance',
+   :file => Rails.root.join('public', 'maintenance.html.erb'),
+   :env  => 'MAINTENANCE',
+   :processor => lambda { |content| ERB.new(content).result }
+
 If <tt>:env</tt> is specified, all requests will be shown the
 maintenance page if the environment variable is set.
 
@@ -42,10 +50,6 @@ If <tt>:env</tt> is not specified, the maintenance page will be shown if it exis
    :file => Rails.root.join('public', 'maintenance.html'),
    :without => /\A\/assets/
 
-If <tt>:paths</tt> is specified, only the paths specified in the given regular
-expression will be put on maintenance mode. This is useful if you still want
-access to an admin interface, as shown on the example.
-
 == Note on Patches/Pull Requests
 
 * Fork the project.
@@ -55,6 +59,10 @@ access to an admin interface, as shown on the example.
 * Push your branch.
 * Send me a pull request.
 
+== Space Babies
+
+We create internet. http://www.spacebabies.nl
+
 == License
 
 BSD. See LICENSE for details.

data/lib/rack/maintenance/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Maintenance
-    VERSION = "2.0.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/rack/maintenance.rb

@@ -13,8 +13,9 @@ class Rack::Maintenance
 
   def call(env)
     if maintenance? && path_in_app(env)
-      data = File.read(file)
-      [ 503, { 'Content-Type' => content_type, 'Content-Length' => data.length.to_s }, [data] ]
+      content = File.read(file)
+      data = processor.call(content)
+      [ 503, { 'Content-Type' => content_type, 'Content-Length' => data.bytesize.to_s }, [data] ]
     else
       app.call(env)
     end
@@ -34,6 +35,10 @@ private ######################################################################
     options[:file]
   end
 
+  def processor
+    options[:processor] || lambda { |content| content }
+  end
+
   def maintenance?
     environment ? ENV[environment] : File.exists?(file)
   end

data/spec/rack-maintenance_spec.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 shared_examples "RackMaintenance" do
   let(:app) { Class.new { def call(env); end }.new }
   let(:rack) { Rack::Maintenance.new(app, :file => file_name) }
+  let(:data) { data = File.read(file_name) }
 
   context "without a :file option" do
     it "raises an error" do
@@ -14,6 +15,10 @@ shared_examples "RackMaintenance" do
   end
 
   context "without maintenance file" do
+    before do
+      FileUtils.rm(file_name) if File.exists?(file_name)
+    end
+
     it "calls the app" do
       app.should_receive(:call).once
       rack.call({})
@@ -35,7 +40,7 @@ shared_examples "RackMaintenance" do
     end
 
     it "returns the maintenance response" do
-      rack.call({}).should eq [503, {"Content-Type"=>content_type, "Content-Length"=>"0"}, [""]]
+      rack.call({}).should eq [503, {"Content-Type"=>content_type, "Content-Length"=>data.bytesize.to_s}, [data]]
     end
 
     context "and :env option MAINTENANCE" do
@@ -61,6 +66,18 @@ shared_examples "RackMaintenance" do
           app.should_not_receive :call
           rack.call({})
         end
+
+        context "and :processor option" do
+          let(:processor) { lambda { |content| ERB.new(content).result } }
+          let(:rack) do
+            Rack::Maintenance.new(app, :file => file_name, :processor => processor )
+          end
+
+          it "passes the file content to the processor" do
+            processor.should_receive(:call).with(data).and_call_original
+            rack.call({})
+          end
+        end
       end
     end
 
@@ -98,3 +115,12 @@ describe "RackMaintenance with html maintenance file" do
   end
 end
 
+describe "RackMaintenance with unicode maintenance file" do
+  before do
+    FileUtils.cp 'spec/unicode.html', 'spec/maintenance.html'
+  end
+  it_behaves_like "RackMaintenance" do
+    let(:file_name) { "spec/maintenance.html" }
+    let(:content_type) { "text/html" }
+  end
+end

data/spec/unicode.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Under Maintenance</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+</head>
+
+<body>
+  <div class="dialog">
+    <h1>ขณะนี้กำลังอยู่ระหว่างการปรับปรุงระบบ</h1>
+  </div>
+</body>
+</html>

metadata

@@ -1,42 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: rack-maintenance
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - David Dollar
 - Joost Baaij
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Detect and show a maintenance page
@@ -47,18 +61,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rack/maintenance/version.rb
-- lib/rack/maintenance.rb
-- lib/rack-maintenance.rb
 - LICENSE
-- Rakefile
 - README.rdoc
+- Rakefile
+- lib/rack-maintenance.rb
+- lib/rack/maintenance.rb
+- lib/rack/maintenance/version.rb
 - spec/rack-maintenance_spec.rb
 - spec/spec_helper.rb
+- spec/unicode.html
 homepage: http://github.com/tilsammans/rack-maintenance
 licenses: []
 metadata: {}
-post_install_message: |2+
+post_install_message: |+
+  ******** Rack::Maintenance 3.0.0 *********
+
+  This gem now requires rack version 2.1.4 or higher.
+
+  The reason for this change is that earlier versions have
+  security vulnerabilities. Because of this major change, I
+  took the time to require up-to-date versions of all
+  dependencies.
+
+  Rack::Maintenance 3.0.0 should be a drop-in upgrade.
+
 
   ******** Rack::Maintenance 2.0.0 *********
 
@@ -78,20 +104,21 @@ 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.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Detect and show a maintenance page
 test_files:
 - spec/rack-maintenance_spec.rb
 - spec/spec_helper.rb
+- spec/unicode.html
+...