yanapi 0.0.1 → 0.1.0

data/Rakefile

@@ -10,5 +10,5 @@ SRC = FileList['**/*.rb']
 CLOBBER.include('doc', '**/*.html', '**/*.gem')
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList.new('test/**/test_*.rb')
+  t.test_files = FileList.new('test/test_yanapi.rb')
 end

data/lib/yanapi/category_query.rb

@@ -1,10 +1,34 @@
+
 module YANAPI
   
   class CategoryQuery < Query
+
+    include Common
     
-    def initialize(*)
-      raise NotImplementedError, 'CategoryQuery is still not implemented!'
+    def initialize(params)
+      params[:method] = 'getByCategory'
+      super
     end
-    
+
+    private
+    # specific checks for CategoryQuery
+    #--
+    def check_params(params)
+      unless params[:category_id] || params[:category_name] 
+        raise Error, "Category is missing!"
+      end
+
+      allowed = %w{category_id category_name region
+                   date_range sort appid type start
+                   results output callback method
+                  }
+
+      # in the module Common
+      check_semantics(allowed, params)
+      basic_check(params)
+
+      super
+    end
+
   end # CategoryQuery
 end # module

data/lib/yanapi/common.rb

@@ -0,0 +1,17 @@
+module YANAPI
+  module Common
+    private
+    def basic_check(params)
+      # fake
+    end
+
+    def check_semantics(allowed, actual)
+      actual.each_key do |param|
+        unless allowed.include?(param.to_s)
+          raise Error, "The parameter #{param} is not allowed!"
+        end
+      end
+    end
+    
+  end # Common
+end # YANAPI

data/lib/yanapi/query.rb

@@ -21,8 +21,8 @@ module YANAPI
       
       # it is a bad idea to alter the parameters hash
       # that's why we duplicate the parameters
-      checked_params = check_params(params.dup)
-      @url = build_url(checked_params)
+      check_params(params)
+      @url = build_url(params.dup)
             
       $stderr.puts 'Full url:', @url if $DEBUG
     end
@@ -130,9 +130,8 @@ module YANAPI
       end
 
       if params[:output] != 'json' && params[:callback]
-        raise Error, "The output type #{@output} is not supported!"
+        raise Error, "You may not use callback with output type: #{@output}!"
       end
-      return params
     end
 
     # proves the presense of an error

data/lib/yanapi/term_query.rb

@@ -2,27 +2,31 @@ module YANAPI
 
   class TermQuery < Query
 
+    include Common
+    
     def initialize(params)
-
       params[:method] = 'questionSearch'
       super
     end
 
     private
-    # specific checks for 
-    #--
     # 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 check_params(params)
       unless params[:query]
         raise Error, "Query is missing!"
       end
+
+      allowed = %w{query search_in category_id
+                   category_name region date_range
+                   sort appid type start results
+                   output callback method
+                  }
+
+      # in the module Common
+      check_semantics(allowed, params)
+      basic_check(params)
+      
       super
     end
 

data/lib/yanapi/version.rb

@@ -1,3 +1,3 @@
 module YANAPI
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/yanapi.rb

@@ -1,6 +1,8 @@
+require 'yanapi/common'
 require 'yanapi/query'
 require 'yanapi/term_query'
 require 'yanapi/question_query'
 require 'yanapi/user_query'
 require 'yanapi/category_query'
 require 'yanapi/version'
+

data/test/test_category_query.rb

