mlangenberg-googlesearch 0.0.1

data/googlesearch.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'googlesearch'
+  s.version = '0.0.1'
+  s.date = '2009-01-07'
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = false
+  s.summary = 'Google CSE implementation'
+  s.description = 'Abstraction of the Google CSE XML API'
+  s.authors = ["Rene Heino", "Matthijs Langenberg"]
+  s.email = 'rails@newminds.nl'
+  s.files = [ "googlesearch.gemspec", 
+              "lib/googlesearch.rb",
+              "lib/googlesearch/search_response.rb",
+              "lib/googlesearch/search_result.rb"]
+  s.test_files = ["spec/google_search_spec.rb",
+                  "spec/search_response_spec.rb",
+                  "spec/spec_helper.rb",
+                  "spec/result_example.xml"]
+  s.add_dependency("nokogiri", ["> 0.0.0"])
+end
+
+
+  

data/lib/googlesearch.rb

@@ -0,0 +1,18 @@
+require 'googlesearch/search_response'
+require 'googlesearch/search_result'
+require 'open-uri'
+
+class GoogleSearch
+  
+  attr_reader :response
+  
+  def initialize(options, search_request = SearchRequest.new)
+    @response = SearchResponse.new search_request.get("http://www.google.com/search?&q=#{options[:q]}&client=google-csbe&output=xml&cx=#{options[:cx]}")
+  end
+end
+
+class SearchRequest
+  def get(uri)
+    open(uri)
+  end
+end

data/lib/googlesearch/search_response.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+class SearchResponse
+  def initialize(xml)
+    doc = Nokogiri::XML(xml)
+    @tm = doc.root.xpath('TM').text.to_f 
+    @m = doc.root.xpath('RES/M').text.to_i
+    @results = []
+    doc.root.xpath('RES//R').each do |res_doc|
+      @results << SearchResult.new(res_doc)
+    end
+  end
+  
+  def total_server_time
+    @tm
+  end
+  
+  def total_number_of_results
+    @m
+  end
+  
+  def results
+    @results
+  end
+end

data/lib/googlesearch/search_result.rb

@@ -0,0 +1,9 @@
+class SearchResult
+  attr_reader :url, :index, :title, :excerpt
+  def initialize(doc)
+    @url = doc.xpath('U').text
+    @index = doc.attributes["N"].to_i
+    @title = doc.xpath('T').text
+    @excerpt = doc.xpath('S').text
+  end
+end

data/spec/google_search_spec.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe GoogleSearch do
+  it do
+    request_mock = mock('request')
+    request_mock.should_receive(:get).with(
+      'http://www.google.com/search?&q=adres&client=google-csbe&output=xml&cx=unique-cse-id'
+    ).and_return('wat_xml')
+    
+    SearchResponse.should_receive(:new).with('wat_xml').and_return('search-response-object')
+    search = GoogleSearch.new({:cx => 'unique-cse-id', :q => 'adres'}, request_mock)
+    search.response.should == 'search-response-object'
+  end
+end

