bcms_google_mini_search 1.0.0

data/README.markdown

@@ -0,0 +1,69 @@
+# 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.
+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
+themselves or a third party service.
+
+## A. Instructions
+There are two basic steps to setting up this module:
+
+1. Configure your Google Mini to crawl your site.
+2. Install the module and configure it to point to your Google Mini server.
+
+These instructions assume the Mini is already set up and running.
+
+### B. Configuring Google Mini
+Configuring the mini include three basic steps, configuring it to crawl your site, creating a collection which limits
+what is returned to just your site, and creating a front end, which allows you to submit search queries.
+
+#### B.1. Configuring the crawler
+1. Log into your search appliance (i.e. http://google.mini.mysite.com), and enter your account username/password.
+2. Click on the 'Crawl and Index' link in the left navigation.
+3. In the top box 'Start Crawling from the Following URLs:' add a new line with the full domain name of your site. (i.e. http://www.mysite.com)
+4. In the bottom box, 'Follow and Crawl Only URLs with the Following Patterns:', enter a pattern of urls you want to crawl. (i.e. www.mysite.com/)
+5. Click 'Save URLs to Crawl button'
+
+Once the crawler is configured, it may take 15+ minutes for it to crawl your site. You can still finish configuring
+the mini, but you may need to wait to test the results.
+
+#### B.2. Configuring the collection
+1. Click the collections link in the left nav. This will allow use a create a search collection specifically for this site.
+2. Type the name of the new collection into the 'Collection Name' text box, and click 'Create Collection' (i.e. MYSITE).
+3. After the page refreshes, click the 'Edit' link to the right of the new collection.
+4. In the top box, 'Include Content Matching the Following Patterns:', enter the same pattern as step B.1.3 above (i.e. http://www.mysite.com/)
+5. Click 'Save Collection Defination'
+
+#### B.3. Configuring the front end
+1. In the left nav, click the 'Serving' link
+2. In the 'Front End Name' text field, enter the name for your front end. (i.e. MYSITE_frontend.)
+3. Click 'Create Front End' to save it.
+
+At this point, you should have the Google Mini appliance configured. If you want to test out the search results using
+the Mini's default search UI, you can click the 'Test Center' link in the upper right hand corner. Select your new
+collection and front end by name, and submit queries.
+
+### C. Configuring the BrowserCMS Google Mini Search Module
+These instructions assume you have successfully installed the bcms_google_mini_search module into your project. To make
+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)
+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
+9. On another page create a Search Box portlet (alternatively, you can create the portlet and add it your templates via render_portlet)
+10. Set the 'Search Engine Name' field to the exact same name as the portlet in step C.3 above (i.e. Google Mini Search Engine)
+11. Save the portlet
+
+At this point, you can test the search by entering in a term to the Search Box portlet. If its working, it should call
+the Search Results page and display the same results as what you see in the Mini 'Test Center'. You can style the HTML in
+the template to tweak how your search results will work.

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/search_result.rb

@@ -0,0 +1,144 @@
+class SearchResult
+
+  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.
+  #
+  def self.find(query, options={})
+    xml_doc = fetch_xml_doc(query, options)
+    results = convert_to_results(xml_doc, options)
+    results.query = query
+    portlet = find_search_engine_portlet(options)
+    results.path = portlet.path 
+    results
+  end
+
+  def self.parse_results_count(xml_doc)
+    root = xml_doc.root
+    count = root.elements["RES/M"]
+    count ? count.text.to_i : 0
+  end
+
+  def self.parse_results(xml_doc)
+    root = xml_doc.root
+    results = []
+    xml_doc.elements.each('GSP/RES/R') do |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
+      result.size = ele.elements["HAS/C"].attributes["SZ"]
+
+      results << result
+    end
+    results
+  end
+
+  def self.convert_to_results(xml_doc, options={})
+    array = parse_results(xml_doc)
+
+    results = PagingResults.new(array)
+    results.results_count = parse_results_count(xml_doc)
+    results.num_pages = calculate_results_pages(results.results_count)
+    results.start = options[:start] ? options[:start] : 0
+    results
+  end
+
+
+
+  def self.calculate_results_pages(results_count)
+    num_pages = results_count / 10
+    num_pages = num_pages + 1 if results_count % 10 > 0
+    num_pages
+  end
+
+
+  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"
+    if options[:start]
+      url = url + "&start=#{options[:start]}"
+    end
+    return url
+  end
+
+  def self.find_search_engine_portlet(options)
+    portlet = GoogleMiniSearchEnginePortlet.new
+    if options[:portlet]
+      portlet = options[:portlet]
+    end
+    portlet
+  end
+
+  # Fetches the xml response from the google mini server.
+  def self.fetch_xml_doc(query, options={})
+    # 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
+
+
+
+  class PagingResults < Array
+
+    attr_accessor :results_count, :num_pages, :current_page, :start, :query, :pages
+    attr_writer :path
+
+    def path
+      @path ? @path : "/search/search-results"
+    end
+
+
+    def next_page?
+      next_start < results_count      
+    end
+
+    def previous_page?
+      previous_start >= 0 && num_pages > 1
+    end
+
+    def pages
+      if num_pages > 1
+        return (1..num_pages)
+      end
+      []
+    end
+
+    def next_start
+      start + 10
+    end
+
+    def previous_start
+      start - 10
+    end
+    
+    def current_page?(page_num)
+      (page_num * 10 - 10 == start )
+    end
+
+    def current_page
+      return page = start / 10 + 1 if start
+      1
+    end
+
+    def next_page_path
+      "#{path}?query=#{query}&start=#{next_start}"
+    end
+
+    def previous_page_path
+      "#{path}?query=#{query}&start=#{previous_start}"
+    end
+
+    def page_path(page_num)
+      "#{path}?query=#{query}&start=#{page_num * 10 - 10}"
+    end
+  end
+
+
+end

data/app/portlets/google_mini_search_engine_portlet.rb

@@ -0,0 +1,9 @@
+class GoogleMiniSearchEnginePortlet < Portlet
+    
+  def render
+    @query = params[:query]
+    @start = params[:start] ? params[:start].to_i : 0
+    @results = SearchResult.find(@query, {:start => @start, :portlet => @portlet})
+  end
+    
+end

data/app/portlets/search_box_portlet.rb

@@ -0,0 +1,10 @@
+class SearchBoxPortlet < Portlet
+    
+  def render
+    @search_engine = GoogleMiniSearchEnginePortlet.find_by_name(@portlet.search_engine_name)
+    unless @search_engine
+      raise "There is no Google Mini Search Engine Portlet with name = '#{@portlet.search_engine_name}'. You must create one for this portlet to work."
+    end
+  end
+    
+end

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

@@ -0,0 +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 %>

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

@@ -0,0 +1,19 @@
+<h2>Search Results</h2>
+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>
+  <% @results.each do |result|%>
+    <li>
+        <%= result.number %> <%= link_to result.title, result.url,  :class=>"search_result_title" %><br />
+        <span class="search_result_description"><%= result.description %></span> <br />
+        <span class="search_result_url"><%= result.url %></span> - 
+        <span class="search_result_size"><%= result.size %></span>
+    </li>
+  <% end %>
+</ul>
+<% if @results.previous_page? %><%= link_to h("< Back"), @results.previous_page_path %><% end %>
+<%  @results.pages.each do |p| %>
+      <%= link_to_unless @results.current_page?(p), p, @results.page_path(p) %>
+<% end %>
+<% if @results.next_page? %><%= link_to h("Next >"), @results.next_page_path %><% end %>

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

@@ -0,0 +1,3 @@
+<%= f.cms_text_field :name, :default_value => "Search Box" %>
+<%= f.cms_text_field :search_engine_name, :default_value => "Google Mini Search Engine", :instructions => "Enter the name of the Google Mini Search Portlet which this form will submit queries to." %>
+<%= f.cms_text_area :template, :default_value => @block.class.default_template %>

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

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

data/lib/bcms_google_mini_search.rb

@@ -0,0 +1 @@
+require 'bcms_google_mini_search/routes'

data/lib/bcms_google_mini_search/routes.rb

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_google_mini_search
+    namespace(:cms) do |cms|
+      #cms.content_blocks :google_mini_searches
+    end  
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_google_mini_search
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- BrowserMedia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-24 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: github@browsermedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- app/controllers/application_controller.rb
+- app/helpers/application_helper.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
+- lib/bcms_google_mini_search.rb
+- lib/bcms_google_mini_search/routes.rb
+- rails/init.rb
+- README.markdown
+has_rdoc: true
+homepage: http://www.browsercms.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bcms_google_mini_search
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Google Mini Search Module for BrowserCMS
+test_files: []
+