01c87e24da
re2 previously failed to compile if: 1. An old `re2` version is installed with a non-standard system prefix, such as `/opt/local`. 2. The environment variable is set: `CPPFLAGS=-I/opt/local/include`. Running `make` would result in function prototype mismatches because the Makefile would previously attempt to use the headers from `/opt/local/include/re2` before the `third_party/re2/re2` directory. https://github.com/grpc/grpc/pull/27660 caused `CPPFLAGS` to inherit from the environment, but this can cause the Makefile to use external include files for re2 and other libraries if `-I` flags are defined. This commit reverts to the original behavior of only using `RbConfig::CONFIG` values to avoid using the wrong headers. |
||
|---|---|---|
| .. | ||
| bin | ||
| end2end | ||
| ext/grpc | ||
| lib | ||
| pb | ||
| qps | ||
| spec | ||
| stress | ||
| tools | ||
| .gitignore | ||
| .rubocop.yml | ||
| .rubocop_todo.yml | ||
| CHANGELOG.md | ||
| README.md | ||
README.md
gRPC Ruby
A Ruby implementation of gRPC.
PREREQUISITES
- Ruby 2.x. The gRPC API uses keyword args.
INSTALLATION
Linux and Mac OS X:
gem install grpc
If using a Gemfile and you wish to pull from a git repository or GitHub, make sure to tell bundler to retrieve submodules:
gem 'grpc', github: 'grpc/grpc', submodules: true
BUILD FROM SOURCE
-
Clone this repository
-
Init submodules
git submodule update --init
- Install Ruby 2.x. Consider doing this with RVM, it's a nice way of controlling the exact ruby version that's used.
$ command curl -sSL https://rvm.io/mpapis.asc | gpg --import -
$ \curl -sSL https://get.rvm.io | bash -s stable --ruby=ruby-2
$
$ # follow the instructions to ensure that your're using the latest stable version of Ruby
$ # and that the rvm command is installed
-
Make sure your run
source $HOME/.rvm/scripts/rvmas instructed to complete the set up of RVM -
Install bundler
$ gem install bundler
- Finally, build and install the gRPC gem locally.
$ # from this directory
$ bundle install # creates the ruby bundle, including building the grpc extension
$ rake # runs the unit tests, see rake -T for other options
DOCUMENTATION
- rubydoc for the gRPC gem is available online at rubydoc.
- the gRPC Ruby reference documentation is available online at grpc.io
CONTENTS
Directory structure is the layout for ruby extensions
-
ext: the gRPC ruby extension
-
lib: the entrypoint gRPC ruby library to be used in a 'require' statement
-
spec: Rspec unittests
-
bin: example gRPC clients and servers, e.g,
stub = Math::Math::Stub.new('my.test.math.server.com:8080', :this_channel_is_insecure) req = Math::DivArgs.new(dividend: 7, divisor: 3) GRPC.logger.info("div(7/3): req=#{req.inspect}") resp = stub.div(req) GRPC.logger.info("Answer: #{resp.inspect}")