twirp 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31b1acc1215a5040a22d6ef3715103a8aa6840c9
-  data.tar.gz: 9cf27b5d6c7232bd6ccbeaf4b54211d97dc1cf45
+  metadata.gz: 7c112741e2caa5862500f4a8593d6d0aac78d26a
+  data.tar.gz: 607d5e0dbd7af7ac89c8e029885845462aad2578
 SHA512:
-  metadata.gz: af3f533423755f9d9ea5e27194a7f7efc857f1dbc4268a3d08548315651b14564f63ea8533b061c9b3c3efc261200c74c7b108696d99905a4ea8eed3c5f47b96
-  data.tar.gz: daf1b600b9df7240fbd99c1289be16f98f60ca0322ce23cfe9c3490611ecf99293d06a6b800ae8221f33c09cc1e0bbb65f536cfeab5b7d5beab678aaeb0590c5
+  metadata.gz: fb48c7b88bbf255a9fe8addd04918e2f9d13218a2352385d5c247797e6fb5440c008bdd89a64f346800bb16b17c7e5717ed463dbf0269dca5ce01bd8281b16e5
+  data.tar.gz: a44529c441232b6987173600206c4a50a8f2c5d12381669b5f92ae63d4814a1d7406138df2e02c89b0587e0bf61399804ce8e4f4e69d17465908fb261f5cbfa7

data/README.md

@@ -6,17 +6,34 @@ The [Twirp protocol](https://twitchtv.github.io/twirp/docs/spec_v5.html) is impl
 
 ## Install
 
-Add `gem "twirp"` to your Gemfile, or install with `gem install twirp`.
+Add `gem "twirp"` to your Gemfile, or install with
 
-For code generation, you also need [protoc](https://github.com/golang/protobuf) (version 3+).
+```
+gem install twirp
+```
+
+Code generation works with [protoc](https://github.com/golang/protobuf) (the protobuf compiler)
+using the `--ruby_out` option to generate messages and `--twirp_ruby_out` to generate services and clients. Make sure to install `protoc` version 3+.
+
+Then use `go get` (Golang) to install the ruby_twirp protoc plugin:
+
+```sh
+go get -u github.com/cyrusaf/ruby-twirp/protoc-gen-twirp_ruby
+```
+
+## Code Generation
+
+Service and client definitions can be auto-generated form a `.proto` file. For example, given a [Protobuf](https://developers.google.com/protocol-buffers/docs/proto3) file like [example/hello_world/service.proto](example/hello_world/service.proto), you can auto-generate proto and twirp files with the command:
+
+```sh
+protoc --proto_path=. --ruby_out=. --twirp_ruby_out=. ./example/hello_world/service.proto
+```
 
 ## Service DSL
 
-A Twirp service defines RPC methods to send and receive Protobuf messages. For example, a `HelloWorld` service:
+The generated code makes use of the service DSL. For example, the generated code for the `HelloWorld` service looks like this:
 
 ```ruby
-require 'twirp'
-
 module Example
   class HelloWorldService < Twirp::Service
     package "example"
@@ -30,27 +47,7 @@ module Example
 end
 ```
 
-The `HelloRequest` and `HelloResponse` messages are expected to be [google-protobuf](https://github.com/google/protobuf/tree/master/ruby) messages, which can also be defined from their DSL or auto-generated.
-
-
-## Code Generation
-
-RPC messages and the service definition can be auto-generated form a `.proto` file.
-
-Code generation works with [protoc](https://github.com/golang/protobuf) (the protobuf compiler)
-using the `--ruby_out` option to generate messages and `--twirp_ruby_out` to generate services and clients.
-
-Make sure to install `protoc` (version 3+). Then use `go get` (Golang) to install the ruby_twirp protoc plugin:
-
-```sh
-go get -u github.com/cyrusaf/ruby-twirp/protoc-gen-twirp_ruby
-```
-
-Given a [Protobuf](https://developers.google.com/protocol-buffers/docs/proto3) file like [example/hello_world/service.proto](example/hello_world/service.proto), you can auto-generate proto and twirp files with the command:
-
-```sh
-protoc --proto_path=. --ruby_out=. --twirp_ruby_out=. ./example/hello_world/service.proto
-```
+The `HelloRequest` and `HelloResponse` messages are expected to be [google-protobuf](https://github.com/google/protobuf/tree/master/ruby) messages. They are generated by `protoc`, but could also be defined from their DSL.
 
 
 ## Twirp Service Handler
@@ -80,17 +77,23 @@ For each rpc method:
 
 #### Start the Service
 
-Instantiate the service with your handler impementation. The service is a [Rack app](https://rack.github.io/). For example:
+Instantiate the service with your handler impementation. Here is where you would use dependency injection or any other extra setup.
 
 ```ruby
 handler = HelloWorldHandler.new()
 service = Example::HelloWorldService.new(handler)
+```
 
+The service is a [Rack app](https://rack.github.io/), it be mounted in a Rails app (e.g. in /config/routes.rb: `mount service, at: service.full_name`). And are also compatible with many other HTTP frameworks. For example, to mount on Webrick with base_url "http://localhost:3000/twirp":
+
+```ruby
 require 'rack'
-Rack::Handler::WEBrick.run service
-```
 
-Rack apps can also be mounted as Rails routes (e.g. `mount service, at: service.full_name`) and are compatible with many other HTTP frameworks.
+path_prefix = "/twirp/" + service.full_name
+server = WEBrick::HTTPServer.new(Port: 3000)
+server.mount path_prefix, Rack::Handler::WEBrick, service
+server.start
+```
 
 #### Unit Tests
 
@@ -124,7 +127,7 @@ end
 Instantiate a client with the service base url:
 
 ```ruby
-client = Example::HelloWorldClient.new("http://localhost:3000")
+client = Example::HelloWorldClient.new("http://localhost:3000/twirp")
 ```
 
 Clients implement the same methods as the service handler. For example the client for `HelloWorldService` implements the `hello` method:
@@ -154,7 +157,7 @@ end
 While Twirp takes care of routing, serialization and error handling, other advanced HTTP options can be configured with [Faraday](https://github.com/lostisland/faraday) middleware. Clients can be initialized with a Faraday connection. For example:
 
 ```ruby
-conn = Faraday.new(:url => 'http://localhost:3000') do |c|
+conn = Faraday.new(:url => 'http://localhost:3000/twirp') do |c|
   c.use Faraday::Request::Retry
   c.use Faraday::Request::BasicAuthentication, 'login', 'pass'
   c.use Faraday::Response::Logger # log to STDOUT
@@ -178,10 +181,8 @@ resp = client.hello(name: "World") # serialized with JSON
 If you just want to make a few quick requests from the console, you can make a `ClientJSON` instance. This doesn't require a service definition at all, but in the other hand, request and response values are not validated. Responses are just a Hash with attributes.
 
 ```ruby
-require 'twirp'
 client = Twirp::ClientJSON.new(conn, package: "example", service: "HelloWorld")
-resp = client.rpc(:Hello, name: "World") # serialized with JSON
-puts resp # resp.data is a plain Hash
+resp = client.rpc(:Hello, name: "World") # serialized with JSON, resp.data is a plain Hash
 ```
 
 

data/lib/twirp/client.rb

@@ -96,8 +96,13 @@ module Twirp
         status >= 300 && status <= 399
       end
 
-      def rpc_path(service_full_name, rpc_method)
-        "/#{service_full_name}/#{rpc_method}"
+      def make_http_request(conn, service_full_name, rpc_method, content_type, body)
+        conn.post do |r|
+          r.url "#{service_full_name}/#{rpc_method}"
+          r.headers['Content-Type'] = content_type
+          r.headers['Accept'] = content_type
+          r.body = body
+        end
       end
 
     end # class << self
@@ -134,13 +139,7 @@ module Twirp
       input = rpcdef[:input_class].new(input) if input.is_a? Hash
       body = Encoding.encode(input, rpcdef[:input_class], @content_type)
 
-      resp = @conn.post do |r|
-        r.url "/#{@service_full_name}/#{rpc_method}"
-        r.headers['Content-Type'] = @content_type
-        r.headers['Accept'] = @content_type
-        r.body = body
-      end
-
+      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, @content_type, body)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end

data/lib/twirp/client_json.rb

@@ -20,13 +20,7 @@ module Twirp
     def rpc(rpc_method, attrs={})
       body = Encoding.encode_json(attrs)
 
-      resp = @conn.post do |r|
-        r.url "/#{@service_full_name}/#{rpc_method}"
-        r.headers['Content-Type'] = Encoding::JSON
-        r.headers['Accept'] = Encoding::JSON
-        r.body = body
-      end
-
+      resp = self.class.make_http_request(@conn, @service_full_name, rpc_method, Encoding::JSON, body)
       if resp.status != 200
         return ClientResp.new(nil, self.class.error_from_response(resp))
       end

data/lib/twirp/version.rb

@@ -1,3 +1,3 @@
 module Twirp
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf