bcms_google_mini_search 1.2.2 → 1.3.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem "mysql2", '0.2.18'
+gem "mocha", '0.9.12', :group => :test, :require=>false
+

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

@@ -8,14 +8,10 @@ It consists of the following two portlets.
 2. Google Mini Search Results Portlet - Sends query to the Mini, formats the XML response and displays the results.
 
 Features:
-
 1. Allows for formatted results of GSA search results.
-2. Will display Key Matches
-3. Will display Synonyms/Related Queries
-4. Allows conditional overriding of collections (i.e. by default it will search one default collection, but a 'site=OTHER_COLLECTION' param can be passed to override that)
-5. Sort by Date/Relevance - Users can now toggle the results display between date and relevance.
-6. Cached Links - Each result now correctly generate a link to the cached version of the document as stored by the GSA.
-7. [GSA Only] Narrow Your Search - Shows users a set of other suggested queries to allow them to 'Narrow Your Search', based on the current query and what results are stored in GSA. Only available for GSA instances, as Google Mini does not support Dynamic Result Clustering.
+2. Will display Key Matches (as of 1.1)
+3. Will display Synonyms/Related Queries (as of 1.1)
+4. Allows conditional overriding of collections (i.e. by default it will search one collection, but a 'site=OTHER_COLLECTION' param can be passed to override that)
 
 Note: This module assume the BrowserCMS web site owner has access to their own GSA/Google Mini server, either hosted by
 themselves or a third party service.

data/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+BcmsGoogleMiniSearch::Application.load_tasks
+
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/models/search_result.rb

@@ -1,18 +1,14 @@
+require 'rexml/document'
+require 'net/http'
+
 class SearchResult
 
-  # Creates a new GSA::Appliance from a GoogleMiniSearchPortlet.
-  #
-  def self.new_gsa(portlet)
-    options = {:portlet=>portlet}
-    normalize_query_options(options)
-    GSA::Appliance.new(options)
-  end
+  attr_accessor :number, :title, :url, :description, :size
 
   #
   # Queries google mini by a specific URL to find all the results. Converts XML results to
   # a paging results of Search Results.
   #
-  # See SearchResult#query_url for acceptable _options_ params
   def self.find(query, options={})
     return QueryResult.new unless query
     xml_doc = fetch_xml_doc(query, options)
@@ -23,14 +19,6 @@ class SearchResult
     results
   end
 
-  def self.create_query(query, options={})
-    opts = options.clone
-    normalize_query_options(opts)
-    opts[:query] = query
-    opts[:engine] = GSA::Engine.new({:host => opts[:host]})
-    GSA::Query.new(opts)
-  end
-
   def self.parse_results_count(xml_doc)
     root = xml_doc.root
     count = root.elements["RES/M"]
@@ -41,7 +29,16 @@ class SearchResult
     root = xml_doc.root
     results = []
     xml_doc.elements.each('GSP/RES/R') do |ele|
-      results << GSA::Result.new(ele)
+      result = SearchResult.new
+      result.number = ele.attributes["N"]
+      result.title = ele.elements["T"].text
+      result.url = ele.elements["U"].text
+      result.description = ele.elements["S"].text
+      
+      doc_size_ele = ele.elements["HAS/C"]
+      result.size = doc_size_ele ? doc_size_ele.attributes["SZ"] : ""
+
+      results << result
     end
     results
   end
@@ -65,76 +62,39 @@ class SearchResult
     num_pages
   end
 
-  # Construct a query url for the GSA.
-  #
-  # @param [String] query
-  # @param [Hash] options
-  # @option :host
-  # @option :start
-  # @option :front_end
-  # @option :collection
-  # @option :sort
-  # @option :as_xml [Boolean] Determines if the results are returned as xml or html. Default to false.
-  def self.query_url(query, options)
-    options[:as_xml] = true if options[:as_xml].nil?
 
+  def self.build_mini_url(options, query)
+    portlet = find_search_engine_portlet(options)
     encoded_query = CGI::escape(query)
 
-    # Turns off automatic results filter (filter=0), which when set to 1, allows mini to reduces the # of similar/duplicate results,
-    # but makes it hard to determine the total # of results.
-    url = "#{options[:host]}/search?q=#{encoded_query}&output=xml_no_dtd&client=#{options[:front_end]}&site=#{options[:collection]}&filter=0"
+    site = portlet.collection_name
+    if options[:site]
+      site = options[:site]
+    end
+    # encoded_query = query
+    url = "#{portlet.service_url}/search?q=#{encoded_query}&output=xml_no_dtd&client=#{portlet.front_end_name}&site=#{site}&filter=0"
     if options[:start]
       url = url + "&start=#{options[:start]}"
     end
-
-    if options[:sort]
-      url += "&sort=#{CGI::escape(options[:sort])}"
-    end
-
-    unless options[:as_xml]
-      url += "&proxystylesheet=#{options[:front_end]}"
-    end
-
-    # Ensure both results (oe) and query/input values (ie) are interpreted as UTF-8.
-    # See http://code.google.com/apis/searchappliance/documentation/46/xml_reference.html#request_i18n
-    url += "&oe=UTF-8&ie=UTF-8"
-    return url
-  end
-
-  def self.create_url_for_query(options, query)
-    normalize_query_options(options)
-    return query_url(query, options)
-  end
-
-  def self.normalize_query_options(options)
-    portlet = find_search_engine_portlet(options)
-    options[:front_end] = portlet.front_end_name
-    options[:collection] = portlet.collection_name
-    options[:host] = portlet.service_url
-
-    options[:collection] = options.delete(:site) if options[:site]
+    return url    
   end
 
   def self.find_search_engine_portlet(options)
     portlet = GoogleMiniSearchEnginePortlet.new
     if options[:portlet]
-      portlet = options.delete(:portlet)
+      portlet = options[:portlet]
     end
     portlet
   end
 
-  # Given a URL, GET it and return the contents
-  # @param [String] url A URL formatted string
-  def self.fetch_document(url)
-    Rails.logger.debug {"GSA: Fetching '#{url}'"}
-    Net::HTTP.get(URI.parse(url))
-  end
-
   # Fetches the xml response from the google mini server.
   def self.fetch_xml_doc(query, options={})
-    url = create_url_for_query(options, query)
-    response = fetch_document(url)
-    REXML::Document.new(response)
+    # Turns off automatic results filter (filter=0), which when set to 1, allows mini to reduces the # of similar/duplicate results,
+    # but makes it hard to determine the total # of results.
+    url = build_mini_url(options, query)
+    response = Net::HTTP.get(URI.parse(url))
+    xml_doc = REXML::Document.new(response)
+    return xml_doc
   end
 
   def self.parse_key_matches(xml_doc)
@@ -165,10 +125,6 @@ class SearchResult
     attr_accessor :results_count, :num_pages, :current_page, :start, :query, :pages, :key_matches, :synonyms
     attr_writer :path
 
-    # For what these codes mean, see http://code.google.com/apis/searchappliance/documentation/46/xml_reference.html#request_sort
-    SORT_BY_DATE_PARAM = "date:D:S:d1"
-    SORT_BY_RELEVANCE_PARAM = "date:D:L:d1"
-
     def initialize(array=[])
       # Need to set defaults so an empty result set works.
       self.start = 0
@@ -193,15 +149,11 @@ class SearchResult
       previous_start >= 0 && num_pages > 1
     end
 
-    # Returns a range of pages that should appear in the pager control. This is design to mimic GSA's pager control,
-    # which will show up to 20 pages at a time, based on the 'range' of pages around the current page.
-    #
-    # i.e. on page 12:  < 2 3 4 5 6 7 8 9 10 11 _12_ 13 14 15 16 17 18 19 20 21 22 >
     def pages
-      return [] if num_pages <= 1
-      first_page = current_page - 10 > 1 ? current_page - 10 : 1
-      last_page = current_page + 9 > num_pages ? num_pages : current_page + 9
-      (first_page..last_page)
+      if num_pages > 1
+        return (1..num_pages)
+      end
+      []
     end
 
     def next_start
@@ -221,28 +173,6 @@ class SearchResult
       1
     end
 
-    # Determines the current Query is sorting by date.
-    #
-    # @param [Hash] params The query parameter from the search page. (same as Rails params)
-    def sorting_by_date?(params)
-      params[:sort] == SearchResult::QueryResult::SORT_BY_DATE_PARAM
-    end
-
-    def path_for(new_query)
-      "#{path}?query=#{new_query}"
-    end
-    # Return the path to sort the current search results by date.
-    #
-    # Based on http://code.google.com/apis/searchappliance/documentation/46/xml_reference.html#request_sort
-    def sort_by_date_path
-      "#{path}?query=#{query}&sort=#{SORT_BY_DATE_PARAM}"
-    end
-
-    # Returns the path to sort the current results by relevance (inverse of sort_by_date_path).
-    def sort_by_relevance_path
-      "#{path}?query=#{query}&sort=#{SORT_BY_RELEVANCE_PARAM}"
-    end
-
     def next_page_path
       "#{path}?query=#{query}&start=#{next_start}"
     end

data/app/portlets/google_mini_search_engine_portlet.rb

@@ -1,28 +1,12 @@
 class GoogleMiniSearchEnginePortlet < Portlet
 
   enable_template_editor true
-
+  
   def render
+    @query = params[:query]
     @site = params[:site]
     @start = params[:start] ? params[:start].to_i : 0
-    options = {:start => @start, :portlet => self, :site=>@site, :sort=>params[:sort]}
-    query_string = params[:query]
-
-    @results = SearchResult.find(query_string, options.clone) # Need to clone, so that :portlet isn't removed for the 2nd call.
-
-    # This is temporary, while the API is being reworked. Ideally, the search results would contain a reference
-    # to the query, so that two X calls isn't needed.
-    @query = SearchResult.create_query(query_string, options.clone)
-
-    if narrow_your_search?
-      @appliance = SearchResult.new_gsa(self)
-      @suggested_queries = @appliance.find_narrow_search_results(query_string)
-    end
+    @results = SearchResult.find(@query, {:start => @start, :portlet => @portlet, :site=>@site})
   end
-
-  # Handles the fact that all portlet attributes, including checkboxes like enable_your_search are stored as strings.
-  def narrow_your_search?
-    self.enable_narrow_your_search == "1"
-  end
-
+    
 end

data/app/views/portlets/google_mini_search_engine/_form.html.erb

@@ -3,6 +3,4 @@
 <%= f.cms_text_field :service_url, :default_value=> "http://", :instructions => "Full Domain name where the Google Mini server is hosted, i.e. 'http://mini.somedomain.com'." %>
 <%= f.cms_text_field :collection_name, :instructions => "Copy the name of the Collection from Google Mini here. (Can pass 'site' param to override as well).", :default_value=>"default_collection" %>
 <%= f.cms_text_field :front_end_name, :instructions => "Copy the name of the Collection front end from Google Mini here.", :default_value=>"default_frontend" %>
-<%= f.cms_check_box :enable_narrow_your_search, :instructions => "The 'Narrow Your Search' feature is a only available for Google Search Appliance, not with Google Mini.",
-                    :label=>"Enable Narrowing?" %>
 <%= f.cms_template_editor :template %>