twirp 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bd8003fe6ecc7f8636213eaf73a6c8b8455fd4e58adb8fb0a7400fdd5f19492
-  data.tar.gz: ec29ec78920b6451469fa05edcc69f4eec4162d79bbebfdf3d4ef2027a39df33
+  metadata.gz: 84ca98464f629eded22f43e5f6be8d5f720287e32056db5535ec71d529745504
+  data.tar.gz: 7f52befd48f263ec529820cdc0a376becee5bff8d83b206d443df288125cf65d
 SHA512:
-  metadata.gz: 58571087c354beb83cf23204abae8f64cb6ea4f3f9d75c8cb68fdaf7e9d282d05b09a37dc2458b60c946e3d930dfa64fef10f9391f0233ed5f71d75aa9ba4bf9
-  data.tar.gz: 55f7b4b75c4381a9144127b899c146f9b3841b49009438f123ac66d95db60aa6decf290e1dd30222eb339e062c92291d4008deb580a8798b738c6af27eb1af60
+  metadata.gz: 1199fe21d97365b929b03e1f2ae347544c13ba69473638c69c7a5f6097bc4de230c41422f1f019700f3b0a8e7a6475cbc24801cee45c755710031a635b4cc359
+  data.tar.gz: fdf6e077944198c4ae9158080f4120c7039a5b2e5bcfd83535a1e2da103638ccf3f2feab429ad22a3fb33c0ed69c504c8b74979a998bd8491d786273f8542733

data/README.md

@@ -1,8 +1,8 @@
 # Twirp-Ruby
 
