rack-killswitch 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+gem "rack", ">= 1.1.0"
+
+# Development-only dependencies
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.1)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rack (>= 1.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rawnet
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+= rack-killswitch
+
+Live broadcast on app showing fire and blood everywhere? Image hosting site flooded with pornography? Or some other urgent reason to take your app offline in a hurry?
+
+rack-killswitch to the rescue. Just add this to your app:
+  
+  # config/environment.rb
+  config.middleware.use 'Rack::Killswitch',
+       :trigger => Rails.root.join('.kill'),
+       :page    => Rails.root.join('public', 'holding.html')
+
+Now, lean back in the comfort of knowing that should excrement hit the rotating device, you can just:
+
+1. touch RAILS_ROOT/.kill (via SSH or have your app admin controller do it if you want to give that power to the users)
+2. Rejoice in the sudden absence of blood and gore on your website as all requests return the contents of holding.html.
+
+Because it's Rack middleware and doesn't ever access the DB, it'll work whether you're using nginx or Apache and do it's job even if your latest commit f'ed up the Rails app, the host lost your DB and the Queen annexed Iceland.
+
+== <steve_jobs>One more thing...</steve_jobs>
+
+Sometimes you'll want to access the app yourself though, just not have it open to the nosy public (screw 'em). The :override_path option sets a path that, when accessed, sets a cookie that will allow you access to the site for as long as you have the cookie and "bypass" the killswitch:
+
+  # config/environment.rb
+  config.middleware.use 'Rack::Killswitch',
+     :trigger => Rails.root.join('.kill'),
+     :page    => Rails.root.join('public', 'holding.html'),
+     :override_path => '/letmein'
+
+Go to 'http://www.wherever.com/letmein' and you're sorted for 24 hours.
+
+== Installation
+
+Rails? Good. Bundle it, and you're sorted.
+
+== Contributing to rack-killswitch
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Rawnet. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "rack-killswitch"
+  gem.homepage = "http://github.com/rawnet/rack-killswitch"
+  gem.license = "MIT"
+  gem.summary = %Q{Rack middleware to disable access to a site with a twist}
+  gem.description = %Q{Live broadcast on app showing fire and blood everywhere? Image hosting site flooded with pornography? Or some other urgent reason to take your app offline in a hurry? rack-killswitch to the rescue.}
+  gem.email = "christian@rawnet.com"
+  gem.authors = ["Christian Sutter"]
+  gem.add_runtime_dependency 'rack', '>= 1.1.0'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rack-killswitch.rb

@@ -0,0 +1 @@
+require 'rack/killswitch'

data/lib/rack/killswitch.rb

@@ -0,0 +1,50 @@
+require 'rack'
+
+# Killswitch is a Rack Middleware to disable access to a Rails (or Rack) app
+#   Inspired by rack-maintenance - https://github.com/ddollar/rack-maintenance
+#   (Credit where credit is due!)
+
+class Rack::Killswitch
+  attr_reader :app, :options
+  
+  def initialize(app, options={})
+    @app     = app
+    @options = options
+
+    raise(ArgumentError, 'Must specify a trigger file (:trigger)') unless options[:trigger]
+    raise(ArgumentError, 'Must specify a holding page (:page)') unless options[:page]
+  end
+  
+  def call(env)
+    # If the site is down and the user visits the defined override path, set a cookie so he can get in
+    if down? and options[:override_path] and env['REQUEST_URI'] == options[:override_path]
+      # HTTP 303: "See Other" 
+      # The response to the request can be found under a different URI and SHOULD be retrieved using a
+      # GET method on that resource. The new URI is not a substitute reference for the originally requested
+      # resource. The 303 response MUST NOT be cached.
+      response = Rack::Response.new([''], 303, { 'Location' => '/', 'Content-Length' => '0' })
+      response.set_cookie("override_killswitch", {:value => "true", :path => "/", :expires => Time.now+24*60*60})
+      response.finish
+    elsif down? and not cookie_set?(env)
+      # Ensure holding page exists
+      raise "Holding page file #{options[:page]} does not exist" unless File.exists?(options[:page])
+      
+      # Get what's in there and send it over to the unsuspecting user
+      data = File.read(options[:page])
+      [ 503, { 'Content-Type' => 'text/html', 'Content-Length' => data.length.to_s }, [data] ] 
+    else
+      # Business as usual
+      app.call(env)
+    end
+  end
+  
+  private
+  def cookie_set?(env)
+    # true as String because it's a cookie!
+    Rack::Request.new(env).cookies['override_killswitch'] == "true"
+  end
+
+  def down?
+    File.exists?(options[:trigger])
+  end
+end

data/rack-killswitch.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-killswitch}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christian Sutter"]
+  s.date = %q{2011-03-10}
+  s.description = %q{Live broadcast on app showing fire and blood everywhere? Image hosting site flooded with pornography? Or some other urgent reason to take your app offline in a hurry? rack-killswitch to the rescue.}
+  s.email = %q{christian@rawnet.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rack-killswitch.rb",
+    "lib/rack/killswitch.rb",
+    "rack-killswitch.gemspec"
+  ]
+  s.homepage = %q{http://github.com/rawnet/rack-killswitch}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rack middleware to disable access to a site with a twist}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 1.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<rack>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rack>, [">= 1.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rack>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 1.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rack>, [">= 1.1.0"])
+  end
+end
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: rack-killswitch
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Christian Sutter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rack
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rack
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  requirement: *id004
+description: Live broadcast on app showing fire and blood everywhere? Image hosting site flooded with pornography? Or some other urgent reason to take your app offline in a hurry? rack-killswitch to the rescue.
+email: christian@rawnet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-killswitch.rb
+- lib/rack/killswitch.rb
+- rack-killswitch.gemspec
+has_rdoc: true
+homepage: http://github.com/rawnet/rack-killswitch
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack middleware to disable access to a site with a twist
+test_files: []
+