committee 1.15.0 → 5.0.0

data/lib/committee/schema_validator/hyper_schema/router.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      class Router
+        def initialize(schema, validator_option)
+          @prefix = validator_option.prefix
+          @prefix_regexp = /\A#{Regexp.escape(@prefix)}/.freeze if @prefix
+          @schema = schema
+
+          @validator_option = validator_option
+        end
+
+        def includes?(path)
+          !@prefix || path =~ @prefix_regexp
+        end
+
+        def includes_request?(request)
+          includes?(request.path)
+        end
+
+        def find_link(method, path)
+          path = path.gsub(@prefix_regexp, "") if @prefix
+          link_with_matches = (@schema.routes[method] || []).map do |pattern, link|
+            if matches = pattern.match(path)
+              # prefer path which has fewer matches (eg. `/pets/dog` than `/pets/{uuid}` for path `/pets/dog` )
+              [matches.captures.size, link, Hash[matches.names.zip(matches.captures)]]
+            else
+              nil
+            end
+          end.compact.sort_by(&:first).first
+          link_with_matches.nil? ? nil : link_with_matches.slice(1, 2)
+        end
+
+        def find_request_link(request)
+          find_link(request.request_method, request.path_info)
+        end
+
+        def build_schema_validator(request)
+          Committee::SchemaValidator::HyperSchema.new(self, request, @validator_option)
+        end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/hyper_schema/string_params_coercer.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      # StringParamsCoercer takes parameters that are specified over a medium that
+      # can only accept strings (for example in a URL path or in query parameters)
+      # and attempts to coerce them into known types based of a link's schema
+      # definition.
+      #
+      # Currently supported types: null, integer, number and boolean.
+      #
+      # +call+ returns a hash of all params which could be coerced - coercion
+      # errors are simply ignored and expected to be handled later by schema
+      # validation.
+      class StringParamsCoercer
+        def initialize(query_hash, schema, options = {})
+          @query_hash = query_hash
+          @schema = schema
+
+          @coerce_recursive = options.fetch(:coerce_recursive, false)
+        end
+
+        def call!
+          coerce_object!(@query_hash, @schema)
+        end
+
+        private
+
+          def coerce_object!(hash, schema)
+            return false unless schema.respond_to?(:properties)
+
+            is_coerced = false
+            schema.properties.each do |k, s|
+              original_val = hash[k]
+              unless original_val.nil?
+                new_value, is_changed = coerce_value!(original_val, s)
+                if is_changed
+                  hash[k] = new_value
+                  is_coerced = true
+                end
+              end
+            end
+
+            is_coerced
+          end
+
+          def coerce_value!(original_val, s)
+            unless original_val.nil?
+              s.type.each do |to_type|
+                case to_type
+                  when "null"
+                    return nil, true if original_val.empty?
+                  when "integer"
+                    begin
+                      return Integer(original_val), true
+                    rescue ArgumentError => e
+                      raise e unless e.message =~ /invalid value for Integer/
+                    end
+                  when "number"
+                    begin
+                      return Float(original_val), true
+                    rescue ArgumentError => e
+                      raise e unless e.message =~ /invalid value for Float/
+                    end
+                  when "boolean"
+                    if original_val == "true" || original_val == "1"
+                      return true, true
+                    end
+                    if original_val == "false" || original_val == "0"
+                      return false, true
+                    end
+                  when "array"
+                    if @coerce_recursive && coerce_array_data!(original_val, s)
+                      return original_val, true # change original value
+                    end
+                  when "object"
+                    if @coerce_recursive && coerce_object!(original_val, s)
+                      return original_val, true # change original value
+                    end
+                end
+              end
+            end
+            return nil, false
+          end
+
+          def coerce_array_data!(original_val, schema)
+            return false unless schema.respond_to?(:items)
+            return false unless original_val.is_a?(Array)
+
+            is_coerced = false
+            original_val.each_with_index do |d, index|
+              new_value, is_changed = coerce_value!(d, schema.items)
+              if is_changed
+                original_val[index] = new_value
+                is_coerced = true
+              end
+            end
+
+            is_coerced
+          end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/hyper_schema.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      attr_reader :link, :param_matches, :validator_option
+
+      def initialize(router, request, validator_option)
+        @link, @param_matches = router.find_request_link(request)
+        @validator_option = validator_option
+      end
+
+      def request_validate(request)
+        request_unpack(request)
+
+        request_schema_validation(request)
+        parameter_coerce!(request, link, validator_option.params_key)
+        parameter_coerce!(request, link, "rack.request.query_hash") if link_exist? && !request.GET.nil? && !link.schema.nil?
+      end
+
+      def response_validate(status, headers, response, _test_method = false)
+        return unless link_exist?
+
+        full_body = +""
+        response.each do |chunk|
+          full_body << chunk
+        end
+
+        data = {}
+        unless full_body.empty?
+          parse_to_json = !validator_option.parse_response_by_content_type ||
+                          headers.fetch('Content-Type', nil)&.start_with?('application/json')
+          data = JSON.parse(full_body) if parse_to_json
+        end
+
+        Committee::SchemaValidator::HyperSchema::ResponseValidator.new(link, validate_success_only: validator_option.validate_success_only).call(status, headers, data)
+      end
+
+      def link_exist?
+        !link.nil?
+      end
+
+      private
+
+        def coerce_path_params
+          return {} unless link_exist?
+
+          Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(param_matches, link.schema, coerce_recursive: validator_option.coerce_recursive).call!
+          param_matches
+        end
+
+        def coerce_query_params(request)
+          return unless link_exist?
+          return if request.GET.nil? || link.schema.nil?
+
+          Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(request.GET, link.schema, coerce_recursive: validator_option.coerce_recursive).call!
+        end
+
+        def request_unpack(request)
+          unpacker = Committee::RequestUnpacker.new(
+            allow_form_params:  validator_option.allow_form_params,
+            allow_get_body:     validator_option.allow_get_body,
+            allow_query_params: validator_option.allow_query_params,
+            optimistic_json:    validator_option.optimistic_json,
+          )
+
+          request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
+
+          # Attempts to coerce parameters that appear in a link's URL to Ruby
+          # types that can be validated with a schema.
+          param_matches_hash = validator_option.coerce_path_params ? coerce_path_params : {}
+
+          # Attempts to coerce parameters that appear in a query string to Ruby
+          # types that can be validated with a schema.
+          coerce_query_params(request) if validator_option.coerce_query_params
+
+          query_param = unpacker.unpack_query_params(request)
+          request_param, is_form_params = unpacker.unpack_request_params(request)
+          coerce_form_params(request_param) if validator_option.coerce_form_params && is_form_params
+          request.env[validator_option.request_body_hash_key] = request_param
+
+          request.env[validator_option.params_key] = Committee::Utils.indifferent_hash
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(query_param))
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(request_param))
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(param_matches_hash))
+        end
+
+        def coerce_form_params(parameter)
+          return unless link_exist?
+          return unless link.schema
+          Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(parameter, link.schema).call!
+        end
+
+        def request_schema_validation(request)
+          return unless link_exist?
+          validator = Committee::SchemaValidator::HyperSchema::RequestValidator.new(link, check_content_type: validator_option.check_content_type, check_header: validator_option.check_header)
+          validator.call(request, request.env[validator_option.params_key], request.env[validator_option.headers_key])
+        end
+
+        def parameter_coerce!(request, link, coerce_key)
+          return unless link_exist?
+
+          Committee::SchemaValidator::HyperSchema::ParameterCoercer.
+              new(request.env[coerce_key],
+                  link.schema,
+                  coerce_date_times: validator_option.coerce_date_times,
+                  coerce_recursive: validator_option.coerce_recursive).
+              call!
+        end
+    end
+  end
+end
+
+require_relative "hyper_schema/request_validator"
+require_relative "hyper_schema/response_generator"
+require_relative "hyper_schema/response_validator"
+require_relative "hyper_schema/router"
+require_relative "hyper_schema/string_params_coercer"
+require_relative "hyper_schema/parameter_coercer"

data/lib/committee/schema_validator/open_api_3/operation_wrapper.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class OpenAPI3
+      class OperationWrapper
+        # # @param request_operation [OpenAPIParser::RequestOperation]
+        def initialize(request_operation)
+          @request_operation = request_operation
+        end
+
+        def path_params
+          request_operation.path_params
+        end
+
+        def original_path
+          request_operation.original_path
+        end
+
+        def http_method
+          request_operation.http_method
+        end
+
+        def coerce_path_parameter(validator_option)
+          options = build_openapi_parser_path_option(validator_option)
+          return {} unless options.coerce_value
+
+          request_operation.validate_path_params(options)
+        rescue OpenAPIParser::OpenAPIError => e
+          raise Committee::InvalidRequest.new(e.message, original_error: e)
+        end
+
+        # @param [Boolean] strict when not content_type or status code definition, raise error
+        def validate_response_params(status_code, headers, response_data, strict, check_header)
+          response_body = OpenAPIParser::RequestOperation::ValidatableResponseBody.new(status_code, response_data, headers)
+
+          return request_operation.validate_response_body(response_body, response_validate_options(strict, check_header))
+        rescue OpenAPIParser::OpenAPIError => e
+          raise Committee::InvalidResponse.new(e.message, original_error: e)
+        end
+
+        def validate_request_params(path_params, query_params, body_params, headers, validator_option)
+          ret, err = case request_operation.http_method
+                when 'get', 'delete', 'head'
+                  validate_get_request_params(path_params, query_params, headers, validator_option)
+                when 'post', 'put', 'patch', 'options'
+                  validate_post_request_params(path_params, query_params, body_params, headers, validator_option)
+                else
+                  raise "Committee OpenAPI3 not support #{request_operation.http_method} method"
+                end
+          raise err if err
+          ret
+        end
+
+        def optional_body?
+          !request_operation.operation_object&.request_body&.required
+        end
+
+        def valid_request_content_type?(content_type)
+          if (request_body = request_operation.operation_object&.request_body)
+            !request_body.select_media_type(content_type).nil?
+          else
+            # if not exist request body object, all content_type allow.
+            # because request body object required content field so when it exists there're content type definition.
+            true
+          end
+        end
+
+        def request_content_types
+          request_operation.operation_object&.request_body&.content&.keys || []
+        end
+
+        private
+
+        attr_reader :request_operation
+
+        # @!attribute [r] request_operation
+        #   @return [OpenAPIParser::RequestOperation]
+
+        # @return [OpenAPIParser::SchemaValidator::Options]
+        def build_openapi_parser_body_option(validator_option)
+          build_openapi_parser_option(validator_option, validator_option.coerce_form_params)
+        end
+
+        # @return [OpenAPIParser::SchemaValidator::Options]
+        def build_openapi_parser_path_option(validator_option)
+          build_openapi_parser_option(validator_option, validator_option.coerce_query_params)
+        end
+
+        # @return [OpenAPIParser::SchemaValidator::Options]
+        def build_openapi_parser_option(validator_option, coerce_value)
+          datetime_coerce_class = validator_option.coerce_date_times ? DateTime : nil
+          validate_header = validator_option.check_header
+          OpenAPIParser::SchemaValidator::Options.new(coerce_value: coerce_value,
+                                                      datetime_coerce_class: datetime_coerce_class,
+                                                      validate_header: validate_header)
+        end
+
+        def validate_get_request_params(path_params, query_params, headers, validator_option)
+          # bad performance because when we coerce value, same check
+          validate_path_and_query_params(path_params, query_params, headers, validator_option)
+        rescue OpenAPIParser::OpenAPIError => e
+          raise Committee::InvalidRequest.new(e.message, original_error: e)
+        end
+
+        def validate_post_request_params(path_params, query_params, body_params, headers, validator_option)
+          content_type = headers['Content-Type'].to_s.split(";").first.to_s
+
+          # bad performance because when we coerce value, same check
+          validate_path_and_query_params(path_params, query_params, headers, validator_option)
+          request_operation.validate_request_body(content_type, body_params, build_openapi_parser_body_option(validator_option))
+        rescue => e
+          raise Committee::InvalidRequest.new(e.message, original_error: e)
+        end
+
+        def validate_path_and_query_params(path_params, query_params, headers, validator_option)
+          # it's currently impossible to validate path params and query params separately
+          # so we have to resort to this workaround
+
+          path_keys = path_params.keys.to_set
+          query_keys = query_params.keys.to_set
+
+          merged_params = query_params.merge(path_params)
+
+          request_operation.validate_request_parameter(merged_params, headers, build_openapi_parser_path_option(validator_option))
+
+          merged_params.each do |k, v|
+            path_params[k] = v if path_keys.include?(k)
+            query_params[k] = v if query_keys.include?(k)
+          end
+        end
+
+        def response_validate_options(strict, check_header)
+          ::OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(strict: strict, validate_header: check_header)
+        end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/open_api_3/request_validator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class OpenAPI3
+      class RequestValidator
+        # @param [SchemaValidator::OpenAPI3::OperationWrapper] operation_object
+        # @param [Committee::SchemaValidator::Option] validator_option
+        def initialize(operation_object, validator_option:)
+          @operation_object = operation_object
+          @validator_option = validator_option
+        end
+
+        def call(request, path_params, query_params, body_params, headers)
+          content_type = ::Committee::SchemaValidator.request_media_type(request)
+          check_content_type(request, content_type) if @validator_option.check_content_type
+
+          @operation_object.validate_request_params(path_params, query_params, body_params, headers, @validator_option)
+        end
+
+        private
+
+        def check_content_type(request, content_type)
+          # support post, put, patch only
+          return true unless request.post? || request.put? || request.patch?
+          return true if @operation_object.valid_request_content_type?(content_type)
+          return true if @operation_object.optional_body? && empty_request?(request)
+
+          message = if valid_content_types.size > 1
+                      types = valid_content_types.map {|x| %{"#{x}"} }.join(', ')
+                      %{"Content-Type" request header must be set to any of the following: [#{types}].}
+                    else
+                      %{"Content-Type" request header must be set to "#{valid_content_types.first}".}
+                    end
+          raise Committee::InvalidRequest, message
+        end
+
+        def valid_content_types
+          @operation_object&.request_content_types
+        end
+
+        def empty_request?(request)
+          return true if !request.body
+
+          data = request.body.read
+          request.body.rewind
+          data.empty?
+        end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/open_api_3/response_validator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class OpenAPI3
+      class ResponseValidator
+        attr_reader :validate_success_only
+
+        # @param [Committee::SchemaValidator::Options] validator_option
+        # @param [Committee::SchemaValidator::OpenAPI3::OperationWrapper] operation_wrapper
+        def initialize(operation_wrapper, validator_option)
+          @operation_wrapper = operation_wrapper
+          @validate_success_only = validator_option.validate_success_only
+          @check_header = validator_option.check_header
+        end
+
+        def call(status, headers, response_data, strict)
+          return unless Committee::Middleware::ResponseValidation.validate?(status, validate_success_only)
+
+          operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header)
+        end
+
+        private
+
+        attr_reader :operation_wrapper, :check_header
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/open_api_3/router.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class OpenAPI3
+      class Router
+        # @param [Committee::SchemaValidator::Option] validator_option
+        def initialize(schema, validator_option)
+          @schema = schema
+          @prefix_regexp = ::Committee::SchemaValidator.build_prefix_regexp(validator_option.prefix)
+          @validator_option = validator_option
+        end
+
+        def includes_request?(request)
+          return true unless @prefix_regexp
+
+          prefix_request?(request)
+        end
+
+        def build_schema_validator(request)
+          Committee::SchemaValidator::OpenAPI3.new(self, request, @validator_option)
+        end
+
+        def operation_object(request)
+          return nil unless includes_request?(request)
+
+          path = request.path
+          path = path.gsub(@prefix_regexp, '') if @prefix_regexp
+
+          request_method = request.request_method.downcase
+
+          @schema.operation_object(path, request_method)
+        end
+
+        private
+
+        def prefix_request?(request)
+          return false unless @prefix_regexp
+
+          request.path =~ @prefix_regexp
+        end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/open_api_3.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class OpenAPI3
+      # @param [Committee::SchemaValidator::Option] validator_option
+      def initialize(router, request, validator_option)
+        @router = router
+        @request = request
+        @operation_object = router.operation_object(request)
+        @validator_option = validator_option
+      end
+
+      def request_validate(request)
+        return unless link_exist?
+
+        request_unpack(request)
+        request_schema_validation(request)
+
+        copy_coerced_data_to_params(request)
+      end
+
+      def response_validate(status, headers, response, test_method = false)
+        full_body = +""
+        response.each do |chunk|
+          full_body << chunk
+        end
+
+        parse_to_json = !validator_option.parse_response_by_content_type || 
+                        headers.fetch('Content-Type', nil)&.start_with?('application/json')
+        data = if parse_to_json
+          full_body.empty? ? {} : JSON.parse(full_body)
+        else
+          full_body
+        end
+
+        # TODO: refactoring name
+        strict = test_method
+        Committee::SchemaValidator::OpenAPI3::ResponseValidator.
+            new(@operation_object, validator_option).
+            call(status, headers, data, strict)
+      end
+
+      def link_exist?
+        !@operation_object.nil?
+      end
+
+      private
+
+      attr_reader :validator_option
+
+      def coerce_path_params
+        return Committee::Utils.indifferent_hash unless validator_option.coerce_path_params
+        Committee::RequestUnpacker.indifferent_params(@operation_object.coerce_path_parameter(@validator_option))
+      end
+
+      def request_schema_validation(request)
+        return unless @operation_object
+
+        validator = Committee::SchemaValidator::OpenAPI3::RequestValidator.new(@operation_object, validator_option: validator_option)
+        validator.call(request, path_params(request), query_params(request), body_params(request), header(request))
+      end
+
+      def path_params(request)
+        request.env[validator_option.path_hash_key]
+      end
+
+      def query_params(request)
+        request.env[validator_option.query_hash_key]
+      end
+
+      def body_params(request)
+        request.env[validator_option.request_body_hash_key]
+      end
+
+      def header(request)
+        request.env[validator_option.headers_key]
+      end
+
+      def request_unpack(request)
+        unpacker = Committee::RequestUnpacker.new(
+          allow_form_params:  validator_option.allow_form_params,
+          allow_get_body:     validator_option.allow_get_body,
+          allow_query_params: validator_option.allow_query_params,
+          optimistic_json:    validator_option.optimistic_json,
+        )
+
+        request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
+
+        request_param, is_form_params = unpacker.unpack_request_params(request)
+        request.env[validator_option.request_body_hash_key] = request_param
+        request.env[validator_option.path_hash_key] = coerce_path_params
+
+        query_param = unpacker.unpack_query_params(request)
+        query_param.merge!(request_param) if request.get? && validator_option.allow_get_body
+        request.env[validator_option.query_hash_key] = query_param
+      end
+
+      def copy_coerced_data_to_params(request)
+        order = if validator_option.parameter_overwite_by_rails_rule
+          # (high priority) path_hash_key -> query_param -> request_body_hash          
+          [validator_option.request_body_hash_key, validator_option.query_hash_key, validator_option.path_hash_key]
+        else
+          # (high priority) path_hash_key -> request_body_hash -> query_param
+          [validator_option.query_hash_key, validator_option.request_body_hash_key, validator_option.path_hash_key]
+        end
+
+        request.env[validator_option.params_key] = Committee::Utils.indifferent_hash
+        order.each do |key|
+          request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(request.env[key]))
+        end
+      end
+    end
+  end
+end
+
+require_relative "open_api_3/router"
+require_relative "open_api_3/operation_wrapper"
+require_relative "open_api_3/request_validator"
+require_relative "open_api_3/response_validator"