proxy 1.3.3

data/CHANGELOG

@@ -0,0 +1,94 @@
+2009-06-05 - Sean Huber (shuber@huberry.com)
+  * Add multiple domain support for rack
+  * Update gemspec
+  * Update README
+
+2009-06-04 - Sean Huber (shuber@huberry.com)
+  * Update test related rake tasks
+  * Remove huberry namespace
+  * Add support for multiple domains
+  * Update README
+
+2009-05-20 - Sean Huber (shuber@huberry.com)
+  * Update date in gemspec so github rebuilds gem
+
+2009-05-18 - Sean Huber (shuber@huberry.com)
+  * Fix compatibility issues with actionpack >= 2.2.2
+
+2009-01-24 - Sean Huber (shuber@huberry.com)
+  * Add compatibility for edge/upcoming rails versions
+
+2009-01-08 - Sean Huber (shuber@huberry.com)
+  * Add Proxy namespace
+  * Remove .gitignore
+
+2008-12-09 - Sean Huber (shuber@huberry.com)
+  * Update README
+
+2008-12-08 - Sean Huber (shuber@huberry.com)
+  * Fix bug - lib/proxy.rb was not included in gemspec
+
+2008-11-14 - Sean Huber (shuber@huberry.com)
+  * Fix bug - "redirect_to some_path" now uses a forwarded host if it exists
+  * Gemify
+  * Update README
+  * Update proxy.gemspec
+
+2008-10-30 - Sean Huber (shuber@huberry.com)
+  * Update documentation
+  * Move the logic that calculates the session_domain into its own method and update documentation
+  * Update README
+
+2008-10-27 - Sean Huber (shuber@huberry.com)
+  * rewrite_url also adds the :host option as options is a Hash
+  * Move the logic that calculates the proxy_relative_url_root into its own method
+
+2008-10-21 - Sean Huber (shuber@huberry.com)
+  * Fix bug - only add the :host option to url_helper if options is a Hash
+
+2008-10-06 - Sean Huber (shuber@huberry.com)
+  * Add tests to ensure asset helpers work correctly
+
+2008-10-05 - Sean Huber (shuber@huberry.com)
+  * Add failing named route test
+  * Named routes now work with forwarded hosts
+  * ActionView::Base#url_for uses forwarded hosts correctly
+  * Update README
+  * Update init.rb
+
+2008-10-03 - Sean Huber (shuber@huberry.com)
+  * Add tests to ensure default host and relative_url_root are restored when an action redirects
+  * Update README
+  * The original session_domain is now restored after each request
+
+2008-10-02 - Sean Huber (shuber@huberry.com)
+  * Remove Dispatcher and moved that logic into Base
+  * Add Rakefile
+  * Fix bug - referred to ActionController instead of ActionController::Base
+  * Fix bug - plugin was not being loaded properly
+  * Update README
+  * Fix bug - proxy_relative_url_root was not being set on every request
+  * Fix bug - relative_url_root was always being delegated to ActionController::AbstractRequest
+
+2008-10-01 - Sean Huber (shuber@huberry.com)
+  * Move some forwarded host logic into AbstractRequest
+  * Add AbstractRequest tests and renamed BaseTest file
+  * Add more AbstractRequest tests
+  * ActionController::Base will delegate relative_url_root to AbstractRequest if necessary to support older versions of actionpack
+  * Add more Base tests
+  * Reorder requires and inclusions in proxy.rb
+  * Update CHANGELOG
+  * Update README
+  * Add UrlRewriter
+  * Add more tests
+
+2008-09-29 - Sean Huber (shuber@huberry.com)
+  * Initial import
+  * Add some tests - still need to figure out how to test Dispatcher
+  * Base automatically detects HTTP_X_FORWARDED_URI and determines relative_url_root (can be overwritten)
+  * Update Base tests
+  * Base can now parse a comma separated string of forwarded uris
+  * The HTTP_X_FORWARDED_URI variable name can be changed to something else
+  * Update README
+  * Regex to determine relative root url is now properly escaped
+  * Fix bug - Base was not setting the class relative_url_root correctly

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean Huber (shuber@huberry.com)
+
+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.markdown

