twirp 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e62a59d0a5485723751b5d1f15452c79d50a338
-  data.tar.gz: 54444353c6556ad93ac5d3eee42a844f0d9ee106
+  metadata.gz: 8be53839103af850b802185600fb7496556d3334
+  data.tar.gz: '08333f8e2be8996b92d9d25368eaa03d0470ef51'
 SHA512:
-  metadata.gz: 0c6a92c2d93ef86c8ecffc4ce1a0581eb9b12bca892e018113ab5e4ac0d0c5bce949b1fe19fe8d14b53887f9273196832a4a3d99ed71d0bde07ccfbab5ca5c5d
-  data.tar.gz: 1ae6b8cb525b577e4b2eeb92114100f0d7b0444d3e5e2226dea24467934d464db92e304b6ed9899cbeff6aace09b1cf4b795448c0d10dac3066567cbfffa0e8f
+  metadata.gz: d4a61196709d7b86207d20618046c87eed889cdb1d5f15693019aad4e25f7df2aecee842b17d2e546cd84212718301e5938fddd4fd274d7e982c6d5354ac6ce1
+  data.tar.gz: b51466076296ddc2a4ee33edfd4557c4236408786902556c77a49e478c0e0a71d4dd603e9a788a141e98739fe15ab252e62f00a96d3bae024386909e27f68aa7

data/README.md

@@ -136,14 +136,6 @@ else
 end
 ```
 
-### Protobuf or JSON
-
-Clients use Protobuf by default. To use JSON, set the `content_type` option:
-
-```ruby
-c = Example::HelloWorldClient.new("http://localhost:3000", content_type: "application/json")
-```
-
 ### Configure Clients with Faraday
 
 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. For example:
@@ -159,12 +151,29 @@ end
 c = Example::HelloWorldClient.new(conn)
 ```
 
+### Protobuf or JSON
+
+Clients use Protobuf by default. To use JSON, set the `content_type` option as 2nd argument:
+
+```ruby
+c = Example::HelloWorldClient.new("http://localhost:3000", content_type: "application/json")
+resp = c.hello(name: "World") # serialized as JSON
+```
+
+### Add-hoc JSON requests
+
+If you just want to make a few quick requests from the console, you can instantiate a plain client and make `.json` calls:
+
+```ruby
+c = Twirp::Client.new("http://localhost:3000", package: "example", service: "HelloWorld")
+resp = c.json(:Hello, name: "World")
+puts resp.data["message"]
+```
+
+
 ## Server Hooks
 
-In the lifecycle of a request, the Twirp service starts by routing the request to a valid
-RPC method. If routing fails, the `on_error` hook is called with a bad_route error.
-If routing succeeds, the `before` hook is called before calling the RPC method handler,
-and then either `on_success` or `on_error` depending if the response is a Twirp error or not.
+In the lifecycle of a server request, Twirp starts by routing the request to a valid RPC method. If routing fails, the `on_error` hook is called with a bad_route error. If routing succeeds, the `before` hook is called before calling the RPC method handler, and then either `on_success` or `on_error` depending if the response is a Twirp error or not.
 
 ```
 routing -> before -> handler -> on_success
@@ -174,9 +183,7 @@ routing -> before -> handler -> on_success
 On every request, one and only one of `on_success` or `on_error` is called.
 
 
-If exceptions are raised, the `exception_raised` hook is called. The exceptioni is wrapped with
-an internal Twirp error, and if the `on_error` hook was not called yet, then it is called with
-the wrapped exception.
+If exceptions are raised, the `exception_raised` hook is called. The exceptioni is wrapped with an internal Twirp error, and if the `on_error` hook was not called yet, then it is called with the wrapped exception.
 
 
 ```

data/lib/twirp/client.rb

@@ -1,5 +1,4 @@
 require 'faraday'
-require 'json'
 
 require_relative 'encoding'
 require_relative 'error'
@@ -41,14 +40,16 @@ module Twirp
       if !Encoding.valid_content_type?(@content_type)
         raise ArgumentError.new("Invalid content_type #{@content_type.inspect}. Expected one of #{Encoding.valid_content_types.inspect}")
       end
-    end
 
