opener-kaf2json 1.1.1-java → 2.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 586646679121ccd4d2180500b7638a6a8f1e0d0d
-  data.tar.gz: 024f2d20e458dfc884152014fc42ed1f3b4ff9be
+  metadata.gz: 6189b9563f53756f473c46ab38e63fb5e6f4eb7c
+  data.tar.gz: 0676e9747e6ae3f01e06bbf852d958e6cd09edfd
 SHA512:
-  metadata.gz: 28a9e7055ad249a64e9596cce02263c2714d0008c5f38f5383cb11ea1f405f2076338a203ea8e86d39f75f92eca61bc8cae7acf5f56132e4cc8008dd075f698e
-  data.tar.gz: 5d46f27fc2d8451d4a3e3171b91af971a7aa26744a5d187e4240f94c4bb34437cea0a43153865e87f1794fca48698ab5bce76874c51e0b3c2a8957c589314c24
+  metadata.gz: 828e9063625de95d67442e1279689130280700be184387bc6afe59746816cb4b79cfeaff7f542770184c15bbb901642e2d26066487707ad08cfee68f89bbbfa6
+  data.tar.gz: 42661053b7e7cecbd8039c0b98cdde65b2dc02dfa64b14ebf555ae87108a58fac08d3d874c4d5add7cc3834a2395fda0bb2f38fcbe68a69473eb770e1e086825

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,43 +1,52 @@
-kaf2json
-------------
+# KAF to JSON
 
-Even if KAF is the true OpeNER data representation format, it is not very friendly for humans. It is also difficult to parse and work with it, specially for new users that are not familiarized with KAF. This is part of the feedback we got from the OpeNER hackathon held in Amsterdam during first days of July. To ease the post-processing of the results by any potential user, we are designing an alternative JSON format to output translate KAF, and turn its complexity into a much more usable format. Although, the specification for this JSON is currently work in progress, we have already a version that covers the most relevant parts from the KAF representation.
+Even if KAF is the true OpeNER data representation format, it is not very
+friendly for humans. It is also difficult to parse and work with it, specially
+for new users that are not familiarized with KAF. This is part of the feedback
+we got from the OpeNER hackathon held in Amsterdam during first days of July. To
+ease the post-processing of the results by any potential user, we are designing
+an alternative JSON format to output translate KAF, and turn its complexity into
+a much more usable format. Although, the specification for this JSON is
+currently work in progress, we have already a version that covers the most
+relevant parts from the KAF representation.
 
-### 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 kaf2json can be done by executing:
 
     gem install opener-kaf2json
 
-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 kaf2json as a regular shell command: by its name. Once installed the gem normally sits in your path so you can call it directly from anywhere.
+You should now be able to call the kaf2json as a regular shell command: by its
+name. Once installed the gem normally sits in your path so you can call it
+directly from anywhere.
 
 This aplication reads a text from standard input in order to convert it to JSON.
 
     cat some_kind_of_kaf_file.kaf | kaf2json
 
+The output will look like the following JSON:
 
-This will output (JSON Format):
-
-```
-{
-	"text"      : "Beatrix Wilhelmina Armgard van Oranje -Nassau (Baarn , 31 januari 1938 ) is sinds 30 april 1980 koningin van het Koninkrijk der Nederlandén ",
-	"language"  : "nl",
-	"terms"     : {},
-	"sentiments": [],
-	"entities"  : {},
-	"opinions"  : {}
-}
-```
+    {
+        "text"      : "Beatrix Wilhelmina Armgard van Oranje -Nassau (Baarn , 31 januari 1938 ) is sinds 30 april 1980 koningin van het Koninkrijk der Nederlandén ",
+        "language"  : "nl",
+        "terms"     : {},
+        "sentiments": [],
+        "entities"  : {},
+        "opinions"  : {}
+    }
 
 ### Webservices
 
@@ -45,28 +54,32 @@ You can launch a webservice by executing:
 
     kaf2json-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:
 
     kaf2json-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 kaf2json 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 kaf2json comes shipped with a daemon that can read jobs
+(and write) jobs to and from Amazon SQS queues. For more information type:
 
     kaf2json-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:
@@ -75,28 +88,17 @@ At least you need the following system setup:
 
 * JRuby 1.7.9 or newer
 
-The Core
---------
-
-The component is a fat wrapper around the actual language technology core. You can find the core technolies in the following repositories:
-
-* (link to) Related Core readmes
-
-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/kaf2json)
 
-Report problem/Get help
------------------------
+## Report problem/Get help
 
 If you encounter problems, please email support@opener-project.eu or leave an
 [issue tracker](https://github.com/opener-project/kaf2json/issues).
 
-
-Contributing
-------------
+## Contributing
 
 1. Fork it <http://github.com/opener-project/kaf2json/fork>
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/kaf2json

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+
 require_relative '../lib/opener/kaf_to_json'
 
-cli = Opener::KafToJson.new(:args => ARGV)
+cli = Opener::KafToJson::CLI.new
 
-puts cli.run(STDIN.tty? ? nil : STDIN.read)
+cli.run

data/bin/kaf2json-daemon

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

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

data/exec/kaf-to-json.rb

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

data/lib/opener/kaf_to_json/cli.rb

@@ -0,0 +1,58 @@
+module Opener
+  class KafToJson
+    ##
+    # CLI wrapper around {Opener::KafToJson} using Slop.
+    #
+    # @!attribute [r] parser
+    #  @return [Slop]
+    #
+    class CLI
+      attr_reader :parser
+
+      def initialize
+        @parser = configure_slop
+      end
+
+      ##
+      # @param [Array] argv
+      #
+      def run(argv = ARGV)
+        parser.parse(argv)
+      end
+
+      ##
+      # @return [Slop]
+      #
+      def configure_slop
+        return Slop.new(:strict => false, :indent => 2, :help => true) do
+          banner 'Usage: kaf2json [OPTIONS]'
+
+          separator <<-EOF.chomp
+
+About:
+
+    Component that converts a given KAF document into a JSON object.
+    This command reads input from STDIN.
+
+Example:
+
+    cat some_file.kaf | kaf2json
+          EOF
+
+          separator "\nOptions:\n"
+
+          on :v, :version, 'Shows the current version' do
+            abort "kaf2json v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
+
+          run do |opts, args|
+            converter = KafToJson.new
+            input     = STDIN.tty? ? nil : STDIN.read
+
+            puts converter.run(input)
+          end
+        end
+      end
+    end # CLI
+  end # KafToJson
+end # Opener

data/lib/opener/kaf_to_json/server.rb

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

data/lib/opener/kaf_to_json/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class KafToJson
-    VERSION = "1.1.1"
+    VERSION = '2.0.0'
   end
 end

data/lib/opener/kaf_to_json.rb

@@ -1,65 +1,48 @@
+require 'slop'
 require 'saxon-xslt'
-require 'opener/core'
 
 require_relative 'kaf_to_json/version'
 require_relative 'kaf_to_json/server'
+require_relative 'kaf_to_json/cli'
 
 module Opener
   ##
-  # Primary POS tagger class that delegates work the various POS tagging
-  # kernels.
-  #
-  # @!attribute [r] options
-  #  @return [Hash]
+  # Component for converting KAF documents to JSON objects.
   #
   class KafToJson
-    attr_reader :options
-
     ##
-    # Hash containing the default options to use.
+    # This method takes a single argument that is ignored to ensure
+    # compatibility with all the other OpeNER components.
     #
-    # @return [Hash]
-    #
-    DEFAULT_OPTIONS = {
-      :args => []
-    }.freeze
+    def initialize(*); end
 
     ##
-    # @param [Hash] options
+    # Processes the input KAF document and returns a String containing the JSON
+    # output.
     #
-    # @option options [Array] :args Arbitrary arguments to pass to the
-    #  underlying kernel.
+    # @param [String] input The input to process.
+    # @return [String]
     #
-    def initialize(options = {})
-      @options = DEFAULT_OPTIONS.merge(options)
+    def run(input)
+      doc  = Saxon::XML(input)
+      xslt = Saxon::XSLT(File.read(xsl))
+
+      return xslt.transform(doc).to_s
     end
 
+    alias tag run
+
     ##
-    # Processes the input and returns an Array containing the output of STDOUT,
-    # STDERR and an object containing process information.
+    # The output type to use in the webservices.
     #
-    # @param [String] input The input to process.
-    # @return [Array]
+    # @return [Symbol]
     #
-    def run(input)
-      begin
-        doc = Saxon::XML(input)
-        xslt = Saxon::XSLT(File.read(xsl))
-        return xslt.transform(doc).to_string
-        
-      rescue Exception => error
-        return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
-      end
-    end
-    
-    alias tag run
-    
     def output_type
       return :json
     end
-    
+
     private
-    
+
     ##
     # @return [String]
     #
@@ -75,4 +58,3 @@ module Opener
     end
   end # KafToJson
 end # Opener
-

data/opener-kaf2json.gemspec

@@ -11,25 +11,28 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.2'
   gem.platform              = 'java'
 
+  gem.license = 'Apache 2.0'
+
   gem.files = Dir.glob([
     'config/*',
     'lib/**/*',
     'config.ru',
     '*.gemspec',
     'README.md',
+    'LICENSE.txt',
     'exec/**/*'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
+  gem.add_dependency 'opener-daemons', '~> 2.2'
+  gem.add_dependency 'opener-webservice', '~> 2.1'
+  gem.add_dependency 'opener-core', '~> 2.2'
+
   gem.add_dependency 'builder'
-  gem.add_dependency 'sinatra', '~>1.4.2'
   gem.add_dependency 'nokogiri'
   gem.add_dependency 'saxon-xslt'
-  gem.add_dependency 'puma'
-  gem.add_dependency 'opener-daemons'
-  gem.add_dependency 'opener-webservice'
-  gem.add_dependency 'opener-core', '~> 1.0'
+  gem.add_dependency 'slop', '~> 3.5'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'cucumber'

metadata

@@ -1,73 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: opener-kaf2json
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: java
 authors:
 - development@olery.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: builder
-  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: sinatra
+  name: opener-daemons
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '2.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '2.2'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  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: saxon-xslt
+  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: puma
+  name: builder
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +67,7 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-daemons
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,7 +81,7 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: opener-webservice
+  name: saxon-xslt
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -109,17 +95,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
@@ -181,27 +167,30 @@ dependencies:
 description: Converts KAF input into JSON
 email:
 executables:
-- kaf2json
 - kaf2json-daemon
 - kaf2json-server
+- kaf2json
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- bin/kaf2json
-- bin/kaf2json-daemon
-- bin/kaf2json-server
-- config.ru
 - config/kaf2json.xsl
-- exec/kaf-to-json.rb
 - lib/opener/kaf_to_json.rb
-- lib/opener/kaf_to_json/public/markdown.css
-- lib/opener/kaf_to_json/server.rb
 - lib/opener/kaf_to_json/version.rb
+- lib/opener/kaf_to_json/server.rb
+- lib/opener/kaf_to_json/cli.rb
+- lib/opener/kaf_to_json/public/markdown.css
 - lib/opener/kaf_to_json/views/index.erb
+- config.ru
 - opener-kaf2json.gemspec
+- README.md
+- LICENSE.txt
+- exec/kaf-to-json.rb
+- bin/kaf2json-daemon
+- bin/kaf2json-server
+- bin/kaf2json
 homepage: http://opener-project.github.com/
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -219,8 +208,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: Converts KAF input into JSON
 test_files: []
+has_rdoc: yard