opener-opinion-detector-basic 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fba3c1e1c36909714262f98b74b56d063e001ce
-  data.tar.gz: d9373a0f72ae696444c98c5a5fb164a64123618e
+  metadata.gz: 173429b1415402fbd4d6c14010d3706a95dc3c70
+  data.tar.gz: febe0e858ba5af068ed9c5bf242f098223ad133a
 SHA512:
-  metadata.gz: 59f04729557973091725070c69e4313fbc1466c3dafed71e8ef8ad92b987c264ea4beeb85ebfbc7128adfb6651dc5459189a6f49f78be537eb531f630dada5db
-  data.tar.gz: 26bcd2d87e98bdd6f8483aaffb42e39e04e07cd8d97f1fd822cc169c9ab81879148a305e804bcae8f1e7deb0b6fff02fc7af2fc88aba6fdb75903702caa947fe
+  metadata.gz: 746417484cd6597a9df72938f8d020a9d4ef38a492d0e475881b12b068c832096f6ed96c9fd93668034391cc14015ea504a72baf827160b119de748c06c18b12
+  data.tar.gz: 3ce4ff9e02b75daeedf3757459545919efed36b64c1a6cdbaf2e7546ec82fca5c051ff8be5cc0530359224ba5dee38d07bfed412cae0b16eb42726de6a30c556

data/README.md

@@ -1,22 +1,19 @@
 Opinion Detector Basic
 ---------------------
 
-This module implements a opinion detector for English (also works for Dutch and
-German). 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.
+
 ### 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
 -----------------
@@ -25,14 +22,11 @@ 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 bare 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:
 
@@ -68,26 +62,19 @@ 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:
+To launch it on a different port provide the `-p [port-number]` option like this:
 
     opinion-detector-basic-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 ```-h``` 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
 
@@ -95,9 +82,7 @@ information type:
 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:
 
@@ -121,14 +106,14 @@ Language Extension
 Where to go from here
 ---------------------
 
-* [Check the project websitere](http://opener-project.github.io)
+* [Check the project website](http://opener-project.github.io)
 * [Checkout the webservice](http://opener.olery.com/opinion-detector-basic)
 
 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/opinion-detector-basic/issues).
+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

data/bin/opinion-detector-basic

@@ -12,8 +12,4 @@ end
 kernel                  = Opener::OpinionDetectorBasic.new(:args => ARGV)
 stdout, stderr, process = kernel.run(input)
 
-if process.success?
-  puts stdout
-else
-  abort stderr
-end
+puts stdout

data/lib/opener/opinion_detector_basic/error_layer.rb

@@ -0,0 +1,90 @@
+require 'nokogiri'
+
+module Opener
+  class OpinionDetectorBasic
+    ##
+    # Add Error Layer to KAF file instead of throwing an error.
+    #
+    class ErrorLayer
+      attr_accessor :input, :document, :error, :klass
+      
+      def initialize(input, error, klass)
+        @input    = input.to_s
+        # Make sure there is always a document, even if it is empty.
+        @document = Nokogiri::XML(input) rescue Nokogiri::XML(nil)
+        @error    = error
+        @klass    = klass
+      end
+      
+      def add
+        if is_xml?
+          unless has_errors_layer?
+            add_errors_layer
+          end
+        else
+          add_root
+          add_text
+          add_errors_layer
+        end
+        add_error
+        
+        xml = !!document.encoding ? document.to_xml : document.to_xml(:encoding => "UTF-8")
+        
+        return xml
+      end
+      
+      ##
+      # Check if the document is a valid XML file.
+      #
+      def is_xml?
+        !!document.root
+      end
+      
+      ##
+      # Add root element to the XML file.
+      #
+      def add_root
+        root = Nokogiri::XML::Node.new "KAF", document
+        document.add_child(root)
+      end
+      
+      ##
+      # Check if the document already has an errors layer.
+      #
+      def has_errors_layer?
+        !!document.at('errors')
+      end
+      
+      ##
+      # Add errors element to the XML file.
+      #
+      def add_errors_layer
+        node = Nokogiri::XML::Node.new "errors", document
+        document.root.add_child(node)
+      end
+      
+      ##
+      # Add the text file incase it is not a valid XML document. More
+      # info for debugging.
+      #
+      def add_text
+        node = Nokogiri::XML::Node.new "raw", document
+        node.inner_html = input
+        document.root.add_child(node)
+        
+      end
+      
+      ##
+      # Add the actual error to the errors layer.
+      #
+      def add_error
+        node = document.at('errors')
+        error_node = Nokogiri::XML::Node.new "error", node
+        error_node['class']   = "#{klass.to_s} #{klass::VERSION}"
+        error_node.inner_html = error
+        node.add_child(error_node)
+      end     
+      
+    end # ErrorLayer
+  end # OpinionDetectorBasic
+end # Opener

data/lib/opener/opinion_detector_basic/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class OpinionDetectorBasic
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/lib/opener/opinion_detector_basic.rb

@@ -1,6 +1,7 @@
 require 'open3'
 
 require_relative 'opinion_detector_basic/version'
+require_relative 'opinion_detector_basic/error_layer'
 
 module Opener
 
@@ -38,7 +39,15 @@ module Opener
     # @return [Array]
     #
     def run(input)
-      capture(input)
+      begin
+        capture(input)
+        stdout, stderr, process = capture(input)
+        raise stderr unless process.success?
+        return stdout
+        
+      rescue Exception => error
+        return ErrorLayer.new(input, error.message, self.class).add
+      end
     end
 
     protected

data/opener-opinion-detector-basic.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.2'
 
   gem.files = Dir.glob([
-    'core/site-packages/pre_build/**/*',
     'core/packages/*',
     'core/vendor/src/**/*',
     'core/*',
@@ -35,6 +34,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'opener-daemons'
   gem.add_dependency 'opener-core', ['>= 0.1.2']
   gem.add_dependency 'opener-webservice'
+  gem.add_dependency 'nokogiri'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'cucumber'

metadata

@@ -1,161 +1,175 @@
 --- !ruby/object:Gem::Specification
 name: opener-opinion-detector-basic
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - development@olery.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opener-build-tools
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.7
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
+  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'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: sinatra
   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'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: httpclient
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: puma
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !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
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-daemons
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-core
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: opener-core
+        version: 0.1.2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.2
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-webservice
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.1.2
-- !ruby/object:Gem::Dependency
-  name: opener-webservice
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: cucumber
   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: :development
 description: Basic Opinion Detector.
-email: 
+email:
 executables:
-- opinion-detector-basic-server
 - opinion-detector-basic
 - opinion-detector-basic-daemon
+- opinion-detector-basic-server
 extensions:
 - ext/hack/Rakefile
 extra_rdoc_files: []
@@ -308,6 +322,7 @@ files:
 - ext/hack/Rakefile
 - ext/hack/support.rb
 - lib/opener/opinion_detector_basic.rb
+- lib/opener/opinion_detector_basic/error_layer.rb
 - lib/opener/opinion_detector_basic/public/markdown.css
 - lib/opener/opinion_detector_basic/server.rb
 - lib/opener/opinion_detector_basic/version.rb
@@ -318,25 +333,24 @@ files:
 homepage: http://opener-project.github.com/
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.2.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Basic Opinion Detector.
 test_files: []
-has_rdoc: