opener-ned 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f8e7e7e81902565ee4114306df8d65bcd309aea
-  data.tar.gz: d9e7e2c4794392f6022ee7920c8218db4b0e215b
+  metadata.gz: 0b3f47e84d065fd802d47943ae7a506a06d6b6ba
+  data.tar.gz: 88c4921c36cf5b5c5e8660cc966a5c0ae412dc5a
 SHA512:
-  metadata.gz: 9b6990d7b5f33a154530298273406745ecefd326709c954ca4a6f7716f76a569a3ad8e0494e844a000988b1a1d816338dbfc09d1466221a31dbc5d9169333c57
-  data.tar.gz: a5680d80805c2999ca5da6bd8f8bf397cffeffebb190d5f410585e637a82f25de00912b9459c92dcabc6a739ce47b64ff29ec003bad5e7b8c298e7628855492d
+  metadata.gz: a92ff540c2377590d52352f8d8dbb0e4b0a0366d74749ec7491df1416c20b792c9d5e5227994e6b36082948dbefcc3e9e758eb1613b05ac6213b1d1cede0a219
+  data.tar.gz: 8a386f5a65e565fe03fd820445b27f50163ba7f01095aaeb6eba94fa68e2d24017a60674db41953919f51b4dfb369179f6cdd816e7d41c419db0b7af3ef39e15

data/README.md

@@ -97,7 +97,7 @@ Language Extension
 Where to go from here
 ---------------------
 
-* [Check the project websitere](http://opener-project.github.io)
+* [Check the project website](http://opener-project.github.io)
 * [Checkout the webservice](http://opener.olery.com/ned)
 
 Report problem/Get help

data/lib/opener/ned.rb

@@ -7,6 +7,7 @@ require File.expand_path('../../../core/target/ehu-ned-1.0.jar', __FILE__)
 
 require_relative 'ned/version'
 require_relative 'ned/cli'
+require_relative 'ned/error_layer'
 
 import 'java.io.InputStreamReader'
 
@@ -60,25 +61,30 @@ module Opener
     end
 
     def run(input)
-      if !input or input.strip.empty?
-        raise ArgumentError, 'No input specified'
-      end
+      begin
+        if !input or input.strip.empty?
+          raise ArgumentError, 'No input specified'
+        end
 
-      language = language_from_kaf(input)
+        language = language_from_kaf(input)
 
-      input_io  = StringIO.new(input)
-      reader    = InputStreamReader.new(input_io.to_inputstream)
-      document  = KAFDocument.create_from_stream(reader)
-      annotator = Java::ehu.ned.Annotate.new
+        input_io  = StringIO.new(input)
+        reader    = InputStreamReader.new(input_io.to_inputstream)
+        document  = KAFDocument.create_from_stream(reader)
+        annotator = Java::ehu.ned.Annotate.new
 
-      endpoint = @options.fetch(:endpoint, uri_for_language(language))
+        endpoint = @options.fetch(:endpoint, uri_for_language(language))
 
-      annotator.disambiguateNEsToKAF(
-        document,
-        endpoint.to_s
-      )
+        annotator.disambiguateNEsToKAF(
+          document,
+          endpoint.to_s
+        )
 
-      return document.to_string
+        return document.to_string
+        
+      rescue Exception => error
+        return ErrorLayer.new(input, error.message, self.class).add
+      end
     end
 
     private

data/lib/opener/ned/error_layer.rb

@@ -0,0 +1,89 @@
+module Opener
+  class Ned
+    ##
+    # Add Error Layer to KAF file instead of throwing an error.
+    #
+    class ErrorLayer
+      attr_accessor :input, :document, :error, :klass
+      
+      def initialize(input, error, klass)
+        @input    = input.to_s
+        # Make sure there is always a document, even if it is empty.
+        @document = Nokogiri::XML(input) rescue Nokogiri::XML(nil)
+        @error    = error
+        @klass    = klass
+      end
+      
+      def add
+        if is_xml?
+          unless has_errors_layer?
+            add_errors_layer
+          end
+        else
+          add_root
+          add_text
+          add_errors_layer
+        end
+        add_error
+        
+        xml = !!document.encoding ? document.to_xml : document.to_xml(:encoding => "UTF-8")
+        
+        return xml
+      end
+      
+      ##
+      # Check if the document is a valid XML file.
+      #
+      def is_xml?
+        !!document.root
+      end
+      
+      ##
+      # Add root element to the XML file.
+      #
+      def add_root
+        root = Nokogiri::XML::Node.new "KAF", document
+        document.add_child(root)
+      end
+      
+      ##
+      # Check if the document already has an errors layer.
+      #
+      def has_errors_layer?
+        !!document.at('errors')
+      end
+      
+      ##
+      # Add errors element to the XML file.
+      #
+      def add_errors_layer
+        node = Nokogiri::XML::Node.new "errors", document
+        document.root.add_child(node)
+      end
+      
+      ##
+      # Add the text file incase it is not a valid XML document. More
+      # info for debugging.
+      #
+      def add_text
+        node = Nokogiri::XML::Node.new "raw", document
+        node.inner_html = input
+        document.root.add_child(node)
+        
+      end
+      
+      ##
+      # Add the actual error to the errors layer.
+      #
+      def add_error
+        node = document.at('errors')
+        error_node = Nokogiri::XML::Node.new "error", node
+        error_node['class']   = klass.to_s
+        error_node['version'] = klass::VERSION
+        error_node.inner_html = error
+        node.add_child(error_node)
+      end     
+      
+    end # ErrorLayer
+  end # Ned
+end # Opener

data/lib/opener/ned/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Ned
-    VERSION = '2.2.0'
+    VERSION = '2.3.0'
   end # Ned
 end # Opener

data/opener-ned.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'opener-daemons'
   gem.add_dependency 'opener-core', ['>= 0.1.2']
 
-  gem.add_development_dependency 'opener-build-tools'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'cliver'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-ned
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -109,7 +109,7 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-build-tools
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -123,7 +123,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: cliver
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -154,6 +154,7 @@ files:
 - exec/ned.rb
 - lib/opener/ned.rb
 - lib/opener/ned/cli.rb
+- lib/opener/ned/error_layer.rb
 - lib/opener/ned/public/markdown.css
 - lib/opener/ned/server.rb
 - lib/opener/ned/version.rb
@@ -183,4 +184,3 @@ signing_key:
 specification_version: 4
 summary: NED client using DBpedia
 test_files: []
-has_rdoc: yard