Ruby SDK for CloudEvents

CloudEvents Ruby SDK

A Ruby language implementation of the CloudEvents specification.

Features:

  • Ruby classes for representing CloudEvents, including support for standard and extension attributes.
  • Support for serializing and deserializing from JSON Structure Format and JSON Batch Format.
  • Support for sending and receiving CloudEvents via HTTP Bindings.
  • Supports the CloudEvent 0.3 and CloudEvents 1.0 specifications.
  • Extensible to additional formats and protocol bindings, and future specification versions.
  • Compatible with Ruby 2.5 or later, or JRuby 9.2.x or later. No runtime gem dependencies.

Quickstart

Install the cloud_events gem or add it to your bundle.

gem install cloud_events

Receiving a CloudEvent in a Sinatra app

A simple Sinatra app that receives CloudEvents:

# examples/server/Gemfile
source "https://rubygems.org"
gem "cloud_events", "~> 0.2"
gem "sinatra", "~> 2.0"

# examples/server/app.rb
require "sinatra"
require "cloud_events"

cloud_events_http = CloudEvents::HttpBinding.default

post "/" do
  event = cloud_events_http.decode_rack_env request.env
  logger.info "Received CloudEvent: #{event.to_h}"
end

Sending a CloudEvent

A simple Ruby script that sends a CloudEvent:

# examples/client/Gemfile
source "https://rubygems.org"
gem "cloud_events", "~> 0.2"

# examples/client/send.rb
require "cloud_events"
require "net/http"
require "uri"

data = { message: "Hello, CloudEvents!" }
event = CloudEvents::Event.create spec_version: "1.0",
                                  id:           "1234-1234-1234",
                                  source:       "/mycontext",
                                  type:         "com.example.someevent",
                                  data:         data

cloud_events_http = CloudEvents::HttpBinding.default
headers, body = cloud_events_http.encode_binary_content event
Net::HTTP.post URI("http://localhost:4567"), body, headers

Putting it together

Start the server on localhost:

cd server
bundle install
bundle exec ruby app.rb

This will run the server in the foreground and start logging to the console.

In a separate terminal shell, send it an event from the client:

cd client
bundle install
bundle exec ruby send.rb

The event should be logged in the server logs.

Hit CTRL+C to stop the server.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/sdk-ruby.

Development

After cloning the repo locally, install the bundle, and install the toys gem if you do not already have it.

bundle install
gem install toys

A variety of Toys scripts are provided for running tests and builds. For example:

# Run the unit tests
toys test

# Run CI locally, including unit tests, doc tests, and rubocop
toys ci

# Build and install the gem locally
toys install

# Clean temporary and build files
toys clean

# List all available scripts
toys

# Show online help for the "test" script
toys test --help

Code style

Ruby code in this library generally follows the Google Ruby Style Guide, which is based on "Seattle Style" Ruby.

Style is enforced by Rubocop rules. You can run rubocop directly using the rubocop binary:

bundle exec rubocop

or via Toys:

toys rubocop

That said, we are not style sticklers, and if a break is necessary for code readability or practicality, Rubocop rules can be selectively disabled.

Pull requests

We welcome contributions from the community! Please take some time to become acquainted with the process before submitting a pull request. There are just a few things to keep in mind.

  • Typically a pull request should relate to an existing issue. If you have found a bug, want to add an improvement, or suggest an API change, please create an issue before proceeding with a pull request. For very minor changes such as typos in the documentation this isn't necessary.
  • Use Conventional Commit messages. All commit messages should follow the Conventional Commits Specification to make it clear how your change should appear in release notes.
  • Sign your work. Each PR must be signed. Be sure your git user.name and user.email are configured then use the --signoff flag for your commits. e.g. git commit --signoff.
  • Make sure CI passes. Invoke toys ci to run the tests locally before opening a pull request. This will include code style checks.

Releasing

Releases can be performed only by users with write access to the repository.

To perform a release:

  1. Go to the GitHub Actions tab, and launch the "Request Release" workflow. You can leave the input field blank.

  2. The workflow will analyze the commit messages since the last release, and open a pull request with a new version and a changelog entry. You can optionally edit this pull request to modify the changelog or change the version released.

  3. Merge the pull request (keeping the release: pending label set.) Once the CI tests have run successfully, a job will run automatically to perform the release, including tagging the commit in git, building and releasing a gem, and building and pushing documentation.

These tasks can also be performed manually by running the appropriate scripts locally. See toys release request --help and toys release perform --help for more information.

If a release fails, you may need to delete the release tag before retrying.

For more information

Community

Each SDK may have its own unique processes, tooling and guidelines, common governance related material can be found in the CloudEvents community directory. In particular, in there you will find information concerning how SDK projects are managed, guidelines for how PR reviews and approval, and our Code of Conduct information.

Licensing

Copyright 2020 Google LLC and the CloudEvents Ruby SDK Contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.