google_custom_search 0.3.0 → 0.3.1

data/.gitignore

@@ -1,5 +1,4 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg
+pkg/*
+rdoc/*
+*.gem
+.bundle

data/CHANGELOG.rdoc

@@ -1,8 +1,11 @@
 = Changelog
 
-Per-release changes to Handler.
+Per-release changes to google_custom_search.
 
+== 0.3.1 (2011 May 12)
 
-== 0.8.0 (2009 Oct 12)
+* 
 
-First release.
+== 0.3.0 (2009 Oct 14)
+
+* First release.

data/README.rdoc

@@ -1,6 +1,10 @@
 = Google Custom Search
 
-Ruby API to Google Custom Search Engine (http://www.google.com/cse). Works with the paid version of CSE where you get results in XML format.
+This project is a Ruby API to Google's Custom Search Engine (http://www.google.com/cse).
+
+If you want a Google-like search engine for your web site, why not use Google? For $100/yr (more if you have over 1,000 pages) you can get access to Google search results for your site in XML format. The google_custom_search gem helps you access this web service and publish the results on your site however you like (all covered under Google's acceptable use policy).
+
+<b>Google Custom Search is currently compatible with Rails 2.x and Rails 3.</b>
 
 
 == 1. Install
@@ -30,6 +34,13 @@ You *must* define a constant in your application called <tt>GOOGLE_SEARCH_CX</tt
 
 You can find the CX value for your custom search engine via the search control panel on Google's site (click the "Get code" link and you'll see a hidden "cx" field in the sample HTML form).
 
+Optionally, you can set default Google search params, such as encoding, by setting up the <tt>GOOGLE_SEARCH_PARAMS</tt> hash in the same initializer:
+
+  GOOGLE_SEARCH_PARAMS = {
+    :ie => 'utf8',
+    :oe => 'utf8'
+  }
+
 If you're working outside of Rails you'll also need some +require+ statements:
 
   require 'rubygems'
@@ -45,21 +56,22 @@ To perform a search:
   
 The +results+ variable is now a GoogleCustomSearch::ResultSet object:
   
-  results.total       # 5080
-  results.pages       # array of GoogleCustomSearch::Result objects
-  results.suggestion  # string with suggested search term, if any
+  results.total            # number of results (integer)
+  results.pages            # array of result objects
+  results.suggestion       # suggested search term, if any
 
 Iterate through the results:
 
-  results.pages.each do |r|
-    r.title           # page title
-    r.url             # page URL
-    r.description     # Google's excerpt, with terms highlighted
+  results.pages.each do |result|
+    result.title           # result title
+    result.url             # result URL
+    result.description     # excerpt, with terms highlighted
   end
 
 
 == Future
 
+* prevent NameError when GOOGLE_SEARCH_CX is missing: show nice msg
 * access to all data returned by Google
 * support for features of CSE free version
 * support for multiple CSEs in one app (GOOGLE_SEARCH_CX should be a hash)

data/Rakefile

@@ -1,21 +1,5 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name        = "google_custom_search"
-    gem.summary     = %Q{Ruby API to Google Custom Search Engine.}
-    gem.description = %Q{Ruby API to Google Custom Search Engine. Works with the paid version of CSE where you get results in XML format.}
-    gem.email       = "alex@alexreisner.com"
-    gem.homepage    = "http://github.com/alexreisner/google_custom_search"
-    gem.authors     = ["Alex Reisner"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -24,33 +8,12 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
 task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "Google Custom Search #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.title = "Google Custom Search #{GoogleCustomSearch::VERSION}"
+  rdoc.rdoc_files.include('*.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/google_custom_search.rb

@@ -3,6 +3,7 @@
 # http://www.google.com/coop/docs/cse/resultsxml.html
 #
 module GoogleCustomSearch
+  extend self
   
   ##
   # Quick Struct-based class to hold a collection of search result data.
@@ -17,7 +18,7 @@ module GoogleCustomSearch
   ##
   # Search the site.
   #
-  def self.search(query, offset = 0, length = 20)
+  def search(query, offset = 0, length = 20)
     
     # Get and parse results.
     url = url(query, offset, length)
@@ -42,7 +43,7 @@ module GoogleCustomSearch
   ##
   # Build search request URL.
   #
-  def self.url(query, offset = 0, length = 20)
+  def url(query, offset = 0, length = 20)
     params = {
       :q      => query,
       :start  => offset,
@@ -51,13 +52,17 @@ module GoogleCustomSearch
       :output => "xml_no_dtd",
       :cx     => GOOGLE_SEARCH_CX
     }
+    begin
+      params.merge!(GOOGLE_SEARCH_PARAMS)
+    rescue NameError
+    end
     "http://www.google.com/search?" + params.to_query
   end
   
   ##
   # Query Google, and make sure it responds.
   #
-  def self.fetch_xml(url)
+  def fetch_xml(url)
     begin
       resp = nil
       timeout(3) do
@@ -71,14 +76,14 @@ module GoogleCustomSearch
   # Transform an array of Google search results (XML parsed by REXML) into
   # a more useful format.
   #
-  def self.parse_results(results)
+  def parse_results(results)
     out = []
     results = [results] if results.is_a?(Hash) # no array if only one result
     results.each do |r|
       out << Result.new(
-        r['U'],                         # url
-        r['T'].sub(/ \[[^\]]*\]$/, ''), # title
-        r['S'].gsub('<br>', '')         # desciption
+        r['U'],                               # url
+        r['T'].try(:sub, / \[[^\]]*\]$/, ''), # title
+        r['S'].try(:gsub, '<br>', '')         # desciption
       )
     end
     out

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: google_custom_search
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors: 
 - Alex Reisner
@@ -9,19 +10,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-14 00:00:00 -04:00
+date: 2011-05-12 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Ruby API to Google Custom Search Engine. Works with the paid version of CSE where you get results in XML format.
-email: alex@alexreisner.com
+description: Ruby interface to Google Custom Search Engine. Works with the paid version of CSE where you get results in XML format.
+email: 
+- alex@alexreisner.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .gitignore
 - CHANGELOG.rdoc
@@ -29,8 +30,6 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- google_custom_search.gemspec
-- init.rb
 - lib/google_custom_search.rb
 - test/google_custom_search_test.rb
 - test/test_helper.rb
@@ -39,29 +38,28 @@ homepage: http://github.com/alexreisner/google_custom_search
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
-summary: Ruby API to Google Custom Search Engine.
-test_files: 
-- test/google_custom_search_test.rb
-- test/test_helper.rb
+summary: Ruby interface to Google Custom Search Engine.
+test_files: []
+

data/google_custom_search.gemspec

@@ -1,51 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{google_custom_search}
-  s.version = "0.3.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alex Reisner"]
-  s.date = %q{2009-10-14}
-  s.description = %q{Ruby API to Google Custom Search Engine. Works with the paid version of CSE where you get results in XML format.}
-  s.email = %q{alex@alexreisner.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "CHANGELOG.rdoc",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "google_custom_search.gemspec",
-     "init.rb",
-     "lib/google_custom_search.rb",
-     "test/google_custom_search_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/alexreisner/google_custom_search}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Ruby API to Google Custom Search Engine.}
-  s.test_files = [
-    "test/google_custom_search_test.rb",
-     "test/test_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end

data/init.rb

@@ -1 +0,0 @@
-require 'google_custom_search'