https://github.com/zeebe-io/zeebe-client-ruby

Zeebe client containing a simple wrapper for the gRPC protocol used by https://zeebe.io.
https://github.com/zeebe-io/zeebe-client-ruby

grpc-protocol ruby zeebe zeebe-client

Last synced: about 2 months ago
JSON representation

Zeebe client containing a simple wrapper for the gRPC protocol used by https://zeebe.io.

• Host: GitHub
• URL: https://github.com/zeebe-io/zeebe-client-ruby
• Owner: zeebe-io
• License: apache-2.0
• Created: 2018-11-30T12:36:50.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-19T13:47:27.000Z (11 months ago)
• Last Synced: 2024-09-26T08:14:12.058Z (3 months ago)
• Topics: grpc-protocol, ruby, zeebe, zeebe-client
• Language: Ruby
• Homepage:
• Size: 145 KB
• Stars: 7
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-camunda-platform-8 - Ruby

README

        
# Zeebe Ruby Client

![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.

## General Usage

Install the gem:

    gem install zeebe-client

Run a Zeebe instance locally:

```sh

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

```

And then try the available [demo script](examples/demo.rb).

See the [changelog](CHANGELOG.md) 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:

```sh

bundle exec rake zeebe:start

bundle exec rake spec

bundle exec rake zeebe:stop

```

To retrieve the latest GRPC proto from the Zeebe repository:

```sh

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](https://zeebe.io) 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](/CODE_OF_CONDUCT.md). By participating, you are expected to uphold

this code. Please report unacceptable behavior to [email protected].