omniauth-cas 0.0.1 → 0.0.2

data/README.md

@@ -22,7 +22,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use like any other OmniAuth strategy:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+        provider :cas, :host => 'cas.yourdomain.com'
+    end
+
+OmniAuth CAS requires at least one of the following two configuration options:
+
+  * `host` - Defines the host of your CAS server. A default login URL of `/login` will be assumed.
+  * `login_url` - Defines the URL used to prompt users for their login information.
+    If no `host` is configured, the host application's domain will be used.
+
+Other configuration options:
+
+  * `port` - The port to use for your configured CAS `host`
+  * `ssl` - TRUE to connect to your CAS server over SSL.
+  * `service_validate_url` - The URL to use to validate a user. Defaults to `/serviceValidate`
+  * `logout_url` - The URL to use to logout a user. Defaults to '/logout'
+  * `uid_key` - The user data attribute to use as your user's unique identifier. Defaults to `user` (usually their login name)
 
 ## Contributing
 

data/lib/omniauth/cas/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Cas
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/omniauth/strategies/cas.rb

@@ -68,10 +68,12 @@ module OmniAuth
       end
 
       def request_phase
+        service_url = append_params( callback_url, return_url )
+
         [
           302,
           {
-            'Location' => login_url( append_params(callback_url, :url => request.referer) ),
+            'Location' => login_url( service_url ),
             'Content-Type' => 'text/plain'
           },
           ["You are being redirected to CAS for sign-in."]
@@ -167,6 +169,15 @@ module OmniAuth
       #   ap "CREDENTIALS"
       # end
 
+      def return_url
+        # If the request already has a `url` parameter, then it will already be appended to the callback URL.
+        if request.params and request.params['url']
+          {}
+        else
+          { :url => request.referer }
+        end
+      end
+
     end
   end
 end

data/spec/omniauth/strategies/cas_spec.rb

@@ -12,20 +12,34 @@ describe OmniAuth::Strategies::CAS, :type => :strategy do
     }.to_app
   end
 
-  describe 'GET /auth/cas' do
+  shared_examples_for "a CAS redirect response" do
+    let(:redirect_params) { "service=" + CGI.escape("http://example.org/auth/cas/callback?url=#{return_url}") }
     before do
-      get '/auth/cas', nil, { 'HTTP_REFERER' => 'http://myapp.com/admin/foo'}
-    end
-
-    let(:redirect_params) { "service=" + CGI.escape("http://example.org/auth/cas/callback?url=http://myapp.com/admin/foo") }
+      get url, nil, request_env
+    end    
     subject { last_response }
-
     it { should be_redirect }
     it "should redirect to the CAS server" do
       subject.headers['Location'].should == "https://cas.example.org/login?" + redirect_params
     end
   end
 
+  describe 'GET /auth/cas' do
+    let(:return_url) { 'http://myapp.com/admin/foo' }
+
+    context "with a referer" do
+      let(:url) { '/auth/cas' }
+      let(:request_env) { { 'HTTP_REFERER' => return_url } }
+      it_behaves_like "a CAS redirect response"
+    end
+    context "with an explicit return URL", :focus => true do
+      let(:url) { "/auth/cas?url=#{return_url}" }
+      let(:request_env) { {} }
+    
+      it_behaves_like "a CAS redirect response"
+    end
+  end
+
   describe 'GET /auth/cas/callback without a ticket' do
     before do
       get '/auth/cas/callback'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-cas
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000Z
+date: 2012-01-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
-  requirement: &2165386700 !ruby/object:Gem::Requirement
+  requirement: &2156670480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165386700
+  version_requirements: *2156670480
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2165386060 !ruby/object:Gem::Requirement
+  requirement: &2156669980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2165386060
+  version_requirements: *2156669980
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &2165385480 !ruby/object:Gem::Requirement
+  requirement: &2156669460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2165385480
+  version_requirements: *2156669460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2165381940 !ruby/object:Gem::Requirement
+  requirement: &2156668920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2165381940
+  version_requirements: *2156668920
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2165381300 !ruby/object:Gem::Requirement
+  requirement: &2156668300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *2165381300
+  version_requirements: *2156668300
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2165380620 !ruby/object:Gem::Requirement
+  requirement: &2156667620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *2165380620
+  version_requirements: *2156667620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165379960 !ruby/object:Gem::Requirement
+  requirement: &2156666940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *2165379960
+  version_requirements: *2156666940
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2165379500 !ruby/object:Gem::Requirement
+  requirement: &2156666480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *2165379500
+  version_requirements: *2156666480
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &2165379120 !ruby/object:Gem::Requirement
+  requirement: &2156666080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165379120
+  version_requirements: *2156666080
 description: 
 email:
 - dlindahl@customink.com