rspec-twirp 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2634a27685c93991e30afab03cf80cb5fe650047a2b91342eeadff69a7bb920e
-  data.tar.gz: f87529044e688df0b546e65cd527989842e983576bf62a70ea7aabf72d920d09
+  metadata.gz: 8a706ac42abbda25e9b6928b76a21b328fcd42809228d072e5a235e18f824970
+  data.tar.gz: a9792cfc6fb182a13e368a73755de2680a83d2884d258b68f1b4f97050a4cc74
 SHA512:
-  metadata.gz: 01e6fbab6f8649f6c8dbcc8df72269699e099eb1d924d6ff6656781d5339d060c6138e465a5c43b5ec2a9320614d7924bed1c79eac088c9c10f881d99c6588d7
-  data.tar.gz: ce566d5fd9e1e91cca7a100d205e4a1b0615c743f808383d5180bd007049aeaaaf1298bfe382ad6e0385404dd3c04fadb5980ac53fbc9de54c9aeee335b4834b
+  metadata.gz: 80b17dd294a3b9a003fd6ee9976caefa4fa8a79191aecc6589f2f04f547853111cfbeba1c2f12ce50709b323740ca6554e07cbb5454bec4d8178c0ce555ca891
+  data.tar.gz: b47c5786903745444d2eb92bfdc08f1c45b2c531d42b23a89179a5c3a0b77bbcc4462fe170e21322379eb1b4028728f270e358ef079b9d5a70ab10eac194ef2b

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+###  v0.3.1  (2022-12-15)
+- simplify dependencies
+- action permissions
+- dependabot automation
+- lockfile
+- builds
+
+###  v0.3.0  (2022-11-16)
+- diffable error matching
+- extract request stubbing
+
+###  v0.2.0  (2022-10-06)
+- ruby 3 fixes
+- mock_client
+- improved make_request spec
+- upgrade mock connection
+- inline request matcher
+- request matcher and_return
+- make request matcher
+- mock_twirp_connection
+- twirp message matcher simplification
+
+###  v0.1.0  (2022-09-24)
+- Update README.md
+- client response matcher
+- improved fail messages
+- response matcher
+- error matcher
+- improve regex match
+- be_a_twirp_request
+
+###  v0.0.1  (2022-05-24)
+- init
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    rspec-twirp (0.3.0)
+      google-protobuf (>= 3)
+      rspec-expectations (>= 3)
+      rspec-protobuf (>= 0.2)
+      twirp (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    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)
+    multipart-post (2.2.3)
+    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-protobuf (0.2.2)
+      google-protobuf (>= 3)
+      rspec-expectations (>= 3)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  codecov
+  rspec (>= 3)
+  rspec-twirp!
+  simplecov
+
+BUNDLED WITH
+   2.3.9

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,43 @@
+RSpec::Twirp
+======
+![Gem](https://img.shields.io/gem/dt/rspec-twirp?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/rspec-twirp/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rspec-twirp)
+
+Twirp RSpec matchers.
+
+
+```ruby
+require "rspec/twirp"
+
+it "matches Twirp responses" do
+  is_expected.to be_a_twirp_response
+  is_expected.to be_a_twirp_response(count: 3)
+  is_expected.to be_a_twirp_response.with_error(:not_found)
+end
+
+it "matches Twirp messages" do
+  is_expected.to be_a_twirp_message
+  is_expected.to be_a_twirp_message(MyRequest)
+  is_expected.to be_a_twirp_message(name: /^B/)
+end
+
+it "matches Twirp errors" do
+  is_expected.to be_a_twirp_error
+  is_expected.to be_a_twirp_error(:internal)
+end
+```
+
+To stub Twirp requests, see [webmock-twirp](https://github.com/dpep/webmock-twirp).
+
+
+----
+## 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

data/lib/rspec/twirp/error_matcher.rb

@@ -1,43 +1,59 @@
 RSpec::Matchers.define :be_a_twirp_error do |*matchers, **meta_matcher|
   match do |actual|
-    @fail_msg = "Expected #{actual} to be a Twirp::Error, found #{actual.class}"
+    @fail_msg = "Expected `#{actual}` to be a Twirp::Error, found: #{actual.class}"
     return false unless actual.is_a?(Twirp::Error)
 
-    matchers.each do |matcher|
+    @expected = {}
+    @actual = {}
+
+    matched = matchers.all? do |matcher|
       case matcher
       when Symbol
         # match code
+        @expected[:code] = matcher
+        @actual[:code] = actual.code
 
         unless Twirp::Error.valid_code?(matcher)
           raise ArgumentError, "invalid error code: #{matcher.inspect}"
         end
 
-        @fail_msg = "Expected #{actual} to have code: #{matcher.inspect}, found #{actual.code}"
-        return false unless actual.code == matcher
+        @fail_msg = "Expected #{actual} to have code `#{matcher.inspect}`, found: #{actual.code.inspect}"
+        actual.code == matcher
       when Integer
         # match http status code
 
         if code = Twirp::ERROR_CODES_TO_HTTP_STATUS.key(matcher)
-          @fail_msg = "Expected #{actual} to have status: #{matcher}, found #{actual.code}"
-          return false unless actual.code == code
+          @expected[:code] = code
+          @actual[:code] = actual.code
+
+          actual_status = Twirp::ERROR_CODES_TO_HTTP_STATUS[actual.code]
+
+          @fail_msg = "Expected #{actual} to have status #{matcher} / #{code.inspect}, found: #{actual_status} / #{actual.code.inspect}"
+          actual.code == code
         else
           raise ArgumentError, "invalid error status code: #{matcher}"
         end
       when Twirp::Error
         # match instance
+        @expected = matcher.to_h
+        @actual = actual.to_h
 
         @fail_msg = "Expected #{actual} to equal #{matcher}"
-        return false unless values_match?(matcher.to_h, actual.to_h)
+        values_match?(matcher.to_h, actual.to_h)
       else
         # match msg
-        @fail_msg = "Expected #{actual} to have msg: #{matcher.inspect}, found #{actual.msg}"
-        return false unless values_match?(matcher, actual.msg)
+        @expected[:msg] = matcher
+        @actual[:msg] = actual.msg
+
+        @fail_msg = "Expected #{actual} to have msg #{matcher.inspect}, found: #{actual.msg.inspect}"
+        values_match?(matcher, actual.msg)
       end
     end
 
     # match meta
     unless meta_matcher.empty?
-      @cur_match = { meta: meta_matcher }
+      @expected[:meta] = meta_matcher
+      @actual[:meta] = actual.meta
 
       # sanity check...values must be Strings or Regexp
       discrete_attrs = meta_matcher.transform_values do |attr|
@@ -46,10 +62,10 @@ RSpec::Matchers.define :be_a_twirp_error do |*matchers, **meta_matcher|
       actual.send(:validate_meta, discrete_attrs)
 
       @fail_msg = "Expected #{actual} to have meta: #{meta_matcher.inspect}, found #{actual.meta}"
-      return false unless values_match?(meta_matcher, actual.meta)
+      matched &= values_match?(meta_matcher, actual.meta)
     end
 
-    true
+    matched
   end
 
   description do
@@ -57,6 +73,12 @@ RSpec::Matchers.define :be_a_twirp_error do |*matchers, **meta_matcher|
   end
 
   failure_message { @fail_msg }
+
+  diffable
+
+  def expected
+    @expected
+  end
 end
 
 RSpec::Matchers.alias_matcher :a_twirp_error, :be_a_twirp_error

data/lib/rspec/twirp/message_matcher.rb

@@ -1,61 +1,2 @@
-RSpec::Matchers.define :be_a_twirp_message do |type = nil, **attrs|
-  match do |actual|
-    # ensure type is a valid twirp message type
-    if type && !(type < Google::Protobuf::MessageExts)
-      raise TypeError, "Expected `type` to be a Google::Protobuf::MessageExts, found: #{type}"
-    end
-
-    @fail_msg = "Expected a Twirp message, found #{actual}"
-    return false unless actual.is_a?(Google::Protobuf::MessageExts)
-
-    # match expected message type
-    @fail_msg = "Expected a Twirp message of type #{type}, found #{actual.class}"
-    return false if type && actual.class != type
-
-    return true if attrs.empty?
-
-    # sanity check inputs
-    validate_types(attrs, actual.class)
-
-    # match attributes which are present
-    attrs.each do |attr_name, expected_attr|
-      actual_attr = actual.send(attr_name)
-
-      @fail_msg = "Expected #{actual} to have #{attr_name}: #{expected_attr.inspect}, found #{actual_attr}"
-      return false unless values_match?(expected_attr, actual_attr)
-    end
-
-    true
-  end
-
-  description do
-    type ? "a #{type} Twirp message" : "a Twirp message"
-  end
-
-  failure_message { @fail_msg }
-
-  private
-
-  def validate_types(attrs, klass)
-    # check names and types of attrs by constructing an actual proto object
-    discrete_attrs = attrs.transform_values do |attr|
-      case attr
-      when Regexp
-        attr.inspect
-      when Range
-        attr.first
-      when RSpec::Matchers::BuiltIn::BaseMatcher
-        # no good substitute, so skip attr and hope for the best
-        nil
-      else
-        attr
-      end
-    end.compact
-
-    klass.new(**discrete_attrs)
-  rescue Google::Protobuf::TypeError => e
-    raise TypeError, e.message
-  end
-end
-
-RSpec::Matchers.alias_matcher :a_twirp_message, :be_a_twirp_message
+RSpec::Matchers.alias_matcher :be_a_twirp_message, :be_a_protobuf
+RSpec::Matchers.alias_matcher :a_twirp_message, :a_protobuf

data/lib/rspec/twirp/response_matcher.rb

@@ -1,31 +1,13 @@
-RSpec::Matchers.define :be_a_twirp_response do |type = nil, **attrs|
+RSpec::Matchers.define :be_a_twirp_response do |**attrs|
   chain :with_error do |*matchers, **meta_matchers|
     # code, msg, meta
     @with_error = [ matchers, meta_matchers ]
   end
 
   match do |actual|
-    # ensure type is a valid twirp request type
-    if type
-      if type.is_a?(Google::Protobuf::MessageExts)
-        unless attrs.empty?
-          raise ArgumentError, "Expected Google::Protobuf::MessageExts instance or attrs, but not both"
-        end
-
-        attrs = type.to_h
-        type = type.class
-      elsif !(type < Google::Protobuf::MessageExts)
-        raise ArgumentError, "Expected `type` to be a Google::Protobuf::MessageExts, found: #{type}"
-      end
-    end
-
     @fail_msg = "Expected a Twirp::ClientResp, found #{actual}"
     return false unless actual.is_a?(Twirp::ClientResp)
 
-    # match expected response type
-    @fail_msg = "Expected a Twirp::ClientResp of type #{type}, found #{actual.data&.class}"
-    return false if type && actual.data&.class != type
-
     if @with_error
       unless attrs.empty?
         raise ArgumentError, "match data attributes or error, but not both"
@@ -48,7 +30,7 @@ RSpec::Matchers.define :be_a_twirp_response do |type = nil, **attrs|
   end
 
   description do
-    type ? "a #{type} Twirp response" : "a Twirp response"
+    "a Twirp response"
   end
 
   failure_message { @fail_msg }

data/lib/rspec/twirp/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Twirp
-    VERSION = "0.2.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/rspec/twirp.rb

@@ -1,54 +1,9 @@
 require "google/protobuf"
-require "rspec"
+require "rspec/expectations"
+require "rspec/protobuf"
 require "twirp"
 
-require "rspec/twirp/helpers"
-require "rspec/twirp/make_request_matcher"
 require "rspec/twirp/error_matcher"
 require "rspec/twirp/message_matcher"
 require "rspec/twirp/response_matcher"
-
-module RSpec
-  module Twirp
-    extend RSpec::Mocks::ExampleMethods
-
-    # private
-
-    def generate_client_response(arg)
-      res = case arg
-      when Google::Protobuf::MessageExts, ::Twirp::Error
-        arg
-      when Class
-        if arg < Google::Protobuf::MessageExts
-          arg.new
-        else
-          raise TypeError, "Expected type `Google::Protobuf::MessageExts`, found: #{arg}"
-        end
-      when Symbol
-        if ::Twirp::Error.valid_code?(arg)
-          ::Twirp::Error.new(arg, arg)
-        else
-          raise ArgumentError, "invalid error code: #{arg}"
-        end
-      when Integer
-        if code = ::Twirp::ERROR_CODES_TO_HTTP_STATUS.key(arg)
-          ::Twirp::Error.new(code, code)
-        else
-          raise ArgumentError, "invalid error code: #{arg}"
-        end
-      else
-        raise NotImplementedError
-      end
-
-      if res.is_a?(Google::Protobuf::MessageExts)
-        ::Twirp::ClientResp.new(res, nil)
-      else
-        ::Twirp::ClientResp.new(nil, res)
-      end
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include(RSpec::Twirp::Helpers)
-end
+require "rspec/twirp/version"

data/rspec-twirp.gemspec

@@ -0,0 +1,23 @@
+require_relative "lib/rspec/twirp/version"
+package = RSpec::Twirp
+
+Gem::Specification.new do |s|
+  s.authors     = ["Daniel Pepper"]
+  s.description = "Twirp RSpec matchers"
+  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.homepage    = "https://github.com/dpep/rspec-twirp"
+  s.license     = "MIT"
+  s.name        = File.basename(__FILE__).split(".")[0]
+  s.summary     = package.to_s
+  s.version     = package.const_get "VERSION"
+
+  s.add_dependency "google-protobuf", ">= 3"
+  s.add_dependency "rspec-expectations", ">= 3"
+  s.add_dependency "rspec-protobuf", ">= 0.2"
+  s.add_dependency "twirp", ">= 1"
+
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "codecov"
+  s.add_development_dependency "rspec", ">= 3"
+  s.add_development_dependency "simplecov"
+end

data/service.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require "google/protobuf"
+require "rack"
+require "twirp"
+require "webrick"
+require "./spec/support/hello_world"
+
+server = WEBrick::HTTPServer.new(Port: 3000)
+
+handler = HelloWorldHandler.new
+service = HelloWorldService.new(handler)
+path_prefix = "/twirp/" + service.full_name
+server.mount path_prefix, Rack::Handler::WEBrick, service
+
+handler = GoodbyeHandler.new
+service = GoodbyeService.new(handler)
+path_prefix = "/twirp/" + service.full_name
+server.mount path_prefix, Rack::Handler::WEBrick, service
+
+server.start
+
+# client = HelloWorldClient.new("http://localhost:3000/twirp")
+# client = GoodbyeClient.new("http://localhost:3000/twirp")
+# resp = client.hello(name: "World")
+# puts resp.data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-twirp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: twirp
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,28 +122,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "..."
+description: Twirp RSpec matchers
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
 - lib/rspec-twirp.rb
 - lib/rspec/twirp.rb
 - lib/rspec/twirp/error_matcher.rb
-- lib/rspec/twirp/helpers.rb
-- lib/rspec/twirp/make_request_matcher.rb
 - lib/rspec/twirp/message_matcher.rb
-- lib/rspec/twirp/mock_client.rb
-- lib/rspec/twirp/mock_connection.rb
 - lib/rspec/twirp/response_matcher.rb
 - lib/rspec/twirp/version.rb
-- spec/error_spec.rb
-- spec/make_request_spec.rb
-- spec/message_spec.rb
-- spec/mock_connection_spec.rb
-- spec/response_spec.rb
-homepage: https://github.com/dpep/rspec-twirp_rb
+- rspec-twirp.gemspec
+- service.rb
+homepage: https://github.com/dpep/rspec-twirp
 licenses:
 - MIT
 metadata: {}
@@ -137,10 +163,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Gem::Specification::RSpec::Twirp
-test_files:
-- spec/error_spec.rb
-- spec/make_request_spec.rb
-- spec/message_spec.rb
-- spec/mock_connection_spec.rb
-- spec/response_spec.rb
+summary: RSpec::Twirp
+test_files: []

data/lib/rspec/twirp/helpers.rb

@@ -1,16 +0,0 @@
-require "rspec/twirp/mock_client"
-require "rspec/twirp/mock_connection"
-
-module RSpec
-  module Twirp
-    module Helpers
-      def mock_twirp_connection(...)
-        RSpec::Twirp.mock_connection(...)
-      end
-
-      def mock_twirp_client(...)
-        RSpec::Twirp.mock_client(...)
-      end
-    end
-  end
-end