rails-gsa 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,24 +1,67 @@
 == RailsGSA
 
 Rails gem for integrating GSA(Google Search Appliance) with your rails application.
+Getting search results from your GSA can be done in 2 ways:
+
+  * Send request to the XML API of GSA(XML Response Object)
+  * Send request to the Cluster API of GSA(JSON Response Object)
+
+== Installation
+
+  gem install rails-gsa
 
 == 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)
+=== Get JSON Response
+
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :output => "json")
+  # where,
+  # gsa_url is the domain of your GSA
+  # search_term is the query
+  # output is the expected response type
+
+Here a request will be sent to your GSA and the recieved JSON response will be parsed and returned to you as a Hash
 
-If we follow the first way, we need to do the following wherever required:
+=== Get XML Response
 
   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.
+Here a request will be sent to your GSA and the recieved XML response will be parsed and returned to you as a Hash
 
-For the second method, you just need to change the value of the :output parameter to "json", as below:
+== Extra Options to modify the response
 
-  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :output => "json")
+=== Access Level
+
+Specifies whether to search public content, secure content, or both.
+
+  # Default Value: "p"
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :access => "s")
+  # Possible values for the access parameter are:
+  # p - search only public content 
+  # s - search only secure content 
+  # a - search all content, both public and secure 
+
+=== Change the Collection
+
+Limits search results to the contents of the specified collection. You can search multiple collections by separating collection names with the OR character, which is notated as the pipe symbol, or the AND character, which is notated as a period. If a user submits a search query without the site parameter, the entire search index is queried.
+
+  # Default Value: "default_collection"
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :site => "myCollection")
+  
+  # You can also specify whether you want to search results in multiple collections as given below:
+  
+  # The following example uses the AND character:
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :site => "col1.col2")
+  
+  # The following example uses the OR character:
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :site => "col1|col2")
+
+=== Pagination
+
+You can use the pagination parameters to get results as you desire
+
+  RailsGSA.search(:gsa_url => "http://testgsa.com", :search_term => "hello", :start => 10, :num => 20)
+  # Deafult value: start = 0; num = 10
 
-This will also return you a Hash object which is created by parsing the JSON response of the GSA.
+The above example will give you results starting from 10 and the next 20 results.
+The maximum number of results available for a query is 1,000, i.e., the value of the start parameter added to the value of the num parameter cannot exceed 1,000. 

data/lib/rails-gsa.rb

@@ -23,6 +23,11 @@ module RailsGSA
 	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?
+	
+	@default_options[:access] = "p" unless ["p", "s", "a"].include?(@default_options[:access])
+	@default_options[:start] = 0 unless @default_options[:start].is_a?(Fixnum)
+	@default_options[:num] = 10 unless @default_options[:num].is_a?(Fixnum)
+	
 	return perform_search
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-gsa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-01-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-requestor
-  requirement: &29919252 !ruby/object:Gem::Requirement
+  requirement: &29294292 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *29919252
+  version_requirements: *29294292
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &29767380 !ruby/object:Gem::Requirement
+  requirement: &29293980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.7.5
   type: :runtime
   prerelease: false
-  version_requirements: *29767380
+  version_requirements: *29293980
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &29767104 !ruby/object:Gem::Requirement
+  requirement: &29293656 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 1.5.5
   type: :runtime
   prerelease: false
-  version_requirements: *29767104
+  version_requirements: *29293656
 description: Integrate GSA(Google Search Appliance) with your ruby/rails application.
 email: rohit0981989@gmail.com
 executables: []