omniauth_crowd 2.0.1 → 2.1.0

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    omniauth_crowd (2.0.0)
+    omniauth_crowd (2.1.0)
       nokogiri (>= 1.4.4)
       omniauth (~> 1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.4)
-    crack (0.1.8)
-    diff-lcs (1.1.2)
+    addressable (2.2.7)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
     hashie (1.2.0)
-    nokogiri (1.5.0)
-    omniauth (1.0.0)
+    nokogiri (1.5.2)
+    omniauth (1.0.3)
       hashie (~> 1.2)
       rack
-    rack (1.2.2)
-    rack-test (0.5.7)
+    rack (1.4.1)
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rake (0.8.7)
+    rake (0.9.2.2)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)
       rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
+    rspec-core (2.5.2)
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)

data/lib/omniauth/strategies/crowd.rb

@@ -19,7 +19,7 @@ module OmniAuth
           get_credentials
         else
           session['omniauth.crowd'] = {'username' => request['username'], 'password' => request['password']}
-          redirect callback_path
+          redirect callback_url
         end
       end
     

data/lib/omniauth/strategies/crowd/configuration.rb

@@ -4,7 +4,12 @@ module OmniAuth
   module Strategies
     class Crowd
       class Configuration
-        attr_reader :crowd_application_name, :crowd_password
+        DEFAULT_AUTHENTICATION_URL = "%s/rest/usermanagement/latest/authentication"
+        DEFAULT_USER_GROUP_URL = "%s/rest/usermanagement/latest/user/group/direct"
+        attr_reader :crowd_application_name, :crowd_password, :disable_ssl_verification, :include_users_groups
+
+        alias :"disable_ssl_verification?" :disable_ssl_verification
+        alias :"include_users_groups?" :include_users_groups
         
         # @param [Hash] params configuration options
         # @option params [String, nil] :crowd_server_url the Crowd server root URL; probably something like
@@ -15,7 +20,11 @@ module OmniAuth
         # @option params [String, nil] :application_name the application name specified in Crowd for this application, required.
         # @option params [String, nil] :application_password the application password specified in Crowd for this application, required.
         # @option params [Boolean, nil] :disable_ssl_verification disable verification for SSL cert,
-        # helpful when you developing with a fake cert.
+        #         helpful when you developing with a fake cert.
+        # @option params [Boolean, true] :   include a list of user groups when getting information ont he user
+        # @option params [String, nil] :crowd_user_group_url (:crowd_server_url + '/rest/usermanagement/latest/user/group/direct') the URL to which to
+        #         use for retrieving users groups optional if `:crowd_server_url` is specified, or if `:include_user_groups` is false
+        #         required otherwise.
         def initialize(params)
           parse_params params
         end
@@ -24,31 +33,36 @@ module OmniAuth
         #
         # @param [String] username the username to validate 
         # 
-        # @return [String] a URL like `http://cas.mycompany.com/login?service=...`
+        # @return [String] a URL like `https://crowd.myhost.com/crowd/rest/usermanagement/latest/authentication?username=USERNAME`
         def authentication_url(username)
           append_username @authentication_url, username
         end
-
-        def disable_ssl_verification?
-          @disable_ssl_verification
+        
+        def user_group_url(username)
+          @user_group_url.nil? ? nil : append_username( @user_group_url, username)
         end
         
         private
-        DEFAULT_AUTHENTICATION_URL = "%s/rest/usermanagement/latest/authentication"
         def parse_params(options)
+          options= {:include_user_groups => true}.merge(options || {})
           %w(application_name application_password).each do |opt|
-            raise ArgumentError.new(":#{opt} MUST be provided") if options[opt.to_sym].blank?
+            raise ArgumentError.new(":#{opt} MUST be provided") if options[opt.to_sym] == ""
           end
           @crowd_application_name = options[:application_name]
           @crowd_password         = options[:application_password]
 
-          unless options.include?(:crowd_server_url) or options.include?(:crowd_authentication_url)
+          unless options.include?(:crowd_server_url) || options.include?(:crowd_authentication_url)
             raise ArgumentError.new("Either :crowd_server_url or :crowd_authentication_url MUST be provided")
           end
           @authentication_url     = options[:crowd_authentication_url] || DEFAULT_AUTHENTICATION_URL % options[:crowd_server_url]
           validate_is_url 'authentication URL', @authentication_url
-
           @disable_ssl_verification = options[:disable_ssl_verification]