@@ -0,0 +1,90 @@
+# Proxy
+
+A gem/plugin that allows rails applications to dynamically respond to multiple domains and proxied requests by detecting forwarded host/uri headers and setting the session domain, default host, and relative url root. The plugin adds this functionality to calls to url\_for, named route helpers, and view url helpers while still allowing you to specifically set the :host and :only\_path options to override this behavior.
+
+The original session domain, default host, and relative url root will be restored after each request.
+
+Requires actionpack >= 2.0.0
+
+
+## Installation
+
+	script/plugin install git://github.com/shuber/proxy.git
+	OR
+	gem install proxy
+
+
+## Usage
+
+### Proxied Requests
+
+Let's say you have a suite of hosted applications all running on the same domain but mounted on different paths. One of them is an order/invoicing application located at:
+
+	http://client.example.com/orders
+
+Imagine you sold an account to a client but the client wants the application to look like its running on his own domain, so they'll set up a proxy so they can access your application at:
+
+	http://clientdomain.com/orders
+
+This plugin will automatically detect this forwarded host and set the session domain and default host (for url generation) accordingly.
+
+
+### Proxied Requests with Custom URIs
+
+Now imagine the client had an existing ordering system already running at /orders, and he wants to slowly migrate his data into your application, so he'll need both applications running for awhile. He wants to keep his original ordering application running at /orders and he wants your application running at:
+
+	http://clientdomain.com/neworders
+
+All the client has to do is proxy /neworders to http://client.example.com/orders and this plugin will automatically detect the forwarded request uri and set the relative url root for your application accordingly. Now whenever urls are generated, they will correctly use /neworders as the relative url root instead of /orders.
+
+Note: this plugin looks for a request header called 'HTTP\_X\_FORWARDED\_URI' to detect the relative root url by default, but this can be overwritten like so:
+
+	ActionController::AbstractRequest.forwarded_uri_header_name = 'SOME_CUSTOM_HEADER_NAME'
+
+You can add that line in environment.rb or an initializer.
+
+
+#### Relative Url Root Proxy Setup
+
+The client's proxy must forward the request uri header in order for this plugin to automatically set the relative url root correctly. Here is how the client would setup a proxy in apache for the example above:
+
+	RewriteRule ^neworders(.*) http://client.example.com/orders$1 [P,QSA,L,E=originalUri:%{REQUEST_URI}]
+	RequestHeader append X_FORWARDED_URI %{originalUri}e e=originalUri
+
+
+### Multiple Domains
+
+Imagine you have a CMS that hosts multiple client sites. You want your users to manage their sites on your root domain `http://yourcmsapp.com` and you display a site's public content when it's accessed by its subdomain (e.g. `http://cool-site.yourcmsapp.com`). You'll probably be using [subdomain-fu](http://github.com/mbleigh/subdomain-fu) so you can route based on subdomains like:
+
+	ActionController::Routing::Routes.draw do |map|
+	  # this routing controller has a before_filter callback that looks up a site by subdomain
+	  map.public_page '*path', :controller => 'routing', :conditions => { :subdomain => /^[^\.]+$/ }
+	
+	  map.with_options :conditions => { :subdomain => nil } do |admin|
+	    admin.resource :account, :controller => 'account'
+	    admin.resources :sites
+	    ...
+	  end
+	end
+
+Now, it gets tricky if you want `http://cool-site.com` to render `cool-site`'s public content because you can't tell if this request has a subdomain or not. In order for your routes to work, you must have all requests coming in from your domain `yourcmsapp.com`. You can accomplish this by calling the `Proxy.replace_host_with(&block)` method like so:
+
+	# config/initializers/proxy.rb
+        
+	Proxy.replace_host_with do |request|
+	  "#{Site.find_by_domain(request.host).try(:subdomain) || '-INVALID-'}.yourcmsapp.com" unless request.host =~ /(\.|^)yourcmsapp.com$/i
+	end
+
+Let's examine what this block is doing:
+
+* First, it checks if the current request's host is already on your domain. If it is, we don't need to do anything, otherwise...
+* It checks if a site exists with a domain that matches the current request's host.
+* If a site does exist, a new host is returned using the site's `subdomain` with your app domain and everything renders fine, otherwise...
+* A fake host is returned (-INVALID-.yourcmsapp.com), and the request 404s once it gets to your `routing` controller and a site can't be found with the subdomain `-INVALID-`
+
+If `nil, false, or an empty string` is returned when you call the `Proxy.replace_host_with` method, the current request's host is not modified. Otherwise, the `HTTP_X_FORWARDED_HOST` request header is set to: `"#{the_original_host}, #{the_new_host}"`. This allows your routes to use your domain when evaluating routing conditions and also allows all of the application's url generators to use the original host.
+
+
+## Contact
+
+Problems, comments, and suggestions all welcome: [shuber@huberry.com](mailto:shuber@huberry.com)

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run the proxy tests'
+task :default => :test
+
+namespace :test do
+  desc 'Default: run the proxy tests for all versions of actionpack'
+  task :all do
+    versions = `gem list`.match(/actionpack \((.+)\)/).captures[0].split(/, /).select { |v| v[0,1].to_i > 1 }
+    versions.each do |version|
+      puts "\n\n============================================================="
+      puts "TESTING WITH ACTION PACK VERSION #{version}\n\n"
+      system "rake test ACTION_PACK_VERSION=#{version}"
+    end
+  end
+end
+
+desc 'Test the proxy plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the proxy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Proxy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require_dependency 'proxy'

data/lib/proxy.rb

@@ -0,0 +1,49 @@
+require 'proxy/action_controller/abstract_request'
+require 'proxy/action_controller/base'
+require 'proxy/action_controller/named_route_collection'
+require 'proxy/action_controller/url_rewriter'
+require 'proxy/action_view/url_helper'
+
+module Proxy
+  mattr_accessor :replace_host_with_proc
+  self.replace_host_with_proc = proc { |request| }
+  
+  def self.replace_host_with(&block)
+    self.replace_host_with_proc = block
+  end
+  
+  private
+  
+    def self.before_dispatch(dispatcher)
+      request = dispatcher.instance_variable_get('@request') || dispatcher.instance_variable_get('@env')
+      request = Rack::Request.new(request) if request.is_a?(Hash)
+      new_host = replace_host_with_proc.call(request)
+      request.env['HTTP_X_FORWARDED_HOST'] = [request.host, new_host].join(', ') unless new_host.blank?
+    end
+end
+
+ActionController::Dispatcher.before_dispatch do |dispatcher|
+  Proxy.send :before_dispatch, dispatcher
+end
+
+ActionController::AbstractRequest = ActionController::Request if defined?(ActionController::Request)
+ActionController::AbstractRequest.send :include, Proxy::ActionController::AbstractRequest
+ActionController::Base.send :include, Proxy::ActionController::Base
+ActionController::Routing::RouteSet::NamedRouteCollection.send :include, Proxy::ActionController::NamedRouteCollection
+ActionController::UrlRewriter.send :include, Proxy::ActionController::UrlRewriter
+ActionView::Base.send :include, Proxy::ActionView::UrlHelper
+
+unless ActionController::UrlWriter.respond_to?(:default_url_options)
+  ActionController::Base.class_eval do
+    include ActionController::UrlWriter
+    
+    def default_url_options_with_backwards_compatibility(*args)
+      default_url_options_without_backwards_compatibility
+    end
+    alias_method_chain :default_url_options, :backwards_compatibility
+  end
+  
+  class << ActionController::UrlWriter
+    delegate :default_url_options, :default_url_options=, :to => ::ActionController::Base
+  end
+end

data/lib/proxy/action_controller/abstract_request.rb

@@ -0,0 +1,41 @@
+module Proxy
+  module ActionController
+    module AbstractRequest
+      def self.included(base)
+        base.class_eval do
+          mattr_accessor :forwarded_uri_header_name
+          self.forwarded_uri_header_name = 'HTTP_X_FORWARDED_URI'
+          memoize :forwarded_hosts, :forwarded_uris if respond_to? :memoize
+        end
+      end
+    
+      # Parses the forwarded host header and returns an array of forwarded hosts
+      #
+      # For example:
+      #
+      #   If the HTTP_X_FORWARDED_HOST header was set to 
+      #     'some-domain.com, some-other-domain.com, and-another-domain.com'
+      #
+      # This method would return ['some-domain.com', 'some-other-domain.com', 'and-another-domain.com']
+      #
+      # Returns an empty array if there aren't any forwarded hosts
+      def forwarded_hosts
+        env['HTTP_X_FORWARDED_HOST'].to_s.split(/,\s*/)
+      end
+    
+      # Parses the forwarded uri header and returns an array of forwarded uris
+      #
+      # For example:
+      #
+      #   If the HTTP_X_FORWARDED_URI header was set to 
+      #     '/some/path, /some/other/path, /and/another/path'
+      #
+      # This method would return ['/some/path, '/some/other/path', '/and/another/path']
+      #
+      # Returns an empty array if there aren't any forwarded uris
+      def forwarded_uris
+        env[self.forwarded_uri_header_name].to_s.split(/,\s*/)
+      end
+    end
+  end
+end

data/lib/proxy/action_controller/base.rb

@@ -0,0 +1,130 @@
+module Proxy
+  module ActionController
+    module Base
+      def self.included(base)
+        base.class_eval do
+          before_filter :set_proxy_relative_url_root
+          around_filter :swap_default_host
+          around_filter :swap_relative_url_root
+          around_filter :swap_session_domain
+          cattr_accessor :original_relative_url_root
+          cattr_accessor :proxy_relative_url_root
+          alias_method_chain :redirect_to, :proxy
+          class << self; delegate :relative_url_root, :relative_url_root=, :to => ::ActionController::AbstractRequest unless ::ActionController::Base.respond_to?(:relative_url_root); end
+        end
+      end
+      
+      protected
+    
+        # Calculates the <tt>relative_url_root</tt> by parsing the request path out of the
+        # first forwarded uri
+        #
+        # For example:
+        #
+        #   http://example.com/manage/videos/new
+        #     gets proxied to
+        #   http://your-domain.com/videos/new
+        #
+        # The first forwarded uri would be: /manage/videos/new
+        # and the request path would be:    /videos/new
+        #
+        # So this method would return: /manage
+        def parse_proxy_relative_url_root
+          request.forwarded_uris.first.gsub(/#{Regexp.escape(request.path)}$/, '')
+        end
+      
+        # Calculates the <tt>session_domain</tt> by parsing the first domain.tld out of the
+        # first forwarded host and prepending a '.'
+        #
+        # For example:
+        #
+        #   http://example.com/manage/videos/new
+        #   http://some.other-domain.com/videos/new
+        #     both get proxied to
+        #   http://your-domain.com/videos/new
+        #
+        # The resulting session domain for the first url would be: '.example.com'
+        # The resulting session domain for the second url would be: '.other-domain.com'
+        def parse_session_domain
+          ".#{$1}" if /([^\.]+\.[^\.]+)$/.match(request.forwarded_hosts.first)
+        end
+      
+        # Forces redirects to use the <tt>default_url_options[:host]</tt> if it exists unless a host
+        # is already set
+        #
+        # For example:
+        #
+        #   http://example.com
+        #     gets proxied to
+        #   http://your-domain.com
+        #
+        # If you have an action that calls <tt>redirect_to new_videos_path</tt>, the example.com domain
+        # would be used instead of your-domain.com
+        def redirect_to_with_proxy(*args)
+          args[0] = request.protocol + url_options[:host] + args.first if args.first.is_a?(String) && !%r{^\w+://.*}.match(args.first) && !url_options[:host].blank?
+          redirect_to_without_proxy(*args)
+        end
+        
+        # Returns ::ActionController::Base.session_options
+        def session_options
+          ::ActionController::Base.session_options
+        end
+    
+        # Sets the <tt>proxy_relative_url_root</tt> using the +parse_proxy_relative_url_root+ method
+        # to calculate it
+        #
+        # Sets the <tt>proxy_relative_url_root</tt> to nil if there aren't any forwarded uris
+        def set_proxy_relative_url_root
+          ::ActionController::Base.proxy_relative_url_root = request.forwarded_uris.empty? ? nil : parse_proxy_relative_url_root
+        end
+      
+        # Sets the <tt>default_url_options[:host]</tt> to the first forwarded host if there are any
+        #
+        # The original default host is restored after each request and can be accessed by calling
+        #   <tt>ActionController::UrlWriter.default_url_options[:original_host]</tt>
+        def swap_default_host
+          url_options[:original_host] = url_options[:host]
+          url_options[:host] = request.forwarded_hosts.first unless request.forwarded_hosts.empty?
+          begin
+            yield
+          ensure
+            url_options[:host] = url_options[:original_host]
+          end
+        end
+      
+        # Sets the <tt>relative_url_root</tt> to the <tt>proxy_relative_url_root</tt> unless it's nil
+        #
+        # The original relative url root is restored after each request and can be accessed by calling
+        #   <tt>ActionController::Base.original_relative_url_root</tt>
+        def swap_relative_url_root
+          ::ActionController::Base.original_relative_url_root = ::ActionController::Base.relative_url_root
+          ::ActionController::Base.relative_url_root = ::ActionController::Base.proxy_relative_url_root unless ::ActionController::Base.proxy_relative_url_root.nil?
+          begin
+            yield
+          ensure
+            ::ActionController::Base.relative_url_root = ::ActionController::Base.original_relative_url_root
+          end
+        end
+      
+        # Sets the <tt>session_options[:session_domain]</tt> to the result of the +parse_session_domain+ method
+        # unless there aren't any forwarded hosts
+        #
+        # The original session domain is restored after each request and can be accessed by calling
+        #   <tt>ActionController::Base.session_options[:original_session_domain]</tt>
+        def swap_session_domain
+          session_options[:original_session_domain] = session_options[:session_domain] || session_options[:domain]
+          session_options[:session_domain] = session_options[:domain] = parse_session_domain unless request.forwarded_hosts.empty?
+          begin
+            yield
+          ensure
+            session_options[:session_domain] = session_options[:domain] = session_options[:original_session_domain]
+          end
+        end
+        
+        # Returns ::ActionController::UrlWriter.default_url_options
+        def url_options
+          ::ActionController::UrlWriter.default_url_options
+        end
+    end
+  end
+end

data/lib/proxy/action_controller/named_route_collection.rb

@@ -0,0 +1,30 @@
+module Proxy
+  module ActionController
+    module NamedRouteCollection
+      def self.included(base)
+        base.class_eval { alias_method_chain :define_url_helper, :proxy }
+      end
+    
+      # Named route url helpers (not path helpers) don't seem to work correctly 
+      # with forwarded hosts unless we explicitly set the option:
+      #
+      #   :only_path => false
+      #
+      # This method only sets that option if it isn't set already
+      def define_url_helper_with_proxy(route, name, kind, options)
+        define_url_helper_without_proxy(route, name, kind, options)
+        if kind == :url
+          selector = url_helper_name(name, kind)
+          @module.module_eval do
+            define_method "#{selector}_with_proxy" do |*args|
+              args << {} unless args.last.is_a? Hash
+              args.last[:only_path] ||= false
+              send "#{selector}_without_proxy", *args
+            end
+            alias_method_chain selector, :proxy
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proxy/action_controller/url_rewriter.rb

@@ -0,0 +1,21 @@
+module Proxy
+  module ActionController
+    module UrlRewriter
+      def self.included(base)
+        base.class_eval { alias_method_chain :rewrite_url, :proxy }
+      end
+    
+      # Adds the default :host option unless already specified
+      #
+      # It will not set the :host option if <tt>options</tt> is not a hash or
+      # if the <tt>ActionController::UrlWriter.default_url_options[:host]</tt> is blank
+      def rewrite_url_with_proxy(options)
+        if options.is_a?(Hash)
+          options[:host] ||= ::ActionController::UrlWriter.default_url_options[:host] unless ::ActionController::UrlWriter.default_url_options[:host].blank?
+          options.delete(:original_host)
+        end
+        rewrite_url_without_proxy(options)
+      end
+    end
+  end
+end

data/lib/proxy/action_view/url_helper.rb

@@ -0,0 +1,21 @@
+module Proxy
+  module ActionView
+    module UrlHelper
+      def self.included(base)
+        base.class_eval { alias_method_chain :url_for, :proxy }
+      end
+    
+      # Adds the default :host option unless already specified
+      #
+      # It will not set the :host option if <tt>options</tt> is not a hash or
+      # if the <tt>ActionController::UrlWriter.default_url_options[:host]</tt> is blank
+      def url_for_with_proxy(options = {})
+        if options.is_a?(Hash)
+          options[:host] ||= ::ActionController::UrlWriter.default_url_options[:host] unless ::ActionController::UrlWriter.default_url_options[:host].blank?
+          options.delete(:original_host)
+        end
+        url_for_without_proxy(options)
+      end
+    end
+  end
+end

data/test/abstract_request_test.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/init'
+
+class AbstractRequestTest < Test::Unit::TestCase
+
+  def setup
+    @request = ActionController::TestRequest.new
+    @request.host = 'example.com'
+    ActionController::UrlWriter.default_url_options[:host] = nil
+    ActionController::Base.relative_url_root = nil
+  end
+  
+  def test_forwarded_hosts_should_be_empty
+    assert_equal [], @request.forwarded_hosts
+  end
+  
+  def test_should_parse_empty_forwarded_hosts_into_an_array
+    @request.env['HTTP_X_FORWARDED_HOST'] = ''
+    assert_equal [], @request.forwarded_hosts
+  end
+  
+  def test_should_parse_nil_forwarded_hosts_into_an_array
+    @request.env['HTTP_X_FORWARDED_HOST'] = nil
+    assert_equal [], @request.forwarded_hosts
+  end
+  
+  def test_forwarded_host_string_should_be_parsed_into_an_array
+    @request.env['HTTP_X_FORWARDED_HOST'] = 'forwarded.com'
+    assert_equal ['forwarded.com'], @request.forwarded_hosts
+  end
+  
+  def test_comma_separated_forwarded_host_string_should_be_parsed_into_an_array
+    @request.env['HTTP_X_FORWARDED_HOST'] = 'forwarded.com,something.com, test.com,   testing.com'
+    assert_equal ['forwarded.com', 'something.com', 'test.com', 'testing.com'], @request.forwarded_hosts
+  end
+  
+  def test_forwarded_uris_should_be_empty
+    assert_equal [], @request.forwarded_uris
+  end
+  
+  def test_should_parse_empty_forwarded_uris_into_an_array
+    @request.env['HTTP_X_FORWARDED_URI'] = ''
+    assert_equal [], @request.forwarded_uris
+  end
+  
+  def test_should_parse_nil_forwarded_uris_into_an_array
+    @request.env['HTTP_X_FORWARDED_URI'] = nil
+    assert_equal [], @request.forwarded_uris
+  end
+  
+  def test_forwarded_uri_string_should_be_parsed_into_an_array
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing'
+    assert_equal ['/test/ing'], @request.forwarded_uris
+  end
+  
+  def test_comma_separated_forwarded_uri_string_should_be_parsed_into_an_array
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing,/whoa, /uh/oh,   /mmm/kay'
+    assert_equal ['/test/ing', '/whoa', '/uh/oh', '/mmm/kay'], @request.forwarded_uris
+  end
+  
+  def test_should_be_able_to_use_custom_forwarded_uri_header_name
+    @original_header_name = ActionController::AbstractRequest.forwarded_uri_header_name
+    @request.env['HTTP_CUSTOM_FORWARDED_URI'] = '/test/ing'
+    ActionController::AbstractRequest.forwarded_uri_header_name = 'HTTP_CUSTOM_FORWARDED_URI'
+    assert_equal ['/test/ing'], @request.forwarded_uris
+    ActionController::AbstractRequest.forwarded_uri_header_name = @original_header_name
+  end
+  
+end

data/test/base_test.rb

@@ -0,0 +1,182 @@
+require File.dirname(__FILE__) + '/init'
+
+class BaseTest < Test::Unit::TestCase
+
+  def setup
+    @controller = TestController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @request.host = 'example.com'
+    ActionController::UrlWriter.default_url_options[:host] = nil
+    ActionController::Base.relative_url_root = '/app'
+  end
+  
+  def test_should_get_normal_action
+    get :normal_action
+    assert_equal "http://#{@request.host}/normal_action", @response.body
+  end
+  
+  def test_should_set_a_forwarded_host_as_a_default_host
+    add_forwarded_host_headers
+    get :normal_action
+    assert_equal "http://domain.com/app/normal_action", @response.body
+  end
+  
+  def test_should_set_forwarded_host_in_a_named_route
+    add_forwarded_host_headers
+    get :named_route_action
+    assert_equal "http://domain.com/app/normal_action", @response.body
+  end
+  
+  def test_should_restore_the_original_default_host
+    ::ActionController::UrlWriter.default_url_options[:host] = 'some-other-domain.com'
+    add_forwarded_host_headers
+    get :normal_action
+    assert_equal "http://domain.com/app/normal_action", @response.body
+  end
+  
+  def test_url_generators_in_views_should_use_forwarded_host
+    add_forwarded_host_headers
+    get :view_action
+    assert_equal "/app/normal_action, http://domain.com/app/normal_action, http://domain.com/app/normal_action, /app/normal_action", @response.body
+  end
+  
+  def test_asset_tag_helpers_should_not_use_forwarded_host
+    add_forwarded_host_headers
+    get :asset_action
+    assert_nil(/domain\.com/.match(@response.body))
+  end
+  
+  def test_should_set_the_session_domain_with_a_forwarded_host
+    add_forwarded_host_headers
+    get :session_action
+    assert_equal '.domain.com', @response.body
+  end
+  
+  def test_should_restore_original_session_domain
+    ::ActionController::Base.session_options[:session_domain] = '.example.com'
+    add_forwarded_host_headers
+    get :session_action
+    assert_equal '.domain.com', @response.body
+    assert_equal '.example.com', ::ActionController::Base.session_options[:session_domain]
+  end
+  
+  def test_should_restore_original_session_domain_with_domain_key
+    ::ActionController::Base.session_options[:domain] = '.example.com'
+    add_forwarded_host_headers
+    get :session_action
+    assert_equal '.domain.com', @response.body
+    assert_equal '.example.com', ::ActionController::Base.session_options[:domain]
+  end
+  
+  def test_should_restore_original_session_if_exception_is_raised
+    ::ActionController::Base.session_options[:session_domain] = '.example.com'
+    add_forwarded_host_headers
+    assert_raises(RuntimeError) { get :exception_action }
+    assert_equal '.example.com', ::ActionController::Base.session_options[:session_domain]
+  end
+  
+  def test_should_restore_original_session_if_redirected
+    ::ActionController::Base.session_options[:session_domain] = '.example.com'
+    add_forwarded_host_headers
+    get :redirect_action
+    assert_equal '.example.com', ::ActionController::Base.session_options[:session_domain]
+  end
+  
+  def test_should_restore_original_host_if_exception_is_raised
+    ::ActionController::UrlWriter.default_url_options[:host] = 'some-other-domain.com'
+    add_forwarded_host_headers
+    assert_raises(RuntimeError) { get :exception_action }
+    assert_equal 'some-other-domain.com', ::ActionController::UrlWriter.default_url_options[:host]
+  end
+  
+  def test_should_restore_original_host_if_redirected
+    ::ActionController::UrlWriter.default_url_options[:host] = 'some-other-domain.com'
+    add_forwarded_host_headers
+    get :redirect_action
+    assert_equal 'some-other-domain.com', ::ActionController::UrlWriter.default_url_options[:host]
+  end
+  
+  def test_should_get_normal_action
+    get :normal_action
+    assert_equal "http://#{@request.host}/app/normal_action", @response.body
+  end
+  
+  def test_should_swap_relative_url_root
+    add_forwarded_uri_headers
+    get :normal_action
+    assert_equal "http://#{@request.host}/test/ing/normal_action", @response.body
+    assert_equal '/app', ActionController::Base.relative_url_root
+  end
+  
+  def test_should_set_proxy_relative_url_root
+    add_forwarded_uri_headers
+    get :normal_action
+    assert_equal '/test/ing', ActionController::Base.proxy_relative_url_root
+  end
+  
+  def test_should_set_proxy_relative_url_root_in_a_named_route
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing/named_route_action'
+    @request.env['PATH_INFO'] = '/named_route_action'
+    get :named_route_action
+    assert_equal "http://#{@request.host}/test/ing/normal_action", @response.body
+  end
+  
+  def test_should_set_original_relative_url_root
+    add_forwarded_uri_headers
+    get :normal_action
+    assert_equal '/app', ActionController::Base.original_relative_url_root
+  end
+  
+  def test_should_restore_relative_url_root_if_exception_is_raised
+    add_forwarded_uri_headers
+    assert_raises(RuntimeError) { get :exception_action }
+    assert_equal '/app', ActionController::Base.relative_url_root
+  end
+  
+  def test_should_restore_relative_url_root_if_exception_is_raised
+    add_forwarded_uri_headers
+    get :redirect_action
+    assert_equal '/app', ActionController::Base.relative_url_root
+  end
+  
+  def test_url_generators_in_views_should_use_forwarded_uri
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing/view_action'
+    @request.env['PATH_INFO'] = '/view_action'
+    get :view_action
+    assert_equal "/test/ing/normal_action, http://example.com/test/ing/normal_action, /test/ing/normal_action, /test/ing/normal_action", @response.body
+  end
+  
+  def test_asset_tag_helpers_should_use_forwarded_uri
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing/asset_action'
+    @request.env['PATH_INFO'] = '/asset_action'
+    get :asset_action
+    assert !@response.body.scan(/img[^>]+src\="\/test\/ing\/images\/test\.gif"/).empty?
+    assert !@response.body.scan(/script[^>]+src\="\/test\/ing\/javascripts\/test\.js"/).empty?
+    assert !@response.body.scan(/link[^>]+href\="\/test\/ing\/stylesheets\/test\.css"/).empty?
+  end
+  
+  def test_should_use_forwarded_host_in_a_redirect
+    add_forwarded_host_headers
+    get :redirect_action
+    assert_redirected_to 'http://domain.com/app/normal_action'
+  end
+  
+  def test_should_use_forwarded_host_in_a_redirect_with_named_routes
+    add_forwarded_host_headers
+    get :redirect_with_named_route_action
+    assert_redirected_to 'http://domain.com/app/normal_action'
+  end
+  
+  protected
+  
+    def add_forwarded_host_headers
+      @request.env['HTTP_X_FORWARDED_HOST'] = 'domain.com'
+    end
+  
+    def add_forwarded_uri_headers
+      @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing/normal_action'
+      @request.env['PATH_INFO'] = '/normal_action'
+    end
+  
+end

data/test/init.rb

@@ -0,0 +1,103 @@
+$:.reject! { |path| path.include? 'TextMate' }
+require 'test/unit'
+
+# Load rubygems
+#
+require 'rubygems'
+
+# Load ActionPack
+#
+args = ['actionpack']
+args << ENV['ACTION_PACK_VERSION'] if ENV['ACTION_PACK_VERSION']
+gem *args
+require 'action_pack'
+require 'action_controller'
+require 'action_controller/dispatcher'
+require 'action_controller/routing'
+require 'action_controller/session_management'
+require 'action_controller/url_rewriter'
+require 'action_controller/test_process'
+require 'action_view'
+
+Test::Unit::TestCase.class_eval do
+  include ActionController::TestProcess
+  
+  unless instance_methods.include?('assert_redirected_to')
+    def assert_redirected_to(url)
+      assert @response.redirect?
+      assert_equal url, @response.location
+    end
+  end
+end
+
+# Routing
+#
+class ActionController::Routing::RouteSet
+	def append
+    yield Mapper.new(self)
+    install_helpers
+	end
+end
+
+ActionController::Base.session_options.merge! :key => '_proxy_session', :secret => '60447f093cd3f5d57686dd5ca1ced83216c846047db0ec97480a5e85411d9bd41ec5587cc4aafac27a4f0e649f0c628b0955b315856b78787a96168671dc96d4'
+
+# Require the main proxy.rb file
+#
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'proxy')
+
+# Test controller
+#
+class TestController < ActionController::Base
+  
+  def asset_action
+    render :inline => '<%= image_tag "test.gif" %>, <%= javascript_include_tag "test" %>, <%= stylesheet_link_tag "test" %>'
+  end
+  
+  def exception_action
+    raise 'Uh oh'
+  end
+
+  def named_route_action
+    render :text => normal_action_url
+  end
+
+  def normal_action
+    render :text => url_for(:controller => 'test', :action => 'normal_action')
+  end
+  
+  def redirect_action
+    redirect_to :action => 'normal_action'
+  end
+  
+  def redirect_with_named_route_action
+    redirect_to normal_action_path
+  end
+  
+  def session_action
+    render :text => ActionController::Base.session_options[:session_domain]
+  end
+  
+  def view_action
+    render :inline => '<%= normal_action_path %>, <%= normal_action_url %>, <%= url_for(:controller => "test", :action => "normal_action") %>, <%= url_for(:controller => "test", :action => "normal_action", :only_path => true) %>'
+  end
+  
+  protected
+  
+    def rescue_action(e)
+      raise e
+    end
+end
+
+# Test routes
+#
+ActionController::Routing::Routes.append do |map|
+  map.connect 'asset_action', :controller => 'test', :action => 'asset_action'
+  map.connect 'exception_action', :controller => 'test', :action => 'exception_action'
+  map.connect 'named_route_action', :controller => 'test', :action => 'named_route_action'
+  map.connect 'normal_action', :controller => 'test', :action => 'normal_action'
+  map.connect 'redirect_action', :controller => 'test', :action => 'redirect_action'
+  map.connect 'redirect_with_named_route_action', :controller => 'test', :action => 'redirect_with_named_route_action'
+  map.connect 'session_action', :controller => 'test', :action => 'session_action'
+  map.connect 'view_action', :controller => 'test', :action => 'view_action'
+  map.normal_action 'normal_action', :controller => 'test', :action => 'normal_action'
+end

data/test/named_route_collection_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/init'
+
+class NamedRouteCollectionTest < Test::Unit::TestCase
+
+  def setup
+    @controller = TestController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @request.host = 'example.com'
+    ActionController::UrlWriter.default_url_options[:host] = nil
+    ActionController::Base.relative_url_root = nil
+  end
+  
+  def test_should_alias_method_chain_url_helpers
+    [ActionController::Base, ActionView::Base].each do |klass|
+      assert klass.method_defined?(:normal_action_url_with_proxy)
+      assert klass.method_defined?(:normal_action_url_without_proxy)
+    end
+  end
+  
+  def test_should_not_alias_method_chain_path_helpers
+    [ActionController::Base, ActionView::Base].each do |klass|
+      assert !klass.method_defined?(:normal_action_path_with_proxy)
+      assert !klass.method_defined?(:normal_action_path_without_proxy)
+    end
+  end
+  
+end

data/test/proxy_test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/init'
+
+class ProxyTest < Test::Unit::TestCase
+
+  def setup
+    @controller = TestController.new
+    @request    = ActionController::TestRequest.new
+    def @request.host; env['HTTP_X_FORWARDED_HOST'].blank? ? env['HTTP_HOST'] : env['HTTP_X_FORWARDED_HOST'].split(/,\s/).last; end
+    @response   = ActionController::TestResponse.new
+    @dispatcher = ActionController::Dispatcher.new(StringIO.new)
+    @dispatcher.instance_variable_set('@request', @request)
+    ActionController::UrlWriter.default_url_options[:host] = nil
+    ActionController::Base.relative_url_root = nil
+    
+    Proxy.replace_host_with do |request|
+      'replaced.com' if request.host == 'replace-me.com'
+    end
+  end
+  
+  def test_should_not_replace_host
+    @request.env['HTTP_HOST'] = 'dont-replace-me.com'
+    assert_equal 'dont-replace-me.com', @request.host
+    Proxy.send(:before_dispatch, @dispatcher)
+    assert_equal 'dont-replace-me.com', @request.host
+  end
+  
+  def test_should_replace_host
+    @request.env['HTTP_HOST'] = 'replace-me.com'
+    assert_equal 'replace-me.com', @request.host
+    Proxy.send(:before_dispatch, @dispatcher)
+    assert_equal 'replaced.com', @request.host
+  end
+  
+end

data/test/url_helper_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/init'
+
+class UrlHelperTest < Test::Unit::TestCase
+
+  def setup
+    @controller = TestController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @request.host = 'example.com'
+    ActionController::UrlWriter.default_url_options[:host] = nil
+    ActionController::Base.relative_url_root = nil
+  end
+  
+  def test_should_render_urls_normally
+    get :view_action
+    assert_equal '/normal_action, http://example.com/normal_action, /normal_action, /normal_action', @response.body
+  end
+  
+  def test_should_render_urls_with_forwarded_hosts_while_respecting_the_only_path_option
+    @request.env['HTTP_X_FORWARDED_HOST'] = 'domain.com'
+    get :view_action
+    assert_equal '/normal_action, http://domain.com/normal_action, http://domain.com/normal_action, /normal_action', @response.body
+  end
+  
+  def test_should_render_urls_with_forwarded_uris
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing/view_action'
+    @request.env['PATH_INFO'] = '/view_action'
+    get :view_action
+    assert_equal '/test/ing/normal_action, http://example.com/test/ing/normal_action, /test/ing/normal_action, /test/ing/normal_action', @response.body
+  end
+  
+  def test_should_render_urls_with_forwarded_hosts_and_uris
+    @request.env['HTTP_X_FORWARDED_HOST'] = 'domain.com'
+    @request.env['HTTP_X_FORWARDED_URI'] = '/test/ing/view_action'
+    @request.env['PATH_INFO'] = '/view_action'
+    get :view_action
+    assert_equal '/test/ing/normal_action, http://domain.com/test/ing/normal_action, http://domain.com/test/ing/normal_action, /test/ing/normal_action', @response.body
+  end
+  
+end

data/test/url_rewriter_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/init'
+
+class UrlRewriter < ::ActionController::UrlRewriter
+  public
+    def rewrite_url
+      super :action => :normal_action, :controller => :test
+    end
+end
+
+class UrlRewriterTest < Test::Unit::TestCase
+
+  def setup
+    @controller = TestController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @request.host = 'example.com'
+    @url_rewriter = UrlRewriter.new(@request, {})
+    ActionController::UrlWriter.default_url_options[:host] = nil
+    ActionController::Base.relative_url_root = nil
+  end
+  
+  def test_should_rewrite_normal_action_with_request_host
+    assert_equal 'http://example.com/normal_action', @url_rewriter.rewrite_url
+  end
+  
+  def test_should_rewrite_normal_action_with_request_host_if_default_host_is_empty
+    ActionController::UrlWriter.default_url_options[:host] = ''
+    assert_equal 'http://example.com/normal_action', @url_rewriter.rewrite_url
+  end
+  
+  def test_should_rewrite_normal_action_with_default_host
+    ActionController::UrlWriter.default_url_options[:host] = 'test.com'
+    assert_equal 'http://test.com/normal_action', @url_rewriter.rewrite_url
+  end
+  
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: proxy
+version: !ruby/object:Gem::Version 
+  version: 1.3.3
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A gem/plugin that allows rails applications to respond to multiple domains and proxied requests
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- lib/proxy/action_controller/abstract_request.rb
+- lib/proxy/action_controller/base.rb
+- lib/proxy/action_controller/named_route_collection.rb
+- lib/proxy/action_controller/url_rewriter.rb
+- lib/proxy/action_view/url_helper.rb
+- lib/proxy.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- test/init.rb
+has_rdoc: true
+homepage: http://github.com/shuber/proxy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem/plugin that allows rails applications to respond to multiple domains and proxied requests
+test_files: 
+- test/abstract_request_test.rb
+- test/base_test.rb
+- test/named_route_collection_test.rb
+- test/proxy_test.rb
+- test/url_helper_test.rb
+- test/url_rewriter_test.rb