zeebe-client 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c458c30ca89e870cabbead8c0672fdebe62969e28cdf031f64675240eddcb45
-  data.tar.gz: 8c51e32007c3a18bd5adc20d52c6b0d26ae6068866684dec7c809202a92f65e8
+  metadata.gz: 17e37e552793b6e9da2af0ed06224a10c5c85aeb065b123621f7abe422b5101d
+  data.tar.gz: 4a0212f29f5d09c31dea91b8796d4f4ae3bff42e6ccfd5dc32eca97530a2b1fb
 SHA512:
-  metadata.gz: 57cfbc109cc7624026c0a25b1ed7bd87281e6ee04d3f79b591a870715606d5c47c385eba2de63c9a8b6961cd75b1f0255cd622f3c634ff877f5626cd75638947
-  data.tar.gz: 43aa739e75b8bd6123503e464f376f46569fb414ccdc472c04403eb0d535ad102b62ac20075cd38a865861f733e70c2df6d1216a17ed4cb6fe95a4213abb0256
+  metadata.gz: 134b6b5d876ce16dfeae427bd24e2b2a4afb8af2a2cf4b368911e3ff37076708d7aa5da911df2b9d7c5a05a774299cba8e15e5eea10deaef9b6f8574701b533f
+  data.tar.gz: abddb8c2325a6e4e01aade80b47f61cc9250b10dc9bc1a2463af272cac87e6f3e21440d5fcf418dc4c27e4eeec4946c9c855edbdfc26340b1a2c59d7cb345ff4

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+---
+name: ci
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+  schedule:
+  - cron: '55 4 * * 4'  # weekly on thursday morning
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.5'
+        - '2.6'
+        - '2.7'
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: |
+        bundle
+    - name: Test
+      run: |
+        bundle exec rake ci

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.13.0 (February 3, 2021)
+
+- add support for [Zeebe 0.26.0](https://github.com/zeebe-io/zeebe/releases/tag/0.26.0)
+
+## 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)
+
+## 0.11.2 (November 5, 2020)
+
+- relax `grpc` dependency version constraint from `~> 1.32.0` to `~> 1.32` thus allowing usage of future versions that are compatible due to [semver](https://github.com/grpc/grpc/blob/master/doc/versioning.md), thanks @rusterholz
+
+## 0.11.1 (November 4, 2020)
+
+- add support for [Zeebe 0.24.3](https://github.com/zeebe-io/zeebe/releases/tag/0.24.3)
+
 ## 0.11.0 (July 29, 2020)
 
 - support Ruby 2.7

data/README.md

@@ -1,6 +1,6 @@
 # Zeebe Ruby Client
 
-[![Build Status](https://travis-ci.org/zeebe-io/zeebe-client-ruby.svg?branch=master)](https://travis-ci.org/zeebe-io/zeebe-client-ruby/)
+![Build Status](https://github.com/zeebe-io/zeebe-client-ruby/workflows/ci/badge.svg)
 
 [Zeebe](https://zeebe.io) client containing a simple wrapper for the GRPC protocol used by Zeebe.
 
@@ -13,7 +13,7 @@ Install the gem:
 Run a Zeebe instance locally:
 
 ```sh
-docker run -it --rm -p 26500:26500 camunda/zeebe:0.24.1
+docker run -it --rm -p 26500:26500 camunda/zeebe:0.26.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.24.1'
+  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:0.26.0'
   sleep(10)
 end
 

data/examples/demo.rb

@@ -13,8 +13,3 @@ puts "  Brokers:"
 topology.brokers.each do |b|
   puts "    - id: #{b.nodeId}, address: #{b.host}:#{b.port}, partitions: #{b.partitions.map { |p| p.partitionId }}"
 end
-
-workflows = zeebe_client.list_workflows(Zeebe::Client::GatewayProtocol::ListWorkflowsRequest.new).workflows
-
-puts ""
-puts "Zeebe workflows: #{workflows.inspect}"

data/gen-grpc.sh

@@ -6,5 +6,5 @@ genPath="lib/zeebe/client"
 grpc_tools_ruby_protoc "${protoPath}/gateway.proto" --ruby_out="${genPath}" --grpc_out="${genPath}"
 
 sed -i 's@proto/gateway_pb@zeebe/client/proto/gateway_pb@g' "${genPath}/proto/gateway_services_pb.rb"
-sed -i 's@module GatewayProtocol@module Zeebe::Client::GatewayProtocol@g' "${genPath}/proto/gateway_pb.rb"
-sed -i 's@module GatewayProtocol@module Zeebe::Client::GatewayProtocol@g' "${genPath}/proto/gateway_services_pb.rb"
+sed -i 's@GatewayProtocol@Zeebe::Client::GatewayProtocol@g' "${genPath}/proto/gateway_pb.rb"
+sed -i 's@GatewayProtocol@Zeebe::Client::GatewayProtocol@g' "${genPath}/proto/gateway_services_pb.rb"

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

@@ -111,6 +111,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :variables, :string, 5
     end
     add_message "gateway_protocol.PublishMessageResponse" do
+      optional :key, :int64, 1
     end
     add_message "gateway_protocol.ResolveIncidentRequest" do
       optional :incidentKey, :int64, 1
@@ -136,11 +137,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
     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
       optional :retries, :int32, 2
@@ -188,6 +194,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

@@ -24,14 +24,14 @@ module Zeebe::Client::GatewayProtocol
       # - worker is blank (empty string, null)
       # - timeout less than 1
       # - maxJobsToActivate is less than 1
-      rpc :ActivateJobs, ActivateJobsRequest, stream(ActivateJobsResponse)
+      rpc :ActivateJobs, ::Zeebe::Client::GatewayProtocol::ActivateJobsRequest, stream(::Zeebe::Client::GatewayProtocol::ActivateJobsResponse)
       #
       # Cancels a running workflow instance
       #
       # Errors:
       # NOT_FOUND:
       # - no workflow instance exists with the given key
-      rpc :CancelWorkflowInstance, CancelWorkflowInstanceRequest, CancelWorkflowInstanceResponse
+      rpc :CancelWorkflowInstance, ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceRequest, ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceResponse
       #
       # Completes a job with the given variables, which allows completing the associated service task.
       #
@@ -43,7 +43,7 @@ module Zeebe::Client::GatewayProtocol
       # FAILED_PRECONDITION:
       # - the job was marked as failed. In that case, the related incident must be resolved before
       # the job can be activated again and completed.
-      rpc :CompleteJob, CompleteJobRequest, CompleteJobResponse
+      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
       # create the instance can be specified either using its unique key (as returned by
@@ -64,10 +64,10 @@ module Zeebe::Client::GatewayProtocol
       # 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, CreateWorkflowInstanceResponse
+      rpc :CreateWorkflowInstance, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceRequest, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceResponse
       #
       # Behaves similarly to `rpc CreateWorkflowInstance`, except that a successful response is received when the workflow completes successfully.
-      rpc :CreateWorkflowInstanceWithResult, CreateWorkflowInstanceWithResultRequest, CreateWorkflowInstanceWithResultResponse
+      rpc :CreateWorkflowInstanceWithResult, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceWithResultRequest, ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceWithResultResponse
       #
       # 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.
@@ -79,7 +79,7 @@ module Zeebe::Client::GatewayProtocol
       # - 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, DeployWorkflowRequest, DeployWorkflowResponse
+      rpc :DeployWorkflow, ::Zeebe::Client::GatewayProtocol::DeployWorkflowRequest, ::Zeebe::Client::GatewayProtocol::DeployWorkflowResponse
       #
       # 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,
@@ -93,7 +93,7 @@ module Zeebe::Client::GatewayProtocol
       # FAILED_PRECONDITION:
       # - the job was not activated
       # - the job is already in a failed state, i.e. ran out of retries
-      rpc :FailJob, FailJobRequest, FailJobResponse
+      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.
       #
@@ -103,7 +103,7 @@ module Zeebe::Client::GatewayProtocol
       #
       # FAILED_PRECONDITION:
       # - the job is not in an activated state
-      rpc :ThrowError, ThrowErrorRequest, ThrowErrorResponse
+      rpc :ThrowError, ::Zeebe::Client::GatewayProtocol::ThrowErrorRequest, ::Zeebe::Client::GatewayProtocol::ThrowErrorResponse
       #
       # Publishes a single message. Messages are published to specific partitions computed from their
       # correlation keys.
@@ -111,7 +111,7 @@ module Zeebe::Client::GatewayProtocol
       # Errors:
       # ALREADY_EXISTS:
       # - a message with the same ID was previously published (and is still alive)
-      rpc :PublishMessage, PublishMessageRequest, PublishMessageResponse
+      rpc :PublishMessage, ::Zeebe::Client::GatewayProtocol::PublishMessageRequest, ::Zeebe::Client::GatewayProtocol::PublishMessageResponse
       #
       # Resolves a given incident. This simply marks the incident as resolved; most likely a call to
       # UpdateJobRetries or SetVariables will be necessary to actually resolve the
@@ -120,7 +120,7 @@ module Zeebe::Client::GatewayProtocol
       # Errors:
       # NOT_FOUND:
       # - no incident with the given key exists
-      rpc :ResolveIncident, ResolveIncidentRequest, ResolveIncidentResponse
+      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)
       # from the given JSON document.
@@ -131,10 +131,10 @@ module Zeebe::Client::GatewayProtocol
       # 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
+      rpc :SetVariables, ::Zeebe::Client::GatewayProtocol::SetVariablesRequest, ::Zeebe::Client::GatewayProtocol::SetVariablesResponse
       #
       # Obtains the current topology of the cluster the gateway is part of.
-      rpc :Topology, TopologyRequest, TopologyResponse
+      rpc :Topology, ::Zeebe::Client::GatewayProtocol::TopologyRequest, ::Zeebe::Client::GatewayProtocol::TopologyResponse
       #
       # Updates the number of retries a job has left. This is mostly useful for jobs that have run out of
       # retries, should the underlying problem be solved.
@@ -145,7 +145,7 @@ module Zeebe::Client::GatewayProtocol
       #
       # INVALID_ARGUMENT:
       # - retries is not greater than 0
-      rpc :UpdateJobRetries, UpdateJobRetriesRequest, UpdateJobRetriesResponse
+      rpc :UpdateJobRetries, ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesRequest, ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesResponse
     end
 
     Stub = Service.rpc_stub_class

data/lib/zeebe/client/version.rb

@@ -1,6 +1,6 @@
 
 module Zeebe
   module Client
-    VERSION = '0.11.0'.freeze
+    VERSION = '0.13.0'.freeze
   end
 end

data/proto/gateway.proto

@@ -226,6 +226,8 @@ message PublishMessageRequest {
 }
 
 message PublishMessageResponse {
+  // the unique ID of the message that was published
+  int64 key = 1;
 }
 
 message ResolveIncidentRequest {
@@ -272,10 +274,18 @@ message Partition {
     FOLLOWER = 1;
   }
 
+  // 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 {

data/zeebe-client.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3'
 
-  s.add_runtime_dependency 'grpc', '~> 1.28.0'
+  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 'grpc-tools', '~> 1.28.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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe-client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '1.32'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '1.32'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '1.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '1.32'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,10 +130,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".solargraph.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Zeebe Client

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