Zeebe Ruby Client

Zeebe client containing a simple wrapper for the GRPC protocol used by Zeebe.

General Usage

Install the gem:

gem install zeebe-client

Run a Zeebe instance locally:

docker run -it --rm -p 26500:26500 camunda/zeebe:8.4.0

And then try the available demo script.

See the changelog before upgrading.

Development

The gen-grpc.sh script can be used to generate Ruby code for the Zeebe proto.

To start Zeebe locally for running the integration tests use:

bundle exec rake zeebe:start
bundle exec rake spec
bundle exec rake zeebe:stop

To retrieve the latest GRPC proto from the Zeebe repository:

wget -O proto/gateway.proto https://raw.githubusercontent.com/camunda/zeebe/develop/gateway-protocol/src/main/proto/gateway.proto

Status

This is a community extension for Zeebe that will be maintained on a best effort basis.

License

zeebe-client-ruby is licensed under the Apache License, Version 2.0. See LICENSE for more information.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to code-of-conduct@zeebe.io.