simple_google_custom_search 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_google_custom_search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cher Wei Soh
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# SimpleGoogleCustomSearch
+
+With Simple Google Custom Search, help people search what they need in your website just like in official google site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_google_custom_search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_google_custom_search
+
+## Configuration
+
+You need to define a <tt>constant variable</tt> for the API to search the matching words to your domain:
+
+    SGCS_CONFIG = {
+        domain: 'YOUR_SITE_URL'
+    }
+
+## Usage
+
+To perform a search:
+
+    results = SimpleGoogleCustomSearch.search("simple", offset +optional+)
+
+The +results+ variable is now a SimpleGoogleCustomSearch::ResultSet object:
+
+    results.total            # number of results (integer)
+    results.item             # array of result objects (SimpleGoogleCustomSearch::Result)
+
+Iterate through the results:
+
+    results.item.each do |result|
+        result.title           # result title
+        result.link            # result URL
+        result.description     # excerpt, with terms highlighted
+    end
+
+## TODO
+
+1. Unit Test
+2. Add Pagination
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_google_custom_search.rb

@@ -0,0 +1,54 @@
+require "simple_google_custom_search/version"
+require 'timeout'
+require 'open-uri'
+require 'cgi'
+require 'hpricot'
+
+module SimpleGoogleCustomSearch
+  autoload :ResultSet, 'simple_google_custom_search/result_set'
+  autoload :Result, 'simple_google_custom_search/result'
+  autoload :SgcsConfig, 'simple_google_custom_search/sgcs_config'
+  extend self
+  
+  def search(query, offset=0)
+    config = SimpleGoogleCustomSearch::SgcsConfig.new
+    site = config.domain + ' -"tagged with" -"posts by date" -page'
+    uri = url(site, CGI.escape(query), offset)
+    return nil unless resp = fetch(uri)
+    
+    if resp.status.first == '200'
+      parse(resp)
+    else
+      nil
+    end
+  end
+  
+  private
+  def url(site, query, offset)
+    "http://www.google.com/search?q=#{URI.escape('site:'+site+' '+query+'&start='+offset.to_s)}"
+  end
+  
+  def fetch(uri)
+    begin
+      resp = nil
+      Timeout::timeout(3) do
+        resp = open(uri)
+      end
+    rescue Timeout::Error; end
+    resp
+  end
+  
+  def parse(resp)
+    parsed = Hpricot(resp.read.encode("UTF-8"))
+    number_of_results = (parsed/'div#resultStats').first.inner_text.to_s[/(\S*) result/i, 1].try(:gsub, ',', '').try(:to_i) || 0  
+    result_set = SimpleGoogleCustomSearch::ResultSet.new(total: number_of_results)
+    result_set.item = (parsed/"li.g").map do |ele|
+      SimpleGoogleCustomSearch::Result.new({
+        :title => ele.at("a").inner_text,
+        :link => "http://www.google.com#{ele.at("a")['href']}",
+        :description => (ele/("span.st")).to_s
+      })
+    end
+    result_set
+  end
+end

data/lib/simple_google_custom_search/result.rb

@@ -0,0 +1,9 @@
+class SimpleGoogleCustomSearch::Result
+  attr_accessor :title, :link, :description
+  
+  def initialize(attrs={})
+    @title = attrs[:title] || ''
+    @link = attrs[:link] || ''
+    @description = attrs[:description] || ''
+  end
+end

data/lib/simple_google_custom_search/result_set.rb

@@ -0,0 +1,15 @@
+class SimpleGoogleCustomSearch::ResultSet
+  attr_accessor :total, :item
+  
+  def initialize(attrs={})
+    @total = attrs[:total] || 0
+    @item = attrs[:item] || []
+  end
+  
+  def self.create_empty
+    self.new({
+      total: 0,
+      item: []
+    })
+  end
+end

data/lib/simple_google_custom_search/sgcs_config.rb

@@ -0,0 +1,17 @@
+class SimpleGoogleCustomSearch::SgcsConfig
+  attr_reader :domain
+
+  def initialize
+    raise 'Please set constant variable SGCS_CONFIG' unless defined?(SGCS_CONFIG)
+    config = SGCS_CONFIG.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    raise 'Please set constant variable SGCS_CONFIG[:domain]' if config[:domain].nil?
+    
+    @domain = config[:domain]
+  end
+
+  def get_config
+    @config ||= {
+      domain: @domain
+    }
+  end
+end

data/lib/simple_google_custom_search/version.rb

@@ -0,0 +1,3 @@
+module SimpleGoogleCustomSearch
+  VERSION = "0.0.1"
+end

data/simple_google_custom_search.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_google_custom_search/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_google_custom_search"
+  gem.version       = SimpleGoogleCustomSearch::VERSION
+  gem.authors       = ["Cher Wei Soh"]
+  gem.email         = ["cherwei.soh@gmail.com"]
+  gem.description   = %q{With Simple Google Custom Search, add a search box to your homepage to help people find what they need on your website}
+  gem.summary       = %q{Simple Google Query Search API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "hpricot"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: simple_google_custom_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cher Wei Soh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: With Simple Google Custom Search, add a search box to your homepage to
+  help people find what they need on your website
+email:
+- cherwei.soh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_google_custom_search.rb
+- lib/simple_google_custom_search/result.rb
+- lib/simple_google_custom_search/result_set.rb
+- lib/simple_google_custom_search/sgcs_config.rb
+- lib/simple_google_custom_search/version.rb
+- simple_google_custom_search.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple Google Query Search API
+test_files: []