API Client Generator for Ruby
Create Ruby clients from a protocol buffer description of an API.
Note This project is a preview. Please try it out and let us know what you think, but there are currently no guarantees of stability or support.
Usage
Install the Generator
This tool is in pre-alpha so it is not yet released to RubyGems.
$ git clone https://github.com/googleapis/gapic-generator-ruby.git
$ cd gapic-generator-ruby
$ git submodule update --init
$ cd gapic-generator
$ bundle install
$ bundle exec rake install
$ which protoc-gen-ruby_gapic
> {Non-empty path}
Generate an API
Installing this generator exposes protoc-gen-ruby_gapic
on the PATH. By doing
so, it gives the protobuf compiler the CLI option --ruby_gapic_out
on which
you can specify an output path for this generator.
If you want to experiment with an already-existing API, one example is available. First you should get the protos and dependencies:
$ git clone [email protected]:googleapis/api-common-protos.git
$ git clone [email protected]:googleapis/googleapis.git
Now you're ready to compile the API:
$ protoc google/cloud/vision/v1/*.proto \
--proto_path=api-common-protos/ \
--proto_path=googleapis/ \
--ruby_gapic_out=/dest/
Or, if you don't have protoc
installed, you can use grpc_tools_ruby_protoc
from the grpc-tools
gem:
$ gem install grpc-tools
$ grpc_tools_ruby_protoc google/cloud/vision/v1/*.proto \
--proto_path=api-common-protos/ \
--proto_path=googleapis/ \
--ruby_gapic_out=/dest/
Contributing
Contributions to this library are always welcome and highly encouraged.
See the CONTRIBUTING documentation for more information on how to get started.
Versioning
This library is currently a preview with no guarantees of stability or support. Please get involved and let us know if you find it useful and we'll work towards a stable version.
Disclaimer
This is not an official Google product.