data/spec/result_example.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE GSP SYSTEM "google.dtd">
+<GSP VER="3.2">
+<TM>0.458025</TM><Q>intercodam</Q>
+<PARAM name="q" value="intercodam" original_value="intercodam"/>
+<PARAM name="client" value="google-csbe" original_value="google-csbe"/>
+<PARAM name="output" value="xml" original_value="xml"/>
+<PARAM name="cx" value="unique-cse-id" original_value="unique-cse-id"/>
+<Context><title>Shopr</title></Context><RES SN="1" EN="5">
+<M>5</M>
+<FI/><XT/>
+<R N="1"><U>http://i3.shop-r.nl/language/nl/pages/39</U><UE>http://i3.shop-r.nl/language/nl/pages/39</UE><T>&lt;b&gt;Intercodam&lt;/b&gt; Tegels B.V.</T><RK>0</RK><S>&lt;b&gt;Intercodam&lt;/b&gt; B.V.. Amstel 135 (vlak naast theater Carre) 1018 EN Amsterdam &lt;b&gt;...&lt;/b&gt; &lt;br&gt;  &lt;b&gt;Intercodam&lt;/b&gt; Tegels B.V. 2008. Aenean eget mi. Fusce mattis est id diam. &lt;b&gt;...&lt;/b&gt;</S><LANG>nl</LANG><Label>_cse_4a4weggqfu8</Label><HAS><L/><C SZ="7k" CID="sleD4FLqURwJ"/><RT/></HAS></R>
+
+<R N="2"><U>http://i3.shop-r.nl/language/nl/</U><UE>http://i3.shop-r.nl/language/nl/</UE><T>&lt;b&gt;Intercodam&lt;/b&gt; Tegels B.V.</T><RK>0</RK><S>&lt;b&gt;Intercodam&lt;/b&gt; Tegels B.V. 2008. Aenean eget mi. Fusce mattis est id diam. Phasellus &lt;br&gt;  faucibus interdum sapien. Duis quis nunc. Sed enim.</S><LANG>nl</LANG><Label>_cse_4a4weggqfu8</Label><HAS><L/><C SZ="6k" CID="zvDK6Ic-qNMJ"/><RT/></HAS></R>
+
+<R N="3"><U>http://i3.shop-r.nl/language/nl/pages/41</U><UE>http://i3.shop-r.nl/language/nl/pages/41</UE><T>&lt;b&gt;Intercodam&lt;/b&gt; Tegels B.V.</T><RK>0</RK><S>De &amp;#39;NV &lt;b&gt;Intercodam&lt;/b&gt;&amp;#39; is opgericht op 16 september 1919 en handelde in de meest &lt;br&gt;  uiteenlopende producten. In 1972 werd deze NV omgezet in een Beheer B.V. &lt;b&gt;...&lt;/b&gt;</S><LANG>nl</LANG><Label>_cse_4a4weggqfu8</Label><HAS><L/><C SZ="6k" CID="7FB2NBtfU-UJ"/><RT/></HAS></R>
+
+<R N="4" MIME="application/pdf"><U>http://i3.shop-r.nl/shops/i3.shop-r.nl/assets/REFIN%20ARDENNES.pdf</U><UE>http://i3.shop-r.nl/shops/i3.shop-r.nl/assets/REFIN%2520ARDENNES.pdf</UE><T>refin - ardennes</T><RK>0</RK><S>&lt;b&gt;INTERCODAM&lt;/b&gt;. refin - ardennes. maart 2008. &lt;b&gt;Intercodam&lt;/b&gt; Tegels BV. Amstel 135 (&lt;br&gt;  naast theater Carré). 1018 EN Amsterdam. tel 020-6225115. fax 020-6243354 &lt;b&gt;...&lt;/b&gt;</S><LANG>nl</LANG><Label>_cse_4a4weggqfu8</Label><HAS><L/><C SZ="" CID="3gRs0rPYzpYJ"/><RT/></HAS></R>
+
+<R N="5" MIME="application/pdf"><U>http://i3.shop-r.nl/shops/i3.shop-r.nl/assets/CAESAR%20MORE.pdf</U><UE>http://i3.shop-r.nl/shops/i3.shop-r.nl/assets/CAESAR%2520MORE.pdf</UE><T>caesar - more</T><RK>0</RK><S>&lt;b&gt;INTERCODAM&lt;/b&gt;. caesar - more. maart 2008. &lt;b&gt;Intercodam&lt;/b&gt; Tegels BV. Amstel 135 (naast &lt;br&gt;  theater Carré). 1018 EN Amsterdam. tel 020-6225115. fax 020-6243354 &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_4a4weggqfu8</Label><HAS><L/><C SZ="" CID="jzBwnKAFGckJ"/><RT/></HAS></R>
+
+</RES>
+</GSP>

data/spec/search_response_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe SearchResponse do
+  
+  setup do 
+    example_xml = File.read(File.join(File.dirname(__FILE__), 'result_example.xml'))
+    @response = SearchResponse.new(example_xml)
+  end
+  
+  it "shoud be able to return total server time in seconds" do
+    @response.total_server_time.should == 0.458025
+  end
+  
+  it "should be able to return total number of results" do
+    @response.total_number_of_results.should == 5
+  end
+  
+  it "should be able to return the first URL of the results" do
+    @response.results.first.url.should == 'http://i3.shop-r.nl/language/nl/pages/39'
+  end
+  
+  it "should be able to return the second index of the results" do
+    @response.results[1].index.should == 2
+  end
+  
+  it "should be able to return the last title of the results" do
+    @response.results.last.title.should == 'caesar - more'
+  end
+  
+  it "should be able to return the third text of the results" do
+    @response.results[2].excerpt.should == %[De &#39;NV <b>Intercodam</b>&#39; is opgericht op 16 september 1919 en handelde in de meest <br>  uiteenlopende producten. In 1972 werd deze NV omgezet in een Beheer B.V. <b>...</b>]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'googlesearch'

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: mlangenberg-googlesearch
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rene Heino
+- Matthijs Langenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Abstraction of the Google CSE XML API
+email: rails@newminds.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- googlesearch.gemspec
+- lib/googlesearch.rb
+- lib/googlesearch/search_response.rb
+- lib/googlesearch/search_result.rb
+has_rdoc: false
+homepage: 
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Google CSE implementation
+test_files: 
+- spec/google_search_spec.rb
+- spec/search_response_spec.rb
+- spec/spec_helper.rb
+- spec/result_example.xml