openapi_first 2.9.1 → 2.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b40040b17718d7e8f1c98bfbdc1182e0d1bb454ff3e2c6c54424c8acdf40ca0
-  data.tar.gz: f41d5ab780eb888cdec6edbc9bd7d017368af07148ca65a1c09139c88ce9cad9
+  metadata.gz: 77ee23a7f40889116a6ae239e51711460c21c9f134f7e85bef5c2869d91d7d26
+  data.tar.gz: 5b541d1727e879c8e1ace187679bd6bc708054e2675d127dfca718fc963fb10b
 SHA512:
-  metadata.gz: 178a990a3ad830e51f1ef9e2fdc15154722ec21ce7d03d9f9592be04226acc45c357a10a956dec8aeb341daaef95bf24c955004800d22ed53b4460111656aeb3
-  data.tar.gz: c6784c5566dd25bc9e633793aa63574d5e663c135169542d5d3c7137f6cdec6f50892059a5f20cad5fba17ba353339f4b23cd654820accaaa5450417ade30bb9
+  metadata.gz: 68e0311f5a70192b54a4d3c3654e1910b39bdfc420db4c5abcce38ba4dc2d2f4e78a278ac35be8a9796c59ba42428c3b67912adb08c1aeb469ba5d08f8223800
+  data.tar.gz: e43db82ccea7aeca33f58fa705f16844080f672dc0b157f72f10aa1e5fdf7ca4a71d6146c93622b46b226811b6e9cd09c61fa72fec6fb16831edfc606668089b

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 2.9.2
+
+- OpenapiFirst::Test reports all non-covered requests now
+- Response validation: Improve content type mismatch exception message
+
 ## 2.9.1
 
 - Fix OpenapiFirst::Test's request validation to not always raise an error, but only for unknown requests

data/README.md

@@ -368,6 +368,8 @@ use OpenapiFirst::Middlewares::RequestValidation, oad
 
 ## Development
 
+Run `git submodule update --init` to initialize the git submodules.
+
 Run `bin/setup` to install dependencies.
 
 See `bundle exec rake` to run the linter and the tests.

data/lib/openapi_first/router/find_response.rb

@@ -16,20 +16,24 @@ module OpenapiFirst
           return Match.new(error: Failure.new(:response_not_found, message:), response: nil)
         end
         response = FindContent.call(contents, content_type)
-        if response.nil?
-          message = "#{content_error(content_type, request_method:,
-                                                   path:)} Content-Type should be #{contents.keys.join(' or ')}."
-          return Match.new(error: Failure.new(:response_not_found, message:), response: nil)
-        end
+        return response_not_found(content_type:, contents:, request_method:, path:) unless response
 
         Match.new(response:, error: nil)
       end
 
-      def self.content_error(content_type, request_method:, path:)
-        return 'Response Content-Type must not be empty.' if content_type.nil? || content_type.empty?
-
-        "Response Content-Type #{content_type} is not defined for #{request_method} #{path}."
+      def self.response_not_found(content_type:, contents:, request_method:, path:)
+        empty_content = content_type.nil? || content_type.empty?
+        message =
+          "Content-Type should be #{contents.keys.join(' or ')}, " \
+          "but was #{empty_content ? 'empty' : content_type} for " \
+          "#{request_method.upcase} #{path}"
+
+        Match.new(
+          error: Failure.new(:response_not_found, message:),
+          response: nil
+        )
       end
+      private_class_method :response_not_found
 
       def self.find_status(responses, status)
         # According to OAS status has to be a string,

data/lib/openapi_first/test/coverage/terminal_formatter.rb

@@ -33,14 +33,17 @@ module OpenapiFirst
           @out.print(string)
         end
 
-        def format_plan(plan)
+        def format_plan(plan) # rubocop:disable Metrics/PerceivedComplexity
           puts ['', "API validation coverage for #{plan.api_identifier}: #{plan.coverage}%"]
           return if plan.done? && !verbose
 
+          requested_routes_count = plan.routes.count { |route| route.requests.any?(&:requested?) }
+          focused_route = requested_routes_count <= 1 && focused
+
           plan.routes.each do |route|
             next if route.finished? && !verbose
 
-            next if route.requests.none?(&:requested?) && focused
+            next if route.requests.none?(&:requested?) && focused_route
 
             format_requests(route.requests)
 

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '2.9.1'
+  VERSION = '2.9.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.9.2
 platform: ruby
 authors:
 - Andreas Haller