rack_staging 0.1.1 → 0.2.0

data/README.mdown

@@ -1,18 +1,47 @@
-# Rack Staging
+# Rack::Staging
+
+Don't let users accidentally stumble upon your staging servers, make sure
+they're password protected.
 
 ## Usage
 
+Include the `Rack::Staging` middleware into your `config.ru` like so:
+
+    use Rack::Staging
+    run MyApp.new
+
+By default `Rack::Staging` will assume it's in a staging environment if the
+hostname for the request contains the string "staging", or if an environment
+variable of "STAGING" is set.
+
+Username and password for authentication should be set to "STAGING_USER" and
+"STAGING_PASS" environment variables respectively.
+
+Alternatively `Rack::Staging` accepts a `Proc` as a parameter which will be
+evaluated to determine whether an app is in your staging environment or not.
+Use this method to override the default behaviour:
+
+    use Rack::Staging, Proc.new{|env| env["HTTP_HOST"] == "foobar.example.org" }
+    run MyApp.new
+
 ## Why would I want to use this?
 
+Because it's easy to forget to make your staging server just *slightly*
+different from your production box by restricting access to it. Hopefully
+remembering to include this in your `Gemfile` is easier (I'll soon make it
+insert itself automatically into the middleware stack for Rails >= 3.x.x apps).
+
 ## Compatibility
 
+Only tested on Ruby 1.9.2
+
 ## Contributions
 
 * Glenn Gillen
 
 ## Status
 
-In Development
+Production Ready
 
 ## Bugs, Feature Requests, etc.
 

data/Rakefile

@@ -2,6 +2,8 @@ require 'rake'
 require 'rake/testtask'
 require 'rubygems'
 require 'rubygems/package_task'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 desc 'Default: run unit tests.'
 task :default => :test

data/lib/rack_staging.rb

@@ -1,51 +1,38 @@
 require 'rack'
 module Rack
-  class Staging
-
-    def initialize(app, staging_test = nil)
+  class Staging < Rack::Auth::Basic
+    def initialize(app, detect_proc = nil)
       @app = app
-      @staging_test = staging_test
-    end
-
-    def call(env)
-      return @app.call(env) unless staging?(env)
-      return robots_txt if robots_txt?(env)
-      return unauthorized unless authorized?(env)
-      @app.call(env)
-    end
 
-    private
-      def staging?(env)
-        return @staging_test.call(env) if @staging_test
+      @staging_detect = detect_proc || lambda do |env|
         env["HTTP_HOST"] =~ /staging/ || ENV["STAGING"]
       end
 
-      def robots_txt?(env)
-        env["PATH_INFO"] == "/robots.txt"
+      super app, 'staging' do |username, password|
+        [username, password] == [ENV["STAGING_USER"], ENV["STAGING_PASS"]]
+      end 
+    end
+    
+    def call(env)
+      @env = env
+      if @staging_detect.call(@env)
+        return robots_txt if robots_txt?(env)
+        super
+      else
+        @app.call(env)
       end
+    end
 
-      def robots_txt
-        body = <<-EOF
+    def robots_txt?(env)
+      env["PATH_INFO"] == "/robots.txt"
+    end
+
+    def robots_txt
+      body = <<-EOF
 User-agent: *
 Disallow: /
 EOF
-        [ 200, {'Content-Type' => 'text/plain'}, [body] ]
-      end
-
-      def authorized?(env)
-        @auth ||=  Rack::Auth::Basic::Request.new(env)
-        @auth.provided? &&
-          @auth.basic? &&
-          @auth.credentials &&
-          @auth.credentials == [ENV["STAGING_USER"], ENV["STAGING_PASS"]]
-      end
-
-      def unauthorized
-        [ 401,
-          {'Content-Type' => 'text/plain',
-           "WWW-Authenticate" => 'Basic realm="staging"' },
-          ["Unauthorized"] ]
-      end
-
+      [ 200, {'Content-Type' => 'text/plain'}, [body] ]
+    end
   end
 end

data/test/staging_test.rb

@@ -24,7 +24,7 @@ class RackStagingTest < Test::Unit::TestCase
   end
 
   def test_robots_txt_if_staging
-    header "HOST", "staging.example.org"
+    header "Host", "staging.example.org"
     get "/robots.txt"
     expected = <<-EOF
 User-agent: *
@@ -34,7 +34,7 @@ EOF
   end
 
   def test_requires_authentication_if_staging
-    header "HOST", "staging.example.org"
+    header "Host", "staging.example.org"
     get "/"
     assert_equal 401, last_response.status
   end
@@ -52,11 +52,11 @@ EOF
       use Rack::Staging, Proc.new{|env| env["HTTP_HOST"] =~ /foobar/ }
       run DummyApp.new
     end
-    header "HOST", "staging.example.org"
+    header "Host", "staging.example.org"
     get "/"
     assert_equal 200, last_response.status
 
-    header "HOST", "foobar.org"
+    header "Host", "foobar.org"
     get "/"
     assert_equal 401, last_response.status
   end
@@ -65,7 +65,7 @@ EOF
     ENV["STAGING_USER"] = "top"
     ENV["STAGING_PASS"] = "seecrets"
 
-    header "HOST", "staging.example.org"
+    header "Host", "staging.example.org"
     get "/"
     assert_equal 401, last_response.status
     authorize "top", "seecrets"

metadata

@@ -1,62 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack_staging
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Glenn Gillen
+- Chris Continanza
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-15 00:00:00 +01:00
-default_executable: 
+date: 2011-10-08 00:00:00.000000000Z
 dependencies: []
-
-description: Automatically protects your staging app from web crawlers and casual visitors.
+description: Automatically protects your staging app from web crawlers and casual
+  visitors.
 email: me@glenngillen.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.mdown
 - Rakefile
 - lib/rack_staging.rb
 - test/staging_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/glenngillen/rack_staging
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - .
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 2
 summary: Rack::Staging - Protects your staging apps from prying eyes.
-test_files: 
+test_files:
 - test/staging_test.rb
 - test/test_helper.rb