oa-casport 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@oa-casport

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in oa-casport.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/oa-casport.rb

@@ -0,0 +1,10 @@
+$:.push File.expand_path('lib', __FILE__)
+
+require "oa-casport/version"
+require 'omniauth/core'
+
+module OmniAuth
+  module Strategies
+    autoload :Casport, 'omniauth/strategies/casport'
+  end
+end

data/lib/oa-casport/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Casport
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/casport.rb

@@ -0,0 +1,142 @@
+require 'omniauth/core'
+require 'httparty'
+require 'redis'
+require 'uri'
+
+module OmniAuth
+  module Strategies
+    #
+    # Authentication to CASPORT
+    #
+    # @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        => '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.'
+    #      }
+    class Casport
+
+      include OmniAuth::Strategy
+      include HTTParty
+      
+      def initialize(app, options)
+        super(app, :casport)
+        @options = options
+        @options[:cas_server]    ||= 'http://cas.dev/users'
+        @options[:format]        ||= 'xml'
+        @options[:format_header] ||= 'application/xml'
+      end
+
+      def request_phase
+        # Can't get user data without their UID for the CASPORT server 
+        raise "No UID set in request.env['omniauth.strategy'].options[:uid]" if @options[:uid].nil?
+        Casport.setup_httparty(@options)
+        redirect(callback_path)
+      end
+    
+      def callback_phase
+        begin
+          raise 'We seemed to have misplaced your credentials... O_o' if user.nil?
+          super
+        rescue => e
+          redirect(request_path)
+#          fail!(:invalid_credentials, e)
+        end
+        call_app!
+      end
+
+      def auth_hash
+        # store user in a local var to avoid new method calls for each attribute
+        user_obj = user
+        begin
+          # convert all Java camelCase keys to Ruby snake_case, it just feels right!
+          user_obj = user_obj['userinfo'].inject({}){|memo, (k,v)| memo[k.gsub(/[A-Z]/){|c| '_'+c.downcase}] = v; memo}
+        rescue => e
+          fail!(:invalid_user, e)
+        end
+        OmniAuth::Utils.deep_merge(super, {
+          'uid'       => user_obj['uid'],
+          'user_info' => {
+                          'name' => user_obj['full_name'],
+                          'email' => user_obj['email']
+                         },
+          'extra'     => {'user_hash' => user_obj}
+        })
+      end
+
+      # Set HTTParty params that we need to set after initialize is called
+      # These params come from @options within initialize and include the following:
+      # :ssl_ca_file - SSL CA File for SSL connections
+      # :format - 'json', 'xml', 'html', etc. || Defaults to 'xml'
+      # :format_header - :format Header string || Defaults to 'application/xml'
+      # :pem_cert - /path/to/a/pem_formatted_certificate.pem for SSL connections
+      # :pem_cert_pass - plaintext password, not recommended!
+      def self.setup_httparty(opts)
+        format opts[:format].to_sym
+        headers 'Accept' => opts[:format_header]
+        if opts[:ssl_ca_file]
+          ssl_ca_file opts[:ssl_ca_file]
+          if opts[:pem_cert_pass]
+            pem File.read(opts[:pem_cert]), opts[:pem_cert_pass]
+          else
+            pem File.read(opts[:pem_cert])
+          end
+        end
+      end
+      
+      def user
+        # 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
+        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])
+          unless @user = (cache.get @options[:uid])
+            # 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
+          end
+        # If we can't connect to Redis...
+        rescue Errno::ECONNREFUSED => e
+          @user ||= Casport.get(url).parsed_response
+        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."
+        end
+        is_empty == true ? true : nil
+      end
+      
+    end
+  end
+end

data/oa-casport.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "oa-casport/version"
+
+Gem::Specification.new do |s|
+  s.name        = "oa-casport"
+  s.version     = OmniAuth::Casport::VERSION
+  s.authors     = ["Jesus Jackson", "Steven Haddox"]
+  s.email       = ["jesusejackson@gmail.com", "stevenhaddox@shortmail.com"]
+  s.homepage    = "http://oa-casport.slkdemos.com"
+  s.summary     = %q{OmniAuth gem for internal casport server}
+  s.description = %q{ Simple gem to enable rack powered Ruby apps to authenticate internally via CASPORT with ease}
+  s.rubyforge_project = "oa-casport"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'oa-core'
+  s.add_dependency 'httparty'
+  s.add_dependency 'redis'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: oa-casport
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jesus Jackson
+- Steven Haddox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oa-core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: " Simple gem to enable rack powered Ruby apps to authenticate internally via CASPORT with ease"
+email: 
+- jesusejackson@gmail.com
+- stevenhaddox@shortmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- lib/oa-casport.rb
+- lib/oa-casport/version.rb
+- lib/omniauth/strategies/casport.rb
+- oa-casport.gemspec
+has_rdoc: true
+homepage: http://oa-casport.slkdemos.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: oa-casport
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: OmniAuth gem for internal casport server
+test_files: []
+