yanapi 0.3.3 → 0.4.0

data/CHANGELOG

@@ -1,4 +1,8 @@
 == COMPLETED
+=== 0.4.0
+Implemented multivalued parameters as Arrays. You can now search in many regions
+and categories simultaneously.
+Enhanced and updated the documentation.
 === 0.3.3
 Added a configuration file for Yard, the documentation should be compatible
 with {RubyDoc.info}[http://www.rubydoc.info] now.
@@ -21,16 +25,19 @@ Initial release of the lib.
 
 
 == PLANNED
-=== 0.4.0
-Enhance the documentation.
-
-Implement multivalue parameters.
 === 0.5.0
 Implement semantic checks for all query types.
 
 Enhance the documentation.
 === 0.6.0
+Implement the output formats <php>, <json>, <rss>.
+
+Update the documentation.
 === 0.7.0
 === 0.8.0
 === 0.9.0
 === 1.0.0
+Implement posting and tracking of questions.
+
+Update the documentations.
+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Andrei Beliankou, University of Trier, Germany
+Copyright (c) 2011 Andrei Beliankou
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -1,8 +1,10 @@
 = YANAPI
 
 * {RubyGems}[http://rubygems.org/gems/yanapi]
-* Developers {Homepage}[http://www.uni-trier.de/index.php?id=24140]
+* {Bug Tracker}[https://github.com/arbox/yanapi/issues]
 * {YANAPI Project Page}[http://yanapi.rubyforge.org/]
+* Developers {Homepage}[http://www.bu.chsta.be]
+
 
 == DESCRIPTION
 
@@ -62,11 +64,12 @@ A small example shall demostrate the usage:
       :search_in => 'question',
       :type => 'resolved',
       :results => 2,
-      :output => 'xml'
+      :output => 'xml',
+      :region => ['us', 'de']
     }
   }
   api = YANAPI::API.new(params)
-  api.get # => default xml structure
+  api.get # => String
 
 
 For details on particular keys and defaults see {the official description}[http://developer.yahoo.com/answers/] and the RDoc documentation in this library.

data/lib/yanapi/query.rb

@@ -12,6 +12,7 @@ module YANAPI
     SERVICE = 'AnswersService'
     SERVICE_VERSION = 'V1'
     VALID_PARAMS = [:appid, :output, :callback]
+    MULTIVALUED_PARAMS = [:region, :category_id, :category_name]
     REQUIRED_PARAMS = [:appid]
     VALID_OUTPUT_FORMATS = [nil, 'xml', 'php', 'rss', 'json']
     
@@ -65,14 +66,22 @@ module YANAPI
         "Output type #{params[:output]} is incompatible with <:callback>!"
       end
 
-      # It accepts only unique values for every parameter,
-      # they can be Strings or Numbers.
-      # We do not support multiple values for categories and regions yet.
-      # Multiple values will be provided as Arrays:
-      # :category_id => [123, 456, 789].
+      # It accepts only unique values for every parameter other than:
+      # * :category_id;
+      # * :category_name;
+      # * :region.
+      # They can be strings, arrays or numbers:
+      #   :category_id => [123, 456, 789].
       params.each_pair do |k, v|
-        unless (v.kind_of?(String) || v.kind_of?(Fixnum))
-          fail UserError, "The value <:#{k}> is not unique!"
+        unless (v.kind_of?(String) || v.kind_of?(Fixnum) || v.kind_of?(Array))
+          fail(UserError,
+               "The value type <#{v.class}> for the key <:#{k}> is wrong!")
+        end
+        
+        if v.kind_of?(Array)
+          unless MULTIVALUED_PARAMS.include?(k)
+            fail UserError, "The value of <:#{k}> must, but is not unique!"
+          end
         end
       end
 

data/lib/yanapi/version.rb

@@ -1,3 +1,3 @@
 module YANAPI
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/test/test_query.rb

@@ -31,7 +31,8 @@ class TestQuery < Test::Unit::TestCase
                          :SERVICE_VERSION,
                          :VALID_PARAMS,
                          :REQUIRED_PARAMS,
-                         :VALID_OUTPUT_FORMATS
+                         :VALID_OUTPUT_FORMATS,
+                         :MULTIVALUED_PARAMS
                         ]
     defined_constants.each do |const|
       assert(YANAPI::Query.const_defined?(const))
@@ -47,6 +48,14 @@ class TestQuery < Test::Unit::TestCase
 
   ## Interface tests
 
+  # It should reject any key with values other than <Fixnum>, <String>, <Array>.
+  def test_type_of_value
+    @params[:query_params][:region] = {'a'=>1}
+    e = assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
+    assert_match(/The value type <Hash> for the key <:region> is wrong!/,
+                 e.message)
+  end
+  
   # It should reject the input hash without <:appid> parameter.
   def test_missing_appid
     @params[:query_params].delete(:appid)
@@ -86,10 +95,11 @@ class TestQuery < Test::Unit::TestCase
     assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
   end
 
-  # It should reject not unique values.
+  # It should reject not unique values for not predefined parameters.
   def test_uniqueness_of_values
-    @params[:query_params][:category_id] = ['123', 345]
-    assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
+    @params[:query_params][:appid] = ['123', 345]
+    e = assert_raises(YANAPI::UserError) { YANAPI::Query.new(@params) }
+    assert_match(/The value of <:appid> must, but is not unique!/, e.message)
   end
 
   
@@ -98,12 +108,16 @@ class TestQuery < Test::Unit::TestCase
   # It should create well formed urls.
   def test_url_form
     q = YANAPI::Query.new(@params)
-    print q.inspect
     etalon_url = 'http://answers.yahooapis.com/AnswersService/V1/questionSearch?appid=YahooDemo&output=xml&query=Haus'
     real_url = q.instance_variable_get(:@url).to_s
     assert_equal(etalon_url, real_url)
 
-    warn "\nWARNING! Expand this test for multivalue parameters!\n"
+    @params[:query_params][:region] = ['us', 'de']
+    q = YANAPI::Query.new(@params)
+    etalon_url = 'http://answers.yahooapis.com/AnswersService/V1/questionSearch?appid=YahooDemo&output=xml&query=Haus&region=de&region=us'
+    real_url = q.instance_variable_get(:@url).to_s
+    assert_equal(etalon_url, real_url)
+    
   end
 
   # It should return <nil> if the server response contains

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yanapi
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Andrei Beliankou
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-10 00:00:00 Z
+date: 2011-08-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri