opener-scorer 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +97 -30
  3. data/lib/opener/scorer/output.rb +0 -2
  4. data/lib/opener/scorer/version.rb +1 -1
  5. metadata +86 -87
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 5847623ff1e420084cafc853ee471ba7ca3cdbba
4
- data.tar.gz: 4f02f6dc97967c621f629f72d14aa6b85e05724e
3
+ metadata.gz: b38817e4cd7ae799a80693f0ceaa347a95cd74fa
4
+ data.tar.gz: 182d4a7edc2cbf4d00f66d788b3abaa115572277
5
5
  SHA512:
6
- metadata.gz: 13be740678aaed976690a837223997b6db91fa38a48827c6c005f644ca93fa0970c7a199099db2fd0745ebcbcfdc8fa8a4c237b7e0abaae9623798e360098f0a
7
- data.tar.gz: b926359ed64e45209ffd422fc4aeab4964d042b21c4744096bcba5a823a77f2c551887e120a15537665d4f2f37c3e7afbf5138a693d04a74ebf88d6400f182d3
6
+ metadata.gz: 07c9f2cad83ed4d473111c6f010a0b7f66b30da64c7833a03598e69248edf613b757a5d93aacf6e9406bc818965dd3b375bc2eec00a576b37b327fbb696617a3
7
+ data.tar.gz: ff24a27f14da1db5d27cddba16510cfcd58571edec896c69653f1ffcc9109969b67eda472497a14050ac9fc6fb56d02f2e28c487168ae9921533fd774d561f7a
data/README.md CHANGED
@@ -1,4 +1,5 @@
1
- # Scorer
1
+ Scorer
2
+ ------------
2
3
 
3
4
  Component that stores results from the Opener Web Services chain into a MySQL
4
5
  Database and shows them into your browser.
@@ -6,55 +7,121 @@ Database and shows them into your browser.
6
7
  It can be used instead of Opener Outlet, to calculate overall sentiment score
7
8
  and sentiment score per topic.
8
9
 
10
+ ### Confused by some terminology?
9
11
 
10
- ## Installation
12
+ This software is part of a larger collection of natural language processing
13
+ tools known as "the OpeNER project". You can find more information about the
14
+ project at (the OpeNER portal)[http://opener-project.github.io]. There you can
15
+ also find references to terms like KAF (an XML standard to represent linguistic
16
+ annotations in texts), component, cores, scenario's and pipelines.
11
17
 
12
- ### As part of a Gemfile in a Ruby application
18
+ Quick Use Example
19
+ -----------------
13
20
 
14
- Add this line to your application's Gemfile:
21
+ Installing the scorer can be done by executing:
15
22
 
16
- gem 'opener-scorer',
17
- :git=>"git@github.com:opener-project/scorer.git"
23
+ gem install opener-scorer
18
24
 
19
- And then execute:
25
+ Please bare in mind that all components in OpeNER take KAF as an input and
26
+ output KAF by default.
20
27
 
21
- $ bundle install
28
+ ### Command line interface
22
29
 
23
- ## Usage
30
+ You should now be able to call the scorer as a regular shell
31
+ command: by its name. Once installed the gem normally sits in your path so you can call it directly from anywhere.
24
32
 
25
- The Opener Scorer comes equipped with a simple webservice. To start the
26
- webservice type:
33
+ This aplication reads a text from standard input in order to rate the given text.
34
+
35
+ cat some_kind_of_kaf_file.kaf | scorer
36
+
37
+
38
+ This will output (JSON Format):
39
+
40
+ ```
41
+ {"overall":-0.06666666666666667,"Restaurant":0.3333333333333333,"Staff":-1.0,"Rooms":1.0,"Facilities":-1.0}
42
+ ```
43
+
44
+ ### Webservices
45
+
46
+ You can launch a webservice by executing:
27
47
 
28
48
  scorer-server
29
49
 
30
50
  This will launch a mini webserver with the webservice. It defaults to port 9292,
31
- so you can access it at:
32
-
33
- http://localhost:9292
51
+ so you can access it at <http://localhost:9292>.
34
52
 
35
- To launch it on a different port provide the ```-p [port-number]``` option like
53
+ To launch it on a different port provide the `-p [port-number]` option like
36
54
  this:
37
55
 
38
56
  scorer-server -p 1234
39
57
 
40
- It then launches at ```http://localhost:1234```
58
+ It then launches at <http://localhost:1234>
41
59
 
42
- When you run a chain of web services using callbacks, the last URL should be the
43
- one that points to the Scorer Web Service. A unique id is generated and once the
44
- chain has finished processing the text, you can view the result in the URL that
45
- you get.
60
+ Documentation on the Webservice is provided by surfing to the urls provided
61
+ above. For more information on how to launch a webservice run the command with
62
+ the ```-h``` option.
46
63
 
47
- ## Contributing
48
64
 
49
- ### Procedure
65
+ ### Daemon
50
66
 
51
- 1. Pull it
52
- 2. Create your feature branch (`git checkout -b features/my-new-feature`)
53
- 3. Commit your changes (`git commit -am 'Add some feature'`)
54
- 4. Push to the branch (`git push origin features/my-new-feature`)
55
- 5. If you're confident, merge your changes into master.
67
+ Last but not least the scorer comes shipped with a daemon that
68
+ can read jobs (and write) jobs to and from Amazon SQS queues. For more
69
+ information type:
70
+
71
+ scorer-daemon -h
72
+
73
+
74
+ Description of dependencies
75
+ ---------------------------
76
+
77
+ This component runs best if you run it in an environment suited for OpeNER
78
+ components. You can find an installation guide and helper tools in the (OpeNER
79
+ installer)[https://github.com/opener-project/opener-installer] and (an
80
+ installation guide on the Opener
81
+ Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html]
82
+
83
+ At least you need the following system setup:
84
+
85
+ ### Depenencies for normal use:
56
86
 
57
- # What's next?
87
+ * JRuby 1.7.9 or newer
58
88
 
59
- If you're interested in the opener-scorer, you also might want to check
60
- out opener-project/scorer.
89
+ Domain Adaption
90
+ ---------------
91
+
92
+ TODO
93
+
94
+ Language Extension
95
+ ------------------
96
+
97
+ TODO
98
+
99
+ The Core
100
+ --------
101
+
102
+ The component is a fat wrapper around the actual language technology core. You
103
+ can find the core technolies in the following repositories:
104
+
105
+ * (link to) Related Core readmes
106
+
107
+ Where to go from here
108
+ ---------------------
109
+
110
+ * Check (the project websitere)[http://opener-project.github.io]
111
+ * (Checkout the webservice)[http://opener.olery.com/scorer]
112
+
113
+ Report problem/Get help
114
+ -----------------------
115
+
116
+ If you encounter problems, please email support@opener-project.eu or leave an
117
+ issue in the (issue tracker)[https://github.com/opener-project/scorer/issues].
118
+
119
+
120
+ Contributing
121
+ ------------
122
+
123
+ 1. Fork it ( http://github.com/opener-project/scorer/fork )
124
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
125
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
126
+ 4. Push to the branch (`git push origin my-new-feature`)
127
+ 5. Create new Pull Request
data/lib/opener/scorer/output.rb CHANGED
@@ -3,8 +3,6 @@ require 'active_record'
3
3
  module Opener
4
4
  class Scorer
5
5
  class Output < ActiveRecord::Base
6
- attr_accessible :uuid, :text
7
-
8
6
  validates_uniqueness_of :uuid
9
7
  end
10
8
  end
data/lib/opener/scorer/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Opener
2
2
  class Scorer
3
- VERSION = "1.0.2"
3
+ VERSION = "1.0.3"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,216 +1,216 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opener-scorer
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 1.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - development@olery.com
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-05-20 00:00:00.000000000 Z
11
+ date: 2014-05-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: builder
15
- requirement: !ruby/object:Gem::Requirement
15
+ version_requirements: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - ">="
17
+ - - '>='
18
18
  - !ruby/object:Gem::Version
19
19
  version: '0'
20
- type: :runtime
21
- prerelease: false
22
- version_requirements: !ruby/object:Gem::Requirement
20
+ requirement: !ruby/object:Gem::Requirement
23
21
  requirements:
24
- - - ">="
22
+ - - '>='
25
23
  - !ruby/object:Gem::Version
26
24
  version: '0'
25
+ prerelease: false
26
+ type: :runtime
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: sinatra
29
- requirement: !ruby/object:Gem::Requirement
29
+ version_requirements: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ~>
32
32
  - !ruby/object:Gem::Version
33
33
  version: 1.4.2
34
- type: :runtime
35
- prerelease: false
36
- version_requirements: !ruby/object:Gem::Requirement
34
+ requirement: !ruby/object:Gem::Requirement
37
35
  requirements:
38
- - - "~>"
36
+ - - ~>
39
37
  - !ruby/object:Gem::Version
40
38
  version: 1.4.2
39
+ prerelease: false
40
+ type: :runtime
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: nokogiri
43
+ version_requirements: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
43
48
  requirement: !ruby/object:Gem::Requirement
44
49
  requirements:
45
- - - ">="
50
+ - - '>='
46
51
  - !ruby/object:Gem::Version
47
52
  version: '0'
48
- type: :runtime
49
53
  prerelease: false
54
+ type: :runtime
55
+ - !ruby/object:Gem::Dependency
56
+ name: httpclient
50
57
  version_requirements: !ruby/object:Gem::Requirement
51
58
  requirements:
52
- - - ">="
59
+ - - '>='
53
60
  - !ruby/object:Gem::Version
54
61
  version: '0'
55
- - !ruby/object:Gem::Dependency
56
- name: httpclient
57
62
  requirement: !ruby/object:Gem::Requirement
58
63
  requirements:
59
- - - ">="
64
+ - - '>='
60
65
  - !ruby/object:Gem::Version
61
66
  version: '0'
62
- type: :runtime
63
67
  prerelease: false
68
+ type: :runtime
69
+ - !ruby/object:Gem::Dependency
70
+ name: uuidtools
64
71
  version_requirements: !ruby/object:Gem::Requirement
65
72
  requirements:
66
- - - ">="
73
+ - - '>='
67
74
  - !ruby/object:Gem::Version
68
75
  version: '0'
69
- - !ruby/object:Gem::Dependency
70
- name: uuidtools
71
76
  requirement: !ruby/object:Gem::Requirement
72
77
  requirements:
73
- - - ">="
78
+ - - '>='
74
79
  - !ruby/object:Gem::Version
75
80
  version: '0'
76
- type: :runtime
77
81
  prerelease: false
82
+ type: :runtime
83
+ - !ruby/object:Gem::Dependency
84
+ name: puma
78
85
  version_requirements: !ruby/object:Gem::Requirement
79
86
  requirements:
80
- - - ">="
87
+ - - '>='
81
88
  - !ruby/object:Gem::Version
82
89
  version: '0'
83
- - !ruby/object:Gem::Dependency
84
- name: puma
85
90
  requirement: !ruby/object:Gem::Requirement
86
91
  requirements:
87
- - - ">="
92
+ - - '>='
88
93
  - !ruby/object:Gem::Version
89
94
  version: '0'
90
- type: :runtime
91
95
  prerelease: false
96
+ type: :runtime
97
+ - !ruby/object:Gem::Dependency
98
+ name: jdbc-mysql
92
99
  version_requirements: !ruby/object:Gem::Requirement
93
100
  requirements:
94
- - - ">="
101
+ - - '>='
95
102
  - !ruby/object:Gem::Version
96
103
  version: '0'
97
- - !ruby/object:Gem::Dependency
98
- name: jdbc-mysql
99
104
  requirement: !ruby/object:Gem::Requirement
100
105
  requirements:
101
- - - ">="
106
+ - - '>='
102
107
  - !ruby/object:Gem::Version
103
108
  version: '0'
104
- type: :runtime
105
109
  prerelease: false
110
+ type: :runtime
111
+ - !ruby/object:Gem::Dependency
112
+ name: activerecord-jdbcmysql-adapter
106
113
  version_requirements: !ruby/object:Gem::Requirement
107
114
  requirements:
108
- - - ">="
115
+ - - '>='
109
116
  - !ruby/object:Gem::Version
110
117
  version: '0'
111
- - !ruby/object:Gem::Dependency
112
- name: activerecord-jdbcmysql-adapter
113
118
  requirement: !ruby/object:Gem::Requirement
114
119
  requirements:
115
- - - ">="
120
+ - - '>='
116
121
  - !ruby/object:Gem::Version
117
122
  version: '0'
118
- type: :runtime
119
123
  prerelease: false
124
+ type: :runtime
125
+ - !ruby/object:Gem::Dependency
126
+ name: activerecord
120
127
  version_requirements: !ruby/object:Gem::Requirement
121
128
  requirements:
122
- - - ">="
129
+ - - ~>
123
130
  - !ruby/object:Gem::Version
124
- version: '0'
125
- - !ruby/object:Gem::Dependency
126
- name: activerecord
131
+ version: '3.2'
127
132
  requirement: !ruby/object:Gem::Requirement
128
133
  requirements:
129
- - - "~>"
134
+ - - ~>
130
135
  - !ruby/object:Gem::Version
131
136
  version: '3.2'
132
- type: :runtime
133
137
  prerelease: false
138
+ type: :runtime
139
+ - !ruby/object:Gem::Dependency
140
+ name: opener-webservice
134
141
  version_requirements: !ruby/object:Gem::Requirement
135
142
  requirements:
136
- - - "~>"
143
+ - - '>='
137
144
  - !ruby/object:Gem::Version
138
- version: '3.2'
139
- - !ruby/object:Gem::Dependency
140
- name: opener-webservice
145
+ version: '0'
141
146
  requirement: !ruby/object:Gem::Requirement
142
147
  requirements:
143
- - - ">="
148
+ - - '>='
144
149
  - !ruby/object:Gem::Version
145
150
  version: '0'
146
- type: :runtime
147
151
  prerelease: false
152
+ type: :runtime
153
+ - !ruby/object:Gem::Dependency
154
+ name: rspec
148
155
  version_requirements: !ruby/object:Gem::Requirement
149
156
  requirements:
150
- - - ">="
157
+ - - '>='
151
158
  - !ruby/object:Gem::Version
152
159
  version: '0'
153
- - !ruby/object:Gem::Dependency
154
- name: rspec
155
160
  requirement: !ruby/object:Gem::Requirement
156
161
  requirements:
157
- - - ">="
162
+ - - '>='
158
163
  - !ruby/object:Gem::Version
159
164
  version: '0'
160
- type: :development
161
165
  prerelease: false
166
+ type: :development
167
+ - !ruby/object:Gem::Dependency
168
+ name: cucumber
162
169
  version_requirements: !ruby/object:Gem::Requirement
163
170
  requirements:
164
- - - ">="
171
+ - - '>='
165
172
  - !ruby/object:Gem::Version
166
173
  version: '0'
167
- - !ruby/object:Gem::Dependency
168
- name: cucumber
169
174
  requirement: !ruby/object:Gem::Requirement
170
175
  requirements:
171
- - - ">="
176
+ - - '>='
172
177
  - !ruby/object:Gem::Version
173
178
  version: '0'
174
- type: :development
175
179
  prerelease: false
180
+ type: :development
181
+ - !ruby/object:Gem::Dependency
182
+ name: pry
176
183
  version_requirements: !ruby/object:Gem::Requirement
177
184
  requirements:
178
- - - ">="
185
+ - - '>='
179
186
  - !ruby/object:Gem::Version
180
187
  version: '0'
181
- - !ruby/object:Gem::Dependency
182
- name: pry
183
188
  requirement: !ruby/object:Gem::Requirement
184
189
  requirements:
185
- - - ">="
190
+ - - '>='
186
191
  - !ruby/object:Gem::Version
187
192
  version: '0'
188
- type: :development
189
193
  prerelease: false
194
+ type: :development
195
+ - !ruby/object:Gem::Dependency
196
+ name: rake
190
197
  version_requirements: !ruby/object:Gem::Requirement
191
198
  requirements:
192
- - - ">="
199
+ - - '>='
193
200
  - !ruby/object:Gem::Version
194
201
  version: '0'
195
- - !ruby/object:Gem::Dependency
196
- name: rake
197
202
  requirement: !ruby/object:Gem::Requirement
198
203
  requirements:
199
- - - ">="
204
+ - - '>='
200
205
  - !ruby/object:Gem::Version
201
206
  version: '0'
202
- type: :development
203
207
  prerelease: false
204
- version_requirements: !ruby/object:Gem::Requirement
205
- requirements:
206
- - - ">="
207
- - !ruby/object:Gem::Version
208
- version: '0'
208
+ type: :development
209
209
  description: MySQL data storing for the web services output when using callbacks.
210
- email:
210
+ email:
211
211
  executables:
212
- - scorer-server
213
212
  - scorer
213
+ - scorer-server
214
214
  extensions: []
215
215
  extra_rdoc_files: []
216
216
  files:
@@ -229,25 +229,24 @@ files:
229
229
  homepage: http://opener-project.github.com/
230
230
  licenses: []
231
231
  metadata: {}
232
- post_install_message:
232
+ post_install_message:
233
233
  rdoc_options: []
234
234
  require_paths:
235
235
  - lib
236
236
  required_ruby_version: !ruby/object:Gem::Requirement
237
237
  requirements:
238
- - - ">="
238
+ - - '>='
239
239
  - !ruby/object:Gem::Version
240
240
  version: 1.9.2
241
241
  required_rubygems_version: !ruby/object:Gem::Requirement
242
242
  requirements:
243
- - - ">="
243
+ - - '>='
244
244
  - !ruby/object:Gem::Version
245
245
  version: '0'
246
246
  requirements: []
247
- rubyforge_project:
247
+ rubyforge_project:
248
248
  rubygems_version: 2.2.2
249
- signing_key:
249
+ signing_key:
250
250
  specification_version: 4
251
251
  summary: MySQL data storing for the web services output when using callbacks.
252
252
  test_files: []
253
- has_rdoc: yard