omniauth-shibboleth 1.0.6 → 1.0.7

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    omniauth-shibboleth (1.0.7)
+      omniauth (>= 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    hashie (1.2.0)
+    omniauth (1.1.1)
+      hashie (~> 1.2)
+      rack
+    rack (1.4.1)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-shibboleth!
+  rack-test
+  rake
+  rspec (~> 2.8)

data/README.md

@@ -35,6 +35,9 @@ To use OmniAuth Shibboleth strategy as a middleware in your rails application, a
     % vi config/initializer/omniauth.rb
     Rails.application.config.middleware.use OmniAuth::Builder do
       provider :shibboleth, {
+        :shib_session_id_field     => "Shib-Session-ID",
+        :shib_application_id_field => "Shib-Application-ID",
+        :debug                     => false,
         :extra_fields => [
           :"unscoped-affiliation",
           :entitlement
@@ -46,15 +49,21 @@ In the above example, 'unscoped-affiliation' and 'entitlement' attributes are ad
 
 https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema
 
-'eppn' attribute is used as uid field. 'displayName' and 'mail' attributes are provided as request.env["omniauth.auth"]["info"]["name"] and request.env["omniauth.auth"]["info"]["email"].
+'eppn' attribute is used as uid field. 'displayName' attribute is provided as request.env["omniauth.auth"]["info"]["name"].
 
-These can be changed by :uid_field and :fields option.
+These can be changed by :uid_field, :name_field option. You can also add any "info" fields defined in Auth-Hash-Schema by using :info_fields option.
 
     % vi config/initializer/omniauth.rb
     Rails.application.config.middleware.use OmniAuth::Builder do
       provider :shibboleth, {
-        :uid_field => :uid,
-        :fields => []
+        :uid_field                 => "uid",
+        :name_field                => "displayName",
+        :info_fields => {
+          :email    => "mail",
+          :location => "contactAddress",
+          :image    => "photo_url",
+          :phone    => "contactPhone"
+        }
       }
     end
 
@@ -84,7 +93,7 @@ https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPSpoofChecking
 
 To provide Shibboleth attributes via environment variables, we can not use proxy_balancer base approach. Currently we can realize it by using Phusion Passenger as an application container. An example construction pattern is shown in presence_checker application (https://github.com/toyokazu/presence_checker/).
 
-### development mode
+### debug mode
 
 When you deploy a new application, you may want to confirm the assumed attributes are correctly provided by Shibboleth SP. OmniAuth Shibboleth strategy provides a confirmation option :debug. If you set :debug true, you can see the environment variables provided at the /auth/shibboleth/callback uri.
 
@@ -95,7 +104,7 @@ When you deploy a new application, you may want to confirm the assumed attribute
 
 ## License (MIT License)
 
-Copyright (C) 2011 by Toyokazu Akiyama.
+Copyright (C) 2011-2012 by Toyokazu Akiyama.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/omniauth-shibboleth/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Shibboleth
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

data/lib/omniauth/strategies/shibboleth.rb

@@ -3,8 +3,11 @@ module OmniAuth
     class Shibboleth
       include OmniAuth::Strategy
 
-      option :uid_field, :eppn
-      option :fields, [:name, :email]
+      option :shib_session_id_field, 'Shib-Session-ID'
+      option :shib_application_id_field, 'Shib-Application-ID'
+      option :uid_field, 'eppn'
+      option :name_field, 'displayName'
+      option :info_fields, {}
       option :extra_fields, []
       option :debug, false
 
@@ -30,7 +33,7 @@ module OmniAuth
             [request.env.sort.map {|i| "#{i[0]}: #{i[1]}" }.join("\n")]
           ]
         end
-        return fail!(:no_shibboleth_session) unless (request.env['Shib-Session-ID'] || request.env['Shib-Application-ID'])
+        return fail!(:no_shibboleth_session) unless (request.env[options.shib_session_id_field.to_s] || request.env[options.shib_application_id_field.to_s])
         super
       end
       
@@ -39,17 +42,13 @@ module OmniAuth
       end
 
       info do
-        options.fields.inject({}) do |hash, field|
-          case field
-          when :name
-            hash[field] = request.env['displayName']
-          when :email
-            hash[field] = request.env['mail']
-          else
-            hash[field] = request.env[field.to_s]
-          end
-          hash
+        res = {
+          :name  => request.env[options.name_field.to_s]
+        }
+        options.info_fields.each_pair do |k,v|
+          res[k] = request.env[v.to_s]
         end
+        res
       end
 
       extra do

data/omniauth-shibboleth.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |gem|
 
   gem.authors       = ["Toyokazu Akiyama"]
   gem.email         = ["toyokazu@gmail.com"]
-  gem.description   = %q{OmniAuth Shibboleth strategies for OmniAuth 1.0}
-  gem.summary       = %q{OmniAuth Shibboleth strategies for OmniAuth 1.0}
+  gem.description   = %q{OmniAuth Shibboleth strategies for OmniAuth 1.x}
+  gem.summary       = %q{OmniAuth Shibboleth strategies for OmniAuth 1.x}
   gem.homepage      = ""
 
   gem.files         = `find . -not \\( -regex ".*\\.git.*" -o -regex "\\./pkg.*" -o -regex "\\./spec.*" \\)`.split("\n").map{ |f| f.gsub(/^.\//, '') }

data/spec/omniauth/strategies/shibboleth_spec.rb

@@ -54,16 +54,20 @@ describe OmniAuth::Strategies::Shibboleth do
         @dummy_id = 'abcdefg'
         @eppn = 'test@example.com'
         @display_name = 'Test User'
-        @email = 'test@example.com'
-        strategy.call!(make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'eppn' => @eppn, 'displayName' => @display_name, 'mail' => @email))
+        strategy.call!(make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'eppn' => @eppn, 'displayName' => @display_name))
         strategy.env['omniauth.auth']['uid'].should == @eppn
         strategy.env['omniauth.auth']['info']['name'].should == @display_name
-        strategy.env['omniauth.auth']['info']['email'].should == @email
       end
     end
 
     context 'with Shibboleth session and attribute options' do
-      let(:options){ { :uid_field => :uid, :fields => [], :extra_fields => [:o, :affiliation] } }
+      let(:options){ {
+        :shib_session_id_field => 'Shib-Session-ID',
+        :shib_application_id_field => 'Shib-Application-ID',
+        :uid_field => :uid,
+        :name_field => :displayName,
+        :info_fields => {},
+        :extra_fields => [:o, :affiliation] } }
       let(:app){ lambda{|env| [404, {}, ['Awesome']]}}
       let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
 
@@ -86,8 +90,7 @@ describe OmniAuth::Strategies::Shibboleth do
         @dummy_id = 'abcdefg'
         @eppn = 'test@example.com'
         @display_name = 'Test User'
-        @email = 'test@example.com'
-        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'eppn' => @eppn, 'displayName' => @display_name, 'mail' => @email)
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'eppn' => @eppn, 'displayName' => @display_name)
         response = strategy.call!(env)
         response[0].should == 200
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-shibboleth
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
-  requirement: &70308556621900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70308556621900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70308556621380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70308556621380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70308556620600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70308556620600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70308556635620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,8 +69,13 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70308556635620
-description: OmniAuth Shibboleth strategies for OmniAuth 1.0
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: OmniAuth Shibboleth strategies for OmniAuth 1.x
 email:
 - toyokazu@gmail.com
 executables: []
@@ -63,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - lib/omniauth/strategies/shibboleth.rb
 - lib/omniauth-shibboleth/version.rb
 - lib/omniauth-shibboleth.rb
@@ -83,18 +104,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3085900571959880599
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3085900571959880599
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: OmniAuth Shibboleth strategies for OmniAuth 1.0
+summary: OmniAuth Shibboleth strategies for OmniAuth 1.x
 test_files:
 - spec/omniauth/strategies/shibboleth_spec.rb
 - spec/spec_helper.rb