google-site-search 0.0.7 → 0.0.8

data/README.rdoc

@@ -47,18 +47,25 @@ Since google only allows a max of 20 returned results I have added a method that
     # has soon as a search doesn't have a next_results_url the method stops.
     array_of_search_results = GoogleSiteSearch.query_multiple(5, *YOUR_URL*)  
 
+== Caching
+
+To aid in caching I added a a *caching_key* method which sorts the query parameters, removes some unique parameters that google adds (i.e. an _ie_ parameter which has something to do with related searchs), and compresses the result. It should be a unique representation of a search url, and used to cache results. 
+
 == Blocks (and a caching example)
 
 Both the query and query_multiple methods can take a block which executes for each Search object found.
 
-    # here is a rails example using the block 
+    # here is a rails example using caching and supplying a block 
     url = GoogleSiteSearch::UrlBuilder.new("microsoft", "00255077836266642015:u-scht7a-8i")
-    @search = Rails.cache.fetch(url) do |search|
-      # I can do something with the search objects.
-      # possibly custom analytics for our searchs?
-      search.url # we can access the object
+
+    @search = Rails.cache.fetch(GoogleSiteSearch::caching_key(url.to_s), :expires => 1.day) do |search|
+      GoogleSiteSearch.query(url, SearchResult) do |search|
+        # I can do something with the search objects.
+        # possibly some custom analytics for our searchs?
+        search.url # we can access the object
+      end
     end
-      
+
 
 == Advanced Usage 
 
@@ -87,7 +94,7 @@ See
 
 == Pagination
 
-The google search api does the work of pagination for us, supplying the next and previous urls. The urls are relative paths and contain the search engine id parameter. Since this is a security concern I strip out the search engine id when I store them in the Search.next_result_url and Search.previous_result_url methods. This makes them safe to put in links on views and it is why you must supply the search engine id again on the paginate call; so full url can be rebuilt for the query call.
+The google search api does the work of pagination for us, supplying the next and previous urls. The urls are relative paths and contain the search engine id parameter. Since this is a security concern I strip out the search engine id when I store them in the Search.next_results_url and Search.previous_results_url methods. This makes them safe to put in links on views and it is why you must supply the search engine id again on the paginate call; so the full url can be rebuilt for the query call.
 
     search2 = GoogleSiteSearch.query(GoogleSiteSearch.paginate(search1.next_results_url, "00255077836266642015:u-scht7a-8i"))
 

data/lib/google-site-search/search.rb

@@ -81,7 +81,7 @@ module GoogleSiteSearch
         @previous_results_url = remove_search_engine_id(doc.find_first("RES/NB/PU").try(:content))
         @search_query = doc.find_first("Q").try(:content)
       rescue Exception => e
-        raise ParsingError, "#{e.message} URL:[#{@url}] XML:[#{@xml}]"
+        raise ParsingError, "#{e.message} Class:[#{e.class}] URL:[#{@url}] XML:[#{@xml}]"
       end
     end
 
@@ -90,7 +90,7 @@ module GoogleSiteSearch
       uri = URI.parse(url)
       params = Rack::Utils::parse_query(uri.query)
       params.delete("cx")
-      uri.query = params.map{|k,v| "#{k}=#{v}"}.sort.join("&")
+      uri.query = params.to_query
       uri.to_s
     end
   end

data/lib/google-site-search/version.rb

@@ -1,3 +1,3 @@
 module GoogleSiteSearch
-	VERSION = "0.0.7"
+	VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-site-search
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 00:00:00.000000000Z
+date: 2013-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &11771100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11771100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &11770260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11770260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rsmaz
-  requirement: &11761040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11761040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &11760240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11760240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem to aid in the consumption of the google site search service; querys
   the service, populates a result object and has some related helper methods.
 email:
@@ -92,21 +112,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3596847305660679714
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3596847305660679714
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem to aid in the consumption of the google site search service; querys