opener-ned 2.4.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6c0f8c10e46991a6c5d92768a4336a7112fdb52
-  data.tar.gz: 75f1f11a4d2f4e31e1bc479cf0e1a5b35535126c
+  metadata.gz: a7555399cec5942f6c40e3153c895167a12b326a
+  data.tar.gz: 8a35994ccb1d85171281b4114af842db52bf6099
 SHA512:
-  metadata.gz: 1c1a3843a2b23bef511adc25d4eebd5ac2072d62678d9a4ce59e7297c791dad092cc31d630b35589059d5f88d4d3b050a217d9e8c92d4b0c4b9e60447f3becb2
-  data.tar.gz: ca9bad5047147879798d6b237007d97918dc82a62eb2d5e6a1958ed2a8bf1b114cbbcb02f84d7ce51ffc0dc661d71aae01895bf9960023912a38f8c35b365913
+  metadata.gz: 42dd20c33ebc66b472ae3d343df1f0837c380e939bcf2dcd19d8b72b5fbf26c95d37edea792a9c348adbb6c4ddabedcae850ab39656545ec7b8e65cfea3751e5
+  data.tar.gz: 651ee179eab6c0a6996f63623a8e0f57fa1cebf861dae08e45dc26c390dd338d980c79c6ab9cd9cd7699f567fec913fdbe5c1459190fb9017759f5d95a5dfbe9

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 OpeNER Project Consortium
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,26 +1,30 @@
-Introduction
-------------
+# NED
 
-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?
+## 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
------------------
+## Quick Use Example
 
 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 keep 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:
 
@@ -28,21 +32,19 @@ A simple example:
 
 An example output (excerpt) could look like this:
 
-```xml
-<entity eid="e3" type="organization">
-  <references>
-    <!--North Yorkshire Police-->
-    <span>
-      <target id="t17" />
-      <target id="t18" />
-      <target id="t19" />
-    </span>
-  </references>
-  <externalReferences>
-    <externalRef resource="spotlight_v1" reference="http://dbpedia.org/resource/North_Yorkshire_Police" />
-  </externalReferences>
-</entity>
-```
+    <entity eid="e3" type="organization">
+      <references>
+        <!--North Yorkshire Police-->
+        <span>
+          <target id="t17" />
+          <target id="t18" />
+          <target id="t19" />
+        </span>
+      </references>
+      <externalReferences>
+        <externalRef resource="spotlight_v1" reference="http://dbpedia.org/resource/North_Yorkshire_Police" />
+      </externalReferences>
+    </entity>
 
 ### Webservices
 
@@ -50,28 +52,32 @@ 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 `--help` 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 moreinformation type:
 
     ned-daemon -h
 
+## Description of dependencies
 
-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
+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)
 
 At least you need the following system setup:
@@ -87,32 +93,28 @@ 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
-------------------
+## Language Extension
 
-  TODO
+TODO
 
-Where to go from here
----------------------
+## Where to go from here
 
 * [Check the project website](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).
+## 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).
 
-Contributing
-------------
+## Contributing
 
 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`)
 5. Create new Pull Request
-

data/bin/ned

@@ -2,6 +2,6 @@
 
 require_relative '../lib/opener/ned'
 
-cli = Opener::Ned::CLI.new(:args => ARGV)
+cli = Opener::Ned::CLI.new
 
-cli.run(STDIN.tty? ? nil : STDIN.read)
+cli.run

data/bin/ned-daemon

@@ -2,9 +2,9 @@
 
 require 'opener/daemons'
 
-exec_path = File.expand_path('../../exec/ned.rb', __FILE__)
+controller = Opener::Daemons::Controller.new(
+  :name      => 'opener-ned',
+  :exec_path => File.expand_path('../../exec/ned.rb', __FILE__)
+)
 
-Opener::Daemons::Controller.new(
-  :name      => 'ned',
-  :exec_path => exec_path
-)
+controller.run

data/bin/ned-server

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'puma/cli'
+require 'opener/webservice'
 
-rack_config = File.expand_path('../../config.ru', __FILE__)
+parser = Opener::Webservice::OptionParser.new(
+  'opener-ned',
+  File.expand_path('../../config.ru', __FILE__)
+)
 
-cli = Puma::CLI.new([rack_config] + ARGV)
-cli.run
+parser.run

data/exec/ned.rb

@@ -1,9 +1,9 @@
 #!/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 = Opener::Daemons::Daemon.new(Opener::Ned)
 
-daemon.start
+daemon.start

data/lib/opener/ned/cli.rb

@@ -1,79 +1,68 @@
 module Opener
   class Ned
     ##
-    # CLI wrapper around {Opener::Ned} using OptionParser.
+    # CLI wrapper around {Opener::Ned} using Slop.
     #
-    # @!attribute [r] options
-    #  @return [Hash]
-    # @!attribute [r] option_parser
-    #  @return [OptionParser]
+    # @!attribute [r] parser
+    #  @return [Slop]
     #
     class CLI
-      attr_reader :options, :option_parser
+      attr_reader :parser
+
+      def initialize
+        @parser = configure_slop
+      end
 
       ##
-      # @param [Hash] options
+      # @param [Array] argv
       #
-      def initialize(options = {})
-        @options = DEFAULT_OPTIONS.merge(options)
-
-        @option_parser = OptionParser.new do |opts|
-          opts.program_name   = 'ned'
-          opts.summary_indent = '  '
-
-          opts.separator "\nOptions:\n\n"
-
-          opts.on('-h', '--help', 'Shows this help message') do
-            show_help
-          end
-
-          opts.on('-v', '--version', 'Shows the current version') do
-            show_version
-          end
+      def run(argv = ARGV)
+        parser.parse(argv)
+      end
 
-          opts.on('-l', '--logging', 'Enables logging output') do
-            @options[:logging] = true
-          end
+      ##
+      # @return [Slop]
+      #
+      def configure_slop
+        return Slop.new(:strict => false, :indent => 2, :help => true) do
+          banner 'Usage: ner [OPTIONS]'
 
-          opts.on('--no-time', 'Disables timestamps') do
-            @options[:enable_time] = false
-          end
+          separator <<-EOF.chomp
 
-          opts.separator <<-EOF
+About:
 
-Examples:
+    Named Entity Disambiguation for various languages using DBPedia.
+    This command reads input from STDIN.
 
-  cat input_file.kaf | #{opts.program_name}
+Example:
 
+    cat some_file.kaf | ned
           EOF
-        end
-      end
 
-      ##
-      # @param [String] input
-      #
-      def run(input)
-        option_parser.parse!(options[:args])
+          separator "\nOptions:\n"
 
-        ned = Ned.new(options)
+          on :v, :version, 'Shows the current version' do
+            abort "ned v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
 
-        puts ned.run(input)
-      end
+          on :l, :logging, 'Enables debug logging output',
+            :default => false
 
-      private
+          on :'disable-time', 'Disables adding of dynamic timestamps',
+            :default => false
 
-      ##
-      # Shows the help message and exits the program.
-      #
-      def show_help
-        abort option_parser.to_s
-      end
+          run do |opts, args|
+            ned = Ned.new(
+              :args        => args,
+              :logging     => opts[:logging],
+              :enable_time => !opts[:'disable-time']
+            )
 
-      ##
-      # Shows the version and exits the program.
-      #
-      def show_version
-        abort "#{option_parser.program_name} v#{VERSION} on #{RUBY_DESCRIPTION}"
+            input = STDIN.tty? ? nil : STDIN.read
+
+            puts ned.run(input)
+          end
+        end
       end
     end # CLI
   end # Ned

data/lib/opener/ned/server.rb

@@ -1,13 +1,12 @@
-require 'sinatra/base'
 require 'opener/webservice'
-require 'httpclient'
 
 module Opener
   class Ned
-    class Server < Webservice
+    class Server < Webservice::Server
       set :views, File.expand_path('../views', __FILE__)
-      text_processor Ned
-      accepted_params :input, :host, :port
+
+      self.text_processor  = Ned
+      self.accepted_params = [:input, :host, :port]
     end # Server
   end # Ned
 end # Opener

data/lib/opener/ned/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Ned
-    VERSION = '2.4.1'
+    VERSION = '3.0.0'
   end # Ned
 end # Opener

data/lib/opener/ned.rb

@@ -1,17 +1,14 @@
-require 'optparse'
 require 'java'
 require 'stringio'
+
+require 'slop'
 require 'nokogiri'
-require 'opener/core'
 
 require File.expand_path('../../../core/target/ehu-ned-1.0.jar', __FILE__)
 
 require_relative 'ned/version'
 require_relative 'ned/cli'
 
-import 'java.io.InputStreamReader'
-import 'ixa.kaflib.KAFDocument'
-
 module Opener
   ##
   # Ruby wrapper around the Java based NED tool that's powered by DBpedia.
@@ -81,8 +78,8 @@ module Opener
 
       language  = language_from_kaf(input)
       input_io  = StringIO.new(input)
-      reader    = InputStreamReader.new(input_io.to_inputstream)
-      document  = KAFDocument.create_from_stream(reader)
+      reader    = Java::java.io.InputStreamReader.new(input_io.to_inputstream)
+      document  = Java::ixa.kaflib.KAFDocument.create_from_stream(reader)
       annotator = new_annotator
       endpoint  = options.fetch(:endpoint, uri_for_language(language))
 
@@ -92,9 +89,6 @@ module Opener
       )
 
       return document.to_string
-
-    rescue Exception => error
-      return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
     end
 
     private

data/opener-ned.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.summary     = 'NED client using DBpedia'
   gem.description = gem.summary
   gem.has_rdoc    = 'yard'
+  gem.license     = 'Apache 2.0'
 
   gem.required_ruby_version = '>= 1.9.2'
 
@@ -16,18 +17,18 @@ Gem::Specification.new do |gem|
     '*.gemspec',
     'config.ru',
     'README.md',
+    'LICENSE.txt',
     'exec/**/*'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
-  gem.add_dependency 'sinatra', '~> 1.4'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'opener-webservice'
+  gem.add_dependency 'opener-daemons', '~> 2.2'
+  gem.add_dependency 'opener-webservice', '~> 2.1'
+  gem.add_dependency 'opener-core', '~> 2.2'
+
   gem.add_dependency 'nokogiri'
-  gem.add_dependency 'puma'
-  gem.add_dependency 'opener-daemons'
-  gem.add_dependency 'opener-core', '~> 1.0'
+  gem.add_dependency 'slop', '~> 3.5'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'cliver'

metadata

@@ -1,87 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: opener-ned
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 3.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: opener-daemons
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  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'
+        version: '2.2'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
   name: opener-webservice
   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: nokogiri
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: opener-core
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-daemons
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,17 +67,17 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-core
+  name: slop
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -155,12 +127,14 @@ files:
 - opener-ned.gemspec
 - config.ru
 - README.md
+- LICENSE.txt
 - exec/ned.rb
 - bin/ned-daemon
 - bin/ned-server
 - bin/ned
 homepage:
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message:
 rdoc_options: []