yanapi 0.1.1 → 0.3.1

data/test/test_query.rb

@@ -1,107 +1,172 @@
 require 'test/unit'
-require 'yanapi'
+require 'yanapi/query'
 require 'fakeweb'
 
 class TestQuery < Test::Unit::TestCase
   def setup
-    @params = {:appid => 'MyID', :method => 'questionSearch'}
+    @params = {
+      :method => 'questionSearch',
+      :query_params => {
+        :appid => 'YahooDemo',
+        :query => 'Haus',
+        :output => 'xml'
+      }
+    }
   end
   def teardown
   end
 
+  ## Structural tests
+  
+  # It should have a public method <get>.
   def test_public_methods
     q = YANAPI::Query.new(@params)
     assert_respond_to(q, :get)
   end
 
+  # This class should declare the following constants.
   def test_constants
-    assert_equal('http://answers.yahooapis.com', YANAPI::Query::HOST)
+    defined_constants = [:HOST,
+                         :SERVICE,
+                         :SERVICE_VERSION,
+                         :VALID_PARAMS,
+                         :REQUIRED_PARAMS,
+                         :VALID_OUTPUT_FORMATS
+                        ]
+    defined_constants.each do |const|
+      assert(YANAPI::Query.const_defined?(const))
+    end    
+  end
+
+  # The following constants should have the given value and type.
+  def test_values_of_constants
+    assert_equal('http://answers.yahooapis.com',
+                 YANAPI::Query::HOST)
     assert_equal('AnswersService', YANAPI::Query::SERVICE)
     assert_equal('V1', YANAPI::Query::SERVICE_VERSION)
-    assert(YANAPI::VERSION.is_a?(String) && ! YANAPI::VERSION.empty?)
   end
 
+  ## Interface tests
+
+  # It should reject the input hash without <:appid> parameter.
   def test_missing_appid
-    @params.delete(:appid)
-    assert_raises(YANAPI::Error) do
-      q = YANAPI::Query.new(@params)
-    end
+    @params[:query_params].delete(:appid)
+    assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
   end
 
-  # a Query can be only initialized with a valid value for :method
-  def test_missing_method
-    @params.delete(:method)
-    assert_raises(YANAPI::Error) do
-      q = YANAPI::Query.new(@params)
-    end
+  # It should accept only predefined values of <:output>:
+  # xml|json|php|rss|nil
+  def test_output_semantics
+    @params[:query_params][:output] = 'trash'
+    assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
   end
+  
+  # It should infer the output type in every case.
+  def test_output_type
+    @params[:query_params].delete(:output)
+    q = YANAPI::Query.new(@params)
+    output = q.instance_variable_get(:@output)
+    assert_equal('xml', output)
 
-  # :method may have only the following values:
-  # questionSearch|getByCategory|getQuestion|getByUser
-  def test_method_semantics
-    @params[:method] = 'someSampleMethod'
-    assert_raises(YANAPI::Error) do
-      q = YANAPI::Query.new(@params)
-    end
+    @params[:query_params][:output] = 'php'
+    q = YANAPI::Query.new(@params)
+    output = q.instance_variable_get(:@output)
+    assert_equal('php', output)
   end
 
-  # :output may be missing
-  def test_missing_output
-    @params.delete(:output)
-    q = YANAPI::Query.new(@params)
-    assert_equal('xml', q.output)
+  # It should allow only the combination: <:callback> and <'json'>.
+  def test_parameters_pairing
+    @params[:query_params][:output] = 'json'
+    @params[:query_params][:callback] = 'wrapper'
+    # It is analoguous to <assert_nothing_raised>.
+    YANAPI::Query.new(@params)
+    
+    @params[:query_params][:output] = 'xml'
+    assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
+    @params[:query_params].delete(:output)
+    assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
   end
 
-  # :output may be NIL or have values xml|json|php|rss
-  def test_output_semantics
-    @params[:output] = 'trash'
-    assert_raises(YANAPI::Error) do
-      q = YANAPI::Query.new(@params)
-    end
+  # It should reject not unique values.
+  def test_uniqueness_of_values
+    @params[:query_params][:category_id] = ['123', 345]
+    assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
   end
-  
 
-  # :callback may be used only with :output => 'json'
-  def test_parameters_pairing
-    @params[:output] = 'json'
-    @params[:callback] = 'wrapper'
-    assert_nothing_raised {q = YANAPI::Query.new(@params)}
-    @params[:output] = 'xml'
-    assert_raises(YANAPI::Error) {YANAPI::Query.new(@params)}
-    @params.delete(:output)
-    assert_raises(YANAPI::Error) {YANAPI::Query.new(@params)}
-  end
-
-  # we can get an empty response set with valid xml structure
-  # and the status code 200 HTTP OK
-  # but we should declene this
+  
+  ## Functional tests
+  
+  # It should return <nil> if the server response contains
+  # no answer. It is possible if we out of range or search criteria
+  # are too strict.
   def test_empty_response
     q = YANAPI::Query.new(@params)
     page = File.open('test/data/empty_result.txt') {|f| f.read}
-    FakeWeb.register_uri(:get, q.url, :response => page)
-    assert_raises(YANAPI::EmptyResponse) {q.get}
+    url = q.instance_variable_get(:@url)
+    FakeWeb.register_uri(:get, url, :response => page)
+    assert_equal(nil, q.get)
   end
 
+  # It should return a valid answer.
+  def test_successfull_response
+    file = 'test/data/successfull_response.txt'
+    http_answer = File.open(file) { |f| f.read }
+    # Deleting the http answer header, leaving xml structure.
+    expected_api_answer = http_answer.sub(/^[^<]+/m, '')
+
+    query = YANAPI::Query.new(@params)
+    url = query.instance_variable_get(:@url)
+    FakeWeb.register_uri(:get, url, :response => http_answer)
+
+    actual_api_answer = query.get
+    assert_instance_of(String, actual_api_answer, 'Not String!')
+    assert_equal(expected_api_answer, actual_api_answer)
+
+    warn "\nAdd tests for <php>, <json> and <rss>!\n"
+  end
+
+  # It should fail with an appropriate exception
+  # with a response containing errors.
   def test_response_with_error
-    q = YANAPI::Query.new(@params)
-    
-    page = File.open('test/data/response_with_error.txt') {|f| f.read}
-    FakeWeb.register_uri(:get, q.url, :response => page)
-    assert_raises(YANAPI::ContentError) {q.get}
-    
-    page = File.open('test/data/error_code.txt') {|f| f.read}
-    FakeWeb.register_uri(:get, q.url, :response => page)
-    assert_raises(YANAPI::ContentError) {q.get}
+    q = create_query('test/data/response_with_error.txt')
+    assert_raises(YANAPI::ContentError) { q.get }
+  end
 
-    page = File.open('test/data/bad_xml.txt') {|f| f.read}
-    FakeWeb.register_uri(:get, q.url, :response => page)
-    assert_raises(YANAPI::ContentError) {q.get}
+  # It should fail with an appropriate exception
+  # with a non valid xml response.
+  def test_non_valid_xml
+    q = create_query('test/data/bad_xml.txt')
+    assert_raises(YANAPI::ContentError) { q.get } 
+  end
+  
+  # It should fail with an appropriate exception
+  # if given the error code 400
+  def test_code_400
+    q = create_query('test/data/code_400.txt')
+    assert_raises(YANAPI::ExternalError) { q.get }
   end
 
-  def test_successfull_response
-    q = YANAPI::Query.new(@params)
-    page = File.open('test/data/successfull_response.txt') {|f| f.read}
-    FakeWeb.register_uri(:get, q.url, :response => page)
-    assert_nothing_raised {q.get}
+  # It should fail with an appropriate exception
+  # if given the error code 403
+  def test_code_403
+    q = create_query('test/data/code_403.txt')
+    assert_raises(YANAPI::ExternalError) { q.get }
+  end
+
+  # It should fail with an appropriate exception
+  # if given the error code 503
+  def test_code_503
+    q = create_query('test/data/code_503.txt')
+    assert_raises(YANAPI::ExternalError) { q.get }
+  end
+
+  # It is a helper method for asserting external and content errors.
+  def create_query(file)
+    query = YANAPI::Query.new(@params)
+    url = query.instance_variable_get(:@url)
+    page = File.open(file) { |f| f.read }
+    FakeWeb.register_uri(:get, url, :response => page)
+
+    query
   end
 end

data/test/test_question_query.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'yanapi'
+require 'yanapi/question_query'
 
 class TestQuestionQuery < Test::Unit::TestCase
   def setup
@@ -7,4 +7,17 @@ class TestQuestionQuery < 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::QuestionQuery.const_defined?(const))
+    end     
+  end
+  
+  def test_sample
+  end
 end #TestQuestionQuery

data/test/test_term_query.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'yanapi'
+require 'yanapi/term_query'
 require 'fakeweb'
 
 class TestTermQuery < Test::Unit::TestCase
@@ -12,14 +12,27 @@ class TestTermQuery < Test::Unit::TestCase
   def teardown
   end
 
-  # questionSearch needs a unique :query
-  def test_missing_query
-    @params.delete(:query)
-    assert_raises(YANAPI::Error) do
-      YANAPI::TermQuery.new(@params)
-    end
+  # This class should declare the following constants.
+  def test_constants
+    defined_constants = [:REQUIRED_PARAMS,
+                         :VALID_PARAMS
+                        ]
+
+    defined_constants.each do |const|
+      assert(YANAPI::TermQuery.const_defined?(const))
+    end     
   end
+  
+  # !!! OBSOLETE, TESTED IN test_query.rb
+  # questionSearch needs a unique :query
+#  def test_missing_query
+#    @params.delete(:query)
+#    assert_raises(YANAPI::Error) do
+#      YANAPI::TermQuery.new(@params)
+#    end
+#  end
 
+  # !!! AMBIGUOUS, SPLIT Query AND TermQuery
   # parameters can be only: query|search_in|category_id|category_name|
   # region|date_range|sort|appid|type|start|results|output|callback|method
   def test_parameters_semantics
@@ -30,7 +43,4 @@ class TestTermQuery < Test::Unit::TestCase
     end
   end
 
-  # validates presense of query
-  # validates uniqueness of query
-
 end #TestTermQuery

data/test/test_user_query.rb

@@ -1,9 +1,23 @@
 require 'test/unit'
-require 'yanapi'
+require 'yanapi/user_query'
 
 class TestUserQuery < Test::Unit::TestCase
   def setup
   end
   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::UserQuery.const_defined?(const))
+    end     
+  end
+  
+  def test_sample
+  end
 end #TestUserQuery

data/test/test_version.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'yanapi/version'
+
+class TestVersion < Test::Unit::TestCase
+
+  # This module should declare the following constants.
+  def test_constants
+    assert(YANAPI.const_defined?(:VERSION))
+    assert(YANAPI::VERSION.is_a?(String))
+    assert_equal(false, YANAPI::VERSION.empty?)
+  end
+end

data/test/test_yanapi.rb

@@ -1,8 +1,9 @@
-require 'test/unit'
-
 require 'test_query'
 require 'test_term_query'
 require 'test_category_query'
 require 'test_user_query'
 require 'test_question_query'
 require 'test_common'
+require 'test_version'
+require 'test_api'
+require 'test_integration'

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yanapi
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: 
-  version: 0.1.1
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Andrei Beliankou
@@ -10,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 +02:00
-default_executable: 
+date: 2011-08-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -21,6 +25,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -32,6 +39,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -42,8 +52,9 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README
 - LICENSE
+- CHANGELOG
 files: 
 - lib/yanapi/error.rb
 - lib/yanapi/user_query.rb
@@ -52,32 +63,43 @@ files:
 - lib/yanapi/common.rb
 - lib/yanapi/category_query.rb
 - lib/yanapi/version.rb
+- lib/yanapi/api.rb
 - lib/yanapi/query.rb
 - lib/yanapi.rb
-- README.rdoc
-- LICENSE
-- Rakefile
 - README
+- LICENSE
+- CHANGELOG
 - test/test_yanapi.rb
+- test/test_api.rb
 - test/test_user_query.rb
+- test/test_integration.rb
+- test/integration_test_data/test_question_query.txt
+- test/integration_test_data/test_category_query.txt
+- test/integration_test_data/test_empty_response.txt
+- test/integration_test_data/test_term_query.txt
+- test/integration_test_data/test_user_query.txt
 - test/test_query.rb
 - test/test_category_query.rb
 - test/test_term_query.rb
+- test/test_version.rb
+- test/test_helper.rb
 - test/test_common.rb
 - test/test_question_query.rb
+- test/data/code_400.txt
 - test/data/bad_xml.txt
+- test/data/code_503.txt
 - test/data/empty_result.txt
 - test/data/error_code.txt
 - test/data/response_with_error.txt
 - test/data/successfull_response.txt
-has_rdoc: true
+- test/data/code_403.txt
 homepage: http://www.uni-trier.de/index.php?id=34451
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - -m
-- README.rdoc
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -85,25 +107,49 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 31
+      segments: 
+      - 1
+      - 8
       version: "1.8"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: yanapi
-rubygems_version: 1.5.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: YANAPI is an API for Yahoo! Answers web services.
 test_files: 
+- test/test_yanapi.rb
+- test/test_api.rb
+- test/test_user_query.rb
+- test/test_integration.rb
+- test/integration_test_data/test_question_query.txt
+- test/integration_test_data/test_category_query.txt
+- test/integration_test_data/test_empty_response.txt
+- test/integration_test_data/test_term_query.txt
+- test/integration_test_data/test_user_query.txt
+- test/test_query.rb
 - test/test_category_query.rb
+- test/test_term_query.rb
+- test/test_version.rb
+- test/test_helper.rb
 - test/test_common.rb
-- test/test_query.rb
 - test/test_question_query.rb
-- test/test_term_query.rb
-- test/test_user_query.rb
-- test/test_yanapi.rb
+- test/data/code_400.txt
+- test/data/bad_xml.txt
+- test/data/code_503.txt
+- test/data/empty_result.txt
+- test/data/error_code.txt
+- test/data/response_with_error.txt
+- test/data/successfull_response.txt
+- test/data/code_403.txt