openapi_parser 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01ffcf763ea2797df03cd91cd162d4031c504d5f7ece8327e4e0cbad989972c4
-  data.tar.gz: 518c4c86cababa47d3a6f0520fbeeec28d953d40ea9e7e3e4ab26150eaf917b5
+  metadata.gz: dd2a5c6292d86e914f641bf9d2e99b6ef8de9cbc46e5b3196937fc1c691541df
+  data.tar.gz: 9a6c9a5400e1fffdf12cc0e43fbc89433b7e4b917bd61dfb1c34c613bc17e9f4
 SHA512:
-  metadata.gz: a59505448fa9fdbe16e6117c86eb885d3343ece1f6e3ed18dffaa44727f6d99e71f81dc48661d311c8e1524d09c21f9c78e8a9a13d921b7478c3bdae0110891b
-  data.tar.gz: ecdfd1fc6b2b159e8991b9d187decc834958f2970bcbef710739b36b09a44409dce0ac425129459f7d5f86236b7f72227bd06d108790ee6e2cfcff5a7a434736
+  metadata.gz: '0093301164855dba5aff9a87cdce0c8d99f85ac5c1c4738c011c850924704313b1fd6f9aee00f01f25e7a125b1d18c3d02659e8594eb6fa1bbd0da84e1bf3734'
+  data.tar.gz: 23b2105486befe12f39f90a9ea8f893b46a1dd36693782499b497ce1909ddef4a6b2d25da313cc62e3de8bf9a28246a5f140640fd9ff7869526ebfa05ea1a828

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+## 0.1.9 (2019-01-01)
+* add strict option (#17)
+
 ## 0.1.8 (2018-12-31)
 * add select_media_type method(#16)
 

data/lib/openapi_parser/config.rb

@@ -15,10 +15,20 @@ class OpenAPIParser::Config
     @config.fetch(:expand_reference, true)
   end
 
+  def strict_response_validation
+    @config.fetch(:strict_response_validation, false)
+  end
+
+  # @return [OpenAPIParser::SchemaValidator::Options]
   def request_validator_options
     @request_validator_options ||= OpenAPIParser::SchemaValidator::Options.new(coerce_value: coerce_value, datetime_coerce_class: datetime_coerce_class)
   end
 
   alias_method :request_body_options, :request_validator_options
   alias_method :path_params_options, :request_validator_options
+
+  # @return [OpenAPIParser::SchemaValidator::ResponseValidateOptions]
+  def response_validate_options
+    @response_validate_options ||= OpenAPIParser::SchemaValidator::ResponseValidateOptions.new(strict: strict_response_validation)
+  end
 end

data/lib/openapi_parser/errors.rb

@@ -64,4 +64,16 @@ module OpenAPIParser
       "#{@value} isn't include enum in #{@reference}"
     end
   end
+
+  class NotExistStatusCodeDefinition < OpenAPIError
+    def message
+      "don't exist status code definition in #{@reference}"
+    end
+  end
+
+  class NotExistContentTypeDefinition < OpenAPIError
+    def message
+      "don't exist response definition #{@reference}"
+    end
+  end
 end

data/lib/openapi_parser/request_operation.rb

@@ -40,14 +40,21 @@ class OpenAPIParser::RequestOperation
     operation_object&.validate_path_params(path_params, options)
   end
 
+  # @param [String] content_type
+  # @param [Hash] params
+  # @param [OpenAPIParser::SchemaValidator::Options] options
   def validate_request_body(content_type, params, options = nil)
     options ||= config.request_body_options
     operation_object&.validate_request_body(content_type, params, options)
   end
 
+  # @param [String] content_type
   # @param [Integer] status_code
-  def validate_response_body(status_code, content_type, data)
-    operation_object&.validate_response_body(status_code, content_type, data)
+  # @param [Hash] data
+  # @param [OpenAPIParser::SchemaValidator::ResponseValidateOptions] response_validate_options
+  def validate_response_body(status_code, content_type, data, response_validate_options = nil)
+    response_validate_options ||= config.response_validate_options
+    operation_object&.validate_response_body(status_code, content_type, data, response_validate_options)
   end
 
   def validate_request_parameter(params, options = nil)

data/lib/openapi_parser/schema_validators/options.rb

@@ -1,5 +1,9 @@
 class OpenAPIParser::SchemaValidator
   class Options
+    # @!attribute [r] coerce_value
+    #   @return [Boolean] coerce value option on/off
+    # @!attribute [r] datetime_coerce_class
+    #   @return [Object, nil] coerce datetime string by this Object class
     attr_reader :coerce_value, :datetime_coerce_class
 
     def initialize(coerce_value: nil, datetime_coerce_class: nil)
@@ -7,4 +11,15 @@ class OpenAPIParser::SchemaValidator
       @datetime_coerce_class = datetime_coerce_class
     end
   end
+
+  # response body validation option
+  class ResponseValidateOptions
+    # @!attribute [r] strict
+    #   @return [Boolean] validate by strict (when not exist definition, raise error)
+    attr_reader :strict
+
+    def initialize(strict: false)
+      @strict = strict
+    end
+  end
 end

data/lib/openapi_parser/schemas/operation.rb

@@ -23,9 +23,12 @@ module OpenAPIParser::Schemas
       request_body&.validate_request_body(content_type, params, options)
     end
 
+    # @param [String] content_type
     # @param [Integer] status_code
-    def validate_response_body(status_code, content_type, data)
-      responses&.validate_response_body(status_code, content_type, data)
+    # @param [Hash] data
+    # @param [OpenAPIParser::SchemaValidator::ResponseValidateOptions] response_validate_options
+    def validate_response_body(status_code, content_type, data, response_validate_options)
+      responses&.validate_response_body(status_code, content_type, data, response_validate_options)
     end
 
     # @param [OpenAPIParser::SchemaValidator::Options] options

data/lib/openapi_parser/schemas/response.rb

@@ -11,9 +11,16 @@ module OpenAPIParser::Schemas
     #   @return [Hash{String => MediaType}, nil] content_type to MediaType hash
     openapi_attr_hash_object :content, MediaType, reference: false
 
-    def validate_parameter(content_type, params)
+    # @param [String] content_type
+    # @param [Hash] params
+    # @param [OpenAPIParser::SchemaValidator::ResponseValidateOptions] response_validate_options
+    def validate_parameter(content_type, params, response_validate_options)
       media_type = select_media_type(content_type)
-      return nil unless media_type
+      unless media_type
+        raise ::OpenAPIParser::NotExistContentTypeDefinition, object_reference if response_validate_options.strict
+
+        return nil
+      end
 
       options = ::OpenAPIParser::SchemaValidator::Options.new # response validator not support any options
       media_type.validate_parameter(params, options)

data/lib/openapi_parser/schemas/responses.rb

@@ -16,21 +16,36 @@ module OpenAPIParser::Schemas
     # @param [Integer] status_code
     # @param [String] content_type
     # @param [Hash] params
-    def validate_response_body(status_code, content_type, params)
+    # @param [OpenAPIParser::SchemaValidator::ResponseValidateOptions] response_validate_options
+    def validate_response_body(status_code, content_type, params, response_validate_options)
       return nil unless response
 
-      res = response[status_code.to_s]
-      return res.validate_parameter(content_type, params) if res
+      if (res = find_response_object(status_code))
+        return res.validate_parameter(content_type, params, response_validate_options)
+      end
 
-      wild_card = status_code_to_wild_card(status_code)
-      res = response[wild_card]
-      return res.validate_parameter(content_type, params) if res
+      raise ::OpenAPIParser::NotExistStatusCodeDefinition, object_reference if response_validate_options.strict
 
-      default&.validate_parameter(content_type, params)
+      nil
     end
 
     private
 
+      # @param [Integer] status_code
+      # @return [Response]
+      def find_response_object(status_code)
+        if (res = response[status_code.to_s])
+          return res
+        end
+
+        wild_card = status_code_to_wild_card(status_code)
+        if (res = response[wild_card])
+          return res
+        end
+
+        default
+      end
+
       # parse 400 -> 4xx
       # OpenAPI3 allow 1xx, 2xx, 3xx... only, don't allow 41x
       # @param [Integer] status_code

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.1.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - ota42y
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2019-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler