subdomainitis 0.9.0

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2010 Stephen Judkins
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright   notice, this list of conditions and the following disclaimer.
+  2. 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.
+  3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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,35 @@
+# Subdomainitis: easily and transparently use subdomains as parameters in a Rails 3 application
+
+### Installation and usage
+To install, add `gem "subdomainitis"` to your `Gemfile`.  Then modify your routes.rb file; see the example below for usage.
+
+    MyProject::Application.routes.draw do
+      extend Subdomainitis
+    
+      resources :spams
+    
+      main_domain do
+        resource :foos
+      end
+    
+      subdomain_as(:account) do
+        resources :bars
+      end
+    
+      use_fake_subdomains! unless Rails.env.production?
+    end
+
+In the example above, the routes for `spams` will work regardless of the presence of a subdomain.  However, the `foos` routes will only work if accessed WITHOUT using a subdomain; only `http://mycompany.com/foos` will work.
+
+Accessing `bars` routes will only work when a subdomain is provided.  Additionally, the specific subdomain is passed into the controller as a path parameter, as specified by the first argument to `subdomain_as`.  For example, `http://subdomain.mycompany.com/bars` resolves to `{:controller => 'bars', :action => 'index', :account => 'subdomain'}`.
+
+URL generation should work transparently as well; make sure you're using url instead of path generation (ie, `foos_url` instead of `foos_path`).  Subdomainitis tries to fail fast by raising exceptions when a working URL cannot be generated.
+
+Call `use_fake_subdomains!` to use the `_subdomain` GET parameter instead of an actual subdomain.  This is useful for development where wildcard subdomains aren't possible, or for testing environments like Cucumber that don't support subdomains.  This support has been tested with both recognition and generation.
+
+No changes are necessary in the controllers.
+
+### Issues
+Though this library seems to work fine for me, there are probably bugs and untested corner cases.  Currently only named routes have been verified to work.
+
+The implementation could probably be cleaner, and relies on internal Rails APIs that may be change in future versions.

data/lib/subdomainitis.rb

