robhurring-gspot 0.2

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1
+	* went to a gemspec rather than rake task

data/README

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Rob Hurring
+
+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/examples/example.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby -rrubygems
+require '../lib/google_search'
+require 'pp'
+
+# Some example uses, this lib is still _very_ basic and will
+# have some rough edges, but i works for basic queries.
+
+# Searching the web
+
+cool_sites = GSpot::Search.web('cool', :max => 1)
+puts "I found #{cool_sites.count} cooool sites"
+puts '-'*30
+cool_sites.each do |cool_site|
+  puts "A cool site:"
+  puts "Title: " << cool_site.title
+  puts "URL: " << cool_site.url
+  puts "About: " << cool_site.content
+  puts
+end
+
+# Goin' Local
+
+local_resturaunts = GSpot::Search.local('resturaunts in new jersey', :max => 2)
+puts "I found #{local_resturaunts.count} local resturaunt(s)!"
+puts '-'*30
+local_resturaunts.each do |local_resturaunt|
+  puts "Resturaunt:"
+  puts local_resturaunt.title
+  puts 'Located At: ' << local_resturaunt.addressLines.join("\n")
+  puts 'Phone: ' << local_resturaunt.phoneNumbers.map{ |pn| pn['number'] }.join(", ")
+  puts
+end
+
+# Images Rawk!
+
+lolcats = GSpot::Search.images('site:icanhascheezburger.com filetype:jpg', :max => 10)
+puts "I CAN HAZ #{lolcats.count} LOLZ?"
+puts '-'*30
+lolcats.each do |lolcat|
+  puts "At " << lolcat.content << ' some kitteh did this'
+  puts 'Image: ' << lolcat.url
+  puts
+end
+
+# Videos!
+
+cool_explosion = GSpot::Search.videos('cool explosion', :max => 1).results.first
+puts "I have a cool explosion"
+puts '-'*30
+puts "Title: " << cool_explosion.title
+puts "Runtime: " << cool_explosion.duration << ' seconds.'
+puts "Publisher: " << cool_explosion.publisher
+puts "Published: " << cool_explosion.published
+puts "View!: " << cool_explosion.url
+puts

data/lib/gspot.rb

@@ -0,0 +1,125 @@
+# == About
+# 
+# Author:: Rob Hurring <rob@ubrio.us>
+# Website:: http://robhurring.com
+# 
+# This is s a stupid simple way to make managing crontabs easier
+# It allows you to write basic cron tasks in ruby and output the
+# complete crontab. I find it easier with setup tasks and repetitive
+# schedules and such. Really only meant as a simple cron mgt. script
+# 
+# == License
+#
+# Copyright (c) 2008 Rob Hurring
+# 
+# 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.
+require 'json'
+require 'open-uri'
+# GSpot is a simple ruby wrapper for Google's AJAX search API
+# It supports:
+#   * web searches
+#   * image searches
+#   * local searches
+#   * video searches
+# This is a very crude class and was made for a project of mine (which is why it isn't very refined
+# at the moment.) I do plan on polishing it up a bit when I get time, but this should do for now :)
+module GSpot
+  class BadEndpointError < StandardError; end
+  class InvalidVersionError < StandardError; end
+  # This guy does the actual searching... srsly.
+  # check out the examples.rb file for example usage
+  class Search
+    attr_reader :results, :estimatedResultCount, :moreResultsUrl, :pages, :viewport, :responseStatus
+    ENDPOINTS = {
+      :base   => %{http://ajax.googleapis.com/ajax/services/search},
+      :web    => %{/web},
+      :local  => %{/local},
+      :images => %{/images},
+      :videos => %{/video},
+      :news   => %{/news}
+    }
+    # options can be
+    #   * :version => API version you wish to use
+    #   * :max => max amount of results you wish to retrieve
+    def initialize(query, service, options = {})
+      @version = options[:version] || 1.0
+      @results = []
+      @query = URI.escape(query)
+      @service = service || :web
+      @max = options[:max] || 10
+      @responseStatus = nil
+      @viewport, @pages, @moreResultsUrl, @estimatedResultCount = nil
+    end
+    # calles Googles REST interface and gets back the JSON data
+    # Google by default sends +4+ results at a time, so if we request a :max > 4
+    # we simply loop and build a result set until we hit our :max, Google should
+    # also put a cap on the total results at around 32
+    def search
+      (@max.to_f / 4).ceil.times do |page|    
+        start = page * 4
+        endpoint = '%s%s?v=%s&q=%s&start=%d' % [ENDPOINTS[:base], ENDPOINTS[@service], @version, @query, start]
+        json = JSON.parse(open(endpoint).read)        
+        if json['responseData'] and not json['responseData']['results'].empty?
+          json['responseData']['results'].each do |data|
+            @results << SearchResult.new(data) unless @results.size >= @max
+          end
+          @estimatedResultCount ||= json['responseData']['cursor']['estimatedResultCount'].to_i
+          @moreResultsUrl ||= json['responseData']['cursor']['moreResultsUrl']
+          @pages ||= json['responseData']['cursor']['pages']
+          @viewport ||= json['responseData']['cursor']['viewport']
+        else
+          raise InvalidVersionError('Invalid Version') if json['responseDetails'] == 'invalid version'
+        end
+        @responseStatus = json['responseStatus']
+      end
+      self
+    end
+    def count
+      @results.size
+    end
+    def each
+      @results.each { |result| yield(result) }
+    end
+    class << self
+      # overloading for endpoints, calling
+      # GSpot::Search.web('what') will do a web search, apply the same to images, video & local
+      def method_missing(sym, *args)
+        valid_endpoints = ENDPOINTS.keys.select{ |e| e != :base }
+        raise(BadEndpointError, %{The endpoint you requested is invalid. "#{sym}" Available endpoints are: #{valid_endpoints}}) unless valid_endpoints.include?(sym)
+        Search.new(args[0], sym, args[1] || {}).search
+      end
+    end
+  end
+  # A generic search result object used to transform JSON into a ruby object
+  # all methods correspond to those of the JSON's ['responseData']['results'] data
+  # for more on what is available just +pp+ them out, or check Google for the JSON
+  # response variables, they should all be tucked in there
+  class SearchResult
+    def initialize(data = {})
+      data.each do |key, value|
+        value.gsub!(/<\/?[^>]*>/, "") if value.respond_to?(:gsub)
+        instance_variable_set "@#{key}", value
+        instance_eval %{ def #{key}; @#{key}; end }  
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: robhurring-gspot
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Rob Hurring
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rob@zerobased.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- CHANGELOG
+- lib/gspot.rb
+- examples/example.rb
+has_rdoc: true
+homepage: http://github.com/robhurring/gspot
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: gspot
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Google AJAX search implemented in ruby
+test_files: []
+