grpc/src/ruby
Jun Mukai c0862859be ruby: Add test case for referring external package
The new spec uses existing EchoDuplicate service in
grpc.testing.duplicate, which refers grpc.testing.Empty,
and verifies if the plugin generates this correctly as
Grpc::Testing::Empty.
2016-04-07 13:13:30 -07:00
..
bin Merge pull request #4412 from murgatroid99/ruby_auth_metadata_plugin 2015-12-11 15:47:22 -08:00
ext/grpc Merge pull request #5528 from rafaelsales/raise-on-unexpected-metadata 2016-04-05 16:04:57 -07:00
lib Make ruby library conform to status code spec 2016-04-04 11:35:49 -07:00
pb ruby: Add test case for referring external package 2016-04-07 13:13:30 -07:00
qps Support many oustanding RPCs per channel - forgot to do this last time 2016-03-31 14:42:35 -07:00
spec ruby: Add test case for referring external package 2016-04-07 13:13:30 -07:00
.gitignore Incorporating ruby into the master grpc repository. 2014-12-01 17:45:43 -08:00
.rubocop.yml Ruby: fix some synchronization code in server implementation 2016-03-09 11:10:20 -08:00
.rubocop_todo.yml Corrects the cancel_after_first_response behaviour 2015-06-19 10:23:42 -07:00
CHANGELOG.md Corrects the Changelog date 2015-04-14 11:03:37 -07:00
README.md Update Ruby README with simpler install instructions 2016-01-15 10:12:28 -08:00

README.md

Gem gRPC Ruby

A Ruby implementation of gRPC.

Status

Beta

PREREQUISITES

  • Ruby 2.x. The gRPC API uses keyword args.

INSTALLATION

Linux and Mac OS X:

gem install grpc

BUILD FROM SOURCE

  • Clone this repository

  • 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/rvm as 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')
    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}")