-    def service_full_name
-      self.class.service_full_name
+      @service_full_name = if opts[:package] || opts[:service]
+        opts[:package].to_s.empty? ? opts[:service].to_s : "#{opts[:package]}.#{opts[:service]}"
+      else
+        self.class.service_full_name # defined through DSL
+      end
     end
 
     def rpc_path(rpc_method)
-      "/#{service_full_name}/#{rpc_method}"
+      "/#{@service_full_name}/#{rpc_method}"
     end
 
     # Make a remote procedure call to a defined rpc_method. The input can be a Proto message instance,
@@ -82,6 +83,27 @@ module Twirp
       return ClientResp.new(data, nil)
     end
 
+    # Convenience method to call any rpc method with dynamic json attributes.
+    # It is like .rpc but does not use the defined Protobuf messages to serialize/deserialize data;
+    # the request attrs can be anything and the response data is always a plain Hash of attributes.
+    # This is useful to test a service before doing any code-generation.
+    def json(rpc_method, attrs={})
+      body = Encoding.encode_json(attrs)
+
+      resp = @conn.post do |r|
+        r.url rpc_path(rpc_method)
+        r.headers['Content-Type'] = Encoding::JSON
+        r.body = body
+      end
+
+      if resp.status != 200
+        return ClientResp.new(nil, error_from_response(resp))
+      end
+
+      data = Encoding.decode_json(resp.body)
+      return ClientResp.new(data, nil)
+    end
+
     def error_from_response(resp)
       status = resp.status
 

data/lib/twirp/encoding.rb

@@ -1,31 +1,45 @@
+require 'json'
+
 module Twirp
 
   module Encoding
     JSON = "application/json"
     PROTO = "application/protobuf"
 
-    def self.decode(bytes, msg_class, content_type)
-      case content_type
-      when JSON  then msg_class.decode_json(bytes)
-      when PROTO then msg_class.decode(bytes)
-      else raise ArgumentError.new("Invalid content_type")
+    class << self
+
+      def decode(bytes, msg_class, content_type)
+        case content_type
+        when JSON  then msg_class.decode_json(bytes)
+        when PROTO then msg_class.decode(bytes)
+        else raise ArgumentError.new("Invalid content_type")
+        end
       end
-    end
 
-    def self.encode(msg_obj, msg_class, content_type)
-      case content_type
-      when JSON  then msg_class.encode_json(msg_obj)
-      when PROTO then msg_class.encode(msg_obj)
-      else raise ArgumentError.new("Invalid content_type")
+      def encode(msg_obj, msg_class, content_type)
+        case content_type
+        when JSON  then msg_class.encode_json(msg_obj)
+        when PROTO then msg_class.encode(msg_obj)
+        else raise ArgumentError.new("Invalid content_type")
+        end
       end
-    end
 
-    def self.valid_content_type?(content_type)
-      content_type == Encoding::JSON || content_type == Encoding::PROTO
-    end
+      def encode_json(attrs)
+        ::JSON.generate(attrs)
+      end
+
+      def decode_json(bytes)
+        ::JSON.parse(bytes)
+      end
+
+      def valid_content_type?(content_type)
+        content_type == JSON || content_type == PROTO
+      end
+
+      def valid_content_types
+        [JSON, PROTO]
+      end
 
-    def self.valid_content_types
-      [Encoding::JSON, Encoding::PROTO]
     end
   end
 

data/lib/twirp/service.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 require_relative 'encoding'
 require_relative 'error'
 require_relative 'service_dsl'
@@ -34,8 +32,8 @@ module Twirp
     def exception_raised(&block) @exception_raised << block; end
 
     # Service full_name is needed to route http requests to this service.
-    def full_name; self.class.service_full_name; end
-    def name; self.class.service_name; end
+    def full_name; @full_name ||= self.class.service_full_name; end
+    def name; @name ||= self.class.service_name; end
 
     # Rack app handler.
     def call(rack_env)
@@ -168,7 +166,7 @@ module Twirp
         @on_error.each{|hook| hook.call(twerr, env) }
 
         status = Twirp::ERROR_CODES_TO_HTTP_STATUS[twerr.code]
-        resp_body = JSON.generate(twerr.to_h)
+        resp_body = Encoding.encode_json(twerr.to_h)
         [status, error_response_headers, [resp_body]]
 
       rescue => e
@@ -185,7 +183,7 @@ module Twirp
       end
 
       twerr = Twirp::Error.internal_with(e)
-      resp_body = JSON.generate(twerr.to_h)
+      resp_body = Encoding.encode_json(twerr.to_h)
       [500, error_response_headers, [resp_body]]
     end
 

data/lib/twirp/service_dsl.rb

@@ -35,12 +35,12 @@ module Twirp
     # Get configured package name as String.
     # An empty value means that there's no package.
     def package_name
-      @package_name ||= @package.to_s
+      @package.to_s
     end
 
     # Service name as String. Defaults to the class name.
     def service_name
-      @service_name ||= (@service || self.name.split("::").last).to_s
+      (@service || self.name.split("::").last).to_s
     end
 
     # Service name with package prefix, which should uniquelly identifiy the service,
@@ -48,7 +48,7 @@ module Twirp
     # This can be used as a path prefix to route requests to the service, because a Twirp URL is:
     # "#{base_url}/#{service_full_name}/#{method]"
     def service_full_name
-      @service_full_name ||= package_name.empty? ? service_name : "#{package_name}.#{service_name}"
+      package_name.empty? ? service_name : "#{package_name}.#{service_name}"
     end
 
     # Get raw definitions for rpc methods.

data/lib/twirp/version.rb

@@ -1,3 +1,3 @@
 module Twirp
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/client_test.rb

@@ -12,7 +12,7 @@ class ClientTest < Minitest::Test
     c = EmptyClient.new("http://localhost:3000")
     refute_nil c
     refute_nil c.instance_variable_get(:@conn) # make sure that connection was assigned
-    assert_equal "EmptyClient", c.service_full_name
+    assert_equal "EmptyClient", c.instance_variable_get(:@service_full_name)
   end
 
   def test_new_with_invalid_url
@@ -27,45 +27,11 @@ class ClientTest < Minitest::Test
     end
   end
 
-  def test_rpc_success
-    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
-      [200, protoheader, proto(Foo, foo: "out")]
-    })
-    resp = c.rpc :Foo, foo: "in"
-    assert_nil resp.error
-    refute_nil resp.data
-    assert_equal "out", resp.data.foo
-  end
-
-  def test_rpc_error
-    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
-      [400, {}, json(code: "invalid_argument", msg: "dont like empty")]
-    })
-    resp = c.rpc :Foo, foo: ""
-    assert_nil resp.data
-    refute_nil resp.error
-    assert_equal :invalid_argument, resp.error.code
-    assert_equal "dont like empty", resp.error.msg
-  end
-
-  def test_rpc_serialization_exception
-    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
-      [200, protoheader, "badstuff"]
-    })
-    assert_raises Google::Protobuf::ParseError do
-      c.rpc :Foo, foo: "in"
-    end
-  end
 
-  def test_rpc_invalid_method
-    c = FooClient.new("http://localhost")
-    resp = c.rpc :OtherStuff, foo: "noo"
-    assert_nil resp.data
-    refute_nil resp.error
-    assert_equal :bad_route, resp.error.code
-  end
+  # Call .rpc on Protobuf client
+  # ----------------------------
 
-  def test_success
+  def test_proto_success
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       [200, protoheader, proto(Example::Hat, inches: 99, color: "red")]
     })
@@ -75,7 +41,7 @@ class ClientTest < Minitest::Test
     assert_equal "red", resp.data.color
   end
 
-  def test_serialized_request_body_attrs
+  def test_proto_serialized_request_body_attrs
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       size = Example::Size.decode(req.body) # body is valid protobuf
       assert_equal 666, size.inches
@@ -87,7 +53,7 @@ class ClientTest < Minitest::Test
     refute_nil resp.data
   end
 
-  def test_serialized_request_body_proto
+  def test_proto_serialized_request_body
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       assert_equal "application/protobuf", req.request_headers['Content-Type']
 
@@ -101,7 +67,7 @@ class ClientTest < Minitest::Test
     refute_nil resp.data
   end
 
-  def test_twirp_error
+  def test_proto_twirp_error
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       [500, {}, json(code: "internal", msg: "something went wrong")]
     })
@@ -112,7 +78,7 @@ class ClientTest < Minitest::Test
     assert_equal "something went wrong", resp.error.msg
   end
 
