opener-ner 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb73b77467d92bf3cabce1ebaa94ba05ef0838e
-  data.tar.gz: 9756f377742951dc077446ddfb189b160c3a5874
+  metadata.gz: 81a89a206b92a88556d978ef8ad37bb9b6ca03d3
+  data.tar.gz: 801709895c96d74cd75b6f34bcf2f08aa8e7654b
 SHA512:
-  metadata.gz: 568efc611a6a4a11184ed6c7172658b370b858c58632894280b0544b5e5514d76ccd6cc3f2f2a416ef43bc9a41b545e876fb6efdaa842547f64065287c0a2da3
-  data.tar.gz: 2263ffdcebf1b5f91240ea595901baf6ad368040adde94dc3e200bbf74859f30e1b172ffa3c02950be7ac46ee972a9acf4a4f33962a4a7c4cf4af403152e8c0c
+  metadata.gz: 0475803001bf5e36ebb77c2b567d2d11245b098406b8226b5d38a52452266d88cad0f9fa9566f30394428768b0061c0951002b6ea4cab99a9836012b7bc0aa0d
+  data.tar.gz: 38ee582fb0d5ab10c9256a6d4d5ea093da4fb5a749e037fffb0d0804ed545ab4eae317706d43b9ca76c11e9b2f3297eee5109197a8cf816bcc772b4d515a2f4c

data/README.md

@@ -4,26 +4,138 @@ This repository contains the source code for the primary NER component of the
 OpeNER project. This component provides a CLI interface for the various kernels
 as well as providing a Sinatra based web service.
 
-## Requirements
+### Confused by some terminology?
 
-* Ruby 1.9.2 or newer
-* Bundler
+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
+-----------------
 
-As a regular Ruby Gem:
+Installing the ner can be done by executing:
 
     gem install opener-ner
 
+Please bare in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
-Using Bundler:
+### Command line interface
 
-    gem 'opener-ner',
-      :git    => 'git@github.com:opener-project/ner.git',
-      :branch => 'master'
+You should now be able to call the NER as a regular shell
+command: by its name. Once installed the gem normalyl sits in your path so you can call it directly from anywhere.
 
-Using specific install:
+This aplication reads a text from standard input in order to identify the language.
+
+    cat some_kind_of_kaf_file.kaf | ner
+
+
+This will output a kaf file containing the named entities. An excerpt can be
+seen here
+
+```
+<entity eid="e3" type="organization">
+  <references>
+    <!--North Yorkshire Police-->
+    <span>
+      <target id="t17" />
+      <target id="t18" />
+      <target id="t19" />
+    </span>
+  </references>
+</entity>
+```
+
+### Webservices
+
+You can launch a language identification webservice by executing:
+
+    ner-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:
+
+    ner-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
+
+Last but not least the NER comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
+
+    ner-daemon -h
+
+
+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)[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:
+
+### Depenencies for normal use:
+
+* MRI 1.9.3 / Jruby
+* 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)
+
+Domain Adaption
+---------------
+
+  TODO
+
+Language Extension
+------------------
+
+  TODO
+
+The Core
+--------
+
+The component is a fat wrapper around the actual language technology core. You
+can find the core technolies in the following repositories:
+
+* (ner-base)[https://github.com/opener-project/ner-base]
+
+
+Where to go from here
+---------------------
+
+* Check (the project websitere)[http://opener-project.github.io]
+* (Checkout the webservice)[http://opener.olery.com/ner]
+
+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/ner/issues].
+
+
+Contributing
+------------
+
+1. Fork it ( http://github.com/opener-project/ner/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
 
-    gem install specific_install
-    gem specific_install opener-ner \
-        -l https://github.com/opener-project/ner.git

data/bin/ner-server

@@ -1,10 +1,8 @@
 #!/usr/bin/env ruby
 
-require 'rack'
+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/ner/version.rb

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

data/opener-ner.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'sinatra', '~> 1.4'
   gem.add_dependency 'httpclient'
   gem.add_dependency 'nokogiri'
+  gem.add_dependency 'puma'
   gem.add_dependency 'opener-ner-base'
   gem.add_dependency 'opener-webservice'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-ner
 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
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: opener-ner-base
   requirement: !ruby/object:Gem::Requirement