@@ -0,0 +1,61 @@
+require 'test/unit'
+require 'yanapi'
+require 'fakeweb'
+
+class TestCategoryQuery < Test::Unit::TestCase
+  def setup
+    @params = {
+      :category_name => 'Ausgehen',
+      :appid => 'YahooDemo'
+    }
+  end
+  def teardown
+  end
+
+  # getByCategory (CategorySearch) needs either :category_id or :category_name
+  def test_missing_category
+    @params.delete(:category_name)
+    @params.delete(:category_id)
+    assert_raises(YANAPI::Error) {YANAPI::CategoryQuery.new(@params)}
+  end
+
+  # parameters can be only: category_name|category_name|
+  # region|date_range|sort|appid|type|start|results|output|callback
+  def test_parameters_semantics
+    assert_nothing_raised {YANAPI::CategoryQuery.new(@params)}
+    @params[:trash] = 'trash'
+    assert_raises(YANAPI::Error) {YANAPI::CategoryQuery.new(@params)}
+  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/test/test_common.rb

@@ -0,0 +1,40 @@
+require 'test/unit'
+require 'yanapi'
+
+class TestCommon < Test::Unit::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+
+  # 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

data/test/test_query.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'yanapi/query'
+require 'yanapi'
 require 'fakeweb'
 
 class TestQuery < Test::Unit::TestCase
@@ -18,6 +18,7 @@ class TestQuery < Test::Unit::TestCase
     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
 
   def test_missing_appid
@@ -59,22 +60,16 @@ class TestQuery < Test::Unit::TestCase
     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)}
+    @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

data/test/test_question_query.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'yanapi'
+
+class TestQuestionQuery < Test::Unit::TestCase
+  def setup
+  end
+  def teardown
+  end
+
+end #TestQuestionQuery

data/test/test_term_query.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'yanapi/term_query'
+require 'yanapi'
 require 'fakeweb'
 
 class TestTermQuery < Test::Unit::TestCase
@@ -16,14 +16,14 @@ class TestTermQuery < Test::Unit::TestCase
   def test_missing_query
     @params.delete(:query)
     assert_raises(YANAPI::Error) do
-      q = YANAPI::TermQuery.new(@params)
+      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
+  # 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
-    assert_nothing_raised {q = YANAPI::TermQuery.new(@params)}
+    assert_nothing_raised {YANAPI::TermQuery.new(@params)}
     @params[:trash] = 'trash'
     assert_raises(YANAPI::Error) do
       q = YANAPI::TermQuery.new(@params)
@@ -32,33 +32,5 @@ class TestTermQuery < Test::Unit::TestCase
 
   # 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/test/test_user_query.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'yanapi'
+
+class TestUserQuery < Test::Unit::TestCase
+  def setup
+  end
+  def teardown
+  end
+end #TestUserQuery

data/test/test_yanapi.rb

@@ -0,0 +1,8 @@
+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'

data/yanapi.gemspec

@@ -10,14 +10,13 @@ Gem::Specification.new do |s|
   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.homepage = "http://www.uni-trier.de/index.php?id=34451" # move on qa.uni
+  s.add_runtime_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.platform = Gem::Platform::RUBY # how to run it on JRuby?
+  s.required_ruby_version = '>=1.8' # is it a correct notation?
   s.files = Dir['**/*']
   s.test_files = `ls test/test_*.rb`.split("\n")
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: yanapi
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
 - Andrei Beliankou
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 23:00:00 +01:00
+date: 2011-04-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -40,9 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -58,8 +47,13 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - yanapi.gemspec
+- test/test_yanapi.rb
+- test/test_user_query.rb
 - test/test_query.rb
+- test/test_category_query.rb
 - test/test_term_query.rb
+- test/test_common.rb
+- test/test_question_query.rb
 - test/data/bad_xml.txt
 - test/data/empty_result.txt
 - test/data/error_code.txt
@@ -72,6 +66,7 @@ files:
 - lib/yanapi/user_query.rb
 - lib/yanapi/question_query.rb
 - lib/yanapi/term_query.rb
+- lib/yanapi/common.rb
 - lib/yanapi/category_query.rb
 - lib/yanapi/version.rb
 - lib/yanapi/query.rb
@@ -91,28 +86,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
-      version: 1.8.7
+      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.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: YANAPI is an API for Yahoo! Answers web services.
 test_files: 
+- test/test_category_query.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