webmock-twirp 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165be6973cc98a0dcfb538746766610afa45c02a344bf3c79f0567c36ab92d4c
-  data.tar.gz: 65a3021683eff819b8a5e1ca6e54d8d4eed63ed9364fd2631cb5308772243ade
+  metadata.gz: 944a35bac7c3e752f543bc37f6d2b0a66a1a7f771022ac28c9c30ddba2e92891
+  data.tar.gz: db6bfad348186e05d483d6d09c485fd470679e3978fcca131e93d5fcee6649de
 SHA512:
-  metadata.gz: e5c02e2bfbe249a15af9aa36b1701e894550a330a72da318bec451a142e2d053ce40bc7c112e43057f1f216c8a0429dc3a670b8c112d136cd167ab482dbc9585
-  data.tar.gz: 6e1839bcd0cf51cb664cdda48408e8bcb89aec4dfbe60ba142cdd33f19b3462257ed56b5096fd9f338996257ec76b5121a2a8028f9e2ae848d2b1e79efd2d433
+  metadata.gz: 7b7fb99d4bf12cad35620ef9bb22bd7faabd626254c6e5a307b27da7478091eaf88256d0fc902cb507311312837c52ecc0b238796cedc0153674dbb34db69308
+  data.tar.gz: 8f4bf9c6f3b828843e2cc8167c4b47e7ccda55a56dda1c678f5b1cf7e2b0eba01207e71572d08e13004e7c031f5ef950160f61a907ffffefbbec862be7d1918b

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+###  v0.1.1  (2022-10-11)
+- test coverage
+- error messages
+- fix and_return alias
+- Update README.md
+
+###  v0.1.0  (2022-10-09)
+- dynamic client/rpc lookup
+
 ###  v0.0.1  (2022-10-07)
 - stub_twirp_request
 

data/README.md

@@ -2,27 +2,95 @@ WebMock::Twirp
 ======
 Twirp support for [WebMock](https://github.com/bblimke/webmock).  All our favorite http request stubbing for Twirp RPCs - message and error serialization done automatically.
 
+###  Install
+```ruby
+gem "webmock-twirp"
+```
 
+###  Example
 ```ruby
-require "webmock-twirp"
+require "webmock/twirp"
+
+it "stubs twirp calls" do 
+  stub_twirp_request
+  
+  client.my_rpc_method(request)
+end
 
-stub_twirp_request(MyTwirpClient, :optional_rpc_method)
+it "matches calls from specific twirp clients and rpc methods" do
+  stub_twirp_request(MyTwirpClient, :optional_rpc_method)
+end
 
-stub_twirp_request(...).with(my_request_message: /^foo/)
+# match parameters
+stub_twirp_request.with(my_request_message: /^foo/)
 
 # or use block mode
-stub_twirp_request(...).with do |request|
+stub_twirp_request.with do |request|
   request # the Twirp request, aka. proto message, used to initiate the request
   request.my_request_message == "hello"
 end
 
 
-stub_twirp_request(...).and_return(return_message: "yo yo")
-stub_twirp_request(...).and_return(404) # results in a Twirp::Error.not_found
+# stub responses
+stub_twirp_request.and_return(return_message: "yo yo")
+stub_twirp_request.and_return(404) # results in a Twirp::Error.not_found
 
 # or use block mode
-stub_twirp_request(...).and_return do |request|
-  { response_message: "oh hi" } # will get properly packaged up automagically
+stub_twirp_request.and_return do |request|
+  { response_message: "oh hi" } # will get properly packaged up
+end
+```
+
+
+## Usage
+
+### .with
+`stub_twirp_request.with` allows you to only stub requests which match specific attributes.  It accepts a hash or a `Google::Protobuf::MessageExts` instance.  The hash supports constants, regexes, and rspec matchers.
+
+```ruby
+stub_twirp_request.with(message: "hi")
+stub_twirp_request.with(message: /^h/)
+stub_twirp_request.with(message: include("i"))
+
+expected_request = MyTwirpRequest.new(message: "hi")
+stub_twirp_request.with(expected_request)
+```
+
+
+If you want even more control over the matching criteria, use the block mode.  A `Protobuf` instance is passed into the block with the request's parameters.
+
+```ruby
+stub_twirp_request.with do |request|
+  request.message == "hi"
+end
+```
+
+
+### .to_return
+`stub_twirp_request.to_return` allows you to specify a response, or use a default response.  It can be a hash or `Protobuf` instance.  To return an error, specify an error code, http status, or `Twirp::Error`.
+
+```ruby
+stub_twirp_request.to_return # ie. `MyTwirpResponse.new`
+
+stub_twirp_request.to_return(msg: "bye")
+
+response = MyTwirpResponse.new(msg: "bye")
+stub_twirp_request.to_return(response)
+
+# errors
+stub_twirp_request.to_return(:not_found)
+stub_twirp_request.to_return(404)
+stub_twirp_request.to_return(Twirp::Error.not_found("Nope"))
+```
+
+The block mode passes in the request Protobuf.
+```ruby
+stub_twirp_request.to_return do |request|
+  if request.message == "hi"
+    { msg: "bye" }
+  else
+    :not_found
+  end
 end
 ```
 

data/lib/webmock/twirp/refinements.rb

@@ -0,0 +1,11 @@
+module WebMock
+  module Twirp
+    module Refinements
+      refine Array do
+        def snag(&block)
+          find(&block)&.tap { |x| delete(x) }
+        end
+      end
+    end
+  end
+end

data/lib/webmock/twirp/request_stub.rb

@@ -1,29 +1,59 @@
 module WebMock
   module Twirp
     class RequestStub < WebMock::RequestStub
-      def initialize(client_or_service, rpc_name = nil)
-        klass = client_or_service.is_a?(Class) ? client_or_service : client_or_service.class
+      using Refinements
 
-        unless klass < ::Twirp::Client || klass < ::Twirp::Service
-          raise TypeError, "expected Twirp Client or Service, found: #{client_or_service}"
+      def initialize(*filters)
+        rpc_name = filters.snag { |x| x.is_a?(Symbol) }
+
+        client = filters.snag { |x| x.is_a?(::Twirp::Client) }
+
+        klass = client&.class
+        klass ||= filters.snag do |x|
+          x.is_a?(Class) && (x < ::Twirp::Client || x < ::Twirp::Service)
+        end
+
+        unless filters.empty?
+          raise ArgumentError, "unexpected arguments: #{filters}"
+        end
+
+        uri = ""
+
+        if client
+          conn = client.instance_variable_get(:@conn)
+          uri += conn.url_prefix.to_s if conn
         end
 
-        @rpcs = klass.rpcs
-        uri = "/#{klass.service_full_name}"
+        if klass
+          @rpcs = klass.rpcs
+          uri += "/#{klass.service_full_name}"
+        else
+          uri += "/[^/]+"
+        end
 
         if rpc_name
-          rpc_info = rpcs.values.find do |x|
-            x[:rpc_method] == rpc_name.to_sym || x[:ruby_method] == rpc_name.to_sym
-          end
+          if klass
+            # kindly convert ruby method to rpc method name
+            rpc_info = klass.rpcs.values.find do |x|
+              x[:rpc_method] == rpc_name || x[:ruby_method] == rpc_name
+            end
 
-          raise ArgumentError, "invalid rpc method: #{rpc_name}" unless rpc_info
+            raise ArgumentError, "invalid rpc method: #{rpc_name}" unless rpc_info
 
-          uri += "/#{rpc_info[:rpc_method]}"
+            uri += "/#{rpc_info[:rpc_method]}"
+          else
+            uri += "/#{rpc_name}"
+          end
         else
           uri += "/[^/]+"
         end
 
         super(:post, /#{uri}$/)
+
+        # filter on Twirp header
+        @request_pattern.with(
+          headers: { "Content-Type" => ::Twirp::Encoding::PROTO },
+        )
       end
 
       def with(request = nil, **attrs, &block)
@@ -87,6 +117,7 @@ module WebMock
 
         super(*response_hashes, &decoder)
       end
+      alias_method :and_return, :to_return # update existing alias
 
       def to_return_json(*)
         raise NotImplementedError
@@ -94,10 +125,24 @@ module WebMock
 
       private
 
-      attr_reader :rpcs
-
       def rpc_from_request(request_signature)
-        rpcs[request_signature.uri.path.split("/").last]
+        service_full_name, rpc_name = request_signature.uri.path.split("/").last(2)
+
+        rpcs = @rpcs || begin
+          # find matching client instance
+          client = ObjectSpace.each_object(::Twirp::Client).find do |client|
+            service_full_name == client.class.service_full_name && \
+              client.class.rpcs.key?(rpc_name)
+          end
+
+          unless client
+            raise "could not determine Twirp::Client for call to: #{service_full_name}/#{rpc_name}"
+          end
+
+          client.class.rpcs
+        end
+
+        rpcs[rpc_name]
       end
 
       def generate_http_response(msg_class, obj)
@@ -124,10 +169,10 @@ module WebMock
           if code = ::Twirp::ERROR_CODES_TO_HTTP_STATUS.key(obj)
             ::Twirp::Error.new(code, code)
           else
-            raise ArgumentError, "invalid error code: #{obj}"
+            raise ArgumentError, "invalid http error status: #{obj}"
           end
         else
-          raise NotImplementedError
+          raise ArgumentError, "can not generate twirp reponse from: #{obj}"
         end
 
         if res.is_a?(Google::Protobuf::MessageExts)

data/lib/webmock/twirp/version.rb

@@ -1,5 +1,5 @@
 module WebMock
   module Twirp
-    VERSION = "0.0.1"
+    VERSION = "0.1.1"
   end
 end

data/lib/webmock/twirp.rb

@@ -1,6 +1,7 @@
 require "google/protobuf"
 require "twirp"
 require "webmock"
+require "webmock/twirp/refinements"
 require "webmock/twirp/request_stub"
 require "webmock/twirp/version"
 
@@ -30,8 +31,7 @@ if $LOADED_FEATURES.find { |x| x =~ %r{/webmock/rspec.rb} }
   # require "webmock/rspec"
   RSpec.configure { |c| c.include WebMock::Twirp::API }
 else
-  # patch Webmock to also export stub_twirp_request
-
+  # patch WebMock to also export stub_twirp_request
   module WebMock
     module API
       include WebMock::Twirp::API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock-twirp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-08 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -105,6 +105,7 @@ files:
 - README.md
 - lib/webmock-twirp.rb
 - lib/webmock/twirp.rb
+- lib/webmock/twirp/refinements.rb
 - lib/webmock/twirp/request_stub.rb
 - lib/webmock/twirp/version.rb
 - webmock-twirp.gemspec