yahoo 1.0.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright 2006 Eric Hodel, The Robot Co-op.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/yahoo.rb
+test/test_yahoo.rb
+test/uri_stub.rb

data/README

@@ -0,0 +1,25 @@
+= yahoo
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/rctools/
+
+Documentation:
+
+http://dev.robotcoop.com/Libraries/yahoo/
+
+== About
+
+This is an abstract class for implementing Yahoo's web services APIs.  By
+itself it isn't at all useful.
+
+== Installing yahoo
+
+Just install the gem:
+
+  $ sudo gem install yahoo
+
+== Using yahoo
+
+Yahoo is used by gems such as yahoo-geocode and yahoo-search.  If you'd like to write bindings a yahoo web service see those gems for examples.
+

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$VERBOSE = nil
+
+spec = Gem::Specification.new do |s|
+  s.name = 'yahoo'
+  s.version = '1.0.0'
+  s.summary = 'Base for Yahoo web services'
+  s.description = 'This library makes it easy to implement Yahoo\'s web services APIs.'
+  s.author = 'Eric Hodel'
+  s.email = 'eric@robotcoop.com'
+
+  s.has_rdoc = true
+  s.files = File.read('Manifest.txt').split($/)
+  s.require_path = 'lib'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Yahoo Web Services'
+end
+
+desc 'Generate RDoc for dev.robotcoop.com'
+Rake::RDocTask.new :dev_rdoc do |rd|
+  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/yahoo'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t Yahoo Web Services'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=Ruby
+

data/lib/yahoo.rb

@@ -0,0 +1,86 @@
+require 'open-uri'
+require 'rexml/document'
+
+##
+# Abstract class for implementing Yahoo APIs.
+#
+# http://developer.yahoo.com/
+
+class Yahoo
+
+  ##
+  # Yahoo error class.
+
+  class Error < RuntimeError; end
+
+  ##
+  # Web services initializer.
+  #
+  # The +appid+ is the Application ID that uniquely identifies your
+  # application.  See: http://developer.yahoo.com/faq/index.html#appid
+  #
+  # Concrete web services implementations need to set the following instance
+  # variables then call super:
+  #
+  # +host+:: API endpoint hostname
+  # +service_name+:: service name
+  # +version+:: service name version number
+  # +method+:: service method call
+  #
+  # See http://developer.yahoo.com/search/rest.html
+
+  def initialize(appid)
+    @appid = appid
+    @url = URI.parse "http://#{@host}/#{@service_name}/#{@version}/#{@method}"
+  end
+
+  ##
+  # Extracts and raises an error from +obj+.  Returns if no error could be
+  # found.
+
+  def check_error(obj)
+    obj = REXML::Document.new obj.read unless REXML::Document === obj
+
+    err = obj.elements['Error']
+    raise Error, err.elements['Message'].text if err
+  end
+
+  ##
+  # Performs a GET request with +params+.  Calls the parse_response method on
+  # the concrete class with an REXML::Document instance and returns its
+  # result.
+
+  def get(params)
+    url = make_url params
+
+    url.open do |xml|
+      res = REXML::Document.new xml.read
+
+      check_error res
+
+      return parse_response(res)
+    end
+  rescue OpenURI::HTTPError => e
+    check_error e.io
+    raise
+  end
+
+  ##
+  # Creates a URL from the Hash +params+.  Automatically adds the appid and
+  # sets the output type to 'xml'.
+
+  def make_url(params)
+    params[:appid] = @appid
+    params[:output] = 'xml'
+
+    escaped_params = params.sort_by { |k,v| k.to_s }.map do |k,v|
+      "#{URI.escape k.to_s}=#{URI.escape v.to_s}"
+    end
+
+    url = @url.dup
+    url.query = escaped_params.join '&'
+    return url
+  end
+
+end
+

data/test/test_yahoo.rb

@@ -0,0 +1,93 @@
+require 'test/unit'
+require 'test/uri_stub'
+require 'yahoo'
+
+class Yahoo::Test < Yahoo
+
+  def initialize(*args)
+    @host = 'api.test.yahoo.com'
+    @service_name = 'TestService'
+    @version = 'Vtest'
+    @method = 'test'
+    super
+  end
+
+  def test
+    get :test_param => 5
+  end
+
+  def parse_response(xml)
+    return xml
+  end
+
+end
+
+class TestYahoo < Test::Unit::TestCase
+
+  def setup
+    URI::HTTP.responses = []
+    URI::HTTP.uris = []
+
+    @t = Yahoo::Test.new 'APP_ID'
+  end
+
+  def test_check_error_IO
+    io = StringIO.new '<Error><Message>you broked it</Message></Error>'
+    @t.check_error io
+
+  rescue Yahoo::Error => e
+    assert_equal 'you broked it', e.message
+
+  else
+    flunk 'expected an error'
+  end
+
+  def test_check_error_REXML__Document
+    xml = REXML::Document.new '<Error><Message>you broked it</Message></Error>'
+    @t.check_error xml
+
+  rescue Yahoo::Error => e
+    assert_equal 'you broked it', e.message
+
+  else
+    flunk 'expected an error'
+  end
+
+  def test_get
+    xml = '<Result>stuff</Result>'
+    URI::HTTP.responses << xml
+
+    result = @t.test
+
+    assert_equal xml, result.to_s
+  end
+
+  def test_get_error
+    def @t.make_url(*args) # HACK extend uri_stub with error raising ability
+      u = Object.new
+      def u.open
+        xml = '<Error><Message>you did the bad thing</Message></Error>'
+        raise OpenURI::HTTPError.new('400 Bad Request', StringIO.new(xml))
+      end
+      return u
+    end
+
+    assert_raise Yahoo::Error do @t.test end
+  end
+
+  def test_initialize
+    assert_equal 'http://api.test.yahoo.com/TestService/Vtest/test',
+                 @t.instance_variable_get(:@url).to_s
+  end
+
+  def test_make_url
+    url = @t.make_url :test_param_1 => 'test test',
+                      :test_param_2 => 'tset tset'
+
+    expected = 'http://api.test.yahoo.com/TestService/Vtest/test?appid=APP_ID&output=xml&test_param_1=test%20test&test_param_2=tset%20tset'
+
+    assert_equal expected, url.to_s
+  end
+
+end
+

data/test/uri_stub.rb

@@ -0,0 +1,17 @@
+require 'open-uri'
+
+class URI::HTTP
+
+  class << self
+    attr_accessor :responses, :uris
+  end
+
+  alias original_open open
+
+  def open
+    self.class.uris << self.to_s
+    yield StringIO.new(self.class.responses.shift)
+  end
+
+end
+

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.15
+specification_version: 1
+name: yahoo
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-06-10 00:00:00 -07:00
+summary: Base for Yahoo web services
+require_paths: 
+- lib
+email: eric@robotcoop.com
+homepage: 
+rubyforge_project: 
+description: This library makes it easy to implement Yahoo's web services APIs.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/yahoo.rb
+- test/test_yahoo.rb
+- test/uri_stub.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+