zeebe-client 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2684eae82bcf65af9a582f3fda8d873dc92245807453d7ebd97e54d701b3916
-  data.tar.gz: 5a9b48e178605eb37b58f86df5935e893c88fc67fa2c1d1a0c778664bd9938d2
+  metadata.gz: 1dbf1b8be6bc6352e6d77a9a2b06f9e9f48d8eef1841c62081ebffd769cfbf64
+  data.tar.gz: a6ca9262c4295a8db23b11bbdb91c086dbf8928105d3f85470d66c76af1863c4
 SHA512:
-  metadata.gz: dff69d1eebacd0eef2e3ef6fb340a1818346a579634582463f5b376007adcced2ca7dacb4d53f0cada09809ef7d9debc5f0881d748e69d9f5195ba565f1dd3ad
-  data.tar.gz: b2c806020247b091075426dde62b12dccf943cb1f06f22ade5d86f25e4b7ba1c0df5851e9fc69a18fbcfc05778ba12e457820b0a86080901d7fe74a96e3ab664
+  metadata.gz: 52fc1ece0c404e4c1befd56ec0c99c0230856245bf0176e49aaba03b8bd2a1b97a80a5bd27823d9f6dcb273ed639ce17e7a43056aeaa3dffed8a8b2ca426259b
+  data.tar.gz: 4e333c196bae5df1454e35c4d1519e52b5293365d5b88d29a47811cbfc67ccc652eefedd3e0cad933979e9ba7c907a73b7096f034c75dda39d7a03ef3cfdfa93

data/.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+---
 name: ci
 
 on:
@@ -5,8 +6,9 @@ on:
     branches: [master]
   pull_request:
     branches: [master]
+  workflow_dispatch:
   schedule:
-  - cron: '7 4 * * 4'  # weekly on thursday morning
+  - cron: '55 4 * * 4'  # weekly on thursday morning
 
 jobs:
   build:
@@ -17,15 +19,14 @@ jobs:
         - '2.5'
         - '2.6'
         - '2.7'
+        - '3.0'
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-    - name: Install dependencies
-      run: |
-        bundle
+        bundler-cache: true  # runs 'bundle install' and caches installed gems automatically
     - name: Test
       run: |
-        bundle exec rake travis
+        bundle exec rake ci

data/.rubocop.yml

@@ -1,9 +1,13 @@
 ---
+inherit_mode:
+  merge:
+  - Exclude
+
 AllCops:
-  TargetRubyVersion: '2.3'
+  TargetRubyVersion: '2.5'
   Exclude:
-    - 'examples/*'
-    - 'lib/zeebe/client/proto/*'
+  - 'examples/*'
+  - 'lib/zeebe/client/proto/*'
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.14.0 (May 17, 2021)
+
+- add support for [Zeebe 1.0.0](https://github.com/zeebe-io/zeebe/releases/tag/1.0.0), thanks [@EugeneIstomin](https://github.com/zeebe-io/zeebe-client-ruby/pull/69)
+
+## 0.13.2 (March 30, 2021)
+
+- add support for [Zeebe 0.26.2](https://github.com/zeebe-io/zeebe/releases/tag/0.26.2)
+
+## 0.13.1 (February 26, 2021)
+
+- support Ruby 3.0
+- add support for [Zeebe 0.26.1](https://github.com/zeebe-io/zeebe/releases/tag/0.26.1)
+
+## 0.13.0 (February 3, 2021)
+
+- add support for [Zeebe 0.26.0](https://github.com/zeebe-io/zeebe/releases/tag/0.26.0), thanks [@rusterholz](https://github.com/zeebe-io/zeebe-client-ruby/pull/62)
+
+## 0.12.1 (December 11, 2020)
+
+- add support for [Zeebe 0.25.3](https://github.com/zeebe-io/zeebe/releases/tag/0.25.3)
+- drop Travis CI in favor of Github Actions
+
 ## 0.12.0 (November 9, 2020)
 
 - add support for [Zeebe 0.25.1](https://github.com/zeebe-io/zeebe/releases/tag/0.25.1)

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.25.1
+docker run -it --rm -p 26500:26500 camunda/zeebe:1.0.0
 ```
 
 And then try the available [demo script](examples/demo.rb).

data/Rakefile

@@ -9,11 +9,11 @@ Bundler::Audit::Task.new
 
 task default: [:rubocop, :spec, 'bundle:audit']
 
-task travis: ['zeebe:start', :default, 'zeebe:stop']
+task ci: ['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.25.1'
+  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:1.0.0'
   sleep(10)
 end
 

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

@@ -19,10 +19,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "gateway_protocol.ActivatedJob" do
       optional :key, :int64, 1
       optional :type, :string, 2
-      optional :workflowInstanceKey, :int64, 3
+      optional :processInstanceKey, :int64, 3
       optional :bpmnProcessId, :string, 4
-      optional :workflowDefinitionVersion, :int32, 5
-      optional :workflowKey, :int64, 6
+      optional :processDefinitionVersion, :int32, 5
+      optional :processDefinitionKey, :int64, 6
       optional :elementId, :string, 7
       optional :elementInstanceKey, :int64, 8
       optional :customHeaders, :string, 9
@@ -31,10 +31,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :deadline, :int64, 12
       optional :variables, :string, 13
     end
-    add_message "gateway_protocol.CancelWorkflowInstanceRequest" do
-      optional :workflowInstanceKey, :int64, 1
+    add_message "gateway_protocol.CancelProcessInstanceRequest" do
+      optional :processInstanceKey, :int64, 1
     end
-    add_message "gateway_protocol.CancelWorkflowInstanceResponse" do
+    add_message "gateway_protocol.CancelProcessInstanceResponse" do
     end
     add_message "gateway_protocol.CompleteJobRequest" do
       optional :jobKey, :int64, 1
@@ -42,51 +42,45 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "gateway_protocol.CompleteJobResponse" do
     end
-    add_message "gateway_protocol.CreateWorkflowInstanceRequest" do
-      optional :workflowKey, :int64, 1
+    add_message "gateway_protocol.CreateProcessInstanceRequest" do
+      optional :processDefinitionKey, :int64, 1
       optional :bpmnProcessId, :string, 2
       optional :version, :int32, 3
       optional :variables, :string, 4
     end
-    add_message "gateway_protocol.CreateWorkflowInstanceResponse" do
-      optional :workflowKey, :int64, 1
+    add_message "gateway_protocol.CreateProcessInstanceResponse" do
+      optional :processDefinitionKey, :int64, 1
       optional :bpmnProcessId, :string, 2
       optional :version, :int32, 3
-      optional :workflowInstanceKey, :int64, 4
+      optional :processInstanceKey, :int64, 4
     end
-    add_message "gateway_protocol.CreateWorkflowInstanceWithResultRequest" do
-      optional :request, :message, 1, "gateway_protocol.CreateWorkflowInstanceRequest"
+    add_message "gateway_protocol.CreateProcessInstanceWithResultRequest" do
+      optional :request, :message, 1, "gateway_protocol.CreateProcessInstanceRequest"
       optional :requestTimeout, :int64, 2
       repeated :fetchVariables, :string, 3
     end
-    add_message "gateway_protocol.CreateWorkflowInstanceWithResultResponse" do
-      optional :workflowKey, :int64, 1
+    add_message "gateway_protocol.CreateProcessInstanceWithResultResponse" do
+      optional :processDefinitionKey, :int64, 1
       optional :bpmnProcessId, :string, 2
       optional :version, :int32, 3
-      optional :workflowInstanceKey, :int64, 4
+      optional :processInstanceKey, :int64, 4
       optional :variables, :string, 5
     end
-    add_message "gateway_protocol.DeployWorkflowRequest" do
-      repeated :workflows, :message, 1, "gateway_protocol.WorkflowRequestObject"
+    add_message "gateway_protocol.DeployProcessRequest" do
+      repeated :processes, :message, 1, "gateway_protocol.ProcessRequestObject"
     end
-    add_message "gateway_protocol.WorkflowRequestObject" do
+    add_message "gateway_protocol.ProcessRequestObject" do
       optional :name, :string, 1
-      optional :type, :enum, 2, "gateway_protocol.WorkflowRequestObject.ResourceType"
-      optional :definition, :bytes, 3
+      optional :definition, :bytes, 2
     end
-    add_enum "gateway_protocol.WorkflowRequestObject.ResourceType" do
-      value :FILE, 0
-      value :BPMN, 1
-      value :YAML, 2
-    end
-    add_message "gateway_protocol.DeployWorkflowResponse" do
+    add_message "gateway_protocol.DeployProcessResponse" do
       optional :key, :int64, 1
-      repeated :workflows, :message, 2, "gateway_protocol.WorkflowMetadata"
+      repeated :processes, :message, 2, "gateway_protocol.ProcessMetadata"
     end
-    add_message "gateway_protocol.WorkflowMetadata" do
+    add_message "gateway_protocol.ProcessMetadata" do
       optional :bpmnProcessId, :string, 1
       optional :version, :int32, 2
-      optional :workflowKey, :int64, 3
+      optional :processDefinitionKey, :int64, 3
       optional :resourceName, :string, 4
     end
     add_message "gateway_protocol.FailJobRequest" do
@@ -137,10 +131,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "gateway_protocol.Partition" do
       optional :partitionId, :int32, 1
       optional :role, :enum, 2, "gateway_protocol.Partition.PartitionBrokerRole"
+      optional :health, :enum, 3, "gateway_protocol.Partition.PartitionBrokerHealth"
     end
     add_enum "gateway_protocol.Partition.PartitionBrokerRole" do
       value :LEADER, 0
       value :FOLLOWER, 1
+      value :INACTIVE, 2
+    end
+    add_enum "gateway_protocol.Partition.PartitionBrokerHealth" do
+      value :HEALTHY, 0
+      value :UNHEALTHY, 1
     end
     add_message "gateway_protocol.UpdateJobRetriesRequest" do
       optional :jobKey, :int64, 1
@@ -163,19 +163,18 @@ module Zeebe::Client::GatewayProtocol
   ActivateJobsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsRequest").msgclass
   ActivateJobsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsResponse").msgclass
   ActivatedJob = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivatedJob").msgclass
-  CancelWorkflowInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceRequest").msgclass
-  CancelWorkflowInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceResponse").msgclass
+  CancelProcessInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelProcessInstanceRequest").msgclass
+  CancelProcessInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelProcessInstanceResponse").msgclass
   CompleteJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobRequest").msgclass
   CompleteJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobResponse").msgclass
-  CreateWorkflowInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceRequest").msgclass
-  CreateWorkflowInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceResponse").msgclass
-  CreateWorkflowInstanceWithResultRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceWithResultRequest").msgclass
-  CreateWorkflowInstanceWithResultResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceWithResultResponse").msgclass
-  DeployWorkflowRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowRequest").msgclass
-  WorkflowRequestObject = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowRequestObject").msgclass
-  WorkflowRequestObject::ResourceType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowRequestObject.ResourceType").enummodule
-  DeployWorkflowResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowResponse").msgclass
-  WorkflowMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowMetadata").msgclass
+  CreateProcessInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceRequest").msgclass
+  CreateProcessInstanceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceResponse").msgclass
+  CreateProcessInstanceWithResultRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceWithResultRequest").msgclass
+  CreateProcessInstanceWithResultResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateProcessInstanceWithResultResponse").msgclass
+  DeployProcessRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployProcessRequest").msgclass
+  ProcessRequestObject = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessRequestObject").msgclass
+  DeployProcessResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployProcessResponse").msgclass
+  ProcessMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessMetadata").msgclass
   FailJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobRequest").msgclass
   FailJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobResponse").msgclass
   ThrowErrorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ThrowErrorRequest").msgclass
@@ -189,6 +188,7 @@ module Zeebe::Client::GatewayProtocol
   BrokerInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.BrokerInfo").msgclass
   Partition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition").msgclass
   Partition::PartitionBrokerRole = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition.PartitionBrokerRole").enummodule
+  Partition::PartitionBrokerHealth = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition.PartitionBrokerHealth").enummodule
   UpdateJobRetriesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesRequest").msgclass
   UpdateJobRetriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
   SetVariablesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.SetVariablesRequest").msgclass

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

@@ -8,7 +8,7 @@ module Zeebe::Client::GatewayProtocol
   module Gateway
     class Service
 
-      include GRPC::GenericService
+      include ::GRPC::GenericService
 
       self.marshal_class_method = :encode
       self.unmarshal_class_method = :decode
@@ -26,12 +26,12 @@ module Zeebe::Client::GatewayProtocol
       # - maxJobsToActivate is less than 1
       rpc :ActivateJobs, ::Zeebe::Client::GatewayProtocol::ActivateJobsRequest, stream(::Zeebe::Client::GatewayProtocol::ActivateJobsResponse)
       #
-      # Cancels a running workflow instance
+      # Cancels a running process instance
       #
       # Errors:
       # NOT_FOUND:
-      # - no workflow instance exists with the given key
-      rpc :CancelWorkflowInstance, ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceRequest, ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceResponse
+      # - no process instance exists with the given key
+      rpc :CancelProcessInstance, ::Zeebe::Client::GatewayProtocol::CancelProcessInstanceRequest, ::Zeebe::Client::GatewayProtocol::CancelProcessInstanceResponse
       #
       # Completes a job with the given variables, which allows completing the associated service task.
       #
@@ -45,41 +45,40 @@ module Zeebe::Client::GatewayProtocol
       # the job can be activated again and completed.
       rpc :CompleteJob, ::Zeebe::Client::GatewayProtocol::CompleteJobRequest, ::Zeebe::Client::GatewayProtocol::CompleteJobResponse
       #
-      # Creates and starts an instance of the specified workflow. The workflow definition to use to
+      # Creates and starts an instance of the specified process. The process definition to use to
       # create the instance can be specified either using its unique key (as returned by
-      # DeployWorkflow), or using the BPMN process ID and a version. Pass -1 as the version to use the
-      # latest deployed version. Note that only workflows with none start events can be started through
+      # DeployProcess), or using the BPMN process ID and a version. Pass -1 as the version to use the
+      # latest deployed version. Note that only processes with none start events can be started through
       # this command.
       #
       # Errors:
       # NOT_FOUND:
-      # - no workflow with the given key exists (if workflowKey was given)
-      # - no workflow with the given process ID exists (if bpmnProcessId was given but version was -1)
-      # - no workflow with the given process ID and version exists (if both bpmnProcessId and version were given)
+      # - no process with the given key exists (if processDefinitionKey was given)
+      # - no process with the given process ID exists (if bpmnProcessId was given but version was -1)
+      # - no process with the given process ID and version exists (if both bpmnProcessId and version were given)
       #
       # FAILED_PRECONDITION:
-      # - the workflow definition does not contain a none start event; only workflows with none
+      # - the process definition does not contain a none start event; only processes with none
       # start event can be started manually.
       #
       # INVALID_ARGUMENT:
       # - 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, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceRequest, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceResponse
+      rpc :CreateProcessInstance, ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceRequest, ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceResponse
       #
-      # Behaves similarly to `rpc CreateWorkflowInstance`, except that a successful response is received when the workflow completes successfully.
-      rpc :CreateWorkflowInstanceWithResult, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceWithResultRequest, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceWithResultResponse
+      # Behaves similarly to `rpc CreateProcessInstance`, except that a successful response is received when the process completes successfully.
+      rpc :CreateProcessInstanceWithResult, ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceWithResultRequest, ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceWithResultResponse
       #
-      # Deploys one or more workflows to Zeebe. Note that this is an atomic call,
-      # i.e. either all workflows are deployed, or none of them are.
+      # Deploys one or more processes to Zeebe. Note that this is an atomic call,
+      # i.e. either all processes are deployed, or none of them are.
       #
       # Errors:
       # INVALID_ARGUMENT:
       # - no resources given.
       # - if at least one resource is invalid. A resource is considered invalid if:
-      # - it is not a BPMN or YAML file (currently detected through the file extension)
       # - the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
-      # - the workflow is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
-      rpc :DeployWorkflow, ::Zeebe::Client::GatewayProtocol::DeployWorkflowRequest, ::Zeebe::Client::GatewayProtocol::DeployWorkflowResponse
+      # - the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
+      rpc :DeployProcess, ::Zeebe::Client::GatewayProtocol::DeployProcessRequest, ::Zeebe::Client::GatewayProtocol::DeployProcessResponse
       #
       # Marks the job as failed; if the retries argument is positive, then the job will be immediately
       # activatable again, and a worker could try again to process it. If it is zero or negative however,
@@ -95,7 +94,7 @@ module Zeebe::Client::GatewayProtocol
       # - the job is already in a failed state, i.e. ran out of retries
       rpc :FailJob, ::Zeebe::Client::GatewayProtocol::FailJobRequest, ::Zeebe::Client::GatewayProtocol::FailJobResponse
       #
-      # Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the workflow by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
+      # Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
       #
       # Errors:
       # NOT_FOUND:
@@ -122,7 +121,7 @@ module Zeebe::Client::GatewayProtocol
       # - no incident with the given key exists
       rpc :ResolveIncident, ::Zeebe::Client::GatewayProtocol::ResolveIncidentRequest, ::Zeebe::Client::GatewayProtocol::ResolveIncidentResponse
       #
-      # Updates all the variables of a particular scope (e.g. workflow instance, flow element instance)
+      # Updates all the variables of a particular scope (e.g. process instance, flow element instance)
       # from the given JSON document.
       #
       # Errors:

data/lib/zeebe/client/version.rb

@@ -1,6 +1,6 @@
 
 module Zeebe
   module Client
-    VERSION = '0.12.0'.freeze
+    VERSION = '0.14.0'.freeze
   end
 end

data/proto/gateway.proto

@@ -2,11 +2,11 @@ syntax = 'proto3';
 package gateway_protocol;
 
 option java_multiple_files = false;
-option java_package = "io.zeebe.gateway.protocol";
-option go_package = "pb";
+option java_package = "io.camunda.zeebe.gateway.protocol";
+option go_package = "./;pb";
 
 // For a more complete documentation, refer to Zeebe documentation at:
-// https://docs.zeebe.io/grpc/reference.html
+// https://docs.camunda.io/docs/reference/grpc
 
 message ActivateJobsRequest {
   // the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
@@ -38,18 +38,18 @@ message ActivatedJob {
   int64 key = 1;
   // the type of the job (should match what was requested)
   string type = 2;
-  // the job's workflow instance key
-  int64 workflowInstanceKey = 3;
-  // the bpmn process ID of the job workflow definition
+  // the job's process instance key
+  int64 processInstanceKey = 3;
+  // the bpmn process ID of the job process definition
   string bpmnProcessId = 4;
-  // the version of the job workflow definition
-  int32 workflowDefinitionVersion = 5;
-  // the key of the job workflow definition
-  int64 workflowKey = 6;
+  // the version of the job process definition
+  int32 processDefinitionVersion = 5;
+  // the key of the job process definition
+  int64 processDefinitionKey = 6;
   // the associated task element ID
   string elementId = 7;
   // the unique key identifying the associated task, unique within the scope of the
-  // workflow instance
+  // process instance
   int64 elementInstanceKey = 8;
   // a set of custom headers defined during modelling; returned as a serialized
   // JSON document
@@ -65,13 +65,13 @@ message ActivatedJob {
   string variables = 13;
 }
 
-message CancelWorkflowInstanceRequest {
-  // the workflow instance key (as, for example, obtained from
-  // CreateWorkflowInstanceResponse)
-  int64 workflowInstanceKey = 1;
+message CancelProcessInstanceRequest {
+  // the process instance key (as, for example, obtained from
+  // CreateProcessInstanceResponse)
+  int64 processInstanceKey = 1;
 }
 
-message CancelWorkflowInstanceResponse {
+message CancelProcessInstanceResponse {
 }
 
 message CompleteJobRequest {
@@ -84,102 +84,91 @@ message CompleteJobRequest {
 message CompleteJobResponse {
 }
 
-message CreateWorkflowInstanceRequest {
-  // the unique key identifying the workflow definition (e.g. returned from a workflow
-  // in the DeployWorkflowResponse message)
-  int64 workflowKey = 1;
-  // the BPMN process ID of the workflow definition
+message CreateProcessInstanceRequest {
+  // the unique key identifying the process definition (e.g. returned from a process
+  // in the DeployProcessResponse message)
+  int64 processDefinitionKey = 1;
+  // the BPMN process ID of the process definition
   string bpmnProcessId = 2;
   // the version of the process; set to -1 to use the latest version
   int32 version = 3;
   // JSON document that will instantiate the variables for the root variable scope of the
-  // workflow instance; it must be a JSON object, as variables will be mapped in a
+  // process 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 argument, as the root of the JSON document is an array and not an object.
   string variables = 4;
 }
 
-message CreateWorkflowInstanceResponse {
-  // the key of the workflow definition which was used to create the workflow instance
-  int64 workflowKey = 1;
-  // the BPMN process ID of the workflow definition which was used to create the workflow
+message CreateProcessInstanceResponse {
+  // the key of the process definition which was used to create the process instance
+  int64 processDefinitionKey = 1;
+  // the BPMN process ID of the process definition which was used to create the process
   // instance
   string bpmnProcessId = 2;
-  // the version of the workflow definition which was used to create the workflow instance
+  // the version of the process definition which was used to create the process instance
   int32 version = 3;
-  // the unique identifier of the created workflow instance; to be used wherever a request
-  // needs a workflow instance key (e.g. CancelWorkflowInstanceRequest)
-  int64 workflowInstanceKey = 4;
+  // the unique identifier of the created process instance; to be used wherever a request
+  // needs a process instance key (e.g. CancelProcessInstanceRequest)
+  int64 processInstanceKey = 4;
 }
 
-message CreateWorkflowInstanceWithResultRequest {
-  CreateWorkflowInstanceRequest request = 1;
-  // timeout (in ms). the request will be closed if the workflow is not completed
+message CreateProcessInstanceWithResultRequest {
+  CreateProcessInstanceRequest request = 1;
+  // timeout (in ms). the request will be closed if the process is not completed
   // before the requestTimeout.
   // if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
   int64 requestTimeout = 2;
-  // list of names of variables to be included in `CreateWorkflowInstanceWithResultResponse.variables`
+  // list of names of variables to be included in `CreateProcessInstanceWithResultResponse.variables`
   // if empty, all visible variables in the root scope will be returned.
   repeated string fetchVariables = 3;
 }
 
-message CreateWorkflowInstanceWithResultResponse {
-  // the key of the workflow definition which was used to create the workflow instance
-  int64 workflowKey = 1;
-  // the BPMN process ID of the workflow definition which was used to create the workflow
+message CreateProcessInstanceWithResultResponse {
+  // the key of the process definition which was used to create the process instance
+  int64 processDefinitionKey = 1;
+  // the BPMN process ID of the process definition which was used to create the process
   // instance
   string bpmnProcessId = 2;
-  // the version of the workflow definition which was used to create the workflow instance
+  // the version of the process definition which was used to create the process instance
   int32 version = 3;
-  // the unique identifier of the created workflow instance; to be used wherever a request
-  // needs a workflow instance key (e.g. CancelWorkflowInstanceRequest)
-  int64 workflowInstanceKey = 4;
+  // the unique identifier of the created process instance; to be used wherever a request
+  // needs a process instance key (e.g. CancelProcessInstanceRequest)
+  int64 processInstanceKey = 4;
   // JSON document
   // consists of visible variables in the root scope
   string variables = 5;
 
 }
 
-message DeployWorkflowRequest {
-  // List of workflow resources to deploy
-  repeated WorkflowRequestObject workflows = 1;
+message DeployProcessRequest {
+  // List of process resources to deploy
+  repeated ProcessRequestObject processes = 1;
 }
 
-message WorkflowRequestObject {
-  enum ResourceType {
-    // FILE type means the gateway will try to detect the resource type
-    // using the file extension of the name field
-    FILE = 0;
-    BPMN = 1; // extension 'bpmn'
-    YAML = 2; // extension 'yaml'
-  }
-
+message ProcessRequestObject {
   // the resource basename, e.g. myProcess.bpmn
   string name = 1;
-  // the resource type; if set to BPMN or YAML then the file extension
-  // is ignored
-  ResourceType type = 2;
   // the process definition as a UTF8-encoded string
-  bytes definition = 3;
+  bytes definition = 2;
 }
 
-message DeployWorkflowResponse {
+message DeployProcessResponse {
   // the unique key identifying the deployment
   int64 key = 1;
-  // a list of deployed workflows
-  repeated WorkflowMetadata workflows = 2;
+  // a list of deployed processes
+  repeated ProcessMetadata processes = 2;
 }
 
-message WorkflowMetadata {
+message ProcessMetadata {
   // the bpmn process ID, as parsed during deployment; together with the version forms a
-  // unique identifier for a specific workflow definition
+  // unique identifier for a specific process definition
   string bpmnProcessId = 1;
   // the assigned process version
   int32 version = 2;
-  // the assigned key, which acts as a unique identifier for this workflow
-  int64 workflowKey = 3;
-  // the resource name (see: WorkflowRequestObject.name) from which this workflow was
+  // the assigned key, which acts as a unique identifier for this process
+  int64 processDefinitionKey = 3;
+  // the resource name (see: ProcessRequestObject.name) from which this process was
   // parsed
   string resourceName = 4;
 }
@@ -272,12 +261,21 @@ message Partition {
   enum PartitionBrokerRole {
     LEADER = 0;
     FOLLOWER = 1;
+    INACTIVE = 2;
+  }
+
+  // Describes the current health of the partition
+  enum PartitionBrokerHealth {
+    HEALTHY = 0;
+    UNHEALTHY = 1;
   }
 
   // the unique ID of this partition
   int32 partitionId = 1;
   // the role of the broker for this partition
   PartitionBrokerRole role = 2;
+  // the health of this partition
+  PartitionBrokerHealth health = 3;
 }
 
 message UpdateJobRetriesRequest {
@@ -291,7 +289,7 @@ message UpdateJobRetriesResponse {
 }
 
 message SetVariablesRequest {
-  // the unique identifier of a particular element; can be the workflow instance key (as
+  // the unique identifier of a particular element; can be the process instance key (as
   // obtained during instance creation), or a given element, such as a service task (see
   // elementInstanceKey on the job message)
   int64 elementInstanceKey = 1;
@@ -329,13 +327,13 @@ service Gateway {
   }
 
   /*
-    Cancels a running workflow instance
+    Cancels a running process instance
 
     Errors:
       NOT_FOUND:
-        - no workflow instance exists with the given key
+        - no process instance exists with the given key
    */
-  rpc CancelWorkflowInstance (CancelWorkflowInstanceRequest) returns (CancelWorkflowInstanceResponse) {
+  rpc CancelProcessInstance (CancelProcessInstanceRequest) returns (CancelProcessInstanceResponse) {
   }
 
   /*
@@ -354,48 +352,47 @@ service Gateway {
   }
 
   /*
-    Creates and starts an instance of the specified workflow. The workflow definition to use to
+    Creates and starts an instance of the specified process. The process definition to use to
     create the instance can be specified either using its unique key (as returned by
-    DeployWorkflow), or using the BPMN process ID and a version. Pass -1 as the version to use the
-    latest deployed version. Note that only workflows with none start events can be started through
+    DeployProcess), or using the BPMN process ID and a version. Pass -1 as the version to use the
+    latest deployed version. Note that only processes with none start events can be started through
     this command.
 
     Errors:
       NOT_FOUND:
-        - no workflow with the given key exists (if workflowKey was given)
-        - no workflow with the given process ID exists (if bpmnProcessId was given but version was -1)
-        - no workflow with the given process ID and version exists (if both bpmnProcessId and version were given)
+        - no process with the given key exists (if processDefinitionKey was given)
+        - no process with the given process ID exists (if bpmnProcessId was given but version was -1)
+        - no process with the given process ID and version exists (if both bpmnProcessId and version were given)
 
       FAILED_PRECONDITION:
-        - the workflow definition does not contain a none start event; only workflows with none
+        - the process definition does not contain a none start event; only processes with none
           start event can be started manually.
 
       INVALID_ARGUMENT:
         - 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) {
+  rpc CreateProcessInstance (CreateProcessInstanceRequest) returns (CreateProcessInstanceResponse) {
   }
 
   /*
-    Behaves similarly to `rpc CreateWorkflowInstance`, except that a successful response is received when the workflow completes successfully.
+    Behaves similarly to `rpc CreateProcessInstance`, except that a successful response is received when the process completes successfully.
   */
-  rpc CreateWorkflowInstanceWithResult (CreateWorkflowInstanceWithResultRequest) returns (CreateWorkflowInstanceWithResultResponse) {
+  rpc CreateProcessInstanceWithResult (CreateProcessInstanceWithResultRequest) returns (CreateProcessInstanceWithResultResponse) {
   }
 
   /*
-    Deploys one or more workflows to Zeebe. Note that this is an atomic call,
-    i.e. either all workflows are deployed, or none of them are.
+    Deploys one or more processes to Zeebe. Note that this is an atomic call,
+    i.e. either all processes are deployed, or none of them are.
 
     Errors:
       INVALID_ARGUMENT:
         - no resources given.
         - if at least one resource is invalid. A resource is considered invalid if:
-          - it is not a BPMN or YAML file (currently detected through the file extension)
           - the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
-          - the workflow is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
+          - the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
    */
-  rpc DeployWorkflow (DeployWorkflowRequest) returns (DeployWorkflowResponse) {
+  rpc DeployProcess (DeployProcessRequest) returns (DeployProcessResponse) {
   }
 
   /*
@@ -416,7 +413,7 @@ service Gateway {
   }
 
   /*
-    Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the workflow by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
+    Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
 
     Errors:
       NOT_FOUND:
@@ -452,7 +449,7 @@ service Gateway {
   }
 
   /*
-    Updates all the variables of a particular scope (e.g. workflow instance, flow element instance)
+    Updates all the variables of a particular scope (e.g. process instance, flow element instance)
     from the given JSON document.
 
     Errors:

data/zeebe-client.gemspec

@@ -17,15 +17,15 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '>= 2.5'
 
   s.add_runtime_dependency 'grpc', '~> 1.32'
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'bundler-audit', '~> 0.7.0'
+  s.add_development_dependency 'bundler-audit', '~> 0.8.0'
   s.add_development_dependency 'grpc-tools', '~> 1.32'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.81.0'
+  s.add_development_dependency 'rubocop', '~> 1.13.0'
   s.add_development_dependency 'solargraph'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe-client
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,6 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".solargraph.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -163,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,16 +0,0 @@
----
-os: linux
-language: ruby
-rvm:
-- 2.7
-- 2.6
-- 2.5
-
-jobs:
-  fast_finish: true
-
-services:
-- docker
-
-script:
-- bundle exec rake travis