grpc-kit

GRPC::Kit

GRPC toolkit for microservices

Installation

Add this line to your application's Gemfile:

gem 'grpc-kit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grpc-kit

Documentation

• GRPC::Kit::Communication::Resilient
• GRPC::Kit::Logger
• GRPC::Kit::Queue::Publisher
• GRPC::Kit::Queue::Worker

GRPC::Kit::Communication::Resilient

Sometimes, GRPC and Google::Cloud raises unavailable error, but you can retry and all works fine. Based on Datastore documentation we implemented a helper for resilient communication.

Example:

pubsub = Google::Cloud::Pubsub.new
topic  = pubsub.create_topic('topic_name')
topic.publish('message') # receives Google::Cloud::UnavailableError

# But you can uses resilient communication
include GRPC::Kit::Communication::Resilient
topic = resilient { topic.publish('message') }

# And you can sets the limit of repetition...
topic = resilient(limit: 5) { topic.publish('message') }

GRPC::Kit::Logger

By default all logs sent to GRPC.logger are ignored. But GRPC::Kit::Logger automatically configures logs to use STDOUT.

GRPC::Kit::Queue::Publisher

To publish a message to topic (creating one if none exists) you only need to configure environment variables for Google::Cloud::Pubsub and use:

GRPC::Kit::Queue::Publisher.publish('topic_name', 'message')

GRPC::Kit::Queue::Worker

Create a class in lib/workers including GRPC::Kit::Queue::Worker:

# lib/workers/my_worker.rb
class MyWorker
  include GRPC::Kit::Queue::Worker

  def initialize(msg)
    @msg = msg
  end

  def call
    puts @msg.data
    @msg.ack!
  end
end

And you can use:

# to list available workers
grpc-kit workers list
# to run a worker
grpc-kit workers runner MyWorker topic_name

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/b2beauty/grpc-kit.

License

The gem is available as open source under the terms of the MIT License.