twirp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5d364eb9a55aa4f9f80a217d0c25a9a3b5377d
-  data.tar.gz: add09813fd7965e1c510b5774a30445e66859b3e
+  metadata.gz: 2de989bef622a106065d7cad486cd575cc10d783
+  data.tar.gz: 5e01d8fae314ab0f4c53e64f9ede154aef54eafb
 SHA512:
-  metadata.gz: 1a0e61629575ec564449543c16b6c4842541abaea0c97e944318aea5ed385941b155371cbe2926faf2fe0c50824d46d1eb44302bed983749859599b6906d9063
-  data.tar.gz: f4113090daee32f775653c563fdb2ba60bad0d34ccc0b2287e8636b820288411933d20e41988d43ae17035db737e3e7cdce4079ad888fd16a4fc14a4eb8ee608
+  metadata.gz: 609f958dec7ba47552c36bd54a96aa7404e602f56ed669e22401deccf9e4568852beac96d09fe40cf81bf42bc601c811d6165fc1a2b1d67c6b92fa1412c26307
+  data.tar.gz: a7414cf878277e142d4b52a1492f03f8e37bfe71fe82ff1046c29199cd9405a5e8e59f4be13b26ecb69ed0d9d689eef98d5378da93ea6fbfa6e365ada542709f

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,3 +1,81 @@
 # Ruby Twirp
 
 Twirp services and clients in Ruby.
+
+### Installation
+Use `go get` to install the ruby_twirp protoc plugin:
+```
+➜ go get github.com/cyrusaf/ruby-twirp/protoc-gen-twirp_ruby
+```
+
+You will also need:
+ - [protoc](https://github.com/golang/protobuf), the protobuf compiler. You need
+   version 3+.
+
+### Haberdasher Example
+See the `examples/` folder for the final product.
+
+First create a basic `.proto` file:
+```
+// haberdasher.proto
+syntax = "proto3";
+package examples;
+
+service Haberdasher {
+    rpc HelloWorld(HelloWorldRequest) returns (HelloWorldResponse);
+}
+
+message HelloWorldRequest {
+    string name = 1;
+}
+
+message HelloWorldResponse {
+    string message = 1;
+}
+
+```
+
+Run the `protoc` binary to generate `gen/haberdasher_pb.rb` and `gen/haberdasher_twirp.rb`.
+```
+➜ protoc --proto_path=. ./haberdasher.proto --ruby_out=gen --twirp_ruby_out=gen
+```
+
+Write an implementation of our haberdasher service and attach to a rack server:
+```
+# config.ru
+require 'rack'
+require_relative 'gen/haberdasher_pb.rb'
+require_relative 'gen/haberdasher_twirp.rb'
+
+class HaberdasherImplementation
+    def HelloWorld(req)
+        return Examples::HelloWorldResponse.new(message: "Hello #{req.name}")
+    end
+end
+
+svc = HaberdasherImplementation.new()
+run Rack::URLMap.new HaberdasherService::PATH_PREFIX => HaberdasherService.new(svc).handler
+```
+
+You can also mount onto a rails service:
+```
+App::Application.routes.draw do
+  svc = HaberdasherImplementation.new()
+  mount HaberdasherServer.new(svc).handler, at: HaberdasherServer::PATH_PREFIX
+end
+```
+
+Run `config.ru` to start the server on port 8080:
+```
+➜ rackup
+```
+
+`curl` your server to get a response:
+```
+➜ curl --request POST \
+  --url http://localhost:8080/twirp/examples.Haberdasher/HelloWorld \
+  --header 'content-type: application/json' \
+  --data '{
+	"name": "World"
+}'
+```

data/examples/Gemfile

@@ -0,0 +1,7 @@
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'twirp'
+gem "rack"

data/examples/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    google-protobuf (3.5.1.2)
+    rack (2.0.1)
+    twirp (0.0.1)
+      google-protobuf (>= 3.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack
+  twirp
+
+BUNDLED WITH
+   1.16.1

data/examples/config.ru

@@ -0,0 +1,12 @@
+require 'rack'
+require_relative 'gen/haberdasher_pb.rb'
+require_relative 'gen/haberdasher_twirp.rb'
+
+class HaberdasherImplementation
+    def HelloWorld(req)
+        return Examples::HelloWorldResponse.new(message: "Hello #{req.name}")
+    end
+end
+
+svc = HaberdasherImplementation.new()
+run Rack::URLMap.new HaberdasherService::PATH_PREFIX => HaberdasherService.new(svc).handler

data/examples/gen/haberdasher_pb.rb

@@ -0,0 +1,18 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: haberdasher.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "examples.HelloWorldRequest" do
+    optional :name, :string, 1
+  end
+  add_message "examples.HelloWorldResponse" do
+    optional :message, :string, 1
+  end
+end
+
+module Examples
+  HelloWorldRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.HelloWorldRequest").msgclass
+  HelloWorldResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("examples.HelloWorldResponse").msgclass
+end

data/examples/gen/haberdasher_twirp.rb

@@ -0,0 +1,7 @@
+# Code generated by protoc-gen-twirp_ruby, DO NOT EDIT.
+require 'twirp'
+
+class HaberdasherService < Twirp::Service
+  PATH_PREFIX = "/twirp/examples.Haberdasher"
+  rpc :HelloWorld, Examples::HelloWorldRequest, Examples::HelloWorldResponse
+end

data/examples/haberdasher.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+package examples;
+
+service Haberdasher {
+    rpc HelloWorld(HelloWorldRequest) returns (HelloWorldResponse);
+}
+
+message HelloWorldRequest {
+    string name = 1;
+}
+
+message HelloWorldResponse {
+    string message = 1;
+}

data/lib/twirp.rb

@@ -1,2 +1,3 @@
 require_relative 'twirp/version'
 require_relative 'twirp/error'
+require_relative 'twirp/service'

data/lib/twirp/{server.rb → service.rb}

@@ -1,5 +1,5 @@
 module Twirp
-  class Server
+  class Service
     @@rpcs = {}
 
     def initialize(svc)
@@ -34,13 +34,13 @@ module Twirp
 
     def serve_json(req, method_name, request_class, response_class)
       params = request_class.decode_json(req.body.read)
-      resp = @svc.send(method_name.underscore, params)
+      resp = @svc.send(method_name, params)
       self.serve_success_json(response_class.encode_json(resp))
     end
 
     def serve_proto(req, method_name, request_class, response_class)
       params = request_type.decode(req.body.read)
-      resp = @svc.send(method_name.underscore, params)
+      resp = @svc.send(method_name, params)
       self.serve_success_proto(response_class.encode(resp))
     end
 

data/lib/twirp/version.rb

@@ -1,3 +1,3 @@
 module Twirp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/protoc-gen-twirp_ruby/main.go

@@ -72,14 +72,15 @@ func (g *generator) generateFile(file *descriptor.FileDescriptorProto) *plugin.C
 	g.P(`# Code generated by protoc-gen-twirp_ruby, DO NOT EDIT.`)
 	for _, service := range file.Service {
 		serviceName := serviceName(service)
+		g.P(`require 'twirp'`)
 		g.P(``)
-		g.P(fmt.Sprintf("class %s < Twirp::Server", serviceName))
-		g.P(fmt.Sprintf(`PATH_PREFIX = "/twirp/%s.%s"`, pkgName, serviceName))
+		g.P(fmt.Sprintf("class %sService < Twirp::Service", serviceName))
+		g.P(fmt.Sprintf(`  PATH_PREFIX = "/twirp/%s.%s"`, pkgName, serviceName))
 		for _, method := range service.GetMethod() {
 			methName := methodName(method)
 			inputName := methodInputName(method)
 			outputName := methodOutputName(method)
-			g.P(fmt.Sprintf("  rpc :%s, %s, %s", methName, inputName, outputName))
+			g.P(fmt.Sprintf("  rpc :%s, %s::%s, %s::%s", methName, CamelCase(pkgName), inputName, CamelCase(pkgName), outputName))
 		}
 		g.P(`end`)
 	}
@@ -183,3 +184,61 @@ func writeResponse(w io.Writer, resp *plugin.CodeGeneratorResponse) {
 		Fail(err.Error(), "writing response")
 	}
 }
+
+// CamelCase converts a string from snake_case to CamelCased.
+//
+// If there is an interior underscore followed by a lower case letter, drop the
+// underscore and convert the letter to upper case. There is a remote
+// possibility of this rewrite causing a name collision, but it's so remote
+// we're prepared to pretend it's nonexistent - since the C++ generator
+// lowercases names, it's extremely unlikely to have two fields with different
+// capitalizations. In short, _my_field_name_2 becomes XMyFieldName_2.
+func CamelCase(s string) string {
+	if s == "" {
+		return ""
+	}
+	t := make([]byte, 0, 32)
+	i := 0
+	if s[0] == '_' {
+		// Need a capital letter; drop the '_'.
+		t = append(t, 'X')
+		i++
+	}
+	// Invariant: if the next letter is lower case, it must be converted
+	// to upper case.
+	//
+	// That is, we process a word at a time, where words are marked by _ or upper
+	// case letter. Digits are treated as words.
+	for ; i < len(s); i++ {
+		c := s[i]
+		if c == '_' && i+1 < len(s) && isASCIILower(s[i+1]) {
+			continue // Skip the underscore in s.
+		}
+		if isASCIIDigit(c) {
+			t = append(t, c)
+			continue
+		}
+		// Assume we have a letter now - if not, it's a bogus identifier. The next
+		// word is a sequence of characters that must start upper case.
+		if isASCIILower(c) {
+			c ^= ' ' // Make it a capital letter.
+		}
+		t = append(t, c) // Guaranteed not lower case.
+		// Accept lower case sequence that follows.
+		for i+1 < len(s) && isASCIILower(s[i+1]) {
+			i++
+			t = append(t, s[i])
+		}
+	}
+	return string(t)
+}
+
+// Is c an ASCII lower-case letter?
+func isASCIILower(c byte) bool {
+	return 'a' <= c && c <= 'z'
+}
+
+// Is c an ASCII digit?
+func isASCIIDigit(c byte) bool {
+	return '0' <= c && c <= '9'
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -48,12 +48,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - README.md
+- examples/Gemfile
+- examples/Gemfile.lock
+- examples/config.ru
+- examples/gen/haberdasher_pb.rb
+- examples/gen/haberdasher_twirp.rb
+- examples/haberdasher.proto
 - lib/twirp.rb
 - lib/twirp/error.rb
-- lib/twirp/server.rb
+- lib/twirp/service.rb
 - lib/twirp/version.rb
 - protoc-gen-twirp_ruby/main.go
 - test/error_test.rb