opener-opinion-detector 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05d2440d3f9d646e1cfa9ca3bd0d38ed74310620
-  data.tar.gz: e62d7f8156727de6cb63040d19c6d4730419e7e5
+  metadata.gz: 308a21347b8aa4e28890b619e3ef76ae0ae8ddb5
+  data.tar.gz: 4cda0fd31a9050f345eca7b9ac33da21d03f5286
 SHA512:
-  metadata.gz: d4e3fddf177214d3b63e7338bd3aefc7b59f0a87a888dd407195ae2938c886fded5e732e51a9a960a14f6a46998d76e8da83c3485498b572bc0de680e24f3c2f
-  data.tar.gz: cda2cceb291359c7c19676786a86e581c1690e4db6adf217ba8dc3f05f9e86d8063bcc8243fcb52ffdb9ed321d1e376ed0f1c574d2261bb6ffdc6c7003950fde
+  metadata.gz: 453cd80301f4b713ed39f181c206cbcd748e13cb8a4878a062d0be0d2457b7ccc35cde5e8238b57becdbbc936483b94460d4d74e8f38eb73f01223ff0172a119
+  data.tar.gz: e191424cfb9bfaff6aff3ad457890328ce9df757f441b5f7a60afd094c5ecaeca9e521a07fdee3887298a9a69162de09bef4750edc6c5ab21f1489a033474840

data/README.md

@@ -5,11 +5,7 @@ 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.
+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
 -----------------
@@ -18,17 +14,13 @@ 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 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.
+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 \
@@ -36,7 +28,6 @@ corpus.
 
 You have to download the models separately. You can download them here:
 
-
 This will output:
 
 ```
@@ -49,26 +40,20 @@ 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 ```-h``` 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
 
@@ -76,8 +61,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:
 
@@ -100,8 +84,7 @@ Language Extension
 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)
 
@@ -114,8 +97,8 @@ Where to go from here
 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).
+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

data/bin/opinion-detector-server

@@ -1,8 +1,52 @@
 #!/usr/bin/env ruby
 
 require 'puma/cli'
+require 'optparse'
+require 'opener/core/resource_switcher'
 
-rack_config = File.expand_path('../../config.ru', __FILE__)
+# Puma sadly does not provide a system that allows us to cleanly inject custom
+# options into their CLI. At the same time Puma doesn't provide an easy system
+# of starting it *without* using the `Puma::CLI` class.
+#
+# To work around these problems we create our own parser and ignore any invalid
+# option errors it throws up. This parser is used to handle options for the
+# resource switcher.
 
-cli = Puma::CLI.new([rack_config] + ARGV)
-cli.run
+rack_config   = File.expand_path('../../config.ru', __FILE__)
+switcher      = Opener::Core::ResourceSwitcher.new
+switcher_opts = {}
+show_help     = false
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [OPTIONS]"
+
+  opts.separator "\nOptions:\n"
+
+  # Don't abort in this block as we otherwise can't show Puma's help message.
+  opts.on('-h', '--help', 'Shows this help message') do
+    show_help = true
+
+    puts parser
+  end
+
+  switcher.bind(opts, switcher_opts)
+
+  opts.separator "\nPuma Usage:\n\n"
+end
+
+begin
+  # Parse destructively so that Puma doesn't break on our custom options.
+  parser.parse!(ARGV)
+rescue OptionParser::InvalidOption
+  # Catch errors generated by Puma options and ignore them.
+end
+
+# Trigger the Puma help message since we overwrite this option and parse
+# destructively.
+if show_help
+  ARGV << '--help'
+end
+
+switcher.install(switcher_opts)
+
+Puma::CLI.new([rack_config] + ARGV).run

data/exec/opinion-detector.rb

@@ -1,9 +1,19 @@
 #!/usr/bin/env ruby
 
 require 'opener/daemons'
+require 'opener/core/resource_switcher'
+
 require_relative '../lib/opener/opinion_detector'
 
-options = Opener::Daemons::OptParser.parse!(ARGV)
+switcher      = Opener::Core::ResourceSwitcher.new
+switcher_opts = {}
+
+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)
 
-daemon.start
+switcher.install(switcher_opts)
+daemon.start

data/lib/opener/opinion_detector/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opener-opinion-detector
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - development@olery.com