murgatroid99 d10c0abaf6 Merge branch 'master' of github.com:google/grpc into merge_new_invoke_api 11 years ago
..
bin d428c54681 removed a reference to a google3 dir 11 years ago
ext d10c0abaf6 Merge branch 'master' of github.com:google/grpc into merge_new_invoke_api 11 years ago
lib d10c0abaf6 Merge branch 'master' of github.com:google/grpc into merge_new_invoke_api 11 years ago
spec d10c0abaf6 Merge branch 'master' of github.com:google/grpc into merge_new_invoke_api 11 years ago
.gitignore 097ef9b7d9 Incorporating ruby into the master grpc repository. 11 years ago
.rspec 097ef9b7d9 Incorporating ruby into the master grpc repository. 11 years ago
.rubocop.yml e2860c5bdb Adds rubocop and fixes most style violations it detected 11 years ago
.rubocop_todo.yml e2860c5bdb Adds rubocop and fixes most style violations it detected 11 years ago
Gemfile 0f0a6bc4f0 Switches to using protobuf-ruby. 11 years ago
README.md 9fe51788e3 Removes google3 specifics from the README.md, aligns the description with an open source release 11 years ago
Rakefile e2860c5bdb Adds rubocop and fixes most style violations it detected 11 years ago
grpc.gemspec 5d11f8e7a1 fix a typo 11 years ago

README.md

gRPC Ruby

A Ruby implementation of gRPC, Google's RPC library.

INSTALLATION PREREQUISITES

This requires Ruby 2.x, as the rpc api surface uses keyword args.

INSTALLING

  • Install the gRPC core library TODO: describe this, once the core distribution mechanism is defined.

$ gem install grpc

Installing from source

  • Build or Install the gRPC core E.g, from the root of the grpc git repo $ cd ../.. $ make && sudo make install

  • 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 $ $ # follow the instructions to ensure that your're using the latest stable version of Ruby $ # and that the rvm command is installed

  • Install bundler $ gem install bundler

  • Finally, install grpc ruby locally. $ cd $ bundle install $ rake # compiles the extension, runs the unit tests, see rake -T for other options

  • CONTENTS

    Directory structure is the layout for ruby extensions

    • ext: the extension code
    • lib: the entrypoint grpc ruby library to be used in a 'require' statement
    • spec: tests
    • bin: example gRPC clients and servers, e.g,

      # client
      stub = Math::Math::Stub.new('my.test.math.server.com:8080')
      req = Math::DivArgs.new(dividend: 7, divisor: 3)
      logger.info("div(7/3): req=#{req.inspect}")
      resp = stub.div(req, INFINITE_FUTURE)
      logger.info("Answer: #{resp.inspect}")