opener-opinion-detector 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cf56bc682d32934b84ecd24ee9be6c31c5ecd04
-  data.tar.gz: e1b81554c5348b4a3fd9ea638cdf2d1bb2740244
+  metadata.gz: 05d2440d3f9d646e1cfa9ca3bd0d38ed74310620
+  data.tar.gz: e62d7f8156727de6cb63040d19c6d4730419e7e5
 SHA512:
-  metadata.gz: a659778886fc9810402e1ef19bc96b18b30bef97fee0ad3a7ffaf804064e6f53643a1923c15de9dfd8a6da70953d72f99fe7470ad68c6b117c484f7cc4c4c75e
-  data.tar.gz: 17b31ba09285d1c59ebeb26603847ada91e5ddcb2f2cd3e578b5f2d04a81a344746ae886847b304ca2f4ca4c2ad7e3f4da71684deeb5713f0b3a779d75d081a1
+  metadata.gz: d4e3fddf177214d3b63e7338bd3aefc7b59f0a87a888dd407195ae2938c886fded5e732e51a9a960a14f6a46998d76e8da83c3485498b572bc0de680e24f3c2f
+  data.tar.gz: cda2cceb291359c7c19676786a86e581c1690e4db6adf217ba8dc3f05f9e86d8063bcc8243fcb52ffdb9ed321d1e376ed0f1c574d2261bb6ffdc6c7003950fde

data/README.md

@@ -1,225 +1,128 @@
-# 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
+----------------
+
+Component that wraps a machine learned Opinion Detector in Python.
+
+### 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.
+
+Quick Use Example
+-----------------
+
+Installing the opinion-detector can be done by executing:
+
+    gem install opener-opinion-detector
+
+Please bare 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 opinion detector 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 application reads a text from standard input in order process it. It needs
+models to work. There is a free set of models available trained on a news
+corpus.
+
+    cat englist.kaf | opinion-detector \
+          --resource-path /path/to/models \
+          --resource-url http://opener.s3.amazonaws.com/Models/final_models_news_20140522.zip
+
+You have to download the models separately. You can download them here:
+
+
+This will output:
+
+```
+
+```
+
+### Webservices
+
+You can launch a webservice by executing:
 
     opinion-detector-server
 
 This will launch a mini webserver with the webservice. It defaults to port 9292,
-so you can access it at:
+so you can access it at <http://localhost:9292>.
 
-    http://localhost:9292
-
-To launch it on a different port provide the ```-p [port-number]``` option like
+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```
+It then launches at <http://localhost:1234>
 
 Documentation on the Webservice is provided by surfing to the urls provided
-above. 
+above. For more information on how to launch a webservice run the command with
+the ```-h``` option.
 
 
-## Contributing
+### Daemon
 
-### Procedure
+Last but not least the opinion detector comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
 
-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.
+    opinion-detector-daemon -h
 
-# What's next? 
 
-If you're interested in the pos_tagger, you also might want to check
-out opener-project/opinion-detector.
+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)
+
+At least you need the following system setup:
+
+### Dependencies for normal use:
+
+* Ruby 1.9.3 or newer
+* Python 2.6 or newer
+* lxml
+
+Domain Adaption
+---------------
+
+  TODO
+
+Language Extension
+------------------
+
+  TODO
+
+The Core
+--------
+
+The component is a fat wrapper around the actual language technology core. You
+can find the core technolies in the following repository
+
+* [opinion-detector-base](https://github.com/opener-project/opinion-detector-base)
+
+Where to go from here
+---------------------
+
+* [Check the project websitere](http://opener-project.github.io)
+* [Checkout the webservice](http://opener.olery.com/opinion-detector)
+
+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/issues).
+
+
+Contributing
+------------
+
+1. Fork it <http://github.com/opener-project/opinion-detector/fork>
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/opinion-detector-daemon

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'opener/daemons'
+
+exec_path = File.expand_path('../../exec/opinion-detector.rb', __FILE__)
+
+Opener::Daemons::Controller.new(
+  :name      => 'opinion-detector',
+  :exec_path => exec_path
+)

data/exec/opinion-detector.rb

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

data/lib/opener/opinion_detector.rb

@@ -50,7 +50,7 @@ module Opener
         raise ArgumentError, "The specified language (#{language}) is invalid"
       end
 
-      kernel = language_constant(language).new(:args => options[:args])
+      kernel = language_constant(language).new(options)
       return kernel.run(input)
     end
 

data/lib/opener/opinion_detector/cli.rb

@@ -1,3 +1,5 @@
+require 'opener/core/resource_switcher'
+
 module Opener
   class OpinionDetector
     ##
@@ -9,18 +11,21 @@ module Opener
     #  @return [OptionParser]
     #
     class CLI
-      attr_reader :options, :option_parser
+      attr_reader :options, :option_parser, :resource_switcher
 
       ##
       # @param [Hash] options
       #
       def initialize(options = {})
         @options = DEFAULT_OPTIONS.merge(options)
+        @resource_switcher = Opener::Core::ResourceSwitcher.new
 
         @option_parser = OptionParser.new do |opts|
           opts.program_name   = 'opinion-detector'
           opts.summary_indent = '  '
 
+          resource_switcher.bind(opts, @options)
+
           opts.on('-h', '--help', 'Shows this help message') do
             show_help
           end
@@ -32,15 +37,10 @@ module Opener
           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
+
+        option_parser.parse!(options[:args])
+        resource_switcher.install(@options)
       end
 
       ##

data/lib/opener/opinion_detector/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class OpinionDetector
-    VERSION = "1.0.1"
+    VERSION = "1.0.3"
   end
 end

data/opener-opinion-detector.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |gem|
     'lib/**/*',
     'config.ru',
     '*.gemspec',
-    'README.md'
+    'README.md',
+    'exec/**/*'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
@@ -24,6 +25,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'sinatra', '~>1.4.2'
   gem.add_dependency 'httpclient'
   gem.add_dependency 'puma'
+  gem.add_dependency 'opener-daemons'
+  gem.add_dependency 'opener-core', ['>= 0.1.2']
   gem.add_dependency 'opener-webservice'
 
   gem.add_development_dependency 'rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-opinion-detector
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - development@olery.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opener-opinion-detector-base
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opener-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
@@ -155,13 +183,16 @@ email:
 executables:
 - opinion-detector-server
 - opinion-detector
+- opinion-detector-daemon
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/opinion-detector
+- bin/opinion-detector-daemon
 - bin/opinion-detector-server
 - config.ru
+- exec/opinion-detector.rb
 - lib/opener/opinion_detector.rb
 - lib/opener/opinion_detector/cli.rb
 - lib/opener/opinion_detector/public/markdown.css