google_search 1.0.0 → 1.1.0

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+tmp
 
 ## PROJECT::SPECIFIC

data/README.rdoc

@@ -16,6 +16,24 @@ You can also search videos, images, books etc. by calling <tt>GoogleSearch.[SEAR
 
 For documention on options and response formats see http://code.google.com/intl/hr/apis/ajaxsearch/documentation/reference.html#_intro_fonje
 
+=== Default options
+
+You may specify default options that go into every request. Usually you'll put your API key here.
+
+  GoogleSearch.default_options = { :key => "my-key", :hl => "hr" }
+
+=== Paginated search
+
+  GoogleSearch.with_pages(1..5) do |search|
+    search.images(:q => "moon") 
+  end
+
+This will do search 5 times, each time given a different page (1..5). Useful for getting more results at once.
+
+=== Handling errors
+
+On invalid response a GoogleSearchError is raised, describing the error.
+
 == Copyright
 
 Copyright (c) 2010 Sasa Brankovic. See LICENSE for details.

data/Rakefile

@@ -12,7 +12,6 @@ begin
     gem.authors = ["Sasa Brankovic"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_dependency "activesupport"
-    gem.add_dependency "addressable"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/google_search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_search}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sasa Brankovic"]
-  s.date = %q{2010-02-02}
+  s.date = %q{2010-02-03}
   s.email = %q{sasa@hakeraj.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,6 +24,9 @@ Gem::Specification.new do |s|
      "VERSION",
      "google_search.gemspec",
      "lib/google_search.rb",
+     "lib/google_search/google_search.rb",
+     "lib/google_search/google_search_error.rb",
+     "spec/google_search_paginated_spec.rb",
      "spec/google_search_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -35,6 +38,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Tiny wrapper for Google Search API}
   s.test_files = [
     "spec/google_search_spec.rb",
+     "spec/google_search_paginated_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -45,16 +49,13 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<addressable>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<addressable>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<addressable>, [">= 0"])
   end
 end
 

data/lib/google_search.rb

@@ -1,24 +1,6 @@
-require 'active_support'
 require 'open-uri'
-require 'addressable/uri'
-
-module GoogleSearch
-  @@default_options = {}
-  
-  def self.default_options(options = {})
-    @@default_options = options
-  end
-
-  def self.method_missing(method, args)
-    raise unless [:web, :local, :video, :blogs, :news, :books, :images, :patent].include?(method)
-    self.query(method, args)
-  end
+require 'active_support'
+require 'cgi'
 
-  private
-    def self.query(type, options)
-      uri = Addressable::URI.parse("http://ajax.googleapis.com/ajax/services/search/#{type}")
-      options[:v] = "1.0"
-      uri.query_values = @@default_options.merge(options)
-      ActiveSupport::JSON.decode(open(uri).read)
-    end
-end
+require 'google_search/google_search'
+require 'google_search/google_search_error'

data/lib/google_search/google_search.rb

@@ -0,0 +1,59 @@
+class GoogleSearch
+  ##
+  # :singleton-method:
+  # Sets up default options that should be present in every request
+  cattr_accessor :default_options
+ 
+  ##
+  # :singleton-method: web(options)
+  
+  ## 
+  # :singleton-method: video(options)
+  
+  ##
+  # :singleton-method: blogs(options)
+
+  ##
+  # :singleton-method: news(options)
+
+  ##
+  # :singleton-method: books(options)
+
+  ##
+  # :singleton-method: images(options)
+
+  ##
+  # :singleton-method: patent(options)
+
+  def self.method_missing(method, args) # :nodoc:
+    raise "Unknown search type '#{method}'" unless self.supported_search_types.include?(method)
+    self.query(method, args)
+  end
+
+  # Yields the search object for number +pages+ specified.
+  # Each page will contain 8 results, +pages+ must be something enumerable
+  def self.with_pages(pages)
+    pages.each do |page|
+      GoogleSearch.with_options :rsz => "large", :start => (page - 1) * 8 do |search|
+        yield search
+      end
+    end
+  end
+
+  private
+    def self.supported_search_types
+      [:web, :local, :video, :blogs, :news, :books, :images, :patent]
+    end
+      
+    def self.query(type, options)
+      options = (self.default_options || {}).merge(options)
+      options[:v] = "1.0"
+      
+      query_string = options.collect { |key, value| "#{key}=#{CGI::escape(value.to_s)}" }.join("&")
+      uri = "http://ajax.googleapis.com/ajax/services/search/#{type}?#{query_string}"
+     
+      result = ActiveSupport::JSON.decode(open(uri).read)
+      raise GoogleSearchError, "#{result['responseStatus']} - #{result['responseDetails']}" unless result["responseStatus"] == 200
+      result
+    end
+end

data/lib/google_search/google_search_error.rb

@@ -0,0 +1,2 @@
+class GoogleSearchError < RuntimeError
+end

data/spec/google_search_paginated_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Doing a paginated search" do
+  context "Searching 3 pages" do
+    before do
+      @results = []
+      GoogleSearch.with_pages(1..3) do |search|
+        @results << search.images(:q => "moon")
+      end
+    end
+
+    it "page should be called 3 times" do
+      @results.size.should == 3
+    end
+
+    it "each page results should originate from its page" do
+      page = 0
+
+      puts @results.each do 
+        |result| 
+        page.should == result["responseData"]["cursor"]["currentPageIndex"].to_i
+        page += 1
+      end
+    end
+  end
+
+end

data/spec/google_search_spec.rb

@@ -1,22 +1,32 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "Google search" do
-  context "Doing a query" do
-    require 'google_search'
-
+  context "Doing a valid query" do
     before :all do
-      GoogleSearch.default_options :hl => "hr"
-      @result = GoogleSearch.web :q => "Michael Jackson"
+      GoogleSearch.default_options = { :hl => "hr" }
+      @result = GoogleSearch.web :q => "Michael Jackson", :start => 10
     end
 
-    it do
+    it "result should be a hash" do
       @result.should be_a_kind_of Hash
     end
 
-    it "should have expected values" do
-      @result.should have_key "responseData"
-      @result["responseData"].should have_key "results"
+    it "should be have status OK" do
+      @result["responseStatus"].should == 200
+    end
+
+    it "should have results" do
       @result["responseData"]["results"].should_not be_empty
     end
   end
+
+  context "Doing an invalid query" do
+    before :all do
+      @query = lambda {  GoogleSearch.web :this_wont_work => true }
+    end
+
+    it "should raise an exception" do
+      @query.should raise_error GoogleSearchError
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,32 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'google_search'
 require 'spec'
 require 'spec/autorun'
 
 Spec::Runner.configure do |config|
+  config.before :all do
+    # The open method, used by GoogleSearch, will get cached so we 
+    # don't bombard Google each time we do testing. Cache is stored 
+    # in tmp/cached_open.
+    GoogleSearch.should_receive(:open).any_number_of_times.and_return { |url| cached_open(url) }
+  end
+end
+
+require 'digest/md5' 
+require 'fileutils'
+
+def cached_open(url) 
+  dir = "tmp/cached_open" 
+  FileUtils::mkdir_p(dir) unless File.exists?(dir)
+  
+  path = File.join(dir, Digest::MD5.hexdigest(url))
+  
+  unless File.exists?(path) 
+    content = open(url).read
+    File.open(path, "w") { |f| f.puts(content) } 
+  end
   
+  open(path)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: google_search
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sasa Brankovic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 +01:00
+date: 2010-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,16 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: addressable
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 description: 
 email: sasa@hakeraj.com
 executables: []
@@ -60,6 +50,9 @@ files:
 - VERSION
 - google_search.gemspec
 - lib/google_search.rb
+- lib/google_search/google_search.rb
+- lib/google_search/google_search_error.rb
+- spec/google_search_paginated_spec.rb
 - spec/google_search_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -93,4 +86,5 @@ specification_version: 3
 summary: Tiny wrapper for Google Search API
 test_files: 
 - spec/google_search_spec.rb
+- spec/google_search_paginated_spec.rb
 - spec/spec_helper.rb