zeebe-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ff45546615505deac91e48ec781bf2e2d6d1ce14805aa2c741687effc38560
-  data.tar.gz: 2d06b409be95371bf28fe16bc620b5de9ffe85adc731d4169bd3bdc74bd9c432
+  metadata.gz: 6b925f865fd28f43106d22aca8965993a8b843337ba3ef2c9c006b44c7252b40
+  data.tar.gz: 9b09990f11584d292341cf1dbcda0832c8d74b235cab86435529fa03c6fc004b
 SHA512:
-  metadata.gz: 3e70ec2dd314f99110ea372df8c5418379c793f7fb02fdb3ab30bd233b84c05fe58bbf8a295d120715258c1044fb83bac282ac13e5ba29b44a53c3b267dc303b
-  data.tar.gz: 89318c917001d3b54a32b246d391dd23700ed68985837f2c118fe7cd1525cc1e4c74d219e2f7045b15e32829c0b953e5a1abe0c3f82caac3339541faef938839
+  metadata.gz: f08056b6caa95bb07ec34a7a8e57aa57346cdb48a7ba85688a8afdf36a3b40ae49dbca6ce53262f9cc108d9fe25b87596a32ce4b1ac1b247436f74fcf625a423
+  data.tar.gz: be1d46e21ca32a242050aaf4dc8cfa670c7c762b533a521dddfb12cc8bb29ffdf983906bdef98484bac4a1182368b5948577b6539b6a878c22c1dff45868d4a2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.0 (March 12, 2019)
+
+NEW FEATURES:
+
+- add support for [Zeebe 0.16.2](https://github.com/zeebe-io/zeebe/releases/tag/0.16.2)
+
 ## 0.3.0 (February 13, 2019)
 
 NEW FEATURES:

data/README.md

@@ -13,7 +13,7 @@ Install the gem:
 Run a Zeebe instance locally:
 
 ```sh
-docker run -it --rm -p 26500:26500 camunda/zeebe:0.15.0
+docker run -it --rm -p 26500:26500 camunda/zeebe:0.16.2
 ```
 
 And then try the available [demo script](examples/demo.rb).

data/Rakefile

@@ -13,7 +13,7 @@ task travis: ['zeebe:start', :default, 'zeebe:stop']
 
 desc 'Starts Zeebe Docker container'
 task 'zeebe:start' do
-  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:0.15.0'
+  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:0.16.2'
   sleep(5)
 end
 

data/lib/zeebe/client/proto/gateway_pb.rb

@@ -47,7 +47,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :workflowKey, :int64, 1
     optional :bpmnProcessId, :string, 2
     optional :version, :int32, 3
-    optional :payload, :string, 4
+    optional :variables, :string, 4
   end
   add_message "gateway_protocol.CreateWorkflowInstanceResponse" do
     optional :workflowKey, :int64, 1
@@ -145,11 +145,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "gateway_protocol.UpdateJobRetriesResponse" do
   end
-  add_message "gateway_protocol.UpdateWorkflowInstancePayloadRequest" do
+  add_message "gateway_protocol.SetVariablesRequest" do
     optional :elementInstanceKey, :int64, 1
-    optional :payload, :string, 2
+    optional :variables, :string, 2
+    optional :local, :bool, 3
   end
-  add_message "gateway_protocol.UpdateWorkflowInstancePayloadResponse" do
+  add_message "gateway_protocol.SetVariablesResponse" do
   end
 end
 
@@ -186,6 +187,6 @@ module Zeebe::Client::GatewayProtocol
   Partition::PartitionBrokerRole = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition.PartitionBrokerRole").enummodule
   UpdateJobRetriesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesRequest").msgclass
   UpdateJobRetriesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
-  UpdateWorkflowInstancePayloadRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadRequest").msgclass
-  UpdateWorkflowInstancePayloadResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadResponse").msgclass
+  SetVariablesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesRequest").msgclass
+  SetVariablesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesResponse").msgclass
 end

data/lib/zeebe/client/proto/gateway_services_pb.rb

@@ -62,8 +62,8 @@ module Zeebe::Client::GatewayProtocol
       # start event can be started manually.
       #
       # INVALID_ARGUMENT:
-      # - the given payload is not a valid JSON document; all payloads are expected to be
-      # valid JSON documents where the root node is an object.
+      # - the given variables argument is not a valid JSON document; it is expected to be a valid
+      # JSON document where the root node is an object.
       rpc :CreateWorkflowInstance, CreateWorkflowInstanceRequest, CreateWorkflowInstanceResponse
       #
       # Deploys one or more workflows to Zeebe. Note that this is an atomic call,
@@ -119,7 +119,7 @@ module Zeebe::Client::GatewayProtocol
       rpc :PublishMessage, PublishMessageRequest, PublishMessageResponse
       #
       # Resolves a given incident. This simply marks the incident as resolved; most likely a call to
-      # UpdateJobRetries or UpdateWorkflowInstancePayload will be necessary to actually resolve the
+      # UpdateJobRetries or SetVariables will be necessary to actually resolve the
       # problem, following by this call.
       #
       # Errors:
@@ -127,6 +127,17 @@ module Zeebe::Client::GatewayProtocol
       # - no incident with the given key exists
       rpc :ResolveIncident, ResolveIncidentRequest, ResolveIncidentResponse
       #
+      # Updates all the variables of a particular scope (e.g. workflow instance, flow element instance)
+      # from the given JSON document.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no element with the given elementInstanceKey exists
+      # INVALID_ARGUMENT:
+      # - the given variables document is not a valid JSON document; valid documents are expected to
+      # be JSON documents where the root node is an object.
+      rpc :SetVariables, SetVariablesRequest, SetVariablesResponse
+      #
       # Obtains the current topology of the cluster the gateway is part of.
       rpc :Topology, TopologyRequest, TopologyResponse
       #
@@ -140,16 +151,6 @@ module Zeebe::Client::GatewayProtocol
       # INVALID_ARGUMENT:
       # - retries is not greater than 0
       rpc :UpdateJobRetries, UpdateJobRetriesRequest, UpdateJobRetriesResponse
-      #
-      # Updates all the variables in the workflow instance scope from the given JSON document.
-      #
-      # Errors:
-      # NOT_FOUND:
-      # - no element with the given elementInstanceKey exists
-      # INVALID_ARGUMENT:
-      # - the given payload is not a valid JSON document; all payloads are expected to be
-      # valid JSON documents where the root node is an object.
-      rpc :UpdateWorkflowInstancePayload, UpdateWorkflowInstancePayloadRequest, UpdateWorkflowInstancePayloadResponse
     end
 
     Stub = Service.rpc_stub_class

data/lib/zeebe/client/version.rb

@@ -1,6 +1,6 @@
 
 module Zeebe
   module Client
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/proto/gateway.proto

@@ -97,8 +97,8 @@ message CreateWorkflowInstanceRequest {
   // workflow instance; it must be a JSON object, as variables will be mapped in a
   // key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
   // "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
-  // valid payload, as the root of the JSON document is an array and not an object.
-  string payload = 4;
+  // valid argument, as the root of the JSON document is an array and not an object.
+  string variables = 4;
 }
 
 message CreateWorkflowInstanceResponse {
@@ -216,8 +216,8 @@ message PublishMessageRequest {
   // the unique ID of the message; can be omitted. only useful to ensure only one message
   // with the given ID will ever be published (during its lifetime)
   string messageId = 4;
-  // the message payload as a JSON document; see CreateWorkflowInstanceRequest for the
-  // rules about payloads
+  // the message payload as a JSON document; to be valid, the root of the document must be an
+  // object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
   string payload = 5;
 }
 
@@ -279,17 +279,25 @@ message UpdateJobRetriesRequest {
 message UpdateJobRetriesResponse {
 }
 
-message UpdateWorkflowInstancePayloadRequest {
+message SetVariablesRequest {
   // the unique identifier of a particular element; can be the workflow instance key (as
   // obtained during instance creation), or a given element, such as a service task (see
   // elementInstanceKey on the JobHeaders message)
   int64 elementInstanceKey = 1;
-  // the new payload as a JSON document; see CreateWorkflowInstanceRequest for the rules
-  // about payloads
-  string payload = 2;
+  // a JSON serialized document describing variables as key value pairs; the root of the document
+  // must be an object
+  string variables = 2;
+  // if true, the variables will be merged strictly into the local scope (as indicated by
+  // elementInstanceKey); this means the variables is not propagated to upper scopes.
+  // for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
+  // 1 => `{ "foo" : 2 }`, and 2 => `{ "bar" : 1 }`. if we send an update request with
+  // elementInstanceKey = 2, variables `{ "foo" : 5 }`, and local is true, then scope 1 will
+  // be unchanged, and scope 2 will now be `{ "bar" : 1, "foo" 5 }`. if local was false, however,
+  // then scope 1 would be `{ "foo": 5 }`, and scope 2 would be `{ "bar" : 1 }`.
+  bool local = 3;
 }
 
-message UpdateWorkflowInstancePayloadResponse {
+message SetVariablesResponse {
 }
 
 service Gateway {
@@ -350,8 +358,8 @@ service Gateway {
           start event can be started manually.
 
       INVALID_ARGUMENT:
-        - the given payload is not a valid JSON document; all payloads are expected to be
-          valid JSON documents where the root node is an object.
+        - the given variables argument is not a valid JSON document; it is expected to be a valid
+          JSON document where the root node is an object.
    */
   rpc CreateWorkflowInstance (CreateWorkflowInstanceRequest) returns (CreateWorkflowInstanceResponse) {
   }
@@ -425,7 +433,7 @@ service Gateway {
 
   /*
     Resolves a given incident. This simply marks the incident as resolved; most likely a call to
-    UpdateJobRetries or UpdateWorkflowInstancePayload will be necessary to actually resolve the
+    UpdateJobRetries or SetVariables will be necessary to actually resolve the
     problem, following by this call.
 
     Errors:
@@ -435,6 +443,20 @@ service Gateway {
   rpc ResolveIncident (ResolveIncidentRequest) returns (ResolveIncidentResponse) {
   }
 
+  /*
+    Updates all the variables of a particular scope (e.g. workflow instance, flow element instance)
+    from the given JSON document.
+
+    Errors:
+      NOT_FOUND:
+        - no element with the given elementInstanceKey exists
+      INVALID_ARGUMENT:
+        - the given variables document is not a valid JSON document; valid documents are expected to
+          be JSON documents where the root node is an object.
+   */
+  rpc SetVariables (SetVariablesRequest) returns (SetVariablesResponse) {
+  }
+
   /*
     Obtains the current topology of the cluster the gateway is part of.
    */
@@ -454,17 +476,4 @@ service Gateway {
    */
   rpc UpdateJobRetries (UpdateJobRetriesRequest) returns (UpdateJobRetriesResponse) {
   }
-
-  /*
-    Updates all the variables in the workflow instance scope from the given JSON document.
-
-    Errors:
-      NOT_FOUND:
-        - no element with the given elementInstanceKey exists
-      INVALID_ARGUMENT:
-        - the given payload is not a valid JSON document; all payloads are expected to be
-          valid JSON documents where the root node is an object.
-   */
-  rpc UpdateWorkflowInstancePayload (UpdateWorkflowInstancePayloadRequest) returns (UpdateWorkflowInstancePayloadResponse) {
-  }
 }

data/zeebe-client.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3'
 
-  s.add_runtime_dependency 'grpc', '~> 1.18.0'
+  s.add_runtime_dependency 'grpc', '~> 1.19.0'
 
-  s.add_development_dependency 'grpc-tools', '~> 1.18.0'
+  s.add_development_dependency 'grpc-tools', '~> 1.19.0'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.64.0'
+  s.add_development_dependency 'rubocop', '~> 0.65.0'
   s.add_development_dependency 'bundler-audit'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement