Merge pull request #101 from tbetbetbe/grpc_samples_add_ruby_route_guide

Grpc samples add ruby route guide

ruby/grpc-demo.gemspec

@@ -2,7 +2,7 @@
 # encoding: utf-8
 
 Gem::Specification.new do |s|
-  s.name          = 'grpc-greeter'
+  s.name          = 'grpc-demo'
   s.version       = '0.1.0'
   s.authors       = ['gRPC Authors']
   s.email         = 'temiola@google.com'
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.description   = 'Simple demo of using gRPC from Ruby'
 
   s.files         = `git ls-files -- ruby/*`.split("\n")
-  s.executables   = `git ls-files -- ruby/greeter*.rb`.split("\n").map do |f|
+  s.executables   = `git ls-files -- ruby/greeter*.rb ruby/route_guide/*.rb`.split("\n").map do |f|
     File.basename(f)
   end
   s.require_paths = ['lib']

ruby/lib/route_guide.rb

@@ -0,0 +1,37 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: route_guide.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "examples.Point" do
+    optional :latitude, :int32, 1
+    optional :longitude, :int32, 2
+  end
+  add_message "examples.Rectangle" do
+    optional :lo, :message, 1, "examples.Point"
+    optional :hi, :message, 2, "examples.Point"
+  end
+  add_message "examples.Feature" do
+    optional :name, :string, 1
+    optional :location, :message, 2, "examples.Point"
+  end
+  add_message "examples.RouteNote" do
+    optional :location, :message, 1, "examples.Point"
+    optional :message, :string, 2
+  end
+  add_message "examples.RouteSummary" do
+    optional :point_count, :int32, 1
+    optional :feature_count, :int32, 2
+    optional :distance, :int32, 3
+    optional :elapsed_time, :int32, 4
+  end
+end
+
+module Examples
+  Point = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.Point").msgclass
+  Rectangle = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.Rectangle").msgclass
+  Feature = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.Feature").msgclass
+  RouteNote = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.RouteNote").msgclass
+  RouteSummary = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.RouteSummary").msgclass
+end

ruby/lib/route_guide_services.rb

@@ -0,0 +1,27 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: route_guide.proto for package 'examples'
+
+require 'grpc'
+require 'route_guide'
+
+module Examples
+  module RouteGuide
+
+    # TODO: add proto service documentation here
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'examples.RouteGuide'
+
+      rpc :GetFeature, Point, Feature
+      rpc :ListFeatures, Rectangle, stream(Feature)
+      rpc :RecordRoute, stream(Point), RouteSummary
+      rpc :RouteChat, stream(RouteNote), stream(RouteNote)
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

ruby/route_guide/route_guide_client.rb

