Project

zeebe-client

0.01
A long-lived project that still receives updates
zeebe-clientzeebe-io/zeebe-client-rubyHomepageDocumentationSource CodeBug Tracker
Zeebe client containing a simple wrapper for the GRPC protocol used by Zeebe.io.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
66,559
Stars
6
Forks
4
Watchers
3
 Releases
Current version
0.20.0
Total releases
35
First release
2018-11-30
Latest release
2024-01-19
 Issues
Open Issues
1
Closed Issues
3
Total Issues
4
Issue Closure Rate
75%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
14
Merged Pull Requests
67
Pull Request Acceptance Rate
81%
 Development
Primary Language
Ruby
Licenses
Apache-2.0
Average date of last 50 commits
2022-02-05
Reverse Dependencies
4

 Dependencies

Development

bundler
>= 0
grpc-tools
~> 1.32
rake
>= 0
rspec
>= 0
solargraph
>= 0
rubocop-rake
>= 0
rubocop-rspec
>= 0
bundler-audit
~> 0.9.0
rubocop
~> 1.28.2

Runtime

grpc
~> 1.32
 Project Readme

Zeebe Ruby Client

Build Status

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.