omniauth-shibboleth 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20c1c77307a9603a5313733f2c8475852f2727d1
-  data.tar.gz: 313fae3b26554a22341ab31ac26870737e82fed2
+  metadata.gz: cbc1910339ca687b35d3e2120072009e39dca66a
+  data.tar.gz: 60215822a0ac07502b0dcee32545d18c0e2dc160
 SHA512:
-  metadata.gz: 072bf6b32382982a02d9f7f6d95e9a38549eac6ca3d1f3001b2dd95d97fa50fb82fc9532bd7c617698e7e1f1a43010c3603b6a39dbbffaf0984d78da5fcf34ce
-  data.tar.gz: 685f71cc782f3ebfed15676c55b498be3cde4b94a1ebe3be39b4f9dfa8bad5ce6710f5c78202ee1f7573e85ac09cffa2e661835ab9cf05db9a1fc4d57216f501
+  metadata.gz: f58cc5c54b07a092f15984b1aa6290d21a7271c4e16933b2d0b6b99639bf8881a1ffe9a03503083be69f8f834bf27c9b843d3c9e52b8bc9a217fe485c2703a3d
+  data.tar.gz: 2b29dcaa1c212ad9b6825b184b1ba766626685d3212daaa1afe7805c9898b6590a7c9df5e62be68bfb874e3e74caa566d651b174e6f9ed124cac0d8a02cd94ed

data/README.md

@@ -18,15 +18,12 @@ https://github.com/toyokazu/omniauth-shibboleth/issues
 
 ## Getting Started
 
-### Installation
-
-    % gem install omniauth-shibboleth
-
-### Setup Gemfile
+### Setup Gemfile and Install
 
     % cd rails-app
     % vi Gemfile
     gem 'omniauth-shibboleth'
+    % bundle install
 
 ### Setup Shibboleth Strategy
 
@@ -69,6 +66,25 @@ These can be changed by :uid_field, :name_field option. You can also add any "in
 
 In the previous example, Shibboleth strategy does not pass any :info fields and use 'uid' attribute as uid fields.
 
+### More flexible attribute configuration
+
+If you need more flexible attribute definition, you can use lambda (Proc) to define your attributes. In the following example, 'uid' attribute is chosen from 'eppn' or 'mail', 'info'/'name' attribute is defined as a concatenation of 'cn' and 'sn' and 'info'/'affiliation' attribute is defined as 'affiliation'@my.localdomain. 'request_param' parameter is a method defined in OmniAuth::Shibboleth::Strategy. You can specify attribute names by downcase strings in either request_type, :env, :header and :params.
+
+    % vi config/initializer/omniauth.rb
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :shibboleth, {
+        :uid_field                 => lambda {|request_param| request_param.call('eppn') || request_param.call('mail')},
+        :name_field                => lambda {|request_param| "#{request_param.call('cn')} #{request_param.call('sn')}"},
+        :info_fields => {
+          :affiliation => lambda {|request_param| "#{request_param.call('affiliation')}@my.localdomain"},
+          :email    => "mail",
+          :location => "contactAddress",
+          :image    => "photo_url",
+          :phone    => "contactPhone"
+        }
+      }
+    end
+
 ### !!!NOTICE!!! devise integration issue
 
 When you use omniauth with devise, the omniauth configuration is applied before devise configuration and some part of the configuration overwritten by the devise's. It may not work as you assume. So thus, in that case, currently you should write your configuration only in device configuration.

data/lib/omniauth-shibboleth/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Shibboleth
-    VERSION = "1.1.2"
+    VERSION = "1.2.0"
   end
 end

data/lib/omniauth/strategies/shibboleth.rb

@@ -57,17 +57,26 @@ module OmniAuth
         return fail!(:no_shibboleth_session) unless (request_param(options.shib_session_id_field.to_s) || request_param(options.shib_application_id_field.to_s))
         super
       end
+
+      def option_handler(option_field)
+        if option_field.class == String ||
+          option_field.class == Symbol
+          request_param(option_field.to_s)
+        elsif option_field.class == Proc
+          option_field.call(self.method(:request_param))
+        end
+      end
       
       uid do
-        request_param(options.uid_field.to_s)
+        option_handler(options.uid_field)
       end
 
       info do
         res = {
-          :name  => request_param(options.name_field.to_s)
+          :name => option_handler(options.name_field)
         }
-        options.info_fields.each_pair do |k,v|
-          res[k] = request_param(v.to_s)
+        options.info_fields.each_pair do |key, field|
+          res[key] = option_handler(field)
         end
         res
       end

data/spec/omniauth/strategies/shibboleth_spec.rb

@@ -1,3 +1,4 @@
+#require 'pry-byebug'
 require 'spec_helper'
 
 def make_env(path = '/auth/shibboleth', props = {})
@@ -54,7 +55,8 @@ describe OmniAuth::Strategies::Shibboleth do
         @dummy_id = 'abcdefg'
         @eppn = 'test@example.com'
         @display_name = 'Test User'
-        strategy.call!(make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'eppn' => @eppn, 'displayName' => @display_name))
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'eppn' => @eppn, 'displayName' => @display_name)
+        response = strategy.call!(env)
         expect(strategy.env['omniauth.auth']['uid']).to eq(@eppn)
         expect(strategy.env['omniauth.auth']['info']['name']).to eq(@display_name)
       end
@@ -65,18 +67,21 @@ describe OmniAuth::Strategies::Shibboleth do
         :shib_session_id_field => 'Shib-Session-ID',
         :shib_application_id_field => 'Shib-Application-ID',
         :uid_field => :uid,
-        :name_field => :displayName,
+        :name_field => :sn,
+        #:name_field => :displayName,
         :info_fields => {},
         :extra_fields => [:o, :affiliation] } }
-      let(:app){ lambda{|env| [404, {}, ['Awesome']]}}
+      let(:app){ lambda{|env| [404, {}, ['Not Found']]}}
       let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
 
       it 'is expected to set specified omniauth.auth fields' do
         @dummy_id = 'abcdefg'
         @uid = 'test'
+        @sn = 'User'
         @organization = 'Test Corporation'
         @affiliation = 'faculty'
-        strategy.call!(make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'uid' => @uid, 'o' => @organization, 'affiliation' => @affiliation))
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'uid' => @uid, 'sn' => @sn, 'o' => @organization, 'affiliation' => @affiliation)
+        response = strategy.call!(env)
         expect(strategy.env['omniauth.auth']['uid']).to eq(@uid)
         expect(strategy.env['omniauth.auth']['extra']['raw_info']['o']).to eq(@organization)
         expect(strategy.env['omniauth.auth']['extra']['raw_info']['affiliation']).to eq(@affiliation)
@@ -85,6 +90,7 @@ describe OmniAuth::Strategies::Shibboleth do
 
     context 'with debug options' do
       let(:options){ { :debug => true} }
+      let(:app){ lambda{|env| [404, {}, ['Not Found']]}}
       let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
 
       it 'is expected to raise environment variables' do
@@ -106,6 +112,7 @@ describe OmniAuth::Strategies::Shibboleth do
         :name_field => :displayName,
         :info_fields => {},
         :extra_fields => [:o, :affiliation] } }
+      let(:app){ lambda{|env| [200, {}, ['OK']]}}
       let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
 
       it 'is expected to handle header variables' do
@@ -132,6 +139,7 @@ describe OmniAuth::Strategies::Shibboleth do
         :name_field => :displayName,
         :info_fields => {},
         :extra_fields => [:o, :affiliation] } }
+      let(:app){ lambda{|env| [200, {}, ['OK']]}}
       let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
 
       it 'is expected to handle header variables' do
@@ -158,6 +166,7 @@ describe OmniAuth::Strategies::Shibboleth do
         :name_field => :displayName,
         :info_fields => {},
         :extra_fields => [:o, :affiliation] } }
+      let(:app){ lambda{|env| [200, {}, ['OK']]}}
       let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
 
       it 'is expected to handle params variables' do
@@ -174,5 +183,55 @@ describe OmniAuth::Strategies::Shibboleth do
         expect(strategy.env['omniauth.auth']['extra']['raw_info']['affiliation']).to eq(@affiliation)
       end
     end
+
+    context 'with Proc option' do
+      let(:options){ {
+        :request_type => :env,
+        :shib_session_id_field => 'Shib-Session-ID',
+        :shib_application_id_field => 'Shib-Application-ID',
+        :uid_field => lambda {|request_param| request_param.call('eppn') || request_param.call('mail')},
+        :name_field => lambda {|request_param| "#{request_param.call('cn')} #{request_param.call('sn')}"},
+        :info_fields => {:affiliation => lambda {|request_param| "#{request_param.call('affiliation')}@my.localdomain" }},
+        :extra_fields => [:o, :affiliation] } }
+      let(:app){ lambda{|env| [200, {}, ['OK']]}}
+      let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
+
+      it 'is expected to have eppn as uid and cn + sn as name field.' do
+        @dummy_id = 'abcdefg'
+        @display_name = 'Test User'
+        @uid = 'test'
+        @eppn = 'test@my.localdomain'
+        @cn = 'Test'
+        @sn = 'User'
+        @organization = 'Test Corporation'
+        @affiliation = 'faculty'
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'uid' => @uid, 'eppn' => @eppn, 'cn' => @cn, 'sn' => @sn, 'o' => @organization, 'affiliation' => @affiliation)
+        response = strategy.call!(env)
+        expect(strategy.env['omniauth.auth']['uid']).to eq(@eppn)
+        expect(strategy.env['omniauth.auth']['info']['name']).to eq("#{@cn} #{@sn}")
+        expect(strategy.env['omniauth.auth']['info']['affiliation']).to eq("#{@affiliation}@my.localdomain")
+        expect(strategy.env['omniauth.auth']['extra']['raw_info']['o']).to eq(@organization)
+        expect(strategy.env['omniauth.auth']['extra']['raw_info']['affiliation']).to eq(@affiliation)
+      end
+
+      let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
+      it 'is expected to have mail as uid and cn + sn as name field.' do
+        @dummy_id = 'abcdefg'
+        @display_name = 'Test User'
+        @uid = 'test'
+        @mail = 'test@my.localdomain'
+        @cn = 'Test'
+        @sn = 'User'
+        @organization = 'Test Corporation'
+        @affiliation = 'faculty'
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'uid' => @uid, 'mail' => @mail, 'cn' => @cn, 'sn' => @sn, 'o' => @organization, 'affiliation' => @affiliation)
+        response = strategy.call!(env)
+        expect(strategy.env['omniauth.auth']['uid']).to eq(@mail)
+        expect(strategy.env['omniauth.auth']['info']['name']).to eq("#{@cn} #{@sn}")
+        expect(strategy.env['omniauth.auth']['info']['affiliation']).to eq("#{@affiliation}@my.localdomain")
+        expect(strategy.env['omniauth.auth']['extra']['raw_info']['o']).to eq(@organization)
+        expect(strategy.env['omniauth.auth']['extra']['raw_info']['affiliation']).to eq(@affiliation)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-shibboleth
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Toyokazu Akiyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth