google-site-search 0.0.2 → 0.0.3

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem "minitest"
   gem "guard-minitest"
   gem "rb-inotify"
 end

data/lib/google-site-search.rb

@@ -47,18 +47,8 @@ module GoogleSiteSearch
 
     # Makes a request to the google search api and returns the xml response as a string.
     def request_xml url
-			response = nil
-      begin
-        ::Timeout::timeout(2) do
-          response = Net::HTTP.get_response(URI.parse(url.to_s))
-        end
-      rescue Errno::ECONNREFUSED => err
-			rescue URI::InvalidURIError => err
-				puts "URI Error [#{url}]"
-      rescue => err
-     	  puts "ERROR #{err.class}"  
-      end
-			response.body if response && response.code == "200"
+      response = Net::HTTP.get_response(URI.parse(url.to_s))
+			response.body if response.is_a?(Net::HTTPSuccess)
     end
 
     # Google returns a result link as an absolute but you may
@@ -72,7 +62,7 @@ module GoogleSiteSearch
 		def separate_search_term_from_filters(string)
 			match = /\smore:p.*/.match(string)
 			return [string, nil] if match.nil?
-			return [match.pre_match, match[0]] 
+			return [match.pre_match.strip, match[0].strip] 
 		end
 
   end

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

@@ -53,28 +53,21 @@ module GoogleSiteSearch
       @results || []
     end
 
-
     private
 
     def parse_xml
-      begin
-        doc = ::XML::Parser.string(@xml).parse
-        doc.find("//GSP/RES/R").each do |result_node|
-          @results << result_class.new(result_node)
-          #puts "*** attribute =  #{result_node.find_first("PageMap/DataObject[@type='metatags']/Attribute[@name='title']").attributes[:value] }"
-        end
-
-        spelling_node = doc.find_first("Spelling/Suggestion")
-				@spelling = spelling_node.try(:content) 
-				@spelling_q = spelling_node.try(:attributes).try(:[],:q)
-        @estimated_results_total = doc.find_first("RES/M").try(:content)
-        @next_results_url = doc.find_first("RES/NB/NU").try(:content)
-        @previous_results_url = doc.find_first("RES/NB/PU").try(:content)
-        @search_query = doc.find_first("Q").try(:content)
-
-      rescue => err
-         puts "parse_xml error #{err.message}"
+      doc = ::XML::Parser.string(@xml).parse
+      doc.find("//GSP/RES/R").each do |result_node|
+        @results << result_class.new(result_node)
       end
+
+      spelling_node = doc.find_first("Spelling/Suggestion")
+      @spelling = spelling_node.try(:content) 
+      @spelling_q = spelling_node.try(:attributes).try(:[],:q)
+      @estimated_results_total = doc.find_first("RES/M").try(:content)
+      @next_results_url = doc.find_first("RES/NB/NU").try(:content)
+      @previous_results_url = doc.find_first("RES/NB/PU").try(:content)
+      @search_query = doc.find_first("Q").try(:content)
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module GoogleSiteSearch
-	VERSION = "0.0.2"
+	VERSION = "0.0.3"
 end

data/test/test_google_site_search.rb

@@ -2,14 +2,18 @@ require_relative 'test_helper'
 
 describe GoogleSiteSearch do
 
-  describe '#.relative_path' do
+  describe '.paginate' do
+    it 'completes a valid url for the relative path supplied' do
+      GoogleSiteSearch.paginate("/some/path").must_equal "http://www.google.com/some/path"
+    end
+  end
 
+  describe '.relative_path' do
     it 'raises InvalidURLError if a nil is given' do
       -> {GoogleSiteSearch.relative_path(nil)}.must_raise URI::InvalidURIError
     end
 
     describe 'given a relative path' do
-
       it 'returns the path given' do
         GoogleSiteSearch.relative_path("/somepath").must_equal "/somepath" 
       end
@@ -17,21 +21,67 @@ describe GoogleSiteSearch do
     end 
 
     describe 'given an absolute url' do 
-
       it 'with just the domain a root path will be returned' do
         GoogleSiteSearch.relative_path("http://www.somesite.com/").must_equal "/" 
       end
 
       it 'with a domain and path given the path will be returned' do
         GoogleSiteSearch.relative_path("http://www.somesite.com/my-test").must_equal "/my-test" 
-
       end
 
       it 'with a query string the path and query will be returned' do
         GoogleSiteSearch.relative_path("http://www.somesite.com/my-test?something=value").must_equal "/my-test?something=value" 
+      end
+
+    end
+  end
+
+  describe '.separate_search_term_from_filters' do
+
+    it 'works on a valid search and filter' do
+      GoogleSiteSearch.separate_search_term_from_filters("microsoft more:pagemap:mytype").must_equal ["microsoft", "more:pagemap:mytype"]
+    end
+
+    it 'not fooled by an improper filter' do
+      GoogleSiteSearch.separate_search_term_from_filters("microsoft more:x:wrong").must_equal ["microsoft more:x:wrong", nil]
+    end
 
+    it 'strips whitespace' do
+      GoogleSiteSearch.separate_search_term_from_filters(" microsoft  more:p:my-value  ").must_equal ["microsoft", "more:p:my-value"]
+    end
+
+    it 'handles nil' do
+      GoogleSiteSearch.separate_search_term_from_filters(nil).must_equal [nil, nil]
+    end
+
+    it 'handles ""' do
+      GoogleSiteSearch.separate_search_term_from_filters("").must_equal ["", nil]
+    end
+  end
+
+  describe ".request_xml" do
+
+    it "passes back the body of a successfull HTTP request" do
+      mock = MiniTest::Mock.new.expect(:is_a?, true, [Net::HTTPSuccess])
+        .expect(:body, "my response")
+      Net::HTTP.stub(:get_response, mock) do
+       GoogleSiteSearch.request_xml("/doesnt_matter").must_equal "my response" 
       end
+    end
 
+    it "returns nil if not a Net::HTTPSuccess" do
+      mock = MiniTest::Mock.new.expect( :is_a?, false, [Net::HTTPSuccess])
+      Net::HTTP.stub(:get_response, mock) do
+       GoogleSiteSearch.request_xml("/doesnt_matter").must_be_nil
+      end
+    end
+
+    it "doesn't catch exceptions if they happen" do
+      mock = -> a {raise StandardError}
+      Net::HTTP.stub(:get_response, mock) do
+       -> {GoogleSiteSearch.request_xml("/doesnt_matter")}.must_raise StandardError 
+      end
     end
   end
+
 end

data/test/test_helper.rb

@@ -2,4 +2,5 @@ ENV['RACK_ENV'] = 'test'
 
 require "google-site-search"
 require "minitest/spec"
+require "minitest/mock"
 include GoogleSiteSearch #include module so I don't have to namespace everything

data/test/test_search.rb

@@ -2,6 +2,71 @@ require_relative 'test_helper'
 
 describe Search do
 
+  let :xml do
+    <<-xml
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<GSP VER="3.2">
+<TM>0.075037</TM><Q>rails</Q>
+<PARAM name="q" value="rails" original_value="rails" url_escaped_value="rails" js_escaped_value="rails"></PARAM><PARAM name="num" value="2" original_value="2" url_escaped_value="2" js_escaped_value="2"></PARAM><PARAM name="hl" value="en" original_value="en" url_escaped_value="en" js_escaped_value="en"></PARAM><PARAM name="client" value="google-csbe" original_value="google-csbe" url_escaped_value="google-csbe" js_escaped_value="google-csbe"></PARAM><PARAM name="cx" value="009797329687680929468:y_saholjpsk" original_value="009797329687680929468:y_saholjpsk" url_escaped_value="009797329687680929468%3Ay_saholjpsk" js_escaped_value="009797329687680929468:y_saholjpsk"></PARAM><PARAM name="boostcse" value="0" original_value="0" url_escaped_value="0" js_escaped_value="0"></PARAM><PARAM name="output" value="xml_no_dtd" original_value="xml_no_dtd" url_escaped_value="xml_no_dtd" js_escaped_value="xml_no_dtd"></PARAM><PARAM name="ie" value="UTF-8" original_value="UTF-8" url_escaped_value="UTF-8" js_escaped_value="UTF-8"></PARAM><PARAM name="oe" value="UTF-8" original_value="UTF-8" url_escaped_value="UTF-8" js_escaped_value="UTF-8"></PARAM><PARAM name="prmd" value="ivnslb" original_value="ivnslb" url_escaped_value="ivnslb" js_escaped_value="ivnslb"></PARAM><PARAM name="ei" value="PYSNUNWAKKea2AXH0YDYDA" original_value="PYSNUNWAKKea2AXH0YDYDA" url_escaped_value="PYSNUNWAKKea2AXH0YDYDA" js_escaped_value="PYSNUNWAKKea2AXH0YDYDA"></PARAM><PARAM name="start" value="2" original_value="2" url_escaped_value="2" js_escaped_value="2"></PARAM><PARAM name="sa" value="N" original_value="N" url_escaped_value="N" js_escaped_value="N"></PARAM><SEARCH_MODES><PROMOTED_MODES></PROMOTED_MODES><UNPROMOTED_MODES></UNPROMOTED_MODES><MORE_TEXT>More</MORE_TEXT><LESS_TEXT>Fewer</LESS_TEXT></SEARCH_MODES><Spelling><Suggestion q="fake suggestion escaped">fake suggestion not escaped</Suggestion></Spelling><Context><title>Info-Tech Research Group</title><Facet><FacetItem><label>test_refinement</label><anchor_text>Test Refinement</anchor_text></FacetItem></Facet></Context><RES SN="3" EN="4">
+it "contains the spelling suggestions" do
 
+end
+<M>29</M>
+<NB><PU>/previous</PU><NU>/next</NU></NB>
+<RG START="1" SIZE="2"></RG> <RG START="1" SIZE="1">    </RG> <R N="3"><U>http://www.infotech.com/research/web-app-dev-trade-in-j2ee-for-ruby-on-rails</U><UE>http://www.infotech.com/research/web-app-dev-trade-in-j2ee-for-ruby-on-rails</UE><T>Web App Dev: Trade in J2EE for Ruby on &lt;b&gt;Rails&lt;/b&gt; | Info-Tech Research &lt;b&gt;...&lt;/b&gt;</T><RK>0</RK><BYLINEDATE>1144738800</BYLINEDATE><S>11 Apr 2006 &lt;b&gt;...&lt;/b&gt; Ruby is gaining a lot of attention as more Web developers report shorter learning &lt;br&gt;  curves and development cycles using the language.</S><LANG>en</LANG><Label>_cse_y_saholjpsk</Label><PageMap><DataObject type="metatags"><Attribute name="viewport" value="width=device-width, initial-scale=1.0"/><Attribute name="csrf-param" value="authenticity_token"/><Attribute name="csrf-token" value="33G4AEWugnU0gp6lDmF/Ct527Yi16df7TR3qST8t52I="/><Attribute name="product" value="itap|"/><Attribute name="product_slug" value="web-app-dev-trade-in-j2ee-for-ruby-on-rails"/><Attribute name="publicationtype" value="note"/><Attribute name="lifecycle" value="MakeDecisions|Evaluate|"/><Attribute name="categories" value="|applications|application-web-development-maintenance|development|"/><Attribute name="publishdate" value="2006-04-11"/><Attribute name="authors" value="Curtis Gittens|"/><Attribute name="title" value="Web App Dev: Trade in J2EE for Ruby on Rails"/></DataObject></PageMap><HAS><L/><C SZ="40k" CID="6P9DT50RDYIJ"/><RT/></HAS></R>
+  <RG START="2" SIZE="1">    </RG> <R N="4"><U>http://hr.mcleanco.com/research/hr-craft-effective-performance-improvement-plans</U><UE>http://hr.mcleanco.com/research/hr-craft-effective-performance-improvement-plans</UE><T>Implement Performance Improvement Plans | McLean &amp;amp; Company</T><RK>0</RK><BYLINEDATE>1313996400</BYLINEDATE><S>22 Aug 2011 &lt;b&gt;...&lt;/b&gt; 1. Implement Performance Improvement Plans. Get employee performance on &lt;br&gt;  track before it rides off the &lt;b&gt;rails&lt;/b&gt;. McLean &amp;amp; Company. / 12. 00:00 &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_y_saholjpsk</Label><PageMap><DataObject type="publication"><Attribute name="type">solution-set</Attribute><Attribute name="type-title">Solution Set</Attribute><Attribute name="attachment-icons">http://static.infotech.com/images/css/icons/ppt_icon-14x14.png|http://static.infotech.com/images/css/icons/doc_icon-14x14.png</Attribute><Attribute name="product_type_bias">1</Attribute><Attribute name="product_families">hr</Attribute><Attribute name="slug">hr-craft-effective-performance-improvement-plans</Attribute><Attribute name="categories">talent-management|coaching-and-development</Attribute><Attribute name="publishdate">2011-05-26</Attribute><Attribute name="authors">Susanna Hunter</Attribute><Attribute name="title">Implement Performance Improvement Plans</Attribute><Attribute name="description">Managers dread implementing a Performance Improvement Plan (PIP) because they think it&#39;s a waste of time. However, in a recent McLean &amp; Company survey, 68% of employees who were placed on a PIP were still with the organization. When a manager...</Attribute><Attribute name="keywords">performance management|Development|difficult employee|performance review|discrimination|termination|Coaching|poor performance|employee performance|Performance Improvement Plan|PIP|performance improvement|Performance appraisal|corrective action|development plans|corrective discipline|progressive discipline|performance issue</Attribute></DataObject><DataObject type="metatags"><Attribute name="viewport" value="width=device-width, initial-scale=1.0"/><Attribute name="csrf-param" value="authenticity_token"/><Attribute name="csrf-token" value="9UbBckKIdrtN7Gn8ZFSuhOqvTcY/8JzUW34mXU4Cwiw="/><Attribute name="product" value="hr|"/><Attribute name="product_slug" value="hr-craft-effective-performance-improvement-plans"/><Attribute name="publicationtype" value="solution-set"/><Attribute name="categories" value="|talent-management|coaching-and-development|"/><Attribute name="publishdate" value="2011-05-26"/><Attribute name="authors" value="Susanna Hunter|"/><Attribute name="title" value="Implement Performance Improvement Plans"/></DataObject><DataObject type="cse_image"><Attribute name="src" value="http://static.infotech.com/images/MCO-Thumb-SB6.jpg"/></DataObject><DataObject type="cse_thumbnail"><Attribute name="width" value="280"/><Attribute name="height" value="160"/><Attribute name="src" value="http://t1.gstatic.com/images?q=tbn:ANd9GcSC2UdC2eeAKKC4nh_iWK8oiPjMI06QVKIKUgSwi3VbnlBEI4TmjiaG12IU"/></DataObject></PageMap><HAS><L/><C SZ="85k" CID="ffPBTuMTrTIJ"/><RT/></HAS></R>
+ <RHS_COLUMN><RG START="1" SIZE="0"></RG></RHS_COLUMN></RES>
+</GSP>
+xml
+
+  end
+
+  describe "#query" do
+    
+    let :search do
+      GoogleSiteSearch.stub(:request_xml, xml) do
+        Search.new("/sample", Result).query 
+      end
+    end
+
+    it "stores the original url given" do
+      search.url.must_equal "/sample"
+    end
+
+    it "has the two results from our xml example" do
+      search.results.count.must_equal 2
+    end
+
+    it "contains the estimated results total" do
+      search.estimated_results_total.must_equal "29"
+    end
+
+    it "contains the next results url" do
+      search.next_results_url.must_equal "/next"
+    end
+
+    it "contains the previous results url" do
+      search.previous_results_url.must_equal "/previous"
+    end
+
+    it "stores the original xml" do
+      search.xml.must_equal xml
+    end
+    
+    it "defaults to the Result class" do
+      search.result_class.must_equal Result
+    end
+
+    it "stores the original search query" do
+      search.search_query.must_equal "rails"
+    end
+
+    it "contains the spelling suggestion" do
+      search.spelling.must_equal "fake suggestion not escaped"
+    end
 
+    it "contains the spelling suggestion attribute q" do
+      search.spelling_q.must_equal "fake suggestion escaped"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-site-search
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &7621180 !ruby/object:Gem::Requirement
+  requirement: &16445280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7621180
+  version_requirements: *16445280
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &7620760 !ruby/object:Gem::Requirement
+  requirement: &16444860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7620760
+  version_requirements: *16444860
 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: