opener-opinion-detector 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e970449786cd7a7d5c31976bb12fbdcb784ee724
-  data.tar.gz: c4ef6b925a24d5385f5552f0c485998060c7bbcc
+  metadata.gz: 31c4caf46aa2fa93dd88d5138cbd495325783565
+  data.tar.gz: 4e5d503fcc00e415d5bb0322a0adc0260d5b2cde
 SHA512:
-  metadata.gz: 624550431e66fa3eed2286b53371ac883510f7f473aba7671e129f5502303ecf92af6f43fa876d453da621b5eb6dbc6bdb2f309ee0d2542f4918a796989961b6
-  data.tar.gz: b5c059110b0940e0a917a118f688778d15637c22d5bed944098cfef11ca0da60765781b51e05c084d41ef4b7511bb51099628a88710616bfc75ba8c0754d8ad0
+  metadata.gz: d0ebc3136cec62b3178af44eacb6f49d7498a7806fa160fc802b4c496e5695728c1c3b19181e2972a48cf8f66fe5d49957fc1b96a8f9c38524ca22dfa54ffdf9
+  data.tar.gz: 7edbf31a74dae022a6ca3e16eb6adb848bb00d5376fa9bf66d22ed8d144d6a19674ebbc00960e6d6144ca9cff7b0fde21b9393efbb80254e19fb84a209dcd02c

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 OpeNER Project Consortium
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,67 +1,72 @@
-Opinion Detector
-----------------
+# Opinion Detector
 
 Component that wraps a machine learned Opinion Detector in Python.
 
-### 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 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.
+Please keep in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
 ### Command line interface
 
-You should now be able to call the 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.
+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.
+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 <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-server -p 1234
 
 It then launches at <http://localhost:1234>
 
-Documentation on the Webservice is provided by surfing to the urls provided above. For more information on how to launch a webservice run the command with the ```-h``` option.
-
+Documentation on the Webservice is provided by surfing to the urls provided
+above. For more information on how to launch a webservice run the command with
+the `--help` option.
 
 ### Daemon
 
-Last but not least the opinion detector 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 comes shipped with a daemon that can
+read jobs (and write) jobs to and from Amazon SQS queues. For more information
+type:
 
     opinion-detector-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:
 
@@ -71,38 +76,34 @@ At least you need the following system setup:
 * Python 2.6 or newer
 * lxml
 
-Domain Adaption
----------------
+## Domain Adaption
 
-  TODO
+TODO
 
-Language Extension
-------------------
+## Language Extension
 
-  TODO
+TODO
 
-The Core
---------
+## The Core
 
-The component is a fat wrapper around the actual language technology core. You can find the core technolies in the following repository
+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
----------------------
+## Where to go from here
 
 * [Check the project website](http://opener-project.github.io)
 * [Checkout the webservice](http://opener.olery.com/opinion-detector)
 
-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/issues).
 
 
-Contributing
-------------
+## Contributing
 
 1. Fork it <http://github.com/opener-project/opinion-detector/fork>
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/opinion-detector

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

data/bin/opinion-detector-daemon

@@ -1,10 +1,14 @@
 #!/usr/bin/env ruby
 
+require 'opener/core'
 require 'opener/daemons'
 
-exec_path = File.expand_path('../../exec/opinion-detector.rb', __FILE__)
+switcher   = Opener::Core::ResourceSwitcher.new
+controller = Opener::Daemons::Controller.new(
+  :name      => 'opener-opinion-detector',
+  :exec_path => File.expand_path('../../exec/opinion-detector.rb', __FILE__)
+)
 
-Opener::Daemons::Controller.new(
-  :name      => 'opinion-detector',
-  :exec_path => exec_path
-)
+switcher.bind(controller.parser.parser)
+
+controller.run

data/bin/opinion-detector-server

@@ -1,54 +1,14 @@
 #!/usr/bin/env ruby
 
-require 'puma/cli'
-require 'optparse'
 require 'opener/core'
+require 'opener/webservice'
 
-rack_config   = File.expand_path('../../config.ru', __FILE__)
-switcher      = Opener::Core::ResourceSwitcher.new
-puma_args     = [rack_config]
-switcher_opts = {}
+switcher = Opener::Core::ResourceSwitcher.new
+parser   = Opener::Webservice::OptionParser.new(
+  'opener-opinion-detector',
+  File.expand_path('../../config.ru', __FILE__)
+)
 
-option_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($0)} [OPTIONS]"
+switcher.bind(parser.parser)
 
-  opts.separator "\nOptions:\n\n"
-
-  opts.on('-h', '--help', 'Shows this help message') do
-    abort option_parser.to_s
-  end
-
-  opts.on('-S', '--state PATH', 'Where to store the state details') do |val|
-    puma_args += ['--state', val]
-  end
-
-  opts.on('-b', '--bind URI', 'URI to bind to (tcp://, unix://, ssl://)') do |val|
-    puma_args += ['--bind', val]
-  end
-
-  opts.on('--pidfile PATH', 'Use PATH as a pidfile') do |val|
-    puma_args += ['--pidfile', val]
-  end
-
-  opts.on('--daemon', 'Daemonize the server into the background') do |val|
-    puma_args << '--daemon'
-  end
-
-  opts.on('-e', '--environment ENVIRONMENT', 'The environment to use') do |val|
-    puma_args += ['--environment', val]
-  end
-
-  opts.separator "\nResource Options:\n\n"
-
-  switcher.bind(opts, switcher_opts)
-end
-
-option_parser.parse!(ARGV)
-
-switcher.install(switcher_opts)
-
-# Puma on JRuby does some weird stuff with forking/exec. As a result of this we
-# *have to* update ARGV as otherwise running Puma as a daemon does not work.
-ARGV.replace(puma_args)
-
-Puma::CLI.new(ARGV).run
+parser.run

data/exec/opinion-detector.rb

@@ -1,19 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'opener/daemons'
-require 'opener/core'
 
 require_relative '../lib/opener/opinion_detector'
 
-switcher      = Opener::Core::ResourceSwitcher.new
-switcher_opts = {}
+daemon = Opener::Daemons::Daemon.new(Opener::OpinionDetector)
 
-parser = Opener::Daemons::OptParser.new do |opts|
-  switcher.bind(opts, switcher_opts)
-end
-
-options = parser.parse!(ARGV)
-daemon  = Opener::Daemons::Daemon.new(Opener::OpinionDetector, options)
-
-switcher.install(switcher_opts)
 daemon.start

data/lib/opener/opinion_detector.rb

@@ -1,8 +1,8 @@
-require 'opener/opinion_detectors/base'
 require 'open3'
+
 require 'nokogiri'
-require 'optparse'
-require 'opener/core'
+require 'slop'
+require 'opener/opinion_detectors/base'
 
 require_relative 'opinion_detector/version'
 require_relative 'opinion_detector/cli'
@@ -18,50 +18,55 @@ module Opener
   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.
+    # @see [Opener::OpinionDetectors::Base#initialize]
     #
     def initialize(options = {})
-      @options = DEFAULT_OPTIONS.merge(options)
+      @options = options
     end
 
     ##
-    # Processes the input and returns an array containing the output of STDOUT,
-    # STDERR and an object containing process information.
+    # Processes the input KAF document and returns a new KAF document containing
+    # the results.
     #
     # @param [String] input
     # @return [String]
     #
     def run(input)
-      begin
-        language = language_from_kaf(input)
+      language = language_from_kaf(input)
 
-        unless valid_language?(language)
-          raise ArgumentError, "The specified language (#{language}) is invalid"
-        end
+      unless valid_language?(language)
+        raise ArgumentError, "The specified language (#{language}) is invalid"
+      end
 
-        kernel = language_constant(language).new(:args => options[:args])
+      kernel = language_constant(language).new(kernel_options)
 
-        return kernel.run(input)
-      rescue Exception => error
-        return Opener::Core::ErrorLayer.new(input, error.message, self.class).add
-      end
+      return kernel.run(input)
     end
 
     protected
 
+    ##
+    # Returns the options to use for the kernel.
+    #
+    # @return [Hash]
+    #
+    def kernel_options
+      return options.merge(:resource_path => models_path)
+    end
+
+    ##
+    # Returns the path to the models to use.
+    #
+    # @return [String]
+    #
+    def models_path
+      return options[:resource_path] || ENV['RESOURCE_PATH'] ||
+        ENV['OPINION_DETECTOR_MODELS_PATH']
+    end
+
     ##
     # Extracts the language from a KAF document.
     #

data/lib/opener/opinion_detector/cli.rb

@@ -1,85 +1,65 @@
-require 'opener/core'
-
 module Opener
   class OpinionDetector
     ##
-    # CLI wrapper around {Opener::OpinionDetector} using OptionParser.
+    # CLI wrapper around {Opener::OpinionDetector} using Slop.
     #
-    # @!attribute [r] options
-    #  @return [Hash]
-    # @!attribute [r] option_parser
-    #  @return [OptionParser]
+    # @!attribute [r] parser
+    #  @return [Slop]
     #
     class CLI
-      attr_reader :options, :option_parser, :resource_switcher
+      attr_reader :parser
+
+      def initialize
+        @parser = configure_slop
+      end
 
       ##
-      # @param [Hash] options
+      # @param [Array] argv
       #
-      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
+      def run(argv = ARGV)
+        parser.parse(argv)
+      end
 
-          opts.on('-v', '--version', 'Shows the current version') do
-            show_version
-          end
+      ##
+      # @return [Slop]
+      #
+      def configure_slop
+        return Slop.new(:strict => false, :indent => 2, :help => true) do
+          banner 'Usage: opinion-detector [OPTIONS]'
 
-          opts.on('-l', '--log', 'Enables logging to STDERR') do
-            @options[:logging] = true
-          end
+          separator <<-EOF.chomp
 
-          opts.on('-d', '--domain DOMAIN_NAME', 'Domain name of the models.') do |v|
-            @options[:domain] = v
-          end
+About:
 
-          opts.separator <<-EOF
+    Machine learning based opinion detection for various languages such as Dutch
+    and English. This command reads input from STDIN.
 
-Examples:
+Example:
 
-  cat example.kaf | #{opts.program_name}
-  cat example.kaf | #{opts.program_name} -l # Enables logging to STDERR
+    cat some_file.kaf | opinion-detector
           EOF
-        end
 
-        option_parser.parse!(options[:args])
-        resource_switcher.install(@options)
-      end
+          separator "\nOptions:\n"
 
-      ##
-      # @param [String] input
-      #
-      def run(input)
-        option_parser.parse!(options[:args])
+          on :v, :version, 'Shows the current version' do
+            abort "opinion-detector v#{VERSION} on #{RUBY_DESCRIPTION}"
+          end
 
-        detector = OpinionDetector.new(options)
+          on :d=, :domain=, 'The domain to use for the models',
+            :as      => String,
+            :default => 'hotel'
 
-        puts detector.run(input)
-      end
+          run do |opts, args|
+            detector = OpinionDetector.new(
+              :args   => args,
+              :domain => opts[:domain]
+            )
 
-      private
+            input = STDIN.tty? ? nil : STDIN.read
 
-      ##
-      # 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}"
+            puts detector.run(input)
+          end
+        end
       end
     end # CLI
   end # OpinionDetector

data/lib/opener/opinion_detector/server.rb

@@ -1,5 +1,3 @@
-require 'sinatra/base'
-require 'httpclient'
 require 'opener/webservice'
 
 module Opener
@@ -7,23 +5,11 @@ module Opener
     ##
     # Opinion Detector server powered by Sinatra.
     #
-    class Server < Webservice
+    class Server < Webservice::Server
       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
+      self.text_processor  = OpinionDetector
+      self.accepted_params = [:input]
     end # Server
   end # OpinionDetector
 end # Opener

data/lib/opener/opinion_detector/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class OpinionDetector
-    VERSION = "1.2.0"
+    VERSION = '2.0.0'
   end
 end

data/opener-opinion-detector.gemspec

@@ -10,24 +10,26 @@ Gem::Specification.new do |gem|
   gem.has_rdoc              = "yard"
   gem.required_ruby_version = ">= 1.9.2"
 
+  gem.license = 'Apache 2.0'
+
   gem.files = Dir.glob([
     'lib/**/*',
     'config.ru',
     '*.gemspec',
     'README.md',
+    'LICENSE.txt',
     'exec/**/*'
   ]).select { |file| File.file?(file) }
 
   gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
   gem.add_dependency 'opener-opinion-detector-base'
+  gem.add_dependency 'opener-daemons', '~> 2.2'
+  gem.add_dependency 'opener-webservice', '~> 2.1'
+  gem.add_dependency 'opener-core', '~> 2.2'
+
   gem.add_dependency 'nokogiri'
-  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', '~> 1.0.2'
-  gem.add_dependency 'opener-webservice'
+  gem.add_dependency 'slop', '~> 3.5'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'cucumber'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-opinion-detector
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opener-opinion-detector-base
@@ -25,63 +25,49 @@ dependencies:
       - !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
+  name: opener-daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        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: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: opener-core
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
-- !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'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +159,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - bin/opinion-detector
 - bin/opinion-detector-daemon
@@ -201,7 +174,8 @@ files:
 - lib/opener/opinion_detector/views/index.erb
 - opener-opinion-detector.gemspec
 homepage: http://opener-project.github.com/
-licenses: []
+licenses:
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []