webmock-twirp 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a34362dd929abe47a175e407335cc6f94a307c00fd902742d06285550fcd78
-  data.tar.gz: efefa4e116a259eeab30129f7afe2b803f682daf0e0c15785e48720c5efe5d70
+  metadata.gz: 292380b89f2b938b849edb2e4ce46cb84e197b6a39592d16425440446adce9a1
+  data.tar.gz: 64be8b4452a96b256adc5bfe9d08a479392d9cb916f4fe0ab1135cc763728f87
 SHA512:
-  metadata.gz: 04c11a624eb11547a7d0df20fcddd5b40015e75b6af94311e764484d98bc1333ffd728b085e0b5a29b08b4b039945d209a7ae74a9312bd0b65d9bebdcf87e43c
-  data.tar.gz: 2179804f8df26c7c65d17781cd0a4df2c5c9806697e97c1f794f2bb008a5d5febdad89522df69b853ddfd6d2a869092b8dc572a5f5ac500fb5db3a5e30995215
+  metadata.gz: c4f52185995140dc0d2aa2646227bbd9195a87941a1ab40a20d6e1dfb1b29bf24c9b0a50796db26fecd453f802fecc5bd5003eee284f325ccea3a96bf4f152a6
+  data.tar.gz: fa2e3ed00ed69f960dae3c500979fc8a745cd6e78015c68d6b963ee85ffad842070855abcdd8d50e6f37263f2789ead2f231d50092698c496bd0e4e5b8251970

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+###  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/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/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

data/lib/webmock/twirp/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock-twirp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-29 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock