yanapi 0.1.1 → 0.3.1

data/test/integration_test_data/test_term_query.txt

@@ -0,0 +1,62 @@
+HTTP/1.1 200 OK
+Date: Wed, 03 Aug 2011 21:16:04 GMT
+P3P: policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+Vary: Accept-Encoding
+Connection: close
+Transfer-Encoding: chunked
+Content-Type: text/xml; charset=utf-8
+Cache-Control: private
+
+<?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="20090824105131AAJyFeP" type="Answered">
+        <Subject>Does the Kool Haus in Toronto have chairs to sit on?</Subject>
+        <Content>I am planning to attend a concert there and I was searching for a seating chart. 
+But all it said was &quot;General Admission, No reserved seating.&quot; 
+Does that mean it is a concert where people stand the whole time?
+Help me out here.
+</Content>
+        <Date>2009-08-24 10:51:31</Date>
+        <Timestamp>1251136291</Timestamp>
+        <Link>http://answers.yahoo.com/question/?qid=20090824105131AAJyFeP</Link>
+        <Category id="396545505">Toronto</Category>
+        <UserId>gD3O45YZaa</UserId>
+        <UserNick>delightfullytacky</UserNick>
+        <UserPhotoURL>http://a323.yahoofs.com/coreid/4e2363ebi52bzws126ac4/hP26bOE3d6_X57.bKhIPA4pnocQMwRgQQuM-/3/tn48.jpeg?ciAAgGPBdR7XKuAK</UserPhotoURL>
+        <NumAnswers>2</NumAnswers>
+        <NumComments>0</NumComments>
+        <ChosenAnswer>*visits website* *watches several videos*
+
+It looks like everyone is standing. You could call and ask:  416-869-0045
+or email: clubevents@theguvernment.com</ChosenAnswer>
+        <ChosenAnswererId>vDGFRACaaa</ChosenAnswererId>
+        <ChosenAnswererNick>Clever Nickname</ChosenAnswererNick>
+        <ChosenAnswerTimestamp>1251150093</ChosenAnswerTimestamp>
+        <ChosenAnswerAwardTimestamp>1251218910</ChosenAnswerAwardTimestamp>
+    </Question>
+    <Question id="20110413211429AAGq456" type="Answered">
+        <Subject>what is the classical song used in hanna in the grimm haus scene?</Subject>
+        <Content>
+Specifically the one Mr. Grimm dances to and explains to her how much she has missed by her father not teaching her music.
+</Content>
+        <Date>2011-04-13 21:14:29</Date>
+        <Timestamp>1302754469</Timestamp>
+        <Link>http://answers.yahoo.com/question/?qid=20110413211429AAGq456</Link>
+        <Category id="2115500203">Jazz</Category>
+        <UserId>o51L3mQ0aa</UserId>
+        <UserNick>Raymond Lam</UserNick>
+        <UserPhotoURL>http://l.yimg.com/a/i/identity2/profile_48b.png</UserPhotoURL>
+        <NumAnswers>1</NumAnswers>
+        <NumComments>0</NumComments>
+        <ChosenAnswer>Grieg, In the Hall of the Mountain King 
+
+
+
+I searched for days for this thing....</ChosenAnswer>
+        <ChosenAnswererId>kF004Enxaa</ChosenAnswererId>
+        <ChosenAnswererNick>Matt Revels</ChosenAnswererNick>
+        <ChosenAnswerTimestamp>1303031285</ChosenAnswerTimestamp>
+        <ChosenAnswerAwardTimestamp>1303273986</ChosenAnswerAwardTimestamp>
+    </Question>
+</ResultSet>
+<!-- ws08.ydn.ac4.yahoo.com uncompressed/chunked Wed Aug  3 14:16:04 PDT 2011 -->

data/test/integration_test_data/test_user_query.txt

@@ -0,0 +1,62 @@
+HTTP/1.1 200 OK
+Date: Thu, 04 Aug 2011 12:39:12 GMT
+P3P: policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+Vary: Accept-Encoding
+Connection: close
+Transfer-Encoding: chunked
+Content-Type: text/xml; charset=utf-8
+Cache-Control: private
+
+<?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="20110804051037AAY1a19" type="Open">
+        <Subject>Wie soll ich die Apps speichern?</Subject>
+        <Content>Hallo, ich habe den iPod Touch der 4. Generation gekauft. Davor hatte ich die 3. Gen..
+Nun möchte ich die alten Apps auf den neuen iPod installieren, aber wie soll ich die Apps aus den alten iPod ziehen?
+Auch Musik und Videos!
+Bitte um Hilfe
+Danke
+</Content>
+        <Date>2011-08-04 05:10:37</Date>
+        <Timestamp>1312459837</Timestamp>
+        <Link>http://answers.yahoo.com/question/?qid=20110804051037AAY1a19</Link>
+        <Category id="396545664">Software</Category>
+        <UserId>J9jXNU1Oaa</UserId>
+        <UserNick>Yoyo</UserNick>
+        <UserPhotoURL>http://a323.yahoofs.com/coreid/4ca62b4ei2959zws135ac4/r0RWIek1cbZfVx7VFIjHJFx3/2/tn48.jpeg?ciAAgGPBxmucSNz4</UserPhotoURL>
+        <NumAnswers>1</NumAnswers>
+        <NumComments>0</NumComments>
+        <ChosenAnswer></ChosenAnswer>
+        <ChosenAnswererId></ChosenAnswererId>
+        <ChosenAnswererNick></ChosenAnswererNick>
+        <ChosenAnswerTimestamp></ChosenAnswerTimestamp>
+        <ChosenAnswerAwardTimestamp></ChosenAnswerAwardTimestamp>
+    </Question>
+    <Question id="20110727064904AAAbyLW" type="Answered">
+        <Subject>Ist mein Gutschein weg?</Subject>
+        <Content>Hallo, ich habe einen Gutschein im Wert von 50€ für Amazon.de gekauft.
+Um zu testen, ob er noch gültig ist habe ich einen Artikel ausgewählt und den Gutschein eingelöst, aber die Bestellung nicht abgeschickt!
+
+Ist mein Gutschein jetzt eingelöst oder nicht?
+Ich möchte den Artikel nicht kaufen wollte nur testen?
+
+Danke
+</Content>
+        <Date>2011-07-27 06:49:04</Date>
+        <Timestamp>1311774544</Timestamp>
+        <Link>http://answers.yahoo.com/question/?qid=20110727064904AAAbyLW</Link>
+        <Category id="396545665">Other - Computers</Category>
+        <UserId>J9jXNU1Oaa</UserId>
+        <UserNick>Yoyo</UserNick>
+        <UserPhotoURL>http://a323.yahoofs.com/coreid/4ca62b4ei2959zws135ac4/r0RWIek1cbZfVx7VFIjHJFx3/2/tn48.jpeg?ciAAgGPBxmucSNz4</UserPhotoURL>
+        <NumAnswers>3</NumAnswers>
+        <NumComments>0</NumComments>
+        <ChosenAnswer>Vorher nachdenken? Nur so&#039;n Vorschlag.
+Die Bestellung wird erst wirksam wenn du sie absendest. Amazon baut bei Bestellungen hin und wieder Mist. Einfach anschreiben. Der Kundenservice reagiert i.d.R. schnell und kundenfreundlich.</ChosenAnswer>
+        <ChosenAnswererId>82c64064ae238f0ce223f33036950a66aa</ChosenAnswererId>
+        <ChosenAnswererNick>another_nick_2006</ChosenAnswererNick>
+        <ChosenAnswerTimestamp>1311774821</ChosenAnswerTimestamp>
+        <ChosenAnswerAwardTimestamp>1312293814</ChosenAnswerAwardTimestamp>
+    </Question>
+</ResultSet>
+<!-- ws09.ydn.ac4.yahoo.com uncompressed/chunked Thu Aug  4 05:39:12 PDT 2011 -->

data/test/test_api.rb

@@ -0,0 +1,154 @@
+require 'test/unit'
+require 'yanapi/api'
+require 'test_helper'
+
+class TestAPI < Test::Unit::TestCase
+
+  include TestHelper
+  
+  def setup
+    @min_input = {
+      :method => 'questionSearch',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :query => 'cars'
+      }
+    }
+    @superfluous_input = @min_input.merge({:some_key => 'some_value'})
+  end
+
+  def teardown
+  end
+
+  # It should declare the following constants.
+  def test_constant_declaration
+    defined_constants = [:REQUIRED_PARAMS,
+                         :ACCEPTED_METHODS
+                        ]
+    
+    defined_constants.each do |const|
+      assert(YANAPI::API.const_defined?(const))
+    end
+  end
+
+  # It should have the following public methods.
+  def test_available_public_methods
+    methods = [:get, :version]
+    methods.each { |m| assert_respond_to(YANAPI::API.new(@min_input), m) }
+  end
+
+  # It should accept a hash.
+  def test_input_class
+    params = []
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/Params should be a Hash, not Array!/, e.message)
+  end
+
+  # It should reject an empty subhash <:query_params>.
+  def test_rejecting_empty_params
+    params = {}
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/The params hash is empty!/, e.message)
+  end
+ 
+  # It should accept a parameter hash with the keys
+  # <:method> and <:query_params>.
+  def test_presence_of_obligatory_keys
+    params = {:abc => 'questionSearch' }
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/You should provide: <:method>, <:query_params>!/,
+                 e.message)
+    params = {:query_params => {:a => 'questionSearch'}}
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/You should provide: <:method>!/, e.message)
+
+    params = {:abc => 'questionSearch', :method => 'questionSearch'}
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/You should provide: <:query_params>!/, e.message)
+  end
+  
+  # It should accept a two dimensional hash.
+  def test_dimensions_of_params
+    params = {:method => 'questionSearch', :query_params => [:abc, :cde]}
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/<:query_params> should be a Hash, not Array!/,
+                 e.message)
+    params = {:method => 'getByUser', :query_params => {}}
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(params) }
+    assert_match(/<:query_params> is empty!/, e.message)    
+  end
+  
+  # It should accept four possible values for <:method>.
+  def test_possible_values_for_method
+    @min_input[:method] = 'no_method'
+    e = assert_raises(YANAPI::UserError) { YANAPI::API.new(@min_input) }
+    assert_match(/<no_method> is not a valid search method!/, e.message)
+  end
+  
+  # It should warn about presence of other keys.
+  def test_warnings_about_ignored_keys
+    out, err = intercept_output do
+      YANAPI::API.new(@superfluous_input)
+    end
+    assert_match(/Keys ignored: <:some_key>!/, err)
+    out, err = intercept_output do
+      YANAPI::API.new(@superfluous_input.merge({:another_key => 'val'}))
+    end
+    assert_match(/Keys ignored: (<:some_key>|,| |<:another_key>)+!/,
+                 err)
+  end
+
+  # It should create a query instance of the correct class.
+  def test_class_of_the_query_instance
+    input = {
+      :method => 'questionSearch',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :query => 'cars'
+      }
+    }
+    obj = YANAPI::API.new(input)
+    query_obj = obj.instance_variable_get(:@query)
+    assert_instance_of(YANAPI::TermQuery, query_obj)
+
+    input = {
+      :method => 'getByUser',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :user_id => 'cars'
+      }
+    }
+    obj = YANAPI::API.new(input)
+    query_obj = obj.instance_variable_get(:@query)
+    assert_instance_of(YANAPI::UserQuery, query_obj)
+
+    input = {
+      :method => 'getByCategory',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :category_id => '123'
+      }
+    }
+    obj = YANAPI::API.new(input)
+    query_obj = obj.instance_variable_get(:@query)
+    assert_instance_of(YANAPI::CategoryQuery, query_obj)
+
+    input = {
+      :method => 'getQuestion',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :question_id => '123'
+      }
+    }
+    obj = YANAPI::API.new(input)
+    query_obj = obj.instance_variable_get(:@query)
+    assert_instance_of(YANAPI::QuestionQuery, query_obj)
+  end
+
+  # It should return a string value for the version.
+  def test_version_class
+    obj = YANAPI::API.new(@min_input)
+    assert_equal(String, obj.version.class)
+    assert_equal(false, obj.version.empty?)
+  end
+end

data/test/test_category_query.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'yanapi'
+require 'yanapi/category_query'
 require 'fakeweb'
 
 class TestCategoryQuery < Test::Unit::TestCase
@@ -12,6 +12,17 @@ class TestCategoryQuery < Test::Unit::TestCase
   def teardown
   end
 
+  # This class should declare the following constants.
+  def test_constants
+    defined_constants = [:VALID_PARAMS,
+                         :REQUIRED_PARAMS
+                        ]
+
+    defined_constants.each do |const|
+      assert(YANAPI::CategoryQuery.const_defined?(const))
+    end     
+  end
+  
   # getByCategory (CategorySearch) needs either :category_id or :category_name
   def test_missing_category
     @params.delete(:category_name)

data/test/test_common.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'yanapi'
+require 'yanapi/common'
 
 class TestCommon < Test::Unit::TestCase
   def setup

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+module TestHelper
+  # It is a helper method, many testable units provide verbose output
+  # to stderr and/or stdout. It can suppress any kind of verbosity.
+  def quietly(&b)
+    begin
+      orig_stderr = $stderr.clone
+      orig_stdout = $stdout.clone
+      $stderr.reopen(File.new('/dev/null', 'w'))
+      $stdout.reopen(File.new('/dev/null', 'w'))
+      b.call
+    ensure
+      $stderr.reopen(orig_stderr)
+      $stdout.reopen(orig_stdout)
+    end
+  end
+
+  # It is a helper method for handling stdout and stderr as strings.
+  def intercept_output
+    orig_stdout = $stdout
+    orig_stderr = $stderr
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    yield
+
+    return $stdout.string, $stderr.string
+  ensure
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end  
+end

data/test/test_integration.rb

@@ -0,0 +1,129 @@
+require 'yanapi'
+require 'fakeweb'
+require 'test/unit'
+
+class TestIntegration < Test::Unit::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+  
+  # It should find questions for given key words.
+  def test_term_query
+    params = {
+      :method => 'questionSearch',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :query => 'Haus',
+        :search_in => 'question',
+        :type => 'resolved',
+        :results => 2,
+        :output => 'xml'
+      }
+    }
+    file = 'test_term_query'
+    exp, act = compare(params, file)
+    assert_equal(exp, act)
+  end
+  
+  # It should find questions for a given category.
+  def test_category_query
+    params = {
+      :method => 'getByCategory',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :category_id => '396545664',
+        :region => 'de',
+        :type => 'resolved',
+        :results => 2,
+        :output => 'xml'
+      }
+    }
+    file = 'test_term_query'
+    exp, act = compare(params, file)
+    assert_equal(exp, act)
+  end
+  
+  # It should find questions for a given user ID.
+  def test_user_query
+    params = {
+      :method => 'getByUser',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :user_id => 'J9jXNU1Oaa',
+        :filter => 'question',
+        :results => 2,
+        :output => 'xml'
+      }
+    }
+    file = 'test_term_query'
+    exp, act = compare(params, file)
+    assert_equal(exp, act)    
+  end
+  
+  # It should find a question given a question ID.
+  def test_question_query
+    params = {
+      :method => 'getQuestion',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :question_id => '20110804051037AAY1a19',
+        :output => 'xml'
+      }
+    }
+    file = 'test_term_query'
+    exp, act = compare(params, file)
+    assert_equal(exp, act)
+  end
+
+  # It should return <nil> if nothing has been found.
+  def test_empty_response
+    params = {
+      :method => 'questionSearch',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :query => 'Haus',
+        :category_id => '396545219',
+        :search_in => 'question',
+        :type => 'resolved'
+      }
+    }
+    file = 'test_empty_response'
+    exp, act = compare(params, file)
+    assert_equal(nil, act)
+  end
+
+  # It should exit with an exception given an invalid input.
+  def test_invalid_query
+    params = {
+      :method => 'questionSearch',
+      :query_params => {
+        :query => 'Haus',
+        :category_id => '396545219',
+        :search_in => 'question',
+        :type => 'resolved'
+      }
+    }
+    assert_raises(YANAPI::UserError) do
+      api = YANAPI::API.new(params)
+    end
+  end
+
+  # It is a helper method, it takes the params hash and the name
+  # of the file with a right answer and asserts their equality.
+  def compare(params, file)
+    file = 'test/integration_test_data/' + file + '.txt'
+    http_answer = File.open(file) { |f| f.read }
+    # Deleting the http answer header, leaving xml structure.
+    expected_api_answer = http_answer.sub(/^[^<]+/m, '')
+
+    api = YANAPI::API.new(params)
+    url = api.instance_variable_get(:@query).
+      instance_variable_get(:@url)
+    FakeWeb.register_uri(:get, url, :response => http_answer)
+
+    actual_api_answer = api.get
+    return expected_api_answer, actual_api_answer
+  end
+end