cpee-worklist 1.0.0

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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 59ae04616e62aed19b864c9e592bb02c26748121c99088713d1f4dfcce9411df
4
+ data.tar.gz: d92a64bd471d4c44cdafd6a32595a3c7cc3a53bb4f7ffe596612a803fb4159c7
5
+ SHA512:
6
+ metadata.gz: af8ffc66af266196228708e7639ffa3a613b487dc57d81b9ab667368e43d382ada743917a4c95aab890489c8b8a3c5131e1958bc3486d4648600ad1143310d94
7
+ data.tar.gz: 40059cbe217575aa2de00b3b49da4522d585805b397071e73adc08c5304830b11b64758b81396e75b560b1eb771ba3810c02bc3fd82b326732186869b5747626
data/AUTHORS ADDED
@@ -0,0 +1,3 @@
1
+ Jürgen 'eTM' Mangler <juergen.mangler@univie.ac.at>
2
+ Florian 'Triarier' Stertz <florian.stertz@gmail.com>
3
+ Patrik 'The King' Koenig
data/LICENSE ADDED
@@ -0,0 +1,165 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+
9
+ This version of the GNU Lesser General Public License incorporates
10
+ the terms and conditions of version 3 of the GNU General Public
11
+ License, supplemented by the additional permissions listed below.
12
+
13
+ 0. Additional Definitions.
14
+
15
+ As used herein, "this License" refers to version 3 of the GNU Lesser
16
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
+ General Public License.
18
+
19
+ "The Library" refers to a covered work governed by this License,
20
+ other than an Application or a Combined Work as defined below.
21
+
22
+ An "Application" is any work that makes use of an interface provided
23
+ by the Library, but which is not otherwise based on the Library.
24
+ Defining a subclass of a class defined by the Library is deemed a mode
25
+ of using an interface provided by the Library.
26
+
27
+ A "Combined Work" is a work produced by combining or linking an
28
+ Application with the Library. The particular version of the Library
29
+ with which the Combined Work was made is also called the "Linked
30
+ Version".
31
+
32
+ The "Minimal Corresponding Source" for a Combined Work means the
33
+ Corresponding Source for the Combined Work, excluding any source code
34
+ for portions of the Combined Work that, considered in isolation, are
35
+ based on the Application, and not on the Linked Version.
36
+
37
+ The "Corresponding Application Code" for a Combined Work means the
38
+ object code and/or source code for the Application, including any data
39
+ and utility programs needed for reproducing the Combined Work from the
40
+ Application, but excluding the System Libraries of the Combined Work.
41
+
42
+ 1. Exception to Section 3 of the GNU GPL.
43
+
44
+ You may convey a covered work under sections 3 and 4 of this License
45
+ without being bound by section 3 of the GNU GPL.
46
+
47
+ 2. Conveying Modified Versions.
48
+
49
+ If you modify a copy of the Library, and, in your modifications, a
50
+ facility refers to a function or data to be supplied by an Application
51
+ that uses the facility (other than as an argument passed when the
52
+ facility is invoked), then you may convey a copy of the modified
53
+ version:
54
+
55
+ a) under this License, provided that you make a good faith effort to
56
+ ensure that, in the event an Application does not supply the
57
+ function or data, the facility still operates, and performs
58
+ whatever part of its purpose remains meaningful, or
59
+
60
+ b) under the GNU GPL, with none of the additional permissions of
61
+ this License applicable to that copy.
62
+
63
+ 3. Object Code Incorporating Material from Library Header Files.
64
+
65
+ The object code form of an Application may incorporate material from
66
+ a header file that is part of the Library. You may convey such object
67
+ code under terms of your choice, provided that, if the incorporated
68
+ material is not limited to numerical parameters, data structure
69
+ layouts and accessors, or small macros, inline functions and templates
70
+ (ten or fewer lines in length), you do both of the following:
71
+
72
+ a) Give prominent notice with each copy of the object code that the
73
+ Library is used in it and that the Library and its use are
74
+ covered by this License.
75
+
76
+ b) Accompany the object code with a copy of the GNU GPL and this license
77
+ document.
78
+
79
+ 4. Combined Works.
80
+
81
+ You may convey a Combined Work under terms of your choice that,
82
+ taken together, effectively do not restrict modification of the
83
+ portions of the Library contained in the Combined Work and reverse
84
+ engineering for debugging such modifications, if you also do each of
85
+ the following:
86
+
87
+ a) Give prominent notice with each copy of the Combined Work that
88
+ the Library is used in it and that the Library and its use are
89
+ covered by this License.
90
+
91
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
+ document.
93
+
94
+ c) For a Combined Work that displays copyright notices during
95
+ execution, include the copyright notice for the Library among
96
+ these notices, as well as a reference directing the user to the
97
+ copies of the GNU GPL and this license document.
98
+
99
+ d) Do one of the following:
100
+
101
+ 0) Convey the Minimal Corresponding Source under the terms of this
102
+ License, and the Corresponding Application Code in a form
103
+ suitable for, and under terms that permit, the user to
104
+ recombine or relink the Application with a modified version of
105
+ the Linked Version to produce a modified Combined Work, in the
106
+ manner specified by section 6 of the GNU GPL for conveying
107
+ Corresponding Source.
108
+
109
+ 1) Use a suitable shared library mechanism for linking with the
110
+ Library. A suitable mechanism is one that (a) uses at run time
111
+ a copy of the Library already present on the user's computer
112
+ system, and (b) will operate properly with a modified version
113
+ of the Library that is interface-compatible with the Linked
114
+ Version.
115
+
116
+ e) Provide Installation Information, but only if you would otherwise
117
+ be required to provide such information under section 6 of the
118
+ GNU GPL, and only to the extent that such information is
119
+ necessary to install and execute a modified version of the
120
+ Combined Work produced by recombining or relinking the
121
+ Application with a modified version of the Linked Version. (If
122
+ you use option 4d0, the Installation Information must accompany
123
+ the Minimal Corresponding Source and Corresponding Application
124
+ Code. If you use option 4d1, you must provide the Installation
125
+ Information in the manner specified by section 6 of the GNU GPL
126
+ for conveying Corresponding Source.)
127
+
128
+ 5. Combined Libraries.
129
+
130
+ You may place library facilities that are a work based on the
131
+ Library side by side in a single library together with other library
132
+ facilities that are not Applications and are not covered by this
133
+ License, and convey such a combined library under terms of your
134
+ choice, if you do both of the following:
135
+
136
+ a) Accompany the combined library with a copy of the same work based
137
+ on the Library, uncombined with any other library facilities,
138
+ conveyed under the terms of this License.
139
+
140
+ b) Give prominent notice with the combined library that part of it
141
+ is a work based on the Library, and explaining where to find the
142
+ accompanying uncombined form of the same work.
143
+
144
+ 6. Revised Versions of the GNU Lesser General Public License.
145
+
146
+ The Free Software Foundation may publish revised and/or new versions
147
+ of the GNU Lesser General Public License from time to time. Such new
148
+ versions will be similar in spirit to the present version, but may
149
+ differ in detail to address new problems or concerns.
150
+
151
+ Each version is given a distinguishing version number. If the
152
+ Library as you received it specifies that a certain numbered version
153
+ of the GNU Lesser General Public License "or any later version"
154
+ applies to it, you have the option of following the terms and
155
+ conditions either of that published version or of any later version
156
+ published by the Free Software Foundation. If the Library as you
157
+ received it does not specify a version number of the GNU Lesser
158
+ General Public License, you may choose any version of the GNU Lesser
159
+ General Public License ever published by the Free Software Foundation.
160
+
161
+ If the Library as you received it specifies that a proxy can decide
162
+ whether future versions of the GNU Lesser General Public License shall
163
+ apply, that proxy's public statement of acceptance of any version is
164
+ permanent authorization for you to choose that version for the
165
+ Library.
data/README.md ADDED
@@ -0,0 +1,21 @@
1
+ All code in this package is provided under the LGPL-3 license.
2
+ Please read the file COPYING.
3
+
4
+ Tested for MRI > 2.7
5
+
6
+ # Installation
7
+
8
+ Clone. Install dependencies:
9
+
10
+ ```bash
11
+ gem install --user cpee cpee-worklist
12
+ ```
13
+
14
+ # Run
15
+
16
+ * Link the directory "ui" into your webserver.
17
+ * Goto server directory and run
18
+
19
+ ```bash
20
+ ./server -v restart
21
+ ```
data/Rakefile ADDED
@@ -0,0 +1,21 @@
1
+ require 'rake'
2
+ require 'rubygems/package_task'
3
+
4
+ spec = eval(File.read('cpee-worklist.gemspec'))
5
+ Gem::PackageTask.new(spec) do |pkg|
6
+ pkg.need_zip = true
7
+ pkg.need_tar = true
8
+ FileUtils.mkdir 'pkg' rescue nil
9
+ FileUtils.rm_rf Dir.glob('pkg/*')
10
+ FileUtils.ln_sf "#{pkg.name}.gem", "pkg/#{spec.name}.gem"
11
+ end
12
+
13
+ task :default => [:gem]
14
+
15
+ task :push => :gem do |r|
16
+ `gem push pkg/cpee-worklist.gem`
17
+ end
18
+
19
+ task :install => :gem do |r|
20
+ `gem install pkg/cpee-worklist.gem`
21
+ end
@@ -0,0 +1,27 @@
1
+ Gem::Specification.new do |s|
2
+ s.name = "cpee-worklist"
3
+ s.version = "1.0.0"
4
+ s.platform = Gem::Platform::RUBY
5
+ s.license = "LGPL-3.0-or-later"
6
+ s.summary = "Worklist for the cloud process execution engine (cpee.org)"
7
+
8
+ s.description = "see http://cpee.org"
9
+
10
+ s.files = Dir['{server/worklist,server/worklist.conf,lib/**/*}'] + %w(LICENSE Rakefile cpee-worklist.gemspec README.md AUTHORS)
11
+ s.require_path = 'lib'
12
+ s.extra_rdoc_files = ['README.md']
13
+ s.bindir = 'tools'
14
+ s.executables = ['cpee-worklist']
15
+
16
+ s.required_ruby_version = '>=2.4.0'
17
+
18
+ s.authors = ['Juergen eTM Mangler','Florian Stertz', 'Patrik Koenig']
19
+
20
+ s.email = 'juergen.mangler@gmail.com'
21
+ s.homepage = 'http://cpee.org/'
22
+
23
+ s.add_runtime_dependency 'riddl', '~> 1.0'
24
+ s.add_runtime_dependency 'json', '~> 2.1'
25
+ s.add_runtime_dependency 'cpee', '~> 2.1', '>= 2.1.56'
26
+ s.add_runtime_dependency 'chronic_duration', '~> 0.10', '>= 0.10.6'
27
+ end
@@ -0,0 +1,36 @@
1
+ # This file is part of CPEE-WORKLIST
2
+ #
3
+ # CPEE-WORKLIST is free software: you can redistribute it and/or modify it
4
+ # under the terms of the GNU Lesser General Public License as published by the
5
+ # Free Software Foundation, either version 3 of the License, or (at your
6
+ # option) any later version.
7
+ #
8
+ # CPEE-WORKLIST is distributed in the hope that it will be useful, but WITHOUT
9
+ # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10
+ # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11
+ # details.
12
+ #
13
+ # You should have received a copy of the GNU Lesser General Public License
14
+ # along with CPEE-WORKLIST (file LICENSE in the main directory). If not, see
15
+ # <http://www.gnu.org/licenses/>.
16
+
17
+ module CPEE
18
+ module Worklist
19
+ class Activities < Array
20
+ def initialize(opts)
21
+ super()
22
+ @opts = opts
23
+ end
24
+
25
+ def unserialize
26
+ self.clear.replace JSON.parse!(File.read(File.join(@opts[:top],'activities.sav'))) rescue []
27
+ end
28
+
29
+ def serialize
30
+ Thread.new do
31
+ File.write File.join(@opts[:top],'activities.sav'), JSON.pretty_generate(self)
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,160 @@
1
+ # This file is part of CPEE-WORKLIST
2
+ #
3
+ # CPEE-WORKLIST is free software: you can redistribute it and/or modify it
4
+ # under the terms of the GNU Lesser General Public License as published by the
5
+ # Free Software Foundation, either version 3 of the License, or (at your
6
+ # option) any later version.
7
+ #
8
+ # CPEE-WORKLIST is distributed in the hope that it will be useful, but WITHOUT
9
+ # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10
+ # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11
+ # details.
12
+ #
13
+ # You should have received a copy of the GNU Lesser General Public License
14
+ # along with CPEE-WORKLIST (file LICENSE in the main directory). If not, see
15
+ # <http://www.gnu.org/licenses/>.
16
+
17
+ require 'cpee/persistence'
18
+ CPEE::Persistence::obj = 'worklist'
19
+
20
+ module CPEE
21
+ module Worklist
22
+
23
+ class Controller
24
+ attr_reader :communication, :events, :notifications, :activities, :callback_keys, :votes, :opts, :orgmodels
25
+
26
+ def initialize(opts)
27
+ CPEE::redis_connect(opts,"Main")
28
+ @opts = opts
29
+
30
+ @redis = opts[:redis]
31
+ @votes = []
32
+
33
+ @activities = Activities.new(opts)
34
+ @activities.unserialize
35
+
36
+ CPEE::Persistence::new_static_object(CPEE::Persistence::obj,opts)
37
+
38
+ @orgmodels = []
39
+ Dir::glob(File.join(@opts[:top],'orgmodels','*')).each do |g|
40
+ add_orgmodel File.basename(g), File.read(g)
41
+ end
42
+
43
+ @callback_keys = {}
44
+ @psredis = @opts[:redis_dyn].call "Callback Response"
45
+
46
+ Thread.new do
47
+ @psredis.psubscribe('callback-response:*','callback-end:*') do |on|
48
+ on.pmessage do |pat, what, message|
49
+ if pat == 'callback-response:*' && @callback_keys.has_key?(what[18..-1])
50
+ index = message.index(' ')
51
+ mess = message[index+1..-1]
52
+ instance = message[0...index]
53
+ m = JSON.parse(mess)
54
+ resp = []
55
+ m['content']['values'].each do |e|
56
+ if e[1][0] == 'simple'
57
+ resp << Riddl::Parameter::Simple.new(e[0],e[1][1])
58
+ elsif e[1][0] == 'complex'
59
+ resp << Riddl::Parameter::Complex.new(e[0],e[1][1],File.open(e[1][2]))
60
+ end
61
+ end
62
+ @callback_keys[what[18..-1]].send(:callback,resp,m['content']['headers'])
63
+ end
64
+ if pat == 'callback-end:*'
65
+ @callback_keys.delete(what[13..-1])
66
+ end
67
+ end
68
+ end
69
+ end
70
+ end
71
+
72
+ def id
73
+ 'worklist'
74
+ end
75
+ def uuid
76
+ @id
77
+ end
78
+ def host
79
+ @opts[:host]
80
+ end
81
+ def base_url
82
+ File.join(@opts[:url],'/')
83
+ end
84
+ def instance_url
85
+ File.join(@opts[:url].to_s,'/')
86
+ end
87
+ def instance_id
88
+ @id
89
+ end
90
+ def base
91
+ base_url
92
+ end
93
+
94
+ def info
95
+ 'worklist'
96
+ end
97
+
98
+ def add_orgmodel(name,content) #{{{
99
+ FileUtils.mkdir_p(File.join(@opts[:top],'orgmodels'))
100
+ @orgmodels << name unless @orgmodels.include?(name)
101
+ File.write(File.join(@opts[:top],'orgmodels',name), content)
102
+ end #}}}
103
+
104
+ def notify(what,content={})
105
+ CPEE::Message::send(:event,what,base,info,uuid,info,content,@redis)
106
+ end
107
+
108
+ def vote(what,content={})
109
+ topic, name = what.split('/')
110
+ handler = File.join(topic,'vote',name)
111
+ votes = []
112
+ CPEE::Persistence::extract_handler(id,@opts,handler).each do |client|
113
+ voteid = Digest::MD5.hexdigest(Kernel::rand().to_s)
114
+ content[:key] = voteid
115
+ content[:subscription] = client
116
+ votes << voteid
117
+ CPEE::Message::send(:vote,what,base,info,uuid,info,content,@redis)
118
+ end
119
+
120
+ if votes.length > 0
121
+ @votes += votes
122
+ psredis = @opts[:redis_dyn].call "Vote"
123
+ collect = []
124
+ psredis.subscribe(votes.map{|e| ['vote-response:' + e.to_s] }.flatten) do |on|
125
+ on.message do |what, message|
126
+ index = message.index(' ')
127
+ mess = message[index+1..-1]
128
+ m = JSON.parse(mess)
129
+ collect << ((m['content'] == true || m['content'] == 'true') || false)
130
+ @votes.delete m['name']
131
+ cancel_callback m['name']
132
+ if collect.length >= votes.length
133
+ psredis.unsubscribe
134
+ end
135
+ end
136
+ end
137
+ !collect.include?(false)
138
+ else
139
+ true
140
+ end
141
+ end
142
+
143
+ def callback(hw,key,content)
144
+ CPEE::Message::send(:callback,'activity/content',base,info,uuid,info,content.merge(:key => key),@redis)
145
+ @callback_keys[key] = hw
146
+ end
147
+
148
+ def cancel_callback(key)
149
+ CPEE::Message::send(:'callback-end',key,base,info,uuid,info,{},@redis)
150
+ end
151
+
152
+ def add_activity(activity)
153
+ @activities << activity
154
+ @activities.serialize
155
+ end
156
+
157
+ end
158
+
159
+ end
160
+ end