From 44a57617e2b93b1a618f336014daee688e4eefc7 Mon Sep 17 00:00:00 2001
From: Joenio Costa <joenio@colivre.coop.br>
Date: Sun, 8 Jan 2012 19:55:36 -0200
Subject: [PATCH] GoogleCsePlugin - Google Custom Search Noosfero Plugin

---
 app/views/layouts/application-ng.rhtml                                              |  2 +-
 lib/noosfero/plugin.rb                                                              |  7 +++++--
 lib/noosfero/plugin/manager.rb                                                      |  7 +++++++
 plugins/google_cse/controllers/google_cse_plugin_environment_controller.rb          |  4 ++++
 plugins/google_cse/doc/google_cse.textile                                           | 13 +++++++++++++
 plugins/google_cse/lib/google_cse_plugin.rb                                         | 25 +++++++++++++++++++++++++
 plugins/google_cse/test/functional/google_cse_plugin_environment_controller_test.rb | 20 ++++++++++++++++++++
 plugins/google_cse/test/unit/google_cse_plugin_test.rb                              | 25 +++++++++++++++++++++++++
 plugins/google_cse/views/google_cse_plugin_environment/results.rhtml                | 30 ++++++++++++++++++++++++++++++
 plugins/google_cse/views/search-box.rhtml                                           | 10 ++++++++++
 10 files changed, 140 insertions(+), 3 deletions(-)
 create mode 100644 plugins/google_cse/controllers/google_cse_plugin_environment_controller.rb
 create mode 100644 plugins/google_cse/doc/google_cse.textile
 create mode 100644 plugins/google_cse/lib/google_cse_plugin.rb
 create mode 100644 plugins/google_cse/test/functional/google_cse_plugin_environment_controller_test.rb
 create mode 100644 plugins/google_cse/test/unit/google_cse_plugin_test.rb
 create mode 100644 plugins/google_cse/views/google_cse_plugin_environment/results.rhtml
 create mode 100644 plugins/google_cse/views/search-box.rhtml

diff --git a/app/views/layouts/application-ng.rhtml b/app/views/layouts/application-ng.rhtml
index 95af2c0..c70583e 100644
--- a/app/views/layouts/application-ng.rhtml
+++ b/app/views/layouts/application-ng.rhtml
@@ -63,7 +63,7 @@
                 <%= render :file => 'account/login', :locals => { :is_thickbox => true } %>
               </div>
           </span>
-          <form action="/search" class="search_form" method="get" class="clean">
+          <form action="/search" class="search_form clean" method="get" id="top-search">
             <input name="query" size="15" value="<%=_('Search...')%>"
                 onfocus="this.form.className='focused';
                          if(this.value=='<%=_('Search...')%>'){this.value=''}"
diff --git a/lib/noosfero/plugin.rb b/lib/noosfero/plugin.rb
index 7471204..daa62b1 100644
--- a/lib/noosfero/plugin.rb
+++ b/lib/noosfero/plugin.rb
@@ -7,6 +7,10 @@ class Noosfero::Plugin
 
   class << self
 
+    def klass(dir)
+      (dir.to_s.camelize + 'Plugin').constantize # load the plugin
+    end
+
     def init_system
       Dir.glob(File.join(Rails.root, 'config', 'plugins', '*')).select do |entry|
         File.directory?(entry)
@@ -18,8 +22,7 @@ class Noosfero::Plugin
           path << File.join(dir, 'lib')
         end
 
-        plugin_name = File.basename(dir).camelize + 'Plugin'
-        plugin_name.constantize # load the plugin
+        klass(File.basename(dir))
       end
     end
 
diff --git a/lib/noosfero/plugin/manager.rb b/lib/noosfero/plugin/manager.rb
index 95635f0..3cbbca9 100644
--- a/lib/noosfero/plugin/manager.rb
+++ b/lib/noosfero/plugin/manager.rb
@@ -22,4 +22,11 @@ class Noosfero::Plugin::Manager
     end
   end
 
+  def [](name)
+    klass = Noosfero::Plugin.klass(name)
+    enabled_plugins.select do |plugin|
+      plugin.kind_of?(klass)
+    end.first
+  end
+
 end
diff --git a/plugins/google_cse/controllers/google_cse_plugin_environment_controller.rb b/plugins/google_cse/controllers/google_cse_plugin_environment_controller.rb
new file mode 100644
index 0000000..3845b90
--- /dev/null
+++ b/plugins/google_cse/controllers/google_cse_plugin_environment_controller.rb
@@ -0,0 +1,4 @@
+class GoogleCsePluginEnvironmentController < ApplicationController
+  append_view_path File.join(File.dirname(__FILE__) + '/../views')
+  no_design_blocks
+end
diff --git a/plugins/google_cse/doc/google_cse.textile b/plugins/google_cse/doc/google_cse.textile
new file mode 100644
index 0000000..4eff300
--- /dev/null
+++ b/plugins/google_cse/doc/google_cse.textile
@@ -0,0 +1,13 @@
+h1. GoogleCsePlugin
+
+A plugin that use the Google Custom Search as Noosfero search engine.
+
+h2. Usage
+
+* Register a Google Custom Search ID at http://www.google.com/cse
+* Set at least basic config, site list and look and fell of your Google Cse ID
+* Configure Noosfero environment with this ID
+** >> env = Environment.find( ... )
+** >> env.settings[:google_cse_id] = '&lt;PUT ID HERE&gt;'
+** >> env.save!
+* That's all! The top search text-field of Noosfero will be used to make searchs
diff --git a/plugins/google_cse/lib/google_cse_plugin.rb b/plugins/google_cse/lib/google_cse_plugin.rb
new file mode 100644
index 0000000..750f725
--- /dev/null
+++ b/plugins/google_cse/lib/google_cse_plugin.rb
@@ -0,0 +1,25 @@
+class GoogleCsePlugin < Noosfero::Plugin
+
+  def self.plugin_name
+    "GoogleCsePlugin"
+  end
+
+  def self.plugin_description
+    _("A plugin that use the Google Custom Search as Noosfero search engine.")
+  end
+
+  def google_id
+    context.environment.settings[:google_cse_id]
+  end
+
+  def self.results_url_path
+    '/plugin/google_cse/results'
+  end
+
+  def body_beginning
+    unless google_id.blank?
+      expanded_template('search-box.rhtml', {:selector => '#top-search, #footer-search', :plugin => self})
+    end
+  end
+
+end
diff --git a/plugins/google_cse/test/functional/google_cse_plugin_environment_controller_test.rb b/plugins/google_cse/test/functional/google_cse_plugin_environment_controller_test.rb
new file mode 100644
index 0000000..c9860cc
--- /dev/null
+++ b/plugins/google_cse/test/functional/google_cse_plugin_environment_controller_test.rb
@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+require File.dirname(__FILE__) + '/../../controllers/google_cse_plugin_environment_controller'
+
+# Re-raise errors caught by the controller.
+class GoogleCsePluginEnvironmentController; def rescue_action(e) raise e end; end
+
+class GoogleCsePluginEnvironmentControllerTest < Test::Unit::TestCase
+
+  def setup
+    @controller = GoogleCsePluginEnvironmentController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  should 'get results page' do
+    get :results
+    assert_response :success
+  end
+
+end
diff --git a/plugins/google_cse/test/unit/google_cse_plugin_test.rb b/plugins/google_cse/test/unit/google_cse_plugin_test.rb
new file mode 100644
index 0000000..6166c20
--- /dev/null
+++ b/plugins/google_cse/test/unit/google_cse_plugin_test.rb
@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+class GoogleCsePluginTest < Test::Unit::TestCase
+
+  def setup
+    @plugin = GoogleCsePlugin.new
+    @context = mock()
+    @plugin.context = @context
+    @env = Environment.new
+    @plugin.context.stubs(:environment).returns(@env)
+  end
+
+  should 'get google_id from environment' do
+    @env.stubs(:settings).returns({:google_cse_id => 10})
+    assert_equal 10, @plugin.google_id
+  end
+
+  should 'not use custom search if google_cse_id isnt set' do
+    @env.stubs(:settings).returns({})
+    assert_nil @plugin.body_beginning
+    @env.stubs(:settings).returns({:google_cse_id => 11})
+    assert_not_nil @plugin.body_beginning
+  end
+
+end
diff --git a/plugins/google_cse/views/google_cse_plugin_environment/results.rhtml b/plugins/google_cse/views/google_cse_plugin_environment/results.rhtml
new file mode 100644
index 0000000..6090fdf
--- /dev/null
+++ b/plugins/google_cse/views/google_cse_plugin_environment/results.rhtml
@@ -0,0 +1,30 @@
+<% plugin = @plugins[:google_cse] %>
+<div id="cse" style="width: 100%;"><%= _('Loading') %></div>
+<script src="//www.google.com/jsapi" type="text/javascript"></script>
+<script type="text/javascript">
+  function parseQueryFromUrl () {
+    var queryParamName = "q";
+    var search = window.location.search.substr(1);
+    var parts = search.split('&');
+    for (var i = 0; i < parts.length; i++) {
+      var keyvaluepair = parts[i].split('=');
+      if (decodeURIComponent(keyvaluepair[0]) == queryParamName) {
+        return decodeURIComponent(keyvaluepair[1].replace(/\+/g, ' '));
+      }
+    }
+    return '';
+  }
+  google.load('search', '1', {style : google.loader.themes.MINIMALIST});
+  google.setOnLoadCallback(function() {
+    var customSearchControl = new google.search.CustomSearchControl(
+      '<%= plugin && plugin.google_id %>');
+    customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
+    var options = new google.search.DrawOptions();
+    options.enableSearchResultsOnly();
+    customSearchControl.draw('cse', options);
+    var queryFromUrl = parseQueryFromUrl();
+    if (queryFromUrl) {
+      customSearchControl.execute(queryFromUrl);
+    }
+  }, true);
+</script>
diff --git a/plugins/google_cse/views/search-box.rhtml b/plugins/google_cse/views/search-box.rhtml
new file mode 100644
index 0000000..c57ddde
--- /dev/null
+++ b/plugins/google_cse/views/search-box.rhtml
@@ -0,0 +1,10 @@
+<script type="text/javascript">
+  jQuery(function($) {
+    $('<%= locals[:selector] %>')
+      .attr({class: "cse-search-box", action: "<%= GoogleCsePlugin.results_url_path %>"})
+      .append('<input type="hidden" name="cx" value="<%= locals[:plugin].google_id %>" /><input type="hidden" name="cof" value="FORID:10" /><input type="hidden" name="ie" value="UTF-8" /><input type="hidden" name="siteurl" value="<%= context.environment.default_hostname %>">')
+      .children("input[name='query']")
+        .attr('name', 'q')
+        .attr('id', 'q');
+  });
+</script>
--
libgit2 0.21.2