webmock-twirp 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a34362dd929abe47a175e407335cc6f94a307c00fd902742d06285550fcd78
-  data.tar.gz: efefa4e116a259eeab30129f7afe2b803f682daf0e0c15785e48720c5efe5d70
+  metadata.gz: fce3ed5388747c254df01adbd95139180c434b3b012c6c0983bd15a3973921bf
+  data.tar.gz: 61c27cfac06badede4fec86c61dd3b718e3731d8c6a4504bb8cbcb5ba3965181
 SHA512:
-  metadata.gz: 04c11a624eb11547a7d0df20fcddd5b40015e75b6af94311e764484d98bc1333ffd728b085e0b5a29b08b4b039945d209a7ae74a9312bd0b65d9bebdcf87e43c
-  data.tar.gz: 2179804f8df26c7c65d17781cd0a4df2c5c9806697e97c1f794f2bb008a5d5febdad89522df69b853ddfd6d2a869092b8dc572a5f5ac500fb5db3a5e30995215
+  metadata.gz: 030f3f2b9930d73e40ad4b2a4ed6fe26dcb84588e5c1378c7c892b20d64ee579d168df3906843878118eb435b1ebedc948944aefb8c45d552c4c3a5ec24d485e
+  data.tar.gz: 7cc323899b49557945f0e53796308d02cafde3dfe9829b9fbb0abfb91c4cdd5f4137828e2be87d20bd4ebe1f66d475fd18166df45eb1adf4da965152ea50b9f2

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+###  v0.4.1  (2022-12-15)
+- protobuf type support
+- gemspec cleanup
+- build upgrade
+- dependabot
+- respond to improvement
+
+###  v0.4.0  (2022-11-16)
+- .to_return(Twirp::ClientResp)
+- revert client class name filter
+- unqualified client class filter
+- uri matching
+
 ###  v0.3.0  (2022-10-28)
 - twirpify all the things
 - improve refinements

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    webmock-twirp (0.4.0)
+      twirp (>= 1)
+      webmock (>= 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    byebug (11.1.3)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    google-protobuf (3.21.12)
+    hashdiff (1.0.1)
+    multipart-post (2.2.3)
+    public_suffix (5.0.1)
+    rack (3.0.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    twirp (1.9.0)
+      faraday (< 2)
+      google-protobuf (~> 3.0, >= 3.7.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  codecov
+  rack
+  rspec
+  simplecov
+  webmock-twirp!
+  webrick
+
+BUNDLED WITH
+   2.3.17

data/README.md

@@ -97,6 +97,45 @@ stub_twirp_request.to_return do |request|
 end
 ```
 
+## Improved WebMock Errors
+Before
+```ruby
+> client = EchoClient.new("http://example.com/twirp")
+...
+> client.echo(msg: "Hi")
+/lib/webmock/http_lib_adapters/net_http.rb:104:in `request': Real HTTP connections are disabled. Unregistered request: 
+POST http://example.com/twirp/Echo/Echo with body ' (WebMock::NetConnectNotAllowedError)
+Hi' with headers {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/protobuf', 'User-Agent'=>'Faraday v1.10.2'}
+
+You can stub this request with the following snippet:
+
+stub_request(:post, "http://example.com/twirp/Echo/Echo").
+  with(
+    body: "\n\x02Hi",
+    headers: {
+       'Accept'=>'*/*',
+       'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+       'Content-Type'=>'application/protobuf',
+       'User-Agent'=>'Faraday v1.10.2'
+    }).
+  to_return(status: 200, body: "", headers: {})
+```
+
+After
+```ruby
+> require "webmock-twirp"
+> client = EchoClient.new("http://example.com/twirp")
+...
+> client.echo(msg: "Hi")
+/lib/webmock/http_lib_adapters/net_http.rb:104:in `request': Real Twirp connections are disabled. Unregistered request: 
+EchoClient(http://example.com/twirp/Echo/Echo).echo(msg: "Hi") (WebMock::NetConnectNotAllowedError)
+
+You can stub this request with the following snippet:
+
+stub_twirp_request(:echo).with(
+  msg: "Hi",
+).to_return(...)
+```
 
 ----
 ## Contributing

data/lib/webmock/twirp/error.rb

@@ -9,7 +9,8 @@ module WebMock
         snippet = WebMock::RequestSignatureSnippet.new(@request_signature)
 
         text = [
-          "Real Twirp connections are disabled. Unregistered request: #{@request_signature}",
+          "Real Twirp connections are disabled. Unregistered request:",
+          @request_signature,
           snippet.stubbing_instructions,
           snippet.request_stubs,
           "="*60

data/lib/webmock/twirp/matchers/make_twirp_request.rb

@@ -7,14 +7,14 @@ module WebMock
         end
 
         def method_missing(name, *args, **kwargs, &block)
-          super unless respond_to?(name)
+          return super unless respond_to_missing?(name)
           @stub.send(name, *args, **kwargs, &block)
 
           self
         end
 
-        def respond_to?(method_name, include_private = false)
-          super || @stub.respond_to?(method_name)
+        def respond_to_missing?(method_name, include_private = false)
+          @stub.respond_to?(method_name)
         end
 
         def matches?(block)

data/lib/webmock/twirp/refinements.rb

@@ -8,16 +8,16 @@ module WebMock
       end
 
       refine Google::Protobuf::MessageExts do
-        def normalized_hash(symbolize_keys: true)
+        def normalized_hash
           res = {}
 
           self.class.descriptor.each do |field|
-            key = symbolize_keys ? field.name.to_sym : field.name
+            key = field.name.to_sym
             value = field.get(self)
 
             if value.is_a?(Google::Protobuf::MessageExts)
               # recursively serialize sub-message
-              value = value.normalized_hash(symbolize_keys: symbolize_keys)
+              value = value.normalized_hash
             end
 
             res[key] = value unless field.default == value

data/lib/webmock/twirp/request_stub.rb

@@ -1,13 +1,11 @@
+require "uri"
+
 module WebMock
   module Twirp
     class RequestStub < WebMock::RequestStub
       using Refinements
 
-      attr_reader :twirp_client, :rpc_name, :with_attrs
-
       def initialize(*filters)
-        rpc_name = filters.snag { |x| x.is_a?(Symbol) }
-
         client = filters.snag { |x| x.is_a?(::Twirp::Client) }
 
         klass = client&.class
@@ -15,11 +13,21 @@ module WebMock
           x.is_a?(Class) && (x < ::Twirp::Client || x < ::Twirp::Service)
         end
 
+        rpc_name = filters.snag { |x| x.is_a?(Symbol) }
+
+        uri = filters.snag do |x|
+          x.is_a?(String) && x.start_with?("http") && x =~ URI::regexp
+        end
+
+        if client && uri
+          raise ArgumentError, "specify uri or client instance, but not both"
+        end
+
         unless filters.empty?
           raise ArgumentError, "unexpected arguments: #{filters}"
         end
 
-        uri = ""
+        uri ||= ""
 
         if client
           conn = client.instance_variable_get(:@conn)
@@ -135,6 +143,9 @@ module WebMock
         raise NotImplementedError
       end
 
+      # for internal, package use only
+      attr_reader :twirp_client, :rpc_name, :with_attrs
+
       private
 
       def generate_http_response(request, obj)
@@ -155,6 +166,8 @@ module WebMock
           end
 
           obj
+        when ::Twirp::ClientResp
+          obj.error || obj.data
         when ::Twirp::Error
           obj
         when Symbol
@@ -169,6 +182,12 @@ module WebMock
           else
             raise ArgumentError, "invalid http error status: #{obj}"
           end
+        when Class
+          unless obj == msg_class
+            raise TypeError, "Expected type #{msg_class}, found #{obj}"
+          end
+
+          obj.new
         else
           raise ArgumentError, "can not generate twirp reponse from: #{obj}"
         end

data/lib/webmock/twirp/version.rb

@@ -1,5 +1,5 @@
 module WebMock
   module Twirp
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/service.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require "google/protobuf"
+require "rack"
+require "twirp"
+require "webrick"
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+server = WEBrick::HTTPServer.new(Port: 3000)
+
+handler = EchoHandler.new
+service = EchoService.new(handler)
+path_prefix = "/twirp/" + service.full_name
+server.mount path_prefix, Rack::Handler::WEBrick, service
+
+# handler = ComplexHandler.new
+# service = ComplexService.new(handler)
+# path_prefix = "/twirp/" + service.full_name
+# server.mount path_prefix, Rack::Handler::WEBrick, service
+
+server.start
+
+# client = EchoClient.new("http://localhost:3000/twirp")
+# client = ComplexClient.new("http://localhost:3000/twirp")
+# resp = client.echo(msg: "World")
+# puts resp.data

data/webmock-twirp.gemspec

@@ -1,25 +1,15 @@
-package_name = File.basename(__FILE__).split(".")[0]
-load Dir.glob("lib/**/version.rb")[0]
-
+require_relative "lib/webmock/twirp/version"
 package = WebMock::Twirp
 
-
 Gem::Specification.new do |s|
-  s.name        = package_name
-  s.version     = package.const_get "VERSION"
   s.authors     = ["Daniel Pepper"]
-  s.summary     = package.to_s
   s.description = "Twirp support for WebMock"
-  s.homepage    = "https://github.com/dpep/#{package_name}"
+  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.homepage    = "https://github.com/dpep/webmock-twirp"
   s.license     = "MIT"
-
-  s.files       = Dir[
-    __FILE__,
-    'lib/**/*',
-    'CHANGELOG*',
-    'LICENSE*',
-    'README*',
-  ]
+  s.name        = File.basename(__FILE__).split(".")[0]
+  s.summary     = package.to_s
+  s.version     = package.const_get "VERSION"
 
   s.add_dependency "webmock", ">= 3"
   s.add_dependency "twirp", ">= 1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock-twirp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-29 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -129,6 +129,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - lib/webmock-twirp.rb
@@ -143,6 +145,7 @@ files:
 - lib/webmock/twirp/request_stub.rb
 - lib/webmock/twirp/stub_request_snippet.rb
 - lib/webmock/twirp/version.rb
+- service.rb
 - webmock-twirp.gemspec
 homepage: https://github.com/dpep/webmock-twirp
 licenses:
@@ -166,5 +169,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Gem::Specification::WebMock::Twirp
+summary: WebMock::Twirp
 test_files: []