Nicolas "Pixel" Noble 7a925f7f5e Flagging the release. před 10 roky
..
bin 7fe43260ac Merge pull request #4412 from murgatroid99/ruby_auth_metadata_plugin před 10 roky
ext 55e813f946 Merge pull request #5088 from murgatroid99/core_long_int64_t před 10 roky
lib 7a925f7f5e Flagging the release. před 10 roky
pb 69108a335e Resolved merge conflicts with upstream/release-0_12 před 10 roky
spec d212b33553 Re-add missing newline in ruby file před 10 roky
.gitignore 097ef9b7d9 Incorporating ruby into the master grpc repository. před 11 roky
.rubocop.yml aad1a34b4f Add newline to .rubocop.yml před 10 roky
.rubocop_todo.yml aa57bab3ca Corrects the cancel_after_first_response behaviour před 10 roky
CHANGELOG.md 51a4c0846b Corrects the Changelog date před 10 roky
README.md d8521e75c8 Update Ruby README with simpler install instructions před 10 roky

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