-[![Run Tests](https://github.com/github/twirp-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/github/twirp-ruby/actions/workflows/tests.yml)
+[![Run Tests](https://github.com/arthurnn/twirp-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/arthurnn/twirp-ruby/actions/workflows/tests.yml)
 
-[Twirp is a protocol](https://github.github.io/twirp/docs/spec_v5.html) for routing and serialization of services defined in a [.proto file](https://developers.google.com/protocol-buffers/docs/proto3), allowing easy implementation of RPC services with auto-generated clients in different languages.
+[Twirp is a protocol](https://twitchtv.github.io/twirp/docs/spec_v5.html) for routing and serialization of services defined in a [.proto file](https://developers.google.com/protocol-buffers/docs/proto3), allowing easy implementation of RPC services with auto-generated clients in different languages.
 
 The [canonical implementation](https://github.com/twitchtv/twirp) is in Golang. The Twirp-Ruby project is the official implementation in Ruby for both server and clients.
 
@@ -11,13 +11,15 @@ The [canonical implementation](https://github.com/twitchtv/twirp) is in Golang.
 
 Add `gem "twirp"` to your Gemfile, or install with `gem install twirp`.
 
-To auto-generate Ruby code from a proto file, use the `protoc` plugin and the `--ruby_out` option ([see Wiki page](https://github.com/github/twirp-ruby/wiki/Code-Generation)).
+To auto-generate Ruby code from a proto file, use the `protoc` plugin and the `--ruby_out` option ([see Wiki page](https://github.com/arthurnn/twirp-ruby/wiki/Code-Generation)).
 
+### No backwards compatible breaking changes, between minor versions(1.10.0)
 
-## Documentation
+When upgrading from version 1.9.0 to 1.10.0, note that there is a breaking change in the `Twirp::ClientResp#initialize` method. The method now accepts keyword arguments. For more details, refer to this [comparison](https://github.com/arthurnn/twirp-ruby/compare/v1.9.0...v1.10.0#diff-b3c497150f4ae769df1a5d90e43142983cfd4d780392cbaa218d74912fa3a174) and this [issue](https://github.com/arthurnn/twirp-ruby/issues/99).
 
-[On the wiki](https://github.com/github/twirp-ruby/wiki).
+## Documentation
 
+[On the wiki](https://github.com/arthurnn/twirp-ruby/wiki).
 
 ## Contributing
 
@@ -25,4 +27,4 @@ To auto-generate Ruby code from a proto file, use the `protoc` plugin and the `-
 
 ## Releases and changes
 
-See the [releases](https://github.com/github/twirp-ruby/releases) page for latest information about released versions.
+See the [releases](https://github.com/arthurnn/twirp-ruby/releases) page for latest information about released versions.

data/lib/twirp/client.rb

@@ -178,7 +178,7 @@ module Twirp
     # natively with twirp-ruby. For normal Faraday, this is a noop.
     def rpc_response_thennable(resp)
       return yield resp unless resp.respond_to?(:then)
-      
+
       resp.then do |resp|
         yield resp
       end
@@ -186,15 +186,18 @@ module Twirp
 
     def rpc_response_to_clientresp(resp, content_type, rpcdef)
       if resp.status != 200
-        return ClientResp.new(error: self.class.error_from_response(resp))
+        return ClientResp.new(error: self.class.error_from_response(resp), headers: resp.headers)
       end
 
       if resp.headers['Content-Type'] != content_type
-        return ClientResp.new(error: Twirp::Error.internal("Expected response Content-Type #{content_type.inspect} but found #{resp.headers['Content-Type'].inspect}"))
+        return ClientResp.new(
+          error: Twirp::Error.internal("Expected response Content-Type #{content_type.inspect} but found #{resp.headers['Content-Type'].inspect}"),
+          headers: resp.headers
+        )
       end
 
       data = Encoding.decode(resp.body, rpcdef[:output_class], content_type)
-      return ClientResp.new(data: data, body: resp.body)
+      return ClientResp.new(data: data, body: resp.body, headers: resp.headers)
     end
 
   end

data/lib/twirp/client_json.rb

@@ -46,11 +46,11 @@ module Twirp
 
     def rpc_response_to_clientresp(resp)
       if resp.status != 200
-        return ClientResp.new(error: self.class.error_from_response(resp))
+        return ClientResp.new(error: self.class.error_from_response(resp), headers: resp.headers)
       end
 
       data = Encoding.decode_json(resp.body)
-      return ClientResp.new(data: data, body: resp.body)
+      return ClientResp.new(data: data, body: resp.body, headers: resp.headers)
     end
 
   end

data/lib/twirp/client_resp.rb

@@ -16,11 +16,13 @@ module Twirp
     attr_accessor :data
     attr_accessor :body
     attr_accessor :error
+    attr_accessor :headers
 
-    def initialize(data: nil, body: nil, error: nil)
+    def initialize(data: nil, body: nil, error: nil, headers: nil)
       @data = data
       @error = error
       @body = body
+      @headers = headers
     end
   end
 end

data/lib/twirp/service.rb

@@ -138,7 +138,7 @@ module Twirp
       input = nil
       begin
         body_str = rack_request.body.read
-        rack_request.body.rewind # allow other middleware to read again (https://github.com/github/twirp-ruby/issues/50)
+        rack_request.body.rewind # allow other middleware to read again (https://github.com/arthurnn/twirp-ruby/issues/50)
         input = Encoding.decode(body_str, env[:input_class], content_type)
       rescue => e
         error_msg = "Invalid request body for rpc method #{method_name.inspect} with Content-Type=#{content_type}"

data/lib/twirp/version.rb

@@ -12,5 +12,5 @@
 # permissions and limitations under the License.
 
 module Twirp
-  VERSION = "1.10.0"
+  VERSION = '1.12.0'
 end

data/test/client_json_test.rb

@@ -27,6 +27,7 @@ class ClientJSONTest < Minitest::Test
     assert_nil resp.error
     refute_nil resp.data
     assert_equal 3, resp.data["blah_resp"]
+    refute_nil resp.headers
   end
 
   def test_client_json_thennable
@@ -77,6 +78,7 @@ class ClientJSONTest < Minitest::Test
     refute_nil resp.error
     assert_equal :invalid_argument, resp.error.code
     assert_equal "dont like empty", resp.error.msg
+    refute_nil resp.headers
   end
 
   def test_client_bad_json_route
@@ -88,6 +90,7 @@ class ClientJSONTest < Minitest::Test
     assert_nil resp.data
     refute_nil resp.error
     assert_equal :bad_route, resp.error.code
+    refute_nil resp.headers
   end
 
 

data/test/client_test.rb

@@ -114,6 +114,7 @@ class ClientTest < Minitest::Test
     resp = c.make_hat(inches: 666)
     assert_nil resp.error
     refute_nil resp.data
+    refute_nil resp.headers
   end
 
   def test_proto_serialized_request_body
@@ -128,6 +129,7 @@ class ClientTest < Minitest::Test
     resp = c.make_hat(Example::Size.new(inches: 666))
     assert_nil resp.error
     refute_nil resp.data
+    refute_nil resp.headers
   end
 
   def test_proto_twirp_error
@@ -139,6 +141,7 @@ class ClientTest < Minitest::Test
     refute_nil resp.error
     assert_equal :internal, resp.error.code
     assert_equal "something went wrong", resp.error.msg
+    refute_nil resp.headers
   end
 
   def test_proto_intermediary_plain_error
@@ -153,6 +156,7 @@ class ClientTest < Minitest::Test
     assert_equal "true", resp.error.meta[:http_error_from_intermediary]
     assert_equal "Response is not JSON", resp.error.meta[:not_a_twirp_error_because]
     assert_equal "plain text error from proxy", resp.error.meta[:body]
+    refute_nil resp.headers
   end
 
   def test_proto_redirect_error
@@ -166,6 +170,7 @@ class ClientTest < Minitest::Test
     assert_equal "Unexpected HTTP Redirect from location=http://rainbow.com", resp.error.msg
     assert_equal "true", resp.error.meta[:http_error_from_intermediary]
     assert_equal "Redirects not allowed on Twirp requests", resp.error.meta[:not_a_twirp_error_because]
+    refute_nil resp.headers
   end
 
   def test_proto_missing_response_header
@@ -176,6 +181,7 @@ class ClientTest < Minitest::Test
     refute_nil resp.error
     assert_equal :internal, resp.error.code
     assert_equal 'Expected response Content-Type "application/protobuf" but found nil', resp.error.msg
+    refute_nil resp.headers
   end
 
   def test_error_with_invalid_code
@@ -187,6 +193,7 @@ class ClientTest < Minitest::Test
     refute_nil resp.error
     assert_equal :internal, resp.error.code
     assert_equal "Invalid Twirp error code: unicorn", resp.error.msg
+    refute_nil resp.headers
   end
 
   def test_error_with_no_code
@@ -201,6 +208,7 @@ class ClientTest < Minitest::Test
     assert_equal "true", resp.error.meta[:http_error_from_intermediary]
     assert_equal 'Response is JSON but it has no "code" attribute', resp.error.meta[:not_a_twirp_error_because]
     assert_equal '{"msg":"I have no code of honor"}', resp.error.meta[:body]
+    refute_nil resp.headers
   end
 
   # Call .rpc on JSON client

data/test/fake_services.rb

@@ -5,17 +5,8 @@ require_relative '../lib/twirp'
 
 # Protobuf messages.
 # An example of the result of the protoc ruby code generator.
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "example.Size" do
-    optional :inches, :int32, 1
-  end
-  add_message "example.Hat" do
-    optional :inches, :int32, 1
-    optional :color, :string, 2
-  end
-  add_message "example.Empty" do
-  end
-end
+descriptor_data = "\n\ntest.proto\x12\x07\x65xample\"\x16\n\x04Size\x12\x0e\n\x06inches\x18\x01 \x01(\x05\"$\n\x03Hat\x12\x0e\n\x06inches\x18\x01 \x01(\x05\x12\r\n\x05\x63olor\x18\x02 \x01(\t\"\x07\n\x05\x45mptyb\x06proto3"
+Google::Protobuf::DescriptorPool.generated_pool.add_serialized_file(descriptor_data)
 
 module Example
   Size = Google::Protobuf::DescriptorPool.generated_pool.lookup("example.Size").msgclass
@@ -56,11 +47,9 @@ class EmptyClient < Twirp::Client
 end
 
 # Foo message
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "Foo" do
-    optional :foo, :string, 1
-  end
-end
+descriptor_data = "\n\tfoo.proto\"\x12\n\x03\x46oo\x12\x0b\n\x03\x66oo\x18\x01 \x01(\tb\x06proto3"
+Google::Protobuf::DescriptorPool.generated_pool.add_serialized_file(descriptor_data)
+
 Foo = Google::Protobuf::DescriptorPool.generated_pool.lookup("Foo").msgclass
 
 # Foo Client

data/twirp.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["forbescyrus@gmail.com", "tothemario@gmail.com"]
   spec.summary       = %q{Twirp services in Ruby.}
   spec.description   = %q{Twirp is a simple RPC framework with protobuf service definitions. The Twirp gem provides native support for Ruby.}
-  spec.homepage      = "https://github.com/github/twirp-ruby"
+  spec.homepage      = "https://github.com/arthurnn/twirp-ruby"
   spec.license       = "MIT"
 
   spec.files         = Dir['lib/**/*'] + %w(Gemfile LICENSE README.md twirp.gemspec)
@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 1.9'
-  spec.add_runtime_dependency 'google-protobuf', '~> 3.0', '>= 3.7.0'
+  spec.add_runtime_dependency 'google-protobuf', '>= 3.25', '< 5.a'
   spec.add_runtime_dependency 'faraday', '< 3' # for clients
+  spec.add_dependency 'rack', '>= 2.2.3', '< 3' # see https://github.com/arthurnn/twirp-ruby/issues/111
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'minitest', '>= 5'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rack', '>= 2.2.3'
+
 end

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Cyrus A. Forbes
 - Mario Izquierdo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.a
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +45,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,20 +107,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.3
 description: Twirp is a simple RPC framework with protobuf service definitions. The
   Twirp gem provides native support for Ruby.
 email:
@@ -129,11 +135,11 @@ files:
 - test/license_header_test.rb
 - test/service_test.rb
 - twirp.gemspec
-homepage: https://github.com/github/twirp-ruby
+homepage: https://github.com/arthurnn/twirp-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Twirp services in Ruby.
 test_files: