opener-tree-tagger 2.0.0

data/lib/opener/tree_tagger/cli.rb

@@ -0,0 +1,69 @@
+module Opener
+  class TreeTagger
+    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   = 'tree-tagger'
+          opts.summary_indent = '  '
+
+          opts.on('-l', '--log', 'Enable logging to STDERR') do
+            @options[:logging] = true
+          end
+
+          opts.separator <<-EOF
+
+Examples:
+
+  cat example.kaf | #{opts.program_name}    # Basic usage
+  cat example.kaf | #{opts.program_name} -l # Logs information to STDERR
+          EOF
+        end
+      end
+
+      ##
+      # @param [String] input
+      #
+      def run(input)
+        option_parser.parse!(options[:args])
+
+        tagger = TreeTagger.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
+  end
+end
+

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

@@ -0,0 +1,284 @@
+
+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/tree_tagger/server.rb

@@ -0,0 +1,16 @@
+require 'sinatra/base'
+require 'httpclient'
+require 'opener/webservice'
+
+module Opener
+  class TreeTagger
+    ##
+    # Polarity tagger server powered by Sinatra.
+    #
+    class Server < Webservice
+      set :views, File.expand_path('../views', __FILE__)
+      text_processor TreeTagger
+      accepted_params :input
+    end # Server
+  end # PolarityTagger
+end # Opener

data/lib/opener/tree_tagger/version.rb

@@ -0,0 +1,5 @@
+module Opener
+  class TreeTagger
+    VERSION = "2.0.0"
+  end
+end

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

@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link type="text/css" rel="stylesheet" charset="UTF-8" href="markdown.css"/>
+    <title>Tree Tagger Web Service</title>
+  </head>
+  <body>
+    <h1>Tree Tagger Web Service</h1>
+
+    <h2>Example Usage</h2>
+
+    <p>
+      <pre>opener-tree-tagger-server start</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>Tag the input tokenized 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></pre>
+
+      <dt>callbacks</dt>
+      <dd>
+            You can provide a list of callback urls. If you provide callback urls
+            the POS tagger 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>