bcms_google_mini_search 1.0.0 → 1.1.0

data/README.markdown

@@ -1,13 +1,19 @@
 # Google Mini Search Module
 
-This module allows BrowserCMS to integrate with a Google Mini Search Appliance. Google Mini is a standalone search
-server, which can be configured to crawl your website. This module submits queries to a Mini server, and formats the results.
+This module allows BrowserCMS to integrate with a Google Search Appliance (Mini or GSA). Google Search Appliance is a standalone search
+server, which can be configured to crawl your website. This module submits queries to a GSA/Mini server, and formats the results.
 It consists of the following two portlets.
 
 1. Search Box - Displays an input box that submits a search query.
 2. Google Mini Search Results Portlet - Sends query to the Mini, formats the XML response and displays the results.
 
-Note: This module assume the BrowserCMS web site owner has access to their own Google Mini server, either hosted by
+Features:
+1. Allows for formatted results of GSA search results.
+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.
 
 ## A. Instructions
@@ -55,8 +61,8 @@ the module work, you will have to configure two portlets.
 1. In your sitemap, create a new section called 'Search', with a path '/search'.
 2. Create a page called 'Search Results', with a path '/search/search-results'.
 3. On that page, add a new 'Google Mini Search Engine' portlet. Keep the default for most fields.
-4. In the Service URL, field, enter in the domain name to your google mini server (i.e.  http://google.mini.mysite.com)
-5. In the Colleciton Name field, enter the same name you gave your collection in B.2.2. (i.e. MYSITE)
+4. In the Service URL, field, enter in the domain name to your google mini server (i.e.  http://google.mini.mysite.com). Note: This URL should be just the domain, i.e. no /search.
+5. In the Collection Name field, enter the same name you gave your collection in B.2.2. (i.e. MYSITE)
 6. In the Front End Name field, enter the same name you have your frontend in B.3.2 (i.e. MYSITE_frontend)
 7. Make sure the 'path' attribute is the same as the page you are adding  the portlet to (i.e. /search/search-results
 8. Save the portlet

data/app/models/search_result.rb

@@ -7,8 +7,9 @@ class SearchResult
   # a paging results of Search Results.
   #
   def self.find(query, options={})
+    return QueryResult.new unless query
     xml_doc = fetch_xml_doc(query, options)
-    results = convert_to_results(xml_doc, options)
+    results = parse_xml(xml_doc, options)
     results.query = query
     portlet = find_search_engine_portlet(options)
     results.path = portlet.path 
@@ -21,7 +22,7 @@ class SearchResult
     count ? count.text.to_i : 0
   end
 
-  def self.parse_results(xml_doc)
+  def self.parse_hits(xml_doc)
     root = xml_doc.root
     results = []
     xml_doc.elements.each('GSP/RES/R') do |ele|
@@ -37,10 +38,11 @@ class SearchResult
     results
   end
 
-  def self.convert_to_results(xml_doc, options={})
-    array = parse_results(xml_doc)
-
-    results = PagingResults.new(array)
+  def self.parse_xml(xml_doc, options={})
+    hits = parse_hits(xml_doc)
+    results = QueryResult.new(hits)
+    results.key_matches= parse_key_matches(xml_doc)
+    results.synonyms = parse_synonyms(xml_doc, results)
     results.results_count = parse_results_count(xml_doc)
     results.num_pages = calculate_results_pages(results.results_count)
     results.start = options[:start] ? options[:start] : 0
@@ -58,11 +60,18 @@ class SearchResult
 
   def self.build_mini_url(options, query)
     portlet = find_search_engine_portlet(options)
-    url = "#{portlet.service_url}/search?q=#{query}&output=xml_no_dtd&client=#{portlet.front_end_name}&site=#{portlet.collection_name}&filter=0"
+    encoded_query = CGI::escape(query)
+
+    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
-    return url
+    return url    
   end
 
   def self.find_search_engine_portlet(options)
@@ -83,13 +92,45 @@ class SearchResult
     return xml_doc
   end
 
+  def self.parse_key_matches(xml_doc)
+    matches = []
+    xml_doc.elements.each('GSP/GM') do |ele|
+      key_match = KeyMatch.new
+      key_match.url = ele.elements["GL"].text
+      key_match.title = ele.elements["GD"].text
+      matches << key_match
+    end
+    matches
+  end
 
+  def self.parse_synonyms(xml_doc, query_result)
+    synonyms = []
+    xml_doc.elements.each('GSP/Synonyms/OneSynonym') do |ele|
+      synonym = Synonym.new
+      synonym.query = ele.attributes["q"]
+      synonym.label = ele.text
+      synonym.query_result = query_result
+      synonyms << synonym
+    end
+    synonyms
+  end
+  # Represents the entire result of the query
+  class QueryResult < Array
 
-  class PagingResults < Array
-
-    attr_accessor :results_count, :num_pages, :current_page, :start, :query, :pages
+    attr_accessor :results_count, :num_pages, :current_page, :start, :query, :pages, :key_matches, :synonyms
     attr_writer :path
 
+    def initialize(array=[])
+      # Need to set defaults so an empty result set works.
+      self.start = 0
+      self.results_count=0
+      self.key_matches = []
+      self.synonyms = []
+      self.num_pages = 1
+      super(array)
+
+    end
+    
     def path
       @path ? @path : "/search/search-results"
     end
@@ -138,6 +179,29 @@ class SearchResult
     def page_path(page_num)
       "#{path}?query=#{query}&start=#{page_num * 10 - 10}"
     end
+
+    def key_matches?
+      !key_matches.empty?
+    end
+
+    def synonyms?
+      !synonyms.empty?
+    end
+  end
+
+  # Sometimes refered to as 'Featured Links', though the GSA UI uses the KeyMatch
+  class KeyMatch
+    attr_accessor :url, :title
+  end
+
+  # AKA Related Query in Google UI
+  class Synonym
+    attr_accessor :query, :label, :query_result
+
+    # Return the url that should be
+    def url
+      "#{query_result.path}?query=#{query}"
+    end
   end
 
 

data/app/portlets/google_mini_search_engine_portlet.rb

@@ -1,9 +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
-    @results = SearchResult.find(@query, {:start => @start, :portlet => @portlet})
+    @results = SearchResult.find(@query, {:start => @start, :portlet => @portlet, :site=>@site})
   end
     
 end

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

@@ -1,6 +1,6 @@
 <%= f.cms_text_field :name, :default_value => "Google Mini Search Engine", :instructions=>"The Search Box portlet will look this up by name, so make it unique." %>
 <%= f.cms_text_field :path, :default_value => "/search/search-results", :instructions=>"The path of the page this portlet will be embedded in." %>
 <%= 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." %>
-<%= f.cms_text_field :front_end_name, :instructions => "Copy the name of the Collection front end from Google Mini here." %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%= 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_template_editor :template %>

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

@@ -2,7 +2,21 @@
 For '<%= @results.query %>', found <%= @results.results_count %> results. <br />
 <% if @results.previous_page? %><%= link_to h("< Back"), @results.previous_page_path %><% end %>
 <% if @results.next_page? %><%= link_to h("Next >"), @results.next_page_path %><% end %>
-<ul>
+<% if @results.key_matches? %>
+    <ul class="key_matches">
+    <% @results.key_matches.each do |match| %>
+        <li><%= link_to match.title, match.url %></li>    
+    <% end %>
+    </ul>
+<% end %>
+<% if @results.synonyms? %>
+    <span class="synonyms">You could also try:
+    <% @results.synonyms.each do |synonym| %>
+        <%= link_to synonym.label, synonym.url %>    
+    <% end %>
+    </span>
+<% end %>
+<ul class="search_results">
   <% @results.each do |result|%>
     <li>
         <%= result.number %> <%= link_to result.title, result.url,  :class=>"search_result_title" %><br />

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

@@ -1,4 +1,4 @@
 <% form_tag @search_engine.path, :method=>'GET' do %>
-    <%= text_field_tag 'query' %>
+    <%= text_field_tag 'query', params[:query] %>
     <%= submit_tag 'Go' %>
 <% end %>

data/test/performance/browsing_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+require 'mocha'
+
+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
+
+  # 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
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/helpers/search_engine_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class SearchEngineHelperTest < ActionView::TestCase
+end

data/test/unit/portlets/google_mini_search_engine_portlet_test.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class GoogleMiniSearchEngineTest < ActiveSupport::TestCase
+
+  test "Should be able to create new instance of a portlet" do
+    assert GoogleMiniSearchEnginePortlet.create!(:name => "New Portlet")
+  end
+
+
+
+  test "Path attribute can be set in constructor" do
+    portlet = GoogleMiniSearchEnginePortlet.create!(:name=>"Engine", :path => "/engine")
+    assert_equal "/engine", portlet.path
+  end
+end

data/test/unit/portlets/search_box_portlet_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class SearchBoxTest < ActiveSupport::TestCase
+
+  test "Should be able to create new instance of a portlet" do
+    assert SearchBoxPortlet.create!(:name => "New Portlet")
+  end
+  
+end

data/test/unit/search_result_test.rb

@@ -0,0 +1,428 @@
+require File.join(File.dirname(__FILE__), '/../test_helper')
+
+class SearchResultTest < ActiveSupport::TestCase
+
+  def setup
+    @xml_string =  <<EOF
+      <GSP>
+        <RES>
+          <M>2</M>
+          <R N="1">
+            <U>http://someurl.com</U>
+            <T>TITLE</T>
+            <S>BLURB</S>
+            <HAS>
+              <C SZ="1k" />
+            </HAS>
+          </R>
+          <R N="2">
+            <U>http://someurl2.com</U>
+            <T>TITLE 2</T>
+            <S>BLURB 2</S>
+            <HAS>
+              <C SZ="2k"/>
+            </HAS>
+          </R>
+        </RES>
+      </GSP>
+EOF
+    @xml_doc =  REXML::Document.new @xml_string
+
+    @large_results_set = <<EOF
+      <GSP>
+        <RES>
+          <M>35</M>
+          <R N="1">
+            <U>http://someurl.com</U>
+            <T>TITLE</T>
+            <S>BLURB</S>
+            <HAS>
+              <C SZ="1k" />
+            </HAS>
+          </R>
+          <R N="2">
+            <U>http://someurl2.com</U>
+            <T>TITLE 2</T>
+            <S>BLURB 2</S>
+            <HAS>
+              <C SZ="2k"/>
+            </HAS>
+          </R>
+        </RES>
+      </GSP>
+EOF
+    @large_xml_doc = REXML::Document.new(@large_results_set)
+
+
+  end
+
+  test "Parse result count from google mini results xml." do
+
+    xml =  <<EOF
+      <GSP>
+        <RES>
+          <M>35</M>
+        </RES>
+      </GSP>
+EOF
+    empty_doc = REXML::Document.new xml
+    assert_equal 35, SearchResult.parse_results_count(empty_doc)
+    assert_equal 35, SearchResult.parse_xml(empty_doc).results_count
+    assert_equal 4, SearchResult.parse_xml(empty_doc).num_pages
+
+  end
+
+  test "Default result count is zero." do
+
+    xml =  <<EOF
+      <GSP>
+        <RES>
+        </RES>
+      </GSP>
+EOF
+    empty_doc = REXML::Document.new xml
+    assert_equal 0, SearchResult.parse_results_count(empty_doc)
+
+  end
+
+  test "Empty xml gives empty results" do
+    xml =  <<EOF
+      <GSP>
+        <RES>
+        </RES>
+      </GSP>
+EOF
+    empty_doc = REXML::Document.new xml
+    SearchResult.expects(:fetch_xml_doc).with("therapy", {}).returns(empty_doc)
+
+    assert_equal [], SearchResult.find("therapy", {})
+  end
+
+  test "Parse result set" do
+
+    results = SearchResult.parse_hits(@xml_doc)
+    assert_equal 2, results.size
+
+    assert_equal "1", results[0].number
+    assert_equal "http://someurl.com", results[0].url
+    assert_equal "TITLE", results[0].title
+    assert_equal "BLURB", results[0].description
+    assert_equal "1k", results[0].size
+
+    assert_equal "2", results[1].number
+    assert_equal "http://someurl2.com", results[1].url
+    assert_equal "TITLE 2", results[1].title
+    assert_equal "BLURB 2", results[1].description
+    assert_equal "2k", results[1].size
+  end
+
+
+  test "Calculates the results pages" do
+    assert_equal 1, SearchResult.calculate_results_pages(9)
+    assert_equal 1, SearchResult.calculate_results_pages(10)
+    assert_equal 2, SearchResult.calculate_results_pages(19)
+    assert_equal 2, SearchResult.calculate_results_pages(20)
+    assert_equal 3, SearchResult.calculate_results_pages(21)
+    assert_equal 4, SearchResult.calculate_results_pages(40)
+    assert_equal 0, SearchResult.calculate_results_pages(0)
+
+  end
+
+  test "Calculates current page based on total results and start" do
+    results = SearchResult::QueryResult.new
+    results.start = 0
+    assert_equal 1, results.current_page
+
+    results.start = 10
+    assert_equal 2, results.current_page
+
+    results.start = 20
+    assert_equal 3, results.current_page
+
+    results.start = 30
+    assert_equal 4, results.current_page
+  end
+
+  test "Next start" do
+    r = SearchResult::QueryResult.new
+    r.start = 0
+    assert_equal 10, r.next_start
+    r.start = 10
+    assert_equal 20, r.next_start
+    r.start = 20
+    assert_equal 30, r.next_start
+  end
+
+  test "Find results should return a paging list of documents with no start" do
+    SearchResult.expects(:fetch_xml_doc).with("therapy", {}).returns(@large_xml_doc)
+
+    results = SearchResult.find("therapy")
+    assert_equal "therapy", results.query
+    assert_equal 35, results.results_count
+    assert_equal 4, results.num_pages
+    assert_equal 0, results.start
+    assert_equal 2, results.size
+    assert_equal 1, results.current_page
+    assert_equal 10, results.next_start
+    assert results.next_page?
+    assert_equal -10, results.previous_start
+    assert_equal false, results.previous_page?
+    assert_equal (1..4), results.pages
+
+  end
+
+
+  test "Find results starts on page 2, if a start is specified" do
+    SearchResult.expects(:fetch_xml_doc).with("therapy", :start=>10).returns(@large_xml_doc)
+
+    results = SearchResult.find("therapy", :start => 10)
+    assert_equal 35, results.results_count
+    assert_equal 4, results.num_pages
+    assert_equal 10, results.start
+    assert_equal 2, results.size
+    assert_equal 2, results.current_page
+    assert_equal 20, results.next_start
+    assert results.next_page?
+    assert_equal 0, results.previous_start
+    assert_equal true, results.previous_page?
+  end
+
+  test "No next start when on the last page" do
+    SearchResult.expects(:fetch_xml_doc).with("therapy", {:start => 30}).returns(@large_xml_doc)
+
+    results = SearchResult.find("therapy", :start => 30)
+    assert_equal 40, results.next_start
+    assert_equal false, results.next_page?
+    assert_equal 20, results.previous_start
+    assert_equal true, results.previous_page?
+  end
+
+  test "Should be no previous or next for a single page of results" do
+    SearchResult.expects(:fetch_xml_doc).with("therapy", {}).returns(@xml_doc)
+
+    results = SearchResult.find("therapy")
+    assert_equal false, results.next_page?
+    assert_equal false, results.previous_page?
+    assert_equal [], results.pages
+  end
+
+  test "Behavior of ranges" do
+    c = 0
+    (1..4).each_with_index do |i, count|
+      assert_equal count + 1, i
+      c = count
+    end
+    assert_equal 3, c
+  end
+
+  test "current_page should check to see if the current page matches" do
+    results = SearchResult::QueryResult.new
+    results.start = 0
+
+    assert_equal true, results.current_page?(1)
+    assert_equal false, results.current_page?(2)
+    assert_equal false, results.current_page?(3)
+    assert_equal false, results.current_page?(4)
+
+  end
+
+  test "Path to next page" do
+    results = SearchResult::QueryResult.new
+    results.start = 0
+    results.path = "/search/search-results"
+    results.query = "X"
+
+    assert_equal "/search/search-results?query=X&start=10", results.next_page_path
+  end
+
+  test "Path to previous page" do
+    results = SearchResult::QueryResult.new
+    results.start = 20
+    results.path = "/search/search-results"
+    results.query = "X"
+
+    assert_equal "/search/search-results?query=X&start=10", results.previous_page_path
+  end
+
+  test "Sets path to default search-results" do
+    results = SearchResult::QueryResult.new
+    assert_equal "/search/search-results", results.path
+  end
+
+  test "Setting path overrides the defaults" do
+    results = SearchResult::QueryResult.new
+    results.path = "/other"
+    assert_equal "/other", results.path
+  end
+
+  test "page_path" do
+    results = SearchResult::QueryResult.new
+    results.query = "X"
+
+    assert_equal "/search/search-results?query=X&start=0", results.page_path(1)
+    assert_equal "/search/search-results?query=X&start=10", results.page_path(2)
+    assert_equal "/search/search-results?query=X&start=20", results.page_path(3)
+    assert_equal "/search/search-results?query=X&start=30", results.page_path(4)
+
+  end
+
+  test "Portlet attributes are used to look up path" do
+    portlet = GoogleMiniSearchEnginePortlet.new(:name=>"Engine", :path => "/engine")
+    SearchResult.expects(:fetch_xml_doc).with("therapy", {:portlet=> portlet}).returns(@xml_doc)
+
+    results = SearchResult.find("therapy", {:portlet=> portlet})
+
+    assert_equal "/engine", results.path
+  end
+
+  test "Default path is used if no portlet specified" do
+    SearchResult.expects(:fetch_xml_doc).with("therapy", {}).returns(@xml_doc)
+    results = SearchResult.find("therapy", {})
+    assert_equal "/search/search-results", results.path
+  end
+
+  test "Uses service URL from portlet" do
+    portlet = GoogleMiniSearchEnginePortlet.new(
+            :name=>"Engine", :path => "/engine", :service_url => "http://mini.someurl.com",
+            :collection_name => "COLLECT", :front_end_name => "FRONT_END")
+
+    url = SearchResult.build_mini_url({:portlet => portlet}, "STUFF")
+    assert_equal "http://mini.someurl.com/search?q=STUFF&output=xml_no_dtd&client=FRONT_END&site=COLLECT&filter=0", url
+
+    url = SearchResult.build_mini_url({:portlet => portlet, :start=>100}, "STUFF")
+    assert_equal "http://mini.someurl.com/search?q=STUFF&output=xml_no_dtd&client=FRONT_END&site=COLLECT&filter=0&start=100", url
+
+  end
+
+  test "Explicitly passing a collection in will query with that rather than a default collection" do
+    portlet = GoogleMiniSearchEnginePortlet.new(
+            :name=>"Engine", :path => "/engine", :service_url => "http://mini.someurl.com",
+            :collection_name => "COLLECT", :front_end_name => "FRONT_END")
+
+    url = SearchResult.build_mini_url({:portlet => portlet, :site=>"ANOTHER_COLLECTION"}, "STUFF")
+    assert_equal "http://mini.someurl.com/search?q=STUFF&output=xml_no_dtd&client=FRONT_END&site=ANOTHER_COLLECTION&filter=0", url
+  end
+
+  test "Handles multiword queries" do
+    url = SearchResult.build_mini_url({}, "One Two")
+    assert_equal "/search?q=One+Two&output=xml_no_dtd&client=&site=&filter=0", url
+  end
+
+  test "Handles keymatches in results" do
+    @xml_with_keymatches = <<XML
+    <GSP>
+        <GM>
+          <GL>http://url1.org</GL>
+          <GD>URL 1</GD>
+        </GM>
+        <GM>
+          <GL>http://url2.org</GL>
+          <GD>URL 2</GD>
+        </GM>
+        <RES>
+          <M>35</M>
+          <R N="1">
+            <U>http://someurl.com</U>
+            <T>TITLE</T>
+            <S>BLURB</S>
+            <HAS>
+              <C SZ="1k" />
+            </HAS>
+          </R>
+          <R N="2">
+            <U>http://someurl2.com</U>
+            <T>TITLE 2</T>
+            <S>BLURB 2</S>
+            <HAS>
+              <C SZ="2k"/>
+            </HAS>
+          </R>
+        </RES>
+      </GSP>
+XML
+    @results_with_keymatches =  REXML::Document.new @xml_with_keymatches
+
+    result = SearchResult.parse_xml @results_with_keymatches
+
+    assert_equal true, result.key_matches?
+    assert_equal 2, result.key_matches.size
+    assert_equal "http://url1.org", result.key_matches[0].url
+    assert_equal "URL 1", result.key_matches[0].title
+    assert_equal "http://url2.org", result.key_matches[1].url
+    assert_equal "URL 2", result.key_matches[1].title
+  end
+
+  test "Handles results with no keymatches" do
+    result = SearchResult.parse_xml @xml_doc
+    assert_equal false, result.key_matches?
+  end
+
+  test "Handle Synonyms / Related Queries" do
+    xml_with_synonyms = <<XML
+    <GSP>
+        <Synonyms>
+          <OneSynonym q="Query 1">Label 1</OneSynonym>
+          <OneSynonym q="Query 2">Label 2</OneSynonym>
+        </Synonyms>
+        <RES>
+          <M>35</M>
+          <R N="1">
+            <U>http://someurl.com</U>
+            <T>TITLE</T>
+            <S>BLURB</S>
+            <HAS>
+              <C SZ="1k" />
+            </HAS>
+          </R>
+          <R N="2">
+            <U>http://someurl2.com</U>
+            <T>TITLE 2</T>
+            <S>BLURB 2</S>
+            <HAS>
+              <C SZ="2k"/>
+            </HAS>
+          </R>
+        </RES>
+      </GSP>
+XML
+    xml_doc_with_synonyms =  REXML::Document.new xml_with_synonyms
+
+    result = SearchResult.parse_xml xml_doc_with_synonyms
+
+    result.expects(:path).returns("/search").twice
+    assert_equal true, result.synonyms?
+    assert_equal 2, result.synonyms.size
+    assert_equal "Label 1", result.synonyms[0].label
+    assert_equal "Query 1", result.synonyms[0].query
+    assert_equal "/search?query=Query 1", result.synonyms[0].url
+    assert_equal "Label 2", result.synonyms[1].label
+    assert_equal "Query 2", result.synonyms[1].query
+    assert_equal "/search?query=Query 2", result.synonyms[1].url
+
+  end
+
+  test "Handles results with no Synonyms" do
+    result = SearchResult.parse_xml @xml_doc
+    assert_equal false, result.synonyms?                                       
+  end
+
+  test "Calculate URL for Related Queries/Synonyms" do
+    syn = SearchResult::Synonym.new
+    syn.query = "Testing"
+    mock_result = mock()
+    mock_result.expects(:path).returns("/random")
+    syn.query_result = mock_result
+    assert_equal "/random?query=Testing", syn.url
+  end
+
+  test "No query = empty results" do
+    result = SearchResult.find(nil)
+    assert_equal 0, result.size
+    assert_equal 0, result.start
+    assert_equal false, result.next_page?
+    assert_equal false, result.previous_page?
+    assert_equal false, result.key_matches?
+    assert_equal false, result.synonyms?
+    assert_equal [], result.pages
+  end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bcms_google_mini_search
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - BrowserMedia
@@ -9,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 -05:00
+date: 2010-08-18 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: 
+description: Allows developers to integrate Google Mini or Google Search Appliance into their CMS sites. Can be used to fetch search results and format them.
 email: github@browsermedia.com
 executables: []
 
@@ -24,44 +30,61 @@ extra_rdoc_files:
 files: 
 - app/controllers/application_controller.rb
 - app/helpers/application_helper.rb
+- app/models/search_result.rb
 - app/portlets/google_mini_search_engine_portlet.rb
 - app/portlets/search_box_portlet.rb
-- app/models/search_result.rb
-- app/views/portlets/search_box/render.html.erb
-- app/views/portlets/search_box/_form.html.erb
-- app/views/portlets/google_mini_search_engine/render.html.erb
 - app/views/portlets/google_mini_search_engine/_form.html.erb
+- app/views/portlets/google_mini_search_engine/render.html.erb
+- app/views/portlets/search_box/_form.html.erb
+- app/views/portlets/search_box/render.html.erb
 - lib/bcms_google_mini_search.rb
 - lib/bcms_google_mini_search/routes.rb
 - rails/init.rb
 - README.markdown
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/helpers/search_engine_helper_test.rb
+- test/unit/portlets/google_mini_search_engine_portlet_test.rb
+- test/unit/portlets/search_box_portlet_test.rb
+- test/unit/search_result_test.rb
 has_rdoc: true
-homepage: http://www.browsercms.org
+homepage: http://github.com/browsermedia/bcms_google_mini_search
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: bcms_google_mini_search
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Google Mini Search Module for BrowserCMS
-test_files: []
-
+test_files: 
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/helpers/search_engine_helper_test.rb
+- test/unit/portlets/google_mini_search_engine_portlet_test.rb
+- test/unit/portlets/search_box_portlet_test.rb
+- test/unit/search_result_test.rb