jumzies-google-mini 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+sample.rb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jimmy Baker
+
+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.rdoc

@@ -0,0 +1,56 @@
+= google-mini
+
+* http://github.com/jumzies/google-mini
+
+== DESCRIPTION:
+
+The Google Mini gem simply lets you query your Google Mini appliance with the ease you'd expect from a Ruby library.
+
+== FEATURES/PROBLEMS:
+
+* Search Results
+* Suggestions
+* Synonyms
+
+== SYNOPSIS:
+
+  require 'google-mini'
+  GoogleMini.search_url = "http://your_google_mini/search?output=xml_no_dtd&client=clientName&site=collectionName&num=100"
+  search = GoogleMini.search('some search term')
+  puts search.results.length
+  puts search.suggestions.length
+  puts search.synonyms.length
+  puts search.keymatches.length
+
+== REQUIREMENTS:
+
+* httparty (http://railstips.org/2008/7/29/it-s-an-httparty-and-everyone-is-invited)
+
+== INSTALL:
+
+  sudo gem install google-mini --source=gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jimmy Baker
+
+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/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "google-mini"
+    gem.summary = %Q{The Google Mini gem simply lets you query your Google Mini appliance with the ease you'd expect from a Ruby library.}
+    gem.email = "jimmybaker@me.com"
+    gem.homepage = "http://github.com/jumzies/google-mini"
+    gem.authors = ["Jimmy Baker"]
+    gem.add_dependency 'httparty'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "google-mini #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/google-mini/google-mini.rb

@@ -0,0 +1,20 @@
+module GoogleMini
+  
+  
+  class << self
+    attr_accessor :search_url
+    
+    def search(query, options={})
+      raise Exception.new("You must define a search url.") if @search_url.blank?
+      url = @search_url + "&q=#{url_escape(query)}"
+      Search.new(url, options)
+    end
+    
+    def url_escape(string)
+      string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+        '%' + $1.unpack('H2' * $1.size).join('%').upcase
+      end.tr(' ', '+')
+    end
+  end
+  
+end

data/lib/google-mini/keymatch.rb

@@ -0,0 +1,8 @@
+class Keymatch
+  attr_reader :title, :url
+  
+  def initialize(options)
+    @title = options['GD']
+    @url = options['GL']
+  end
+end

data/lib/google-mini/result.rb

@@ -0,0 +1,13 @@
+class Result
+  
+  attr_reader :number, :title, :url, :description, :size
+  
+  def initialize(options)
+    @number = options['N']
+    @title = options['T']
+    @url = options['U']
+    @description = options['S']
+    @size = options['HAS']['C']
+  end
+  
+end

data/lib/google-mini/search.rb

@@ -0,0 +1,55 @@
+class Search
+  include HTTParty
+  attr_reader :results, :suggestions, :synonyms, :keymatches
+  
+  # takes a response hash from a google mini query
+  def initialize(url, options)
+    @results = []
+    @suggestions = []
+    @synonyms = []
+    @keymatches = []
+    
+    # ask the google mini for search results
+    response = Search.get(url)
+    
+    # results
+    if response['GSP'].has_key?('RES')
+      if response['GSP']['RES']['R'].kind_of?(Array)
+        response['GSP']['RES']['R'].map{ |res| @results << Result.new(res) }
+      else
+        @results << Result.new(response['GSP']['RES']['R'])
+      end
+    end
+    
+    # suggestions
+    if response['GSP'].has_key?('Spelling')
+      if response['GSP']['Spelling'].kind_of?(Array)
+        response['GSP']['Spelling'].map{ |sp| sp.map{ |k, v| @suggestions << v } }
+      else
+        response['GSP']['Spelling'].map{ |k,v| @suggestions << v }
+      end
+    end
+    
+    # synonyms
+    if response['GSP'].has_key?('Synonyms')
+      if response['GSP']['Synonyms'].kind_of?(Array)
+        response['GSP']['Synonyms'].map{ |syn| syn.map{ |k, v| @synonyms << v } }
+      else
+        response['GSP']['Synonyms'].map{ |k,v| @synonyms << v }
+      end
+    end
+    
+    # keymatches
+    if response['GSP'].has_key?('GM')
+      if response['GSP']['GM'].kind_of?(Array)
+        response['GSP']['GM'].each do |gm|
+          @keymatches << Keymatch.new(gm)
+        end
+      else
+        @keymatches << Keymatch.new(response['GSP']['GM'])
+      end
+    end
+    
+  end
+  
+end

data/lib/google-mini.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__))
+
+begin
+   require 'rubygems'
+rescue LoadError
+   nil
+end
+
+module GoogleMini
+  VERSION = '0.0.1'
+end
+
+require 'httparty'
+require 'google-mini/google-mini'
+require 'google-mini/result'
+require 'google-mini/search'
+require 'google-mini/keymatch'

data/test/google-mini_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GoogleMiniTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'google-mini'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: jumzies-google-mini
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jimmy Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: jimmybaker@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/google-mini.rb
+- lib/google-mini/google-mini.rb
+- lib/google-mini/keymatch.rb
+- lib/google-mini/result.rb
+- lib/google-mini/search.rb
+- test/google-mini_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/jumzies/google-mini
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+summary: The Google Mini gem simply lets you query your Google Mini appliance with the ease you'd expect from a Ruby library.
+test_files: 
+- test/google-mini_test.rb
+- test/test_helper.rb