openapi_first 0.13.3 → 0.14.3

data/benchmarks/apps/openapi.yaml

@@ -28,15 +28,13 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  type: object
-                  required: [hello, id]
-                  properties:
-                    hello:
-                      type: string
-                    id:
-                      type: string
+                type: object
+                required: [hello, id]
+                properties:
+                  hello:
+                    type: string
+                  id:
+                    type: string
   /hello:
     get:
       operationId: find_things
@@ -61,11 +59,13 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [hello]
-                properties:
-                  hello:
-                    type: string
+                type: array
+                items:
+                  type: object
+                  required: [hello]
+                  properties:
+                    hello:
+                      type: string
         default:
           description: Error response
 

data/benchmarks/apps/openapi_first_with_hanami_api.ru

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+require 'hanami/api'
+
+app = Class.new(Hanami::API) do
+  get '/hello/:id' do
+    json(hello: 'world', id: params.fetch(:id))
+  end
+
+  get '/hello' do
+    json([{ hello: 'world' }])
+  end
+
+  post '/hello' do
+    status 201
+    json(hello: 'world')
+  end
+end.new
+
+oas_path = File.absolute_path('./openapi.yaml', __dir__)
+use OpenapiFirst::Router, spec: OpenapiFirst.load(oas_path)
+use OpenapiFirst::RequestValidation
+
+run app

data/benchmarks/apps/openapi_first_with_response_validation.ru

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+
+namespace = Module.new do
+  def self.find_thing(params, _res)
+    { hello: 'world', id: params.fetch(:id) }
+  end
+
+  def self.find_things(_params, _res)
+    [{ hello: 'world' }]
+  end
+
+  def self.create_thing(_params, res)
+    res.status = 201
+    { hello: 'world' }
+  end
+end
+
+oas_path = File.absolute_path('./openapi.yaml', __dir__)
+run OpenapiFirst.app(oas_path, namespace: namespace, response_validation: true)

data/benchmarks/benchmarks.rb

@@ -19,28 +19,25 @@ apps = Dir['./apps/*.ru'].each_with_object({}) do |config, hash|
 end
 apps.freeze
 
+bench = lambda do |app|
+  examples.each do |example|
+    env, expected_status = example
+    100.times { app.call(env) }
+    response = app.call(env)
+    raise unless response[0] == expected_status
+  end
+end
+
 Benchmark.ips do |x|
   apps.each do |config, app|
-    x.report(config) do
-      examples.each do |example|
-        env, expected_status = example
-        response = app.call(env)
-        raise unless response[0] == expected_status
-      end
-    end
+    x.report(config) { bench.call(app) }
   end
   x.compare!
 end
 
 Benchmark.memory do |x|
   apps.each do |config, app|
-    x.report(config) do
-      examples.each do |example|
-        env, expected_status = example
-        response = app.call(env)
-        raise unless response[0] == expected_status
-      end
-    end
+    x.report(config) { bench.call(app) }
   end
   x.compare!
 end

data/lib/openapi_first/app.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rack'
-require 'logger'
 
 module OpenapiFirst
   class App
@@ -11,17 +10,15 @@ module OpenapiFirst
       namespace:,
       router_raise_error: false,
       request_validation_raise_error: false,
-      response_validation: false
+      response_validation: false,
+      resolver: nil
     )
       @stack = Rack::Builder.app do
         freeze_app
         use OpenapiFirst::Router, spec: spec, raise_error: router_raise_error, parent_app: parent_app
         use OpenapiFirst::RequestValidation, raise_error: request_validation_raise_error
         use OpenapiFirst::ResponseValidation if response_validation
-        run OpenapiFirst::Responder.new(
-          spec: spec,
-          namespace: namespace
-        )
+        run OpenapiFirst::Responder.new(namespace: namespace, resolver: resolver)
       end
     end
 

data/lib/openapi_first/{find_handler.rb → default_operation_resolver.rb}

@@ -3,20 +3,14 @@
 require_relative 'utils'
 
 module OpenapiFirst
-  class FindHandler
-    def initialize(spec, namespace)
+  class DefaultOperationResolver
+    def initialize(namespace)
       @namespace = namespace
-      @handlers = spec.operations.each_with_object({}) do |operation, hash|
-        operation_id = operation.operation_id
-        handler = find_handler(operation_id)
-        next if handler.nil?
-
-        hash[operation_id] = handler
-      end
+      @handlers = {}
     end
 
-    def [](operation_id)
-      @handlers[operation_id]
+    def call(operation)
+      @handlers[operation.name] ||= find_handler(operation['x-handler'] || operation['operationId'])
     end
 
     def find_handler(operation_id)

data/lib/openapi_first/definition.rb

@@ -6,9 +6,14 @@ module OpenapiFirst
   class Definition
     attr_reader :filepath, :operations
 
-    def initialize(parsed)
-      @filepath = parsed.path
-      @operations = parsed.endpoints.map { |e| Operation.new(e) }
+    def initialize(resolved, filepath)
+      @filepath = filepath
+      methods = %w[get head post put patch delete trace options]
+      @operations = resolved['paths'].flat_map do |path, path_item|
+        path_item.slice(*methods).map do |request_method, _operation_object|
+          Operation.new(path, request_method, path_item)
+        end
+      end
     end
   end
 end

data/lib/openapi_first/operation.rb

@@ -1,29 +1,30 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'json_schemer'
 require_relative 'schema_validation'
 require_relative 'utils'
 require_relative 'response_object'
 
 module OpenapiFirst
-  class Operation
+  class Operation # rubocop:disable Metrics/ClassLength
     extend Forwardable
-    def_delegators :@operation,
-                   :parameters,
-                   :method,
-                   :request_body,
-                   :operation_id
+    def_delegators :operation_object,
+                   :[],
+                   :dig
 
     WRITE_METHODS = Set.new(%w[post put patch delete]).freeze
     private_constant :WRITE_METHODS
 
-    def initialize(parsed)
-      @operation = parsed
+    attr_reader :path, :method
+
+    def initialize(path, request_method, path_item_object)
+      @path = path
+      @method = request_method
+      @path_item_object = path_item_object
     end
 
-    def path
-      @operation.path.path
+    def operation_id
+      operation_object['operationId']
     end
 
     def read?
@@ -34,6 +35,10 @@ module OpenapiFirst
       WRITE_METHODS.include?(method)
     end
 
+    def request_body
+      operation_object['requestBody']
+    end
+
     def parameters_schema
       @parameters_schema ||= begin
         parameters_json_schema = build_parameters_json_schema
@@ -53,6 +58,7 @@ module OpenapiFirst
       raise ResponseInvalid, "Response has no content-type for '#{name}'" unless content_type
 
       media_type = find_content_for_content_type(content, content_type)
+
       unless media_type
         message = "Response content type not found '#{content_type}' for '#{name}'"
         raise ResponseContentTypeNotFoundError, message
@@ -62,7 +68,7 @@ module OpenapiFirst
     end
 
     def request_body_schema(request_content_type)
-      content = @operation.request_body.content
+      content = operation_object.dig('requestBody', 'content')
       media_type = find_content_for_content_type(content, request_content_type)
       schema = media_type&.fetch('schema', nil)
       return unless schema
@@ -71,8 +77,9 @@ module OpenapiFirst
     end
 
     def response_for(status)
-      @operation.response_by_code(status.to_s, use_default: true).raw
-    rescue OasParser::ResponseCodeNotFound
+      response_content = response_by_code(status)
+      return response_content if response_content
+
       message = "Response status code or default not found: #{status} for '#{name}'"
       raise OpenapiFirst::ResponseCodeNotFoundError, message
     end
@@ -83,6 +90,15 @@ module OpenapiFirst
 
     private
 
+    def response_by_code(status)
+      operation_object.dig('responses', status.to_s) ||
+        operation_object.dig('responses', 'default')
+    end
+
+    def operation_object
+      @path_item_object[method]
+    end
+
     def find_content_for_content_type(content, request_content_type)
       content.fetch(request_content_type) do |_|
         type = request_content_type.split(';')[0]
@@ -91,24 +107,32 @@ module OpenapiFirst
     end
 
     def build_parameters_json_schema
-      return unless @operation.parameters&.any?
+      parameters = all_parameters
+      return unless parameters&.any?
 
-      @operation.parameters.each_with_object(new_node) do |parameter, schema|
-        params = Rack::Utils.parse_nested_query(parameter.name)
+      parameters.each_with_object(new_node) do |parameter, schema|
+        params = Rack::Utils.parse_nested_query(parameter['name'])
         generate_schema(schema, params, parameter)
       end
     end
 
+    def all_parameters
+      parameters = @path_item_object['parameters']&.dup || []
+      parameters_on_operation = operation_object['parameters']
+      parameters.concat(parameters_on_operation) if parameters_on_operation
+      parameters
+    end
+
     def generate_schema(schema, params, parameter)
       required = Set.new(schema['required'])
       params.each do |key, value|
-        required << key if parameter.required
+        required << key if parameter['required']
         if value.is_a? Hash
           property_schema = new_node
           generate_schema(property_schema, value, parameter)
           Utils.deep_merge!(schema['properties'], { key => property_schema })
         else
-          schema['properties'][key] = parameter.schema
+          schema['properties'][key] = parameter['schema']
         end
       end
       schema['required'] = required.to_a

data/lib/openapi_first/request_validation.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rack'
-require 'json_schemer'
 require 'multi_json'
 require_relative 'inbox'
 require_relative 'router_required'
@@ -63,13 +62,13 @@ module OpenapiFirst
     end
 
     def validate_request_content_type!(content_type, operation)
-      return if operation.request_body.content[content_type]
+      return if operation.request_body.dig('content', content_type)
 
       halt_with_error(415)
     end
 
     def validate_request_body_presence!(body, operation)
-      return unless operation.request_body.required && body.empty?
+      return unless operation.request_body['required'] && body.empty?
 
       halt_with_error(415, 'Request body is required')
     end
@@ -142,6 +141,8 @@ module OpenapiFirst
     end
 
     def parse_array_parameter(value, schema)
+      return value if value.nil? || value.empty?
+
       array = value.is_a?(Array) ? value : value.split(',')
       return array unless schema['items']
 

data/lib/openapi_first/responder.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require 'rack'
+require 'multi_json'
 require_relative 'inbox'
-require_relative 'find_handler'
+require_relative 'default_operation_resolver'
 
 module OpenapiFirst
   class Responder
-    def initialize(spec:, namespace:, resolver: FindHandler.new(spec, namespace))
-      @resolver = resolver
+    def initialize(namespace: nil, resolver: nil)
+      @resolver = resolver || DefaultOperationResolver.new(namespace)
       @namespace = namespace
     end
 
@@ -24,7 +25,7 @@ module OpenapiFirst
     private
 
     def find_handler(operation)
-      handler = @resolver[operation.operation_id]
+      handler = @resolver.call(operation)
       raise NotImplementedError, "Could not find handler for #{operation.name}" unless handler
 
       handler

data/lib/openapi_first/response_object.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require_relative 'utils'
 
 module OpenapiFirst
   # Represents an OpenAPI Response Object

data/lib/openapi_first/response_validation.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'json_schemer'
 require 'multi_json'
 require_relative 'router_required'
-require_relative 'validation'
+require_relative 'validation_format'
 
 module OpenapiFirst
   class ResponseValidation

data/lib/openapi_first/response_validator.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'json_schemer'
-require 'multi_json'
-require_relative 'validation'
+require_relative 'response_validation'
 require_relative 'router'
 
 module OpenapiFirst

data/lib/openapi_first/router.rb

@@ -2,7 +2,6 @@
 
 require 'rack'
 require 'hanami/router'
-require_relative 'utils'
 
 module OpenapiFirst
   class Router
@@ -40,7 +39,10 @@ module OpenapiFirst
 
     def raise_error(env)
       req = Rack::Request.new(env)
-      msg = "Could not find definition for #{req.request_method} '#{req.path}' in API description #{@filepath}"
+      msg =
+        "Could not find definition for #{req.request_method} '#{
+          req.path
+        }' in API description #{@filepath}"
       raise NotFoundError, msg
     end
 
@@ -54,7 +56,7 @@ module OpenapiFirst
     end
 
     def build_router(operations) # rubocop:disable Metrics/AbcSize
-      router = Hanami::Router.new {}
+      router = Hanami::Router.new
       operations.each do |operation|
         normalized_path = operation.path.gsub('{', ':').gsub('}', '')
         if operation.operation_id.nil?

data/lib/openapi_first/validation_format.rb

@@ -19,6 +19,11 @@ module OpenapiFirst
           title: "has not a valid #{error.dig('schema', 'format')} format",
           detail: "#{error['data'].inspect} is not a valid #{error.dig('schema', 'format')} format"
         }
+      elsif error['type'] == 'enum'
+        {
+          title: "value #{error['data'].inspect} is not defined in enum",
+          detail: "value can be one of #{error.dig('schema', 'enum')&.join(', ')}"
+        }
       elsif error['type'] == 'required'
         missing_keys = error['details']['missing_keys']
         {

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.13.3'
+  VERSION = '0.14.3'
 end

data/lib/openapi_first.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'oas_parser'
-require 'openapi_first/definition'
-require 'openapi_first/version'
-require 'openapi_first/inbox'
-require 'openapi_first/router'
-require 'openapi_first/request_validation'
-require 'openapi_first/response_validator'
-require 'openapi_first/response_validation'
-require 'openapi_first/responder'
-require 'openapi_first/app'
+require 'json_refs'
+require_relative 'openapi_first/definition'
+require_relative 'openapi_first/version'
+require_relative 'openapi_first/inbox'
+require_relative 'openapi_first/router'
+require_relative 'openapi_first/request_validation'
+require_relative 'openapi_first/response_validator'
+require_relative 'openapi_first/response_validation'
+require_relative 'openapi_first/responder'
+require_relative 'openapi_first/app'
 
 module OpenapiFirst
   OPERATION = 'openapi_first.operation'
@@ -24,11 +24,12 @@ module OpenapiFirst
   end
 
   def self.load(spec_path, only: nil)
-    content = YAML.load_file(spec_path)
-    raw = OasParser::Parser.new(spec_path, content).resolve
-    raw['paths'].filter!(&->(key, _) { only.call(key) }) if only
-    parsed = OasParser::Definition.new(raw, spec_path)
-    Definition.new(parsed)
+    resolved = Dir.chdir(File.dirname(spec_path)) do
+      content = YAML.load_file(File.basename(spec_path))
+      JsonRefs.call(content, resolve_local_ref: true, resolve_file_ref: true)
+    end
+    resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
+    Definition.new(resolved, spec_path)
   end
 
   def self.app(
@@ -78,11 +79,17 @@ module OpenapiFirst
   end
 
   class Error < StandardError; end
+
   class NotFoundError < Error; end
+
   class NotImplementedError < RuntimeError; end
+
   class ResponseInvalid < Error; end
+
   class ResponseCodeNotFoundError < ResponseInvalid; end
+
   class ResponseContentTypeNotFoundError < ResponseInvalid; end
+
   class ResponseBodyInvalidError < ResponseInvalid; end
 
   class RequestInvalidError < Error

data/openapi_first.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
     spec.metadata['changelog_uri'] = 'https://github.com/ahx/openapi_first/blob/master/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -35,15 +35,18 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
-  spec.add_runtime_dependency 'hanami-router', '~> 2.0.alpha3'
+  spec.add_runtime_dependency 'hanami-router', '~> 2.0.alpha4'
   spec.add_runtime_dependency 'hanami-utils', '~> 2.0.alpha1'
+  spec.add_runtime_dependency 'json_refs', '>= 0.1.7'
   spec.add_runtime_dependency 'json_schemer', '~> 0.2.16'
   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'
   spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end