rack-canonical-host 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## Rack::CanonicalHost 0.0.4
+
+  * Add option to ignored certain hosts ([Eric Allam][rubymaverick])
+  * Add tests ([Nathaniel Bibler][nbibler])
+  * Add HTML response body on redirect
+  * Set `Content-Type` header on redirect ([Jon Wood][jellybob])
+
+## Rack::CanonicalHost 0.0.3
+
+  * Allow `env` to be passed to the optional block
+
+## Rack::CanonicalHost 0.0.2
+
+  * Move `CanonicalHost` into `Rack` namespace
+
+## Rack::CanonicalHost 0.0.1
+
+  * Initial release
+
+[jellybob]: http://github.com/jellybob
+[nbibler]: http://github.com/nbibler
+[rubymaverick]: http://github.com/rubymaverick

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# Rack Canonical Host
+
+Rack middleware that lets you define a single host name as the canonical host
+for your application. Requests for other host names will then be redirected to
+the canonical host.
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+``` ruby
+gem 'rack-canonical-host'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-canonical-host
+
+
+## Usage
+
+For most applications, you can insert the middleware into the `config.ru` file
+in the root of the application.
+
+Here's a simple example of what the `config.ru` in a Rails application might
+look like after adding the `Rack::CanonicalHost` middleware.
+
+``` ruby
+require ::File.expand_path('../config/environment',  __FILE__)
+
+use Rack::CanonicalHost, 'example.com'
+run YourRailsApp::Application
+```
+
+In this case, any requests coming in that aren't for the specified host,
+`example.com`, will be redirected, keeping the requested path intact.
+
+
+### Environment-Specific Configuration
+
+You probably don't want your redirect to happen when developing locally. One
+way to prevent this from happening is to use environment variables in your
+production environment to set the canonical host name.
+
+With Heroku, you would do this like so:
+
+    $ heroku config:add CANONICAL_HOST=example.com
+
+Then, can configure the middleware like this:
+
+``` ruby
+use Rack::CanonicalHost, ENV['CANONICAL_HOST'] if ENV['CANONICAL_HOST']
+```
+
+Now, the middleware will only be used if a canonical host has been defined.
+
+
+### Options
+
+If you'd like the middleware to ignore certain hosts, use the `:ignore_hosts`
+option:
+
+``` ruby
+use Rack::CanonicalHost, 'example.com', ignored_hosts: ['api.example.com']
+```
+
+In this case, requests for the host `api.example.com` will not be redirected.
+
+Alternatively, you can pass a block whose return value will be used as the
+canonical host name.
+
+``` ruby
+use Rack::CanonicalHost do
+  case ENV['RACK_ENV'].to_sym
+    when :staging then 'example.com'
+    when :production then 'staging.example.com'
+  end
+end
+```
+
+
+## Contributors
+
+Thanks to the following people who have contributed patches or helpful
+suggestions:
+
+  * [Peter Baker](http://github.com/finack)
+  * [Jon Wood](http://github.com/jellybob)
+  * [Nathaniel Bibler](http://github.com/nbibler)
+  * [Eric Allam](http://github.com/rubymaverick)
+
+

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'

data/lib/rack-canonical-host.rb

@@ -1,30 +1 @@
-module Rack # :nodoc:
-  class CanonicalHost
-    def initialize(app, host=nil, &block)
-      @app = app
-      @host = host
-      @block = block
-    end
-
-    def call(env)
-      if url = url(env)
-        [301, { 'Location' => url }, ['Redirecting...']]
-      else
-        @app.call(env)
-      end
-    end
-
-    def url(env)
-      if (host = host(env)) && env['SERVER_NAME'] != host
-        url = Rack::Request.new(env).url
-        url.sub(%r{\A(https?://)(.*?)(:\d+)?(/|$)}, "\\1#{host}\\3/")
-      end
-    end
-    private :url
-
-    def host(env)
-      @block ? @block.call(env) || @host : @host
-    end
-    private :host
-  end
-end
+require 'rack/canonical_host'

data/lib/rack/canonical_host.rb

@@ -0,0 +1,48 @@
+require 'rack'
+
+module Rack # :nodoc:
+  class CanonicalHost
+    HTML_TEMPLATE = <<-HTML
+      <!DOCTYPE html>
+      <html lang="en-US">
+        <head><title>301 Moved Permanently</title></head>
+        <body>
+          <h1>Moved Permanently</h1>
+          <p>The document has moved <a href="%s">here</a>.</p>
+        </body>
+      </html>
+    HTML
+
+    def initialize(app, host=nil, options={}, &block)
+      @app = app
+      @host = host
+      @block = block
+      @ignored_hosts = options[:ignored_hosts] || []
+    end
+
+    def call(env)
+      if url = url(env)
+        [
+          301,
+          { 'Location' => url, 'Content-Type' => 'text/html' },
+          [HTML_TEMPLATE % url]
+        ]
+      else
+        @app.call(env)
+      end
+    end
+
+    def url(env)
+      if (host = host(env)) && env['SERVER_NAME'] != host && !@ignored_hosts.include?(env['SERVER_NAME'])
+        url = Rack::Request.new(env).url
+        url.sub(%r{\A(https?://)(.*?)(:\d+)?(/|$)}, "\\1#{host}\\3/")
+      end
+    end
+    private :url
+
+    def host(env)
+      @block ? @block.call(env) || @host : @host
+    end
+    private :host
+  end
+end

data/lib/rack/canonical_host/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class CanonicalHost
+    VERSION = '0.0.4'
+  end
+end

data/rack-canonical-host.gemspec

@@ -0,0 +1,17 @@
+require './lib/rack/canonical_host/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'rack-canonical-host'
+  gem.version = Rack::CanonicalHost::VERSION
+  gem.summary = 'Rack middleware for defining a canonical host name.'
+  gem.homepage = 'http://github.com/tylerhunt/rack-canonical-host'
+  gem.author = 'Tyler Hunt'
+
+  gem.add_dependency 'rack', '~> 1.0'
+  gem.add_development_dependency 'rspec', '~> 2.0'
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/spec/rack/canonical_host_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Rack::CanonicalHost do
+  let(:response) { [200, { 'Content-Type' => 'text/plain' }, 'OK'] }
+  let(:inner_app) { lambda { |env| response } }
+
+  def build_app(host=nil, options={}, inner_app=inner_app, &block)
+    Rack::Builder.new do
+      use Rack::Lint
+      use Rack::CanonicalHost, host, options, &block
+      run inner_app
+    end
+  end
+
+  shared_context 'matching and non-matching requests' do
+    context 'with a request to a matching host' do
+      let(:url) { 'http://example.com/full/path' }
+
+      it { should_not be_redirect }
+
+      it 'calls the inner app' do
+        inner_app.should_receive(:call).with(env).and_return(response)
+        subject
+      end
+    end
+
+    context 'with a request to a non-matching host' do
+      let(:url) { 'http://www.example.com/full/path' }
+
+      it { should be_redirect.via(301).to('http://example.com/full/path') }
+
+      it 'does not call the inner app' do
+        inner_app.should_not_receive(:call)
+        subject
+      end
+    end
+  end
+
+  context '#call' do
+    let(:env) { Rack::MockRequest.env_for(url) }
+
+    subject { app.call(env) }
+
+    context 'without any options' do
+      let(:app) { build_app('example.com') }
+
+      include_context 'matching and non-matching requests'
+    end
+
+    context 'with ignored hosts' do
+      let(:app) { build_app('example.com', ignored_hosts: ['example.net']) }
+
+      include_context 'matching and non-matching requests'
+
+      context 'with a request to an ignored host' do
+        let(:url) { 'http://example.net/full/path' }
+
+        it { should_not be_redirect }
+
+        it 'calls the inner app' do
+          inner_app.should_receive(:call).with(env).and_return(response)
+          subject
+        end
+      end
+    end
+
+    context 'with a block' do
+      let(:app) { build_app { 'example.com' } }
+
+      include_context 'matching and non-matching requests'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rack/canonical_host'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |file|
+  require(file)
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/support/matchers/be_redirect.rb

@@ -0,0 +1,67 @@
+module BeRedirect
+  class Matcher
+    attr :expected_status_code
+    attr :expected_location
+    attr :actual_status_code
+    attr :actual_location
+
+    def matches?(response)
+      @actual_status_code, headers, _ = response
+      @actual_location = headers['Location']
+
+      status_code_matches? && location_matches?
+    end
+
+    def via(expected_status_code)
+      @expected_status_code = expected_status_code
+      self
+    end
+
+    def to(expected_location)
+      @expected_location = expected_location
+      self
+    end
+
+    def description
+      if expected_status_code && expected_location
+        "redirect via #{expected_status_code} to #{expected_location.inspect}"
+      elsif expected_status_code
+        "redirect via #{expected_status_code}"
+      elsif expected_location
+        "redirect to #{expected_location.inspect}"
+      else
+        "be a redirect"
+      end
+    end
+
+    def failure_message_for_should
+      "Expected response to #{description}"
+    end
+
+    def failure_message_for_should_not
+      "Did not expect response to #{description}"
+    end
+
+    def status_code_matches?
+      if expected_status_code
+        actual_status_code == expected_status_code
+      else
+        actual_status_code.to_s =~ /^30[1237]$/
+      end
+    end
+    private :status_code_matches?
+
+    def location_matches?
+      !expected_location || (expected_location == actual_location)
+    end
+    private :location_matches?
+  end
+
+  def be_redirect
+    Matcher.new
+  end
+end
+
+RSpec.configure do |config|
+  config.include(BeRedirect)
+end

metadata

@@ -1,80 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-canonical-host
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Tyler Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-09 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: 
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
 - LICENSE
-- README.rdoc
+- README.md
+- Rakefile
 - lib/rack-canonical-host.rb
-has_rdoc: true
+- lib/rack/canonical_host.rb
+- lib/rack/canonical_host/version.rb
+- rack-canonical-host.gemspec
+- spec/rack/canonical_host_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_redirect.rb
 homepage: http://github.com/tylerhunt/rack-canonical-host
 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 
-      segments: 
-      - 0
-      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 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rack middleware for defining a canonical host name.
-test_files: []
-
+test_files:
+- spec/rack/canonical_host_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_redirect.rb

data/README.rdoc

@@ -1,32 +0,0 @@
-= Rack Canonical Host
-
-Rack Canonical Host is a bit of Rack middleware that lets you define a single
-host as the canonical host for your site, and redirect all other hostnames to
-that canonical host.
-
-In the simplest case, just specify the host name and any requests coming in
-that aren't for the host example.com will be rewritten with the proper host.
-
-    use Rack::CanonicalHost, 'example.com'
-
-You could also define a constant in your environment-specific configuration
-files to set up a canonical host redirect for only certain environments.
-
-    CANONICAL_HOST = 'example.com'
-
-Then, you can set up the middle are like this.
-
-    use Rack::CanonicalHost, CANONICAL_HOST if defined?(CANONICAL_HOST)
-
-Alternatively, you can pass a block whose return value will be used to set the
-canonical host.
-
-    use Rack::CanonicalHost do
-      case ENV['RACK_ENV'].to_sym
-        when :staging then 'example.com'
-        when :production then 'staging.example.com'
-      end
-    end
-
-
-Copyright (c) 2009 Tyler Hunt. See LICENSE for details.