sso_what 0.2.1

data/MIT-LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2008 {Centro}[www.centro.net]
+
+Authored by:
+
+  {Gabriel Gironda}[gabriel.gironda@gmail.com]
+  {Josh Davison}[josh.davison@centro.net]
+  {Justin Knowlden}[gus@gusg.us]
+    
+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,40 @@
+# SSO What
+
+SSO What enables your Rails app to function well with sub-domains solely in the context of managing cookies. SSO What has to do two things (which makes us angry since it should only be one):
+
+1. Support a dynamic domain that works across sub-domains for session cookies
+2. Support a cookie domain that works across sub-domains for all cookies other than a session cookie
+
+### Session Cookies
+
+SSO What is used to generate a session domain for single sign-on which works regardless of sub-domains and different hosts in different environments. So. If you have two servers, `kill.for.thrills.hypo.luxa` and `thrill.olympics.hypo.luxa`, the session domain would resolve to `.hypo.luxa`.
+
+If your staging environment uses `kill.for.thrills.alien.jourgensen` it will automatically use `.alien.jourgensen` without further configuration.
+
+To enable this feature set the session options on `ActionController` using the following line in your environment file:
+
+    config.action_controller.session = {:base_domain => true}
+
+If you want to set a specific domain for all session cookies, this has nothing to do with SSO What. But, you can use built-in Rails behavior and do this in your environment file:
+
+    config.action_controller.session = {:domain => 'thrill.olympics.hypo.luxa'}
+
+### All other cookies
+
+SSO What will force (for now since it's not configurable) all cookies that you set without an explicit domain to work across sub-domains. For example, if the domain your app is serving is `foo.example.com` and you set a cookie named `bar` but don't provide a domain, SSO What will kick in and set the domain to `.example.com`. Without SSO What, the domain would be `foo.example.com`.
+
+If you provide an explicit domain with your cookie, SSO What just watches everything go by. It may cry a little, though :(
+
+# Requirements
+
+Shoulda and Mocha are required to run the tests.
+
+## License
+
+Copyright (c) 2008 {Centro}[www.centro.net], released under the MIT license.
+
+Authored by:
+
+    {Gabriel Gironda}[gabriel.gironda@gmail.com]
+    {Josh Davison}[josh.davison@centro.net]
+    {Justin Knowlden}[gus@gusg.us]

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sso_what plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the sso_what plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SsoWhat'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/sso_what.rb

@@ -0,0 +1,2 @@
+require 'thumblemonks/base_domain_session'
+require 'thumblemonks/base_domain_cookie'

data/lib/thumblemonks/base_domain_cookie.rb

@@ -0,0 +1,27 @@
+module ThumbleMonks
+  module SsoWhat
+    module BaseDomainCookie
+      def self.included(klass)
+        klass.alias_method_chain :set_cookie, :domain_override
+      end
+
+      def set_cookie_with_domain_override(key, value)
+        value = {:value => value} unless value.is_a?(Hash)
+        domain_requested, host = value[:domain], request.host
+        unless domain_requested || host_has_no_tld?(host)
+          domain_requested = host.gsub(/^(.*\.)?([a-z0-9-]+\.[a-z]+)$/i, '\2')
+          value[:domain] = ".#{domain_requested}"
+        end
+        set_cookie_without_domain_override(key, value)
+      end
+
+    private
+
+      def host_has_no_tld?(host)
+        host =~ /^[a-z0-9-]+$/i
+      end
+    end # DomainOverride
+  end # SsoWhat
+end # ThumbleMonks
+
+Rack::Response.instance_eval { include ThumbleMonks::SsoWhat::BaseDomainCookie }

data/lib/thumblemonks/base_domain_session.rb

@@ -0,0 +1,19 @@
+module Centro
+  module SsoWhat
+    module BaseDomainSession
+      def self.included(klass)
+        klass.alias_method_chain :call, :domain_override
+      end
+    
+      def call_with_domain_override(env)
+        if @default_options[:base_domain]
+          base_host = env["HTTP_HOST"].scan(/[0-9a-z-]+\.[0-9a-z-]+(?=:|$)/i).first
+          @default_options[:domain] = base_host ? ".#{base_host}" : base_host
+        end
+        call_without_domain_override(env)
+      end
+    end # MultiDomainSession
+  end # AbstractStore
+end # Centro
+
+ActionController::Session::AbstractStore.instance_eval { include Centro::SsoWhat::BaseDomainSession }

data/sso_what.gemspec

@@ -0,0 +1,39 @@
+Gem::Specification.new do |s|
+  s.name     = "sso_what"
+  s.version  = "0.2.1"
+  s.date     = "2009-03-05"
+  s.summary  = "Rails extension to help with cookies in a system with sub-domains"
+  s.email    = %w[gus@gusg.us gabriel.gironda@gmail.com]
+  s.homepage = "http://github.com/thumblemonks/sso_what"
+  s.description = "Rails extension to help with cookies in a system with sub-domains"
+  s.authors  = %w[Justin\ Knowlden Gabriel\ Gironda]
+
+  s.rubyforge_project = %q{sso_what}
+
+  s.has_rdoc = true
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "SSO What", "--main", "README.markdown"]
+  s.extra_rdoc_files = %w[README.markdown MIT-LICENSE]
+  
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to?(:required_rubygems_version=)
+  s.rubygems_version = "1.3.1"
+  s.require_paths = ["lib"]
+
+  # run git ls-files to get an updated list
+  s.files = %w[
+    MIT-LICENSE
+    README.markdown
+    Rakefile
+    lib/sso_what.rb
+    lib/thumblemonks/base_domain_cookie.rb
+    lib/thumblemonks/base_domain_session.rb
+    sso_what.gemspec
+  ]
+  
+  s.test_files = %w[
+    test/base_domain_cookie_test.rb
+    test/base_domain_session_test.rb
+    test/test_helper.rb
+  ]
+
+  s.post_install_message = %q{Choosy ministries choose Thumble Monks}
+end

data/test/base_domain_cookie_test.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class BaseDomainCookieTest < Test::Unit::TestCase
+  def setup
+    # @response = OpenStruct.new(:headers => { "Set-Cookie" => [] })
+    # @controller = OpenStruct.new(:request => @request, :response => @response)
+    @test_request = OpenStruct.new
+    @response = Rack::Response.new
+    @response.stubs(:request).returns(@test_request)
+  end
+
+  context "if domain is provided" do
+    should "not do anyhing" do
+      @response.set_cookie("fanta", {:value => "wanna fanta", :domain => 'foo.bar'})
+      assert_equal 'domain=foo.bar', domain_for_the_first_cookie_found
+    end
+  end
+
+  context "if domain is not provided" do
+    context "and value is a string" do
+      should "set the domain to request.host but with subdomain support" do
+        @test_request.expects(:host).returns('foo-bar.baz')
+        @response.set_cookie("fanta", "wanna fanta")
+        assert_equal 'domain=.foo-bar.baz', domain_for_the_first_cookie_found
+      end
+    end
+
+    should "set the domain to request.host but with subdomain support" do
+      @test_request.expects(:host).returns('foo-bar.baz')
+      @response.set_cookie("fanta", {:value => "wanna fanta"})
+      assert_equal 'domain=.foo-bar.baz', domain_for_the_first_cookie_found
+    end
+
+    should "remove subdomains" do
+      @test_request.expects(:host).returns('thomas.f00.bar')
+      @response.set_cookie("fanta", {:value => "wanna fanta"})
+      assert_equal 'domain=.f00.bar', domain_for_the_first_cookie_found
+    end
+
+    should "do nothing for one word hosts" do
+      @test_request.expects(:host).returns('localhost')
+      @response.set_cookie("fanta", {:value => "wanna fanta"})
+      assert_nil domain_for_the_first_cookie_found
+    end
+  end
+
+  def domain_for_the_first_cookie_found
+    @response["Set-Cookie"].scan(/domain=[a-z0-9.-]+/i).first
+  end
+end

data/test/base_domain_session_test.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class BaseDomainSessionTest < Test::Unit::TestCase
+  # Macros
+
+  def self.store_with_multi_domain(multi_domain_option, &block)
+    context "session store with multi-domain set to #{multi_domain_option.inspect}" do
+      setup do
+        @response = [nil, {"Set-Cookie" => nil}] # second element is the header
+        @app = stub(:call => @response)
+        options = {:base_domain => multi_domain_option, :expire_after => 3600}
+        @store = TestSessionStore.new(@app, options)
+      end
+      yield if block_given?
+    end
+  end
+
+  def self.should_expect_cookie_domain_for_http_host(http_host, cookie_domain)
+    should "return #{cookie_domain} for #{http_host}" do
+      env = {"HTTP_HOST" => http_host}
+      @store.call(env)
+      expected = cookie_domain.nil? ? nil : "domain=#{cookie_domain}"
+      assert_equal expected, domain_for_the_first_cookie_found
+    end
+  end
+
+  def domain_for_the_first_cookie_found
+    set_cookie = @response[1]["Set-Cookie"]
+    set_cookie && set_cookie.scan(/domain=[a-z0-9.-]+/i).first
+  end
+
+  # Tests
+
+  store_with_multi_domain(true) do
+    should_expect_cookie_domain_for_http_host "foohost", nil
+    should_expect_cookie_domain_for_http_host "foohost.bar", ".foohost.bar"
+    should_expect_cookie_domain_for_http_host "gah.foohost.bar", ".foohost.bar"
+    should_expect_cookie_domain_for_http_host "publisher.gah.foohost.bar", ".foohost.bar"
+    should_expect_cookie_domain_for_http_host "gah.foohost.bar:3000", ".foohost.bar"
+  end
+  
+  store_with_multi_domain(false) do
+    should_expect_cookie_domain_for_http_host "gah.foohost.bar", nil
+  end
+
+  store_with_multi_domain(nil) do
+    should_expect_cookie_domain_for_http_host "gah.foohost.bar", nil
+  end
+
+end
+
+class TestSessionStore < ActionController::Session::AbstractStore
+  def get_session(env, sid)
+    [sid, {:foo => "bar"}]
+  end
+
+  def set_session(env, sid, session_data)
+    true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'ostruct'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'action_controller'
+
+require 'sso_what'

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: sso_what
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Justin Knowlden
+- Gabriel Gironda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-05 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Rails extension to help with cookies in a system with sub-domains
+email: 
+- gus@gusg.us
+- gabriel.gironda@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/sso_what.rb
+- lib/thumblemonks/base_domain_cookie.rb
+- lib/thumblemonks/base_domain_session.rb
+- sso_what.gemspec
+has_rdoc: true
+homepage: http://github.com/thumblemonks/sso_what
+licenses: []
+
+post_install_message: Choosy ministries choose Thumble Monks
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- SSO What
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: sso_what
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails extension to help with cookies in a system with sub-domains
+test_files: 
+- test/base_domain_cookie_test.rb
+- test/base_domain_session_test.rb
+- test/test_helper.rb