@@ -0,0 +1,135 @@
+module Subdomainitis
+
+  SUBDOMAIN_KEY = "_subdomain"
+
+  class IsSubdomain
+    def initialize(route_set)
+      @route_set = route_set
+    end
+    attr_reader :route_set
+
+    def matches?(request)
+      if route_set.use_fake_subdomains
+        request.GET.has_key?(SUBDOMAIN_KEY)
+      else
+        request.subdomain.present?
+      end
+    end
+  end
+
+  class IsMaindomain < IsSubdomain
+    def matches?(request)
+      !super(request)
+    end
+  end
+
+
+  class SubdomainRouteSet < ActionDispatch::Routing::RouteSet
+    def initialize(parent_route_set, subdomain_key)
+      @parent_route_set, @subdomain_key = parent_route_set, subdomain_key
+      super *[]
+    end
+    attr_reader :parent_route_set, :subdomain_key
+
+    def add_route(app, conditions = {}, requirements = {}, defaults = {}, name = nil, anchor = true)
+      parent_route_set.add_subdomain_route(name, subdomain_key)
+      parent_route_set.add_route wrap(app), conditions, requirements, defaults, name, anchor
+    end
+
+    def wrap(app)
+      ActionDispatch::Routing::Mapper::Constraints.new(
+        RouteSetMiddleware.new(parent_route_set, app, subdomain_key),
+        [IsSubdomain.new(parent_route_set)],
+        request_class
+      )
+    end
+  end
+
+  def subdomain_as(subdomain_key, &block)
+    @set.subdomain_routes ||= {}
+    subdomain_routeset = SubdomainRouteSet.new @set, subdomain_key
+    subdomain_routeset.draw &block
+  end
+
+  def main_domain(&block)
+    constraints IsMaindomain.new(@set), &block
+  end
+
+  def use_fake_subdomains!
+    @set.use_fake_subdomains = true
+  end
+
+  class RouteSetMiddleware
+    def initialize(route_set, dispatcher, subdomain_key)
+      @route_set, @dispatcher, @subdomain_key = route_set, dispatcher, subdomain_key
+    end
+
+    attr_reader :route_set, :subdomain_key, :dispatcher
+
+    PATH_PARAMETER_KEY = 'action_dispatch.request.path_parameters'
+
+    def call(env)
+      request = ActionDispatch::Request.new env
+
+      path_parameters = env[PATH_PARAMETER_KEY].merge(subdomain_key => subdomain_from(request))
+      env = env.merge(PATH_PARAMETER_KEY => path_parameters)
+
+      dispatcher.call(env)
+    end
+
+    def subdomain_from(request)
+      if route_set.use_fake_subdomains
+        request.GET[SUBDOMAIN_KEY]
+      else
+        request.subdomain
+      end
+    end
+  end
+
+  module RouteSetMethods
+    def url_for_with_subdomains(args)
+      if subdomain_key = subdomain_routes[args[:use_route]]
+        subdomain_url_for(subdomain_key, args.dup)
+      else
+        url_for_without_subdomains args
+      end
+    end
+
+    def subdomain_url_for(subdomain_key, args)
+      raise HostRequired.new if args[:only_path]
+      subdomain_parameter = args.delete(subdomain_key)
+      raise HostRequired.new unless subdomain_parameter
+
+      url_for_without_subdomains(if use_fake_subdomains
+        args.merge SUBDOMAIN_KEY => subdomain_parameter
+      else
+        args.merge :host => host_name(subdomain_parameter, args[:host])
+      end)
+    end
+
+    def add_subdomain_route(name, subdomain_key)
+      subdomain_routes[name] = subdomain_key
+    end
+
+    def host_name(subdomain_parameter, host)
+      raise HostRequired.new unless host
+      ([subdomain_parameter] + host.split(".")[-2..-1]).join(".")
+    end
+
+  end
+
+  def self.extended(router)
+    router.instance_variable_get(:@set).class_eval do
+      include RouteSetMethods
+      alias_method_chain :url_for, :subdomains
+      attr_accessor :subdomain_routes, :use_fake_subdomains
+    end
+  end
+
+  class HostRequired < Exception
+    def initialize
+      super("A hostname must be specified to generate this URL since it depends on a subdomain")
+    end
+  end
+
+end

data/lib/subdomainitis/spec_helpers.rb

@@ -0,0 +1,51 @@
+module Subdomainitis
+  module SpecHelpers
+    extend RSpec::Matchers::DSL
+
+    define :generate_url do |expected|
+
+      match do |args|
+        generate(args) == expected
+      end
+
+      failure_message_for_should do |args|
+        "expected that #{generate(args).inspect} would be == #{expected.inspect}"
+      end
+
+    end
+
+    define :resolve_to do |expected|
+      match do |path|
+        called = false
+        uri = URI.parse(path)
+        controller_class = "#{expected[:controller].camelize}Controller".constantize
+        controller_instance = mock(controller_class)
+        controller_class.should_receive(:action).any_number_of_times.with(expected[:action]).and_return(controller_instance)
+
+        controller_instance.should_receive(:call) do |env|
+          env["action_dispatch.request.path_parameters"].symbolize_keys.should == expected.symbolize_keys
+
+          called = true
+
+          [200, {'Content-Type' => 'text/html'}, ['Not Found']]
+        end.any_number_of_times
+
+        env = Rack::MockRequest.env_for(path, {:method => :get})
+
+        subject.call(env)
+
+        called
+      end
+    end
+
+    def generate(args)
+      url_helpers.url_for(args.merge(:host => 'test.host'))
+    end
+
+    def url_helpers
+      subject.url_helpers
+    end
+
+
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: subdomainitis
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Stephen Judkins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  type: :runtime
+  version_requirements: *id002
+description: subdomainitis provides easy, simple support for using wildcard subdomains as controller parameters in Rails 3
+email: 
+- stephen.judkins@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/subdomainitis/spec_helpers.rb
+- lib/subdomainitis.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/stephenjudkins/subdomainitis
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easy routing based on subdomains for Rails 3
+test_files: []
+