caterpillar 1.4.4 → 1.6.0

data/lib/caterpillar/util.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #--
 # (c) Copyright 2008,2009,2010 Mikael Lammentausta
-# See the file LICENSES.txt included with the distribution for
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 

data/lib/rails_gem_chooser.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #--
-# (c) Copyright 2009,2010 Mikael Lammentausta
+# (c) Copyright 2009 - 2011 Mikael Lammentausta
 #
 # See the file MIT-LICENSE included with the distribution for
 # software license details.
@@ -31,7 +31,7 @@ class RailsGemChooser
         STDERR.puts 'Could not detect Rails version'
         return nil
       end
-	  end
+    end
     # don't attempt to load Rails if building a Rubygem..!
     if $0[/gem$/] or !File.exist?(config_file)
       return nil
@@ -40,7 +40,7 @@ class RailsGemChooser
       f=File.open(config_file)
       config = f.read
       f.close
-      rails_gem_version = config[/^RAILS_GEM_VERSION.*(\d\.\d\.\d)/,1]
+      rails_gem_version = config[/^RAILS_GEM_VERSION.*(\d\.\d\.\d+)/,1]
       #STDOUT.puts 'Detected Rails version %s from the config file %s' % [rails_gem_version,config_file]
       return rails_gem_version
     end
@@ -48,6 +48,7 @@ class RailsGemChooser
 
   # Load a specific GEM
   def __load_gem(require_name, gem_name, version)
+    #STDOUT.puts 'Loading gem: %s v %s' % [require_name, version]
     version ? gem(gem_name, '= '+version) : gem(gem_name)
     begin
       require require_name
@@ -58,7 +59,9 @@ class RailsGemChooser
 
   # Either define +rails_gem_version+ or +config_file+
   def __load(rails_gem_version=nil,config_file=nil)
-    raise 'oops' if config_file and rails_gem_version
+    if (config_file and rails_gem_version) and (version != rails_gem_version)
+      raise 'oops: Rails version mismatch'
+    end
 
     rails_gem_version ||= version(config_file) # also detects ENV['RAILS_GEM_VERSION']
 
@@ -68,7 +71,7 @@ class RailsGemChooser
     # except that with the underline divider the gem is not found ..
     #rails_gems = %w{ activesupport actionpack activerecord }
     
-    rails_gems = {              
+    rails_gems = {
       # require name      gem name
       "active_support" => "activesupport",
       "action_pack"    => "actionpack",
@@ -78,9 +81,13 @@ class RailsGemChooser
     rails_gems.keys.each do |rg_key|
       __load_gem(rg_key, rails_gems[rg_key], rails_gem_version)
     end
-    require 'action_controller'
+    require 'action_controller' # action_controller lives in action_pack
 
-    #STDOUT.puts 'Loaded Rails version %s' % Rails::VERSION::STRING
+    #STDOUT.puts "Loaded gems:"
+    #STDOUT.puts "ActiveRecord: %s" % ActiveRecord::VERSION::STRING
+    #STDOUT.puts "ActionPack: %s" %  ActionPack::VERSION::STRING
+    #require 'active_support/version'
+    #STDOUT.puts "ActiveSupport: %s" %  ActiveSupport::VERSION::STRING
   end
 
   end

data/lib/web/portlet.rb

@@ -62,4 +62,4 @@ module Web # :nodoc:
     end
 
   end
-end
+end

data/portlet_test_bench/controllers/caterpillar/application.rb

@@ -10,11 +10,6 @@ class Caterpillar::ApplicationController < ActionController::Base
   # Rails-portlet has session cookie support.
   #session :disabled => true
 
-  # Import security filters
-  include Caterpillar::Security
-  secure_portlet_sessions
-
-
   ### Used for navigating the test bench
 
   # If controller is not ApplicationController, test is selected.

data/portlet_test_bench/controllers/caterpillar/junit_controller.rb

@@ -4,6 +4,7 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
   layout false
 
   def index
+    logger.debug request.inspect
     render :text => "", :layout => 'bare'
   end
 
@@ -189,21 +190,18 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
     render :text => txt, :status => 200
   end
 
-  # test foobarcookies with Liferay UID cookie and authentication.
-  # 5 cookies altogether.  
-  def cookies_liferay_auth
-    txt =  "Liferay_UID: #{@uid}\n"
-    txt += "#{cookies[:foo]}#{cookies[:bar]}#{cookies[:baz]}"
-    render :inline => txt, :status => 200
-  end
-  before_filter :get_liferay_uid, :only => [:liferay_uid, :cookies_liferay_auth]
+  # include filters authorize_agent, authorize_request
+  include Caterpillar::Security::InstanceMethods
+  
+  # include filters get_liferay_uid, get_liferay_gid
+  include Caterpillar::Helpers::Liferay
 
   #
   # authenticate these actions
   #
   before_filter :authorize_request, :only => [
     :authorized,
-    :liferay_uid,
+    :liferay_uid_auth,
     :foobarcookies_auth,
     :foobarcookiestxt_auth,
     :cookies_liferay_auth
@@ -211,6 +209,15 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
   alias :foobarcookies_auth :foobarcookies
   alias :foobarcookiestxt_auth :foobarcookiestxt
 
+  #
+  # collect Liferay UID cookie
+  #
+  before_filter :get_liferay_uid, :only => [
+    :liferay_uid,
+    :liferay_uid_auth,
+    :cookies_liferay_auth
+    ]
+
   # test session authorization
   def authorized
     render :nothing => true, :status => 200
@@ -222,6 +229,20 @@ class Caterpillar::JunitController < Caterpillar::ApplicationController
     render :inline => @uid, :status => 200
   end
 
+  # test Liferay UID cookie and authentication
+  def liferay_uid_auth
+    @uid = 'nil' if @uid.nil?
+    render :inline => @uid, :status => 200
+  end
+
+  # test foobarcookies with Liferay UID cookie and authentication.
+  # 5 cookies altogether.  
+  def cookies_liferay_auth
+    txt =  "Liferay_UID: #{@uid}\n"
+    txt += "#{cookies[:foo]}#{cookies[:bar]}#{cookies[:baz]}"
+    render :inline => txt, :status => 200
+  end
+
   def target1
     render :action => 'target1', :layout => 'bare'
   end

data/portlet_test_bench/controllers/caterpillar/liferay_controller.rb

@@ -1,11 +1,21 @@
 # encoding: utf-8
+class Caterpillar::LiferayController < Caterpillar::ApplicationController
 
+  # Import security filters
+  include Caterpillar::Security
+  secure_portlet_sessions(:only => :authorized_sessions)
+  
+  # UID & GID filters
+  include Caterpillar::Helpers::Liferay
+  before_filter :get_liferay_uid, :only => :session_variables
+  before_filter :get_liferay_gid, :only => :session_variables
 
-class Caterpillar::LiferayController < Caterpillar::ApplicationController
 
   def session_variables
-    @uid = params[:uid]
-    @gid = params[:gid]
+  end
+  
+  def authorized_sessions
+    render :inline => 'Request was authorized via shared secret'
   end
 
 end

data/portlet_test_bench/controllers/caterpillar/session_controller.rb

@@ -2,6 +2,9 @@
 
 
 class Caterpillar::SessionController < Caterpillar::ApplicationController
+  include Caterpillar::Helpers::Portlet
+
+  before_filter :get_namespace, :only => :namespace
 
   # flash message.
   def flash_msg

data/portlet_test_bench/controllers/caterpillar/xhr_controller.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 class Caterpillar::XhrController < Caterpillar::ApplicationController
-
+  include Caterpillar::Helpers::Liferay
+  
   def prototype
     # the page with the XHR triggers
     @javascripts = %w{prototype}
@@ -17,4 +18,14 @@ class Caterpillar::XhrController < Caterpillar::ApplicationController
     send_data Time.now.to_s, :type => 'text/html'
   end
 
+  # Liferay resource URL
+  def resource
+    logger.debug params
+    @resource_url = cookies[:Liferay_resourceUrl]
+    logger.debug @resource_url
+    @r_u_params = params.dup
+    #p url_for(:controller => Caterpillar::XhrController )
+    
+  end
+
 end

data/portlet_test_bench/views/caterpillar/application/_back_to_menu.html.erb

@@ -9,5 +9,5 @@ overflow: hidden;
 margin-left: 0px;
 margin-right: 0px;
 ">
-  <%= link_to "All tests", portlet_test_bench_url -%>
+  <%= link_to "All tests", portlet_test_bench_path -%>
 </p>

data/portlet_test_bench/views/caterpillar/application/index.html.erb

@@ -1,5 +1,12 @@
+<style type="text/css">
+body {
+background: white;
+}
+</style>
+<%= image_tag 'caterpillar/caterpillar.gif' %>
+<span style="font-size: 3em;">
 Caterpillar <%= Caterpillar::VERSION %>
-
+</span>
 <hr />
 
 Includes <%= link_to 'portlet test bench', portlet_test_bench_url %>.

data/portlet_test_bench/views/caterpillar/application/portlet_test_bench.html.erb

@@ -36,7 +36,7 @@ background: white;
 <div class="testBenchHeader">Rails-portlet test bench</div>
 
 <p style="font-size: 14px;">
-These are isolated test cases of the Rails-portlet, for manual testing in the browser. The <%= link_to_exit_portlet 'source code', 'http://rails-portlet.rubyforge.org/svn/trunk/caterpillar/portlet_test_bench/' -%> can be used as a reference for using the same features in other Rails apps.
+These are isolated test cases of the Rails-portlet, for manual testing in the browser. The <%= link_to_exit_portlet 'source code', 'http://github.com/lamikae/caterpillar/tree/master/portlet_test_bench/' -%> can be used as a reference for using the same features in other Rails apps.
 </p>
 
 <div class="testBenchSuite">HTTP</div>
@@ -107,6 +107,20 @@ These are isolated test cases of the Rails-portlet, for manual testing in the br
 
 </div>
 
+<div class="testBenchSuite">Liferay</div>
+<div class="testContainer">
+
+  <%= link_to 'Liferay UID and GID',
+        url_for(
+          :controller => 'Caterpillar::Liferay',
+          :action => :session_variables
+        )
+  -%><br />
+
+  <%= link_to 'Liferay resource URL',
+        :controller => 'Caterpillar::Xhr', :action => :resource  -%><br />
+
+</div>
 
 <div class="testBenchSuite">Misc</div>
 <div class="testContainer">
@@ -120,16 +134,20 @@ These are isolated test cases of the Rails-portlet, for manual testing in the br
   <%= link_to 'Link outside the portlet',
         :controller => 'Caterpillar::Resource', :action => :exit_portlet  -%><br />
 
-  <%= link_to 'Liferay session variables',
-        url_for(
-          :controller => 'Caterpillar::Liferay',
-          :action => :session_variables
-        )+'/uid/%UID%/gid/%GID%'
-  -%><br />
-
   <%= link_to 'Flash message',
         :controller => 'Caterpillar::Session', :action => :flash_msg -%><br />
 
+  <%= link_to 'Cookies set by rails-portlet',
+        :controller => 'Caterpillar::Session', :action => :cookies -%><br />
+
+  <%= link_to 'Portlet namespace',
+        :controller => 'Caterpillar::Session', :action => :namespace -%><br />
+
+
+  <%= link_to 'Portlet request authorization via shared secret',
+        :controller => 'Caterpillar::Liferay', :action => :authorized_sessions  -%><br />
+
+
 </div>
 
 

data/portlet_test_bench/views/caterpillar/css/background.html.erb

@@ -1,3 +1,5 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
   <head>
     <title>Simple CSS test</title>
     <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
@@ -27,4 +29,5 @@
       <div id="background_image"></div>
     </center>
 
-  </body>
+  </body>
+</html>

data/portlet_test_bench/views/caterpillar/css/simple.html.erb

@@ -1,3 +1,5 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
   <head>
     <title>Simple CSS test</title>
     <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
@@ -8,7 +10,8 @@
       /* simple.html.erb */
       #head_ref {
       margin: 25px; padding: 10px; border: 1px solid #000000;
-      background: #6FFF3A;
+      background: blue;
+      color: white;
       }
     </style>
   </head>
@@ -18,36 +21,37 @@
     <style type="text/css" id="style_in_body">
       #body_ref {
       margin: 25px; padding: 10px; border: 1px solid #000000;
-      background: #FFB751;
+      background: green;
       }
     </style>
 
     Body<br />
-    <b>background-color: #FFFFFCC; font: 11px Arial,Helvetica;</b>
+    <b>background-color: gray; font: 11px Arial,Helvetica;</b>
     <p class="info">
       All the following divs should appear the same, with different background colors.<br />
       <b>margin: 25px; padding: 10px; border: 1px solid #000000;</b>
     </p>
-    <div style="margin: 25px; padding: 10px; border: 1px solid #000000; background: #FFFFFF;">
+    <div style="margin: 25px; padding: 10px; border: 1px solid #000000; background: orange;">
       This is a div with self-contained style parameters. <br />
-      <b>background: #FFEE31;</b>
+      <b>background: orange</b>
     </div>
 
     <div id="simple_content">
       This is a div with style definitions in <i>main.css</i>.<br />
-      <b>background: #93FFE4;</b>
+      <b>background: purple</b>
     </div>
 
     <div id="head_ref">
       This is a div with style definitions in <i>&lt;head&gt;</i>.<br />
-      <b>background: #6FFF3A;</b>
+      <b>background: blue</b>
     </div>
 
     <div id="body_ref">
       This is a div with style definitions in <i>&lt;body&gt;</i>.<br />
-      <b>background: #FFB751;</b>
+      <b>background: green</b>
     </div>
 
     <br />
 
-  </body>
+  </body>
+</html>

data/portlet_test_bench/views/caterpillar/liferay/session_variables.html.erb

@@ -4,16 +4,13 @@ These tests check that Liferay session variables are available in Rails.
 </p>
 
 <p>
-These variables are accessible in Java JSR286 portlets from the Liferay API.
-When the Rails-portlet receives a request where the URL contains keywords %UID% or %GID%, these are replaced by the values received from the Liferay API. Rails receives a request with the actual UID number and GID numbers, respectively. The page (Layout in the database) where the portlet is has defined this Group.
+These variables are accessible in Java JSR286 portlets from the Liferay API. Rails-portlet includes these values into a cookie that is available in Rails.
 </p>
 
 <p>
-  <%#= link_to 'UID', url_for(:action => :session_variables)+'/uid/%UID%' -%><br/>
-  <%#= link_to 'UID debug', url_for(:action => :session_variables)+'/uid/10000' -%><br/>
   <% if @uid -%>
     <span style="font-size: 18px;">
-      Received UID: <%= @uid %>
+      Liferay UID: <%= @uid %>
     </span>
   <% else -%>
     No UID found!
@@ -21,18 +18,12 @@ When the Rails-portlet receives a request where the URL contains keywords %UID%
 </p>
 
 <p>
-  <%#= link_to 'GID', url_for(:action => :session_variables)+'/gid/%GID%' -%><br/>
-  <%#= link_to 'GID debug', url_for(:action => :session_variables)+'/gid/20000' -%><br/>
   <% if @gid -%>
     <span style="font-size: 18px;">
-      Received GID: <%= @gid %>
+      Liferay GID: <%= @gid %>
     </span>
   <% else -%>
     No GID found!
   <% end -%>
 </p>
 
-<p style="font-size: 18px;">
-  <%#= link_to 'Reset', :action => :session_variables -%>
-</p>
-

data/portlet_test_bench/views/caterpillar/session/cookies.html.erb

@@ -0,0 +1,5 @@
+<% cookies.each do |cookie| %>
+<p>
+<%= cookie.inspect %>
+</p>
+<% end%>

data/portlet_test_bench/views/caterpillar/session/namespace.html.erb

@@ -0,0 +1,14 @@
+<% if @namespace  %>
+
+  <p>
+    Portlet namespace:<br />
+    <span style="font-size:1.2em; text-style: italic;">
+      <%= @namespace %>
+    </span>
+  </p>
+
+<% else %>
+
+Sorry, the cookie "Portlet_namespace" is not set.
+
+<% end %>