zeebe-client 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7677117e7478a6b8bec4586778b6a670c19d10faee239d2d8cc84a4e426f1e4
-  data.tar.gz: 29b158f3095613e43d02445c8bd946248cd5710d2be522e3f31cf215b2a85732
+  metadata.gz: 70d1fee91e17ac504afb34fcf0212fe77038ac533202e20e9a68ee1c9eef401d
+  data.tar.gz: f984bc1dd46d561b0144cc69d28a17d0e7be4c379771fee23a39a18ebac58ace
 SHA512:
-  metadata.gz: b469d40411964ac108c99e39bfe64329a90ec21d52a0ed7dcd9b4b6a38af6b438fd331de5c982d945d01dd142b2c23c867c935eb6a47b41c00bcb387675185ed
-  data.tar.gz: 9ee2a75468a12d4ecadf7a1eb5a2a5f3c9c5b69e4b0e6dc7d977ab48b311344f7cc4d32d1a0794f78173ba1d26543489f3ce9582804792ec47355b0865be6249
+  metadata.gz: 0f06e5a0bdd25e33d980246e5cbb11b476b2536b2d63af169bae4847f637ec731261e9904a4cbf5ff66d06240b7d6f1a53c66185d8277609227d00c83bcc0d4d
+  data.tar.gz: f5a7889850feaaba06ec05ca8b179265a186ec9fb13c30a177e9fb2775c07aecb36265b6a6618ed4c04a5988784b9e148eeb33242e5fd28138b4ca59253661aa

data/.github/workflows/ci.yml

@@ -20,6 +20,7 @@ jobs:
         - '2.6'
         - '2.7'
         - '3.0'
+        - '3.1'
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby-version }}

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.17.0 (April 12th, 2022)
+
+- add support for [Zeebe 8.0.0](https://github.com/camunda/zeebe/releases/tag/8.0.0)
+
+## 0.16.3 (January 31st, 2022)
+
+- add support for [Zeebe 1.3.2](https://github.com/zeebe-io/zeebe/releases/tag/1.3.2)
+
+## 0.16.2 (January 11th, 2022)
+
+- support Ruby 3.1
+- add support for [Zeebe 1.3.0](https://github.com/zeebe-io/zeebe/releases/tag/1.3.0)
+
 ## 0.16.1 (January 4th, 2022)
 
 - add support for [Zeebe 1.2.9](https://github.com/zeebe-io/zeebe/releases/tag/1.2.9) which includes some Log4J CVE fixes

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

data/Rakefile

@@ -13,7 +13,7 @@ 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:1.2.9'
+  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:8.0.0'
   sleep(10)
 end
 

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

@@ -77,16 +77,50 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :key, :int64, 1
       repeated :processes, :message, 2, "gateway_protocol.ProcessMetadata"
     end
+    add_message "gateway_protocol.DeployResourceRequest" do
+      repeated :resources, :message, 1, "gateway_protocol.Resource"
+    end
+    add_message "gateway_protocol.Resource" do
+      optional :name, :string, 1
+      optional :content, :bytes, 2
+    end
+    add_message "gateway_protocol.DeployResourceResponse" do
+      optional :key, :int64, 1
+      repeated :deployments, :message, 2, "gateway_protocol.Deployment"
+    end
+    add_message "gateway_protocol.Deployment" do
+      oneof :Metadata do
+        optional :process, :message, 1, "gateway_protocol.ProcessMetadata"
+        optional :decision, :message, 2, "gateway_protocol.DecisionMetadata"
+        optional :decisionRequirements, :message, 3, "gateway_protocol.DecisionRequirementsMetadata"
+      end
+    end
     add_message "gateway_protocol.ProcessMetadata" do
       optional :bpmnProcessId, :string, 1
       optional :version, :int32, 2
       optional :processDefinitionKey, :int64, 3
       optional :resourceName, :string, 4
     end
+    add_message "gateway_protocol.DecisionMetadata" do
+      optional :dmnDecisionId, :string, 1
+      optional :dmnDecisionName, :string, 2
+      optional :version, :int32, 3
+      optional :decisionKey, :int64, 4
+      optional :dmnDecisionRequirementsId, :string, 5
+      optional :decisionRequirementsKey, :int64, 6
+    end
+    add_message "gateway_protocol.DecisionRequirementsMetadata" do
+      optional :dmnDecisionRequirementsId, :string, 1
+      optional :dmnDecisionRequirementsName, :string, 2
+      optional :version, :int32, 3
+      optional :decisionRequirementsKey, :int64, 4
+      optional :resourceName, :string, 5
+    end
     add_message "gateway_protocol.FailJobRequest" do
       optional :jobKey, :int64, 1
       optional :retries, :int32, 2
       optional :errorMessage, :string, 3
+      optional :retryBackOff, :int64, 4
     end
     add_message "gateway_protocol.FailJobResponse" do
     end
@@ -175,7 +209,13 @@ module Zeebe::Client::GatewayProtocol
   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
+  DeployResourceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployResourceRequest").msgclass
+  Resource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Resource").msgclass
+  DeployResourceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployResourceResponse").msgclass
+  Deployment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Deployment").msgclass
   ProcessMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ProcessMetadata").msgclass
+  DecisionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DecisionMetadata").msgclass
+  DecisionRequirementsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DecisionRequirementsMetadata").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

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

@@ -80,6 +80,17 @@ module Zeebe::Client::GatewayProtocol
       # - 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
       #
+      # Deploys one or more resources (e.g. processes or decision models) to Zeebe.
+      # Note that this is an atomic call, i.e. either all resources 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:
+      # - the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
+      # - the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
+      rpc :DeployResource, ::Zeebe::Client::GatewayProtocol::DeployResourceRequest, ::Zeebe::Client::GatewayProtocol::DeployResourceResponse
+      #
       # 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,
       # an incident will be raised, tagged with the given errorMessage, and the job will not be

data/lib/zeebe/client/version.rb

@@ -1,6 +1,6 @@
 
 module Zeebe
   module Client
-    VERSION = '0.16.1'.freeze
+    VERSION = '0.17.0'.freeze
   end
 end

data/proto/gateway.proto

@@ -142,11 +142,15 @@ message CreateProcessInstanceWithResultResponse {
 }
 
 message DeployProcessRequest {
+  // since 8, replaced by DeployResourceRequest
+  option deprecated = true;
   // List of process resources to deploy
   repeated ProcessRequestObject processes = 1;
 }
 
 message ProcessRequestObject {
+  // since 8, replaced by Resource
+  option deprecated = true;
   // the resource basename, e.g. myProcess.bpmn
   string name = 1;
   // the process definition as a UTF8-encoded string
@@ -154,12 +158,45 @@ message ProcessRequestObject {
 }
 
 message DeployProcessResponse {
+  // since 8, replaced by DeployResourceResponse
+  option deprecated = true;
   // the unique key identifying the deployment
   int64 key = 1;
   // a list of deployed processes
   repeated ProcessMetadata processes = 2;
 }
 
+message DeployResourceRequest {
+  // list of resources to deploy
+  repeated Resource resources = 1;
+}
+
+message Resource {
+  // the resource name, e.g. myProcess.bpmn or myDecision.dmn
+  string name = 1;
+  // the file content as a UTF8-encoded string
+  bytes content = 2;
+}
+
+message DeployResourceResponse {
+  // the unique key identifying the deployment
+  int64 key = 1;
+  // a list of deployed resources, e.g. processes
+  repeated Deployment deployments = 2;
+}
+
+message Deployment {
+  // each deployment has only one metadata
+  oneof Metadata {
+    // metadata of a deployed process
+    ProcessMetadata process = 1;
+    // metadata of a deployed decision
+    DecisionMetadata decision = 2;
+    // metadata of a deployed decision requirements
+    DecisionRequirementsMetadata decisionRequirements = 3;
+  }
+}
+
 message ProcessMetadata {
   // the bpmn process ID, as parsed during deployment; together with the version forms a
   // unique identifier for a specific process definition
@@ -173,6 +210,41 @@ message ProcessMetadata {
   string resourceName = 4;
 }
 
+message DecisionMetadata {
+  // the dmn decision ID, as parsed during deployment; together with the
+  // versions forms a unique identifier for a specific decision
+  string dmnDecisionId = 1;
+  // the dmn name of the decision, as parsed during deployment
+  string dmnDecisionName = 2;
+  // the assigned decision version
+  int32 version = 3;
+  // the assigned decision key, which acts as a unique identifier for this
+  // decision
+  int64 decisionKey = 4;
+  // the dmn ID of the decision requirements graph that this decision is part
+  // of, as parsed during deployment
+  string dmnDecisionRequirementsId = 5;
+  // the assigned key of the decision requirements graph that this decision is
+  // part of
+  int64 decisionRequirementsKey = 6;
+}
+
+message DecisionRequirementsMetadata {
+  // the dmn decision requirements ID, as parsed during deployment; together
+  // with the versions forms a unique identifier for a specific decision
+  string dmnDecisionRequirementsId = 1;
+  // the dmn name of the decision requirements, as parsed during deployment
+  string dmnDecisionRequirementsName = 2;
+  // the assigned decision requirements version
+  int32 version = 3;
+  // the assigned decision requirements key, which acts as a unique identifier
+  // for this decision requirements
+  int64 decisionRequirementsKey = 4;
+  // the resource name (see: Resource.name) from which this decision
+  // requirements was parsed
+  string resourceName = 5;
+}
+
 message FailJobRequest {
   // the unique job identifier, as obtained when activating the job
   int64 jobKey = 1;
@@ -182,6 +254,8 @@ message FailJobRequest {
   // this is particularly useful if a job runs out of retries and an incident is raised,
   // as it this message can help explain why an incident was raised
   string errorMessage = 3;
+  // the backoff timeout for the next retry
+  int64 retryBackOff = 4;
 }
 
 message FailJobResponse {
@@ -394,8 +468,25 @@ service Gateway {
           - the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
    */
   rpc DeployProcess (DeployProcessRequest) returns (DeployProcessResponse) {
+    // since 8, replaced by DeployResource
+    option deprecated = true;
+  }
+
+  /*
+    Deploys one or more resources (e.g. processes or decision models) to Zeebe.
+    Note that this is an atomic call, i.e. either all resources 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:
+          - the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
+          - the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
+  */
+  rpc DeployResource (DeployResourceRequest) returns (DeployResourceResponse) {
   }
 
+
   /*
     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,

data/zeebe-client.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'grpc-tools', '~> 1.32'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 1.24.1'
+  s.add_development_dependency 'rubocop', '~> 1.26.1'
   s.add_development_dependency 'rubocop-rake'
   s.add_development_dependency 'rubocop-rspec'
   s.add_development_dependency 'solargraph'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe-client
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Zeebe Client