opener-opinion-detector-basic 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15594a72e55cc49a04e35a1d9d798fa3642b2a98
-  data.tar.gz: 2c91b6ed446a7135046b9dc3450769aaf8f9cec6
+  metadata.gz: 8ffb23060aa771379f81ad7e3afeb854dc0b02f9
+  data.tar.gz: 6c3cc572d420793124bef66ee3e8a43e4d09ee61
 SHA512:
-  metadata.gz: c5cc2d1a82f6c1e3f3332b46274604326321bcade393cf57f30c0c3e0ca50d06d2472da9c27458ed71d3957e904ea41e31459c61136991bfc84565382e5b3cd4
-  data.tar.gz: 500b0cd9fbfc621dee215d42e5c173768607a4c5e0abfc10f8b74d935b6df74188183a6094cd2949d3ed92adf808e9701e3d116f60ecd243b075e7f68b65881a
+  metadata.gz: 6ffc414059c2e342934f708b04065defa434f572cf90bf1f587a4a6abb8baee4147eb1fdd0a0c0f6f7f6acf4fc18611780792f91974f378f872a4fa7697ca227
+  data.tar.gz: 37f14ff748c15df4d9454b7862ec1b459c75f860ccb6b6cdfea2ca51bc2e63f67aa42352b71d7acd698f583f14a475e815aa59f8cf86390405cd6bc13cd05863

data/README.md

@@ -1,32 +1,43 @@
-Opinion Detector Basic
----------------------
+# Opinion Detector Basic
 
-This module implements a opinion detector for all the languages covered in the OpeNER project (English, Dutch, German, Italian,
-Spanish and French). The language is determined by the "xml:lang" attribut in the input KAF file. Depending on the value of this attribute, the corresponding lexicon will be loaded. This module detects three elements of the opinions:
+This module implements a opinion detector for all the languages covered in the
+OpeNER project (English, Dutch, German, Italian, Spanish and French). The
+language is determined by the "xml:lang" attribut in the input KAF file.
+Depending on the value of this attribute, the corresponding lexicon will be
+loaded. This module detects three elements of the opinions:
 
 * Expression: the actual opinion expression
 * Target: about what is the previous expression
 * Holder: who is stating that expression
 
-This module is based on a set of rules for extracting the opinion expressions first (taking into account polarity words and sentiment modifiers) and then other
-rules to determine the targets and holders for those expressions. The input KAF file needs to be processed at least with the tokenizer, pos-tagger and polarity-tagger.
+This module is based on a set of rules for extracting the opinion expressions
+first (taking into account polarity words and sentiment modifiers) and then
+other rules to determine the targets and holders for those expressions. The
+input KAF file needs to be processed at least with the tokenizer, pos-tagger and
+polarity-tagger.
 
-### 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 opinion-detector-basic can be done by executing:
 
     gem install opener-opinion-detector-basic
 
-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
 
-The input KAF file has to be annotated with at least the term layer, with polarity information.  Correct input files for this module are the output KAF files from the polarity tagger module
+The input KAF file has to be annotated with at least the term layer, with
+polarity information.  Correct input files for this module are the output KAF
+files from the polarity tagger module
 
 To tag an input KAF file example.kaf with opinions you can run:
 
@@ -36,25 +47,23 @@ The output will the input KAF file extended with the opinion layer.
 
 Excerpt of example output.
 
-```
-<opinions>
-  <opinion oid="o1">
-    <opinion_target>
-      <!--hotel-->
-      <span>
-        <target id="t_6"/>
-      </span>
-    </opinion_target>
-    <opinion_expression polarity="positive" strength="2">
-      <!--heel mooi-->
-      <span>
-        <target id="t_4"/>
-        <target id="t_5"/>
-      </span>
-    </opinion_expression>
-  </opinion>
-</opinions>
-```
+    <opinions>
+      <opinion oid="o1">
+        <opinion_target>
+          <!--hotel-->
+          <span>
+            <target id="t_6"/>
+          </span>
+        </opinion_target>
+        <opinion_expression polarity="positive" strength="2">
+          <!--heel mooi-->
+          <span>
+            <target id="t_4"/>
+            <target id="t_5"/>
+          </span>
+        </opinion_expression>
+      </opinion>
+    </opinions>
 
 ### Webservices
 
@@ -62,7 +71,8 @@ You can launch a webservice by executing:
 
     opinion-detector-basic-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:
 
@@ -70,19 +80,24 @@ To launch it on a different port provide the `-p [port-number]` option like this
 
 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 opinion detector basic 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 opinion detector basic comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
 
     opinion-detector-basic-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 [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:
 
@@ -92,32 +107,26 @@ At least you need the following system setup:
 * Python 2.6
 * lxml: library for processing xml in python
 
-Domain Adaption
----------------
-
-  TODO
+## Domain Adaption
 
-Language Extension
-------------------
+TODO
 
-  TODO
+## Language Extension
 
+TODO
 
-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/opinion-detector-basic)
 
-Report problem/Get help
------------------------
+## Report problem/Get help
 
-If you encounter problems, please email <support@opener-project.eu> or leave an issue in the 
+If you encounter problems, please email <support@opener-project.eu> or leave an
+issue in the
 [issue tracker](https://github.com/opener-project/opinion-detector-basic/issues).
 
-
-Contributing
-------------
+## Contributing
 
 1. Fork it <http://github.com/opener-project/opinion-detector-basic/fork>
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/opinion-detector-basic

@@ -2,14 +2,6 @@
 
 require_relative '../lib/opener/opinion_detector_basic'
 
-# STDIN.tty? returns `false` if data is being piped into the current process.
-if STDIN.tty?
-  input = nil
-else
-  input = STDIN.read
-end
+cli = Opener::OpinionDetectorBasic::CLI.new
 
-kernel                  = Opener::OpinionDetectorBasic.new(:args => ARGV)
-stdout, stderr, process = kernel.run(input)
-
-puts stdout
+cli.run

data/bin/opinion-detector-basic-daemon

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

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

data/exec/opinion-detector-basic.rb

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

data/lib/opener/opinion_detector_basic.rb

@@ -1,25 +1,31 @@
 require 'open3'
-require 'opener/core'
+require 'slop'
 
 require_relative 'opinion_detector_basic/version'
+require_relative 'opinion_detector_basic/cli'
 
 module Opener
-
-
   ##
-  # The basic Opinion detector.
+  # Rule based opinion detector.
   #
   # @!attribute [r] args
   #  @return [Array]
+  #
   # @!attribute [r] options
   #  @return [Hash]
   #
   class OpinionDetectorBasic
     attr_reader :args, :options
 
+    ##
+    # @param [Hash] options
+    #
+    # @option options [Array] :args Command-line arguments to pass to the
+    #  underlying Python kernel.
+    #
     def initialize(options = {})
-      @args          = options.delete(:args) || []
-      @options       = options
+      @args    = options.delete(:args) || []
+      @options = options
     end
 
     ##
@@ -32,36 +38,35 @@ module Opener
     end
 
     ##
-    # Runs the command and returns the output of STDOUT, STDERR and the
-    # process information.
+    # Processes an input KAF document and returns the results as a new KAF
+    # document.
     #
-    # @param [String] input The input to tag.
-    # @return [Array]
+    # @param [String] input
+    # @return [String]
     #
     def run(input)
-      begin
-        stdout, stderr, process = capture(input)
-        raise stderr unless process.success?
-        return stdout
+      stdout, stderr, process = capture(input)
 
-      rescue Exception => error
-        return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
-      end
+      raise stderr unless process.success?
+
+      return stdout
     end
 
     protected
+
     ##
     # @return [String]
     #
     def adjust_python_path
       site_packages =  File.join(core_dir, 'site-packages')
-      "env PYTHONPATH=#{site_packages}:$PYTHONPATH"
+
+      return "env PYTHONPATH=#{site_packages}:$PYTHONPATH"
     end
+
     ##
     # capture3 method doesn't work properly with Jruby, so
     # this is a workaround
     #
-
     def capture(input)
       Open3.popen3(*command.split(" ")) {|i, o, e, t|
         out_reader = Thread.new { o.read }
@@ -91,9 +96,8 @@ module Opener
     #
     def language(input)
       document = Nokogiri::XML(input)
-      language = document.at('KAF').attr('xml:lang')
-      return language
-    end
 
+      return document.at('KAF').attr('xml:lang')
+    end
   end # OpinionDetectorBasic
 end # Opener

data/lib/opener/opinion_detector_basic/cli.rb

@@ -0,0 +1,62 @@
+module Opener
+  class OpinionDetectorBasic
+    ##
+    # CLI wrapper around {Opener::OpinionDetectorBasic} 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: opinion-detector-basic [OPTIONS]'
+
+          separator <<-EOF.chomp
+
+About:
+
+    Rule based opinion detection for various languages such as Dutch and
+    English. This command reads input from STDIN.
+
+Example:
+
+    cat some_file.kaf | opinion-detector-basic
+          EOF
+
+          separator "\nOptions:\n"
+
+          on :v, :version, 'Shows the current version' do
+            abort "opinion-detector-basic v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
+
+          run do |opts, args|
+            detector = OpinionDetectorBasic.new(
+              :args   => args,
+              :domain => opts[:domain]
+            )
+
+            input = STDIN.tty? ? nil : STDIN.read
+
+            puts detector.run(input)
+          end
+        end
+      end
+    end # CLI
+  end # OpinionDetectorBasic
+end # Opener

data/lib/opener/opinion_detector_basic/server.rb

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

data/lib/opener/opinion_detector_basic/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class OpinionDetectorBasic
-    VERSION = "1.1.0"
+    VERSION = '2.0.0'
   end
 end

data/opener-opinion-detector-basic.gemspec

@@ -28,15 +28,14 @@ Gem::Specification.new do |gem|
 
   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 'rake'
-  gem.add_dependency 'sinatra'
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'puma'
-  gem.add_dependency 'opener-daemons'
-  gem.add_dependency 'opener-core', '~> 1.0'
-  gem.add_dependency 'opener-webservice'
   gem.add_dependency 'nokogiri'
   gem.add_dependency 'cliver'
+  gem.add_dependency 'slop', '~> 3.5'
 
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'cucumber'

metadata

@@ -1,73 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: opener-opinion-detector-basic
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !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
+  name: opener-daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !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.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: opener-daemons
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +67,7 @@ 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'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: opener-webservice
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: cliver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cliver
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -322,6 +294,7 @@ files:
 - exec/opinion-detector-basic.rb
 - ext/hack/Rakefile
 - lib/opener/opinion_detector_basic.rb
+- lib/opener/opinion_detector_basic/cli.rb
 - lib/opener/opinion_detector_basic/public/markdown.css
 - lib/opener/opinion_detector_basic/server.rb
 - lib/opener/opinion_detector_basic/version.rb