opener-scorer 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5847623ff1e420084cafc853ee471ba7ca3cdbba
-  data.tar.gz: 4f02f6dc97967c621f629f72d14aa6b85e05724e
+  metadata.gz: b38817e4cd7ae799a80693f0ceaa347a95cd74fa
+  data.tar.gz: 182d4a7edc2cbf4d00f66d788b3abaa115572277
 SHA512:
-  metadata.gz: 13be740678aaed976690a837223997b6db91fa38a48827c6c005f644ca93fa0970c7a199099db2fd0745ebcbcfdc8fa8a4c237b7e0abaae9623798e360098f0a
-  data.tar.gz: b926359ed64e45209ffd422fc4aeab4964d042b21c4744096bcba5a823a77f2c551887e120a15537665d4f2f37c3e7afbf5138a693d04a74ebf88d6400f182d3
+  metadata.gz: 07c9f2cad83ed4d473111c6f010a0b7f66b30da64c7833a03598e69248edf613b757a5d93aacf6e9406bc818965dd3b375bc2eec00a576b37b327fbb696617a3
+  data.tar.gz: ff24a27f14da1db5d27cddba16510cfcd58571edec896c69653f1ffcc9109969b67eda472497a14050ac9fc6fb56d02f2e28c487168ae9921533fd774d561f7a

data/README.md

@@ -1,4 +1,5 @@
-# Scorer
+Scorer
+------------
 
 Component that stores results from the Opener Web Services chain into a MySQL 
 Database and shows them into your browser.
@@ -6,55 +7,121 @@ Database and shows them into your browser.
 It can be used instead of Opener Outlet, to calculate overall sentiment score
 and sentiment score per topic.
 
+### Confused by some terminology?
 
-## Installation
+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.
 
-### As part of a Gemfile in a Ruby application
+Quick Use Example
+-----------------
 
-Add this line to your application's Gemfile:
+Installing the scorer can be done by executing:
 
-    gem 'opener-scorer',
-        :git=>"git@github.com:opener-project/scorer.git"
+    gem install opener-scorer
 
-And then execute:
+Please bare in mind that all components in OpeNER take KAF as an input and
+output KAF by default.
 
-    $ bundle install
+### Command line interface
 
-## Usage
+You should now be able to call the scorer 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.
 
-The Opener Scorer comes equipped with a simple webservice. To start the
-webservice type:
+This aplication reads a text from standard input in order to rate the given text.
+
+    cat some_kind_of_kaf_file.kaf | scorer
+
+
+This will output (JSON Format):
+
+```
+{"overall":-0.06666666666666667,"Restaurant":0.3333333333333333,"Staff":-1.0,"Rooms":1.0,"Facilities":-1.0}
+```
+
+### Webservices
+
+You can launch a webservice by executing:
 
     scorer-server
 
 This will launch a mini webserver with the webservice. It defaults to port 9292,
-so you can access it at:
-
-    http://localhost:9292
+so you can access it at <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:
 
     scorer-server -p 1234
 
-It then launches at ```http://localhost:1234```
+It then launches at <http://localhost:1234>
 
-When you run a chain of web services using callbacks, the last URL should be the
-one that points to the Scorer Web Service. A unique id is generated and once the
-chain has finished processing the text, you can view the result in the URL that
-you get.
+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.
 
-## Contributing
 
-### Procedure
+### Daemon
 
-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.
+Last but not least the scorer comes shipped with a daemon that
+can read jobs (and write) jobs to and from Amazon SQS queues. For more
+information type:
+
+    scorer-daemon -h
+
+
+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:
+
+### Depenencies for normal use:
 
-# What's next? 
+* JRuby 1.7.9 or newer
 
-If you're interested in the opener-scorer, you also might want to check
-out opener-project/scorer.
+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 repositories:
+
+* (link to) Related Core readmes
+
+Where to go from here
+---------------------
+
+* Check (the project websitere)[http://opener-project.github.io]
+* (Checkout the webservice)[http://opener.olery.com/scorer]
+
+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/scorer/issues].
+
+
+Contributing
+------------
+
+1. Fork it ( http://github.com/opener-project/scorer/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/lib/opener/scorer/output.rb

@@ -3,8 +3,6 @@ require 'active_record'
 module Opener
   class Scorer
     class Output < ActiveRecord::Base
-       attr_accessible :uuid, :text
-
        validates_uniqueness_of :uuid
     end
   end

data/lib/opener/scorer/version.rb

@@ -1,5 +1,5 @@
 module Opener
   class Scorer
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,216 +1,216 @@
 --- !ruby/object:Gem::Specification
 name: opener-scorer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - development@olery.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.2
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: nokogiri
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: httpclient
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: uuidtools
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: puma
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: jdbc-mysql
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jdbc-mysql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: activerecord-jdbcmysql-adapter
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord-jdbcmysql-adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: activerecord
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
+        version: '3.2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: opener-webservice
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: opener-webservice
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
   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
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: cucumber
   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
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
   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
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
   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'
+  type: :development
 description: MySQL data storing for the web services output when using callbacks.
-email: 
+email:
 executables:
-- scorer-server
 - scorer
+- scorer-server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -229,25 +229,24 @@ files:
 homepage: http://opener-project.github.com/
 licenses: []
 metadata: {}
-post_install_message: 
+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: 
+rubyforge_project:
 rubygems_version: 2.2.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: MySQL data storing for the web services output when using callbacks.
 test_files: []
-has_rdoc: yard