opener-ned 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9040d06ad1e01c87c8748947ee3c66f61ea2d083
-  data.tar.gz: 843fc7ae1a18cf93118a9300bcfce32f4f5ba27d
+  metadata.gz: 52feee8c2bb6f1cbc0e13e763564ebcf1d317ea5
+  data.tar.gz: 9d3f246df66dd2ed80ea8f88530e8bd9ec5b19d8
 SHA512:
-  metadata.gz: 6947de909caf7c8ef1c496e994a18a99190b3b23c83e73528a7491531a6a22c08a3179303517a3c99f7041a3a66dffbb5519c7dd8008296c1bd96f45525423b7
-  data.tar.gz: cd2c1cdf5386e380cbb09663a2633f793bcb7f61fa83879df5e92cb118911e177b1d9b82daaa35b8bf5ca55de94a0a38ee5278de5a74c08b45683d9b0d0f2b60
+  metadata.gz: 5c7af973b5ee38ffed564fb2cde68da63fda96af29153587a0c6780117801b2eba1c0e55d6f1a7c7258033c35dadaec907df304cae5d02d13184f35e635d6a8d
+  data.tar.gz: 5bef0f6b3742aba26c61e4a1565075014bdf0d78c5bd7799830073fd31406576fefba4a51a14a3f0e8da0ceef6df0dff4f36ee6bca95212caeb02b8cc480737c

data/README.md

@@ -1,57 +1,135 @@
-# NED
+Introduction
+------------
 
 This repository contains a Named Entity Disambiguation tool that queries a
 DBpedia spotlight server. The client takes KAF as input (containing
 `<entities>` nodes).
 
-## Requirements
+### Confused by some terminology?
 
-* Ruby 1.9.2 or newer
-* Java 1.7 or newer
+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.
 
-## Installation
+Quick Use Example
+-----------------
 
-Installing as a regular Gem:
+Installing the ned can be done by executing:
 
     gem install opener-ned
 
-Using Bundler:
+Please bare in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
-    gem 'opener-ned',
-      :git    => 'git@github.com:opener-project/constituent-parser-base.git',
-      :branch => 'master'
 
-Using specific install:
+### Command line interface
 
-    gem install specific_install
-    gem specific_install opener-ned \
-       -l https://github.com/opener-project/constituent-parser-base.git
+The NED client connects to the (DBPedia spotlight demo servers)[http://dbpedia-spotlight.github.io/demo/].
 
-## Usage
+A simple example:
 
-The NED client requires a working DBpedia Spotlight server to be available. By
-default it tries to connect to http://localhost:2020 (English language) but you
-can change this using the `--host` and `--port` options in the CLI.
+    cat some_input_file.kaf | ned
 
-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>
+```
+
+### Webservices
+
+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>.
+
+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.
+
+
+### Daemon
 
-    cat some_input_file.kaf | ned --host=http://example.com/ --port=1234
+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:
 
-## Contributing
+    ned-daemon -h
 
-First make sure all the required dependencies are installed:
 
-    bundle install
+Description of dependencies
+---------------------------
 
-Then compile the required Java code:
+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]
 
-    bundle exec rake compile
+At least you need the following system setup:
 
-For this you'll need to have Java 1.7 and Maven installed. These requirements
-are verified for you before the Rake task calls Maven.
+### Depenencies for normal use:
 
-## Structure
+* Jruby (1.7.9 or newer)
+* Java 1.7 or newer (There are problems with encoding in older versions).
+
+### Dependencies if you want to modify the component:
+
+* Maven (for building the Gem)
+
+### 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.
+
+Language Extension
+------------------
+
+  TODO
+
+Where to go from here
+---------------------
+
+* 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/issues].
+
+
+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-server

@@ -1,10 +1,8 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/opener/ned/server'
+require 'puma/cli'
 
-# 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__)
+rack_config = File.expand_path('../../config.ru', __FILE__)
 
-server.start
+cli = Puma::CLI.new([rack_config] + ARGV)
+cli.run

data/lib/opener/ned/cli.rb

@@ -29,34 +29,12 @@ module Opener
             show_version
           end
 
-          opts.on('-p', '--port [VALUE]', 'Use a custom port') do |value|
-            @options[:port] = value
-          end
-
-          opts.on('-H', '--host [VALUE]', 'Use a custom hostname') do |value|
-            @options[:host] = value
-          end
-
           opts.separator <<-EOF
 
 Examples:
 
   cat input_file.kaf | #{opts.program_name}
-  cat input_file.kaf | #{opts.program_name} --host=http://some-host.com/
-
-Port Numbers:
-
-  Port numbers are required. Each language has its own port number (unless
-  specified otherwise):
-
-  * German: 2010
-  * English: 2020
-  * Spanish: 2030
-  * French: 2040
-  * Italian: 2050
-  * Dutch: 2060
 
-  By default port 2020 (English) is used.
           EOF
         end
       end

data/lib/opener/ned/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Ned
-    VERSION = '2.0.0'
+    VERSION = '2.0.1'
   end # Ned
 end # Opener

data/opener-ned.gemspec

@@ -24,6 +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_development_dependency 'opener-build-tools'
   gem.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-ned
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -66,6 +66,20 @@ dependencies:
         version: '0'
   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-build-tools
   version_requirements: !ruby/object:Gem::Requirement