opener-ned 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee1efe28b8ebe6ded998c4c332d54d223373696a
-  data.tar.gz: 442d071af7a75fae2dc59199106944c269196168
+  metadata.gz: a32557f4c5975993619a7c34fd8445c4a34c2772
+  data.tar.gz: a1bf198c6c521deb21c295b6570e772ff2444cb6
 SHA512:
-  metadata.gz: 4c68995447104271cc30b3cd0e94a560c8c931c86274735c2a9091fa3dc1455a0219328c4bed28e909c5d3fcb18a2d13355a28c6759d3f4a5064de0f67dd1647
-  data.tar.gz: edae0c4ca159a514d809fcd67f5ca75db2eed3df88d394e1095147cdac59d607c9bd2d37f78d59cebd91388648dbc523736892a8aa6795bc79d70a9ba7224a6c
+  metadata.gz: 39f0013bf01f194047ecdd5921bca6618201045dd8197635fb2a34a023cbe4bf7a2d5a4365b338e9052b05c7fc8b6e57b7b6337b96105abca3231f5469b8adf3
+  data.tar.gz: 56facef0fb80a8b52e50b7337ac82c3901f2a8938edce8a4f662ef593033658c8e25a04f7a39327f9fee65629b81eabdef8506500818e2f9455dd68de695d404

data/README.md

@@ -1,12 +1,17 @@
 Introduction
 ------------
 
-This repository contains a Named Entity Disambiguation tool that queries a DBpedia spotlight server. The client takes KAF as input (containing `<entities>` nodes).
+This repository contains a Named Entity Disambiguation tool that queries a
+DBpedia spotlight server. The client takes KAF as input (containing
+`<entities>` nodes).
 
 ### Confused by some terminology?
 
-This software is part of a larger collection of natural language processing tools known as "the OpeNER project". You can find more information about the project at [the OpeNER portal](http://opener-project.github.io). There you can also find references to terms like KAF (an XML standard to represent linguistic annotations in texts), component, cores, scenario's and pipelines.
-
+This software is part of a larger collection of natural language processing
+tools known as "the OpeNER project". You can find more information about the
+project at (the OpeNER portal)[http://opener-project.github.io]. There you can
+also find references to terms like KAF (an XML standard to represent linguistic
+annotations in texts), component, cores, scenario's and pipelines.
 
 Quick Use Example
 -----------------
@@ -15,12 +20,13 @@ Installing the ned can be done by executing:
 
     gem install opener-ned
 
-Please bare in mind that all components in OpeNER take KAF as an input and output KAF by default.
+Please bare in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
 
 ### Command line interface
 
-The NED client connects to the [DBPedia spotlight demo servers](http://dbpedia-spotlight.github.io/demo/).
+The NED client connects to the (DBPedia spotlight demo servers)[http://dbpedia-spotlight.github.io/demo/].
 
 A simple example:
 
@@ -50,20 +56,26 @@ You can launch a language identification webservice by executing:
 
     ned-server
 
-This will launch a mini webserver with the webservice. It defaults to port 9292, so you can access it at <http://localhost:9292>.
+This will launch a mini webserver with the webservice. It defaults to port 9292,
+so you can access it at <http://localhost:9292>.
 
-To launch it on a different port provide the `-p [port-number]` option like this:
+To launch it on a different port provide the `-p [port-number]` option like
+this:
 
     ned-server -p 1234
 
 It then launches at <http://localhost:1234>
 
-Documentation on the Webservice is provided by surfing to the urls provided above. For more information on how to launch a webservice run the command with the ```-h``` option.
+Documentation on the Webservice is provided by surfing to the urls provided
+above. For more information on how to launch a webservice run the command with
+the ```-h``` option.
 
 
 ### Daemon
 
-Last but not least the NED comes shipped with a daemon that can read jobs (and write) jobs to and from Amazon SQS queues. For moreinformation type:
+Last but not least the NED comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
 
     ned-daemon -h
 
@@ -71,8 +83,11 @@ Last but not least the NED comes shipped with a daemon that can read jobs (and w
 Description of dependencies
 ---------------------------
 
-This component runs best if you run it in an environment suited for OpeNER components. You can find an installation guide and helper tools in the [OpeNER installer](ttps://github.com/opener-project/opener-installer) and an
-[installation guide on the Opener Website](http://opener-project.github.io/getting-started/how-to/local-installation.html)
+This component runs best if you run it in an environment suited for OpeNER
+components. You can find an installation guide and helper tools in the (OpeNER
+installer)[https://github.com/opener-project/opener-installer] and (an
+installation guide on the Opener
+Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html]
 
 At least you need the following system setup:
 
@@ -87,7 +102,9 @@ At least you need the following system setup:
 
 ### Structure
 
-This repository comes in two parts: a collection of Java source files and Ruby source files. The Java code can be found in the `core/` directory, everything else will be Ruby source code.
+This repository comes in two parts: a collection of Java source files and Ruby
+source files. The Java code can be found in the `core/` directory, everything
+else will be Ruby source code.
 
 Language Extension
 ------------------
@@ -97,20 +114,20 @@ Language Extension
 Where to go from here
 ---------------------
 
-* [Check the project website](http://opener-project.github.io)
-* [Checkout the webservice](http://opener.olery.com/ned)
+* Check (the project websitere)[http://opener-project.github.io]
+* (Checkout the webservice)[http://opener.olery.com/ned]
 
 Report problem/Get help
 -----------------------
 
-If you encounter problems, please email <support@opener-project.eu> or leave an issue in the 
-[issue tracker](https://github.com/opener-project/ned/issue).
+If you encounter problems, please email support@opener-project.eu or leave an
+issue in the (issue tracker)[https://github.com/opener-project/ned/issues].
 
 
 Contributing
 ------------
 
-1. Fork it <http://github.com/opener-project/ned/fork>
+1. Fork it ( http://github.com/opener-project/ned/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/bin/ned-server

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'puma/cli'
+require_relative '../lib/opener/ned/server'
 
-rack_config = File.expand_path('../../config.ru', __FILE__)
+# Without calling `Rack::Server#options` manually the CLI arguments will never
+# be passed, thus the application can't be specified as a constructor argument.
+server                  = Rack::Server.new
+server.options[:config] = File.expand_path('../../config.ru', __FILE__)
 
-cli = Puma::CLI.new([rack_config] + ARGV)
-cli.run
+server.start

data/lib/opener/ned/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Ned
-    VERSION = '2.0.4'
+    VERSION = '2.1.0'
   end # Ned
 end # Opener

data/lib/opener/ned.rb

@@ -7,7 +7,6 @@ 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'
 
@@ -61,30 +60,25 @@ module Opener
     end
 
     def run(input)
-      begin
-        if !input or input.strip.empty?
-          raise ArgumentError, 'No input specified'
-        end
+      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
-        
-      rescue Exception => error
-        return ErrorLayer.new(input, error.message, self.class).add
-      end
+      return document.to_string
     end
 
     private

data/opener-ned.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |gem|
     'lib/**/*',
     '*.gemspec',
     'config.ru',
-    'README.md',
-    'exec/**/*'
+    'README.md'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
@@ -25,10 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'httpclient'
   gem.add_dependency 'opener-webservice'
   gem.add_dependency 'nokogiri'
-  gem.add_dependency 'puma'
-  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.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -67,49 +67,7 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: puma
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: opener-daemons
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: opener-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: opener-build-tools
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -123,7 +81,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: cliver
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -140,21 +98,17 @@ description: NED client using DBpedia
 email:
 executables:
 - ned
-- ned-daemon
 - ned-server
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/ned
-- bin/ned-daemon
 - bin/ned-server
 - config.ru
 - core/target/ehu-ned-1.0.jar
-- 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

data/bin/ned-daemon

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'opener/daemons'
-
-exec_path = File.expand_path('../../exec/ned.rb', __FILE__)
-
-Opener::Daemons::Controller.new(
-  :name      => 'ned',
-  :exec_path => exec_path
-)

data/exec/ned.rb

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'opener/daemons'
-require_relative '../lib/opener/ned'
-
-options = Opener::Daemons::OptParser.parse!(ARGV)
-daemon  = Opener::Daemons::Daemon.new(Opener::Ned, options)
-
-daemon.start

data/lib/opener/ned/error_layer.rb

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