-  def test_intermediary_plain_error
+  def test_proto_intermediary_plain_error
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       [503, {}, 'plain text error from proxy']
     })
@@ -126,7 +92,7 @@ class ClientTest < Minitest::Test
     assert_equal "plain text error from proxy", resp.error.meta[:body]
   end
 
-  def test_redirect_error
+  def test_proto_redirect_error
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       [300, {'location' => "http://rainbow.com"}, '']
     })
@@ -139,7 +105,7 @@ class ClientTest < Minitest::Test
     assert_equal "Redirects not allowed on Twirp requests", resp.error.meta[:not_a_twirp_error_because]
   end
 
-  def test_missing_proto_response_header
+  def test_proto_missing_response_header
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       [200, {}, proto(Example::Hat, inches: 99, color: "red")]
     })
@@ -174,6 +140,9 @@ class ClientTest < Minitest::Test
     assert_equal '{"msg":"I have no code of honor"}', resp.error.meta[:body]
   end
 
+  # Call .rpc on JSON client
+  # ------------------------
+
   def test_json_success
     c = Example::HaberdasherClient.new(conn_stub("/example.Haberdasher/MakeHat") {|req|
       [200, jsonheader, '{"inches": 99, "color": "red"}']
@@ -233,6 +202,88 @@ class ClientTest < Minitest::Test
   end
 
 
+  # Directly call .rpc
+  # ------------------
+
+  def test_rpc_success
+    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
+      [200, protoheader, proto(Foo, foo: "out")]
+    })
+    resp = c.rpc :Foo, foo: "in"
+    assert_nil resp.error
+    refute_nil resp.data
+    assert_equal "out", resp.data.foo
+  end
+
+  def test_rpc_error
+    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
+      [400, {}, json(code: "invalid_argument", msg: "dont like empty")]
+    })
+    resp = c.rpc :Foo, foo: ""
+    assert_nil resp.data
+    refute_nil resp.error
+    assert_equal :invalid_argument, resp.error.code
+    assert_equal "dont like empty", resp.error.msg
+  end
+
+  def test_rpc_serialization_exception
+    c = FooClient.new(conn_stub("/Foo/Foo") {|req|
+      [200, protoheader, "badstuff"]
+    })
+    assert_raises Google::Protobuf::ParseError do
+      c.rpc :Foo, foo: "in"
+    end
+  end
+
+  def test_rpc_invalid_method
+    c = FooClient.new("http://localhost")
+    resp = c.rpc :OtherStuff, foo: "noo"
+    assert_nil resp.data
+    refute_nil resp.error
+    assert_equal :bad_route, resp.error.code
+  end
+
+  # Call .json
+  # ----------
+
+  def test_direct_json_success
+    c = Twirp::Client.new(conn_stub("/my.pkg.Talking/Blah") {|req|
+      assert_equal "application/json", req.request_headers['Content-Type']
+      assert_equal '{"blah1":1,"blah2":2}', req.body # body is json
+
+      [200, {}, json(blah_resp: 3)]
+    }, package: "my.pkg", service: "Talking")
+
+    resp = c.json :Blah, blah1: 1, blah2: 2
+    assert_nil resp.error
+    refute_nil resp.data
+    assert_equal 3, resp.data["blah_resp"]
+  end
+
+  def test_direct_json_error
+    c = Twirp::Client.new(conn_stub("/Foo/Foomo") {|req|
+      [400, {}, json(code: "invalid_argument", msg: "dont like empty")]
+    }, service: "Foo")
+
+    resp = c.json :Foomo, foo: ""
+    assert_nil resp.data
+    refute_nil resp.error
+    assert_equal :invalid_argument, resp.error.code
+    assert_equal "dont like empty", resp.error.msg
+  end
+
+  def test_direct_json_bad_route
+    c = Twirp::Client.new(conn_stub("/Foo/OtherMethod") {|req|
+      [404, {}, 'not here buddy']
+    }, service: "Foo")
+
+    resp = c.json :OtherMethod, foo: ""
+    assert_nil resp.data
+    refute_nil resp.error
+    assert_equal :bad_route, resp.error.code
+  end
+
+
   # Test Helpers
   # ------------
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cyrus A. Forbes