openapi_first 0.11.0.alpha → 0.12.1

data/lib/openapi_first/response_validator.rb

@@ -3,61 +3,20 @@
 require 'json_schemer'
 require 'multi_json'
 require_relative 'validation'
+require_relative 'router'
 
 module OpenapiFirst
   class ResponseValidator
     def initialize(spec)
       @spec = spec
+      @router = Router.new(->(_env) {}, spec: spec, raise_error: true)
+      @response_validation = ResponseValidation.new(->(response) { response.to_a })
     end
 
     def validate(request, response)
-      errors = validation_errors(request, response)
-      Validation.new(errors || [])
-    rescue OasParser::ResponseCodeNotFound, OasParser::MethodNotFound => e
-      Validation.new([e.message])
-    end
-
-    def validate_operation(request, response)
-      errors = validation_errors(request, response)
-      Validation.new(errors || [])
-    rescue OasParser::ResponseCodeNotFound, OasParser::MethodNotFound => e
-      Validation.new([e.message])
-    end
-
-    private
-
-    def validation_errors(request, response)
-      content = response_for(request, response)&.content
-      return unless content
-
-      content_type = content[response.content_type]
-      return ["Content type not found: '#{response.content_type}'"] unless content_type
-
-      response_schema = content_type['schema']
-      return unless response_schema
-
-      response_data = MultiJson.load(response.body)
-      validate_json_schema(response_schema, response_data)
-    end
-
-    def validate_json_schema(schema, data)
-      JSONSchemer.schema(schema).validate(data).to_a.map do |error|
-        format_error(error)
-      end
-    end
-
-    def format_error(error)
-      ValidationFormat.error_details(error)
-                      .merge!(
-                        data_pointer: error['data_pointer'],
-                        schema_pointer: error['schema_pointer']
-                      )
-    end
-
-    def response_for(request, response)
-      @spec
-        .find_operation!(request)
-        &.response_by_code(response.status.to_s, use_default: true)
+      env = request.env.dup
+      @router.call(env)
+      @response_validation.validate(response, env[OPERATION])
     end
   end
 end

data/lib/openapi_first/router.rb

@@ -6,52 +6,49 @@ require_relative 'utils'
 
 module OpenapiFirst
   class Router
-    NOT_FOUND = Rack::Response.new('', 404).finish.freeze
-    DEFAULT_NOT_FOUND_APP = ->(_env) { NOT_FOUND }
-
-    def initialize(app, options) # rubocop:disable Metrics/MethodLength
+    def initialize(
+      app,
+      spec:,
+      raise_error: false,
+      parent_app: nil
+    )
       @app = app
-      @parent_app = options.fetch(:parent_app, nil)
-      @raise = options.fetch(:raise, false)
-      @failure_app = find_failure_app(options[:not_found])
-      if @failure_app.nil?
-        raise ArgumentError,
-              'not_found must be nil, :continue or must respond to call'
-      end
-      spec = options.fetch(:spec)
+      @parent_app = parent_app
+      @raise = raise_error
       @filepath = spec.filepath
       @router = build_router(spec.operations)
     end
 
     def call(env)
-      endpoint = find_endpoint(env)
-      return endpoint.call(env) if endpoint
+      env[OPERATION] = nil
+      response = call_router(env)
+      status = response[0]
+      if UNKNOWN_ROUTE_STATUS.include?(status) && env[OPERATION].nil?
+        return @parent_app.call(env) if @parent_app # This should only happen if used via OpenapiFirst.middlware
 
-      if @raise
-        req = Rack::Request.new(env)
-        msg = "Could not find definition for #{req.request_method} '#{req.path}' in API description #{@filepath}"
-        raise NotFoundError, msg
+        raise_error(env) if @raise
       end
-      return @parent_app.call(env) if @parent_app
-
-      @failure_app.call(env)
+      response
     end
 
-    private
+    UNKNOWN_ROUTE_STATUS = [404, 405].freeze
+    ORIGINAL_PATH = 'openapi_first.path_info'
 
-    def find_failure_app(option)
-      return DEFAULT_NOT_FOUND_APP if option.nil?
-      return @app if option == :continue
+    private
 
-      option if option.respond_to?(:call)
+    def raise_error(env)
+      req = Rack::Request.new(env)
+      msg = "Could not find definition for #{req.request_method} '#{req.path}' in API description #{@filepath}"
+      raise NotFoundError, msg
     end
 
-    def find_endpoint(env)
-      original_path_info = env[Rack::PATH_INFO]
+    def call_router(env)
+      # Changing and restoring PATH_INFO is needed, because Hanami::Router does not respect existing script_path
+      env[ORIGINAL_PATH] = env[Rack::PATH_INFO]
       env[Rack::PATH_INFO] = Rack::Request.new(env).path
-      @router.recognize(env).endpoint
+      @router.call(env)
     ensure
-      env[Rack::PATH_INFO] = original_path_info
+      env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH) if env[ORIGINAL_PATH]
     end
 
     def build_router(operations) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -67,7 +64,8 @@ module OpenapiFirst
           normalized_path,
           to: lambda do |env|
             env[OPERATION] = operation
-            env[PARAMETERS] = Utils.deep_stringify(env['router.params'])
+            env[PARAMETERS] = env['router.params']
+            env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH)
             @app.call(env)
           end
         )

data/lib/openapi_first/router_required.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module RouterRequired
+    def call(env)
+      unless env.key?(OPERATION)
+        raise 'OpenapiFirst::Router missing in middleware stack. Did you forget adding OpenapiFirst::Router?'
+      end
+
+      super
+    end
+  end
+end

data/lib/openapi_first/validation_format.rb

@@ -5,6 +5,7 @@ module OpenapiFirst
     SIMPLE_TYPES = %w[string integer].freeze
 
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def self.error_details(error)
       if error['type'] == 'pattern'
         {
@@ -23,9 +24,10 @@ module OpenapiFirst
       elsif error['schema'] == false
         { title: 'unknown fields are not allowed' }
       else
-        { title: 'is not valid' }
+        { title: "is not valid: #{error['data'].inspect}" }
       end
     end
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.11.0.alpha'
+  VERSION = '0.12.1'
 end

data/openapi_first.gemspec

@@ -32,13 +32,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'deep_merge', '>= 1.2.1'
-  spec.add_dependency 'hanami-router', '~> 2.0.alpha3'
-  spec.add_dependency 'hanami-utils', '~> 2.0.alpha1'
-  spec.add_dependency 'json_schemer', '~> 0.2'
-  spec.add_dependency 'multi_json', '~> 1.14'
-  spec.add_dependency 'oas_parser', '~> 0.25.1'
-  spec.add_dependency 'rack', '~> 2.2'
+  spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
+  spec.add_runtime_dependency 'hanami-router', '~> 2.0.alpha3'
+  spec.add_runtime_dependency 'hanami-utils', '~> 2.0.alpha1'
+  spec.add_runtime_dependency 'json_schemer', '~> 0.2'
+  spec.add_runtime_dependency 'multi_json', '~> 1.14'
+  spec.add_runtime_dependency 'oas_parser', '~> 0.25.1'
+  spec.add_runtime_dependency 'rack', '~> 2.2'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rack-test', '~> 1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.11.0.alpha
+  version: 0.12.1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -206,12 +206,13 @@ files:
 - lib/openapi_first/find_handler.rb
 - lib/openapi_first/inbox.rb
 - lib/openapi_first/operation.rb
-- lib/openapi_first/operation_resolver.rb
 - lib/openapi_first/request_validation.rb
+- lib/openapi_first/responder.rb
 - lib/openapi_first/response_object.rb
 - lib/openapi_first/response_validation.rb
 - lib/openapi_first/response_validator.rb
 - lib/openapi_first/router.rb
+- lib/openapi_first/router_required.rb
 - lib/openapi_first/utils.rb
 - lib/openapi_first/validation.rb
 - lib/openapi_first/validation_format.rb
@@ -235,9 +236,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: