rack-ensure_proper_host 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2011 - 2012 Spencer Steffen and Citrus Media Group.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    * Neither the name of Citrus Media Group nor the names of its
+      contributors may be used to endorse or promote products derived from this
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,98 @@
+# Rack::EnsureProperHost [![Build Status](https://secure.travis-ci.org/citrus/rack-ensure_proper_host.png)](http://travis-ci.org/citrus/rack-ensure_proper_host)
+
+Inspired by [rack-no-www](https://github.com/logicaltext/rack-no-www).
+
+------------------------------------------------------------------------------
+Usage
+------------------------------------------------------------------------------
+
+All of these examples will redirect all requests from *.example.com to example.com. Requests to secure.example.com will remain untouched.
+
+Rack::EnsureProperHost is middleware. Use it like this in your rack applications:
+
+
+### Rails
+
+```ruby
+# config/application.rb
+module MyApp
+  class Application < Rails::Application
+
+    config.middleware.insert_before Rack::Lock, Rack::EnsureProperHost, %w(example.com secure.example.com)
+        
+  end
+end
+```
+
+### Sinatra
+
+```ruby
+require 'sinatra'
+require 'rack/ensure_proper_host'
+
+use Rack::EnsureProperHost, %w(example.com secure.example.com)
+
+get '/hello' do
+  'Hello World'
+end
+```
+
+### Rack 
+
+Add the following to your `config.ru`
+
+```ruby
+# config.ru
+require 'your_app.rb'
+require 'rack/ensure_proper_host'
+
+use Rack::EnsureProperHost, %w(example.com secure.example.com)
+run YourApp.new
+```
+
+
+
+------------------------------------------------------------------------------
+Installation
+------------------------------------------------------------------------------
+
+As usual, just use the `gem install` command:
+
+```bash
+(sudo) gem install rack-ensure_proper_host
+```
+    
+Or add Rack::EnsureProperHost as a gem in your Gemfile:
+
+```bash
+gem 'rack-ensure_proper_host', '~> 0.1.0' 
+```
+
+Then run `bundle install`
+
+
+------------------------------------------------------------------------------
+Testing
+------------------------------------------------------------------------------
+
+Testing is done with minitest. Run the tests with:
+
+```bash
+rake
+```
+    
+
+------------------------------------------------------------------------------
+Changelog
+------------------------------------------------------------------------------
+
+**2012/1/20 - v0.1.0**
+
+- it exists!
+  
+
+------------------------------------------------------------------------------
+License
+------------------------------------------------------------------------------
+
+Copyright (c) 2011 - 2012 Spencer Steffen & Citrus, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "**/*_test.rb"  
+end
+
+task :default => [ :test ]

data/lib/rack-ensure_proper_host.rb

@@ -0,0 +1 @@
+require "rack/ensure_proper_host"

data/lib/rack/ensure_proper_host.rb

@@ -0,0 +1,28 @@
+require "rack/ensure_proper_host/version"
+
+module Rack
+  class EnsureProperHost
+  
+    def initialize(app, *hosts)
+      @app = app
+      @hosts = hosts.flatten
+    end
+  
+    def call(env)
+      @host = env['HTTP_HOST']    
+      if @hosts.include?(@host)
+        @app.call(env)
+      else
+        [ 301, request_with_proper_host(env), [ "Moved Permanently\n" ]]      
+      end    
+    end
+  
+    private
+      
+      def request_with_proper_host(env)
+        req = Rack::Request.new(env)
+        { 'Location' => req.url.sub(req.host, @hosts.first), 'Content-Type' => 'text/html' }
+      end
+  
+  end
+end

data/lib/rack/ensure_proper_host/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class EnsureProperHost
+    VERSION = "0.1.0"
+  end
+end

data/rack-ensure_proper_host.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/ensure_proper_host/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-ensure_proper_host"
+  s.version     = Rack::EnsureProperHost::VERSION
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = "https://github.com/citrus/rack-ensure_proper_host"
+  s.summary     = "Rack middleware for ensuring only proper hosts get passed to your application"
+  s.description = "Rack middleware for ensuring only proper hosts get passed to your application"
+
+  s.rubyforge_project = "rack-ensure_proper_host"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake",            "> 0"
+  s.add_development_dependency "bundler",         "> 0"
+  s.add_development_dependency "minitest",        "> 2"
+  s.add_development_dependency "minitest_should", "~> 0.3.0"
+  s.add_development_dependency "rack-test",       "~> 0.6"
+    
+end

data/test/rack/ensure_proper_host_test.rb

@@ -0,0 +1,98 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/should"
+
+require "rack/test"
+require "rack/ensure_proper_host"
+
+module Rack
+  class EnsureProperHostTest < MiniTest::Should::TestCase
+  
+    include Rack::Test::Methods
+    
+    MockApp = lambda { |env| [200, {}, [ "Hello, world." ]] }  
+    
+    def request_with_host(host, path="/")
+      request path, { "HTTP_HOST" => host }
+    end
+    
+    context "When used to ensure specific hosts" do
+    
+      def allowed_hosts
+        %w(www.example.org secure.example.org)
+      end
+      
+      def app
+        EnsureProperHost.new(MockApp, allowed_hosts)
+      end
+        
+      should "redirect to default host" do
+        request_with_host "example.org"
+        follow_redirect!
+        assert_equal "http://www.example.org/", last_request.url
+        assert last_response.redirect?
+      end
+      
+      should "redirect to default host for any non-allowed host" do
+        %w(something.example.org omg.wtf.bbq.example.com www2.exmple.com wwww.example.com).each do |host|
+          request_with_host host
+          follow_redirect!
+          assert_equal "http://www.example.org/", last_request.url
+          assert last_response.redirect?
+        end
+      end
+      
+      should "redirect to default host and keep path" do
+        request_with_host "example.org", "/some/crazy/path?wtf=1"
+        follow_redirect!
+        assert_equal "http://www.example.org/some/crazy/path?wtf=1", last_request.url
+        assert last_response.redirect?
+      end
+      
+      should "redirect and retain content type" do
+        request_with_host "example.org", "/some/crazy/path"
+        follow_redirect!
+        assert_equal "text/html", last_response.headers['Content-Type']
+      end
+      
+      should "redirect and return 301 move permanently" do
+        request_with_host "example.org"
+        follow_redirect!
+        assert_equal 301, last_response.status
+        assert_equal "Moved Permanently\n", last_response.body
+      end
+      
+      should "serve all allowed hosts without redirecting" do
+        allowed_hosts.each do |host|
+          request_with_host host
+          assert_equal "http://#{host}/", last_request.url
+          assert last_response.ok?
+        end
+      end
+      
+    end
+    
+    context "When used as no-www middleware" do
+      
+      def app
+        EnsureProperHost.new(MockApp, "example.org")
+      end
+      
+      should "redirect to non-www host" do
+        request_with_host "www.example.org"
+        follow_redirect!
+        assert_equal "http://example.org/", last_request.url
+        assert last_response.redirect?
+      end
+      
+      should "redirect to non-www host and keep path" do
+        request_with_host "www.example.org", "/some/crazy/path?wtf=1"
+        follow_redirect!
+        assert_equal "http://example.org/some/crazy/path?wtf=1", last_request.url
+        assert last_response.redirect?
+      end
+      
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rack-ensure_proper_host
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70202462779080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70202462779080
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70202462778540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70202462778540
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70202462778060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *70202462778060
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: &70202462777560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70202462777560
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70202462777060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70202462777060
+description: Rack middleware for ensuring only proper hosts get passed to your application
+email:
+- spencer@citrusme.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-ensure_proper_host.rb
+- lib/rack/ensure_proper_host.rb
+- lib/rack/ensure_proper_host/version.rb
+- rack-ensure_proper_host.gemspec
+- test/rack/ensure_proper_host_test.rb
+homepage: https://github.com/citrus/rack-ensure_proper_host
+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: rack-ensure_proper_host
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rack middleware for ensuring only proper hosts get passed to your application
+test_files:
+- test/rack/ensure_proper_host_test.rb