zeebe-client 0.10.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af8339dff98c4a38105f27820ff9fd179d780f9d3badd18c9a238701993dbb79
-  data.tar.gz: 12ee0429e2bd32ed0968332224870a82896896d5eaaafeef608d4b62108f25db
+  metadata.gz: ca33deb0d1cfdb40a4814745cc0e61f44e477c21c41ee19da439d8515d5dcae5
+  data.tar.gz: d8058ade9bbdc00a55043c240473534d4829e8a2d7ffd10197a7c370b79ed897
 SHA512:
-  metadata.gz: 054b1cf77d293189584f30e13c879d471813419bd93936aa3fa6c6ad089f09ecda90791d0dd0d60953f4a0378f1c945fbe6a07ae5ba7e525f192bfc82742fd40
-  data.tar.gz: 04602b2aefd5f47b22cbdc9ff8f75e939640e071b39740be4069c945a4508b97fb349030519cb08346f317f3f3e8df0abde15b72d6608484dcb2559efbb6c6ef
+  metadata.gz: a8a2db2649ca643094e519123ca2ebaf5676806121af3a9c92333458f07bd2bfa14620888e831a67df6e08a6543655b3467dd2454d0c77d5abcbd3446f7f5ad9
+  data.tar.gz: 47dd8e5b2ce677168546c2e35efdaa84612d22ccbd79dfd8ceb0815a8ce82f5c0d45ae9c18ba4553b72d3e3d943c73339c4505840d0bf0b70fa3b100ba6421ab

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+---
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: '17:00'
+  open-pull-requests-limit: 99

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,28 @@
 # Changelog
 
+## 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
+- drop EOL Ruby 2.4 and older
+- add support for [Zeebe 0.24.1](https://github.com/zeebe-io/zeebe/releases/tag/0.24.1)
+
 ## 0.10.1 (April 24, 2020)
 
 - add support for [Zeebe 0.23.1](https://github.com/zeebe-io/zeebe/releases/tag/0.23.1)

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.23.1
+docker run -it --rm -p 26500:26500 camunda/zeebe:0.25.3
 ```
 
 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.23.1'
+  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:0.25.3'
   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

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.10.1'.freeze
+    VERSION = '0.12.1'.freeze
   end
 end

data/proto/gateway.proto

@@ -15,14 +15,14 @@ message ActivateJobsRequest {
   // the name of the worker activating the jobs, mostly used for logging purposes
   string worker = 2;
   // a job returned after this call will not be activated by another call until the
-  // timeout has been reached
+  // timeout (in ms) has been reached
   int64 timeout = 3;
   // the maximum jobs to activate by this request
   int32 maxJobsToActivate = 4;
   // a list of variables to fetch as the job variables; if empty, all visible variables at
   // the time of activation for the scope of the job will be returned
   repeated string fetchVariable = 5;
-  // The request will be completed when at least one job is activated or after the requestTimeout.
+  // The request will be completed when at least one job is activated or after the requestTimeout (in ms).
   // if the requestTimeout = 0, a default timeout is used.
   // if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
   int64 requestTimeout = 6;
@@ -115,7 +115,7 @@ message CreateWorkflowInstanceResponse {
 
 message CreateWorkflowInstanceWithResultRequest {
   CreateWorkflowInstanceRequest request = 1;
-  // timeout in milliseconds. the request will be closed if the workflow is not completed
+  // timeout (in ms). the request will be closed if the workflow is not completed
   // before the requestTimeout.
   // if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
   int64 requestTimeout = 2;
@@ -226,6 +226,8 @@ message PublishMessageRequest {
 }
 
 message PublishMessageResponse {
+  // the unique ID of the message that was published
+  int64 key = 1;
 }
 
 message ResolveIncidentRequest {
@@ -415,7 +417,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.
-   
+
     Errors:
       NOT_FOUND:
         - no job was found with the given key

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.27.0'
+  s.add_runtime_dependency 'grpc', '~> 1.32'
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'bundler-audit', '~> 0.6.0'
-  s.add_development_dependency 'grpc-tools', '~> 1.27.0'
+  s.add_development_dependency 'bundler-audit', '~> 0.7.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.10.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.27.0
+        version: '1.32'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.27.0
+        version: '1.32'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.27.0
+        version: '1.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.27.0
+        version: '1.32'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -129,10 +129,11 @@ executables: []
 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
@@ -168,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,20 +0,0 @@
----
-os: linux
-language: ruby
-rvm:
-- 2.7
-- 2.6
-- 2.5
-- 2.4
-- 2.3
-
-jobs:
-  fast_finish: true
-  allow_failures:
-  - rvm: 2.7
-
-services:
-- docker
-
-script:
-- bundle exec rake travis