yahoo-answers 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Felipe Koch
+
+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,52 @@
+= yahoo-answers
+
+Github Project:
+http://github.com/felipekk/yahoo-answers-gem
+
+== Requirements
+
+This gem requires Eric Hodel and David N. Welton's yahoo gem:
+
+http://github.com/davidw/yahoo-gem
+
+Also check out their Yahoo Web Search and Yahoo Location Search gem:
+
+http://github.com/davidw/yahoo-search-gem
+
+== Description
+
+This is a simple implementation of version 1 of Yahoo! Answers API. It allows you to search Yahoo! Answers, returning
+the questions found and it's answers.
+
+== Using Yahoo::Answers
+
+First you'll need a Yahoo Application ID.  You can register for one here:
+
+http://api.search.yahoo.com/webservices/register_application
+
+Then simply create a Yahoo::Answers object with your API Key and start searching for answers:
+
+    require 'rubygems'
+    require 'yahoo/answers'
+
+    ya = Yahoo::Answers.new api_key
+
+    results = ys.search(:query => 'cars')
+
+    results.each do |result|
+        puts result.inspect
+    end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Felipe Koch. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yahoo-answers"
+    gem.summary = "A Ruby Yahoo! Answers API Implementation"
+    gem.description = "An interface to Yahoo! Answers service"
+    gem.email = "felipekk@gmail.com"
+    gem.homepage = "http://github.com/felipekk/yahoo-answers-gem"
+    gem.authors = ["Felipe Koch"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_dependency "yahoo", ">= 2.0.0"
+    gem.files.add 'lib/yahoo/answers.rb'
+    # 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: 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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yahoo-answers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/yahoo/answers.rb

@@ -0,0 +1,89 @@
+require 'yahoo'
+
+##
+# Yahoo! Answers API
+#
+# http://developer.yahoo.com/answers/V1/questionSearch.html
+
+class Yahoo::Answers < Yahoo
+
+  Question = Struct.new :id, :type, :subject, :content, :date, :timestamp, :link, :category_id, :category, :user_id,
+                        :user_nick, :user_photo_url, :num_answers, :num_comments, :answer, :answerer_id,
+                        :answerer_nick, :answer_timestamp, :answer_award_timestamp
+
+  def initialize(*args) # :nodoc:
+    @host = 'answers.yahooapis.com'
+    @service_name = 'AnswersService'
+    @version = 'V1'
+    super
+  end
+
+  ##
+  # Searches the web for <tt>:query</tt> and returns up to <tt>:results</tt> results
+  #
+  # <tt>:results</tt> defaults to 10 questions, maximum per Yahoo! Answers API is 50
+  #
+  # All options on http://developer.yahoo.com/answers/V1/questionSearch.html can be used
+
+  def search(options)
+    params = { :results => 10 }.merge(options)
+    get :questionSearch, params
+  end
+
+  def parse_response(xml) # :nodoc:
+    results = []
+
+    xml.xpath('//xmlns:Question').each do |r|
+      result = Question.new
+
+      result.id = r.attribute('id').content
+      result.type = r.attribute('type').content
+      result.subject = r.at_xpath('xmlns:Subject').content
+      result.content = r.at_xpath('xmlns:Content').content
+      result.date = r.at_xpath('xmlns:Date').content
+      result.timestamp = r.at_xpath('xmlns:Timestamp').content.to_i
+      result.link = r.at_xpath('xmlns:Link').content
+      result.category_id = r.at_xpath('xmlns:Category').attribute('id').content.to_i
+      result.category = r.at_xpath('xmlns:Category').content
+      result.user_id = r.at_xpath('xmlns:UserId').content
+      result.user_nick = r.at_xpath('xmlns:UserNick').content
+      result.user_photo_url = r.at_xpath('xmlns:UserPhotoURL').content
+      result.num_answers = r.at_xpath('xmlns:NumAnswers').content.to_i
+      result.num_comments = r.at_xpath('xmlns:NumComments').content.to_i
+      result.answer = r.at_xpath('xmlns:ChosenAnswer').content
+      result.answerer_id = r.at_xpath('xmlns:ChosenAnswererId').content
+      result.answerer_nick = r.at_xpath('xmlns:ChosenAnswererNick').content
+      result.answer_timestamp = r.at_xpath('xmlns:ChosenAnswerTimestamp').content.to_i
+      result.answer_award_timestamp = r.at_xpath('xmlns:ChosenAnswerAwardTimestamp').content.to_i
+
+      results << result
+    end
+
+    return results
+  end
+end
+
+##
+# A Result contains the following fields
+#
+# +id+:: unique id of the question
+# +type+:: state of the question (answered, open, ...)
+# +subject+:: question subject
+# +content+:: question text
+# +date+:: pre-formatted date of when the question was submitted
+# +timestamp+:: unix timestamp of when the question was submitted
+# +link+:: link to the question
+# +category+:: category that the question is listed under
+# +category_id+:: unique id of the category
+# +user_id+:: unique id of the user who posted the question
+# +user_nick+:: nickname of the user who posted the question
+# +user_photo_url+:: URL of the user's photo
+# +num_answers+:: number of answers to the question
+# +num_comments+:: number of comments to the question
+# +answer+:: the text of the chosen answer
+# +answer_timestamp+:: unix time of when the answer was submitted
+# +answer_award_timestamp+:: unix time of when the answer was given an award
+# +answerer_id+:: unique id of the user who submitted the answer
+# +answerer_nick+:: nickname of the user who submitted the answer
+
+class Yahoo::Answers::Result; end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'rc_rest/uri_stub'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'yahoo/answers'
+
+class Test::Unit::TestCase
+end

data/test/test_answers.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+class Yahoo::TestAnswers < Test::Unit::TestCase
+
+  context "given a response" do
+    setup do
+      URI::HTTP.responses = []
+      URI::HTTP.responses << <<-EOF.strip
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:answers" xsi:schemaLocation="urn:yahoo:answers http://answers.yahooapis.com/AnswersService/V1/QuestionResponse.xsd">
+    <Question id="20080217202924AAkuKbJ" type="Answered">
+        <Subject>***cars?***?</Subject>
+        <Content>has anyone seen the new go smart cars? i dont like them. to me it looks like a car that got cut in half. my mom wants to buy one for me. wat do u think of them?</Content>
+        <Date>2008-02-17 20:29:24</Date>
+        <Timestamp>1203308964</Timestamp>
+        <Link>http://answers.yahoo.com/question/?qid=20080217202924AAkuKbJ</Link>
+        <Category id="396545312">Buying and Selling</Category>
+        <UserId>xryGBiRVaa</UserId>
+        <UserNick>@13x</UserNick>
+        <UserPhotoURL/>
+        <NumAnswers>3</NumAnswers>
+        <NumComments>6</NumComments>
+        <ChosenAnswer>I think there an oxymoron. Smart people do not buy them. You would be better off buying Barbies Corvette.</ChosenAnswer>
+        <ChosenAnswererId>4e22efbfa0c39c853547002dfd47db5faa</ChosenAnswererId>
+        <ChosenAnswererNick>Just Me</ChosenAnswererNick>
+        <ChosenAnswerTimestamp>1203310721</ChosenAnswerTimestamp>
+        <ChosenAnswerAwardTimestamp>1203558774</ChosenAnswerAwardTimestamp>
+    </Question>
+    <Question id="20100110090837AACoHlh" type="Open">
+        <Subject>How can i determine the speed of the cars?</Subject>
+        <Content>I just wanted to know, generally, how can i figure out what the speed of two cars was before they got into an accident, to determine which car was speeding. I know skid marks were left and the conditions were dry, level and smooth.</Content>
+        <Date>2010-01-10 09:08:37</Date>
+        <Timestamp>1263143317</Timestamp>
+        <Link>http://answers.yahoo.com/question/?qid=20100110090837AACoHlh</Link>
+        <Category id="396545317">Other - Cars and Transportation</Category>
+        <UserId>EkIFD4K4aa</UserId>
+        <UserNick>nhh</UserNick>
+        <UserPhotoURL>http://l.yimg.com/a/i/identity/nopic_48.gif</UserPhotoURL>
+        <NumAnswers>1</NumAnswers>
+        <NumComments>0</NumComments>
+        <ChosenAnswer/>
+        <ChosenAnswererId/>
+        <ChosenAnswererNick/>
+        <ChosenAnswerTimestamp/>
+        <ChosenAnswerAwardTimestamp/>
+    </Question>
+</ResultSet>
+<!-- ws13.ydn.ac4.yahoo.com compressed/chunked Wed Jan 27 08:50:07 PST 2010 -->
+      EOF
+      URI::HTTP.uris = []
+
+      @answer = Yahoo::Answers.new 'APP_ID'
+    end
+
+    context "when doing a search" do
+      setup do
+        @results = @answer.search(:query => 'cars')
+      end
+
+      should("have two results") { assert_equal 2, @results.size }
+
+      context "the first result" do
+        setup do
+          @result = @results.first
+        end
+
+        should("have correct id") { assert_equal "20080217202924AAkuKbJ", @result.id }
+        should("have correct type") { assert_equal "Answered", @result.type }
+        should("have correct subject") { assert_equal "***cars?***?", @result.subject }
+        should("have correct content") { assert_equal "has anyone seen the new go smart cars? i dont like them. to me it looks like a car that got cut in half. my mom wants to buy one for me. wat do u think of them?", @result.content }
+        should("have correct date") { assert_equal "2008-02-17 20:29:24", @result.date }
+        should("have correct timestamp") { assert_equal 1203308964, @result.timestamp }
+        should("have correct link") { assert_equal "http://answers.yahoo.com/question/?qid=20080217202924AAkuKbJ", @result.link }
+        should("have correct category id") { assert_equal 396545312, @result.category_id }
+        should("have correct category") { assert_equal "Buying and Selling", @result.category }
+        should("have correct user id") { assert_equal "xryGBiRVaa", @result.user_id }
+        should("have correct user nick") { assert_equal "@13x", @result.user_nick }
+        should("have blank user photo url") { assert_equal "", @result.user_photo_url }
+        should("have correct num answers") { assert_equal 3, @result.num_answers }
+        should("have correct num comments") { assert_equal 6, @result.num_comments }
+        should("have correct answer") { assert_equal "I think there an oxymoron. Smart people do not buy them. You would be better off buying Barbies Corvette.", @result.answer }
+        should("have correct answer timestamp") { assert_equal 1203310721, @result.answer_timestamp }
+        should("have correct answerer id") { assert_equal "4e22efbfa0c39c853547002dfd47db5faa", @result.answerer_id }
+        should("have correct answerer nick") { assert_equal "Just Me", @result.answerer_nick }
+      end
+
+      context "the last result" do
+        setup do
+          @result = @results.last
+        end
+
+        should("have correct user photo url") { assert_equal "http://l.yimg.com/a/i/identity/nopic_48.gif", @result.user_photo_url }
+        should("have blank answer") { assert_equal "", @result.answer }
+        should("have correct answer timestamp") { assert_equal 0, @result.answer_timestamp }
+        should("have correct answer award timestamp") { assert_equal 0, @result.answer_award_timestamp }
+      end
+    end
+  end
+end

data/yahoo-answers.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yahoo-answers}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Felipe Koch"]
+  s.date = %q{2010-01-27}
+  s.description = %q{An interface to Yahoo! Answers service}
+  s.email = %q{felipekk@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/yahoo/answers.rb",
+     "test/helper.rb",
+     "test/test_answers.rb",
+     "yahoo-answers.gemspec"
+  ]
+  s.homepage = %q{http://github.com/felipekk/yahoo-answers-gem}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby Yahoo! Answers API Implementation}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_answers.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
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<yahoo>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<yahoo>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<yahoo>, [">= 2.0.0"])
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: yahoo-answers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Felipe Koch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-27 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yahoo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: An interface to Yahoo! Answers service
+email: felipekk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yahoo/answers.rb
+- test/helper.rb
+- test/test_answers.rb
+- yahoo-answers.gemspec
+has_rdoc: true
+homepage: http://github.com/felipekk/yahoo-answers-gem
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby Yahoo! Answers API Implementation
+test_files: 
+- test/helper.rb
+- test/test_answers.rb