opener-ner 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822d5662b2e3e6fc8bdb4d9764374cf88494065c
-  data.tar.gz: 850c3aa84b1e851f366ae0db587aecd694bc54b8
+  metadata.gz: 0e3d2681b8fd8feaa6a65dbcb5082eac3e517656
+  data.tar.gz: 03cedcd7d8f77c63fe4a9d70c24fb5e87187936e
 SHA512:
-  metadata.gz: f1f33be981aff1cf9b431121f0493f55ba2d18e32ac742c1b47325dc465128f1484b4fd3d06d9bb7ffa8bf218f213fb04a5aadf172fc1b941fc82e130dbceca2
-  data.tar.gz: 34961f4cda78f5d995b67eb33d3b0cce8da166993be279276cdba2b94080a0ca024f15889543f2f5aab10cb390f52c999bdc5d4a14f54eea69c55c27361b23ce
+  metadata.gz: 1e2e99e598633b21e17d6a0dd8a08707556406aa6599d24df80b9d1c4723ae909a9b67657c0be3fb46ddf8fe127fb6eada9c75f73fa974f07e5f61a30988a838
+  data.tar.gz: 7ff4845b61b7028fb38886a57ebbba60e7a5cf9cf3be16e5fdeabd3e76c52715052670c0b0d9c6ea3955828eaf5ddc34e2bc78af8c7a7f3b4f0618cfeaf6f1f2

data/README.md

@@ -1,44 +1,50 @@
 # NER
 
-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.
+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.
 
 ### 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 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.
+Please keep in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
 ### Command line interface
 
-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.
+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.
 
-This aplication reads a text from standard input in order to identify the language.
+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
 
-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>
-```
+    <entity eid="e3" type="organization">
+      <references>
+        <!--North Yorkshire Police-->
+        <span>
+          <target id="t17" />
+          <target id="t18" />
+          <target id="t19" />
+        </span>
+      </references>
+    </entity>
 
 ### Webservices
 
@@ -46,28 +52,32 @@ 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>.
+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:
 
     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.
-
+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 NER comes shipped with a daemon that can read jobs (and write) jobs to and from Amazon SQS queues. For more information type:
+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
 
-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
+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:
@@ -81,43 +91,35 @@ At least you need the following system setup:
 
 * Maven (for building the Gem)
 
-Domain Adaption
----------------
+## Domain Adaption
 
-  TODO
+TODO
 
-Language Extension
-------------------
+## Language Extension
 
-  TODO
+TODO
 
-The Core
---------
+## The Core
 
-The component is a fat wrapper around the actual language technology core. You can find the core technolies in the following repositories:
+The component is a 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
----------------------
+## Where to go from here
 
 * [Check the project website](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).
+## 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
-------------
+## 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
-

data/bin/ner

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

data/bin/ner-daemon

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

data/bin/ner-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-ner',
+  File.expand_path('../../config.ru', __FILE__)
+)
 
-cli = Puma::CLI.new([rack_config] + ARGV)
-cli.run
+parser.run

data/exec/ner.rb

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

data/lib/opener/ner.rb

@@ -1,7 +1,6 @@
-require 'optparse'
 require 'opener/ners/base'
 require 'nokogiri'
-require 'opener/core'
+require 'slop'
 
 require_relative 'ner/version'
 require_relative 'ner/cli'
@@ -39,6 +38,7 @@ module Opener
     #
     # @option options [Array] :args Collection of arbitrary arguments to pass
     #  to the underlying kernels.
+    #
     # @option options [String] :language The language to use.
     #
     def initialize(options = {})
@@ -53,20 +53,16 @@ module Opener
     # @return [Array]
     #
     def run(input)
-      begin
-        language = language_from_kaf(input) || DEFAULT_LANGUAGE
-        args     = options[:args].dup
-
-        if language_constant_defined?(language)
-          kernel = language_constant(language).new(options)
-        else
-          kernel = Ners::Base.new(options)
-        end
+      language = language_from_kaf(input) || DEFAULT_LANGUAGE
+      args     = options[:args].dup
 
-        return kernel.run(input)
-      rescue Exception => error
-        return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
+      if language_constant_defined?(language)
+        kernel = language_constant(language).new(options)
+      else
+        kernel = Ners::Base.new(options)
       end
+
+      return kernel.run(input)
     end
 
     protected

data/lib/opener/ner/cli.rb

@@ -1,88 +1,64 @@
 module Opener
   class Ner
     ##
-    # CLI wrapper around {Opener::Ner} using OptionParser.
+    # CLI wrapper around {Opener::Ner} 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   = 'ner'
-          opts.summary_indent = '  '
-
-          opts.on('-h', '--help', 'Shows this help message') do
-            show_help
-          end
-
-          opts.on('-v', '--version', 'Shows the current version') do
-            show_version
-          end
-
-          opts.on(
-            '-l',
-            '--language [VALUE]',
-            'Uses this specific language'
-          ) do |value|
-            @options[:language] = value
-          end
+      def run(argv = ARGV)
+        parser.parse(argv)
+      end
 
-          opts.separator <<-EOF
+      ##
+      # @return [Slop]
+      #
+      def configure_slop
+        return Slop.new(:strict => false, :indent => 2, :help => true) do
+          banner 'Usage: ner [OPTIONS]'
 
-Examples:
+          separator <<-EOF.chomp
 
-  cat example.kaf | #{opts.program_name} -l en
+About:
 
-Languages:
+    Named Entity Recognition for various languages such as English and Dutch.
+    This command reads input from STDIN.
 
-  Ner will try to detect the language of the KAF file if no language is given.
+Example:
 
-  * Dutch (nl)
-  * English (en)
-  * French (fr)
-  * German (de)
-  * Italian (it)
-  * Spanish (es)
+    cat some_file.kaf | ner
           EOF
-        end
-      end
 
-      ##
-      # @param [String] input
-      #
-      def run(input)
-        option_parser.parse!(options[:args])
+          separator "\nOptions:\n"
 
-        ner = Ner.new(options)
+          on :v, :version, 'Shows the current version' do
+            abort "ner v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
 
-        return ner.run(input)
-      end
+          on :l=, :language=, 'Sets a specific language to use', :as => String
 
-      private
+          run do |opts, args|
+            parser = Ner.new(
+              :args     => args,
+              :language => opts[:language]
+            )
 
-      ##
-      # Shows the help message and exits the program.
-      #
-      def show_help
-        abort option_parser.to_s
-      end
+            input = STDIN.tty? ? nil : STDIN.read
 
-      ##
-      # Shows the version and exits the program.
-      #
-      def show_version
-        abort "#{option_parser.program_name} v#{VERSION} on #{RUBY_DESCRIPTION}"
+            puts parser.run(input)
+          end
+        end
       end
     end # CLI
-  end # Ner
+  end # ConstituentParser
 end # Opener

data/lib/opener/ner/server.rb

@@ -1,16 +1,15 @@
-require 'sinatra/base'
 require 'opener/webservice'
-require 'httpclient'
 
 module Opener
   class Ner
     ##
     # NER server powered by Sinatra.
     #
-    class Server < Webservice
+    class Server < Webservice::Server
       set :views, File.expand_path('../views', __FILE__)
-      text_processor Ner
-      accepted_params :input
+
+      self.text_processor  = Ner
+      self.accepted_params = [:input]
     end # Server
   end # Ner
 end # Opener

data/lib/opener/ner/version.rb

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

data/opener-ner.gemspec

@@ -22,14 +22,12 @@ Gem::Specification.new do |gem|
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
-  gem.add_dependency 'sinatra', '~> 1.4'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'nokogiri'
-  gem.add_dependency 'puma'
-  gem.add_dependency 'opener-daemons'
   gem.add_dependency 'opener-ner-base', ['~> 3.0']
-  gem.add_dependency 'opener-webservice'
-  gem.add_dependency 'opener-core', '~> 1.0'
+  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_development_dependency 'rake'
 end

metadata

@@ -1,101 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: opener-ner
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: opener-ner-base
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
   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'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  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: '3.0'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: opener-daemons
   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: opener-webservice
   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: opener-ner-base
+  name: opener-core
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-webservice
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -108,20 +80,6 @@ dependencies:
         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: '1.0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
   version_requirements: !ruby/object:Gem::Requirement