kpayson64 f3f5c18e5a Merge pull request #7284 from ewr/FixRubyTimeConversion há 9 anos atrás
..
bin cdff92f02e added ruby client compression interop tests há 9 anos atrás
ext f3f5c18e5a Merge pull request #7284 from ewr/FixRubyTimeConversion há 9 anos atrás
lib 49bfb92dc1 Master is now 1.1.0-dev. há 9 anos atrás
pb 535b71dce4 changed compression request streaming enumerable to set write flag on every message há 9 anos atrás
qps cdff92f02e added ruby client compression interop tests há 9 anos atrás
spec 7c55ab090a removed unnecessary public methods removed tests of non api methods há 9 anos atrás
stress ddaa69f15d Got Ruby stress client working, with some modifications to interop tests há 9 anos atrás
tools 49bfb92dc1 Master is now 1.1.0-dev. há 9 anos atrás
.gitignore 097ef9b7d9 Incorporating ruby into the master grpc repository. há 11 anos atrás
.rubocop.yml 59dfee8800 Fixed rubocop issues with newest changes há 9 anos atrás
.rubocop_todo.yml aa57bab3ca Corrects the cancel_after_first_response behaviour há 10 anos atrás
CHANGELOG.md 51a4c0846b Corrects the Changelog date há 10 anos atrás
README.md d8521e75c8 Update Ruby README with simpler install instructions há 10 anos atrás

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