zeebe-client 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 4f6667965dca1ac19a7bf939ac637a57d2f5c293aaca01ad35100bafbae959ca
4
+ data.tar.gz: 8594e7adced8d41a01e9b9fd8f0c731ed0cc6fa2c64339adbeac8aa0eb1b7132
5
+ SHA512:
6
+ metadata.gz: bbf5ef25ca7892d036502a5d471d0eadec5be2e8f364bbd38a9d0a2529cfc081b67a03f4f7c2c19a8af25c8c818ca555c548ae57247cae9c963f89ce8c53bc57
7
+ data.tar.gz: 8d3e56dcd5af3f6e29c598e95518f19c27e83787d8b587aaadc9f5fe4565c2902193aed0ab45999b5fa4ba9eafce8175f8a43015b1421ee463c69f451bc1fcb1
data/.gitignore ADDED
@@ -0,0 +1,3 @@
1
+ .DS_Store
2
+ *.lock
3
+ pkg/*
data/.rubocop.yml ADDED
@@ -0,0 +1,82 @@
1
+ inherit_from: .rubocop_todo.yml
2
+
3
+ AllCops:
4
+ TargetRubyVersion: '2.3'
5
+ Exclude:
6
+ - 'lib/zeebe/client/proto/*'
7
+
8
+ Gemspec/OrderedDependencies:
9
+ Enabled: false
10
+
11
+ Layout/AlignHash:
12
+ Enabled: false
13
+
14
+ Layout/EmptyLineAfterGuardClause:
15
+ Enabled: false
16
+
17
+ # allows nicer usage of private_class_method
18
+ Layout/EmptyLinesAroundArguments:
19
+ Enabled: false
20
+
21
+ Layout/LeadingBlankLines:
22
+ Enabled: false
23
+
24
+ Layout/SpaceInsideHashLiteralBraces:
25
+ Enabled: false
26
+
27
+ Metrics/AbcSize:
28
+ Enabled: false
29
+
30
+ Metrics/BlockLength:
31
+ Enabled: false
32
+
33
+ Metrics/ClassLength:
34
+ Enabled: false
35
+
36
+ Metrics/CyclomaticComplexity:
37
+ Enabled: false
38
+
39
+ Metrics/LineLength:
40
+ Max: 200
41
+
42
+ Metrics/MethodLength:
43
+ Enabled: false
44
+
45
+ Metrics/PerceivedComplexity:
46
+ Enabled: false
47
+
48
+ Naming/UncommunicativeMethodParamName:
49
+ Enabled: false
50
+
51
+ Naming/MemoizedInstanceVariableName:
52
+ Enabled: false
53
+
54
+ Style/ConditionalAssignment:
55
+ Enabled: false
56
+
57
+ Style/Documentation:
58
+ Enabled: false
59
+
60
+ Style/FormatStringToken:
61
+ Enabled: false
62
+
63
+ Style/FrozenStringLiteralComment:
64
+ Enabled: false
65
+
66
+ Style/GuardClause:
67
+ Enabled: false
68
+
69
+ Style/IdenticalConditionalBranches:
70
+ Enabled: false
71
+
72
+ Style/InverseMethods:
73
+ Enabled: false
74
+
75
+ Style/NegatedIf:
76
+ Enabled: false
77
+
78
+ Style/RescueModifier:
79
+ Enabled: false
80
+
81
+ Style/SymbolArray:
82
+ Enabled: false
data/.rubocop_todo.yml ADDED
File without changes
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ rvm:
5
+ - 2.5
6
+ - 2.4
7
+ - 2.3
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # Changelog
2
+
3
+ ## 0.0.1
4
+
5
+ NEW FEATURES:
6
+
7
+ - add support for Zeebe 0.13.1
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,187 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
data/README.md ADDED
@@ -0,0 +1,25 @@
1
+ # Zeebe Ruby Client
2
+
3
+ [![Build Status](https://travis-ci.org/cmur2/zb-ruby-client.svg?branch=master)](https://travis-ci.org/cmur2/zb-ruby-client)
4
+
5
+ [Zeebe](https://zeebe.io) client containing a simple wrapper for the GRPC protocol used by Zeebe.
6
+
7
+ ## General Usage
8
+
9
+ Install the gem:
10
+
11
+ gem install zeebe-client
12
+
13
+ Run a Zeebe instance locally:
14
+
15
+ ```sh
16
+ docker run -it --rm -p 26500:26500 camunda/zeebe:0.13.1
17
+ ```
18
+
19
+ And then try the available [demo script](examples/demo.rb).
20
+
21
+ See the [changelog](CHANGELOG.md) before upgrading.
22
+
23
+ ## Development
24
+
25
+ The `gen-grpc.sh` script can be used to generate Ruby code for the Zeebe proto.
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rubocop/rake_task'
3
+ require 'bundler/audit/task'
4
+
5
+ RuboCop::RakeTask.new
6
+ Bundler::Audit::Task.new
7
+
8
+ task default: [:rubocop, 'bundle:audit']
data/examples/demo.rb ADDED
@@ -0,0 +1,8 @@
1
+
2
+ require 'zeebe/client'
3
+
4
+ stub = Zeebe::Client::GatewayProtocol::Gateway::Stub.new('localhost:26500', :this_channel_is_insecure)
5
+
6
+ puts stub.topology(Zeebe::Client::GatewayProtocol::TopologyRequest.new).inspect
7
+
8
+ puts stub.list_workflows(Zeebe::Client::GatewayProtocol::ListWorkflowsRequest.new).inspect
data/gen-grpc.sh ADDED
@@ -0,0 +1,10 @@
1
+ #!/bin/bash
2
+
3
+ protoPath="proto"
4
+ genPath="lib/zeebe/client"
5
+
6
+ grpc_tools_ruby_protoc "${protoPath}/gateway.proto" --ruby_out="${genPath}" --grpc_out="${genPath}"
7
+
8
+ sed -i 's@proto/gateway_pb@zeebe/client/proto/gateway_pb@g' "${genPath}/proto/gateway_services_pb.rb"
9
+ sed -i 's@module GatewayProtocol@module Zeebe::Client::GatewayProtocol@g' "${genPath}/proto/gateway_pb.rb"
10
+ sed -i 's@module GatewayProtocol@module Zeebe::Client::GatewayProtocol@g' "${genPath}/proto/gateway_services_pb.rb"
@@ -0,0 +1,9 @@
1
+
2
+ require 'zeebe/client/proto/gateway_pb'
3
+ require 'zeebe/client/proto/gateway_services_pb'
4
+ require 'zeebe/client/version'
5
+
6
+ module Zeebe
7
+ module Client
8
+ end
9
+ end
@@ -0,0 +1,193 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: proto/gateway.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ Google::Protobuf::DescriptorPool.generated_pool.build do
7
+ add_message "gateway_protocol.TopologyRequest" do
8
+ end
9
+ add_message "gateway_protocol.Partition" do
10
+ optional :partitionId, :int32, 1
11
+ optional :role, :enum, 3, "gateway_protocol.Partition.PartitionBrokerRole"
12
+ end
13
+ add_enum "gateway_protocol.Partition.PartitionBrokerRole" do
14
+ value :LEADER, 0
15
+ value :FOLLOWER, 1
16
+ end
17
+ add_message "gateway_protocol.BrokerInfo" do
18
+ optional :nodeId, :int32, 1
19
+ optional :host, :string, 2
20
+ optional :port, :int32, 3
21
+ repeated :partitions, :message, 4, "gateway_protocol.Partition"
22
+ end
23
+ add_message "gateway_protocol.TopologyResponse" do
24
+ repeated :brokers, :message, 1, "gateway_protocol.BrokerInfo"
25
+ optional :clusterSize, :int32, 2
26
+ optional :partitionsCount, :int32, 3
27
+ optional :replicationFactor, :int32, 4
28
+ end
29
+ add_message "gateway_protocol.WorkflowRequestObject" do
30
+ optional :name, :string, 1
31
+ optional :type, :enum, 2, "gateway_protocol.WorkflowRequestObject.ResourceType"
32
+ optional :definition, :bytes, 3
33
+ end
34
+ add_enum "gateway_protocol.WorkflowRequestObject.ResourceType" do
35
+ value :FILE, 0
36
+ value :BPMN, 1
37
+ value :YAML, 2
38
+ end
39
+ add_message "gateway_protocol.DeployWorkflowRequest" do
40
+ repeated :workflows, :message, 1, "gateway_protocol.WorkflowRequestObject"
41
+ end
42
+ add_message "gateway_protocol.WorkflowMetadata" do
43
+ optional :bpmnProcessId, :string, 1
44
+ optional :version, :int32, 2
45
+ optional :workflowKey, :int64, 3
46
+ optional :resourceName, :string, 4
47
+ end
48
+ add_message "gateway_protocol.DeployWorkflowResponse" do
49
+ optional :key, :int64, 1
50
+ repeated :workflows, :message, 2, "gateway_protocol.WorkflowMetadata"
51
+ end
52
+ add_message "gateway_protocol.PublishMessageRequest" do
53
+ optional :name, :string, 1
54
+ optional :correlationKey, :string, 2
55
+ optional :timeToLive, :int64, 3
56
+ optional :messageId, :string, 4
57
+ optional :payload, :string, 5
58
+ end
59
+ add_message "gateway_protocol.PublishMessageResponse" do
60
+ end
61
+ add_message "gateway_protocol.CreateJobRequest" do
62
+ optional :jobType, :string, 1
63
+ optional :retries, :int32, 2
64
+ optional :customHeaders, :string, 3
65
+ optional :payload, :string, 4
66
+ end
67
+ add_message "gateway_protocol.CreateJobResponse" do
68
+ optional :key, :int64, 1
69
+ end
70
+ add_message "gateway_protocol.UpdateJobRetriesRequest" do
71
+ optional :jobKey, :int64, 1
72
+ optional :retries, :int32, 2
73
+ end
74
+ add_message "gateway_protocol.UpdateJobRetriesResponse" do
75
+ end
76
+ add_message "gateway_protocol.FailJobRequest" do
77
+ optional :jobKey, :int64, 1
78
+ optional :retries, :int32, 2
79
+ end
80
+ add_message "gateway_protocol.FailJobResponse" do
81
+ end
82
+ add_message "gateway_protocol.CompleteJobRequest" do
83
+ optional :jobKey, :int64, 1
84
+ optional :payload, :string, 2
85
+ end
86
+ add_message "gateway_protocol.CompleteJobResponse" do
87
+ end
88
+ add_message "gateway_protocol.CreateWorkflowInstanceRequest" do
89
+ optional :workflowKey, :int64, 1
90
+ optional :bpmnProcessId, :string, 2
91
+ optional :version, :int32, 3
92
+ optional :payload, :string, 4
93
+ end
94
+ add_message "gateway_protocol.CreateWorkflowInstanceResponse" do
95
+ optional :workflowKey, :int64, 1
96
+ optional :bpmnProcessId, :string, 2
97
+ optional :version, :int32, 3
98
+ optional :workflowInstanceKey, :int64, 5
99
+ end
100
+ add_message "gateway_protocol.CancelWorkflowInstanceRequest" do
101
+ optional :workflowInstanceKey, :int64, 1
102
+ end
103
+ add_message "gateway_protocol.CancelWorkflowInstanceResponse" do
104
+ end
105
+ add_message "gateway_protocol.UpdateWorkflowInstancePayloadRequest" do
106
+ optional :elementInstanceKey, :int64, 1
107
+ optional :payload, :string, 2
108
+ end
109
+ add_message "gateway_protocol.UpdateWorkflowInstancePayloadResponse" do
110
+ end
111
+ add_message "gateway_protocol.ListWorkflowsRequest" do
112
+ optional :bpmnProcessId, :string, 1
113
+ end
114
+ add_message "gateway_protocol.ListWorkflowsResponse" do
115
+ repeated :workflows, :message, 1, "gateway_protocol.WorkflowMetadata"
116
+ end
117
+ add_message "gateway_protocol.GetWorkflowRequest" do
118
+ optional :workflowKey, :int64, 1
119
+ optional :version, :int32, 2
120
+ optional :bpmnProcessId, :string, 3
121
+ end
122
+ add_message "gateway_protocol.GetWorkflowResponse" do
123
+ optional :workflowKey, :int64, 1
124
+ optional :version, :int32, 2
125
+ optional :bpmnProcessId, :string, 3
126
+ optional :resourceName, :string, 4
127
+ optional :bpmnXml, :string, 5
128
+ end
129
+ add_message "gateway_protocol.ActivateJobsRequest" do
130
+ optional :type, :string, 1
131
+ optional :worker, :string, 2
132
+ optional :timeout, :int64, 3
133
+ optional :amount, :int32, 4
134
+ end
135
+ add_message "gateway_protocol.JobHeaders" do
136
+ optional :workflowInstanceKey, :int64, 1
137
+ optional :bpmnProcessId, :string, 2
138
+ optional :workflowDefinitionVersion, :int32, 3
139
+ optional :workflowKey, :int64, 4
140
+ optional :elementId, :string, 5
141
+ optional :elementInstanceKey, :int64, 6
142
+ end
143
+ add_message "gateway_protocol.ActivatedJob" do
144
+ optional :key, :int64, 1
145
+ optional :type, :string, 2
146
+ optional :jobHeaders, :message, 3, "gateway_protocol.JobHeaders"
147
+ optional :customHeaders, :string, 4
148
+ optional :worker, :string, 5
149
+ optional :retries, :int32, 6
150
+ optional :deadline, :int64, 7
151
+ optional :payload, :string, 8
152
+ end
153
+ add_message "gateway_protocol.ActivateJobsResponse" do
154
+ repeated :jobs, :message, 1, "gateway_protocol.ActivatedJob"
155
+ end
156
+ end
157
+
158
+ module Zeebe::Client::GatewayProtocol
159
+ TopologyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.TopologyRequest").msgclass
160
+ Partition = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition").msgclass
161
+ Partition::PartitionBrokerRole = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition.PartitionBrokerRole").enummodule
162
+ BrokerInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.BrokerInfo").msgclass
163
+ TopologyResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.TopologyResponse").msgclass
164
+ WorkflowRequestObject = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowRequestObject").msgclass
165
+ WorkflowRequestObject::ResourceType = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowRequestObject.ResourceType").enummodule
166
+ DeployWorkflowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowRequest").msgclass
167
+ WorkflowMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowMetadata").msgclass
168
+ DeployWorkflowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowResponse").msgclass
169
+ PublishMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.PublishMessageRequest").msgclass
170
+ PublishMessageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.PublishMessageResponse").msgclass
171
+ CreateJobRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateJobRequest").msgclass
172
+ CreateJobResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateJobResponse").msgclass
173
+ UpdateJobRetriesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesRequest").msgclass
174
+ UpdateJobRetriesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
175
+ FailJobRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobRequest").msgclass
176
+ FailJobResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobResponse").msgclass
177
+ CompleteJobRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobRequest").msgclass
178
+ CompleteJobResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobResponse").msgclass
179
+ CreateWorkflowInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceRequest").msgclass
180
+ CreateWorkflowInstanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceResponse").msgclass
181
+ CancelWorkflowInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceRequest").msgclass
182
+ CancelWorkflowInstanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceResponse").msgclass
183
+ UpdateWorkflowInstancePayloadRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadRequest").msgclass
184
+ UpdateWorkflowInstancePayloadResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadResponse").msgclass
185
+ ListWorkflowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ListWorkflowsRequest").msgclass
186
+ ListWorkflowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ListWorkflowsResponse").msgclass
187
+ GetWorkflowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.GetWorkflowRequest").msgclass
188
+ GetWorkflowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.GetWorkflowResponse").msgclass
189
+ ActivateJobsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsRequest").msgclass
190
+ JobHeaders = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.JobHeaders").msgclass
191
+ ActivatedJob = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivatedJob").msgclass
192
+ ActivateJobsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsResponse").msgclass
193
+ end
@@ -0,0 +1,34 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: proto/gateway.proto for package 'gateway_protocol'
3
+
4
+ require 'grpc'
5
+ require 'zeebe/client/proto/gateway_pb'
6
+
7
+ module Zeebe::Client::GatewayProtocol
8
+ module Gateway
9
+ class Service
10
+
11
+ include GRPC::GenericService
12
+
13
+ self.marshal_class_method = :encode
14
+ self.unmarshal_class_method = :decode
15
+ self.service_name = 'gateway_protocol.Gateway'
16
+
17
+ rpc :Topology, TopologyRequest, TopologyResponse
18
+ rpc :DeployWorkflow, DeployWorkflowRequest, DeployWorkflowResponse
19
+ rpc :PublishMessage, PublishMessageRequest, PublishMessageResponse
20
+ rpc :CreateJob, CreateJobRequest, CreateJobResponse
21
+ rpc :UpdateJobRetries, UpdateJobRetriesRequest, UpdateJobRetriesResponse
22
+ rpc :FailJob, FailJobRequest, FailJobResponse
23
+ rpc :CompleteJob, CompleteJobRequest, CompleteJobResponse
24
+ rpc :CreateWorkflowInstance, CreateWorkflowInstanceRequest, CreateWorkflowInstanceResponse
25
+ rpc :CancelWorkflowInstance, CancelWorkflowInstanceRequest, CancelWorkflowInstanceResponse
26
+ rpc :UpdateWorkflowInstancePayload, UpdateWorkflowInstancePayloadRequest, UpdateWorkflowInstancePayloadResponse
27
+ rpc :ActivateJobs, ActivateJobsRequest, stream(ActivateJobsResponse)
28
+ rpc :ListWorkflows, ListWorkflowsRequest, ListWorkflowsResponse
29
+ rpc :GetWorkflow, GetWorkflowRequest, GetWorkflowResponse
30
+ end
31
+
32
+ Stub = Service.rpc_stub_class
33
+ end
34
+ end
@@ -0,0 +1,6 @@
1
+
2
+ module Zeebe
3
+ module Client
4
+ VERSION = '0.0.1'.freeze
5
+ end
6
+ end
@@ -0,0 +1,230 @@
1
+ syntax = 'proto3';
2
+ package gateway_protocol;
3
+
4
+ option java_multiple_files = false;
5
+ option java_package = "io.zeebe.gateway.protocol";
6
+ option go_package = "pb";
7
+
8
+ message TopologyRequest {
9
+ }
10
+
11
+ message Partition {
12
+ int32 partitionId = 1;
13
+ enum PartitionBrokerRole {
14
+ LEADER = 0;
15
+ FOLLOWER = 1;
16
+ }
17
+ PartitionBrokerRole role = 3;
18
+ }
19
+
20
+ message BrokerInfo {
21
+ int32 nodeId = 1;
22
+ string host = 2;
23
+ int32 port = 3;
24
+ repeated Partition partitions = 4;
25
+ }
26
+
27
+ message TopologyResponse {
28
+ repeated BrokerInfo brokers = 1;
29
+ int32 clusterSize = 2;
30
+ int32 partitionsCount = 3;
31
+ int32 replicationFactor = 4;
32
+ }
33
+
34
+ message WorkflowRequestObject {
35
+ string name = 1;
36
+ enum ResourceType {
37
+ // FILE type means the gateway will try to detect the resource type using the file extension of the name
38
+ FILE = 0;
39
+ BPMN = 1;
40
+ YAML = 2;
41
+ }
42
+ ResourceType type = 2;
43
+ bytes definition = 3;
44
+ }
45
+
46
+ message DeployWorkflowRequest {
47
+ repeated WorkflowRequestObject workflows = 1;
48
+ }
49
+
50
+ message WorkflowMetadata {
51
+ string bpmnProcessId = 1;
52
+ int32 version = 2;
53
+ int64 workflowKey = 3;
54
+ string resourceName = 4;
55
+ }
56
+
57
+ message DeployWorkflowResponse {
58
+ int64 key = 1;
59
+ repeated WorkflowMetadata workflows = 2;
60
+ }
61
+
62
+ message PublishMessageRequest {
63
+ string name = 1;
64
+ string correlationKey = 2;
65
+ int64 timeToLive = 3;
66
+ string messageId = 4;
67
+ /* payload has to be a valid json object as string */
68
+ string payload = 5;
69
+ }
70
+
71
+ message PublishMessageResponse {
72
+ }
73
+
74
+ message CreateJobRequest {
75
+ string jobType = 1;
76
+ int32 retries = 2;
77
+ /* custom headers has to be a valid json object as string */
78
+ string customHeaders = 3;
79
+ /* payload has to be a valid json object as string */
80
+ string payload = 4;
81
+ }
82
+
83
+ message CreateJobResponse {
84
+ int64 key = 1;
85
+ }
86
+
87
+ message UpdateJobRetriesRequest {
88
+ int64 jobKey = 1;
89
+ int32 retries = 2;
90
+ }
91
+
92
+ message UpdateJobRetriesResponse {
93
+ }
94
+
95
+ message FailJobRequest {
96
+ int64 jobKey = 1;
97
+ int32 retries = 2;
98
+ }
99
+
100
+ message FailJobResponse {
101
+ }
102
+
103
+ message CompleteJobRequest {
104
+ int64 jobKey = 1;
105
+ /* payload has to be a valid json object as string */
106
+ string payload = 2;
107
+ }
108
+
109
+ message CompleteJobResponse {
110
+ }
111
+
112
+ message CreateWorkflowInstanceRequest {
113
+ int64 workflowKey = 1;
114
+ string bpmnProcessId = 2;
115
+ /* if bpmnProcessId is set version = -1 indicates to use the latest version */
116
+ int32 version = 3;
117
+ /* payload has to be a valid json object as string */
118
+ string payload = 4;
119
+ }
120
+
121
+ message CreateWorkflowInstanceResponse {
122
+ int64 workflowKey = 1;
123
+ string bpmnProcessId = 2;
124
+ int32 version = 3;
125
+ int64 workflowInstanceKey = 5;
126
+ }
127
+
128
+ message CancelWorkflowInstanceRequest {
129
+ int64 workflowInstanceKey = 1;
130
+ }
131
+
132
+ message CancelWorkflowInstanceResponse {
133
+ }
134
+
135
+ message UpdateWorkflowInstancePayloadRequest {
136
+ int64 elementInstanceKey = 1;
137
+ /* payload has to be a valid json object as string */
138
+ string payload = 2;
139
+ }
140
+
141
+ message UpdateWorkflowInstancePayloadResponse {
142
+ }
143
+
144
+ message ListWorkflowsRequest {
145
+ /* optional filter by BPMN process id, if empty all workflows are returned */
146
+ string bpmnProcessId = 1;
147
+ }
148
+
149
+ message ListWorkflowsResponse {
150
+ repeated WorkflowMetadata workflows = 1;
151
+ }
152
+
153
+ /* either workflow key or bpmn process id and version has to be specified*/
154
+ message GetWorkflowRequest {
155
+ int64 workflowKey = 1;
156
+ /* if bpmnProcessId is set version = -1 indicates to use the latest version */
157
+ int32 version = 2;
158
+ string bpmnProcessId = 3;
159
+ }
160
+
161
+ message GetWorkflowResponse {
162
+ int64 workflowKey = 1;
163
+ int32 version = 2;
164
+ string bpmnProcessId = 3;
165
+ string resourceName = 4;
166
+ string bpmnXml = 5;
167
+ }
168
+
169
+ message ActivateJobsRequest {
170
+ string type = 1;
171
+ string worker = 2;
172
+ int64 timeout = 3;
173
+ int32 amount = 4;
174
+ }
175
+
176
+ message JobHeaders {
177
+ int64 workflowInstanceKey = 1;
178
+ string bpmnProcessId = 2;
179
+ int32 workflowDefinitionVersion = 3;
180
+ int64 workflowKey = 4;
181
+ string elementId = 5;
182
+ int64 elementInstanceKey = 6;
183
+ }
184
+
185
+ message ActivatedJob {
186
+ int64 key = 1;
187
+ string type = 2;
188
+ JobHeaders jobHeaders = 3;
189
+ // json object as string
190
+ string customHeaders = 4;
191
+ string worker = 5;
192
+ int32 retries = 6;
193
+ // epoch milliseconds
194
+ int64 deadline = 7;
195
+ /* json object as string */
196
+ string payload = 8;
197
+ }
198
+
199
+ message ActivateJobsResponse {
200
+ repeated ActivatedJob jobs = 1;
201
+ }
202
+
203
+ service Gateway {
204
+ rpc Topology (TopologyRequest) returns (TopologyResponse) {
205
+ }
206
+ rpc DeployWorkflow (DeployWorkflowRequest) returns (DeployWorkflowResponse) {
207
+ }
208
+ rpc PublishMessage (PublishMessageRequest) returns (PublishMessageResponse) {
209
+ }
210
+ rpc CreateJob (CreateJobRequest) returns (CreateJobResponse) {
211
+ }
212
+ rpc UpdateJobRetries (UpdateJobRetriesRequest) returns (UpdateJobRetriesResponse) {
213
+ }
214
+ rpc FailJob (FailJobRequest) returns (FailJobResponse) {
215
+ }
216
+ rpc CompleteJob (CompleteJobRequest) returns (CompleteJobResponse) {
217
+ }
218
+ rpc CreateWorkflowInstance (CreateWorkflowInstanceRequest) returns (CreateWorkflowInstanceResponse) {
219
+ }
220
+ rpc CancelWorkflowInstance (CancelWorkflowInstanceRequest) returns (CancelWorkflowInstanceResponse) {
221
+ }
222
+ rpc UpdateWorkflowInstancePayload (UpdateWorkflowInstancePayloadRequest) returns (UpdateWorkflowInstancePayloadResponse) {
223
+ }
224
+ rpc ActivateJobs (ActivateJobsRequest) returns (stream ActivateJobsResponse) {
225
+ }
226
+ rpc ListWorkflows (ListWorkflowsRequest) returns (ListWorkflowsResponse) {
227
+ }
228
+ rpc GetWorkflow (GetWorkflowRequest) returns (GetWorkflowResponse) {
229
+ }
230
+ }
@@ -0,0 +1,29 @@
1
+
2
+ $LOAD_PATH.push File.expand_path('lib', __dir__)
3
+
4
+ require 'zeebe/client/version'
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = 'zeebe-client'
8
+ s.version = Zeebe::Client::VERSION
9
+ s.summary = 'Zeebe Client'
10
+ s.description = 'Zeebe client containing a simple wrapper for the GRPC protocol used by Zeebe.io.'
11
+ s.author = 'Christian Nicolai'
12
+ s.email = 'chrnicolai@gmail.com'
13
+ s.homepage = 'https://github.com/cmur2/zb-ruby-client'
14
+ s.license = 'Apache-2.0'
15
+
16
+ s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
17
+ s.test_files = s.files.grep(%r{^(test|spec|features)/})
18
+ s.require_paths = ['lib']
19
+
20
+ s.required_ruby_version = '>= 2.3'
21
+
22
+ s.add_runtime_dependency 'grpc', '~> 1.16.0'
23
+
24
+ s.add_development_dependency 'grpc-tools', '~> 1.16.0'
25
+ s.add_development_dependency 'bundler'
26
+ s.add_development_dependency 'rake'
27
+ s.add_development_dependency 'rubocop', '~> 0.60.0'
28
+ s.add_development_dependency 'bundler-audit'
29
+ end
metadata ADDED
@@ -0,0 +1,145 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: zeebe-client
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Christian Nicolai
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-11-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: grpc
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 1.16.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 1.16.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: grpc-tools
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 1.16.0
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 1.16.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.60.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.60.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: bundler-audit
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description: Zeebe client containing a simple wrapper for the GRPC protocol used by
98
+ Zeebe.io.
99
+ email: chrnicolai@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rubocop.yml"
106
+ - ".rubocop_todo.yml"
107
+ - ".travis.yml"
108
+ - CHANGELOG.md
109
+ - Gemfile
110
+ - LICENSE
111
+ - README.md
112
+ - Rakefile
113
+ - examples/demo.rb
114
+ - gen-grpc.sh
115
+ - lib/zeebe/client.rb
116
+ - lib/zeebe/client/proto/gateway_pb.rb
117
+ - lib/zeebe/client/proto/gateway_services_pb.rb
118
+ - lib/zeebe/client/version.rb
119
+ - proto/gateway.proto
120
+ - zeebe-client.gemspec
121
+ homepage: https://github.com/cmur2/zb-ruby-client
122
+ licenses:
123
+ - Apache-2.0
124
+ metadata: {}
125
+ post_install_message:
126
+ rdoc_options: []
127
+ require_paths:
128
+ - lib
129
+ required_ruby_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - ">="
132
+ - !ruby/object:Gem::Version
133
+ version: '2.3'
134
+ required_rubygems_version: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ requirements: []
140
+ rubyforge_project:
141
+ rubygems_version: 2.7.7
142
+ signing_key:
143
+ specification_version: 4
144
+ summary: Zeebe Client
145
+ test_files: []