https://github.com/googleapis/gapic-generator-ruby

Generate Ruby gRPC client libraries from Protocol Buffer definitions.
https://github.com/googleapis/gapic-generator-ruby

Keywords from Contributors

marshalling protobuf-runtime protoc protocol-buffers protocol-compiler activerecord activejob mvc rspec feature-flag

Last synced: about 11 hours ago
JSON representation

Repository metadata

Generate Ruby gRPC client libraries from Protocol Buffer definitions.

Host: GitHub
URL: https://github.com/googleapis/gapic-generator-ruby
Owner: googleapis
License: apache-2.0
Created: 2018-10-29T16:42:48.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2026-02-25T22:01:56.000Z (6 days ago)
Last Synced: 2026-02-28T00:57:05.978Z (3 days ago)
Language: Ruby
Homepage:
Size: 836 MB
Stars: 49
Watchers: 43
Forks: 33
Open Issues: 26
Releases: 37
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

API Client Generator for Ruby

Create Ruby clients from a protocol buffer description of an API.

Getting started

The easiest way to use this generator is to clone the github repo (either at
HEAD or at a release tag) and run the generator using the provided command line
tool. The following steps describe how do this.

Prepare your Ruby environment

The GAPIC Generator for Ruby is written in Ruby and requires the Ruby runtime
and several related tools.

First, install Ruby, version 3.1 or later, if you have not already done so.
This page on the
official Ruby website includes installation information. We recommend using a
Ruby version manager such as
ASDF.

You will need the Bundler and
Toys gems. Install them if you haven't done
so already:

$ gem install bundler
$ gem install toys

Clone the Ruby GAPIC Generator repo

The generator itself is present in the repo
https://github.com/googleapis/gapic-generator-ruby. Clone it to your local
workstation. The following steps will use it at HEAD, but you can also check
out a recent release tag.

$ git clone https://github.com/googleapis/gapic-generator-ruby.git
$ cd gapic-generator-ruby

There are submodules in this repo, so you will need to initialize those.

$ git submodule init
$ git submodule update

Generating the Showcase client

In this section we'll generate a client for the
Showcase API, a sample API used
for demoing and testing GAPIC.

(The following section will demonstrate how to generate a client for a Google
API from the Googleapis repo.)

Obtain Showcase protos

The GAPIC Generator uses protobuf files as input. We will obtain the protos for
Showcase from its repository on GitHub.

Clone the Showcase repo. For this example, we will assume we are starting
inside the gapic-generator-ruby clone directory (see above). We'll move up one
directory, clone the showcase repo and then move back into the
gapic-generator-ruby directory for subsequent steps.

$ cd ..
$ git clone https://github.com/googleapis/gapic-showcase.git
$ cd gapic-generator-ruby

Configure the client for the Echo service

Each client requires a configuration. The Ruby GAPIC Generator can get this
configuration from a YAML-formatted config file, or from the BUILD.bazel file
used to generate Google APIs. For Showcase, we have neither, so we'll write a
YAML file.

Create a file called showcase.yml and copy the following into it:

:transports: ["rest", "grpc"]
:gem:
  :name: google-showcase

Note that all the keys begin with a colon, which signals to Ruby that they
should be deserialized as Symbol keys rather than String keys.

Generate the Echo client

We can now run the generator, by using a Toys tool provided in the repo. This
run will generate a client of the "Echo" service, one of the services in the
Showcase API. It will read the source protos from the gapic-showcase clone,
and write the result into a tmp directory within the gapic-generator-ruby
clone. It will also get the configuration from the showcase.yml file you
created above.

Make sure you have moved into the gapic-generator-ruby directory, then run:

$ toys run --input-dir=../gapic-showcase/schema --output-dir=tmp \
  --config-file=showcase.yml google/showcase/v1beta1/echo.proto

Now you can see the results in the tmp directory.

$ cd tmp
$ ls

Generating a client for Google Cloud Language V2

In this section we'll generate a client for the Natural Language service that
is part of Google Cloud. This will be very similar to the above Showcase
example, but we will get the input protos and configuration from the googleapis
repository, which is brought into gapic-generator-ruby as a submodule.

Within the gapic-generator-ruby directory, run:

$ toys run --output-dir=tmp --clean google/cloud/language/v2

That's it! The generator's proto lookup defaults to searching the submodule
in shared/googleapis so you do not need to provide --input-dir. It also
finds its configuration in the BUILD.bazel file colocated with the protos.
The --clean flag clears out the old tmp directory (in case you previously
had generated the showcase client there.)

Contributing

The Ruby GAPIC Generator is maintained internally at Google by the Ruby Cloud
SDK team. The roadmap is generally driven by the needs of the Google API client
libraries for Ruby. However, contributions will be considered. Before opening
a pull request, please open an issue describing the change that you are
proposing; unless it is an obvious or trivial fix, it is best to discuss and
get agreement on the change before making it.

Testing

The CI runs on GitHub Actions and comprises four types of tests:

Unit tests for the various components
Comparative tests against golden outputs
Functional tests for some golden outputs
Lint and style checks using rubocop

To run the tests, execute this in the repo:

$ toys ci

Note that the functional tests require Docker because they involve spinning up
a temporary service for a generated client to talk to.

Updating golden outputs

If you make changes that result in changes to the generated client code, you
will need to regenerate the golden outputs to match. To do that, run the
following in the repo:

$ toys gen

Include both the generator and golden output changes in the same pull request.

Golden outputs are generated from input protos in the shared/googleapis
submodule. Their configurations are provided by YAML files in the
shared/config directory. Finally, there is an index of those outputs in the
shared/gem_defaults.rb file.

If any of these inputs are modified, or if the submodule is updated, you should
update the "binary inputs" in the shared/input directory. These are binary
encodings of that input and configuration data, used in some tests. To update
the binary inputs, execute:

$ toys bin

Disclaimer

While Google uses this product internally to produce API client libraries, this
generator itself is not an official Google product. You can use it to produce
your own clients for Google services or your own, but Google does not provide
official support for use of this generator.

Owner metadata

Name: Google APIs
Login: googleapis
Email:
Kind: organization
Description: Clients for Google APIs and tools that help produce them.
Website: https://googleapis.github.io
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/16785467?v=4
Repositories: 781
Last ynced at: 2023-04-09T04:55:29.167Z
Profile URL: https://github.com/googleapis

GitHub Events

Total

Release event: 2
Delete event: 40
Pull request event: 170
Fork event: 1
Issues event: 17
Watch event: 2
Issue comment event: 30
Push event: 100
Pull request review event: 119
Pull request review comment event: 33
Create event: 103

Last Year

Delete event: 34
Pull request event: 94
Issues event: 11
Watch event: 1
Issue comment event: 17
Push event: 53
Pull request review comment event: 15
Pull request review event: 68
Create event: 60

Committers metadata

Last synced: 2 days ago

Total Commits: 872
Total Committers: 34
Avg Commits per committer: 25.647
Development Distribution Score (DDS): 0.626

Commits in past year: 63
Committers in past year: 10
Avg Commits per committer in past year: 6.3
Development Distribution Score (DDS) in past year: 0.587

Name	Email	Commits
Daniel Azuma	d**a@g**m	326
Viacheslav Rostovtsev	5****v	175
Mike Moore	m**e@b**m	135
yoshi-code-bot	7****t	81
André Andreassa	a****a	30
Ernest Landrito	l**o@g**m	18
Chris Smith	q**o@g**m	16
Joe Bolinger	j**r@g**m	13
Mend Renovate	b**t@r**m	12
release-please[bot]	5****]	10
dependabot[bot]	4****]	7
Mira Leung	m****g	6
Jeff Ching	c**r@g**m	5
Diptanshu Mittal	4****l	4
Justin Beckwith	j**h@g**m	3
Aza Tulepbergenov	a**p@g**m	3
Graham Paye	p**e@g**m	3
Penelope Phippen	p**n@g**m	3
Tomo Suzuki	s**o@g**m	3
Noah Dietz	n****z	2
Yoshi Automation Bot	y**n@g**m	2
Alexander Fenster	f**r@g**m	2
Sam Phippen	s**n@g**m	2
piaxc	p**c@g**m	1
google-cloud-policy-bot[bot]	8****]	1
Vadym Matsishevskyi	2****e	1
Tram Bui	6****9	1
Shiv Gautam	8****m	1
Sandeep Tuniki	7****i	1
Sampath Kumar	s**m@g**m	1
and 4 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 4 days ago

Total issues: 43
Total pull requests: 551
Average time to close issues: 11 months
Average time to close pull requests: 20 days
Total issue authors: 14
Total pull request authors: 24
Average comments per issue: 0.77
Average comments per pull request: 0.37
Merged pull request: 392
Bot issues: 4
Bot pull requests: 65

Past year issues: 5
Past year pull requests: 143
Past year average time to close issues: 16 days
Past year average time to close pull requests: 7 days
Past year issue authors: 3
Past year pull request authors: 12
Past year average comments per issue: 0.2
Past year average comments per pull request: 0.22
Past year merged pull request: 94
Past year bot issues: 2
Past year bot pull requests: 4

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/googleapis/gapic-generator-ruby

Top Issue Authors

dazuma (18)
aandreassa (6)
viacheslav-rostovtsev (6)
repo-metadata-lint[bot] (3)
vchudnov-g (1)
failure-checker[bot] (1)
IlyaUmanets (1)
NivedhaSenthil (1)
shouichi (1)
qnm (1)
Abdullah-l (1)
dsisnero (1)
blowmage (1)
colinbendell (1)

Top Pull Request Authors

dazuma (140)
yoshi-code-bot (114)
viacheslav-rostovtsev (75)
aandreassa (61)
renovate-bot (52)
dependabot[bot] (50)
release-please[bot] (15)
chingor13 (8)
suztomo (5)
atulep (4)
landrito (3)
diptanshumittal (3)
google-admin (3)
alexander-fenster (2)
noahdietz (2)

Top Issue Labels

priority: p2 (24)
type: bug (19)
priority: p3 (10)
type: feature request (9)
type: process (7)
repo-metadata: lint (3)
priority: p1 (2)
type: cleanup (2)
type: question (2)
type: docs (1)
api: analyticsdata (1)

Top Pull Request Labels

kokoro:force-run (225)
dependencies (50)
autorelease: published (11)
cla: yes (11)
autorelease: pending (6)
do not merge (5)
autorelease: closed (3)
ruby (2)
samples (1)