webmock-twirp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 165be6973cc98a0dcfb538746766610afa45c02a344bf3c79f0567c36ab92d4c
+  data.tar.gz: 65a3021683eff819b8a5e1ca6e54d8d4eed63ed9364fd2631cb5308772243ade
+SHA512:
+  metadata.gz: e5c02e2bfbe249a15af9aa36b1701e894550a330a72da318bec451a142e2d053ce40bc7c112e43057f1f216c8a0429dc3a670b8c112d136cd167ab482dbc9585
+  data.tar.gz: 6e1839bcd0cf51cb664cdda48408e8bcb89aec4dfbe60ba142cdd33f19b3462257ed56b5096fd9f338996257ec76b5121a2a8028f9e2ae848d2b1e79efd2d433

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+###  v0.0.1  (2022-10-07)
+- stub_twirp_request
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Daniel Pepper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+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.
+
+
+```ruby
+require "webmock-twirp"
+
+stub_twirp_request(MyTwirpClient, :optional_rpc_method)
+
+stub_twirp_request(...).with(my_request_message: /^foo/)
+
+# or use block mode
+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
+
+# or use block mode
+stub_twirp_request(...).and_return do |request|
+  { response_message: "oh hi" } # will get properly packaged up automagically
+end
+```
+
+
+----
+## Contributing
+
+Yes please  :)
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-feature`)
+1. Ensure the tests pass (`bundle exec rspec`)
+1. Commit your changes (`git commit -am 'awesome new feature'`)
+1. Push your branch (`git push origin my-feature`)
+1. Create a Pull Request
+
+
+----
+![Gem](https://img.shields.io/gem/dt/webmock-twirp?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/webmock-twirp/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/webmock-twirp)

data/lib/webmock/twirp/request_stub.rb

@@ -0,0 +1,149 @@
+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
+
+        unless klass < ::Twirp::Client || klass < ::Twirp::Service
+          raise TypeError, "expected Twirp Client or Service, found: #{client_or_service}"
+        end
+
+        @rpcs = klass.rpcs
+        uri = "/#{klass.service_full_name}"
+
+        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
+
+          raise ArgumentError, "invalid rpc method: #{rpc_name}" unless rpc_info
+
+          uri += "/#{rpc_info[:rpc_method]}"
+        else
+          uri += "/[^/]+"
+        end
+
+        super(:post, /#{uri}$/)
+      end
+
+      def with(request = nil, **attrs, &block)
+        unless request.nil? || attrs.empty?
+          raise ArgumentError, "specify request or attrs, but not both"
+        end
+
+        request_matcher = if request
+          unless request.is_a?(Google::Protobuf::MessageExts)
+            raise TypeError, "Expected request to be Protobuf::MessageExts, found: #{request}"
+          end
+
+          { body: request.to_proto }
+        end
+
+        decoder = ->(request) do
+          input_class = rpc_from_request(request)[:input_class]
+
+          matched = true
+          decoded_request = input_class.decode(request.body)
+
+          if attrs.any?
+            attr_matcher = Matchers::HashIncludingMatcher.new(**attrs)
+            attr_hash = WebMock::Util::HashKeysStringifier.stringify_keys!(decoded_request.to_h, deep: true)
+
+            matched &= attr_matcher === attr_hash
+          end
+
+          if block
+            matched &= block.call(decoded_request)
+          end
+
+          matched
+        end if attrs.any? || block_given?
+
+        super(request_matcher || {}, &decoder)
+      end
+
+      def to_return(*responses, &block)
+        unless responses.empty? || block.nil?
+          raise ArgumentError, "specify responses or block, but not both"
+        end
+
+        # if no args, provide default response
+        responses << nil if responses.empty? && block.nil?
+
+        response_hashes = responses.map do |response|
+          ->(request) do
+            # determine msg type and package response
+            output_class = rpc_from_request(request)[:output_class]
+            generate_http_response(output_class, response)
+          end
+        end
+
+        decoder = ->(request) do
+          # determine msg type and call provided block
+          rpc = rpc_from_request(request)
+          res = block.call(rpc[:input_class].decode(request.body))
+          generate_http_response(rpc[:output_class], res)
+        end if block_given?
+
+        super(*response_hashes, &decoder)
+      end
+
+      def to_return_json(*)
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :rpcs
+
+      def rpc_from_request(request_signature)
+        rpcs[request_signature.uri.path.split("/").last]
+      end
+
+      def generate_http_response(msg_class, obj)
+        res = case obj
+        when nil
+          msg_class.new
+        when Hash
+          msg_class.new(**obj)
+        when Google::Protobuf::MessageExts
+          unless obj.is_a?(msg_class)
+            raise TypeError, "Expected type #{msg_class}, found #{obj}"
+          end
+
+          obj
+        when ::Twirp::Error
+          obj
+        when Symbol
+          if ::Twirp::Error.valid_code?(obj)
+            ::Twirp::Error.new(obj, obj)
+          else
+            raise ArgumentError, "invalid error code: #{obj}"
+          end
+        when Integer
+          if code = ::Twirp::ERROR_CODES_TO_HTTP_STATUS.key(obj)
+            ::Twirp::Error.new(code, code)
+          else
+            raise ArgumentError, "invalid error code: #{obj}"
+          end
+        else
+          raise NotImplementedError
+        end
+
+        if res.is_a?(Google::Protobuf::MessageExts)
+          {
+            status: 200,
+            headers: { "Content-Type" => ::Twirp::Encoding::PROTO },
+            body: res.to_proto,
+          }
+        else # Twirp::Error
+          {
+            status: ::Twirp::ERROR_CODES_TO_HTTP_STATUS[res.code],
+            headers: { "Content-Type" => ::Twirp::Encoding::JSON },
+            body: ::Twirp::Encoding.encode_json(res.to_h),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/webmock/twirp/version.rb

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

data/lib/webmock/twirp.rb

@@ -0,0 +1,40 @@
+require "google/protobuf"
+require "twirp"
+require "webmock"
+require "webmock/twirp/request_stub"
+require "webmock/twirp/version"
+
+
+module WebMock
+  module Twirp
+    extend self
+
+    private
+
+    module API
+      def stub_twirp_request(...)
+        WebMock::StubRegistry.instance.register_request_stub(
+          WebMock::Twirp::RequestStub.new(...),
+        )
+      end
+
+      # def a_twirp_request(uri)
+      #   WebMock::RequestPattern.new(:post, uri)
+      # end
+    end
+  end
+end
+
+
+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
+
+  module WebMock
+    module API
+      include WebMock::Twirp::API
+    end
+  end
+end

data/lib/webmock-twirp.rb

@@ -0,0 +1 @@
+require "webmock/twirp"

data/webmock-twirp.gemspec

@@ -0,0 +1,31 @@
+package_name = File.basename(__FILE__).split(".")[0]
+load Dir.glob("lib/**/version.rb")[0]
+
+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.license     = "MIT"
+
+  s.files       = Dir[
+    __FILE__,
+    'lib/**/*',
+    'CHANGELOG*',
+    'LICENSE*',
+    'README*',
+  ]
+
+  s.add_dependency "webmock", ">= 3"
+  s.add_dependency "twirp", ">= 1"
+
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "codecov"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: webmock-twirp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Pepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: twirp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Twirp support for WebMock
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/webmock-twirp.rb
+- lib/webmock/twirp.rb
+- lib/webmock/twirp/request_stub.rb
+- lib/webmock/twirp/version.rb
+- webmock-twirp.gemspec
+homepage: https://github.com/dpep/webmock-twirp
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Gem::Specification::WebMock::Twirp
+test_files: []