rails-gsa 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Rohit Sharma - rohit0981989@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,24 @@
+== RailsGSA
+
+Rails gem for integrating GSA(Google Search Appliance) with your rails application.
+
+== Usage
+
+Suppose you have access to a GSA with url "http://testgsa.com", and you want to search for a query string "hello". You can do this using 2 methods:
+1) Send request to the XML API of GSA(XML Response Object)
+2) Send request to the Cluster API of GSA(JSON Response Object)
+
+If we follow the first way, we need to do the following wherever required:
+
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :output => "xml")
+
+The above line of code does the following
+1) Sends a request to the GSA with the specified search term.
+2) Parse the XML response given by the GSA.
+3) Create and return a Hash object of the resultset generated after parsing the XML response.
+
+For the second method, you just need to change the value of the :output parameter to "json", as below:
+
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :output => "json")
+
+This will also return you a Hash object which is created by parsing the JSON response of the GSA.

data/lib/rails-gsa.rb

@@ -0,0 +1,154 @@
+require 'http_requestor'
+require 'nokogiri'
+require 'json'
+
+
+module RailsGSA
+
+  class NoInternetConnectionError < Exception; end
+  def self.default_options
+    @default_options ||= {:gsa_url => "",
+							:search_term => "",
+							:output => "json",
+							:access => "p",
+							:client => "default_frontend",
+							:proxystylesheet => "default_frontend",
+							:site => "default_collection",
+							:start => 0,
+							:num => 10
+						}
+  end
+
+  def self.search(args = {})
+	default_options
+    @default_options.merge!(args)
+	raise ArgumentError, "GSA URL missing. Please provide valid arguments." if @default_options[:gsa_url].empty? || @default_options[:gsa_url].nil?
+	return perform_search
+  end
+
+  protected
+    def self.perform_search
+		@http =  HTTP::Requestor.new(@default_options[:gsa_url])
+		if @default_options[:output] == "json"
+			json_response = @http.post(json_search_url).body
+			response_object = JSON.parse(json_response)
+			return ((response_object.empty? || response_object.nil?) ? {} : response_object)
+		elsif @default_options[:output] == "xml"
+			return xml_parsed_to_search_results(xml_search_url)
+		end
+	end
+
+	def self.json_search_url
+		url = URI.escape("/cluster?q=#{@default_options[:search_term]}&coutput=json&" +
+          "access=#{@default_options[:access]}&output=xml_no_dtd&client=#{@default_options[:client]}&proxystylesheet=#{@default_options[:proxystylesheet]}&" +
+          "site=#{@default_options[:site]}&start=#{@default_options[:start]}&num=#{@default_options[:num]}"
+    )
+		return url
+	end
+	
+	def self.xml_search_url
+		url = URI.escape("/search?q=#{@default_options[:search_term]}&output=xml&client=#{@default_options[:client]}&" +
+          "start=#{@default_options[:start]}&num=#{@default_options[:num]}&filter=0"
+		)
+		return url
+	end
+	
+	def self.xml_parsed_to_search_results(url)
+		if url.include?("cache")
+			new_url = url+"&proxystylesheet=my_frontend"
+			return {:cached_page => @http.get(new_url).body}
+		else
+			new_output = ""
+			output = @http.get(url).body
+			output.each_line{|line| new_output += line.chop}
+			doc = Nokogiri::XML(new_output)
+			search_result_nodes = doc.xpath('//GSP/RES')
+
+			all_params = {}
+			results = {}
+			results[:actual_results] = {}
+      
+			doc.xpath('//GSP/PARAM').each do |p|
+				case p['name']
+					when 'q'
+						all_params[:query] = p['value']
+					when 'site'
+						all_params[:site] = p['value']
+					when 'client'
+						all_params[:client] = p['value']
+					when 'output'
+						all_params[:output] = p['value']
+					when 'start'
+						all_params[:start] = p['value']
+				end
+			end
+
+			results[:all_params] = all_params
+			results[:filtered] = false
+			results[:total_results] = 0
+			results[:search_time] = doc.xpath('//GSP/TM')[0].text
+
+			unless doc.xpath('//GSP/RES').empty? || doc.xpath('//GSP/RES').nil?
+				results[:from] = doc.xpath('//GSP/RES')[0]['SN']
+				results[:to] = doc.xpath('//GSP/RES')[0]['EN']
+			end
+
+			unless search_result_nodes.empty? || search_result_nodes.nil?
+				index = 0
+				search_result_nodes.children.each do |child|
+					case child.name
+						when 'M'
+							results[:total_results] = child.text
+						when 'NB'
+							results[:top_nav] = {}
+							child.children.each do |top_nav|
+								case top_nav.name
+									when 'PU'
+										results[:top_nav][:previous] = top_nav.text
+									when 'NU'
+										results[:top_nav][:next] = top_nav.text
+								end
+							end
+						when 'R'
+							key = "result_#{index}".to_sym
+							index+=1
+							results[:actual_results][key] = {}
+							results[:actual_results][key][:indented] = (child['L'].to_i > 1)
+							child.children.each do |ar|
+								case ar.name
+									when 'U'
+										results[:actual_results][key][:display_link] = ar.text
+									when 'UE'
+										results[:actual_results][key][:link_for_title] = ar.text
+									when 'T'
+										results[:actual_results][key][:title] = ar.text
+									when 'FS'
+										results[:actual_results][key][:date] = ar['VALUE']
+									when 'S'
+										results[:actual_results][key][:description] = ar.text
+									when 'HAS'
+										ar.children.each do |c|
+											case c.name
+												when 'C'
+													add_to_query = "#{c['CID']}:#{results[:actual_results][key][:link_for_title]}"
+													final_cached_url = "#{@default_options[:gsa_url]}/search?q=cache:#{add_to_query}+#{all_params[:query]}&site=#{all_params[:site]}&client=#{all_params[:client]}&output=#{all_params[:output]}&proxystylesheet=my_frontend"                          
+													results[:actual_results][key][:cache_link] = final_cached_url
+													results[:actual_results][key][:size] = c['SZ']
+											end
+										end
+									when 'HN'
+										results[:actual_results][key][:more_results] = {}
+										results[:actual_results][key][:more_results][:text] = "More Results from #{ar.text}"
+										sitesearch_url = "/search?q=#{all_params[:query]}&site=#{all_params[:site]}&client=#{all_params[:client]}&output=#{all_params[:output]}&as_sitesearch=#{ar.text}"
+										results[:actual_results][key][:more_results][:link] = "#{root_url.chop}#{sitesearch_url}"
+								end
+							end
+						when 'FI'
+							results[:filtered] = true
+					end
+				end
+			end
+			return results
+		end
+	end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rails-gsa
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Rohit Sharma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http-requestor
+  requirement: &29919252 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *29919252
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &29767380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *29767380
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &29767104 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *29767104
+description: Integrate GSA(Google Search Appliance) with your ruby/rails application.
+email: rohit0981989@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails-gsa.rb
+- MIT-LICENSE
+- README.rdoc
+homepage: http://github.com/rohit9889/rails-gsa
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Integrate GSA(Google Search Appliance) with your ruby/rails application.
+test_files: []