@@ -0,0 +1,165 @@
+#!/usr/bin/env ruby
+
+# Copyright 2015, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Sample app that connects to a Route Guide service.
+#
+# Usage: $ path/to/route_guide_client.rb path/to/route_guide_db.json &
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(File.dirname(this_dir), 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'grpc'
+require 'route_guide_services'
+
+include Examples
+
+GET_FEATURE_POINTS = [
+  Point.new(latitude:  409_146_138, longitude: -746_188_906),
+  Point.new(latitude:  0, longitude: 0)
+]
+
+# runs a GetFeature rpc.
+#
+# - once with a point known to be present in the sample route database
+# - once with a point that is not in the sample database
+def run_get_feature(stub)
+  p 'GetFeature'
+  p '----------'
+  GET_FEATURE_POINTS.each do |pt|
+    resp = stub.get_feature(pt)
+    if resp.name != ''
+      p "- found '#{resp.name}' at #{pt.inspect}"
+    else
+      p "- found nothing at #{pt.inspect}"
+    end
+  end
+end
+
+LIST_FEATURES_RECT = Rectangle.new(
+  lo: Point.new(latitude: 400_000_000, longitude: -750_000_000),
+  hi: Point.new(latitude: 420_000_000, longitude: -730_000_000))
+
+# runs a ListFeatures rpc.
+#
+# - the rectangle to chosen to include most of the known features
+#   in the sample db.
+def run_list_features(stub)
+  p 'ListFeatures'
+  p '------------'
+  resps = stub.list_features(LIST_FEATURES_RECT)
+  resps.each do |r|
+    p "- found '#{r.name}' at #{r.location.inspect}"
+  end
+end
+
+# RandomRoute provides an Enumerable that yields a random 'route' of points
+# from a list of Features.
+class RandomRoute
+  def initialize(features, size)
+    @features = features
+    @size = size
+  end
+
+  # yields a point, waiting between 0 and 1 seconds between each yield
+  #
+  # @return an Enumerable that yields a random point
+  def each
+    return enum_for(:each) unless block_given?
+    @size.times do
+      json_feature = @features[rand(0..@features.length)]
+      next if json_feature.nil?
+      location = json_feature['location']
+      pt = Point.new(
+        Hash[location.each_pair.map { |k, v| [k.to_sym, v] }])
+      p "- next point is #{pt.inspect}"
+      yield pt
+      sleep(rand(0..1))
+    end
+  end
+end
+
+# runs a RecordRoute rpc.
+#
+# - the rectangle to chosen to include most of the known features
+#   in the sample db.
+def run_record_route(stub, features)
+  p 'RecordRoute'
+  p '-----------'
+  points_on_route = 10  # arbitrary
+  deadline = points_on_route  # as delay b/w each is max 1 second
+  reqs = RandomRoute.new(features, points_on_route)
+  resp = stub.record_route(reqs.each, deadline)
+  p "summary: #{resp.inspect}"
+end
+
+ROUTE_CHAT_NOTES = [
+  RouteNote.new(message: 'doh - a deer',
+                location: Point.new(latitude: 0, longitude: 0)),
+  RouteNote.new(message: 'ray - a drop of golden sun',
+                location: Point.new(latitude: 0, longitude: 1)),
+  RouteNote.new(message: 'me - the name I call myself',
+                location: Point.new(latitude: 1, longitude: 0)),
+  RouteNote.new(message: 'fa - a longer way to run',
+                location: Point.new(latitude: 1, longitude: 1)),
+  RouteNote.new(message: 'soh - with needle and a thread',
+                location: Point.new(latitude: 0, longitude: 1))
+]
+
+# runs a RouteChat rpc.
+#
+# sends a canned set of route notes and prints out the responses.
+def run_route_chat(stub)
+  p 'Route Chat'
+  p '----------'
+  # TODO: decouple sending and receiving, i.e have the response enumerator run
+  # on its own thread.
+  resps = stub.route_chat(ROUTE_CHAT_NOTES)
+  resps.each { |r| p "received #{r.inspect}" }
+end
+
+def main
+  stub = RouteGuide::Stub.new('localhost:50051')
+  run_get_feature(stub)
+  run_list_features(stub)
+  run_route_chat(stub)
+  if ARGV.length == 0
+    p 'no feature database; skipping record_route'
+    exit
+  end
+  raw_data = []
+  File.open(ARGV[0]) do |f|
+    raw_data = MultiJson.load(f.read)
+  end
+  run_record_route(stub, raw_data)
+end
+
+main

ruby/route_guide/route_guide_server.rb

@@ -0,0 +1,211 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+# Copyright 2015, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Sample app that connects to a Route Guide service.
+#
+# Usage: $ path/to/route_guide_server.rb path/to/route_guide_db.json &
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.join(File.dirname(this_dir), 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'grpc'
+require 'multi_json'
+require 'route_guide_services'
+
+include Examples
+COORD_FACTOR = 1e7
+RADIUS = 637_100
+
+# Determines the distance between two points.
+def calculate_distance(point_a, point_b)
+  to_radians = proc { |x| x * Math::PI / 180 }
+  lat_a = point_a.latitude / COORD_FACTOR
+  lat_b = point_b.latitude / COORD_FACTOR
+  long_a = point_a.longitude / COORD_FACTOR
+  long_b = point_b.longitude / COORD_FACTOR
+  φ1 = to_radians.call(lat_a)
+  φ2 = to_radians.call(lat_b)
+  Δφ = to_radians.call(lat_a - lat_b)
+  Δλ = to_radians.call(long_a - long_b)
+  a = Math.sin(Δφ / 2)**2 +
+      Math.cos(φ1) * Math.cos(φ2) +
+      Math.sin(Δλ / 2)**2
+  (2 * RADIUS *  Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))).to_i
+end
+
+# RectangleEnum provides an Enumerator of the points in a feature_db within a
+# given Rectangle.
+class RectangleEnum
+  # @param [Hash] feature_db
+  # @param [Rectangle] bounds
+  def initialize(feature_db, bounds)
+    @feature_db = feature_db
+    @bounds = bounds
+    lats = [@bounds.lo.latitude, @bounds.hi.latitude]
+    longs = [@bounds.lo.longitude, @bounds.hi.longitude]
+    @lo_lat, @hi_lat = lats.min, lats.max
+    @lo_long, @hi_long = longs.min, longs.max
+  end
+
+  # in? determines if location lies within the bounds of this instances
+  # Rectangle.
+  def in?(location)
+    location['longitude'] >= @lo_long &&
+      location['longitude'] <= @hi_long &&
+      location['latitude'] >= @lo_lat &&
+      location['latitude'] <= @hi_lat
+  end
+
+  # each yields the features in the instances feature_db that lie within the
+  # instance rectangle.
+  def each
+    return enum_for(:each) unless block_given?
+    @feature_db.each_pair do |location, name|
+      next unless in?(location)
+      next if name.nil? || name == ''
+      pt = Point.new(
+        Hash[location.each_pair.map { |k, v| [k.to_sym, v] }])
+      yield Feature.new(location: pt, name: name)
+    end
+  end
+end
+
+# A EnumeratorQueue wraps a Queue to yield the items added to it.
+class EnumeratorQueue
+  extend Forwardable
+  def_delegators :@q, :push
+
+  def initialize(sentinel)
+    @q = Queue.new
+    @sentinel = sentinel
+    @received_notes = {}
+  end
+
+  def each_item
+    return enum_for(:each_item) unless block_given?
+    loop do
+      r = @q.pop
+      break if r.equal?(@sentinel)
+      fail r if r.is_a? Exception
+      yield r
+    end
+  end
+end
+
+# ServerImpl provides an implementation of the RouteGuide service.
+class ServerImpl < RouteGuide::Service
+  # @param [Hash] feature_db {location => name}
+  def initialize(feature_db)
+    @feature_db = feature_db
+    @received_notes = Hash.new { |h, k| h[k] = [] }
+  end
+
+  def get_feature(point, _call)
+    name = @feature_db[{
+      'longitude' => point.longitude,
+      'latitude' => point.latitude }] || ''
+    Feature.new(location: point, name: name)
+  end
+
+  def list_features(rectangle, _call)
+    RectangleEnum.new(@feature_db, rectangle).each
+  end
+
+  def record_route(call)
+    started, elapsed_time = 0, 0
+    distance, count, features, last = 0, 0, 0, nil
+    call.each_remote_read do |point|
+      count += 1
+      name = @feature_db[{
+        'longitude' => point.longitude,
+        'latitude' => point.latitude }] || ''
+      features += 1 unless name == ''
+      if last.nil?
+        last = point
+        started = Time.now.to_i
+        next
+      end
+      elapsed_time = Time.now.to_i - started
+      distance += calculate_distance(point, last)
+      last = point
+    end
+    RouteSummary.new(point_count: count,
+                     feature_count: features,
+                     distance: distance,
+                     elapsed_time: elapsed_time)
+  end
+
+  def route_chat(notes)
+    q = EnumeratorQueue.new(self)
+    # run a separate thread that processes the incoming requests
+    t = Thread.new do
+      begin
+        notes.each do |n|
+          key = {
+            'latitude' => n.location.latitude,
+            'longitude' => n.location.longitude
+          }
+          earlier_msgs = @received_notes[key]
+          @received_notes[key] << n.message
+          # send back the earlier messages at this point
+          earlier_msgs.each do |r|
+            q.push(RouteNote.new(location: n.location, message: r))
+          end
+        end
+        q.push(self)  # signal completion
+      rescue StandardError => e
+        q.push(e)  # signal completion via an error
+      end
+    end
+    q.each_item
+  end
+end
+
+def main
+  if ARGV.length == 0
+    fail 'Please specify the path to the route_guide json database'
+  end
+  raw_data = []
+  File.open(ARGV[0]) do |f|
+    raw_data = MultiJson.load(f.read)
+  end
+  feature_db = Hash[raw_data.map { |x| [x['location'], x['name']] }]
+  port = '0.0.0.0:50051'
+  s = GRPC::RpcServer.new
+  s.add_http2_port(port)
+  logger.info("... running insecurely on #{port}")
+  s.handle(ServerImpl.new(feature_db))
+  s.run
+end
+
+main