opener-tree-tagger 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4856dbf455d4598c83e69c973613c3ebaf29ff10
-  data.tar.gz: 12f3b098d50619f459388bcecf967986522035ae
+  metadata.gz: be445f3932e633ffbe7c11fd31393801c72cc025
+  data.tar.gz: f3900dd4dd481cac768268bed936db806dfa710c
 SHA512:
-  metadata.gz: 4f0809d73b7010d0113b1350f6b43660f4baa1d0d79736bbdd2e7995ace7710497e18fea0c86a6e72fcacc1ecd9c62e394139653c669504b1f0b43775ee9ab70
-  data.tar.gz: 669c0966558d135693c42c58d8eca25979d56531e05738346d397bc69f57e8ce802c1fdf865cd93eae4aaa139fb366f9382e9e1680c4d3628db46e5c53678034
+  metadata.gz: a3abb1d49a7e01e084b6c4b451405586f6e83ce67ff1c086d5965bb6b906b1687e748ca7a3312a26e2d431c10b48a716ea892a72b882dcdde1a70e0dcf8d4f4f
+  data.tar.gz: bae2c53f3f670d810b53e35cf126791a09f6106b0841c3b24d90165abb91a0c4234be6d4606dff2a63a721bf3129a665355aa2e307cd38934f698bd2e2cc3095

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

@@ -3,13 +3,28 @@
 Introduction
 ------------
 
-This module implements a wrapper to process text with the PoS tagger TreeTagger. TreeTagger is a tool that assigns the lemmas and part-of-speech information to an input text. This module takes KAF as input, with the token layer created (for instance by one of our tokenizer modules) and outputs KAF with a new term layer. It is important to note that the token layer in the input is not modified in the output, so the program takes care of performing the correct matching between the term and the token layer.
-
-The language of the input KAF text has to be specified through the attribute xml:lang in the main KAF element. This module works for text in all the languages covered by the OpeNER project (English, Dutch,German, Italian, Spanish and French). It can be easily extended to other languages by downloading the specific TreeTagger models for that language and providing a mapping from the tagset used by these models to the tagset defined in KAF. 
+This module implements a wrapper to process text with the PoS tagger TreeTagger.
+TreeTagger is a tool that assigns the lemmas and part-of-speech information to
+an input text. This module takes KAF as input, with the token layer created (for
+instance by one of our tokenizer modules) and outputs KAF with a new term layer.
+It is important to note that the token layer in the input is not modified in the
+output, so the program takes care of performing the correct matching between the
+term and the token layer.
+
+The language of the input KAF text has to be specified through the attribute
+xml:lang in the main KAF element. This module works for text in all the
+languages covered by the OpeNER project (English, Dutch,German, Italian, Spanish
+and French). It can be easily extended to other languages by downloading the
+specific TreeTagger models for that language and providing a mapping from the
+tagset used by these models to the tagset defined in KAF.
 
 ### 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
 -----------------
@@ -18,25 +33,32 @@ Installing the tree-tagger can be done by executing:
 
     gem install opener-tree-tagger
 
-Also make sure you have tree-tagger and the proper language files installed AND that you set the path to the tree-tagger in the TREE_TAGGER_PATH environment variable.
+Also make sure you have tree-tagger and the proper language files installed AND
+that you set the path to the tree-tagger in the `TREE_TAGGER_PATH` environment
+variable.
 
-Besides that, make sure you install lxml. You can probably achieve this by typing 
+Besides that, make sure you install lxml. You can probably achieve this by
+typing
 
     pip install lxml
 
-If that doesn't work, please check the [installation guide on the OpeNER portal](http://opener-project.github.io/getting-started/how-to/local-installation.html).
+If that doesn't work, please check the
+[installation guide on the OpeNER portal](http://opener-project.github.io/getting-started/how-to/local-installation.html).
 
-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 tree-tagger 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 tree-tagger 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 | tree-tagger
 
-
 This will output KAF xml.
 
 ### Webservices
@@ -45,58 +67,70 @@ You can launch a language identification webservice by executing:
 
     tree-tagger-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 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:
 
     tree-tagger-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 tree-tagger 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 tree-tagger comes shipped with a daemon that can read
+jobs (and write) jobs to and from Amazon SQS queues. For more information type:
 
     tree-tagger-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)
+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:
 
-* Ruby (Tested on MRI and JRuby) 1.9.3 
+* Ruby (Tested on MRI and JRuby) 1.9.3
 * Python 2.6
 * LXML installed
-* This module has a dependency on the following external module: TreeTagger (http://www.ims.uni-stuttgart.de/projekte/corplex/TreeTagger/) More information is further down in this document.
-* Tree tagger installed and it's path know in TREE_TAGGER_PATH environment
+* This module has a dependency on the following external module: TreeTagger
+  (<http://www.ims.uni-stuttgart.de/projekte/corplex/TreeTagger/>) More
+  information is further down in this document.
+* Tree tagger installed and it's path know in `TREE_TAGGER_PATH` environment
   variable.
 
-If TreeTagger is not installed in your machine you can download it from <http://www.ims.uni-stuttgart.de/projekte/corplex/TreeTagger/> and follow the installation instructions. To indicate to our scripts where TreeTagger is located, you have to set an environment variable with the location:
+If TreeTagger is not installed in your machine you can download it from
+<http://www.ims.uni-stuttgart.de/projekte/corplex/TreeTagger/> and follow the
+installation instructions. To indicate to our scripts where TreeTagger is
+located, you have to set an environment variable with the location:
 
-```shell
-export TREE_TAGGER_PATH=/usr/local/TreeTagger/
-```
+    export TREE_TAGGER_PATH=/usr/local/TreeTagger/
 
 It is advised you add the path to the tree tagger in your bash or zsh profile by
-adding it to ```~/.bash_profile``` or ```~/.zshrc```
+adding it to `~/.bash_profile` or `~/.zshrc`.
 
 Language Extension
 ------------------
 
-The tree-tagger depends on the availability of Tree Tagger models. Check out the tree tagger website for more languages. Also you'll have to update the py files in the core directory.
+The tree-tagger depends on the availability of Tree Tagger models. Check out the
+tree tagger website for more languages. Also you'll have to update the Python
+files in the core directory.
 
 The Core
 --------
 
-The component is a fat wrapper around the actual language technology core. You can find the core technolies in the core directory of this repository.
+The component is a wrapper around the actual language technology core. You
+can find the core technolies in the core directory of this repository.
 
 Where to go from here
 ---------------------
@@ -107,9 +141,9 @@ Where to go from here
 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/tree-tagger/issues].
-
+If you encounter problems, please email <support@opener-project.eu> or leave an
+issue in the
+[issue tracker](https://github.com/opener-project/tree-tagger/issues).
 
 Contributing
 ------------

data/bin/tree-tagger-daemon

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

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

data/exec/tree-tagger.rb

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

data/lib/opener/tree_tagger.rb

@@ -1,7 +1,6 @@
 require 'open3'
 require 'optparse'
 require 'nokogiri'
-require 'opener/core'
 
 require_relative 'tree_tagger/version'
 require_relative 'tree_tagger/cli'
@@ -36,9 +35,6 @@ module Opener
       raise stderr unless process.success?
 
       return stdout
-
-    rescue Exception => error
-      return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
     end
 
     def capture(input)

data/lib/opener/tree_tagger/server.rb

@@ -1,5 +1,3 @@
-require 'sinatra/base'
-require 'httpclient'
 require 'opener/webservice'
 
 module Opener
@@ -7,10 +5,11 @@ module Opener
     ##
     # Polarity tagger server powered by Sinatra.
     #
-    class Server < Webservice
+    class Server < Webservice::Server
       set :views, File.expand_path('../views', __FILE__)
-      text_processor TreeTagger
-      accepted_params :input
+
+      self.text_processor  = TreeTagger
+      self.accepted_params = [:input]
     end # Server
   end # PolarityTagger
 end # Opener

data/lib/opener/tree_tagger/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class TreeTagger
-    VERSION = "3.3.0"
+    VERSION = '4.0.0'
   end
 end

data/opener-tree-tagger.gemspec

@@ -5,11 +5,13 @@ Gem::Specification.new do |gem|
   gem.version     = Opener::TreeTagger::VERSION
   gem.authors     = ["rubenIzquierdo", "sparkboxx"]
   gem.email       = ["ruben.izquierdobevia@vu.nl", "wilco@olery.com"]
-  gem.description = %q{Ruby wrapped KAF based Tree Tagger for 6 languages }
+  gem.description = %q{Ruby wrapped KAF based Tree Tagger for 6 languages}
   gem.summary     = gem.description
   gem.homepage    = "http://opener-project.github.com/"
   gem.extensions  = ['ext/hack/Rakefile']
 
+  gem.license = 'Apache 2.0'
+
   gem.files = Dir.glob([
     'core/*',
     'exec/*',
@@ -19,18 +21,17 @@ Gem::Specification.new do |gem|
     '*.gemspec',
     '*_requirements.txt',
     'README.md',
+    'LICENSE.txt',
     'task/*'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
-  gem.add_dependency 'opener-daemons'
+  gem.add_dependency 'opener-daemons', '~> 2.1'
+  gem.add_dependency 'opener-webservice', '~> 2.1'
+  gem.add_dependency 'opener-core', '~> 2.0'
+
   gem.add_dependency 'rake'
-  gem.add_dependency 'sinatra'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'puma'
-  gem.add_dependency 'opener-webservice'
-  gem.add_dependency 'opener-core', ['>= 1.0.2', '~> 1.0']
   gem.add_dependency 'nokogiri'
   gem.add_dependency 'cliver'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opener-tree-tagger
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - rubenIzquierdo
@@ -9,80 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opener-daemons
   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: rake
-  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: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: opener-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: opener-webservice
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,26 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +123,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Ruby wrapped KAF based Tree Tagger for 6 languages '
+description: Ruby wrapped KAF based Tree Tagger for 6 languages
 email:
 - ruben.izquierdobevia@vu.nl
 - wilco@olery.com
@@ -183,6 +135,7 @@ extensions:
 - ext/hack/Rakefile
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - bin/tree-tagger
 - bin/tree-tagger-daemon
@@ -214,7 +167,8 @@ files:
 - task/requirements.rake
 - task/test.rake
 homepage: http://opener-project.github.com/
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []