grpc_kit 0.1.0

data/examples/routeguide/routeguide.proto

@@ -0,0 +1,110 @@
+// Copyright 2015 gRPC authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "io.grpc.examples.routeguide";
+option java_outer_classname = "RouteGuideProto";
+
+package routeguide;
+
+// Interface exported by the server.
+service RouteGuide {
+  // A simple RPC.
+  //
+  // Obtains the feature at a given position.
+  //
+  // A feature with an empty name is returned if there's no feature at the given
+  // position.
+  rpc GetFeature(Point) returns (Feature) {}
+
+  // A server-to-client streaming RPC.
+  //
+  // Obtains the Features available within the given Rectangle.  Results are
+  // streamed rather than returned at once (e.g. in a response message with a
+  // repeated field), as the rectangle may cover a large area and contain a
+  // huge number of features.
+  rpc ListFeatures(Rectangle) returns (stream Feature) {}
+
+  // A client-to-server streaming RPC.
+  //
+  // Accepts a stream of Points on a route being traversed, returning a
+  // RouteSummary when traversal is completed.
+  rpc RecordRoute(stream Point) returns (RouteSummary) {}
+
+  // A Bidirectional streaming RPC.
+  //
+  // Accepts a stream of RouteNotes sent while a route is being traversed,
+  // while receiving other RouteNotes (e.g. from other users).
+  rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
+}
+
+// Points are represented as latitude-longitude pairs in the E7 representation
+// (degrees multiplied by 10**7 and rounded to the nearest integer).
+// Latitudes should be in the range +/- 90 degrees and longitude should be in
+// the range +/- 180 degrees (inclusive).
+message Point {
+  int32 latitude = 1;
+  int32 longitude = 2;
+}
+
+// A latitude-longitude rectangle, represented as two diagonally opposite
+// points "lo" and "hi".
+message Rectangle {
+  // One corner of the rectangle.
+  Point lo = 1;
+
+  // The other corner of the rectangle.
+  Point hi = 2;
+}
+
+// A feature names something at a given point.
+//
+// If a feature could not be named, the name is empty.
+message Feature {
+  // The name of the feature.
+  string name = 1;
+
+  // The point where the feature is detected.
+  Point location = 2;
+}
+
+// A RouteNote is a message sent while at a given point.
+message RouteNote {
+  // The location from which the message is sent.
+  Point location = 1;
+
+  // The message to be sent.
+  string message = 2;
+}
+
+// A RouteSummary is received in response to a RecordRoute rpc.
+//
+// It contains the number of individual points received, the number of
+// detected features, and the total distance covered as the cumulative sum of
+// the distance between each point.
+message RouteSummary {
+  // The number of points received.
+  int32 point_count = 1;
+
+  // The number of known features passed while traversing the route.
+  int32 feature_count = 2;
+
+  // The distance covered in metres.
+  int32 distance = 3;
+
+  // The duration of the traversal in seconds.
+  int32 elapsed_time = 4;
+}

data/examples/routeguide/routeguide_pb.rb

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

data/examples/routeguide/routeguide_services_pb.rb

@@ -0,0 +1,61 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: routeguide.proto for package 'routeguide'
+# Original file comments:
+# Copyright 2015 gRPC authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'routeguide_pb'
+
+module Routeguide
+  module RouteGuide
+    # Interface exported by the server.
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'routeguide.RouteGuide'
+
+      # A simple RPC.
+      #
+      # Obtains the feature at a given position.
+      #
+      # A feature with an empty name is returned if there's no feature at the given
+      # position.
+      rpc :GetFeature, Point, Feature
+      # A server-to-client streaming RPC.
+      #
+      # Obtains the Features available within the given Rectangle.  Results are
+      # streamed rather than returned at once (e.g. in a response message with a
+      # repeated field), as the rectangle may cover a large area and contain a
+      # huge number of features.
+      rpc :ListFeatures, Rectangle, stream(Feature)
+      # A client-to-server streaming RPC.
+      #
+      # Accepts a stream of Points on a route being traversed, returning a
+      # RouteSummary when traversal is completed.
+      rpc :RecordRoute, stream(Point), RouteSummary
+      # A Bidirectional streaming RPC.
+      #
+      # Accepts a stream of RouteNotes sent while a route is being traversed,
+      # while receiving other RouteNotes (e.g. from other users).
+      rpc :RouteChat, stream(RouteNote), stream(RouteNote)
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/examples/routeguide_client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('./examples/routeguide')
+
+require 'grpc_kit'
+require 'pry'
+require 'routeguide_services_pb'
+
+stub = Routeguide::RouteGuide::Stub.new('localhost', 50051)
+
+def get_feature(stub)
+  points = [
+    Routeguide::Point.new(latitude:  409_146_138, longitude: -746_188_906),
+    Routeguide::Point.new(latitude:  0, longitude: 0)
+  ]
+
+  points.each do |pt|
+    feature = stub.get_feature(pt)
+    puts "get_feature #{feature.name}, #{feature.location}"
+  end
+end
+
+get_feature(stub)

data/examples/routeguide_server.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('./examples/routeguide')
+
+require 'grpc_kit'
+require 'pry'
+require 'json'
+require 'routeguide_services_pb'
+
+class Server < Routeguide::RouteGuide::Service
+  RESOURCE_PATH = './examples/routeguide/routeguide.json'
+
+  def initialize
+    File.open(RESOURCE_PATH) do |f|
+      features = JSON.load(f.read)
+      @features = Hash[features.map { |x| [x['location'], x['name']] }]
+    end
+  end
+
+  def get_feature(point, _call)
+    name = @features.fetch({ 'longitude' => point.longitude, 'latitude' => point.latitude }, '')
+    Routeguide::Feature.new(location: point, name: name)
+  end
+end
+
+sock = TCPServer.new(50051)
+
+server = GrpcKit::Server.new
+server.handle(Server.new)
+server.run
+
+loop do
+  conn = sock.accept
+  server.session_start(conn)
+end

data/grpc_kit.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grpc_kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grpc_kit'
+  spec.version       = GrpcKit::VERSION
+  spec.authors       = ['ganmacs']
+  spec.email         = ['ganmacs@gmail.com']
+
+  spec.summary       = 'A kit for creating gRPC server/client'
+  spec.description   = 'A kit for creating gRPC server/client'
+  spec.homepage      = 'https://github.com/ganmacs/grpc_kit'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ds9', '~> 1.1.1'
+  spec.add_dependency 'google-protobuf', '~> 3.6.1'
+  spec.add_dependency 'googleapis-common-protos-types', '~> 1.0.2'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'grpc-tools'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/grpc.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Compat file for xx_services_pb.rb
+require 'grpc_kit'
+require 'grpc_kit/grpc/generic_service'
+
+GRPC = GrpcKit::GRPC

data/lib/grpc_kit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require 'grpc_kit/version'
+require 'grpc_kit/server'
+require 'grpc_kit/client'
+
+module GrpcKit
+  def self.logger
+    @logger ||= Logger.new(STDOUT, level: :debug) # TODO: use :info level
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/grpc_kit/client.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: false
+
+require 'socket'
+require 'grpc_kit/session/client'
+
+module GrpcKit
+  class Client
+    def initialize(host, port, io = GrpcKit::IO::Basic)
+      @host = host
+      @port = port
+      @authority = "#{host}:#{port}"
+      @io = io
+    end
+
+    # @params handler [object]
+    def handle(handler)
+      klass = handler.class
+
+      klass.rpc_descs.values.each do |rpc_desc|
+        path = rpc_desc.path(klass.service_name)
+        if @rpc_descs[path]
+          raise "Duplicated method registered #{key}, class: #{handler}"
+        end
+
+        @rpc_descs[path] = [rpc_desc, handler]
+      end
+    end
+
+    class RequestResponse
+      attr_writer :session
+
+      def initialize(path, opts = {})
+        @path = path
+        @opts = opts
+        @session = nil
+        @data = ''
+      end
+
+      def invoke(data)
+        @session.submit_settings([])
+
+        stream_id = submit_request(data)
+        @session.start(stream_id)
+        @data
+      end
+
+      def on_data_chunk_recv(stream, data)
+        compressed, length, buf = data.unpack('CNa*')
+        if compressed == 0 # TODO: not
+          if length != buf.size
+            raise 'recived data inconsistent'
+          end
+
+          @data << buf
+          stream.recv2(buf)
+        else
+          raise 'not supported'
+        end
+      end
+
+      private
+
+      def submit_request(data)
+        @session.submit_request(
+          {
+            ':method' => 'POST',
+            ':scheme' => 'http',
+            ':authority' => @opts[:authority],
+            ':path' => @path.to_s,
+            'te' => 'trailers',
+            'content-type' => 'application/grpc',
+            'user-agent' => "grpc-ruby/#{GrpcKit::VERSION} (grpc_kit)",
+            'grpc-accept-encoding' => 'identity,deflate,gzip',
+          },
+          data,
+        )
+      end
+    end
+
+    def request_response(path, request, rpc_desc, opts = {})
+      GrpcKit.logger.info('Calling request_respose')
+      sock = TCPSocket.new(@host, @port)
+
+      rr = RequestResponse.new(path, { authority: @authority }.merge(opts))
+      session = GrpcKit::Session::Client.new(@io.new(sock, sock), rr)
+      rr.session = session
+
+      req = rpc_desc.encode2(request)
+      data = [0, req.length, req].pack('CNa*')
+
+      resp = rr.invoke(data)
+      rpc_desc.decode2(resp)
+    end
+
+    def client_streamer(path, requests, rpc, opts = {})
+      GrpcKit.logger.info('Calling client_streamer')
+    end
+
+    def server_streamer(path, request, metadata, opts = {})
+      GrpcKit.logger.info('Calling server_streamer')
+    end
+
+    def bidi_streamer(path, requests, metadata, opts = {})
+      GrpcKit.logger.info('Calling bidi_streamer')
+    end
+  end
+end

data/lib/grpc_kit/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/status_codes'
+
+module GrpcKit
+  module Errors
+    # https://github.com/grpc/grpc/blob/23b5b1a5a9c7084c5b64d4998ee15af0f77bd589/doc/statuscodes.md
+    class BadStatus < StandardError
+      def initialize(code, message)
+        super("#{code}:#{details}")
+        @code = code
+        @message = message
+      end
+
+      class Unimplemented < BadStatus
+        def initialize(name)
+          super(
+            GrpcKit::StatusCodes::UNIMPLEMENTED,
+            "Method not found at server: #{name}"
+          )
+        end
+      end
+    end
+  end
+end