webmock-twirp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 961de376102cbbb75708a544bb34e42c065beab4ad92ef4e4441036d47569d1d
-  data.tar.gz: 0de10400686561ba24d597d06ea23c4b77ca3445af78c7f7a98997e1bd32d86c
+  metadata.gz: 944a35bac7c3e752f543bc37f6d2b0a66a1a7f771022ac28c9c30ddba2e92891
+  data.tar.gz: db6bfad348186e05d483d6d09c485fd470679e3978fcca131e93d5fcee6649de
 SHA512:
-  metadata.gz: e1edcd51eff12eb65d75dd96713ff202410447cdd9ef3ddfbf1fff7c090cc94d370ec381a6bf4966b7e1cd0034c59552f1ed1953e498f7b24b06df4bf1beaad9
-  data.tar.gz: b6a646485bc5d8a49f27229cddfc55d3045fb000a0d0186ed03216dbd8436331186d058dcd4257ca15ee5d6ebd757026d7fb5a9fb4be69f4c1d512e4efd0286e
+  metadata.gz: 7b7fb99d4bf12cad35620ef9bb22bd7faabd626254c6e5a307b27da7478091eaf88256d0fc902cb507311312837c52ecc0b238796cedc0153674dbb34db69308
+  data.tar.gz: 8f4bf9c6f3b828843e2cc8167c4b47e7ccda55a56dda1c678f5b1cf7e2b0eba01207e71572d08e13004e7c031f5ef950160f61a907ffffefbbec862be7d1918b

data/CHANGELOG.md

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

data/README.md

@@ -2,7 +2,12 @@ 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"
 
@@ -37,6 +42,59 @@ 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
+```
+
+
 ----
 ## Contributing
 

data/lib/webmock/twirp/request_stub.rb

@@ -117,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
@@ -168,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.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/webmock/twirp.rb

@@ -31,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.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock