bcms_cas 1.1.3 → 1.2.0

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.markdown

@@ -1,65 +1,60 @@
 # Central Authentication Server Module
 
-This module allows BrowserCMS to integrate with a Central Authentication Server (CAS) to allow users to log in to a BrowserCMS site,
-using credentials stored in an external system. This module requires an existing CAS server to be running (See http://code.google.com/p/rubycas-server/)
-as an example of a server.
+This module allows BrowserCMS to integrate with a Central Authentication Server (CAS) to allow users to log in to a BrowserCMS site, using credentials stored in an external system. This module requires an existing CAS server to be running (See http://code.google.com/p/rubycas-server/) as an example of a server.
 
-This module will allow user to login to the public area of the CMS, using the Login Form Portlet. It does not handle users that need to
-log into the CMS administrative area. It also handles single logout by redirecting the user to cas /logout service.
+This module will allow user to login to the public area of the CMS, using the Login Form Portlet. It does not handle users that need to log into the CMS administrative area. It also handles single logout by redirecting the user to cas /logout service.
+
+## Installation Instructions
 
-## A. Instructions
 Here are the necessary steps to install this module.
 
-1. Configure your CAS server and test that you can login directly via their /login page.
-2. Install the rubycas-client gem (See B below)
-3. Install the bcms_cas module, and configure it to point to your CAS server (see C below).
-4. Migrate the database to add the CAS Group (See D below)
-5. Create a Login Form to submit to the CAS server. (See E below)
+1. Install the bcms_cas module, and configure it to point to your CAS server (see B below).
+2. Configure your CAS server and test that you can login directly via their /login page.
+3. Migrate the database to add the CAS Group 
+4. Create a Login Form to submit to the CAS server. 
+
+## 1. Installing the Module
+
+Install the module by running the following command in your project.
+
+    $ rails g cms:install bcms_cas
+	$ rake db:seed
 
-## B. Installing RubyCAS-Client
-This project depends on RubyCAS-client (http://code.google.com/p/rubycas-client/). RubyCAS-Client is a standard Rails PluginGem, and the instructions
-for installing in into a Rails project can be found on their website. The following command will probably work though:
+This should install the bcms_cas gem along with all its dependencies. The db:seed will add a new group to the CMS
 
-    gem install rubycas-client
+See http://www.browsercms.org/doc/guides/html/installing_modules.html for more information on how to install modules generally.
 
-This will add the latest version of a gem. The bcms_cas module will require the necessary files, so you do not need to
-make any configuration changes in your rails project.
+## 2. Configure the CAS server
 
-## C. Installing/Configuring the Module
-To install a BrowserCMS module see the following instructions http://www.browsercms.org/doc/guides/html/installing_modules.html . After you add the gem to your
-environment.rb, run the following command to generate the necessary configuration files.
+Edit the config/environments/development.rb file to include the following:
 
-    $ ./script/generate bcms_cas
+	config.bcms_cas_server = "https://cas.some-domain.com"
+	
+If you are using the same cas server for each environment (development, production, testing) you can configure this once in the config/application.rb, otherwise edit each environment file separate. 
 
-This will generate several files. You will then need to edit one of them to point to the CAS server. Edit the config/initializers/bcms_cas.rb and change the server_url
-value to whatever domain name your cas server is located at. The file should look similar to this:
+Go to your CAS domain and test that you can log in.
 
-    Cas::Module.configure do |config|
-      config.server_url = "https://cas.yourdomainname.com"
-    end
+## 2a. Ensure SITE_DOMAIN is configured.
 
-Next edit the production.rb to make sure your SITE_DOMAIN variable in production is correctly set to the right top level domain. This will be needed
-to allow redirects between the servers to happen correctly (it requires Absolute URLs).
+Edit the production.rb to make sure your SITE_DOMAIN variable in production is correctly set to the right top level domain. This will be needed to allow redirects between the servers to happen correctly (it requires Absolute URLs).
 
     SITE_DOMAIN="www.yourdomainname.com"
 
-## D. Configure the 'CAS Authenticated User' Group
+## 3. Configure the 'CAS Authenticated User' Group
 When you run rake db:migrate, this module will add a new group to the CMS called 'CAS Authenticated Users'. All users that
 log in successfully will be assigned to members of this group. You will potentially want to rename this group to something
 that more accurately reflects who these users are (i.e. Members, Staff, etc) and then set which sections of the website this
 group can visit.
 
-## E. Create a Login Form
+## 4. Create a Login Form
 
-Via the BrowserCMS UI, create a page and place a Login Form portlet on it. It should use the newly generated login view created by the bcms_cas generator. If
-the module is configured correctly, then logging in should correctly establish a CAS session.
+Via the BrowserCMS UI, create a page and place a Login Form portlet on it. It should use the newly generated login view created by the bcms_cas generator. If the module is configured correctly, then logging in should correctly establish a CAS session.
 
-F. Known Issues
+## Known Issues
 
 * Every page is secured by the CASClient Gateway Filter, which means a lot of redirects. This is potentially a big performance hit, and would require modifying the filter so it only handles checking login_tickets, rather than redirects. 
 * A user logged in using CAS will be assigned to a single group. There is no way to map a user to different groups (i.e. Platnium or Gold Members). Could potentially be done via cas extra info.
 * The internal CMS User database is bypassed/not used for login for front end pages. This means it would fail the cmsadmin user tried to login via the Login Form.
-* [Low] LoginPortlet Form tag should pull from CAS automatically (requires changes to CMS core)
 * [Low] username/login field is different between CMS and CAS (requires core changes)
 * The CAS Login page has to be styled to match the look and feel of the site.
 * If the user types in wrong username/pw on CMS login form, they will be left on the CAS Login page, with message.

data/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/app/portlets/helpers/login_portlet_helper.rb

@@ -0,0 +1,3 @@
+module LoginPortletHelper
+  include Cas::LoginPortlet
+end

data/app/views/portlets/login/render.html.erb

@@ -0,0 +1,17 @@
+<% form_tag login_url_tag do %>
+    <%= login_ticket_tag %>
+    <%= service_url_tag %>
+    <p>
+      <%= label_tag :login %>
+      <%= text_field_tag :username, @login %>
+    </p>
+    <p>
+      <%= label_tag :password %>
+      <%= password_field_tag :password %>
+    </p>
+    <p>
+      <%= label_tag :remember_me %>
+      <%= check_box_tag :remember_me, '1', @remember_me %>
+    </p>
+    <p><%= submit_tag "Login" %></p>
+<% end %>

data/lib/bcms_cas/acts_as_content_page_extention.rb

@@ -8,4 +8,3 @@ module Cas
     end
   end
 end
-Cms::Acts::ContentPage.send(:include, Cas::Acts::ContentPage)

data/lib/bcms_cas/authentication.rb

@@ -16,6 +16,7 @@ module Cas
       controller_class.skip_filter :check_access_to_page
       controller_class.skip_filter :try_to_stream_file
       
+      controller_class.before_filter :verify_cas_configured
       controller_class.before_filter CASClient::Frameworks::Rails::GatewayFilter
       controller_class.before_filter :login_from_cas_ticket
       controller_class.before_filter :try_to_stream_file      
@@ -26,6 +27,13 @@ module Cas
     # Each instance of the controller will gain these methods.
     module InstanceMethods
 
+      # Provide a more helpful warning if developers forgot to configure the server correctly.
+      def verify_cas_configured
+        unless BcmsCas::Engine.configured?
+          BcmsCas::Engine.raise_configuration_error
+        end
+      end
+      
       # Attempts to set the current user based on the session attribute set by CAS.
       def login_from_cas_ticket
         logger.debug "Checking for cas login. The current_user is '#{@current_user.login}'." if @current_user
@@ -42,7 +50,6 @@ module Cas
       end
     end
   end
-  Cms::ContentController.send(:include, Cas::Authentication)
 
 
   # Extends the core SessionController to properly destroy the local session on logout, and redirect to CAS for Single Log out.
@@ -61,5 +68,4 @@ module Cas
       end
     end
   end
-  Cms::SessionsController.send(:include, Cas::SingleLogOut)
 end

data/lib/bcms_cas/engine.rb

@@ -0,0 +1,57 @@
+require 'browsercms'
+module BcmsCas
+  class Engine < Rails::Engine
+    include Cms::Module
+    
+    NOT_CONFIGURED = "https://localhost:3000/cas-not-configured"
+    
+    # Delay loading until Rails and BrowserCMS app directory has been loaded
+    initializer 'bcms_cas.load_dependencies' do
+      require 'bcms_cas/configuration'
+      require 'bcms_cas/authentication'
+      require 'bcms_cas/login_portlet_extension'
+      require 'bcms_cas/acts_as_content_page_extention'
+    end
+    
+    config.after_initialize do
+      CASClient::Frameworks::Rails::Filter.configure(
+              :cas_base_url => BcmsCas::Engine.cas_server,
+              :extra_attributes_session_key => :cas_extra_attributes
+      )
+    end
+    
+    config.to_prepare do
+      Cms::ContentController.send(:include, Cas::Authentication)
+      Cms::SessionsController.send(:include, Cas::SingleLogOut)
+      Cms::Acts::ContentPage.send(:include, Cas::Acts::ContentPage)
+      
+      Cms::ContentController.class_eval do
+        helper Cas::LoginPortlet
+      end
+    end
+    
+    def self.cas_server
+      if Rails.configuration.respond_to? :bcms_cas_server
+        Rails.configuration.bcms_cas_server
+      else
+        NOT_CONFIGURED
+      end
+    end
+    
+    def self.configured?
+      NOT_CONFIGURED != cas_server
+    end
+    
+    def self.raise_configuration_error      
+      error_message = <<message
+
+      Configuration Issue: You must configure a CAS server for the bcms_cas module to work.
+      Add the following to 'config/environments/#{Rails.env}.rb'
+      
+          config.bcms_cas_server = "https://cas.some-domain.com"
+
+message
+      raise error_message
+    end
+  end
+end

data/lib/bcms_cas/routes.rb

@@ -1,7 +1,5 @@
 module Cms::Routes
   def routes_for_bcms_cas
-    namespace(:cms) do |cms|
-      #cms.content_blocks :cas
-    end  
   end
 end
+  

data/lib/bcms_cas/version.rb

@@ -0,0 +1,3 @@
+module BcmsCas
+  VERSION = "1.2.0"
+end

data/lib/bcms_cas.rb

@@ -1,6 +1,4 @@
+require 'bcms_cas/engine'
 require 'bcms_cas/routes'
-require 'bcms_cas/configuration'
-require 'bcms_cas/authentication'
-require 'bcms_cas/login_portlet_extension'
-require 'bcms_cas/acts_as_content_page_extention'
+
 

data/lib/generators/bcms_cas/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Installs the bcms_cas module.
+
+Example:
+    rails generate bcms_cas:install
+
+    This will:
+		1. Copy any migrations from the gem into the project.
+		2. Add the routes to the config/routes.rb
+

data/lib/generators/bcms_cas/install/install_generator.rb

@@ -0,0 +1,15 @@
+require 'cms/module_installation'
+
+class BcmsCas::InstallGenerator < Cms::ModuleInstallation
+  source_root File.expand_path("../templates", __FILE__)
+  
+  def add_seeds
+    template "bcms_cas.seeds.rb", "db/bcms_cas.seeds.rb"
+    append_file "db/seeds.rb", "\nrequire File.expand_path('../bcms_cas.seeds.rb', __FILE__)\n"
+  
+  end
+  
+  def override_login_form_template
+    template "render.html.erb", "app/views/portlets/login/render.html.erb"
+  end
+end

data/lib/generators/bcms_cas/install/templates/bcms_cas.seeds.rb

@@ -0,0 +1,4 @@
+group = Group.create!(:name=>"CAS Authenticated Users", 
+                      :code=>"cas_group", 
+                      :group_type=>GroupType.find_by_name("Registered Public User"))
+group.sections = Section.all

data/test/performance/browsing_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
-require 'performance_test_help'
+require 'rails/performance_test_help'
 
 # Profiling results for each test method are written to tmp/performance.
-class BrowsingTest < ActionController::PerformanceTest
+class BrowsingTest < ActionDispatch::PerformanceTest
   def test_homepage
     get '/'
   end

data/test/test_helper.rb

@@ -1,33 +1,10 @@
 ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
-require 'test_help'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
 
-class ActiveSupport::TestCase
-  # Transactional fixtures accelerate your tests by wrapping each test method
-  # in a transaction that's rolled back on completion.  This ensures that the
-  # test database remains unchanged so your fixtures don't have to be reloaded
-  # between every test method.  Fewer database queries means faster tests.
-  #
-  # Read Mike Clark's excellent walkthrough at
-  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
-  #
-  # Every Active Record database supports transactions except MyISAM tables
-  # in MySQL.  Turn off transactional fixtures in this case; however, if you
-  # don't care one way or the other, switching from MyISAM to InnoDB tables
-  # is recommended.
-  #
-  # The only drawback to using transactional fixtures is when you actually 
-  # need to test transactions.  Since your test is bracketed by a transaction,
-  # any transactions started in your code will be automatically rolled back.
-  self.use_transactional_fixtures = true
-
-  # Instantiated fixtures are slow, but give you @david where otherwise you
-  # would need people(:david).  If you don't want to migrate your existing
-  # test cases which use the @david style and don't mind the speed hit (each
-  # instantiated fixtures translates to a database query per test method),
-  # then set this back to true.
-  self.use_instantiated_fixtures  = false
+require 'mocha'
 
+class ActiveSupport::TestCase
   # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
   #
   # Note: You'll currently still have to declare fixtures explicitly in integration tests

data/test/unit/cas/cas_authentication_test.rb

@@ -12,6 +12,13 @@ class MyController < ActionController::Base
     {}
   end
 
+  def session
+    unless @custom_session
+      @custom_session = {}
+    end
+    @custom_session
+  end
+  
   def destroy
     "Exists only to be alias_method_chained"
   end
@@ -22,7 +29,8 @@ class CasAuthTest < ActiveSupport::TestCase
   def setup
     MyController.expects(:skip_filter).with(:check_access_to_page)
     MyController.expects(:skip_filter).with(:try_to_stream_file)
-    
+
+    MyController.expects(:before_filter).with(:verify_cas_configured)
     MyController.expects(:before_filter).with(CASClient::Frameworks::Rails::GatewayFilter)
     MyController.expects(:before_filter).with(:login_from_cas_ticket)
     MyController.expects(:before_filter).with(:try_to_stream_file)
@@ -48,7 +56,6 @@ class CasAuthTest < ActiveSupport::TestCase
 
   test "login_from_cas_ticket will create and set the current user and User.current if a session attribute was found." do
     c = MyController.new
-    c.session = {}
     c.session[:cas_user] = "1234"
 
     User.current = Group.find_by_code("guest")