rack_staging 0.1.0

data/README.mdown

@@ -0,0 +1,51 @@
+# Rack Staging
+
+## Usage
+
+## Why would I want to use this?
+
+## Compatibility
+
+## Contributions
+
+* Glenn Gillen
+
+## Status
+
+In Development
+
+## Bugs, Feature Requests, etc.
+
+If you think you've found a bug or have a feature you'd like to contribute
+here are the ways to let me know, in order of likelihood for a speedy
+resolution:
+
+* Fork the repo, add a test, implement the feature, send me a pull request
+* Fork the repo, add a failing test, send me a pull request
+* Create an issue on Github.
+
+## License
+
+Rack Staging is released under the MIT license.
+
+Copyright (c) 2011 Glenn Gillen
+
+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.
+ObjectBouncer
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubygems'
+require 'rubygems/package_task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test Rack::Staging'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+spec_data = File.open('rack_staging.gemspec').read
+spec = nil
+Thread.new do
+  spec = eval("#{spec_data}")
+end.join
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end

data/lib/rack_staging.rb

@@ -0,0 +1,49 @@
+require 'rack'
+module Rack
+  class Staging
+
+    def initialize(app, staging_test = 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
+        env["HTTP_HOST"] =~ /staging/ || ENV["STAGING"]
+      end
+
+      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'}, ["Unauthorized"] ]
+      end
+
+
+  end
+end

data/test/staging_test.rb

@@ -0,0 +1,78 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
+require "test_helper"
+
+class DummyApp
+
+  def call(env)
+    [ 200, {'Content-Type' => 'text/plain'}, ['this is from DummyApp'] ]
+  end
+end
+
+class RackStagingTest < Test::Unit::TestCase
+
+  def app
+    @app ||= Rack::Builder.new do
+      use Rack::Staging
+      run DummyApp.new
+    end
+  end
+
+  def test_passes_through_to_other_middleware_if_not_staging
+    get "/"
+    assert_equal 200, last_response.status
+    assert_equal "this is from DummyApp", last_response.body
+  end
+
+  def test_robots_txt_if_staging
+    header "HOST", "staging.example.org"
+    get "/robots.txt"
+    expected = <<-EOF
+User-agent: *
+Disallow: /
+EOF
+    assert_equal expected, last_response.body
+  end
+
+  def test_requires_authentication_if_staging
+    header "HOST", "staging.example.org"
+    get "/"
+    assert_equal 401, last_response.status
+  end
+
+  def test_requires_authentication_if_env_var_set
+    ENV["STAGING"] = "true"
+    get "/"
+    assert_equal 401, last_response.status
+  ensure
+    ENV.delete("STAGING")
+  end
+
+  def test_requires_authentication_if_proc_returns_true
+    @app = Rack::Builder.new do
+      use Rack::Staging, Proc.new{|env| env["HTTP_HOST"] =~ /foobar/ }
+      run DummyApp.new
+    end
+    header "HOST", "staging.example.org"
+    get "/"
+    assert_equal 200, last_response.status
+
+    header "HOST", "foobar.org"
+    get "/"
+    assert_equal 401, last_response.status
+  end
+
+  def test_auths_based_on_env_settings
+    ENV["STAGING_USER"] = "top"
+    ENV["STAGING_PASS"] = "seecrets"
+
+    header "HOST", "staging.example.org"
+    get "/"
+    assert_equal 401, last_response.status
+    authorize "top", "seecrets"
+    get "/"
+    assert_equal 200, last_response.status
+  ensure
+    ENV.delete("STAGING_USER")
+    ENV.delete("STAGING_PASS")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'rack/test'
+require 'rack/builder'
+require "#{File.dirname(__FILE__)}/../lib/rack_staging"
+
+module Test
+  module Unit
+    class TestCase
+      include Rack::Test::Methods
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: rack_staging
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Glenn Gillen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-15 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Automatically protects your staging app from web crawlers and casual visitors.
+email: me@glenngillen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_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: 
+- .
+- 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.0
+signing_key: 
+specification_version: 2
+summary: Rack::Staging - Protects your staging apps from prying eyes.
+test_files: 
+- test/staging_test.rb
+- test/test_helper.rb