+          @include_users_groups     = options[:include_user_groups]
+          if @include_users_groups
+            @user_group_url         = options[:crowd_user_group_url] || DEFAULT_USER_GROUP_URL % options[:crowd_server_url]
+            validate_is_url 'user group URL', @user_group_url
+          end
+
         end
 
         IS_NOT_URL_ERROR_MESSAGE = "%s is not a valid URL"

data/lib/omniauth/strategies/crowd/crowd_validator.rb

@@ -6,44 +6,69 @@ module OmniAuth
   module Strategies
     class Crowd
       class CrowdValidator
+        AUTHENTICATION_REQUEST_BODY = "<password><value>%s</value></password>"
         def initialize(configuration, username, password)
           @configuration, @username, @password = configuration, username, password
-          @uri = URI.parse(@configuration.authentication_url(@username))
+          @authentiction_uri = URI.parse(@configuration.authentication_url(@username))
+          @user_group_uri    = @configuration.include_users_groups? ? URI.parse(@configuration.user_group_url(@username)) : nil
         end
 
         def user_info
-          if is_user_authorized?
-            parse_user_info
+          user_info_hash = retrieve_user_info!
+          if user_info_hash && @configuration.include_users_groups?
+            add_user_groups(user_info_hash)
           else
             nil
           end
         end
 
         private
-        def parse_user_info
-          return nil if @body.nil? || @body == ''
-          doc = Nokogiri::XML(@body)
-          return nil if doc.nil?
-          {
-            "user" => doc.xpath("//user/@name").to_s,
-            "name" => doc.xpath("//user/display-name/text()").to_s,
-            "first_name" => doc.xpath("//user/first-name/text()").to_s,
-            "last_name" => doc.xpath("//user/last-name/text()").to_s,
-            "email" => doc.xpath("//user/email/text()").to_s
-          }
+        def add_user_groups(user_info_hash)
+          response, body = make_user_group_request
+          unless response.code.to_i != 200 || body.nil? || body == '' 
+            doc = Nokogiri::XML(body)
+            user_info_hash["groups"] = doc.xpath("//groups/group/@name").map(&:to_s)
+          end
+          user_info_hash
         end
-        AUTHENTICATION_REQUEST_BODY = "<password><value>%s</value></password>"
-        def is_user_authorized?
-          http = Net::HTTP.new(@uri.host, @uri.port)
-          http.use_ssl = @uri.port == 443 || @uri.instance_of?(URI::HTTPS)
+        
+        def retrieve_user_info!
+          response, body = make_authorization_request
+          unless response.code.to_i != 200 || body.nil? || body == '' 
+            doc = Nokogiri::XML(body)
+            {
+              "user" => doc.xpath("//user/@name").to_s,
+              "name" => doc.xpath("//user/display-name/text()").to_s,
+              "first_name" => doc.xpath("//user/first-name/text()").to_s,
+              "last_name" => doc.xpath("//user/last-name/text()").to_s,
+              "email" => doc.xpath("//user/email/text()").to_s
+            }
+          else
+            nil
+          end
+        end
+        
+        def make_user_group_request
+          http = Net::HTTP.new(@user_group_uri.host, @user_group_uri.port)
+          http.use_ssl = @user_group_uri.port == 443 || @user_group_uri.instance_of?(URI::HTTPS)
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl? && @configuration.disable_ssl_verification?
+          http.start do |c|
+            req = Net::HTTP::Get.new("#{@user_group_uri.path}?#{@user_group_uri.query}")
+            req.basic_auth @configuration.crowd_application_name, @configuration.crowd_password
+            http.request(req)
+          end
+        end
+        
+        def make_authorization_request 
+          http = Net::HTTP.new(@authentiction_uri.host, @authentiction_uri.port)
+          http.use_ssl = @authentiction_uri.port == 443 || @authentiction_uri.instance_of?(URI::HTTPS)
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl? && @configuration.disable_ssl_verification?
           http.start do |c|
-            req = Net::HTTP::Post.new("#{@uri.path}?#{@uri.query}")
+            req = Net::HTTP::Post.new("#{@authentiction_uri.path}?#{@authentiction_uri.query}")
             req.body = AUTHENTICATION_REQUEST_BODY % @password
             req.basic_auth @configuration.crowd_application_name, @configuration.crowd_password
             req.add_field 'Content-Type', 'text/xml'
-            @response, @body = http.request(req)
-            @response.code.to_i == 200
+            http.request(req)
           end
         end
       end

