/gax-ruby

Google API Extensions for Ruby

Primary LanguageRubyBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Google API Extensions for Ruby

Build Status Code Coverage Gem Version

Google API Extensions for Ruby (gax-ruby) is a set of modules which aids the development of APIs for clients and servers based on gRPC and Google API conventions.

Application code will rarely need to use most of the classes within this library directly, but code generated automatically from the API definition files in Google APIs can use services such as page streaming to provide a more convenient and idiomatic API surface to callers.

2.0 Under development

The master branch is currently under development for version 2.0, which will break backwards compatibility with the 1.x releases. A list of upcoming changes in 2.0 can be seen by viewing issues using the 2.0 tag.

To view the code for the 1.x releases, see the 1.x branch.

Documentation

Detailed documentation for gax-ruby can be seen on rubydoc.info.

Supported Ruby Versions

This library is supported on Ruby 2.3+.

Google provides official support for Ruby versions that are actively supported by Ruby Core—that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.3 and later. Older versions of Ruby may still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.

Contributing

Contributions to this library are always welcome and highly encouraged.

See the Contributing Guide for more information on how to get started.

Versioning

This library follows Semantic Versioning.

License

BSD - See LICENSE for more information.