opener-outlet 1.0.1 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +84 -32
  3. data/config/database.rb +11 -11
  4. data/lib/opener/outlet/output.rb +1 -3
  5. data/lib/opener/outlet/version.rb +1 -1
  6. metadata +89 -90
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f7e8f97ae0cd983e2615e1a56091f769fe99d16a
4
- data.tar.gz: c1b7c8748c5cf2b4b2be5e30a462679c37f50cc3
3
+ metadata.gz: ee0777ec7c070229ca946ef35baf649caec2c214
4
+ data.tar.gz: 4c882fddf5409115a28dd5e6fef6704382dd7fcc
5
5
  SHA512:
6
- metadata.gz: 5bba56e3eb92c6eee490a445093be43a3d34ad60f29e4e32668435e6188c9747fb71d0ef5b6b8684df16e7f2ff1df3f91b3a52b259300e116eb732706dd70e07
7
- data.tar.gz: 0f29700842e2f4279099891dd951557a3bd805a28c269f65f32b6424fe11ae8774bcd445d3dc4afe6925aabd222a31eabee6edeb157b12c59207afeaa06fe88a
6
+ metadata.gz: 5d9c2f01d80022cf76b37591c6f1495ab4c84714efecdbcc3ba80486fcc09492fa6c35b1570e8c74f8b1633b8f4c30d3c78f6077af4e77688cd260ddd677072d
7
+ data.tar.gz: 1ddf421608c1999faabd1a492cbaab15896073228cac4c6d7b65009bd3075d357b101338bf29d317f3d50a4fc4a54d082803bd9acfb0965af16b29e871f5c160
data/README.md CHANGED
@@ -1,57 +1,109 @@
1
- # Outlet
1
+ Outlet
2
+ ------------
2
3
 
3
4
  Component that stores results from the Opener Web Services chain into a SQLite
4
5
  Database and shows them into your browser.
5
6
 
7
+ ### Confused by some terminology?
6
8
 
7
- ## Installation
9
+ This software is part of a larger collection of natural language processing
10
+ tools known as "the OpeNER project". You can find more information about the
11
+ project at (the OpeNER portal)[http://opener-project.github.io]. There you can
12
+ also find references to terms like KAF (an XML standard to represent linguistic
13
+ annotations in texts), component, cores, scenario's and pipelines.
8
14
 
9
- ### As part of a Gemfile in a Ruby application
15
+ Quick Use Example
16
+ -----------------
10
17
 
11
- Add this line to your application's Gemfile:
18
+ Installing the outlet can be done by executing:
12
19
 
13
- gem 'opener-outlet',
14
- :git=>"git@github.com:opener-project/outlet.git"
20
+ gem install opener-outlet
15
21
 
16
- And then execute:
22
+ Please bare in mind that all components in OpeNER take KAF as an input and
23
+ output KAF by default.
17
24
 
18
- $ bundle install
25
+ ### Webservices
19
26
 
20
- ## Usage
21
-
22
- The Opener Outlet comes equipped with a simple webservice. To start the
23
- webservice type:
27
+ You can launch a webservice by executing:
24
28
 
25
29
  outlet-server
26
30
 
27
31
  This will launch a mini webserver with the webservice. It defaults to port 9292,
28
- so you can access it at:
29
-
30
- http://localhost:9292
32
+ so you can access it at <http://localhost:9292>.
31
33
 
32
- To launch it on a different port provide the ```-p [port-number]``` option like
34
+ To launch it on a different port provide the `-p [port-number]` option like
33
35
  this:
34
36
 
35
- opinion-detector-server -p 1234
37
+ outlet-server -p 1234
36
38
 
37
- It then launches at ```http://localhost:1234```
39
+ It then launches at <http://localhost:1234>
38
40
 
39
- When you run a chain of web services using callbacks, the last URL should be the
40
- one that points to the Outlet Web Service. A unique id is generated and once the
41
- chain has finished processing the text, you can view the result in the URL that
42
- you get.
41
+ Documentation on the Webservice is provided by surfing to the urls provided
42
+ above. For more information on how to launch a webservice run the command with
43
+ the ```-h``` option.
43
44
 
44
- ## Contributing
45
45
 
46
- ### Procedure
46
+ ### Daemon
47
47
 
48
- 1. Pull it
49
- 2. Create your feature branch (`git checkout -b features/my-new-feature`)
50
- 3. Commit your changes (`git commit -am 'Add some feature'`)
51
- 4. Push to the branch (`git push origin features/my-new-feature`)
52
- 5. If you're confident, merge your changes into master.
48
+ Last but not least the outlet comes shipped with a daemon that
49
+ can read jobs (and write) jobs to and from Amazon SQS queues. For more
50
+ information type:
51
+
52
+ outlet-daemon -h
53
+
54
+
55
+ Description of dependencies
56
+ ---------------------------
57
+
58
+ This component runs best if you run it in an environment suited for OpeNER
59
+ components. You can find an installation guide and helper tools in the (OpeNER
60
+ installer)[https://github.com/opener-project/opener-installer] and (an
61
+ installation guide on the Opener
62
+ Website)[http://opener-project.github.io/getting-started/how-to/local-installation.html]
63
+
64
+ At least you need the following system setup:
65
+
66
+ ### Depenencies for normal use:
67
+
68
+ * JRuby 1.7.9 or newer
69
+ * Ruby 1.9.3 or newer
70
+
71
+ Domain Adaption
72
+ ---------------
73
+
74
+ TODO
53
75
 
54
- # What's next?
76
+ Language Extension
77
+ ------------------
55
78
 
56
- If you're interested in the opener-outlet, you also might want to check
57
- out opener-project/outlet.
79
+ TODO
80
+
81
+ The Core
82
+ --------
83
+
84
+ The component is a fat wrapper around the actual language technology core. You
85
+ can find the core technolies in the following repositories:
86
+
87
+ * (link to) Related Core readmes
88
+
89
+ Where to go from here
90
+ ---------------------
91
+
92
+ * Check (the project websitere)[http://opener-project.github.io]
93
+ * (Checkout the webservice)[http://opener.olery.com/outlet]
94
+
95
+ Report problem/Get help
96
+ -----------------------
97
+
98
+ If you encounter problems, please email support@opener-project.eu or leave an
99
+ issue in the (issue tracker)[https://github.com/opener-project/outlet/issues].
100
+
101
+
102
+ Contributing
103
+ ------------
104
+
105
+ 1. Fork it ( http://github.com/opener-project/outlet/fork )
106
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
107
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
108
+ 4. Push to the branch (`git push origin my-new-feature`)
109
+ 5. Create new Pull Request
data/config/database.rb CHANGED
@@ -1,26 +1,26 @@
1
1
  require 'active_record'
2
2
  require 'activerecord-jdbcmysql-adapter'
3
3
 
4
- DB_PASS = ENV["DB_PASS"]
5
- DB_NAME = ENV["DB_NAME"]
6
- DB_USER = ENV["DB_USER"]
7
- DB_HOST = ENV["DB_HOST"]
4
+ db_pass = ENV["DB_PASS"]
5
+ db_name = ENV["DB_NAME"]
6
+ db_user = ENV["DB_USER"]
7
+ db_host = ENV["DB_HOST"]
8
8
 
9
9
  if ENV["RACK_ENV"] == 'production'
10
10
  ActiveRecord::Base.establish_connection(
11
11
  adapter: 'mysql2',
12
- database: DB_NAME,
13
- host: DB_HOST,
14
- username: DB_USER,
15
- password: DB_PASS
12
+ database: db_name,
13
+ host: db_host,
14
+ username: db_user,
15
+ password: db_pass
16
16
  )
17
17
  else
18
18
  ActiveRecord::Base.establish_connection(
19
19
  adapter: 'mysql2',
20
- host: DB_HOST || 'localhost',
20
+ host: db_host || 'localhost',
21
21
  username: 'root',
22
- password: DB_PASS || '',
23
- database: DB_NAME || 'opener_development'
22
+ password: db_pass || '',
23
+ database: db_name || 'opener_development'
24
24
  )
25
25
  end
26
26
 
data/lib/opener/outlet/output.rb CHANGED
@@ -2,9 +2,7 @@ require 'active_record'
2
2
 
3
3
  module Opener
4
4
  class Outlet
5
- class Output < ActiveRecord::Base
6
- attr_accessible :uuid, :text
7
-
5
+ class Output < ActiveRecord::Base
8
6
  validates_uniqueness_of :uuid
9
7
  end
10
8
  end
data/lib/opener/outlet/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Opener
2
2
  class Outlet
3
- VERSION = "1.0.1"
3
+ VERSION = "1.0.3"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,227 +1,227 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opener-outlet
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
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
11
  date: 2014-05-20 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: 3.0.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: 3.0.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: puma
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: puma
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: httpclient
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: httpclient
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: uuidtools
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: uuidtools
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: activesupport
134
141
  version_requirements: !ruby/object:Gem::Requirement
135
142
  requirements:
136
- - - "~>"
143
+ - - ~>
137
144
  - !ruby/object:Gem::Version
138
145
  version: '3.2'
139
- - !ruby/object:Gem::Dependency
140
- name: activesupport
141
146
  requirement: !ruby/object:Gem::Requirement
142
147
  requirements:
143
- - - "~>"
148
+ - - ~>
144
149
  - !ruby/object:Gem::Version
145
150
  version: '3.2'
146
- type: :runtime
147
151
  prerelease: false
152
+ type: :runtime
153
+ - !ruby/object:Gem::Dependency
154
+ name: opener-webservice
148
155
  version_requirements: !ruby/object:Gem::Requirement
149
156
  requirements:
150
- - - "~>"
157
+ - - '>='
151
158
  - !ruby/object:Gem::Version
152
- version: '3.2'
153
- - !ruby/object:Gem::Dependency
154
- name: opener-webservice
159
+ version: '0'
155
160
  requirement: !ruby/object:Gem::Requirement
156
161
  requirements:
157
- - - ">="
162
+ - - '>='
158
163
  - !ruby/object:Gem::Version
159
164
  version: '0'
160
- type: :runtime
161
165
  prerelease: false
166
+ type: :runtime
167
+ - !ruby/object:Gem::Dependency
168
+ name: rspec
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: rspec
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: cucumber
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: cucumber
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: pry
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: pry
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
208
+ type: :development
209
+ - !ruby/object:Gem::Dependency
210
+ name: rake
204
211
  version_requirements: !ruby/object:Gem::Requirement
205
212
  requirements:
206
- - - ">="
213
+ - - '>='
207
214
  - !ruby/object:Gem::Version
208
215
  version: '0'
209
- - !ruby/object:Gem::Dependency
210
- name: rake
211
216
  requirement: !ruby/object:Gem::Requirement
212
217
  requirements:
213
- - - ">="
218
+ - - '>='
214
219
  - !ruby/object:Gem::Version
215
220
  version: '0'
216
- type: :development
217
221
  prerelease: false
218
- version_requirements: !ruby/object:Gem::Requirement
219
- requirements:
220
- - - ">="
221
- - !ruby/object:Gem::Version
222
- version: '0'
222
+ type: :development
223
223
  description: Database storing for the web services output when using callbacks.
224
- email:
224
+ email:
225
225
  executables:
226
226
  - outlet-server
227
227
  extensions: []
@@ -245,25 +245,24 @@ files:
245
245
  homepage: http://opener-project.github.com/
246
246
  licenses: []
247
247
  metadata: {}
248
- post_install_message:
248
+ post_install_message:
249
249
  rdoc_options: []
250
250
  require_paths:
251
251
  - lib
252
252
  required_ruby_version: !ruby/object:Gem::Requirement
253
253
  requirements:
254
- - - ">="
254
+ - - '>='
255
255
  - !ruby/object:Gem::Version
256
256
  version: 1.9.2
257
257
  required_rubygems_version: !ruby/object:Gem::Requirement
258
258
  requirements:
259
- - - ">="
259
+ - - '>='
260
260
  - !ruby/object:Gem::Version
261
261
  version: '0'
262
262
  requirements: []
263
- rubyforge_project:
263
+ rubyforge_project:
264
264
  rubygems_version: 2.2.2
265
- signing_key:
265
+ signing_key:
266
266
  specification_version: 4
267
267
  summary: Database storing for the web services output when using callbacks.
268
268
  test_files: []
269
- has_rdoc: yard