opener-opinion-detector 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04c5af868b17a2e60d8a4ce8f5bfbd32842129fa
+  data.tar.gz: 0348514671da532342f41d71011b226705cadb14
+SHA512:
+  metadata.gz: 633377edd6cf4606e8e24841a8de9ca654008b8c8e6eda5a97c0b564d08969e916e9370c73d25e045ac2baff415021a37534b1c7c81933d05bfa21599e18b49d
+  data.tar.gz: d58166aa6337bc845cb0d542cd7810829e26a2d874542978c39cb7efe8889bd41c6e31428bb7392dfd6ea3a8d603d128d7babe95c5440f38464a79329acf9c2a

data/README.md

@@ -0,0 +1,225 @@
+# OpinionDetector
+
+Component that wraps the different existing Opinion Detectors.
+
+## Requirements
+
+* Perl 5
+* Ruby 1.9.2 or newer
+* Make
+
+## Developers
+
+See how to edit / change / compile this gem at the bottom of this file.
+
+## Installation
+
+### As part of a Gemfile in a Ruby application
+
+Add this line to your application's Gemfile:
+
+    gem 'opener-opinion-detector',
+        :git=>"git@github.com:opener-project/opinion-detector.git"
+
+And then execute:
+
+    $ bundle install
+
+### As a standalone GEM:
+
+Make sure you have the ```specific_install``` gem installed first by running
+
+    $ gem install specific_install
+
+After that you can install the gem from the git repository like this:
+
+    $ gem specific_install opener-opinion-detector \
+        -l https://github.com/opener-project/opinion-detector.git
+
+Once the gem is installed you have access to the following command from
+anywhere on your computer:
+
+    $ cat englist.kaf | opinion-detector
+
+or you can launch a webservice with
+
+    $ opinion-detector-server
+
+KAF file text:
+
+    <?xml version='1.0' encoding='UTF-8'?>
+    <KAF xml:lang="en">
+      <kafHeader>
+        <linguisticProcessors layer="text">
+          <lp timestamp="2013-04-11T09:21:29CEST" version="1.0" name="Open-nlp sentence splitter"/>
+          <lp timestamp="2013-04-11T09:21:29CEST" version="1.0" name="Open-nlp tokenizer"/>
+        </linguisticProcessors>
+        <linguisticProcessor layer="terms">
+          <lp timestamp="2013-04-11T09:23:08CEST" version="1.0" name="Basic_polarity_tagger_with_pos"/>
+        </linguisticProcessor>
+        <linguisticProcessor layer="term">
+          <lp timestamp="2013-04-11T09:23:07CEST" version="1.0" name="TreeTagger_from_kaf"/>
+        </linguisticProcessor>
+      </kafHeader>
+      <text>
+        <wf wid="w_1" sent="s_1">This</wf>
+        <wf wid="w_2" sent="s_1">is</wf>
+        <wf wid="w_3" sent="s_1">a</wf>
+        <wf wid="w_4" sent="s_1">very</wf>
+        <wf wid="w_5" sent="s_1">nice</wf>
+        <wf wid="w_6" sent="s_1">hotel</wf>
+        <wf wid="w_7" sent="s_1">in</wf>
+        <wf wid="w_8" sent="s_1">Amsterdam</wf>
+      </text>
+      <terms>
+        <term tid="t_1" lemma="this" morphofeat="DT" type="close" pos="D">
+          <span>
+            <target id="w_1"/>
+          </span>
+        </term>
+        <term tid="t_2" lemma="be" morphofeat="VBZ" type="open" pos="V">
+          <span>
+            <target id="w_2"/>
+          </span>
+        </term>
+        <term tid="t_3" lemma="a" morphofeat="DT" type="close" pos="D">
+          <span>
+            <target id="w_3"/>
+          </span>
+        </term>
+        <term tid="t_4" lemma="very" morphofeat="RB" type="open" pos="A">
+          <span>
+            <target id="w_4"/>
+          </span>
+          <sentiment sentiment_modifier="intensifier" resource="VUA_olery_lexicon_en_lmf"/>
+        </term>
+        <term tid="t_5" lemma="nice" morphofeat="JJ" type="open" pos="G">
+          <span>
+            <target id="w_5"/>
+          </span>
+          <sentiment polarity="positive" resource="VUA_olery_lexicon_en_lmf"/>
+        </term>
+        <term tid="t_6" lemma="hotel" morphofeat="NN" type="open" pos="N">
+          <span>
+            <target id="w_6"/>
+          </span>
+        </term>
+        <term tid="t_7" lemma="in" morphofeat="IN" type="close" pos="P">
+          <span>
+            <target id="w_7"/>
+          </span>
+        </term>
+        <term tid="t_8" lemma="Amsterdam" morphofeat="NP" type="open" pos="R">
+          <span>
+            <target id="w_8"/>
+          </span>
+        </term>
+      </terms>
+      <entities>
+        <entity eid="e15" type="location">
+    	<references>
+            <span>
+              <!--Amsterdam -->
+              <target id="t_8" />
+            </span>
+    	</references>
+        </entity>
+      </entities>
+    </KAF>
+
+
+Enjoy!
+
+## Usage
+
+Detecting opinion for some text (assuming that the above text is in a file called *english.kaf*):
+
+    cat english.kaf | opinion-detector
+    
+
+Will result in
+
+    <?xml version='1.0' encoding='UTF-8'?>
+    <KAF version="v1.opener" xml:lang="en">
+      <kafHeader>
+        <linguisticProcessors layer="text">
+          <lp name="opennlp-en-tok" timestamp="2013-06-11T13:41:37Z" version="1.0"/>
+          <lp name="opennlp-en-sent" timestamp="2013-06-11T13:41:37Z" version="1.0"/>
+        </linguisticProcessors>
+        <linguisticProcessor layer="term">
+          <lp timestamp="2013-06-12T15:18:03CEST" version="1.0" name="Open nlp pos tagger"/>
+        </linguisticProcessor>
+      </kafHeader>
+      <text>
+        <wf length="4" offset="0" para="1" sent="1" wid="w1">this</wf>
+        <wf length="2" offset="5" para="1" sent="1" wid="w2">is</wf>
+        <wf length="2" offset="8" para="1" sent="1" wid="w3">an</wf>
+        <wf length="7" offset="11" para="1" sent="1" wid="w4">english</wf>
+        <wf length="4" offset="19" para="1" sent="1" wid="w5">text</wf>
+      </text>
+      <terms>
+        <term lemma="this" morphofeat="FM" pos="O" tid="t_1" type="open">
+          <span>
+            <target id="w1"/>
+          </span>
+        </term>
+        <term lemma="is" morphofeat="FM" pos="O" tid="t_2" type="open">
+          <span>
+            <target id="w2"/>
+          </span>
+        </term>
+        <term lemma="an" morphofeat="APPR" pos="P" tid="t_3" type="close">
+          <span>
+            <target id="w3"/>
+          </span>
+        </term>
+        <term lemma="english" morphofeat="FM" pos="O" tid="t_4" type="open">
+          <span>
+            <target id="w4"/>
+          </span>
+        </term>
+        <term lemma="text" morphofeat="FM" pos="O" tid="t_5" type="open">
+          <span>
+            <target id="w5"/>
+          </span>
+        </term>
+      </terms>
+    </KAF>
+  
+## Server
+
+The Opinion Detector comes equipped with a simple webservice. To start the
+webservice type:
+
+    opinion-detector-server
+
+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:
+
+    opinion-detector-server -p 1234
+
+It then launches at ```http://localhost:1234```
+
+Documentation on the Webservice is provided by surfing to the urls provided
+above. 
+
+
+## Contributing
+
+### Procedure
+
+1. Pull it
+2. Create your feature branch (`git checkout -b features/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin features/my-new-feature`)
+5. If you're confident, merge your changes into master.
+
+# What's next? 
+
+If you're interested in the pos_tagger, you also might want to check
+out opener-project/opinion-detector.

data/bin/opinion-detector

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

data/bin/opinion-detector-server

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+
+# Without calling `Rack::Server#options` manually the CLI arguments will never
+# be passed, thus the application can't be specified as a constructor argument.
+server                  = Rack::Server.new
+server.options[:config] = File.expand_path('../../config.ru', __FILE__)
+
+server.start

data/config.ru

@@ -0,0 +1,4 @@
+require File.expand_path('../lib/opener/opinion_detector', __FILE__)
+require File.expand_path('../lib/opener/opinion_detector/server', __FILE__)
+
+run Opener::OpinionDetector::Server

data/lib/opener/opinion_detector.rb

@@ -0,0 +1,90 @@
+require 'opener/opinion_detectors/base'
+require 'open3'
+require 'nokogiri'
+require 'optparse'
+
+require_relative 'opinion_detector/version'
+require_relative 'opinion_detector/cli'
+
+module Opener
+  ##
+  # Primary opinion detector class that delegates work to the various opinion
+  # detector kernels.
+  #
+  # @!attribute [r] options
+  #  @return [Hash]
+  #
+  class OpinionDetector
+    attr_reader :options
+
+    ##
+    # Hash containing the default options to use.
+    #
+    # @return [Hash]
+    #
+    DEFAULT_OPTIONS = {
+      :args => []
+    }.freeze
+
+    ##
+    # @param [Hash] options
+    #
+    # @option options [Array] :args Collection of arbitrary arguments to pass
+    #  to the individual tokenizer commands.
+    #
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    ##
+    # Processes the input and returns an array containing the output of STDOUT,
+    # STDERR and an object containing process information.
+    #
+    # @param [String] input
+    # @return [Array]
+    #
+    def run(input)
+      language = language_from_kaf(input)
+
+      unless valid_language?(language)
+        raise ArgumentError, "The specified language (#{language}) is invalid"
+      end
+
+      kernel = language_constant(language).new(:args => options[:args])
+      return kernel.run(input)
+    end
+
+    protected
+
+    ##
+    # Extracts the language from a KAF document.
+    #
+    # @param [String] input
+    # @return [String]
+    #
+    def language_from_kaf(input)
+      reader = Nokogiri::XML::Reader(input)
+
+      return reader.read.lang
+    end
+
+    ##
+    # @param [String] language
+    # @return [Class]
+    #
+    def language_constant(language)
+      Opener::OpinionDetectors.const_get(language.upcase)
+    end
+
+    ##
+    # @return [TrueClass|FalseClass]
+    #
+    def valid_language?(language)
+      if language
+        return Opener::OpinionDetectors.const_defined?(language.upcase)
+      else
+        return false
+      end
+    end
+  end # OpinionDetector
+end # Opener

data/lib/opener/opinion_detector/cli.rb

@@ -0,0 +1,84 @@
+module Opener
+  class OpinionDetector
+    ##
+    # CLI wrapper around {Opener::OpinionDetector} using OptionParser.
+    #
+    # @!attribute [r] options
+    #  @return [Hash]
+    # @!attribute [r] option_parser
+    #  @return [OptionParser]
+    #
+    class CLI
+      attr_reader :options, :option_parser
+
+      ##
+      # @param [Hash] options
+      #
+      def initialize(options = {})
+        @options = DEFAULT_OPTIONS.merge(options)
+
+        @option_parser = OptionParser.new do |opts|
+          opts.program_name   = 'opinion-detector'
+          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', '--log', 'Enables logging to STDERR') do
+            @options[:logging] = true
+          end
+
+          opts.separator <<-EOF
+
+Examples:
+
+  cat example.kaf | #{opts.program_name}
+  cat example.kaf | #{opts.program_name} -l # Enables logging to STDERR
+          EOF
+        end
+      end
+
+      ##
+      # @param [String] input
+      #
+      def run(input)
+        option_parser.parse!(options[:args])
+
+        tagger = OpinionDetector.new(options)
+
+        stdout, stderr, process = tagger.run(input)
+
+        if process.success?
+          puts stdout
+
+          if options[:logging] and !stderr.empty?
+            STDERR.puts(stderr)
+          end
+        else
+          abort stderr
+        end
+      end
+
+      private
+
+      ##
+      # Shows the help message and exits the program.
+      #
+      def show_help
+        abort option_parser.to_s
+      end
+
+      ##
+      # Shows the version and exits the program.
+      #
+      def show_version
+        abort "#{option_parser.program_name} v#{VERSION} on #{RUBY_DESCRIPTION}"
+      end
+    end # CLI
+  end # OpinionDetector
+end # Opener

data/lib/opener/opinion_detector/public/markdown.css

@@ -0,0 +1,283 @@
+input[type="text"], textarea
+{
+  width: 500px;
+}
+
+body {
+  font-family: Helvetica, arial, sans-serif;
+  font-size: 14px;
+  line-height: 1.6;
+  padding-top: 10px;
+  padding-bottom: 10px;
+  background-color: white;
+  padding: 30px; }
+
+body > *:first-child {
+  margin-top: 0 !important; }
+body > *:last-child {
+  margin-bottom: 0 !important; }
+
+a {
+  color: #4183C4; }
+a.absent {
+  color: #cc0000; }
+a.anchor {
+  display: block;
+  padding-left: 30px;
+  margin-left: -30px;
+  cursor: pointer;
+  position: absolute;
+  top: 0;
+  left: 0;
+  bottom: 0; }
+
+h1, h2, h3, h4, h5, h6 {
+  margin: 20px 0 10px;
+  padding: 0;
+  font-weight: bold;
+  -webkit-font-smoothing: antialiased;
+  cursor: text;
+  position: relative; }
+
+h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor {
+  background: url("../../images/modules/styleguide/para.png") no-repeat 10px center;
+  text-decoration: none; }
+
+h1 tt, h1 code {
+  font-size: inherit; }
+
+h2 tt, h2 code {
+  font-size: inherit; }
+
+h3 tt, h3 code {
+  font-size: inherit; }
+
+h4 tt, h4 code {
+  font-size: inherit; }
+
+h5 tt, h5 code {
+  font-size: inherit; }
+
+h6 tt, h6 code {
+  font-size: inherit; }
+
+h1 {
+  font-size: 28px;
+  color: black; }
+
+h2 {
+  font-size: 24px;
+  border-bottom: 1px solid #cccccc;
+  color: black; }
+
+h3 {
+  font-size: 18px; }
+
+h4 {
+  font-size: 16px; }
+
+h5 {
+  font-size: 14px; }
+
+h6 {
+  color: #777777;
+  font-size: 14px; }
+
+p, blockquote, ul, ol, dl, li, table, pre {
+  margin: 15px 0; }
+
+hr {
+  background: transparent url("../../images/modules/pulls/dirty-shade.png") repeat-x 0 0;
+  border: 0 none;
+  color: #cccccc;
+  height: 4px;
+  padding: 0; }
+
+body > h2:first-child {
+  margin-top: 0;
+  padding-top: 0; }
+body > h1:first-child {
+  margin-top: 0;
+  padding-top: 0; }
+body > h1:first-child + h2 {
+  margin-top: 0;
+  padding-top: 0; }
+body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child {
+  margin-top: 0;
+  padding-top: 0; }
+
+a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
+  margin-top: 0;
+  padding-top: 0; }
+
+h1 p, h2 p, h3 p, h4 p, h5 p, h6 p {
+  margin-top: 0; }
+
+li p.first {
+  display: inline-block; }
+
+ul, ol {
+  padding-left: 30px; }
+
+ul :first-child, ol :first-child {
+  margin-top: 0; }
+
+ul :last-child, ol :last-child {
+  margin-bottom: 0; }
+
+dl {
+  padding: 0; }
+dl dt {
+  font-size: 14px;
+  font-weight: bold;
+  font-style: italic;
+  padding: 0;
+  margin: 15px 0 5px; }
+dl dt:first-child {
+  padding: 0; }
+dl dt > :first-child {
+  margin-top: 0; }
+dl dt > :last-child {
+  margin-bottom: 0; }
+dl dd {
+  margin: 0 0 15px;
+  padding: 0 15px; }
+dl dd > :first-child {
+  margin-top: 0; }
+dl dd > :last-child {
+  margin-bottom: 0; }
+
+blockquote {
+  border-left: 4px solid #dddddd;
+  padding: 0 15px;
+  color: #777777; }
+blockquote > :first-child {
+  margin-top: 0; }
+blockquote > :last-child {
+  margin-bottom: 0; }
+
+table {
+  padding: 0; }
+table tr {
+  border-top: 1px solid #cccccc;
+  background-color: white;
+  margin: 0;
+  padding: 0; }
+table tr:nth-child(2n) {
+  background-color: #f8f8f8; }
+table tr th {
+  font-weight: bold;
+  border: 1px solid #cccccc;
+  text-align: left;
+  margin: 0;
+  padding: 6px 13px; }
+table tr td {
+  border: 1px solid #cccccc;
+  text-align: left;
+  margin: 0;
+  padding: 6px 13px; }
+table tr th :first-child, table tr td :first-child {
+  margin-top: 0; }
+table tr th :last-child, table tr td :last-child {
+  margin-bottom: 0; }
+
+img {
+  max-width: 100%; }
+
+span.frame {
+  display: block;
+  overflow: hidden; }
+span.frame > span {
+  border: 1px solid #dddddd;
+  display: block;
+  float: left;
+  overflow: hidden;
+  margin: 13px 0 0;
+  padding: 7px;
+  width: auto; }
+span.frame span img {
+  display: block;
+  float: left; }
+span.frame span span {
+  clear: both;
+  color: #333333;
+  display: block;
+  padding: 5px 0 0; }
+span.align-center {
+  display: block;
+  overflow: hidden;
+  clear: both; }
+span.align-center > span {
+  display: block;
+  overflow: hidden;
+  margin: 13px auto 0;
+  text-align: center; }
+span.align-center span img {
+  margin: 0 auto;
+  text-align: center; }
+span.align-right {
+  display: block;
+  overflow: hidden;
+  clear: both; }
+span.align-right > span {
+  display: block;
+  overflow: hidden;
+  margin: 13px 0 0;
+  text-align: right; }
+span.align-right span img {
+  margin: 0;
+  text-align: right; }
+span.float-left {
+  display: block;
+  margin-right: 13px;
+  overflow: hidden;
+  float: left; }
+span.float-left span {
+  margin: 13px 0 0; }
+span.float-right {
+  display: block;
+  margin-left: 13px;
+  overflow: hidden;
+  float: right; }
+span.float-right > span {
+  display: block;
+  overflow: hidden;
+  margin: 13px auto 0;
+  text-align: right; }
+
+code, tt {
+  margin: 0 2px;
+  padding: 0 5px;
+  white-space: nowrap;
+  border: 1px solid #eaeaea;
+  background-color: #f8f8f8;
+  border-radius: 3px; }
+
+pre code {
+  margin: 0;
+  padding: 0;
+  white-space: pre;
+  border: none;
+  background: transparent; }
+
+.highlight pre {
+  background-color: #f8f8f8;
+  border: 1px solid #cccccc;
+  font-size: 13px;
+  line-height: 19px;
+  overflow: auto;
+  padding: 6px 10px;
+  border-radius: 3px; }
+
+pre {
+  background-color: #f8f8f8;
+  border: 1px solid #cccccc;
+  font-size: 13px;
+  line-height: 19px;
+  overflow: auto;
+  padding: 6px 10px;
+  border-radius: 3px; }
+pre code, pre tt {
+  background-color: transparent;
+  border: none; }
+

data/lib/opener/opinion_detector/server.rb

@@ -0,0 +1,29 @@
+require 'sinatra/base'
+require 'httpclient'
+require 'opener/webservice'
+
+module Opener
+  class OpinionDetector
+    ##
+    # Opinion Detector server powered by Sinatra.
+    #
+    class Server < Webservice
+      set :views, File.expand_path('../views', __FILE__)
+      text_processor OpinionDetector
+      accepted_params :input
+
+      ##
+      # @see Opener::Webservice#analyze
+      #
+      def analyze(*args)
+        begin
+          super
+        # ArgumentErrors are used for invalid languages. These happen too often
+        # so we'll supress them for now.
+        rescue ArgumentError => error
+          halt(400, error.message.strip)
+        end
+      end
+    end # Server
+  end # OpinionDetector
+end # Opener

data/lib/opener/opinion_detector/version.rb

@@ -0,0 +1,5 @@
+module Opener
+  class OpinionDetector
+    VERSION = "1.0.0"
+  end
+end

data/lib/opener/opinion_detector/views/index.erb

@@ -0,0 +1,281 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link type="text/css" rel="stylesheet" charset="UTF-8" href="markdown.css"/>
+    <title>Opinion Detector Webservice</title>
+  </head>
+  <body>
+    <h1>Opinion Detector Web Service</h1>
+
+    <h2>Example Usage</h2>
+
+    <p>
+      <pre>opinion-detector-server start</pre>
+      <pre>curl -d &#39;input=&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;no&quot;?&gt;&lt;KAF version=&quot;v1.opener&quot; xml:lang=&quot;en&quot;&gt;&lt;kafHeader&gt;&lt;linguisticProcessors layer=&quot;text&quot;&gt;&lt;lp name=&quot;opennlp-en-tok&quot; timestamp=&quot;2013-06-11T13:41:37Z&quot; version=&quot;1.0&quot;/&gt;&lt;lp name=&quot;opennlp-en-sent&quot; timestamp=&quot;2013-06-11T13:41:37Z&quot; version=&quot;1.0&quot;/&gt;&lt;/linguisticProcessors&gt;&lt;/kafHeader&gt;&lt;text&gt;&lt;wf length=&quot;4&quot; offset=&quot;0&quot; para=&quot;1&quot; sent=&quot;1&quot; wid=&quot;w1&quot;&gt;this&lt;/wf&gt;&lt;wf length=&quot;2&quot; offset=&quot;5&quot; para=&quot;1&quot; sent=&quot;1&quot; wid=&quot;w2&quot;&gt;is&lt;/wf&gt;&lt;wf length=&quot;2&quot; offset=&quot;8&quot; para=&quot;1&quot; sent=&quot;1&quot; wid=&quot;w3&quot;&gt;an&lt;/wf&gt;&lt;wf length=&quot;7&quot; offset=&quot;11&quot; para=&quot;1&quot; sent=&quot;1&quot; wid=&quot;w4&quot;&gt;english&lt;/wf&gt;&lt;wf length=&quot;4&quot; offset=&quot;19&quot; para=&quot;1&quot; sent=&quot;1&quot; wid=&quot;w5&quot;&gt;text&lt;/wf&gt;&lt;/text&gt;&lt;/KAF&gt;&#39; http://localhost:9292 -XPOST</pre>
+
+      outputs:
+
+      <pre>
+        &lt;?xml version=&#39;1.0&#39; encoding=&#39;UTF-8&#39;?&gt;
+        &lt;KAF xml:lang=&quot;en&quot;&gt;
+          &lt;kafHeader&gt;
+            &lt;linguisticProcessors layer=&quot;text&quot;&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:21:29CEST&quot; version=&quot;1.0&quot; name=&quot;Open-nlp sentence splitter&quot;/&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:21:29CEST&quot; version=&quot;1.0&quot; name=&quot;Open-nlp tokenizer&quot;/&gt;
+            &lt;/linguisticProcessors&gt;
+            &lt;linguisticProcessor layer=&quot;opinions&quot;&gt;
+              &lt;lp timestamp=&quot;2013-06-27T17:56:32EEST&quot; version=&quot;1.0&quot; name=&quot;Crfsuite machine learning opinion miner&quot;/&gt;
+            &lt;/linguisticProcessor&gt;
+            &lt;linguisticProcessor layer=&quot;terms&quot;&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:23:08CEST&quot; version=&quot;1.0&quot; name=&quot;Basic_polarity_tagger_with_pos&quot;/&gt;
+            &lt;/linguisticProcessor&gt;
+            &lt;linguisticProcessor layer=&quot;term&quot;&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:23:07CEST&quot; version=&quot;1.0&quot; name=&quot;TreeTagger_from_kaf&quot;/&gt;
+            &lt;/linguisticProcessor&gt;
+          &lt;/kafHeader&gt;
+          &lt;text&gt;
+            &lt;wf wid=&quot;w_1&quot; sent=&quot;s_1&quot;&gt;This&lt;/wf&gt;
+            &lt;wf wid=&quot;w_2&quot; sent=&quot;s_1&quot;&gt;is&lt;/wf&gt;
+            &lt;wf wid=&quot;w_3&quot; sent=&quot;s_1&quot;&gt;a&lt;/wf&gt;
+            &lt;wf wid=&quot;w_4&quot; sent=&quot;s_1&quot;&gt;very&lt;/wf&gt;
+            &lt;wf wid=&quot;w_5&quot; sent=&quot;s_1&quot;&gt;nice&lt;/wf&gt;
+            &lt;wf wid=&quot;w_6&quot; sent=&quot;s_1&quot;&gt;hotel&lt;/wf&gt;
+            &lt;wf wid=&quot;w_7&quot; sent=&quot;s_1&quot;&gt;in&lt;/wf&gt;
+            &lt;wf wid=&quot;w_8&quot; sent=&quot;s_1&quot;&gt;Amsterdam&lt;/wf&gt;
+          &lt;/text&gt;
+          &lt;terms&gt;
+            &lt;term tid=&quot;t_1&quot; lemma=&quot;this&quot; morphofeat=&quot;DT&quot; type=&quot;close&quot; pos=&quot;D&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_1&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_2&quot; lemma=&quot;be&quot; morphofeat=&quot;VBZ&quot; type=&quot;open&quot; pos=&quot;V&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_2&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_3&quot; lemma=&quot;a&quot; morphofeat=&quot;DT&quot; type=&quot;close&quot; pos=&quot;D&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_3&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_4&quot; lemma=&quot;very&quot; morphofeat=&quot;RB&quot; type=&quot;open&quot; pos=&quot;A&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_4&quot;/&gt;
+              &lt;/span&gt;
+              &lt;sentiment sentiment_modifier=&quot;intensifier&quot; resource=&quot;VUA_olery_lexicon_en_lmf&quot;/&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_5&quot; lemma=&quot;nice&quot; morphofeat=&quot;JJ&quot; type=&quot;open&quot; pos=&quot;G&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_5&quot;/&gt;
+              &lt;/span&gt;
+              &lt;sentiment polarity=&quot;positive&quot; resource=&quot;VUA_olery_lexicon_en_lmf&quot;/&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_6&quot; lemma=&quot;hotel&quot; morphofeat=&quot;NN&quot; type=&quot;open&quot; pos=&quot;N&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_6&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_7&quot; lemma=&quot;in&quot; morphofeat=&quot;IN&quot; type=&quot;close&quot; pos=&quot;P&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_7&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_8&quot; lemma=&quot;Amsterdam&quot; morphofeat=&quot;NP&quot; type=&quot;open&quot; pos=&quot;R&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_8&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+          &lt;/terms&gt;
+          &lt;entities&gt;
+            &lt;entity eid=&quot;e15&quot; type=&quot;location&quot;&gt;
+              &lt;references&gt;
+                &lt;span&gt;
+                  &lt;!--Amsterdam --&gt;
+                  &lt;target id=&quot;t_8&quot;/&gt;
+                &lt;/span&gt;
+              &lt;/references&gt;
+            &lt;/entity&gt;
+          &lt;/entities&gt;
+          &lt;opinions&gt;
+            &lt;opinion oid=&quot;o_1&quot;&gt;
+              &lt;opinion_holder&gt;
+                &lt;span/&gt;
+              &lt;/opinion_holder&gt;
+              &lt;opinion_target&gt;
+                &lt;span&gt;
+                  &lt;target id=&quot;t_1&quot;/&gt;
+                &lt;/span&gt;
+              &lt;/opinion_target&gt;
+              &lt;opinion_expression polarity=&quot;positive&quot; strength=&quot;1&quot;&gt;
+                &lt;span&gt;
+                  &lt;target id=&quot;t_4&quot;/&gt;
+                  &lt;target id=&quot;t_5&quot;/&gt;
+                  &lt;target id=&quot;t_6&quot;/&gt;
+                  &lt;target id=&quot;t_7&quot;/&gt;
+                  &lt;target id=&quot;t_8&quot;/&gt;
+                &lt;/span&gt;
+              &lt;/opinion_expression&gt;
+            &lt;/opinion&gt;
+          &lt;/opinions&gt;
+        &lt;/KAF&gt;</pre>
+    </p>
+
+    <h2>Try the webservice</h2>
+
+    <p>* required</p>
+    <p>** When entering a value no response will be displayed in the browser.</p>
+
+    <form action="<%=url("/")%>" method="POST">
+      <div>
+        <label for="input"/>Type your text here*</label>
+        <br/>
+
+        <textarea name="input" id="text" rows="10" cols="50"/></textarea>
+      </div>
+      <% 10.times do |t| %>
+      <div>
+        <label for="callbacks">Callback URL <%=t+1%>(**)</label>
+        <br />
+
+        <input id="callbacks" type="text" name="callbacks[]" />
+      </div>
+      <% end %>
+
+      <div>
+        <label for="error_callback">Error Callback</label>
+        <br />
+
+        <input id="error_callback" type="text" name="error_callback" />
+      </div>
+      <input type="submit" value="Submit" />
+    </form>
+
+    <h2>Actions</h2>
+
+    <p>
+      <dl>
+        <dt>POST /</dt>
+        <dd>Detect opinion for input text. See arguments listing for more options.</dd>
+        <dt>GET /</dt>
+        <dd>Show this page</dd>
+      </dl>
+    </p>
+
+    <h2>Arguments</h2>
+
+    <p> The webservice takes the following arguments: </p>
+    <p>* required</p>
+
+    <dl>
+      <dt>text*</dt>
+      <dd>The input text in KAF format. Sample KAF input:</dd>
+      <pre>
+        &lt;?xml version=&#39;1.0&#39; encoding=&#39;UTF-8&#39;?&gt;
+        &lt;KAF xml:lang=&quot;en&quot;&gt;
+          &lt;kafHeader&gt;
+            &lt;linguisticProcessors layer=&quot;text&quot;&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:21:29CEST&quot; version=&quot;1.0&quot; name=&quot;Open-nlp sentence splitter&quot;/&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:21:29CEST&quot; version=&quot;1.0&quot; name=&quot;Open-nlp tokenizer&quot;/&gt;
+            &lt;/linguisticProcessors&gt;
+            &lt;linguisticProcessor layer=&quot;terms&quot;&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:23:08CEST&quot; version=&quot;1.0&quot; name=&quot;Basic_polarity_tagger_with_pos&quot;/&gt;
+            &lt;/linguisticProcessor&gt;
+            &lt;linguisticProcessor layer=&quot;term&quot;&gt;
+              &lt;lp timestamp=&quot;2013-04-11T09:23:07CEST&quot; version=&quot;1.0&quot; name=&quot;TreeTagger_from_kaf&quot;/&gt;
+            &lt;/linguisticProcessor&gt;
+          &lt;/kafHeader&gt;
+          &lt;text&gt;
+            &lt;wf wid=&quot;w_1&quot; sent=&quot;s_1&quot;&gt;This&lt;/wf&gt;
+            &lt;wf wid=&quot;w_2&quot; sent=&quot;s_1&quot;&gt;is&lt;/wf&gt;
+            &lt;wf wid=&quot;w_3&quot; sent=&quot;s_1&quot;&gt;a&lt;/wf&gt;
+            &lt;wf wid=&quot;w_4&quot; sent=&quot;s_1&quot;&gt;very&lt;/wf&gt;
+            &lt;wf wid=&quot;w_5&quot; sent=&quot;s_1&quot;&gt;nice&lt;/wf&gt;
+            &lt;wf wid=&quot;w_6&quot; sent=&quot;s_1&quot;&gt;hotel&lt;/wf&gt;
+            &lt;wf wid=&quot;w_7&quot; sent=&quot;s_1&quot;&gt;in&lt;/wf&gt;
+            &lt;wf wid=&quot;w_8&quot; sent=&quot;s_1&quot;&gt;Amsterdam&lt;/wf&gt;
+          &lt;/text&gt;
+          &lt;terms&gt;
+            &lt;term tid=&quot;t_1&quot; lemma=&quot;this&quot; morphofeat=&quot;DT&quot; type=&quot;close&quot; pos=&quot;D&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_1&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_2&quot; lemma=&quot;be&quot; morphofeat=&quot;VBZ&quot; type=&quot;open&quot; pos=&quot;V&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_2&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_3&quot; lemma=&quot;a&quot; morphofeat=&quot;DT&quot; type=&quot;close&quot; pos=&quot;D&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_3&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_4&quot; lemma=&quot;very&quot; morphofeat=&quot;RB&quot; type=&quot;open&quot; pos=&quot;A&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_4&quot;/&gt;
+              &lt;/span&gt;
+              &lt;sentiment sentiment_modifier=&quot;intensifier&quot; resource=&quot;VUA_olery_lexicon_en_lmf&quot;/&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_5&quot; lemma=&quot;nice&quot; morphofeat=&quot;JJ&quot; type=&quot;open&quot; pos=&quot;G&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_5&quot;/&gt;
+              &lt;/span&gt;
+              &lt;sentiment polarity=&quot;positive&quot; resource=&quot;VUA_olery_lexicon_en_lmf&quot;/&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_6&quot; lemma=&quot;hotel&quot; morphofeat=&quot;NN&quot; type=&quot;open&quot; pos=&quot;N&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_6&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_7&quot; lemma=&quot;in&quot; morphofeat=&quot;IN&quot; type=&quot;close&quot; pos=&quot;P&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_7&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+            &lt;term tid=&quot;t_8&quot; lemma=&quot;Amsterdam&quot; morphofeat=&quot;NP&quot; type=&quot;open&quot; pos=&quot;R&quot;&gt;
+              &lt;span&gt;
+                &lt;target id=&quot;w_8&quot;/&gt;
+              &lt;/span&gt;
+            &lt;/term&gt;
+          &lt;/terms&gt;
+          &lt;entities&gt;
+            &lt;entity eid=&quot;e15&quot; type=&quot;location&quot;&gt;
+        	&lt;references&gt;
+                &lt;span&gt;
+                  &lt;!--Amsterdam --&gt;
+                  &lt;target id=&quot;t_8&quot; /&gt;
+                &lt;/span&gt;
+        	&lt;/references&gt;
+            &lt;/entity&gt;
+          &lt;/entities&gt;
+        &lt;/KAF&gt;</pre>
+
+      <dt>callbacks</dt>
+      <dd>
+            You can provide a list of callback urls. If you provide callback urls
+            the Opinion detector will run as a background job and a callback
+            with the results will be performed (POST) to the first url in the callback
+            list. The other urls in callback list will be provided in the "callbacks"
+            argument.<br/><br/>
+            Using callback you can chain together several OpeNER webservices in
+        one call. The first, will call the second, which will call the third, etc.
+        See for more information the <a href="http://opener-project.github.io">
+          webservice documentation online</a>.
+      </dd>
+      <dt>error_callback</dt>
+      <dd>URL to notify if errors occur in the background process. The error
+      callback will do a POST with the error message in the 'error' field.</dd>
+      </dt>
+
+
+
+    </dl>
+
+
+    <p>
+
+    </p>
+
+  </body>
+</html>

data/lib/opener/opinion_detector/views/result.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link type="text/css" rel="stylesheet" charset="UTF-8" href="markdown.css"/>
+    <title>Language Detector Webservice</title>
+  </head>
+  <body>
+    <h1>Output URL</h1>
+    <p>
+      When ready, you can view the result
+      <a href=<%= output_url %>>here</a>
+    </p>
+
+  </body>
+</html>

data/opener-opinion-detector.gemspec

@@ -0,0 +1,33 @@
+require File.expand_path('../lib/opener/opinion_detector/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name                  = 'opener-opinion-detector'
+  gem.version               = Opener::OpinionDetector::VERSION
+  gem.authors               = ['development@olery.com']
+  gem.summary               = 'Gem that wraps up the different existing opinion detectors'
+  gem.description           = gem.summary
+  gem.homepage              = 'http://opener-project.github.com/'
+  gem.has_rdoc              = "yard"
+  gem.required_ruby_version = ">= 1.9.2"
+
+  gem.files = Dir.glob([
+    'lib/**/*',
+    'config.ru',
+    '*.gemspec',
+    'README.md'
+  ]).select { |file| File.file?(file) }
+
+  gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
+
+  gem.add_dependency 'opener-opinion-detector-base'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'sinatra', '~>1.4.2'
+  gem.add_dependency 'httpclient'
+  gem.add_dependency 'opener-webservice'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+end
+

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: opener-opinion-detector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- development@olery.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opener-opinion-detector-base
+  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: nokogiri
+  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: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  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: opener-webservice
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem that wraps up the different existing opinion detectors
+email: 
+executables:
+- opinion-detector-server
+- opinion-detector
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/opinion-detector
+- bin/opinion-detector-server
+- config.ru
+- lib/opener/opinion_detector.rb
+- lib/opener/opinion_detector/cli.rb
+- lib/opener/opinion_detector/public/markdown.css
+- lib/opener/opinion_detector/server.rb
+- lib/opener/opinion_detector/version.rb
+- lib/opener/opinion_detector/views/index.erb
+- lib/opener/opinion_detector/views/result.erb
+- opener-opinion-detector.gemspec
+homepage: http://opener-project.github.com/
+licenses: []
+metadata: {}
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem that wraps up the different existing opinion detectors
+test_files: []
+has_rdoc: yard