opener-scorer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c7f17022140c8d6b926ea397e425080cd5e2649
+  data.tar.gz: 94e0ff7ab67c6c207cef8fcbbbecf7ea61b6e7e7
+SHA512:
+  metadata.gz: 77ef8845ae7ddb33c92f920b431bcda6e966c7dbbfe3356f13495fd292911c68f84232671815268c0e1ed9bce1f42490437d965fccaa4b67da496177820e9149
+  data.tar.gz: c9a81adb19075b963e9bf52983be175f2e99a87640f7943123f12a42adfd8117123d541e7d4ddbbdcd1855b25d45f6bd35c3bbb8c8e2e41f1661a8abd6d60a07

data/README.md

@@ -0,0 +1,60 @@
+# Scorer
+
+Component that stores results from the Opener Web Services chain into a MySQL 
+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.
+
+
+## Installation
+
+### As part of a Gemfile in a Ruby application
+
+Add this line to your application's Gemfile:
+
+    gem 'opener-scorer',
+        :git=>"git@github.com:opener-project/scorer.git"
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+The Opener Scorer comes equipped with a simple webservice. To start the
+webservice type:
+
+    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
+
+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```
+
+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.
+
+## Contributing
+
+### Procedure
+
+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.
+
+# What's next? 
+
+If you're interested in the opener-scorer, you also might want to check
+out opener-project/scorer.

data/bin/scorer

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'json'
+require_relative '../lib/opener/scorer/output_processor'
+
+processor = Opener::Scorer::OutputProcessor.new((STDIN.tty? ? nil : STDIN.read))
+
+puts processor.process.to_json

data/bin/scorer-server

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+
+# Without calling `Rack::Server#options` manually the CLI arguments will never
+# be passed, thus the application can't be specified as a constructor argument.
+server                  = Rack::Server.new
+server.options[:config] = File.expand_path('../../config.ru', __FILE__)
+
+server.start

data/config.ru

@@ -0,0 +1,4 @@
+require File.expand_path('../lib/opener/scorer', __FILE__)
+require File.expand_path('../lib/opener/scorer/server', __FILE__)
+
+run Opener::Scorer::Server

data/config/database.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+require 'activerecord-jdbcmysql-adapter'
+
+
+DB_PASS = ENV["DB_PASS"]
+DB_NAME = ENV["DB_NAME"]
+DB_USER = ENV["DB_USER"]
+
+if ENV["RACK_ENV"] == 'production'
+  ActiveRecord::Base.establish_connection(
+    :adapter=>  'mysql2',
+    :host => "opener-olery.cqlc6ghud3pa.eu-west-1.rds.amazonaws.com",
+    :username => "enouch",
+    :password => DB_PASS,
+    :database => "opener-olery",
+  )
+else
+  ActiveRecord::Base.establish_connection(
+    adapter:  'mysql2',
+    host:     'localhost',
+    username: 'root',
+    password: DB_PASS || '',
+    database: DB_NAME || 'opener_development'
+  )
+end
+
+if ActiveRecord::Base.connection.execute("SHOW INDEX FROM output_scores").nil?
+  ActiveRecord::Base.connection.execute("CREATE INDEX uuid_index ON output_scores(uuid);")
+end
+ActiveRecord::Base.connection.execute("CREATE TABLE IF NOT EXISTS output_scores (uuid varchar(40), raw_text longtext, bathroom double,breakfast double,cleanliness double,facilities double,internet double,location double,noise double,parking double,restaurant double,room double,sleeping_comfort double,staff double,swimming_pool double,value_for_money double, overall double);")

data/lib/opener/scorer.rb

@@ -0,0 +1,9 @@
+require_relative 'scorer/output'
+require_relative 'scorer/output_processor'
+require_relative 'scorer/version'
+require_relative 'scorer/server'
+
+module Opener
+  class Scorer
+  end
+end

data/lib/opener/scorer/output.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+module Opener
+  class Scorer
+    class Output < ActiveRecord::Base
+       attr_accessible :uuid, :text
+
+       validates_uniqueness_of :uuid
+    end
+  end
+end
+

data/lib/opener/scorer/output_processor.rb

@@ -0,0 +1,151 @@
+require 'nokogiri'
+
+module Opener
+  class Scorer
+    ##
+    # Class that given a raw xml input, it will calculate the overall sentiment
+    # score and the scores per topic, given that it is a valid KAF document.
+    #
+    # @!attribute [r] input
+    #  @return [String]
+    #
+    # @!attribute [r] lemmas_array
+    #  @return [Array]
+    #
+    # @!attribute [r] lemmas_hash
+    #  @return [Hash]
+    #
+    # @!attribute [r] polarities_hash
+    #  @return [Hash]
+    #
+    class OutputProcessor
+      attr_accessor :input, :lemmas_array, :lemmas_hash, :polarities_hash
+
+      ##
+      # @param [String] input
+      #
+      def initialize(input)
+        @input = Nokogiri::XML::Document.parse(input)
+        @lemmas_array = []
+        @lemmas_hash = {}
+        @polarities_hash = {}
+      end
+
+      ##
+      # Process the document and return the scores for the available topics.
+      #
+      # @return [Hash]
+      #
+      def process
+        scores = {}
+
+        build_lemmas_hash
+        build_polarities_hash
+
+        if overall_score = get_overall_score
+          scores[:overall] = overall_score
+        end
+
+        lemmas_hash.keys.each do |topic|
+          score = get_topic_score(topic)
+          if score
+            scores[topic] = score
+          end
+        end
+
+        return scores
+      end
+
+      protected
+
+      ##
+      # Create a hash with all lemma ids per property and also an array with
+      # all lemma ids.
+      #
+      def build_lemmas_hash
+        input.css('features properties property').each do |property|
+          lemma = property.attr('lemma').to_sym
+          lemmas_hash[lemma] ||= []
+          property.css('references target').each do |target|
+            lemma_id = target.attr('id')
+            lemmas_array << lemma_id
+            lemmas_hash[lemma] << lemma_id
+          end
+        end
+      end
+
+      ##
+      # Create a hash with all lemma ids that have a polarity.
+      #
+      def build_polarities_hash
+        input.at('opinions').css('opinion').each do |opinion|
+          polarity = opinion.at('opinion_expression').attr('polarity').to_sym
+          if opinion.at('opinion_target')
+            opinion.at('opinion_target').css('span target').each do |target|
+              polarities_hash[target.attr('id')] ||= []
+              polarities_hash[target.attr('id')] << polarity
+            end
+          end
+
+          opinion.at('opinion_expression').css('span target').each do |target|
+            polarities_hash[target.attr('id')] ||= []
+            polarities_hash[target.attr('id')] << polarity
+          end
+        end
+      end
+
+      ##
+      # Get the score for all lemmas that have a polarity.
+      #
+      # @return [Float]
+      #
+      def get_overall_score
+        polarities = []
+        input.at('opinions').css('opinion').each do |opinion|
+          polarities << opinion.at('opinion_expression').attr('polarity').to_sym
+        end
+        
+        positive = polarities.count(:positive)
+        negative = polarities.count(:negative)
+        
+        return if (positive + negative) == 0
+        
+        score = ((positive - negative).to_f) / (positive + negative)
+        
+        return score     
+      end
+
+      ##
+      # Given a topic, return the sentiment score of the lemmas of this topic.
+      #
+      # @return [Float] || [NilClass]
+      #
+      def get_topic_score(topic)
+        return calculate_score(lemmas_hash[topic]) if lemmas_hash[topic]
+      end
+
+      ##
+      # Given an array of lemma ids, calculate the sentiment score.
+      #
+      # @return [Float]
+      #
+      def calculate_score(lemma_ids)
+        polarities = []
+
+        lemma_ids.each do |id|
+          polarities << polarities_hash[id]
+        end     
+        
+        positive = polarities.flatten.count(:positive)
+        negative = polarities.flatten.count(:negative)
+        
+        return if (positive + negative) == 0
+
+        score = ((positive - negative).to_f) / (positive + negative)
+
+        return score
+      end
+
+    end # OutputProcessor
+  end # Scorer
+end # Opener

data/lib/opener/scorer/server.rb

@@ -0,0 +1,53 @@
+require 'sinatra'
+require 'nokogiri'
+require File.expand_path('../../../../config/database', __FILE__)
+
+module Opener
+  class Scorer
+    class Server < Sinatra::Base
+
+      post '/' do
+        output            = Output.new
+        output.uuid       = params[:request_id]
+        output.text       = OutputProcessor.new(params[:input]).process.to_json
+        output.save
+      end
+
+      get '/' do
+        if params[:request_id]
+          redirect "#{url("/")}#{params[:request_id]}"
+        else
+          erb :index
+        end
+      end
+
+      get '/:request_id' do
+        unless params[:request_id] == 'favicon.ico'
+          begin
+            output = Output.find_by_uuid(params[:request_id])
+
+            if output
+              content_type(:json)
+              scores = JSON.parse(output.text)
+              body( {:uuid=>output.uuid, :scores=>scores}.to_json)
+            else
+              halt(404, "No record found for ID #{params[:request_id]}")
+            end
+          rescue => error
+            error_callback = params[:error_callback]
+
+            submit_error(error_callback, error.message) if error_callback
+
+            raise(error)
+          end
+        end
+      end
+
+      private
+
+      def submit_error(url, message)
+        HTTPClient.post(url, :body => {:error => message})
+      end
+    end # Server
+  end # Scorer
+end # Opener

data/lib/opener/scorer/version.rb

@@ -0,0 +1,5 @@
+module Opener
+  class Scorer
+    VERSION = "1.0.0"
+  end
+end

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

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link type="text/css" rel="stylesheet" charset="UTF-8" href="markdown.css"/>
+    <title>Opener Scorer</title>
+  </head>
+  <body>
+    <h1>Opener Scorer</h1>
+
+    <p>This Web Service, after processing the output, it stores it  in a
+      MySQL database when using callbacks and lets you view the output.</p>
+    <p>When using callbacks, the last Callback URL should be the URL that points
+      to Scorer. Then, when you submit your text, you get a URL where the result
+      will be shown, when the processing is over.</p>
+      
+      <h2>Search for an output</h2>
+
+      <p>* required</p>
+      
+
+      <form action="<%=url("/")%>" method="GET">
+        <div>
+          <label for="request_id"/>Type the ID here*</label>
+          <br/>
+
+          <input type="text" name="request_id" id="text" rows="10" cols="50"/>
+        </div>
+        <input type="submit" value="Submit" />
+      </form>
+
+  </body>
+</html>
+

data/opener-scorer.gemspec

@@ -0,0 +1,37 @@
+require File.expand_path('../lib/opener/scorer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name                  = 'opener-scorer'
+  gem.version               = Opener::Scorer::VERSION
+  gem.authors               = ['development@olery.com']
+  gem.summary               = 'MySQL data storing for the web services output when using callbacks.'
+  gem.description           = gem.summary
+  gem.homepage              = "http://opener-project.github.com/"
+  gem.has_rdoc              = 'yard'
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.files = Dir.glob([
+    'config/**/*',
+    'lib/**/*',
+    'config.ru',
+    '*.gemspec',
+    'README.md'
+  ]).select { |file| File.file?(file) }
+
+  gem.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
+
+  gem.add_dependency 'builder'
+  gem.add_dependency 'sinatra', '~>1.4.2'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'httpclient'
+  gem.add_dependency 'uuidtools'
+  gem.add_dependency 'jdbc-mysql'
+  gem.add_dependency 'activerecord-jdbcmysql-adapter'
+  gem.add_dependency 'activerecord', '~>3.2'
+  gem.add_dependency 'opener-webservice'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: opener-scorer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- development@olery.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !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: httpclient
+  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: uuidtools
+  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: jdbc-mysql
+  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: activerecord-jdbcmysql-adapter
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !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'
+description: MySQL data storing for the web services output when using callbacks.
+email: 
+executables:
+- scorer-server
+- scorer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/scorer
+- bin/scorer-server
+- config.ru
+- config/database.rb
+- lib/opener/scorer.rb
+- lib/opener/scorer/output.rb
+- lib/opener/scorer/output_processor.rb
+- lib/opener/scorer/server.rb
+- lib/opener/scorer/version.rb
+- lib/opener/scorer/views/index.erb
+- opener-scorer.gemspec
+homepage: http://opener-project.github.com/
+licenses: []
+metadata: {}
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: MySQL data storing for the web services output when using callbacks.
+test_files: []
+has_rdoc: yard