yanapi 0.0.1

data/test/test_query.rb

@@ -0,0 +1,112 @@
+require 'test/unit'
+require 'yanapi/query'
+require 'fakeweb'
+
+class TestQuery < Test::Unit::TestCase
+  def setup
+    @params = {:appid => 'MyID', :method => 'questionSearch'}
+  end
+  def teardown
+  end
+
+  def test_public_methods
+    q = YANAPI::Query.new(@params)
+    assert_respond_to(q, :get)
+  end
+
+  def test_constants
+    assert_equal('http://answers.yahooapis.com', YANAPI::Query::HOST)
+    assert_equal('AnswersService', YANAPI::Query::SERVICE)
+    assert_equal('V1', YANAPI::Query::SERVICE_VERSION)
+  end
+
+  def test_missing_appid
+    @params.delete(:appid)
+    assert_raises(YANAPI::Error) do
+      q = YANAPI::Query.new(@params)
+    end
+  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
+  end
+
+  # :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
+  end
+
+  # :output may be missing
+  def test_missing_output
+    @params.delete(:output)
+    q = YANAPI::Query.new(@params)
+    assert_equal('xml', q.output)
+  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
+  end
+  
+  # :callback may be used only with :output => 'json'
+  def test_parameters_clash
+    # the default value 'xml' is set internally during the initialization
+    # we may delete the input value
+    @params.delete(:output)
+    @params[:callback] = 'wrapper'
+    assert_raises(YANAPI::Error) do
+      q = YANAPI::Query.new(@params)
+    end
+  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)}
+  end
+
+  # we can get an empty response set with valid xml structure
+  # and the status code 200 HTTP OK
+  # but we should declene this
+  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}
+  end
+
+  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}
+
+    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}
+  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}
+  end
+end

data/test/test_term_query.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'yanapi/term_query'
+require 'fakeweb'
+
+class TestTermQuery < Test::Unit::TestCase
+  def setup
+    @params = {
+      :query => 'Auto',
+      :appid => 'YahooDemo'
+    }
+  end
+  def teardown
+  end
+
+  # questionSearch needs a unique :query
+  def test_missing_query
+    @params.delete(:query)
+    assert_raises(YANAPI::Error) do
+      q = YANAPI::TermQuery.new(@params)
+    end
+  end
+
+  # parameters can be only: query|search_in|category_query|category_name|
+  # region|date_range|sort|appid|type|start|results|output|callback
+  def test_parameters_semantics
+    assert_nothing_raised {q = YANAPI::TermQuery.new(@params)}
+    @params[:trash] = 'trash'
+    assert_raises(YANAPI::Error) do
+      q = YANAPI::TermQuery.new(@params)
+    end
+  end
+
+  # validates presense of query
+  # validates uniqueness of query
+  # validates the range of :start
+  # validates the range of :results
+  # validates the :region semantics
+  # validates the :type uniqueness and semantics
+  # validates uniqueness of the :date_range and its semantics
+  # validates semantics of all possible parameter names
+
+  def test_start_range
+  end
+
+  def test_result_range
+  end
+
+  def test_region_semantics
+   
+  end
+
+  # ?? not sure
+  def test_type_uniqueness
+  end
+
+  def test_type_semantics
+  end
+
+  def test_date_uniqueness
+  end
+
+  def test_date_semantics
+  end
+end #TestTermQuery

data/yanapi.gemspec

@@ -0,0 +1,23 @@
+lib_path = File.expand_path('../lib', __FILE__) # strange??
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'yanapi/version'
+
+Gem::Specification.new do |s|
+  s.name = "yanapi"
+  s.summary = 'YANAPI is an API for Yahoo! Answers web services.' # it is the description for 'gem list -d'
+  s.description = 'YANAPI is a programmatic API for Yahoo! Answers web services.It enables you to search for questions using key words, user IDs, category names and IDs and a pricise ID of a question. The output is provided in the xml format as well as json, php and rss.' # it appears on the RubyGems page
+  s.rubyforge_project = "yanapi"
+  s.version = YANAPI::VERSION
+  s.author = "Andrei Beliankou"
+  s.email = "a.belenkow@uni-trier.de"
+  s.homepage = "http://www.uni-trier.de/index.php?id=34451"
+#  s.require_paths = 'lib' # it is the default value, why to use?
+  s.add_dependency('nokogiri')
+  s.add_development_dependency('fakeweb')
+  s.rdoc_options = ["-m", "README.rdoc"]
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.8.7'
+  s.files = Dir['**/*']
+  s.test_files = `ls test/test_*.rb`.split("\n")
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: yanapi
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrei Beliankou
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-26 23:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: YANAPI is a programmatic API for Yahoo! Answers web services.It enables you to search for questions using key words, user IDs, category names and IDs and a pricise ID of a question. The output is provided in the xml format as well as json, php and rss.
+email: a.belenkow@uni-trier.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- yanapi.gemspec
+- test/test_query.rb
+- test/test_term_query.rb
+- test/data/bad_xml.txt
+- test/data/empty_result.txt
+- test/data/error_code.txt
+- test/data/response_with_error.txt
+- test/data/successfull_response.txt
+- LICENSE
+- Rakefile
+- README
+- lib/yanapi/error.rb
+- lib/yanapi/user_query.rb
+- lib/yanapi/question_query.rb
+- lib/yanapi/term_query.rb
+- lib/yanapi/category_query.rb
+- lib/yanapi/version.rb
+- lib/yanapi/query.rb
+- lib/yanapi.rb
+has_rdoc: true
+homepage: http://www.uni-trier.de/index.php?id=34451
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- -m
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+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.3.7
+signing_key: 
+specification_version: 3
+summary: YANAPI is an API for Yahoo! Answers web services.
+test_files: 
+- test/test_query.rb
+- test/test_term_query.rb