foreign_domain_routing 1.0.4

data/README

@@ -0,0 +1,126 @@
+Foreign Domain Routing + 
+Request Routing Plugin for Ruby on Rails 
+-----------------------------------------
+= Foreign Domain Request Routing
+
+-------------------------------------------------------------------------------
+Foreign Domain Routing provides simple handling of foreign domains in Rails.
+It borrows largely from SubdomainFu and some other snippets found around the web.
+
+Request routing allows you to define routing conditions that test 
+methods/properties of the request object such as subdomain, domain,
+port.  You can test them either against a value or with a Regexp
+(assuming the method returns a string)
+
+Merging these two plugins allows them to work together and enhance the routing
+capability of Rails.
+
+Documentation from the original plugins follows...
+
+-------------------------------------------------------------------------------
+Foreign Domain Routing
+-------------------------------------------------------------------------------
+
+Installation
+============
+
+Foreign Domain Routing is available as a plugin. To install it with Rails 2.1 
+or later):
+
+script/plugin install git://github.com/brianmulloy/foreign-domain-routing.git
+
+Examples
+========
+
+Foreign Domain Routing extends Rails's routing mechanisms to provide a way to 
+redirect non-native domains. 
+
+Let's say my rails app domain is 'mydomain.com' and I am creating an app that
+allows users to add a CNAME record to map their subdomain so that 
+'foo.usersdomain.com' would actually point to 'mydomain.com/users/1234'.
+
+The route at the top of config/routes.rb would look like:
+
+map.connect '*path', :controller => 'users',
+:action => 'index', :conditions => { :foreign_domain => true }
+
+And in the users controller:
+
+@user = User.find_by_foreign_domain(request.host.downcase) 
+# this example would require a database field called foreign_domain
+
+Configuration
+=============
+
+You will need to configure Foreign Domain Routing based on your native hostnames. 
+
+native_domains
+--------
+
+A hash of arrays for the native domain names for each relevant environment.
+
+Create the file config/initializers/native_domains.rb and put something like:
+
+ForeignDomainRouting.init_native_domains = {
+  :development => ['localhost'], 
+  :staging => ['staging.example.com'],
+  :production => ['example.com', 'example.org', 'example.net']
+} # set all at once (also the defaults)
+
+
+Or set the native domains on the fly with:
+
+ForeignDomainRouting.native_domains = 
+  ['example.com', 'example.org', 'example.net'] # sets for current environment
+
+Resources
+=========
+
+* GitHub Repository: http://github.com/brianmulloy/foreign_domain_routing
+* 2008 by Brian Mulloy (http://landlessness.net/). Released under the MIT license.
+
+
+*******************************************************************************
+
+-------------------------------------------------------------------------------
+Request Routing Plugin for Ruby on Rails
+-------------------------------------------------------------------------------
+(c) Dan Webb 2006 (dan@vivabit.com)
+
+Plugin that allows you to define routing conditions that test 
+methods/properties of the request object such as subdomain, domain,
+port.  You can test them either against a value or with a Regexp
+(assuming the method returns a string)
+
+*UPDATE* Now works with the new routing code as implemented in edge rails.  Note the
+change in API: use :conditions instead of :requirements.
+
+== Installation
+
+    ruby script/plugin install http://svn.vivabit.net/external/rubylibs/request_routing/
+
+== Usage
+
+In routes.rb you can specify use the :requirements hash with request properties:
+
+    map.connect '', :controller => 'main', :conditions => { :subdomain => 'www' }
+
+    map.connect 'admin', :controller => 'admin', :conditions => { :remote_ip => /^127\.0\.0\.[0-9]$/ }
+
+You can also, of course, use the conditions hash in map.with_options calls.
+
+The allowed properties are:
+
+		:subdomain  (only checks the first subdomain)
+		:domain (only accurate for single tld domain names at the moment)
+		:method (a symbol)
+		:port (a number)
+		:remote_ip 
+		:content_type (content type of the post body)
+		:accepts 
+		:request_uri (the entire request uri)
+		:protocol (either http:// or https://)
+
+== Copyright
+
+Copyright (c) 2009 Joe Scharf. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "foreign_domain_routing"
+    gem.summary = %Q{This version of foreign_domain_routing merges foreign_domain_routing with request_routing}
+    gem.email = "joe@quantipay.com"
+    gem.homepage = "http://github.com/quantipay/foreign_domain_routing"
+    gem.authors = ["Joe Scharf"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "foreign-domain-routing-gem #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 4
+:major: 1
+:minor: 0

data/lib/foreign_domain_routing.rb

@@ -0,0 +1,34 @@
+require 'foreign_domain_routing/routing_extensions'
+
+module ForeignDomainRouting
+  DEFAULT_NATIVE_DOMAINS = {:development => ['localhost:3000'], :test => ['test.host'], :production => ['example.com'] }
+  mattr_accessor :init_native_domains
+  @@init_native_domains = DEFAULT_NATIVE_DOMAINS.dup
+    
+  def self.native_domains
+    init_native_domains[RAILS_ENV.to_sym]
+  end
+  
+  def self.native_domains=(value)
+    init_native_domains[RAILS_ENV.to_sym] = value
+  end
+
+  def self.foreign_domain?(host)
+    native_domains.each do |domain|
+      return false if host =~ /#{domain}\Z/i
+    end
+    true
+  end
+  
+  module Controller
+    def self.included(controller)
+      controller.helper_method(:foreign_domain?)
+    end
+    
+    protected
+    
+    def foreign_domain?
+      ForeignDomainRouting.foreign_domain?(request.host)
+    end
+  end
+end

data/lib/foreign_domain_routing/routing_extensions.rb

@@ -0,0 +1,55 @@
+module ForeignDomainRouting
+  module RouteExtensions
+
+    TESTABLE_REQUEST_METHODS = [:subdomain, :domain, :method, :port, :remote_ip, 
+                                :content_type, :accepts, :request_uri, :protocol]
+    
+    def self.included(base)
+      base.alias_method_chain :recognition_conditions, :foreign_domain
+    end
+
+    def recognition_conditions_with_foreign_domain      
+      result = recognition_conditions_without_foreign_domain
+      result << "ForeignDomainRouting.foreign_domain?(env[:host])" if conditions[:foreign_domain] == true
+      result << "!ForeignDomainRouting.foreign_domain?(env[:host])" if conditions[:foreign_domain] == false
+      
+      conditions.each do |method, value|
+        if TESTABLE_REQUEST_METHODS.include? method
+          result << if value.is_a? Regexp
+            "conditions[#{method.inspect}] =~ env[#{method.inspect}]"
+          else
+            "conditions[#{method.inspect}] === env[#{method.inspect}]"
+          end
+        else
+        end
+      end
+      
+      
+      result
+    end
+  end
+
+  module RouteSetExtensions
+    def self.included(base)
+      base.alias_method_chain :extract_request_environment, :foreign_domain
+    end
+
+    def extract_request_environment_with_foreign_domain(request)
+      extract_request_environment_without_foreign_domain(request).merge({ 
+        :host => request.host,
+        :method => request.method,
+        :subdomain => request.subdomains.first.to_s, 
+        :domain => request.domain, 
+        :port => request.port, 
+        :remote_ip => request.remote_ip, 
+        :content_type => request.content_type, 
+        :accepts => request.accepts.map(&:to_s).join(','), 
+        :request_uri => request.request_uri, 
+        :protocol => request.protocol
+        })
+    end
+  end
+end
+
+ActionController::Routing::RouteSet.send :include, ForeignDomainRouting::RouteSetExtensions
+ActionController::Routing::Route.send :include, ForeignDomainRouting::RouteExtensions

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'foreign_domain_routing'
+
+ActionController::Base.send :include, ForeignDomainRouting::Controller
+
+# RAILS_DEFAULT_LOGGER.info("** ForeignDomainRouting: initialized properly")

data/test/foreign_domain_routing_test.rb

@@ -0,0 +1,135 @@
+require 'test_helper'
+
+require File.dirname(__FILE__) + "/../init"
+RAILS_ENV = :test
+
+class TestController < Class.new(ActionController::Base)
+  def thing
+  end
+end
+
+class OtherTestController < Class.new(ActionController::Base)
+  def thing
+  end
+end
+
+class MockRequest < Struct.new(:path, :subdomains, :method, :remote_ip, :protocol, :path_parameters, :domain, :port, :content_type, :accepts, :request_uri, :host)
+end
+
+class ForeignDomainRoutingTest < ActionController::TestCase
+  attr_reader :rs
+  def setup
+    @rs = ::ActionController::Routing::RouteSet.new
+    ActionController::Routing.use_controllers! %w(test) if ActionController::Routing.respond_to? :use_controllers!
+    @rs.draw {|m| m.connect ':controller/:action/:id' }
+    @request = MockRequest.new(
+      '',
+      ['www'],
+      :post,
+      '1.2.3.4',
+      'http://',
+      '',
+      'thing.com',
+      3432,
+      'text/html',
+      ['*/*'],
+      '/',
+      'www.example.com'
+    )
+  end
+  
+  test "should route normally" do
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end
+    
+    @request.path = '/test/thing'
+    assert(@rs.recognize(@request))    
+  end
+  
+  test "should route conditionally on subdomain" do
+    @rs.draw { |m| m.connect 'thing', :controller => 'test', :conditions => { :subdomain => 'www' }  }
+    @request.path = '/thing'
+    assert(@rs.recognize(@request))
+    @request.subdomains = ['sdkg']
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end    
+  end
+  
+  test "should route conditionally on protocol" do
+    @rs.draw { |m| m.connect 'thing', :controller => 'test', :conditions => { :protocol => /^https:/ }  }
+    @request.path = '/thing'
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end
+    
+    @request.protocol = "https://"
+    assert(@rs.recognize(@request))
+  end
+
+  test "should route conditionally on alternate conditionals" do
+    @rs.draw { |m| 
+      m.connect 'thing', :controller => 'test', :conditions => { :remote_ip => '1.2.3.4' }  
+      m.connect 'thing', :controller => 'other_test', :conditions => { :remote_ip => '1.2.3.5' }
+    }
+    
+    @request.path = '/thing'
+    assert(@rs.recognize(@request))
+    
+    @request.remote_ip = '1.2.3.5'
+    assert(@rs.recognize(@request))
+  end
+  
+  test "should route conditionally on foreign domain" do
+    ForeignDomainRouting.init_native_domains = {
+      :development => ['localhost'], 
+      :test => ['www.example.com'],
+      :production => ['example.com', 'example.org', 'example.net']
+    }
+    
+    @rs.draw { |m| m.connect 'thing', :controller => 'test', :conditions => { :foreign_domain => false }  }
+    @request.path = '/thing'
+    assert(@rs.recognize(@request))
+    @request.host = ['foreign.domain.com']
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end
+    @rs.draw { |m| m.connect 'thing', :controller => 'test', :conditions => { :foreign_domain => true }  }
+    @request.path = '/thing'
+    assert(@rs.recognize(@request))
+  end
+  
+  test "should route conditionally on foreign domain and protocol" do
+    ForeignDomainRouting.init_native_domains = {
+      :development => ['localhost'], 
+      :test => ['www.example.com'],
+      :production => ['example.com', 'example.org', 'example.net']
+    }
+    
+    @rs.draw { |m| m.connect 'thing', :controller => 'test', :conditions => { :foreign_domain => false, :protocol => /^http:/ }  }
+    @request.path = '/thing'
+    # :foreign_domain => false, :protocol => http:// (MATCH)
+    assert(@rs.recognize(@request))
+
+    # :foreign_domain => false, :protocol => https:// (NO MATCH)
+    @request.protocol = "https://"
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end
+
+    # :foreign_domain => true, :protocol => http:// (NO MATCH)
+    @request.host = ['foreign.domain.com']
+    @request.protocol = "http://"
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end
+
+    # :foreign_domain => true, :protocol => https:// (NO MATCH)
+    @request.protocol = "https://"
+    assert_raise(ActionController::RoutingError) do
+      @rs.recognize(@request)
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'action_controller'
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'foreign_domain_routing'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: foreign_domain_routing
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Joe Scharf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-06 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: joe@quantipay.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- VERSION.yml
+- lib/foreign_domain_routing.rb
+- lib/foreign_domain_routing/routing_extensions.rb
+- rails/init.rb
+- test/foreign_domain_routing_test.rb
+- test/test_helper.rb
+- README
+has_rdoc: true
+homepage: http://github.com/quantipay/foreign_domain_routing
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 2
+summary: This version of foreign_domain_routing merges foreign_domain_routing with request_routing
+test_files: 
+- test/foreign_domain_routing_test.rb
+- test/test_helper.rb