Craig Tiller d6a5b803f4 Merge github.com:grpc/grpc into error 9 lat temu
..
bin e621f13ecd Simplified ruby interop test files 10 lat temu
ext d6a5b803f4 Merge github.com:grpc/grpc into error 9 lat temu
lib f624a796e7 Merge pull request #6537 from grpc/release-0_14 9 lat temu
pb ddaa69f15d Got Ruby stress client working, with some modifications to interop tests 10 lat temu
qps 8ecd4d7aa6 Add support for an "OTHER" value in client_type, server_type, and add a string to 10 lat temu
spec cf239e7309 Add a default handler to Ruby services that returns UNIMPLEMENTED 10 lat temu
stress ddaa69f15d Got Ruby stress client working, with some modifications to interop tests 10 lat temu
tools 38c6cfb82f Merge pull request #6536 from grpc/release-0_14 9 lat temu
.gitignore 097ef9b7d9 Incorporating ruby into the master grpc repository. 11 lat temu
.rubocop.yml 59dfee8800 Fixed rubocop issues with newest changes 10 lat temu
.rubocop_todo.yml aa57bab3ca Corrects the cancel_after_first_response behaviour 10 lat temu
CHANGELOG.md 51a4c0846b Corrects the Changelog date 11 lat temu
README.md d8521e75c8 Update Ruby README with simpler install instructions 10 lat temu

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}")