omniauth-cas 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 09cce5081c4f84323fdc73cc34324fd597d78424
-  data.tar.gz: 9a70b93dee51a38340bd07630f83179992f254b1
+SHA256:
+  metadata.gz: 20d02177b4bdbd637993a8d225133ada4d6d40092b59db98e54b38bbe8aef780
+  data.tar.gz: 9143ccd826882b5f1228b7686958cfa62c9527ab1fef041d6ce1bfb39e7e0f6d
 SHA512:
-  metadata.gz: 436b7b6a87016de8dd0b4c0e8d89697a5570f17d88662bd73b1ee407f9edb3cf8b058d523c1863e5ecaef9aba9ebaf3c52457005119a547398f7fb761f4949a0
-  data.tar.gz: d2e434a790244adbe2c83fdfc9900785acbf48f3f9592911a580ce3fefa35eca3e8561906898c4c134895fbcd6614ce2f019ecada702cf56d9a1a453ef9b8457
+  metadata.gz: a9edd4d3c46a7c7349a0ebf05a67747cb25cfda51fc2c4ebfbc054726e4e8b7034f969291f5f184d609999250507bdfe1da01f659cb43682b837d4fa44292271
+  data.tar.gz: e64e3311e11537b2abc77d25189ef38eebdcbb147eb6db53deb7562530371f40851e035eae08370f3621843873c36c47e9690d1e5f2a0678b31ea8dd87f79bca

data/.travis.yml

@@ -1,9 +1,21 @@
+dist: xenial
+os: linux
+language: ruby
 rvm:
   - 2.1
   - 2.2
-  - 2.3.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-edge
 branches:
   only:
     - master
 before_install:
-  - gem install bundler
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+jobs:
+  allow_failures:
+  - rvm: ruby-edge

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
 project adheres to [Semantic Versioning](http://semver.org/)
 
+## 2.0.0 - 2010-11-14
+
+### Added
+
+* Add support for multivalued attributes ([#59](https://github.com/dlindahl/omniauth-cas/pull/59))
+* Successfully test against Ruby 2.4 and up ([#60](https://github.com/dlindahl/omniauth-cas/pull/60))
+
+### Changed
+
+* Forward success response to `fetch_raw_info` callback ([#51](https://github.com/dlindahl/omniauth-cas/pull/51))
+* Relax development dependencies to the latest versions
+
 ## 1.1.1 - 2016-09-19
 
 ### Changed

data/README.md

@@ -1,9 +1,9 @@
 # OmniAuth CAS Strategy [![Gem Version][version_badge]][version] [![Build Status][travis_status]][travis]
 
-[version_badge]: https://badge.fury.io/rb/omniauth-cas.png
-[version]: http://badge.fury.io/rb/omniauth-cas
-[travis]: http://travis-ci.org/dlindahl/omniauth-cas
-[travis_status]: https://secure.travis-ci.org/dlindahl/omniauth-cas.png
+[version_badge]: https://badge.fury.io/rb/omniauth-cas.svg
+[version]: https://badge.fury.io/rb/omniauth-cas
+[travis]: https://travis-ci.org/dlindahl/omniauth-cas
+[travis_status]: https://secure.travis-ci.org/dlindahl/omniauth-cas.svg
 [releases]: https://github.com/dlindahl/omniauth-cas/releases
 
 This is a OmniAuth 1.0 compatible port of the previously available
@@ -58,6 +58,7 @@ Other configuration options:
   * `uid_field` - The user data attribute to use as your user's unique identifier. Defaults to `'user'` (which usually contains the user's login name).
   * `ca_path` - Optional when `ssl` is `true`. Sets path of a CA certification directory. See [Net::HTTP][net_http] for more details.
   * `disable_ssl_verification` - Optional when `ssl` is true. Disables verification.
+  * `merge_multivalued_attributes` - When set to `true` returns attributes with multiple values as arrays. Defaults to `false` and returns the last value as a string.
   * `on_single_sign_out` - Optional. Callback used when a [CAS 3.1 Single Sign Out][sso]
     request is received.
   * `fetch_raw_info` - Optional. Callback used to return additional "raw" user
@@ -65,9 +66,13 @@ Other configuration options:
 
     ```ruby
     provider :cas,
-             fetch_raw_info: lambda { |strategy, options, ticket, user_info|
-               ExternalService.get(user_info[:user]).attributes
-            }
+      fetch_raw_info: Proc.new { |strategy, opts, ticket, user_info, rawxml|
+        return {} if user_info.empty? || rawxml.nil? # Auth failed
+
+        extra_info = ExternalService.get(user_info[:user]).attributes
+        extra_info.merge!({'roles' => rawxml.xpath('//cas:roles').map(&:text)})
+        extra_info
+      }
     ```
 
 Configurable options for values returned by CAS:
@@ -118,6 +123,6 @@ Special thanks go out to the following people
   * @rbq for README updates and OmniAuth 0.3 migration guide
 
 [old_omniauth_cas]: https://github.com/intridea/omniauth/blob/0-3-stable/oa-enterprise/lib/omniauth/strategies/cas.rb
-[document_up]: http://dlindahl.github.com/omniauth-cas/
-[net_http]: http://ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/Net/HTTP.html
+[document_up]: https://dlindahl.github.io/omniauth-cas/
+[net_http]: https://ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/Net/HTTP.html
 [sso]: https://wiki.jasig.org/display/CASUM/Single+Sign+Out

data/lib/omniauth/cas/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Cas
-    VERSION = '1.1.1'
+    VERSION = '2.0.0'
   end
 end

data/lib/omniauth/strategies/cas.rb

@@ -22,6 +22,7 @@ module OmniAuth
       option :port, nil
       option :path, nil
       option :ssl,  true
+      option :merge_multivalued_attributes, false
       option :service_validate_url, '/serviceValidate'
       option :login_url,            '/login'
       option :logout_url,           '/logout'
@@ -189,8 +190,11 @@ module OmniAuth
     private
 
       def fetch_raw_info(ticket)
-        ticket_user_info = validate_service_ticket(ticket).user_info
-        custom_user_info = options.fetch_raw_info.call(self, options, ticket, ticket_user_info)
+        validator = validate_service_ticket(ticket)
+        ticket_user_info = validator.user_info
+        ticket_success_body = validator.success_body
+        custom_user_info = options.fetch_raw_info.call(self,
+          options, ticket, ticket_user_info, ticket_success_body)
         self.raw_info = ticket_user_info.merge(custom_user_info)
       end
 

data/lib/omniauth/strategies/cas/service_ticket_validator.rb

@@ -8,6 +8,8 @@ module OmniAuth
       class ServiceTicketValidator
         VALIDATION_REQUEST_HEADERS = { 'Accept' => '*/*' }
 
+        attr_reader :success_body
+
         # Build a validator from a +configuration+, a
         # +return_to+ URL, and a +ticket+.
         #
@@ -40,6 +42,16 @@ module OmniAuth
 
       private
 
+        # Merges attributes with multiple values into an array if support is
+        # enabled (disabled by default)
+        def attribute_value(user_info, attribute, value)
+          if @options.merge_multivalued_attributes && user_info.key?(attribute)
+            Array(user_info[attribute]).push(value)
+          else
+            value
+          end
+        end
+
         # turns an `<cas:authenticationSuccess>` node into a Hash;
         # returns nil if given nil
         def parse_user_info(node)
@@ -50,7 +62,7 @@ module OmniAuth
               unless e.kind_of?(Nokogiri::XML::Text) || node_name == 'proxies'
                 # There are no child elements
                 if e.element_children.count == 0
-                  hash[node_name] = e.content
+                  hash[node_name] = attribute_value(hash, node_name, e.content)
                 elsif e.element_children.count
                   # JASIG style extra attributes
                   if node_name == 'attributes'

data/omniauth-cas.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'nokogiri',                '~> 1.5'
   gem.add_dependency 'addressable',             '~> 2.3'
 
-  gem.add_development_dependency 'rake',        '~> 10.0'
-  gem.add_development_dependency 'webmock',     '~> 1.19.0'
-  gem.add_development_dependency 'rspec',       '~> 3.1.0'
-  gem.add_development_dependency 'rack-test',   '~> 0.6'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
 
   gem.add_development_dependency 'awesome_print'
 end

data/spec/fixtures/cas_success.xml

@@ -10,5 +10,8 @@
     <cas:image>/images/user.jpg</cas:image>
     <cas:phone>555-555-5555</cas:phone>
     <cas:hire_date>2004-07-13</cas:hire_date>
+    <cas:roles>senator</cas:roles>
+    <cas:roles>lobbyist</cas:roles>
+    <cas:roles>financier</cas:roles>
   </cas:authenticationSuccess>
 </cas:serviceResponse>

data/spec/fixtures/cas_success_jasig.xml

@@ -11,6 +11,9 @@
       <cas:image>/images/user.jpg</cas:image>
       <cas:phone>555-555-5555</cas:phone>
       <cas:hire_date>2004-07-13</cas:hire_date>
+      <cas:roles>senator</cas:roles>
+      <cas:roles>lobbyist</cas:roles>
+      <cas:roles>financier</cas:roles>
     </cas:attributes>
   </cas:authenticationSuccess>
 </cas:serviceResponse>

data/spec/omniauth/strategies/cas/logout_request_spec.rb

@@ -58,12 +58,14 @@ describe OmniAuth::Strategies::CAS::LogoutRequest do
       { on_single_sign_out: callback }
     end
 
+    let(:response_body) { subject[2].respond_to?(:body) ? subject[2].body : subject[2] }
+
     context 'that returns TRUE' do
       let(:callback) { Proc.new{true} }
 
       it 'responds with OK' do
         expect(subject[0]).to eq 200
-        expect(subject[2].body).to eq ['OK']
+        expect(response_body).to eq ['OK']
       end
     end
 
@@ -72,7 +74,7 @@ describe OmniAuth::Strategies::CAS::LogoutRequest do
 
       it 'responds with OK' do
         expect(subject[0]).to eq 200
-        expect(subject[2].body).to eq ['OK']
+        expect(response_body).to eq ['OK']
       end
     end
 
@@ -81,7 +83,7 @@ describe OmniAuth::Strategies::CAS::LogoutRequest do
 
       it 'responds with OK' do
         expect(subject[0]).to eq 400
-        expect(subject[2].body).to eq ['Bad Request']
+        expect(response_body).to eq ['Bad Request']
       end
     end
 

data/spec/omniauth/strategies/cas/service_ticket_validator_spec.rb

@@ -9,6 +9,7 @@ describe OmniAuth::Strategies::CAS::ServiceTicketValidator do
   let(:provider_options) do
     double('provider_options',
       disable_ssl_verification?: false,
+      merge_multivalued_attributes: false,
       ca_path: '/etc/ssl/certsZOMG'
     )
   end
@@ -48,8 +49,26 @@ describe OmniAuth::Strategies::CAS::ServiceTicketValidator do
 
     subject { validator.user_info }
 
-    it 'parses user info from the response' do
-      expect(subject).to include 'user' => 'psegel'
+    context 'with default settings' do
+      it 'parses user info from the response' do
+        expect(subject).to include 'user' => 'psegel'
+        expect(subject).to include 'roles' => 'financier'
+      end
+    end
+
+    context 'when merging multivalued attributes' do
+      let(:provider_options) do
+        double('provider_options',
+          disable_ssl_verification?: false,
+          merge_multivalued_attributes: true,
+          ca_path: '/etc/ssl/certsZOMG'
+        )
+      end
+
+      it 'parses multivalued user info from the response' do
+        expect(subject).to include 'user' => 'psegel'
+        expect(subject).to include 'roles' => %w[senator lobbyist financier]
+      end
     end
   end
 end

data/spec/omniauth/strategies/cas_spec.rb

@@ -10,7 +10,17 @@ describe OmniAuth::Strategies::CAS, type: :strategy do
   let(:app) do
     Rack::Builder.new {
       use OmniAuth::Test::PhonySession
-      use MyCasProvider, name: :cas, host: 'cas.example.org', ssl: false, port: 8080, uid_field: :employeeid
+      use MyCasProvider,
+        name: :cas,
+        host: 'cas.example.org',
+        ssl: false,
+        port: 8080,
+        uid_field: :employeeid,
+        fetch_raw_info: Proc.new { |v, opts, ticket, info, node|
+          info.empty? ? {} : {
+            "roles" => node.xpath('//cas:roles').map(&:text),
+          }
+        }
       run lambda { |env| [404, {'Content-Type' => 'text/plain'}, [env.key?('omniauth.auth').to_s]] }
     }.to_app
   end
@@ -184,6 +194,7 @@ describe OmniAuth::Strategies::CAS, type: :strategy do
               expect(subject.user).to eq 'psegel'
               expect(subject.employeeid).to eq '54'
               expect(subject.hire_date).to eq '2004-07-13'
+              expect(subject.roles).to eq %w(senator lobbyist financier)
             end
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-cas
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Derek Lindahl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -56,58 +56,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +131,6 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -155,7 +154,7 @@ files:
 homepage: https://github.com/dlindahl/omniauth-cas
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,9 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: CAS Strategy for OmniAuth
 test_files:

data/.ruby-version

@@ -1 +0,0 @@
-2.1.2