shibboleth-rails 0.1.0

data/.gitignore

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

data/Gemfile

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

data/Rakefile

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

data/app/controllers/user_sessions_controller.rb

@@ -0,0 +1,25 @@
+class UserSessionsController < ApplicationController
+
+	skip_before_filter :require_shibboleth
+	before_filter :not_in_production
+
+	def new
+		@users = User.all
+	end
+
+	def create
+		session[:simulate_id] = params[:user_id]
+		redirect_to root_url
+	end
+
+	def destroy
+		session[:simulate_id] = nil
+		redirect_to new_user_session_url, :notice => "Logout successful!"
+	end
+
+	private
+	def not_in_production
+		redirect_to root_url if Rails.env.production?
+	end
+
+end

data/app/views/user_sessions/new.html.haml

@@ -0,0 +1,4 @@
+= form_tag user_session_path do
+	Login as:
+	= select_tag :user_id, options_from_collection_for_select(@users, :id, :name_n)
+	= submit_tag "Login"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+	unless Rails.env.production?
+		resource :user_session, :only => [:new, :create, :destroy]
+	end
+end

data/lib/shibboleth-rails.rb

@@ -0,0 +1,4 @@
+require "shibboleth-rails/version"
+require 'shibboleth-rails/engine'
+require 'shibboleth-rails/controller_additions'
+require 'shibboleth-rails/user_model_additions'

data/lib/shibboleth-rails/controller_additions.rb

@@ -0,0 +1,43 @@
+module Shibboleth::Rails
+
+	module ControllerAdditions
+		private
+
+		def authenticated?
+			request.env['employeeNumber'].present?
+		end
+
+		def shibboleth
+			{:emplid => request.env['employeeNumber'],
+			 :name_n => request.env['REMOTE_USER'].chomp("@osu.edu")}
+		end
+
+		def current_user
+			return @current_user if defined?(@current_user)
+			@current_user = if session[:simulate_id].present?
+												User.find(session[:simulate_id])
+											elsif authenticated?
+												User.find_or_create_from_shibboleth(shibboleth)
+											end
+		end
+
+		def require_shibboleth
+			unless current_user
+				if Rails.env.production?
+					base = request.protocol + request.host
+					requested_url = base + request.request_uri
+					redirect_to [base, '/Shibboleth.sso/Login?target=',
+						CGI.escape(requested_url)].join
+				else
+					redirect_to new_user_session_url, :notice => 'Login first, please.'
+				end
+			end
+		end
+	end
+
+end
+
+ActionController::Base.class_eval do
+	include Shibboleth::Rails::ControllerAdditions
+	helper_method :current_user
+end

data/lib/shibboleth-rails/engine.rb

@@ -0,0 +1,6 @@
+module Shibboleth::Rails
+
+	class Engine < ::Rails::Engine
+	end
+
+end

data/lib/shibboleth-rails/user_model_additions.rb

@@ -0,0 +1,15 @@
+module Shibboleth::Rails
+
+	module ModelAdditions
+		def find_or_create_from_shibboleth(identity)
+			user = find_or_create_by_emplid(identity)
+
+			# names change due to marriage, etc.
+			# update_attribute is a NOOP if not different
+			user.update_attribute(:name_n, identity[:name_n])
+
+			user
+		end
+	end
+
+end

data/lib/shibboleth-rails/version.rb

@@ -0,0 +1,5 @@
+module Shibboleth
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/shibboleth-rails.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shibboleth-rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shibboleth-rails"
+  s.version     = Shibboleth::Rails::VERSION
+  s.authors     = ["mikegee"]
+  s.email       = ["gee.24@osu.edu"]
+  s.homepage    = "https://github.com/ASCTech/shibboleth-rails"
+  s.summary     = %q{This Rails plugin integrates Shibboletth single signon.}
+  s.description = %q{Environment variables that Shibboleth sets are used to determine 'current_user'.  An interface to login as any user is also provided for running in development.}
+
+  s.rubyforge_project = "shibboleth-rails"
+
+  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_runtime_dependency "rails", '>3.0'
+  s.add_runtime_dependency "haml"
+end

data/spec/controllers/user_sessions_controller_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe UserSessionsController do
+	before { @user = Factory(:user) }
+
+	describe 'loading the login page' do
+		before { get :new }
+		it { should respond_with(:success) }
+		it { should assign_to(:user_session) }
+		it { should assign_to(:users), :with => [@user] }
+	end
+
+	describe 'loggin in' do
+		before { post :create, :user_id => @user.id }
+		it 'should login the user' do
+			UserSession.find.user.should == @user
+		end
+		it { should respond_with(:redirect), :to => root_url }
+		it { should set_the_flash.to("You are now logged in as #{@user.name_n}.") }
+	end
+
+	describe 'logging out' do
+		before do
+			UserSession.create(@user)
+			delete :destroy
+		end
+		it 'should log out the user' do
+			UserSession.find.should be_nil
+		end
+		it { should respond_with(:redirect), :to => new_user_session_url }
+		it { should set_the_flash.to('Logout successful!') }
+	end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: shibboleth-rails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mikegee
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Environment variables that Shibboleth sets are used to determine 'current_user'.  An interface to login as any user is also provided for running in development.
+email: 
+- gee.24@osu.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- app/controllers/user_sessions_controller.rb
+- app/views/user_sessions/new.html.haml
+- config/routes.rb
+- lib/shibboleth-rails.rb
+- lib/shibboleth-rails/controller_additions.rb
+- lib/shibboleth-rails/engine.rb
+- lib/shibboleth-rails/user_model_additions.rb
+- lib/shibboleth-rails/version.rb
+- shibboleth-rails.gemspec
+- spec/controllers/user_sessions_controller_spec.rb
+homepage: https://github.com/ASCTech/shibboleth-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: shibboleth-rails
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: This Rails plugin integrates Shibboletth single signon.
+test_files: 
+- spec/controllers/user_sessions_controller_spec.rb