route_guide 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdeed664737a7158414a45109d8004095d2b4fd938884aa48308559b315301a3
-  data.tar.gz: 6b57a38724df01709371539f44f5fa03969eebb3aa33ff9a9b878323d25ac50a
+  metadata.gz: 306b79419a33139769d321a1a4221408f633eac26d9d2ebcbae7d53efdfde67a
+  data.tar.gz: 21d43d8d4317bcc007711a883ed8d8ba7f94b7a0583455dfa40db4b4e5573ec1
 SHA512:
-  metadata.gz: f5f44cba98251ef93b4e2fe5dbb40cababe43618daf48860751a76ec42021dbb663c1c3856ef5b0fae68c80f79788bcbaa8ffd78902ad25381aafb6b3e5866d5
-  data.tar.gz: 27d80d941d0fa5a29c10edcf93a3295c691b5d5f5e9161b081a4b86e1a4f291204679ef8205cdc2c0faa6ed8226e5f7f635b2a258568ec6ad13ccd4e5ec0e343
+  metadata.gz: 6fe81484e7005e9ffb9d6351a7e07a7474478d8ef06c2d3c66ef1ff1db72bf18d87116eea778377f1acb1b550d5f7a6235b2d3b42eed81b14b7d3bcb4ae8d3c4
+  data.tar.gz: 54914673ae41f39bc028359ef28723224b5f63b7a9520ef1d347671142378c63b56e87c9e51fd7fbe8d0d3ab96f3b8ef12cd25db6a205d63b5b413553389710b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    route_guide (0.1.4)
+    route_guide (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -15,36 +15,40 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 You need to implement a server and a client. Then you can use this gem to connect between
-the two.
+the two. Check the `examples` folder for a working example.
 
 ### Server side service implementation
 
-1. Create the service in `directions_service.rb`:
+1. Create a `Gemfile` below then run `bundle` install:
 
 ```ruby
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "grpc"
+gem "route_guide"
+```
+
+2. Setup the gRPC server in `server.rb`:
+
+```ruby
+#!/usr/bin/env ruby
+
 require 'grpc'
 require 'route_guide'
 
 class DirectionsService < RouteGuide::DirectionsService::Service
   def direct_it(direction_req, _unused_call)
     puts "Received direction request for #{direction_req}"
+    # build response from object
     RouteGuide::DirectionsResponse.new(
-      directions: response.direction,
-      approximate_time_of_travel_in_hrs: response.approximate_time_of_travel_in_hrs,
-      approximate_distance_in_kms: response.approximate_distance_in_kms
+      directions: 'response',
+      approximate_time_of_travel_in_hrs: 4,
+      approximate_distance_in_kms: 30
     )
   end
 end
-```
-
-2. Setup the gRPC server in `server.rb`:
-
-```ruby
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'route_guide'
-require_relative 'directions_service'
 
 class RouteGuideServer
   class << self
@@ -55,8 +59,10 @@ class RouteGuideServer
     private
 
     def start_grpc_server
+      # create server
       @server = GRPC::RpcServer.new
       @server.add_http2_port("0.0.0.0:50052", :this_port_is_insecure)
+      # assign server to a grpc handler
       @server.handle(DirectionsService)
       @server.run_till_terminated
     end
@@ -83,12 +89,15 @@ require 'grpc'
 require 'route_guide'
 
 def test_single_call
+  # 1. connect to server service
   stub = RouteGuide::DirectionsService::Stub.new('0.0.0.0:50052', :this_channel_is_insecure)
+  # 2. build request object
   req = RouteGuide::DirectionsRequest.new(
     current_location: 'current_location',
     target_location: 'travel_location',
     means_of_travel: 'means_of_travel'
   )
+  # 3. call the remote method with request object as parameter
   resp_obj = stub.direct_it(req)
   puts "Response: #{resp_obj}"
 end
@@ -96,7 +105,11 @@ end
 test_single_call
 ```
 
-Then run the client in a separate terminal.
+2. Then run the client in a separate terminal. Run client with;
+
+```sh
+bundle exec client.rb
+```
 
 ## Development
 

data/examples/Gemfile.example

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "grpc"
+gem "route_guide"

data/examples/README.md

@@ -0,0 +1,9 @@
+# Examples
+
+## Usage
+
+- Open a terminal tab.
+- Run `ruby server.rb`.
+- Open another terminal tab.
+- Run `ruby client.rb`.
+- Go to the server tab and see the logs.

data/examples/client.rb

@@ -4,12 +4,15 @@ require 'grpc'
 require 'route_guide'
 
 def test_single_call
+  # 1. connect to server service
   stub = RouteGuide::DirectionsService::Stub.new('0.0.0.0:50052', :this_channel_is_insecure)
+  # 2. build request object
   req = RouteGuide::DirectionsRequest.new(
     current_location: 'current_location',
     target_location: 'travel_location',
     means_of_travel: 'means_of_travel'
   )
+  # 3. call remote method with request object as parameter
   resp_obj = stub.direct_it(req)
   puts "Response: #{resp_obj}"
 end

data/examples/server.rb

@@ -1,8 +1,20 @@
 #!/usr/bin/env ruby
 
+require 'grpc'
 require 'rubygems'
 require 'route_guide'
-require_relative 'directions_service'
+
+class DirectionsService < RouteGuide::DirectionsService::Service
+  def direct_it(direction_req, _unused_call)
+    puts "Received direction request for #{direction_req}"
+    # build response from object
+    RouteGuide::DirectionsResponse.new(
+      directions: 'response',
+      approximate_time_of_travel_in_hrs: 4,
+      approximate_distance_in_kms: 30
+    )
+  end
+end
 
 class RouteGuideServer
   class << self
@@ -13,8 +25,10 @@ class RouteGuideServer
     private
 
     def start_grpc_server
+      # create server
       @server = GRPC::RpcServer.new
       @server.add_http2_port("0.0.0.0:50052", :this_port_is_insecure)
+      # assign server to a grpc handler
       @server.handle(DirectionsService)
       @server.run_till_terminated
     end

data/lib/route_guide/route_guide_services_pb.rb

@@ -2,7 +2,7 @@
 # Source: route_guide.proto for package 'route_guide'
 
 require 'grpc'
-require_relative 'route_guide_pb'
+require 'route_guide_pb'
 
 module RouteGuide
   module DirectionsService

data/lib/route_guide/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RouteGuide
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_guide
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - sylvance_theone
@@ -30,8 +30,9 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- examples/Gemfile.example
+- examples/README.md
 - examples/client.rb
-- examples/directions_service.rb
 - examples/server.rb
 - lib/route_guide.rb
 - lib/route_guide/route_guide_pb.rb

data/examples/directions_service.rb

@@ -1,13 +0,0 @@
-require 'grpc'
-require 'route_guide'
-
-class DirectionsService < RouteGuide::DirectionsService::Service
-  def direct_it(direction_req, _unused_call)
-    puts "Received direction request for #{direction_req}"
-    RouteGuide::DirectionsResponse.new(
-      directions: response.direction,
-      approximate_time_of_travel_in_hrs: response.approximate_time_of_travel_in_hrs,
-      approximate_distance_in_kms: response.approximate_distance_in_kms
-    )
-  end
-end