uwn-api 0.0.1

data/lib/uwn/api/statement.rb

@@ -0,0 +1,136 @@
+module Uwn
+  module Api
+    
+    # Wrapper class for UWN Statement equivalent (with some abstracter function)
+    class Statement
+
+      attr_accessor :parent, :statements
+
+      # Statement constructor
+      def initialize options={}
+        self.parent = options[:parent] if options.include? :parent
+        @object = options[:object] if options.include? :object
+        self.statements = []
+        @parent_language = Util.parent_root(self).language
+      end
+
+      # term name as a string
+      def term_str
+        @object.get_object.get_term_str
+      end
+
+      # language of object
+      def language
+        @object.get_object.get_term_language
+      end
+
+      # word lexcat (noun, verb, adj etc.)
+      def lexcat
+        match = @object.get_object.to_s.match(/lexcat:([a-z]+)/)
+        return match[1] unless match.nil?
+        nil
+      end
+
+      # match current to the Meaning (root object) language
+      def is_synonym?
+        @object.get_object.get_term_language == @parent_language
+      end
+
+      # is the current object referenced to a synset?
+      def has_synset?
+        self.synset.is_a? String
+      end
+
+      def is_lexical_category?
+        @object.get_predicate.to_s == "rel:lexical_category"
+      end
+
+      def is_subclass?
+        @object.get_predicate.to_s == "rel:subclass"
+      end
+
+      # subject object
+      def subject
+        @object.get_subject
+      end
+
+      # object of object (raw object)
+      def object
+        @object.get_object
+      end
+
+      # predicate object (tells something about the object)
+      def predicate
+        @object.get_predicate
+      end
+
+      # weight of the link
+      def weight
+        @object.get_weight
+      end
+
+      def to_s
+        @object.get_subject.to_s
+      end
+
+      # synset for current statement (not tested, depends on predicate!)
+      def synset
+        unless @object.nil?
+          os = @object.get_object.to_s
+          return os unless os.match(/([s][\/][n]){1}[0-9]+/).nil?
+          su = @object.get_subject.to_s
+          return su unless su.match(/([s][\/][n]){1}[0-9]+/).nil?
+        end
+      end
+
+      # get filtered categories (word types ex. verb, noun) from synset
+      def lexical_categories
+        self.predicate_match "rel:lexical_category"
+      end
+
+      # get filtered lexicalizations (translations) from synset
+      def lexicalizations
+        self.predicate_match "rel:lexicalization"
+      end
+
+      # get filtered synonyms from synset
+      def synonyms
+        sts = self.predicate_match "rel:lexicalization"
+        sts.reject{|t| !t.is_synonym? }
+      end
+
+      # get filtered subclasses from synset
+      def subclasses
+        self.predicate_match "rel:subclass"
+      end
+
+      # get filtered glosses from synset
+      def glosses
+        self.predicate_match "rel:has_gloss"
+      end
+
+      # get raw synsets
+      def synsets
+        self.predicate_match
+      end
+
+      protected
+
+      # get predicates (with or without name filter)
+      def predicate_match predicate_name = nil
+        sts = self.lookup_synset self.synset
+        sts.map!{|s| Statement.new(parent: self, object: s) }
+        return sts.reject{|t| t.predicate.to_s != predicate_name} unless predicate_name.nil?
+        sts
+      end
+
+      # get unique synsets from uwn
+      def lookup_synset synset
+        root = Util.parent_root self
+        root.connect.statements(synset)
+      end
+
+    end
+
+  end
+end

data/lib/uwn/api/util.rb

@@ -0,0 +1,22 @@
+module Uwn
+  module Api
+    
+    class Util
+
+      class << self
+
+        def parent_root current_object
+          current = current_object
+          while true do
+            break if current.parent.nil?
+            current = current.parent
+          end
+          current
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/uwn/api/version.rb

@@ -0,0 +1,5 @@
+module Uwn
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/lib/uwn/deps/lgpl-3.0.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/lib/uwn/deps/plugins.txt

@@ -0,0 +1,11 @@
+UWN plugin data missing!!!!!
+
+It's too large for the repository, download it instead from the source below:
+
+http://www.mpi-inf.mpg.de/yago-naga/uwn/downloads.html
+http://www.mpi-inf.mpg.de/yago-naga/uwn/uwn.zip
+
+Else, use it's online equivalent:
+
+http://www.mpi-inf.mpg.de/yago-naga/uwn/downloads.html
+http://www.mpi-inf.mpg.de/yago-naga/uwn/uwnapi.zip

data/lib/uwn/deps/plugins/readme.txt

@@ -0,0 +1,30 @@
+Princeton WordNet Plugin for UWN API
+http://www.lexvo.org/uwn/api/
+
+
+== DESCRIPTION ==
+
+This plugin provides access to the Princeton WordNet 3.0 data
+using the UWN API. It can be used in conjunction with other
+multilingual plugins provided on the UWN API website.
+
+
+== CREDITS AND LICENSE ==
+
+WordNet 3.0: Copyright 2006 by Princeton University.
+See LICENSE for more details.
+
+For more information about WordNet and to download WordNet 3.0
+in its original form, please visit: 
+http://wordnet.princeton.edu/
+
+For academic research, consider consulting and citing the WordNet book:
+Christiane Fellbaum (1998, ed.). WordNet: An Electronic Lexical Database. 
+Cambridge, MA: MIT Press.
+
+For additionally citing this plugin more specifically, the following
+reference can be used:
+Gerard de Melo and Gerhard Weikum (2012).
+UWN: A Large Multilingual Lexical Knowledge Base
+In: Proceedings of ACL 2012 (Demonstration Session).
+

data/lib/uwn/deps/plugins/uwn.plg

@@ -0,0 +1 @@
+org.lexvo.uwn.internal.PluginStd uwn.dat

data/lib/uwn/deps/plugins/wordnet.plg

@@ -0,0 +1 @@
+org.lexvo.uwn.internal.PluginStd wordnet.dat

data/lib/uwn/deps/readme.txt

@@ -0,0 +1,21 @@
+UWN API Version 1.0
+2012-07-02
+
+This API provides access to semantic knowledge provided by different types
+of plug-ins. Please refer to
+  http://www.lexvo.org/uwn/api/
+for more information about the API and a list of plugins that can be used
+with this API. Plugins should be placed in the plugins/ subdirectory in
+unzipped form.
+
+License: LGPL 3.0
+The LGPL license allows for non-commercial as well as commercial use.
+Note however that individual plugins may be subject to different licenses.
+
+For academic use, please cite:
+Gerard de Melo and Gerhard Weikum (2009). Towards a Universal Wordnet by Learning from Combined Evidence.
+In: Proc. 18th ACM Conference on Information and Knowledge Management (CIKM 2009),
+Hong Kong, China. ACM, New York, USA.
+
+Copyright (c) 2012 Gerard de Melo
+http://www.lexvo.org/gdm/

data/test/unit/uwn_connect.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/uwn/api")
+
+
+#
+# Test the error handling from uwn
+#
+
+class UwnConnect < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_default_options
+    begin
+      uwn = Uwn::Api::Connect.new
+      assert true
+    rescue Exception => e
+      assert false, "should not get an exception"
+    end
+  end
+
+  def test_correct_path_option
+    begin
+      uwn = Uwn::Api::Connect.new plugins_path: Uwn::Api::Connect::DEFAULT_PATH
+      assert true
+    rescue Exception => e
+      assert false, "should not get an exception" 
+    end
+  end
+
+  def test_incorrect_path_option
+    begin
+      uwn = Uwn::Api::Connect.new plugins_path: "/non/existing/path/to/plugins"
+    rescue Exception => e
+      assert e.message == "The plug-in directory '/non/existing/path/to/plugins' does not exist!"
+    end
+  end
+
+  def test_word_present
+    uwn = Uwn::Api::Connect.new
+    assert uwn.is_a?(Uwn::Api::Connect), "expected Connect object"
+    begin
+      meaning = uwn.meaning("gem", "eng")
+      assert true
+    rescue Exception => e
+      assert false, "word should be found"
+    end
+  end
+
+
+end