oa-casport 0.1.1 → 0.1.4

data/README.md

@@ -0,0 +1,39 @@
+# oa-casport
+
+The goal of this gem is to allow CASPORT integartion with your rack-based application easily through OmniAuth.
+
+## Installation
+
+Add the following line to your Gemfile:
+
+  gem 'oa-casport'
+
+## Configuration Parameters:
+
+Configuration within the initializer for OmniAuth:
+
+    # @example Basic Usage
+    #
+    #  use OmniAuth::Strategies::Casport, {
+    #    :setup => true
+    #  }
+    # 
+    # @example Full Options Usage
+    #
+    #  use OmniAuth::Strategies::Casport, {
+    #    :setup         => true,
+    #    :cas_server    => 'http://cas.slkdemos.com/users/',
+    #    :format        => 'json', 'xml' || Defaults to 'xml'
+    #    :format_header => 'application/xml', 'application/json' || Defaults to 'application/xml'
+    #    :ssl_ca_file   => 'path/to/ca_file.crt',
+    #    :pem_cert      => '/path/to/cert.pem',
+    #    :pem_cert_pass => 'keep it secret, keep it safe.',
+    #    :redis_options => 'disabled'
+    #  }
+
+## Example Applications
+
+You can see how to set it up and use it with a Rails 3 application at: [https://github.com/stevenhaddox/oa-casport-rails3](https://github.com/stevenhaddox/oa-casport-rails3)
+
+\#TODO: You can see how to set it up and use it with a Sinatra application at: [https://github.com/stevenhaddox/oa-casport-sinatra](https://github.com/stevenhaddox/oa-casport-sinatra)
+

data/lib/oa-casport/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Casport
-    VERSION = "0.1.1"
+    VERSION = "0.1.4"
   end
 end

data/lib/omniauth/strategies/casport.rb

@@ -2,6 +2,7 @@ require 'omniauth/core'
 require 'httparty'
 require 'redis'
 require 'uri'
+require 'yaml'
 
 module OmniAuth
   module Strategies
@@ -11,19 +12,20 @@ module OmniAuth
     # @example Basic Usage
     #
     #  use OmniAuth::Strategies::Casport, {
-    #        :setup       => true
-    #      }
+    #    :setup       => true
+    #  }
     # @example Full Options Usage
     #
     #  use OmniAuth::Strategies::Casport, {
-    #        :setup         => true,
-    #        :cas_server    => 'http://cas.slkdemos.com/users/',
-    #        :format        => 'json', 'xml', 'html', etc. || Defaults to 'xml'
-    #        :format_header => 'application/xml',
-    #        :ssl_ca_file   => 'path/to/ca_file.crt',
-    #        :pem_cert      => '/path/to/cert.pem',
-    #        :pem_cert_pass => 'keep it secret, keep it safe.'
-    #      }
+    #    :setup         => true,
+    #    :cas_server    => 'http://cas.slkdemos.com/users/',
+    #    :format        => 'json', 'xml', 'html', etc. || Defaults to 'xml'
+    #    :format_header => 'application/xml',
+    #    :ssl_ca_file   => 'path/to/ca_file.crt',
+    #    :pem_cert      => '/path/to/cert.pem',
+    #    :pem_cert_pass => 'keep it secret, keep it safe.',
+    #    :redis_options => 'disabled' or options_hash || Defaults to {:host => '127.0.0.1', :port => 6739}
+    #  }
     class Casport
 
       include OmniAuth::Strategy
@@ -65,7 +67,7 @@ module OmniAuth
           fail!(:invalid_user, e)
         end
         OmniAuth::Utils.deep_merge(super, {
-          'uid'       => user_obj['uid'],
+          'uid'       => user_obj['dn'],
           'user_info' => {
                           'name' => user_obj['full_name'],
                           'email' => user_obj['email']
@@ -83,7 +85,9 @@ module OmniAuth
       # :pem_cert_pass - plaintext password, not recommended!
       def self.setup_httparty(opts)
         format opts[:format].to_sym
-        headers 'Accept' => opts[:format_header]
+        headers 'Accept'               => opts[:format_header]
+        headers 'Content-Type'         => opts[:format_header]
+        headers 'X-XSRF-UseProtection' => 'false' if opts[:format] == 'json'
         if opts[:ssl_ca_file]
           ssl_ca_file opts[:ssl_ca_file]
           if opts[:pem_cert_pass]
@@ -98,12 +102,19 @@ module OmniAuth
         # Can't get user data without a UID from the application
         begin
           raise "No UID set in request.env['omniauth.strategy'].options[:uid]" if @options[:uid].nil?
-          @options[:uid] = @options[:uid].to_s
+          # Fix DN order (if we have a DN) for CASPORT to work properly
+          if @options[:uid].include?('/') or @options[:uid].include?(',')
+            # Convert '/' to ',' and split on ','
+            @options[:uid] = @options[:uid].gsub('/',',').split(',').reject{|array| array.all? {|el| el.nil? || el.strip.empty? }}
+            # See if the DN is in the order CASPORT expects (and fix it if needed)
+            @options[:uid] = @options[:uid].reverse if @options[:uid].first.downcase.include? 'c='
+            # Join our array of DN elements back together with a comma as expected by CASPORT
+            @options[:uid] = @options.join ','
+          end
         rescue => e
           fail!(:uid_not_found, e)
         end
 
-        url = URI.escape("#{@options[:cas_server]}/#{@options[:uid]}.#{@options[:format]}")
         begin
           raise Errno::ECONNREFUSED if @options[:redis_options] == 'disabled'
           cache = @options[:redis_options].nil? ? Redis.new : Redis.new(@options[:redis_options])
@@ -111,30 +122,33 @@ module OmniAuth
             # User is not in the cache
             # Retrieving the user data from CASPORT
             # {'userinfo' => {{'uid' => UID}, {'fullName' => NAME},...}},
-            @user = Casport.get(url).parsed_response
-            cache.set @options[:uid], @user
-            # CASPORT expiration time for user (24 hours => 1440 seconds)
-            cache.expire @options[:uid], 1440
+            get_user
+            if @user
+              # Set Redis object for the user, and expire after 24 hours
+              cache.set @options[:uid], @user.to_yaml
+              cache.expire @options[:uid], 1440
+            end
+          else
+            # We found our user in the cache, let's parse it into a Ruby object
+            @user = YAML::load(@user)
           end
         # If we can't connect to Redis...
         rescue Errno::ECONNREFUSED => e
-          @user ||= Casport.get(url).parsed_response
+          get_user
         end
-        @user = nil if user_empty?
         @user
       end
 
-      # Investigate user_obj to see if it's empty (or anti-pattern data)
-      def user_empty?
-        is_empty = false
-        is_empty = true if @user.nil?
-        is_empty = true if @user.empty?
-        # If it isn't empty yet, let's convert it into a Hash object for easy parsing via eval
-        unless @user.class == Hash
-          is_empty = true
-          raise "String returned when a Hash was expected."
+      # Query for the user against CASPORT, return as nil or parsed object
+      def get_user
+        return if @user # no extra http calls
+        url = URI.escape("#{@options[:cas_server]}/#{@options[:uid]}.#{@options[:format]}")
+        response = Casport.get(url)
+        if response.success?
+          @user = response.parsed_response
+        else
+          @user = nil
         end
-        is_empty == true ? true : nil
       end
       
     end

data/oa-casport.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'oa-core'
   s.add_dependency 'httparty'
   s.add_dependency 'redis'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fakeweb'
 end

data/spec/casport_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '../lib/omniauth/strategies/casport.rb')
+
+desribe ".user" do
+  let(:app) { lamdba { |env| [200, {}, ['Test']] } }
+  
+  it "should have correct xml returned" do
+    result = {'userinfo' => {'name' => 'Tyler Durden'}}
+    userinfo = '<userinfo><name>Tyler Durden</name></userinfo>'
+    FakeWeb.register_uri(:get, 'http://cas.dev/dn', :body => userinfo)
+    options = {:dn => 'dn', :cas_server => 'http://cas.dev/'}
+    user = OmniAuth::Strategies::Casport.new(app, options).user
+    user.should == result
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'fakeweb'
+require 'oa-casport'
+require 'httparty'
+require 'redis'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end
+
+before(:each) do
+  FakeWeb.clean_registry
+end

metadata

@@ -2,7 +2,7 @@
 name: oa-casport
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors: 
 - Jesus Jackson
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 -04:00
+date: 2011-07-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,28 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: " Simple gem to enable rack powered Ruby apps to authenticate internally via casport with ease"
 email: 
 - jesusejackson@gmail.com
@@ -61,12 +83,14 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
-- README
+- README.md
 - Rakefile
 - lib/oa-casport.rb
 - lib/oa-casport/version.rb
 - lib/omniauth/strategies/casport.rb
 - oa-casport.gemspec
+- spec/casport_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/stevenhaddox/oa-casport
 licenses: []
@@ -95,5 +119,6 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: OmniAuth gem for internal casport server
-test_files: []
-
+test_files: 
+- spec/casport_spec.rb
+- spec/spec_helper.rb

data/README

@@ -1,30 +0,0 @@
-# oa-casport is a custom strategy for authentication with Casport that works with the OmniAuth gem
-
-## Examples:
-
-You can see how to set it up and use it with a Rails 3 application at: [https://github.com/stevenhaddox/oa-casport-rails3](https://github.com/stevenhaddox/oa-casport-rails3)
-
-\#TODO: You can see how to set it up and use it with a Sinatra application at: [https://github.com/stevenhaddox/oa-casport-sinatra](https://github.com/stevenhaddox/oa-casport-sinatra)
-
-## Configuration Parameters:
-
-Configuration within the initializer for OmniAuth:
-
-    # @example Basic Usage
-    #
-    #  use OmniAuth::Strategies::Casport, {
-    #        :setup => true
-    #      }
-    # @example Full Options Usage
-    #
-    #  use OmniAuth::Strategies::Casport, {
-    #        :setup         => true,
-    #        :cas_server    => 'http://cas.slkdemos.com/users/',
-    #        :format        => 'json', 'xml', 'html', etc. || Defaults to 'xml'
-    #        :format_header => 'application/xml',
-    #        :ssl_ca_file   => 'path/to/ca_file.crt',
-    #        :pem_cert      => '/path/to/cert.pem',
-    #        :pem_cert_pass => 'keep it secret, keep it safe.'
-    #      }
-
-