openapi_first 2.9.1 → 2.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b40040b17718d7e8f1c98bfbdc1182e0d1bb454ff3e2c6c54424c8acdf40ca0
-  data.tar.gz: f41d5ab780eb888cdec6edbc9bd7d017368af07148ca65a1c09139c88ce9cad9
+  metadata.gz: ef8ea95833884daf36e8a33742ce4a6eddfb9343b67de0b5e787ebc377c0691d
+  data.tar.gz: b63916918c1d1116d99c2e071c3e8e752b1cce66cd431dceb5076a3e70688c10
 SHA512:
-  metadata.gz: 178a990a3ad830e51f1ef9e2fdc15154722ec21ce7d03d9f9592be04226acc45c357a10a956dec8aeb341daaef95bf24c955004800d22ed53b4460111656aeb3
-  data.tar.gz: c6784c5566dd25bc9e633793aa63574d5e663c135169542d5d3c7137f6cdec6f50892059a5f20cad5fba17ba353339f4b23cd654820accaaa5450417ade30bb9
+  metadata.gz: 3cbf77e0a4a51b213a90458c1181bd29474f378195210cf76466c24ef832195b32e4cbd8aec7ba97ece0bd7d9a97b6022e02b5288600d8879b82401c398d1ddc
+  data.tar.gz: 8789c3dadcff66b6cbb831dfae948da5adcbcd2788ff40765f39d4a1a0ba238cef1d7df609b4dd57e8ba71653103e21f9fb6a7e1f0a212e45c02d4f8c5e41e39

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 2.9.3
+
+- Fix OpenapiFirst.load when MultiJson is configured to return symbol keys
+
+## 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

@@ -56,11 +56,7 @@ Here is how to set it up:
     end
     ```
 2. Observe your application. You can do this in one of two ways:
-    - Inject a Module to wrap (prepend) the `call` method of your Rack app Class.
-      ```ruby
-      OpenapiFirst::Test.observe(MyApplication)
-      ```
-    - Or add an `app` method to your tests, which wraps your application with silent request / response validation. (✷1)
+    - Add an `app` method to your tests, which wraps your application with silent request / response validation. (✷1)
       ```ruby
       RSpec.configure do |config|
         config.include OpenapiFirst::Test::Methods[MyApp], type: :request
@@ -73,6 +69,13 @@ Here is how to set it up:
         OpenapiFirst::Test.app(MyApp)
       end
       ```
+    - Or inject a Module to wrap (prepend) the `call` method of your Rack app Class.
+    
+      NOTE: This is still work in progress. It works with basic Sinatra apps, but does not work with Hanami or Rails out of the box, yet. PRs welcome 🤗
+      
+      ```ruby
+      OpenapiFirst::Test.observe(MyApplication)
+      ```
 3. Run your tests. The Coverage feature will tell you about missing or invalid requests/responses.
 
 (✷1): It does not matter what method of openapi_first you use to validate requests/responses. Instead of using `OpenapiFirstTest.app` to wrap your application, you could also use the [middlewares](#rack-middlewares) or [test assertion method](#test-assertions), but you would have to do that for all requests/responses defined in your API description to make coverage work.
@@ -368,6 +371,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/file_loader.rb

@@ -13,7 +13,7 @@ module OpenapiFirst
 
       body = File.read(file_path)
       extname = File.extname(file_path)
-      return JSON.parse(body) if extname == '.json'
+      return ::JSON.parse(body) if extname == '.json'
       return YAML.unsafe_load(body) if ['.yaml', '.yml'].include?(extname)
 
       body

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.3'
 end

data/lib/openapi_first.rb

@@ -66,7 +66,7 @@ module OpenapiFirst
   # @return [Definition]
   # TODO: This needs to work with unresolved contents as well
   def self.parse(contents, only: nil, filepath: nil, &)
-    contents = JSON.parse(JSON.generate(contents)) # Deeply stringify keys, because of YAML. See https://github.com/ahx/openapi_first/issues/367
+    contents = ::JSON.parse(::JSON.generate(contents)) # Deeply stringify keys, because of YAML. See https://github.com/ahx/openapi_first/issues/367
     contents['paths'].filter!(&->(key, _) { only.call(key) }) if only
     Definition.new(contents, filepath, &)
   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.3
 platform: ruby
 authors:
 - Andreas Haller