data/lib/omniauth_crowd.rb

@@ -1,2 +1 @@
-require "omniauth_crowd/version"
 require 'omniauth/strategies/crowd'

data/lib/omniauth_crowd/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Crowd
-    VERSION = "2.0.1"
+    VERSION = "2.1.0"
   end
 end

data/spec/fixtures/groups.xml

@@ -0,0 +1,8 @@
+<groups expand="group">
+<group name="Developers">
+<link rel="self" href="http://crowd.bogus.com/crowd/rest/usermanagement/latest/group?groupname=Developers"/>
+</group>
+<group name="jira-users">
+<link rel="self" href="http://crowd.bogus.com/crowd/rest/usermanagement/latest/group?groupname=jira-users"/>
+</group>
+</groups>

data/spec/omniauth/strategies/crowd_spec.rb

@@ -26,7 +26,7 @@ describe OmniAuth::Strategies::Crowd, :type=>:strategy do
 
       it 'should redirect to callback' do
         last_response.should be_redirect
-        last_response.headers['Location'].should == '/auth/crowd/callback'
+        last_response.headers['Location'].should == 'http://example.org/auth/crowd/callback'
       end
     end
 
@@ -44,6 +44,8 @@ describe OmniAuth::Strategies::Crowd, :type=>:strategy do
         before do
           stub_request(:post, "https://bogus_app:bogus_app_password@crowd.example.org/rest/usermanagement/latest/authentication?username=foo").
             to_return(:body => File.read(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'success.xml')))
+          stub_request(:get, "https://bogus_app:bogus_app_password@crowd.example.org/rest/usermanagement/latest/user/group/direct?username=foo").
+            to_return(:body => File.read(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'groups.xml')))
           get '/auth/crowd/callback', nil, 'rack.session'=>{'omniauth.crowd'=> {"username"=>"foo", "password"=>"ba"}}
         end
         it 'should call through to the master app' do
@@ -57,6 +59,7 @@ describe OmniAuth::Strategies::Crowd, :type=>:strategy do
             auth = last_request.env['omniauth.auth']['provider'].should == :crowd
             auth = last_request.env['omniauth.auth']['uid'].should == 'foo'
             auth = last_request.env['omniauth.auth']['user_info'].should be_kind_of(Hash)
+            auth = last_request.env['omniauth.auth']['user_info']['groups'].sort.should == ["Developers", "jira-users"].sort
           end
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: omniauth_crowd
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 2
-  - 0
   - 1
-  version: 2.0.1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Robert Di Marco
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-23 00:00:00 Z
+date: 2012-03-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: omniauth
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,12 +28,12 @@ dependencies:
         - 1
         - 0
         version: "1.0"
+  requirement: *id001
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  name: omniauth
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,12 +44,12 @@ dependencies:
         - 4
         - 4
         version: 1.4.4
+  requirement: *id002
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rack
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  name: nokogiri
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +58,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id003
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  name: rack
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +72,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id004
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  name: rake
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,12 +86,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id005
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  name: rack-test
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -104,12 +102,12 @@ dependencies:
         - 5
         - 0
         version: 2.5.0
+  requirement: *id006
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -120,12 +118,12 @@ dependencies:
         - 3
         - 4
         version: 1.3.4
+  requirement: *id007
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  name: webmock
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -136,8 +134,10 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  requirement: *id008
   type: :development
-  version_requirements: *id008
+  prerelease: false
+  name: bundler
 description: This is an OmniAuth provider for Atlassian Crowd's REST API.  It allows you to easily integrate your Rack application in with Atlassian Crowd.
 email: 
 - rob@innovationontherun.com
@@ -155,13 +155,13 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/omniauth/strategies/crowd.rb
 - lib/omniauth/strategies/crowd/configuration.rb
 - lib/omniauth/strategies/crowd/crowd_validator.rb
 - lib/omniauth_crowd.rb
 - lib/omniauth_crowd/version.rb
 - omniauth_crowd.gemspec
+- spec/fixtures/groups.xml
 - spec/fixtures/success.xml
 - spec/omniauth/strategies/crowd_spec.rb
 - spec/spec_helper.rb
@@ -199,6 +199,7 @@ signing_key:
 specification_version: 3
 summary: An OmniAuth provider for Atlassian Crowd REST API
 test_files: 
+- spec/fixtures/groups.xml
 - spec/fixtures/success.xml
 - spec/omniauth/strategies/crowd_spec.rb
 - spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-1.0.1