ccls-calnet_authenticated 1.3.2

data/README.rdoc

@@ -0,0 +1,59 @@
+= CalNet Authenticated
+
+In Heavy Development ...
+
+This is a "rails" gem, so much of the code will
+be for testing in a rails app, but will not be
+included in the actual gem.
+
+== ToDo
+
+* Include migrations with an rsync or a generator
+* preferably a generator, but they are diff in rails 3
+  * rake task require mods to the Rakefile
+  * append requirement to Rakefile ?
+  * perhaps add initializer (don't know how rails 3 does it)
+* import some tests
+* include any test helpers for users
+* Cleanup code.  Isolate requirements
+* Too many quirks to keep controllers and views in gem so install them in app with generator.
+
+== Installation / Usage
+
+ config.gem 'ccls-calnet_authenticated',
+   :source => 'http://rubygems.org'
+
+ class User
+   calnet_authenticated
+ end
+
+ # Generates a db migration
+ script/generate calnet_authenticated User
+
+As some methods, like current_user, are flexible
+and dependent upon the developer's choice of user
+model, eager loading isn't good enough.
+The developer will need to ensure that the model
+is always around.  I chose to simply add ...
+
+ require 'user' <- or whatever your user model is
+
+to the bottom of my config/environment.rb outside
+of the initializer block.
+
+
+== Gemified with Jeweler
+
+ vi Rakefile
+ rake version:write
+
+ rake version:bump:patch
+ rake version:bump:minor
+ rake version:bump:major
+
+ rake gemspec
+
+ rake install
+ rake release
+
+Copyright (c) 2010 [George 'Jake' Wendt], released under the MIT license

data/generators/calnet_authenticated/USAGE

@@ -0,0 +1,15 @@
+script/generate calnet_authenticated
+
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate calnet_authenticated
+
+    This will create:
+        a migration file for 
+
+				a bunch of stuff
+
+
+blah blah blah

data/generators/calnet_authenticated/calnet_authenticated_generator.rb

@@ -0,0 +1,118 @@
+#class CalnetAuthenticatedGenerator < Rails::Generator::NamedBase
+class CalnetAuthenticatedGenerator < Rails::Generator::Base
+
+	def manifest
+		record do |m|
+			#	The autotest file will require that the app actually 
+			#		looks for autotest files.
+			m.directory('config/autotest')
+			m.file('autotest_calnet_authenticated.rb', 'config/autotest/calnet_authenticated.rb')
+
+			#	*.rake files in the lib/tasks/ directory are automatically
+			#		loaded so nothing is required to include this.
+			m.directory('lib/tasks')
+			m.file('calnet_authenticated.rake', 'lib/tasks/calnet_authenticated.rake')
+
+#	may want to consider installing roles.yml ( actually have in simply_authorized )
+
+			m.migration_template 'migration.rb', 'db/migrate', 
+				:migration_file_name => "add_calnet_authenticated_columns_to_users"
+#				:migration_file_name => "add_calnet_authenticated_columns_to_#{file_path.gsub(/\//, '_').pluralize}"
+
+			dot = File.dirname(__FILE__)
+
+			m.directory('public/javascripts')
+			Dir["#{dot}/templates/javascripts/*js"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "public/javascripts/#{File.basename(file)}")
+			}
+			m.directory('public/stylesheets')
+			Dir["#{dot}/templates/stylesheets/*css"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "public/stylesheets/#{File.basename(file)}")
+			}
+
+
+
+#	Due to the ApplicationController errors, don't use 
+#		controllers in the gem.  Models and unit tests
+#		seem to work just fine as they are subclasses of 
+#		ActiveRecord::Base.  Controllers are subclasses of
+#		ApplicationController, which is in the application.
+#
+#	TODO copy routes maybe?	How to copy in the complex route?
+#				Simple, restful route is simple.
+#				Probably have to do this manually.
+#
+#	TODO copy controllers, views and functional tests.
+#		there are no views
+
+#			m.directory('app/views/photos')
+#			Dir["#{dot}/templates/views/photos/*rb"].each{|file| 
+#				f = file.split('/').slice(-3,3).join('/')
+#	has an extra directory in path which is needed in m.file(f
+#	which is relative to templates/
+#				m.file(f, "app/views/photos/#{File.basename(file)}")
+#			}
+#
+#	more generic way (not yet actually tested)
+
+			Dir["#{dot}/templates/views/*/**/"].each do |dir|
+				last_dir = dir.split('/').last
+				m.directory("app/views/#{last_dir}")
+				Dir["#{dot}/templates/views/#{last_dir}/*rb"].each do |file|
+					f = file.split('/').slice(-3,3).join('/')
+					m.file(f, "app/views/#{last_dir}/#{File.basename(file)}")
+				end
+			end
+
+			m.directory('app/controllers')
+			Dir["#{dot}/templates/controllers/*rb"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "app/controllers/#{File.basename(file)}")
+			}
+			m.directory('test/functional/calnet_authenticated')
+			Dir["#{dot}/templates/functional/*rb"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "test/functional/calnet_authenticated/#{File.basename(file)}")
+			}
+
+#			m.directory('test/unit/authorized')
+#			Dir["#{dot}/templates/unit/*rb"].each{|file| 
+#				f = file.split('/').slice(-2,2).join('/')
+#				m.file(f, "test/unit/authorized/#{File.basename(file)}")
+#			}
+
+		end
+	end
+
+end
+module Rails::Generator::Commands
+	class Create
+		def migration_template(relative_source, 
+				relative_destination, template_options = {})
+			migration_directory relative_destination
+			migration_file_name = template_options[
+				:migration_file_name] || file_name
+			if migration_exists?(migration_file_name)
+				puts "Another migration is already named #{migration_file_name}: #{existing_migrations(migration_file_name).first}: Skipping" 
+			else
+				template(relative_source, "#{relative_destination}/#{next_migration_string}_#{migration_file_name}.rb", template_options)
+			end
+		end
+	end #	Create
+	class Base
+	protected
+		#	the loop through migrations happens so fast
+		#	that they all have the same timestamp which
+		#	won't work when you actually try to migrate.
+		#	All the timestamps MUST be unique.
+		def next_migration_string(padding = 3)
+			@s = (!@s.nil?)? @s.to_i + 1 : if ActiveRecord::Base.timestamped_migrations
+				Time.now.utc.strftime("%Y%m%d%H%M%S")
+			else
+				"%.#{padding}d" % next_migration_number
+			end
+		end
+	end	#	Base
+end

data/generators/calnet_authenticated/templates/autotest_calnet_authenticated.rb

@@ -0,0 +1,3 @@
+#	From `script/generate calnet_authenticated` ...
+gem 'ccls-calnet_authenticated'
+require 'calnet_authenticated/autotest'

data/generators/calnet_authenticated/templates/calnet_authenticated.rake

@@ -0,0 +1,6 @@
+# From `script/generate calnet_authenticated` ...
+# condition added to allow clean 'rake gems:install'
+unless Gem.source_index.find_name('ccls-calnet_authenticated').empty?
+	gem 'ccls-calnet_authenticated'
+	require 'calnet_authenticated/test_tasks'
+end

data/generators/calnet_authenticated/templates/controllers/sessions_controller.rb

@@ -0,0 +1,8 @@
+class SessionsController < ApplicationController
+
+	def destroy
+		calnetuid = session[:calnetuid]
+		CASClient::Frameworks::Rails::Filter.logout(self)
+	end
+
+end

data/generators/calnet_authenticated/templates/controllers/users_controller.rb

@@ -0,0 +1,40 @@
+class UsersController < ApplicationController
+
+	skip_before_filter :login_required, :only => :menu
+
+	before_filter :id_required, :only => [:edit, :show, :update, :destroy]
+	before_filter :may_view_user_required, :except => [:index,:menu]
+	before_filter :may_view_users_required, :only => :index
+
+	ssl_allowed :menu
+
+	def menu
+		respond_to do |format|
+			format.js {}
+		end
+	end
+
+	def show
+		@roles = Role.all
+	end
+
+	def index
+		@users = User.search(params)
+	end
+
+	def destroy
+		@user.destroy
+		redirect_to users_path
+	end
+
+protected
+
+	def id_required
+		if !params[:id].blank? and User.exists?(params[:id])
+			@user = User.find(params[:id])
+		else
+			access_denied("user id required!", users_path)
+		end
+	end
+
+end

data/generators/calnet_authenticated/templates/functional/sessions_controller_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class CalnetAuthenticated::SessionsControllerTest < ActionController::TestCase
+	tests SessionsController
+
+	test "should logout if authenticated" do
+		login_as Factory(:user)
+		assert_logged_in
+		delete :destroy
+		assert_redirected_to_logout
+	end
+
+	test "should NOT logout if NOT authenticated" do
+		assert_not_logged_in
+		delete :destroy
+		assert_redirected_to_login
+	end
+
+#
+#	A temp testing route :show was created specifically to 
+#	test the current_user and logged_in? methods.  Without
+#	actually making a request, these methods fail as the
+#	session is nil.  When making a :destroy request, it is
+#	destroyed and can't be checked.
+#
+#	I suppose that I could create a new controller that
+#	doesn't meddle with the session, but ...
+#
+
+#	test "should not be logged_in? without login" do
+#		assert_not_logged_in
+#		get :show
+#		assert_not_logged_in
+#		assert_equal false, @controller.logged_in?
+#		assert_redirected_to_login
+#	end
+#
+#	test "should be logged_in? with login" do
+#		assert_not_logged_in
+#		login_as Factory(:user)
+#		assert_logged_in
+#		get :show
+#		assert_logged_in
+#		assert_equal true, @controller.logged_in?
+#		assert_redirected_to '/'
+#	end
+#
+#	test "should not have current_user without login" do
+#		assert_not_logged_in
+#		get :show
+#		assert_not_logged_in
+#		assert_nil @controller.current_user
+#		assert_redirected_to_login
+#	end
+#
+#	test "should have a current_user with login" do
+#		assert_not_logged_in
+#		login_as Factory(:user)
+#		assert_logged_in
+#		get :show
+#		assert_logged_in
+#		assert_not_nil @controller.current_user
+#		assert @controller.current_user.is_a?(User)
+#		assert @controller.current_user.is_a?(CalnetAuthenticatedUser())
+#		assert_redirected_to '/'
+#	end
+
+end

