kpayson64 34967b7306 Merge pull request #7270 from kpayson64/ruby_ga_change 10 سال پیش
..
bin b39ad701ea Added comments to ruby code generation 10 سال پیش
ext b44b385ad2 Merge branch 'fix_cpp_deps' of https://github.com/dgquintas/grpc into bb_reader_error 10 سال پیش
lib b156671023 Change cancelled to cancelled? 10 سال پیش
pb b156671023 Change cancelled to cancelled? 10 سال پیش
qps 11ca9d8dc0 Merge pull request #6674 from murgatroid99/node_ruby_codegen_comments 10 سال پیش
spec b156671023 Change cancelled to cancelled? 10 سال پیش
stress ddaa69f15d Got Ruby stress client working, with some modifications to interop tests 10 سال پیش
tools d29a3bf004 Update master branch to 0.16.0-dev 10 سال پیش
.gitignore 097ef9b7d9 Incorporating ruby into the master grpc repository. 11 سال پیش
.rubocop.yml 59dfee8800 Fixed rubocop issues with newest changes 10 سال پیش
.rubocop_todo.yml aa57bab3ca Corrects the cancel_after_first_response behaviour 11 سال پیش
CHANGELOG.md 51a4c0846b Corrects the Changelog date 11 سال پیش
README.md d8521e75c8 Update Ruby README with simpler install instructions 10 سال پیش

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