wlapi 0.8.3 → 0.8.4

data/CHANGELOG.rdoc

@@ -1,4 +1,6 @@
 == COMPLETED
+=== 0.8.4
+Imlemented the <tt>API#crossword</tt> method for the prefix/suffix search.
 === 0.8.3
 Implemented a simple error handling strategy, it is possible to intercept
 the <tt>WLAPI::Error</tt> which covers all error types.
@@ -22,11 +24,15 @@ Initial release of the lib.
 
 
 == PLANNED
-=== 0.8.4
-Test the lib against mri, rbx, jruby, win rubies.
+
+
 === 0.8.5
+Test the lib against mri, rbx, jruby, win rubies.
 Introduce +nokogiri+ for parsing responses.
 === 0.8.6
+Implement <ngrams> and <ngram_references>.
+
+Refine semantic checks for two parameter methods.
 === 0.8.7
 === 0.8.8
 === 0.8.9

data/README.rdoc

@@ -5,6 +5,7 @@
 * {WLAPI Project Page}[http://bu.chsta.be/projects/wlapi/]
 * {Source Code}[https://github.com/arbox/wlapi]
 * {Bug Tracker}[https://github.com/arbox/wlapi/issues]
+* {Mailing List}[http://groups.google.com/group/wlapi]
 
 == DESCRIPTION
 WLAPI is a programmatic API for web services provided by the project
@@ -21,6 +22,7 @@ You can use the following search methods:
 * baseform;
 * cooccurrences;
 * cooccurrences_all;
+* crossword;
 * domain;
 * experimental_synonyms;
 * frequencies;
@@ -34,7 +36,12 @@ You can use the following search methods:
 * thesaurus;
 * wordforms.
 
-There are three additional services by Wortschatz Leipzig: Kreuzworträtsel, MARS and Kookurrenzschnitt. They will not be implemented.
+The services <tt>NGrams</tt> and <tt>NGramReferences</tt> are under
+development and will be available soon.
+
+There are two additional services by Wortschatz Leipzig: MARS and
+Kookurrenzschnitt. They will not be implemented due to internal restrictions
+of the service provider.
 
 == INSTALLATION
 WLAPI is provided as a .gem package. Simply install it via
@@ -84,11 +91,11 @@ Then it fetches a response from a remote server, it can result
 in a <tt>WLAPI::ExternalError</tt>. In most cases it will be a simple wrapper
 around other errors, e.g. <tt>Savon::SOAP::Fault</tt>.
 
-All of them are subcalsses of <tt>YANAPI::Error</tt> which is in turn a subclass
+All of them are subcalsses of <tt>WLAPI::Error</tt> which is in turn a subclass
 of the standard +RuntimeError+.
 
-If you want to intercept any and every exception thrown by YANAPI simply rescue
-<tt>YANAPI::Error</tt>.
+If you want to intercept any and every exception thrown by WLAPI simply rescue
+<tt>WLAPI::Error</tt>.
 
 
 == SUPPORT

data/lib/wlapi/api.rb

@@ -43,8 +43,11 @@ module WLAPI
         :LeftNeighbours => "#{endpoint}/LeftNeighbours",
         :RightNeighbours => "#{endpoint}/RightNeighbours",
         :Sentences => "#{endpoint}/Sentences",
-        :Cooccurrences => "#{endpoint}/Cooccurrences"
-        # no MARSService and Kreuzwortrraetsel
+        :Cooccurrences => "#{endpoint}/Cooccurrences",
+        :Kreuzwortraetsel => "#{endpoint}/Kreuzwortraetsel",
+        :NGrams => "#{endpoint}/NGrams",
+        :NGramReferences => "#{endpoint}/NGramReferences"
+        # no MARSService
       }
       
       # cl short for client.
@@ -116,7 +119,7 @@ module WLAPI
       
       get_answer(answer)
     end
-    
+
     ## Two parameter methods.
     #############################################################################
     
@@ -239,6 +242,13 @@ module WLAPI
       
       get_answer(answer)
     end
+
+    #
+    def ngrams(pattern, limit = 10)
+    end
+    #
+    def ngram_references(pattern, limit = 10)
+    end
     
     ## Three parameter methods.
     #############################################################################
@@ -325,6 +335,31 @@ module WLAPI
       
       get_answer(answer)
     end    
+
+    # Attempts to find suitable words given a pattern as word parameter, 
+    # a word length and the number of words to find at max (limit),
+    # e.g. <tt>API#crossword('%uto', 4)</tt> would return find 24 results and
+    # return them as an array: <tt>[Auto, Auto, ...]</tt>:
+    #   api.crossword('%uto') => ["Auto", "Auto", ...]
+    # SQL like syntax is used for pattern (<tt>%</tt> for an arbitrary string, 
+    # <tt>_</tt> for a single character).
+    #
+    # Note: Umlaute will count as one character
+    #
+    #--
+    # Let's keep all public method names in English:
+    # kreuzwortraetsel => crossword.
+    def crossword(word, word_length, limit = 10)
+      check_params(word, word_length, limit)
+
+      arg1 = ['Wort', word ]
+      arg2 = ['Wortlaenge', word_length]
+      arg3 = ['Limit', limit]
+      answer = query(@cl_Kreuzwortraetsel, arg1, arg2, arg3)
+      
+      get_answer(answer)
+    end
+    
     private
     
     # Main query method, it invokes the soap engine.

data/lib/wlapi/version.rb

@@ -1,3 +1,3 @@
 module WLAPI
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
 end

data/test/test_api.rb

@@ -5,9 +5,12 @@ require 'wlapi'
 
 class TestApi < Test::Unit::TestCase
 
-  METHODS = [:baseform,
-             :domain,
-             :wordforms,
+  ONE_PAR = [:frequencies,
+             :baseform,
+             :domain
+            ]
+
+  TWO_PAR = [:wordforms,
              :thesaurus,
              :synonyms,
              :sentences,
@@ -15,35 +18,20 @@ class TestApi < Test::Unit::TestCase
              :right_neighbours,
              :similarity,
              :experimental_synonyms,
-             :right_collocation_finder,
-             :left_collocation_finder,
-             :cooccurrences,
-             :cooccurrences_all,
-             :intersection,
-             :frequencies
+             :ngrams,
+             :ngram_references
             ]
 
-  ONE_PAR = [:frequencies,
-             :baseform,
-             :domain
-            ]
-  
   THREE_PAR = [:right_collocation_finder,
                :left_collocation_finder,
                :cooccurrences,
                :cooccurrences_all,
-               :intersection
+               :intersection,
+               :crossword
               ]
 
-  TWO_PAR = [:wordforms,
-             :thesaurus,
-             :synonyms,
-             :sentences,
-             :left_neighbours,
-             :right_neighbours,
-             :similarity,
-             :experimental_synonyms
-            ]
+  METHODS = ONE_PAR + TWO_PAR + THREE_PAR
+
   def setup
     @api = WLAPI::API.new
     @word = 'Stuhl'
@@ -88,15 +76,16 @@ class TestApi < Test::Unit::TestCase
     assert_raise(WLAPI::UserError) do
       ONE_PAR.each { |m| @api.send(m, 1) }
     end
-=begin
+
     assert_raise(WLAPI::UserError) do
-      TWO_PAR.each { |m| @api.send(m, 'Haus', 1) }
+      TWO_PAR.each { |m| @api.send(m, 'Haus', [:a]) }
     end
-=end  
+
     assert_raise(WLAPI::UserError) do
       THREE_PAR.each { |m| @api.send(m, 3, 3.5, 'a') }
     end
-  end  
+  end
+  
   # One parameter.
   def test_frequencies
     response = @api.frequencies('Haus')
@@ -258,7 +247,7 @@ class TestApi < Test::Unit::TestCase
   def test_cooccurrences_all
     begin
       @api.cooccurrences_all('Haus', 10000)
-    rescue RuntimeError => e
+    rescue WLAPI::ExternalError => e
       assert_match(/You're not allowed to access this service./, e.message)
     end
     # Not possible to test without access credential.
@@ -267,13 +256,17 @@ class TestApi < Test::Unit::TestCase
   def test_intersection
     begin
       @api.intersection('Haus', 'Brot', 1)
-    rescue RuntimeError => e
+    rescue WLAPI::ExternalError => e
       assert_match(/You're not allowed to access this service./, e.message)
     end
     # Not possible to test without access credentials.
   end
-
-
+  
+  def test_crossword
+    response = @api.crossword('%uto', 4, 200)
+    assert(response.length == 24)
+  end
+  
 ################## HELPER METHODS ###############################################
   def check_input(*args)
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wlapi
 version: !ruby/object:Gem::Version 
-  hash: 57
+  hash: 55
   prerelease: 
   segments: 
   - 0
   - 8
-  - 3
-  version: 0.8.3
+  - 4
+  version: 0.8.4
 platform: ruby
 authors: 
 - Andrei Beliankou
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-16 00:00:00 Z
+date: 2012-01-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: savon