data/generators/calnet_authenticated/templates/functional/users_controller_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class CalnetAuthenticated::UsersControllerTest < ActionController::TestCase
+	tests UsersController
+
+	ASSERT_ACCESS_OPTIONS = {
+		:model => 'User',
+		:actions => [:destroy,:index,:show],
+		:attributes_for_create => :factory_attributes,
+		:method_for_create => :factory_create
+	}
+
+	def factory_attributes
+		Factory.attributes_for(:user)
+	end
+	def factory_create
+		Factory(:user)
+	end
+
+	assert_access_with_login(    :logins => site_administrators )
+	assert_no_access_with_login( :logins => non_site_administrators )
+	assert_no_access_without_login
+	assert_access_with_https
+	assert_no_access_with_http
+
+	#	use full role names as used in one test method
+	site_administrators.each do |cu|
+	
+		test "should filter users index by role with #{cu} login" do
+			some_other_user = send(cu)
+			login_as send(cu)
+			get :index, :role_name => cu
+			assert assigns(:users).length >= 2
+			assigns(:users).each do |u|
+				assert u.role_names.include?(cu)
+			end
+			assert_nil flash[:error]
+			assert_response :success
+		end
+	
+		test "should ignore empty role_name with #{cu} login" do
+			some_other_user = admin
+			login_as send(cu)
+			get :index, :role_name => ''
+			assert assigns(:users).length >= 2
+			assert_nil flash[:error]
+			assert_response :success
+		end
+	
+		test "should ignore invalid role with #{cu} login" do
+			login_as send(cu)
+			get :index, :role_name => 'suffocator'
+	#		assert_not_nil flash[:error]
+			assert_response :success
+		end
+	
+		test "should get private users menu via js with #{cu} login" do
+			login_as send(cu)
+			@request.accept = "text/javascript"
+			get :menu
+			assert_response :success
+			assert_match /jQuery/, @response.body
+		end
+	
+	end
+	
+	all_test_roles.each do |cu|
+	
+		test "should NOT get user info with invalid id with #{cu} login" do
+			login_as send(cu)
+			get :show, :id => 0
+			assert_not_nil flash[:error]
+			assert_redirected_to users_path
+		end
+	
+		test "should get #{cu} info with self login" do
+			u = send(cu)
+			login_as u
+			get :show, :id => u.id
+			assert_response :success
+			assert_not_nil assigns(:user)
+			assert_equal u, assigns(:user)
+		end
+	
+	end
+
+	test "should get empty private users menu via js without login" do
+		@request.accept = "text/javascript"
+		get :menu
+		assert_response :success
+		assert_match /\A\s*\z/, @response.body
+	end
+
+end

data/generators/calnet_authenticated/templates/migration.rb

@@ -0,0 +1,41 @@
+#class AddCalnetAuthenticatedColumnsTo<%= class_name.pluralize.gsub(/::/, '') -%> < ActiveRecord::Migration
+#class AddCalnetAuthenticatedColumnsToUsers -%> < ActiveRecord::Migration
+class AddCalnetAuthenticatedColumnsToUsers < ActiveRecord::Migration
+	def self.up
+#		table_name = '<%= file_path.gsub(/\//, '_').pluralize %>'
+		table_name = 'users'
+		create_table table_name do |t|
+			t.timestamps
+		end unless table_exists?(table_name)
+		cols = columns(table_name).map(&:name)
+		add_column( table_name, :uid, :string 
+			) unless cols.include?('uid')
+		add_column( table_name, :sn, :string 
+			) unless cols.include?('sn')
+		add_column( table_name, :displayname, :string 
+			) unless cols.include?('displayname')
+		add_column( table_name, :mail, :string, { 
+				:default => '', :null => false } 
+			) unless cols.include?('mail')
+		add_column( table_name, :telephonenumber, :string 
+			) unless cols.include?('telephonenumber')
+
+		idxs = indexes(table_name).map(&:name)
+		add_index( table_name, :uid, :unique => true 
+			) unless idxs.include?("index_#{table_name}_on_uid")
+		add_index( table_name, :sn 
+			) unless idxs.include?("index_#{table_name}_on_sn")
+	end
+
+	def self.down
+#		table_name = '<%= file_path.gsub(/\//, '_').pluralize %>'
+		table_name = 'users'
+		remove_index  table_name, :uid
+		remove_index  table_name, :sn 
+		remove_column table_name, :uid
+		remove_column table_name, :sn
+		remove_column table_name, :displayname
+		remove_column table_name, :mail
+		remove_column table_name, :telephonenumber
+	end
+end