rspec-twirp 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a9027f86450d9e045705304d1d8e590b51a733269938e83ca5ae098a90018d4
-  data.tar.gz: dca42845c93b814878cf24842320583ddf6dbce3b0d266cd897a58500cf31a31
+  metadata.gz: 8a706ac42abbda25e9b6928b76a21b328fcd42809228d072e5a235e18f824970
+  data.tar.gz: a9792cfc6fb182a13e368a73755de2680a83d2884d258b68f1b4f97050a4cc74
 SHA512:
-  metadata.gz: 98d362457d71269cf64bffa1fe0b1fe00e173fe68df88e12cf0af20aa1030d518e031415d005050209b070095c36a6eac454e1bdba740661a090ce3be90cfa15
-  data.tar.gz: a0923b782b8568198fb267cd1e3bc6192bb032b0a7e746be478a4e8d66317ccc81652487f6f3b442847c6c2946b2e398f25b60682c0cc6b1c794c556837d0978
+  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/version.rb

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

data/lib/rspec/twirp.rb

@@ -1,5 +1,5 @@
 require "google/protobuf"
-require "rspec"
+require "rspec/expectations"
 require "rspec/protobuf"
 require "twirp"
 

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.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-16 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:
     - - ">="
@@ -94,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
@@ -114,16 +128,20 @@ 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/message_matcher.rb
 - lib/rspec/twirp/response_matcher.rb
 - lib/rspec/twirp/version.rb
-- spec/error_spec.rb
-- spec/message_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: {}
@@ -145,8 +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/message_spec.rb
-- spec/response_spec.rb
+summary: RSpec::Twirp
+test_files: []

data/spec/error_spec.rb

@@ -1,159 +0,0 @@
-describe "be_a_twirp_error" do
-  subject(:error) { Twirp::Error.new(code, msg, meta) }
-
-  let(:code) { :not_found }
-  let(:msg) { "Not Found" }
-  let(:meta) { { is_meta: "true" } }
-
-  it { is_expected.to be_a_twirp_error }
-
-  it "is composable" do
-    expect(e: error).to include(e: a_twirp_error)
-  end
-
-  it "catches type mismatches" do
-    expect {
-      expect(Object).to be_a_twirp_error
-    }.to fail_with /to be a Twirp::Error/
-  end
-
-  describe "status matches" do
-    it { is_expected.to be_a_twirp_error(404) }
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_error(400)
-      }.to fail_including(
-        "to have status 400",
-        "found: 404",
-
-        # diff
-        "-:code => :invalid_argument,",
-        "+:code => :not_found,",
-      )
-    end
-
-    it "catches erroneous codes" do
-      expect {
-        is_expected.to be_a_twirp_error(123)
-      }.to raise_error(ArgumentError, /invalid error/)
-    end
-  end
-
-  describe "code matches" do
-    it { is_expected.to be_a_twirp_error(:not_found) }
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_error(:unknown)
-      }.to fail_including(
-        "to have code `:unknown`",
-        "found: :not_found",
-
-        # diff
-        "-:code => :unknown,",
-        "+:code => :not_found,",
-      )
-    end
-
-    it "catches erroneous codes" do
-      expect {
-        is_expected.to be_a_twirp_error(:not_a_valid_code)
-      }.to raise_error(ArgumentError, /:not_a_valid_code/)
-    end
-  end
-
-  describe "msg matches" do
-    it { is_expected.to be_a_twirp_error("Not Found") }
-
-    it "supports Regex matches" do
-      is_expected.to be_a_twirp_error(/Not/)
-    end
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_error("Not")
-      }.to fail_including(
-        'to have msg "Not"',
-        'found: "Not Found"',
-
-        # diff
-        '-:msg => "Not",',
-        '+:msg => "Not Found",',
-      )
-
-      expect {
-        is_expected.to be_a_twirp_error(/Nope/)
-      }.to fail_including(
-        # diff
-        '-:msg => /Nope/,',
-        '+:msg => "Not Found",',
-      )
-    end
-  end
-
-  describe "meta matches" do
-    it { is_expected.to be_a_twirp_error(is_meta: "true") }
-    it { is_expected.to be_a_twirp_error(is_meta: /^t/) }
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_error(is_meta: "false")
-      }.to fail_including(
-        "to have meta",
-
-        # diff
-        '-:meta => {:is_meta=>"false"},',
-        '+:meta => {:is_meta=>"true"},',
-      )
-
-      expect {
-        is_expected.to be_a_twirp_error(not_meta: "")
-      }.to fail_with /to have meta.*not_meta/
-    end
-
-    it "catches type errors" do
-      expect {
-        is_expected.to be_a_twirp_error(is_meta: true)
-      }.to raise_error(ArgumentError, /meta values must be Strings/)
-    end
-  end
-
-  describe "instance matches" do
-    it "matches similar looking instances" do
-      error = Twirp::Error.new(code, msg, meta)
-      is_expected.to be_a_twirp_error(error)
-    end
-
-    it "catches mismatches" do
-      # no meta
-      expect {
-        is_expected.to be_a_twirp_error(Twirp::Error.not_found("Not Found"))
-      }.to fail
-
-      expect {
-        is_expected.to be_a_twirp_error(Twirp::Error.internal("boom"))
-      }.to fail
-    end
-  end
-
-  describe "multi matches" do
-    it { is_expected.to be_a_twirp_error(:not_found, "Not Found") }
-    it { is_expected.to be_a_twirp_error(:not_found, /Not/) }
-    it { is_expected.to be_a_twirp_error(:not_found, is_meta: "true") }
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_error(:unknown, "Not Found")
-      }.to fail_with /unknown/
-
-      expect {
-        is_expected.to be_a_twirp_error(:not_found, "Nope")
-      }.to fail_with /Nope/
-
-      expect {
-        is_expected.to be_a_twirp_error(:not_found, is_meta: "false")
-      }.to fail_with /false/
-    end
-  end
-end

data/spec/message_spec.rb

@@ -1,69 +0,0 @@
-describe "be_a_twirp_message" do
-  subject(:request) { HelloRequest.new(**attrs) }
-
-  let(:attrs) { {} }
-
-  it { is_expected.to be_a_twirp_message }
-
-  it "works with responses also" do
-    expect(HelloResponse.new).to be_a_twirp_message
-  end
-
-  it "supports compound matchers" do
-    expect([ request ]).to include(a_twirp_message)
-  end
-
-  it "does not match non-twirp subjects" do
-    expect(Object).not_to be_a_twirp_message
-  end
-
-  it "matches a specific message type" do
-    is_expected.to be_a_twirp_message(HelloRequest)
-  end
-
-  it "catches type mismatches" do
-    is_expected.not_to be_a_twirp_message(GoodbyeRequest)
-  end
-
-  it "catches erroneous message types" do
-    expect {
-      is_expected.to be_a_twirp_message(Object)
-    }.to raise_error(TypeError, /Object/)
-  end
-
-  context "with attributes" do
-    let(:attrs) { { name: "Bob", count: 3 } }
-
-    it "can match attributes" do
-      is_expected.to be_a_twirp_message(HelloRequest, **attrs)
-    end
-
-    it "supports regex matches" do
-      is_expected.to be_a_twirp_message(name: /^B/)
-    end
-
-    it "supports range matches" do
-      is_expected.to be_a_twirp_message(count: 1..5)
-    end
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_message(GoodbyeRequest, name: "Bob")
-      }.to fail_with /message of type/
-
-      is_expected.not_to be_a_twirp_message(name: "nope")
-
-      is_expected.not_to be_a_twirp_message(name: /no/)
-
-      is_expected.not_to be_a_twirp_message(count: 1)
-    end
-
-    it "catches erroneous attribute matches" do
-      is_expected.not_to be_a_twirp_message(namezzz: "Bob")
-    end
-
-    it "handles type mismatches" do
-      is_expected.not_to be_a_twirp_message(name: 123)
-    end
-  end
-end

data/spec/response_spec.rb

@@ -1,89 +0,0 @@
-describe "be_a_twirp_response" do
-  context "with a response" do
-    subject { Twirp::ClientResp.new(response, nil) }
-
-    let(:response) { GoodbyeResponse.new }
-
-    it { is_expected.to be_a_twirp_response }
-
-    it "handles non-twirp response" do
-      expect(Object).not_to be_a_twirp_response
-    end
-
-    context "with attributes" do
-      let(:response) { GoodbyeResponse.new(**attrs) }
-      let(:attrs) { { message: "bye", name: "Bob" } }
-
-      it "can match attributes" do
-        is_expected.to be_a_twirp_response(**attrs)
-      end
-
-      it "supports regex matches" do
-        is_expected.to be_a_twirp_response(name: /^B/)
-      end
-
-      it "catches mismatches" do
-        expect {
-          is_expected.to be_a_twirp_response(name: "nope")
-        }.to fail_including(
-          '-:name => "nope",',
-          '+:name => "Bob",',
-        )
-
-        expect {
-          is_expected.to be_a_twirp_response(name: /no/)
-        }.to fail_including(
-          '-:name => /no/,',
-          '+:name => "Bob",',
-        )
-      end
-    end
-  end
-
-  context "with error" do
-    subject { Twirp::ClientResp.new(nil, error) }
-
-    let(:error) { Twirp::Error.new(code, msg, meta) }
-    let(:code) { :not_found }
-    let(:msg) { "Not Found" }
-    let(:meta) { { is_meta: "true" } }
-
-    it { is_expected.to be_a_twirp_response.with_error }
-    it { is_expected.to be_a_twirp_response.with_error(code) }
-    it { is_expected.to be_a_twirp_response.with_error(msg) }
-    it { is_expected.to be_a_twirp_response.with_error(**meta) }
-    it { is_expected.to be_a_twirp_response.with_error(/Not/) }
-
-    it "catches mismatches" do
-      expect {
-        is_expected.to be_a_twirp_response.with_error(:internal)
-      }.to fail_with /to have code `:internal`/
-    end
-  end
-
-  context "with neither response nor error" do
-    subject { Twirp::ClientResp.new(nil, nil) }
-
-    it "fails the response match" do
-      expect {
-        is_expected.to be_a_twirp_response
-      }.to fail_with /to have data/
-    end
-
-    it "fails the error match" do
-      expect {
-        is_expected.to be_a_twirp_response.with_error
-      }.to fail_with /to have an error/
-    end
-  end
-
-  context "with both response and error" do
-    subject { Twirp::ClientResp.new(GoodbyeResponse.new, Twirp::Error.not_found("Not Found")) }
-
-    it "does not permit both attr and error matching" do
-      expect {
-        is_expected.to be_a_twirp_response(name: "Bob").with_error
-      }.to raise_error(ArgumentError, /but not both/)
-    end
-  end
-end