openapi_first 3.0.1 → 3.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f2547655bd57c98d6619ce62242b3f4b65177c8d8f228781dc55f469a79b51b
-  data.tar.gz: 8f644a212e33370f6cd077469fecee5214c34f3b636658170ad3cae45eccc3df
+  metadata.gz: 5d07efa6286183d4d90a9126e3b5082e27fad9efa966f9aa7623ca280b51c6f8
+  data.tar.gz: 8c6e34a8dffd1b1dd7f8e71cfbb85ded8dd260d2f96631c8e7b91944ddb4033b
 SHA512:
-  metadata.gz: 4fa6acbbb24462294ad5abfc31db63f3ceefbb1c8aa9edf5634a9400ff8f69e84e3fff0fe713a23a0afe71db696a1c080597617be449f3ee67607668e73fdd40
-  data.tar.gz: 28f991a4401b32c122cb785ca616fb0de70935067be6ace0dcfa8fbca448b164cb2a84e4118264b2aa539d8ccf4528e2891981cdb9d58310b211a1bffc4ec652
+  metadata.gz: f60e8101c9a716ae9dbaf27dc9a815d6c44988f65e7d3cef73d93630f668ca664d13f1a0d356d777a6ba75dd0888a3baf44ad5a28716f4d93a02556c331bf46f
+  data.tar.gz: d9161ef397b3f8974f2540d37b12bf07d1b6ff2acb55413504a8fd541c3e91bde36a34712609ef0ef48f93cda59fb6898f4856a0a8c67ce8923351d06ef61709

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## 3.1.0.beta1
+
+### openapi_first/test
+
+#### Changed
+- Test now raises `OpenapiFirst::Test::UnknownQueryParameterError` when it sees unknown query parameters. Note that `OpenapiFirst` ("core") still allows unknown query parameters.
+- Test does not track requests/responses unless the OAD was registered via Test.register (or OpenapiFirst.register)
+
 ## 3.0.1
 - Add missing gem dependency "drb", which is no longer installed by default with newer rubies. This is used in openapi_first/test to make parallel tests work.
 

data/README.md

@@ -243,7 +243,7 @@ Or you can ignore all unknown response status:
 
 ```ruby
 OpenapiFirst::Test.setup do |test|
-  test.ignore_all_unknown_status = true
+  test.ignore_unknown_response_status = true
 end
 ```
 

data/lib/openapi_first/parsed_request.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  ParsedRequest = Data.define(:path, :query, :headers, :body, :cookies)
+end

data/lib/openapi_first/request.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'request_parser'
+require 'openapi_parameters'
+require_relative 'parsed_request'
 require_relative 'request_validator'
 require_relative 'validated_request'
+require_relative 'request_body_parsers'
 
 module OpenapiFirst
   # Represents one request definition of an OpenAPI description.
@@ -10,8 +12,7 @@ module OpenapiFirst
   # An 3.x Operation object can accept multiple requests, because it can handle multiple content-types.
   # This class represents one of those requests.
   class Request
-    # rubocop:disable Metrics/MethodLength
-    def initialize(path:, request_method:, operation_object:,
+    def initialize(path:, request_method:, operation_object:, # rubocop:disable Metrics/MethodLength
                    parameters:, content_type:, content_schema:, required_body:, key:)
       @path = path
       @request_method = request_method
@@ -20,13 +21,11 @@ module OpenapiFirst
       @operation = operation_object
       @allow_empty_content = content_type.nil? || required_body == false
       @key = key
-      @request_parser = RequestParser.new(
-        query_parameters: parameters.query,
-        path_parameters: parameters.path,
-        header_parameters: parameters.header,
-        cookie_parameters: parameters.cookie,
-        content_type:
-      )
+      @query_parser = parameters.query&.then { |params| OpenapiParameters::Query.new(params) }
+      @path_parser = parameters.path&.then { |params| OpenapiParameters::Path.new(params) }
+      @headers_parser = parameters.header&.then { |params| OpenapiParameters::Header.new(params) }
+      @cookies_parser = parameters.cookie&.then { |params| OpenapiParameters::Cookie.new(params) }
+      @body_parsers = RequestBodyParsers[content_type] if content_type
       @validator = RequestValidator.new(
         content_schema:,
         required_request_body: required_body == true,
@@ -35,10 +34,11 @@ module OpenapiFirst
         header_schema: parameters.header_schema,
         cookie_schema: parameters.cookie_schema
       )
+      @parameters = parameters
     end
-    # rubocop:enable Metrics/MethodLength
 
-    attr_reader :content_type, :content_schema, :operation, :request_method, :path, :key
+    attr_reader :content_type, :content_schema, :operation, :request_method, :path, :key, :query_schema, :parameters
+    private attr_reader :query_parser
 
     def allow_empty_content?
       @allow_empty_content
@@ -47,15 +47,33 @@ module OpenapiFirst
     def validate(request, route_params:)
       parsed_request = nil
       error = catch FAILURE do
-        parsed_request = @request_parser.parse(request, route_params:)
+        parsed_request = parse_request(request, route_params:)
         @validator.call(parsed_request)
         nil
       end
-      ValidatedRequest.new(request, parsed_request:, error:, request_definition: self)
+      ValidatedRequest.new(request, parsed_request:, error:, request_definition: self, query_parser:)
     end
 
     def operation_id
       @operation['operationId']
     end
+
+    private
+
+    def parse_request(request, route_params:)
+      ParsedRequest.new(
+        path: @path_parser&.unpack(route_params),
+        query: parse_query(request.env[Rack::QUERY_STRING]),
+        headers: @headers_parser&.unpack_env(request.env),
+        cookies: @cookies_parser&.unpack(request.env[Rack::HTTP_COOKIE]),
+        body: @body_parsers&.call(request)
+      )
+    end
+
+    def parse_query(query_string)
+      @query_parser&.unpack(query_string)
+    rescue OpenapiParameters::InvalidParameterError
+      Failure.fail!(:invalid_query, message: 'Invalid query parameter.')
+    end
   end
 end

data/lib/openapi_first/test.rb

@@ -5,7 +5,7 @@ require_relative 'registry'
 
 module OpenapiFirst
   # Test integration
-  module Test
+  module Test # rubocop:disable Metrics/ModuleLength
     autoload :Coverage, 'openapi_first/test/coverage'
     autoload :Methods, 'openapi_first/test/methods'
     autoload :Observe, 'openapi_first/test/observe'
@@ -13,6 +13,7 @@ module OpenapiFirst
     extend Registry
 
     class CoverageError < Error; end
+    class UnknownQueryParameterError < Error; end
 
     # Inject request/response validation in a rack app class
     def self.observe(app, api: :default)
@@ -33,6 +34,11 @@ module OpenapiFirst
       @configuration ||= Configuration.new
     end
 
+    def self.registered?(oad)
+      key = oad.key
+      definitions.any? { |(_name, registered)| registered.key == key }
+    end
+
     # Sets up OpenAPI test coverage and OAD registration.
     # @yieldparam [OpenapiFirst::Test::Configuration] configuration A configuration to setup test integration
     def self.setup
@@ -99,12 +105,16 @@ module OpenapiFirst
 
       OpenapiFirst.configure do |config|
         @after_request_validation = config.after_request_validation do |validated_request, oad|
+          next unless registered?(oad)
           raise validated_request.error.exception if raise_request_error?(validated_request)
 
+          check_unknown_query_parameters(validated_request)
+
           Coverage.track_request(validated_request, oad)
         end
 
         @after_response_validation = config.after_response_validation do |validated_response, rack_request, oad|
+          next unless registered?(oad)
           if validated_response.invalid? && raise_response_error?(validated_response)
             raise validated_response.error.exception
           end
@@ -115,17 +125,6 @@ module OpenapiFirst
       @installed = true
     end
 
-    def self.raise_request_error?(validated_request)
-      return false if validated_request.valid?
-      return false if validated_request.known?
-
-      !configuration.ignore_unknown_requests
-    end
-
-    def self.raise_response_error?(invalid_response)
-      configuration.response_raise_error && !configuration.ignore_response?(invalid_response)
-    end
-
     def self.uninstall
       configuration = OpenapiFirst.configuration
       configuration.after_request_validation.delete(@after_request_validation)
@@ -135,5 +134,38 @@ module OpenapiFirst
       @installed = nil
       @exit_handler = nil
     end
+
+    class << self
+      private
+
+      def check_unknown_query_parameters(validated_request)
+        return unless validated_request.known?
+
+        unknown_parameters = validated_request.unknown_query_parameters
+        return unless unknown_parameters
+
+        message = unknown_parameters_message(unknown_parameters, validated_request)
+        raise UnknownQueryParameterError, message
+      end
+
+      def unknown_parameters_message(unknown_parameters, validated_request)
+        s = 's' if many?(unknown_parameters)
+        list = unknown_parameters.keys.map(&:inspect).join(', ')
+        "Unknown query parameter#{s} #{list} for #{validated_request.fullpath}"
+      end
+
+      def raise_request_error?(validated_request)
+        return false if validated_request.valid?
+        return false if validated_request.known?
+
+        !configuration.ignore_unknown_requests
+      end
+
+      def many?(array) = array.length > 1
+
+      def raise_response_error?(invalid_response)
+        configuration.response_raise_error && !configuration.ignore_response?(invalid_response)
+      end
+    end
   end
 end

data/lib/openapi_first/validated_request.rb

@@ -8,11 +8,12 @@ module OpenapiFirst
   class ValidatedRequest < SimpleDelegator
     extend Forwardable
 
-    def initialize(original_request, error:, parsed_request: nil, request_definition: nil)
+    def initialize(original_request, error:, parsed_request: nil, request_definition: nil, query_parser: nil)
       super(original_request)
       @parsed_request = parsed_request
       @error = error
       @request_definition = request_definition
+      @query_parser = query_parser
     end
 
     # A Failure object if the request is invalid
@@ -31,6 +32,11 @@ module OpenapiFirst
     # @return [Hash] The raw OpenAPI 3 operation object
     def_delegator :request_definition, :operation
 
+    # @return [Hash] Query parameters and values that are not defined in the OpenAPI spec.
+    def unknown_query_parameters
+      @query_parser&.unknown_values(query_string)
+    end
+
     # Parsed path parameters
     # @return [Hash<String, anything>]
     def parsed_path_parameters = @parsed_request&.path || {}

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '3.0.1'
+  VERSION = '3.1.0.beta1'
 end

data/lib/openapi_first.rb

@@ -47,8 +47,8 @@ module OpenapiFirst
   # @return [Class] The error response class
   def self.find_error_response(name)
     ERROR_RESPONSES.fetch(name) do
-      raise "Unknown error response: #{name}. " /
-            'Register your error response class via `OpenapiFirst.register_error_response(name, klass)`. ' /
+      raise "Unknown error response: #{name}. " \
+            'Register your error response class via `OpenapiFirst.register_error_response(name, klass)`. ' \
             "Registered error responses are: #{ERROR_RESPONSES.keys.join(', ')}."
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0.beta1
 platform: ruby
 authors:
 - Andreas Haller
@@ -63,7 +63,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -73,7 +73,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -121,11 +121,11 @@ files:
 - lib/openapi_first/json.rb
 - lib/openapi_first/middlewares/request_validation.rb
 - lib/openapi_first/middlewares/response_validation.rb
+- lib/openapi_first/parsed_request.rb
 - lib/openapi_first/ref_resolver.rb
 - lib/openapi_first/registry.rb
 - lib/openapi_first/request.rb
 - lib/openapi_first/request_body_parsers.rb
-- lib/openapi_first/request_parser.rb
 - lib/openapi_first/request_validator.rb
 - lib/openapi_first/response.rb
 - lib/openapi_first/response_body_parsers.rb

data/lib/openapi_first/request_parser.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'openapi_parameters'
-require_relative 'request_body_parsers'
-
-module OpenapiFirst
-  ParsedRequest = Data.define(:path, :query, :headers, :body, :cookies)
-
-  # Parse a request
-  class RequestParser
-    def initialize(
-      query_parameters:,
-      path_parameters:,
-      header_parameters:,
-      cookie_parameters:,
-      content_type:
-    )
-      @query_parser = OpenapiParameters::Query.new(query_parameters) if query_parameters
-      @path_parser = OpenapiParameters::Path.new(path_parameters) if path_parameters
-      @headers_parser = OpenapiParameters::Header.new(header_parameters) if header_parameters
-      @cookies_parser = OpenapiParameters::Cookie.new(cookie_parameters) if cookie_parameters
-      @body_parsers = RequestBodyParsers[content_type] if content_type
-    end
-
-    attr_reader :query, :path, :headers, :cookies
-
-    def parse(request, route_params:)
-      ParsedRequest.new(
-        path: @path_parser&.unpack(route_params),
-        query: parse_query(request.env[Rack::QUERY_STRING]),
-        headers: @headers_parser&.unpack_env(request.env),
-        cookies: @cookies_parser&.unpack(request.env[Rack::HTTP_COOKIE]),
-        body: @body_parsers&.call(request)
-      )
-    end
-
-    private
-
-    def parse_query(query_string)
-      @query_parser&.unpack(query_string)
-    rescue OpenapiParameters::InvalidParameterError
-      Failure.fail!(:invalid_query, message: 'Invalid query parameter.')
-    end
-  end
-end