openapi_first 0.21.0 → 1.0.0.beta3

data/examples/app.rb

@@ -1,22 +1,18 @@
 # frozen_string_literal: true
 
 require 'openapi_first'
+require 'rack'
 
-module Web
-  module Things
-    class Index
-      def call(_params, _response)
-        { hello: 'world' }
-      end
-    end
-  end
-end
+# This example is a bit contrived, but it shows what you could do with the middlewares
+
+App = Rack::Builder.new do
+  use OpenapiFirst::RequestValidation, raise_error: true, spec: File.expand_path('./openapi.yaml', __dir__)
+  use OpenapiFirst::ResponseValidation
 
-oas_path = File.absolute_path('./openapi.yaml', __dir__)
+  handlers = {
+    'things#index' => ->(_env) { [200, { 'Content-Type' => 'application/json' }, ['{"hello": "world"}']] }
+  }
+  not_found = ->(_env) { [404, {}, []] }
 
-App = OpenapiFirst.app(
-  oas_path,
-  namespace: Web,
-  router_raise_error: OpenapiFirst.env == 'test',
-  response_validation: OpenapiFirst.env == 'test'
-)
+  run ->(env) { handlers.fetch(env[OpenapiFirst::OPERATION].operation_id, not_found).call(env) }
+end

data/lib/openapi_first/operation.rb

@@ -4,10 +4,9 @@ require 'forwardable'
 require 'set'
 require_relative 'schema_validation'
 require_relative 'utils'
-require_relative 'response_object'
 
 module OpenapiFirst
-  class Operation # rubocop:disable Metrics/ClassLength
+  class Operation
     extend Forwardable
     def_delegators :operation_object,
                    :[],
@@ -40,24 +39,6 @@ module OpenapiFirst
       operation_object['requestBody']
     end
 
-    def parameters_schema
-      @parameters_schema ||= begin
-        parameters_json_schema = build_parameters_json_schema
-        parameters_json_schema && SchemaValidation.new(parameters_json_schema)
-      end
-    end
-
-    def query_parameters_schema
-      @query_parameters_schema ||= begin
-        query_parameters_json_schema = build_query_parameters_json_schema
-        query_parameters_json_schema && SchemaValidation.new(query_parameters_json_schema)
-      end
-    end
-
-    def content_types_for(status)
-      response_for(status)['content']&.keys
-    end
-
     def response_schema_for(status, content_type)
       content = response_for(status)['content']
       return if content.nil? || content.empty?
@@ -102,6 +83,23 @@ module OpenapiFirst
       !!find_content_for_content_type(content, request_content_type)
     end
 
+    def query_parameters
+      @query_parameters ||= all_parameters.filter { |p| p['in'] == 'query' }
+    end
+
+    def path_parameters
+      @path_parameters ||= all_parameters.filter { |p| p['in'] == 'path' }
+    end
+
+    def all_parameters
+      @all_parameters ||= begin
+        parameters = @path_item_object['parameters']&.dup || []
+        parameters_on_operation = operation_object['parameters']
+        parameters.concat(parameters_on_operation) if parameters_on_operation
+        parameters
+      end
+    end
+
     private
 
     def response_by_code(status)
@@ -121,55 +119,5 @@ module OpenapiFirst
         content[type] || content["#{type.split('/')[0]}/*"] || content['*/*']
       end
     end
-
-    def build_parameters_json_schema
-      parameters = all_parameters
-      return unless parameters&.any?
-
-      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 build_query_parameters_json_schema
-      query_parameters = all_parameters.reject { |field, _value| field['in'] == 'header' }
-      return unless query_parameters&.any?
-
-      query_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']
-        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']
-        end
-      end
-      schema['required'] = required.to_a
-    end
-
-    def new_node
-      {
-        'type' => 'object',
-        'required' => [],
-        'properties' => {}
-      }
-    end
   end
 end

data/lib/openapi_first/request_validation.rb

@@ -2,12 +2,12 @@
 
 require 'rack'
 require 'multi_json'
-require_relative 'inbox'
 require_relative 'use_router'
 require_relative 'validation_format'
+require 'openapi_parameters'
 
 module OpenapiFirst
-  class RequestValidation # rubocop:disable Metrics/ClassLength
+  class RequestValidation
     prepend UseRouter
 
     def initialize(app, options = {})
@@ -19,17 +19,17 @@ module OpenapiFirst
       operation = env[OPERATION]
       return @app.call(env) unless operation
 
-      env[INBOX] = {}
       error = catch(:error) do
-        params = validate_query_parameters!(operation, env[PARAMETERS])
-        env[INBOX].merge! env[PARAMETERS] = params if params
-        req = Rack::Request.new(env)
+        query_params = OpenapiParameters::Query.new(operation.query_parameters).unpack(env['QUERY_STRING'])
+        validate_query_parameters!(operation, query_params)
+        env[PARAMS].merge!(query_params)
+
         return @app.call(env) unless operation.request_body
 
-        validate_request_content_type!(operation, req.content_type)
-        parsed_request_body = parse_and_validate_request_body!(operation, req)
-        env[REQUEST_BODY] = parsed_request_body
-        env[INBOX].merge! parsed_request_body if parsed_request_body.is_a?(Hash)
+        content_type = Rack::Request.new(env).content_type
+        validate_request_content_type!(operation, content_type)
+        parsed_request_body = env[REQUEST_BODY]
+        validate_request_body!(operation, parsed_request_body, content_type)
         nil
       end
       if error
@@ -42,23 +42,15 @@ module OpenapiFirst
 
     private
 
-    ROUTER_PARSED_BODY = 'router.parsed_body'
-
-    def parse_and_validate_request_body!(operation, request)
-      env = request.env
-
-      body = env.delete(ROUTER_PARSED_BODY) if env.key?(ROUTER_PARSED_BODY)
-
+    def validate_request_body!(operation, body, content_type)
       validate_request_body_presence!(body, operation)
-      return if body.nil?
+      return if content_type.nil?
 
-      schema = operation&.request_body_schema(request.content_type)
+      schema = operation&.request_body_schema(content_type)
       return unless schema
 
       errors = schema.validate(body)
       throw_error(400, serialize_request_body_errors(errors)) if errors.any?
-      return Utils.deep_symbolize(body) if body.is_a?(Hash)
-
       body
     end
 
@@ -104,30 +96,29 @@ module OpenapiFirst
       end
     end
 
-    def validate_query_parameters!(operation, params)
-      schema = operation.query_parameters_schema
-      return unless schema
-
-      params = filtered_params(schema.raw_schema, params)
-      params = Utils.deep_stringify(params)
-      errors = schema.validate(params)
-      throw_error(400, serialize_query_parameter_errors(errors)) if errors.any?
-      Utils.deep_symbolize(params)
+    def build_json_schema(parameter_defs)
+      init_schema = {
+        'type' => 'object',
+        'properties' => {},
+        'required' => []
+      }
+      parameter_defs.each_with_object(init_schema) do |parameter_def, schema|
+        parameter = OpenapiParameters::Parameter.new(parameter_def)
+        schema['properties'][parameter.name] = parameter.schema if parameter.schema
+        schema['required'] << parameter.name if parameter.required?
+      end
     end
 
-    def filtered_params(json_schema, params)
-      json_schema['properties']
-        .each_with_object({}) do |key_value, result|
-          parameter_name = key_value[0].to_sym
-          schema = key_value[1]
-          next unless params.key?(parameter_name)
+    def validate_query_parameters!(operation, params)
+      parameter_defs = operation.query_parameters
+      return unless parameter_defs&.any?
 
-          value = params[parameter_name]
-          result[parameter_name] = parse_parameter(value, schema)
-        end
+      json_schema = build_json_schema(parameter_defs)
+      errors = SchemaValidation.new(json_schema).validate(params)
+      throw_error(400, serialize_parameter_errors(errors)) if errors.any?
     end
 
-    def serialize_query_parameter_errors(validation_errors)
+    def serialize_parameter_errors(validation_errors)
       validation_errors.map do |error|
         pointer = error['data_pointer'][1..].to_s
         {
@@ -135,41 +126,5 @@ module OpenapiFirst
         }.update(ValidationFormat.error_details(error))
       end
     end
-
-    def parse_parameter(value, schema)
-      return filtered_params(schema, value) if schema['properties']
-
-      return parse_array_parameter(value, schema) if schema['type'] == 'array'
-
-      parse_simple_value(value, schema)
-    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']
-
-      array.map! { |e| parse_simple_value(e, schema['items']) }
-    end
-
-    def parse_simple_value(value, schema)
-      return to_boolean(value) if schema['type'] == 'boolean'
-
-      begin
-        return Integer(value, 10) if schema['type'] == 'integer'
-        return Float(value) if schema['type'] == 'number'
-      rescue ArgumentError
-        value
-      end
-      value
-    end
-
-    def to_boolean(value)
-      return true if value == 'true'
-      return false if value == 'false'
-
-      value
-    end
   end
 end

data/lib/openapi_first/router.rb

@@ -12,7 +12,6 @@ module OpenapiFirst
       options
     )
       @app = app
-      @parent_app = options.fetch(:parent_app, nil)
       @raise = options.fetch(:raise_error, false)
       @not_found = options.fetch(:not_found, :halt)
       spec = options.fetch(:spec)
@@ -28,8 +27,6 @@ module OpenapiFirst
       env[OPERATION] = nil
       response = call_router(env)
       if env[OPERATION].nil?
-        return @parent_app.call(env) if @parent_app # This should only happen if used via OpenapiFirst.middleware
-
         raise_error(env) if @raise
 
         return @app.call(env) if @not_found == :continue
@@ -39,6 +36,10 @@ module OpenapiFirst
     end
 
     ORIGINAL_PATH = 'openapi_first.path_info'
+    private_constant :ORIGINAL_PATH
+
+    ROUTER_PARSED_BODY = 'router.parsed_body'
+    private_constant :ROUTER_PARSED_BODY
 
     private
 
@@ -96,8 +97,11 @@ module OpenapiFirst
     def build_route(operation)
       lambda do |env|
         env[OPERATION] = operation
-        env[PARAMETERS] = env['router.params']
-        env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH)
+        path_info = env.delete(ORIGINAL_PATH)
+        env[REQUEST_BODY] = env.delete(ROUTER_PARSED_BODY) if env.key?(ROUTER_PARSED_BODY)
+        route_params = Utils::StringKeyedHash.new(env['router.params'])
+        env[PARAMS] = OpenapiParameters::Path.new(operation.path_parameters).unpack(route_params)
+        env[Rack::PATH_INFO] = path_info
         @app.call(env)
       end
     end

data/lib/openapi_first/utils.rb

@@ -1,29 +1,19 @@
 # frozen_string_literal: true
 
-require 'hanami/utils/string'
-require 'hanami/utils/hash'
-require 'deep_merge/core'
-
 module OpenapiFirst
   module Utils
-    def self.deep_merge!(dest, source)
-      DeepMerge.deep_merge!(source, dest)
-    end
-
-    def self.underscore(string)
-      Hanami::Utils::String.underscore(string)
-    end
+    class StringKeyedHash
+      def initialize(original)
+        @orig = original
+      end
 
-    def self.classify(string)
-      Hanami::Utils::String.classify(string)
-    end
-
-    def self.deep_symbolize(hash)
-      Hanami::Utils::Hash.deep_symbolize(hash)
-    end
+      def key?(key)
+        @orig.key?(key.to_sym)
+      end
 
-    def self.deep_stringify(hash)
-      Hanami::Utils::Hash.deep_stringify(hash)
+      def [](key)
+        @orig[key.to_sym]
+      end
     end
   end
 end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.21.0'
+  VERSION = '1.0.0.beta3'
 end

data/lib/openapi_first.rb

@@ -5,19 +5,15 @@ require 'json_refs'
 require_relative 'openapi_first/definition'
 require_relative 'openapi_first/version'
 require_relative 'openapi_first/errors'
-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'
-  PARAMETERS = 'openapi_first.parameters'
-  REQUEST_BODY = 'openapi_first.parsed_request_body'
-  INBOX = 'openapi_first.inbox'
+  OPERATION = 'openapi.operation'
+  PARAMS = 'openapi.params'
+  REQUEST_BODY = 'openapi.parsed_request_body'
   HANDLER = 'openapi_first.handler'
 
   def self.env
@@ -32,50 +28,4 @@ module OpenapiFirst
     resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
     Definition.new(resolved, spec_path)
   end
-
-  def self.app(
-    spec,
-    namespace:,
-    router_raise_error: false,
-    request_validation_raise_error: false,
-    response_validation: false
-  )
-    spec = OpenapiFirst.load(spec) unless spec.is_a?(Definition)
-    App.new(
-      nil,
-      spec,
-      namespace: namespace,
-      router_raise_error: router_raise_error,
-      request_validation_raise_error: request_validation_raise_error,
-      response_validation: response_validation
-    )
-  end
-
-  def self.middleware(
-    spec,
-    namespace:,
-    router_raise_error: false,
-    request_validation_raise_error: false,
-    response_validation: false
-  )
-    spec = OpenapiFirst.load(spec) unless spec.is_a?(Definition)
-    AppWithOptions.new(
-      spec,
-      namespace: namespace,
-      router_raise_error: router_raise_error,
-      request_validation_raise_error: request_validation_raise_error,
-      response_validation: response_validation
-    )
-  end
-
-  class AppWithOptions
-    def initialize(spec, options)
-      @spec = spec
-      @options = options
-    end
-
-    def new(app)
-      App.new(app, @spec, **@options)
-    end
-  end
 end

data/openapi_first.gemspec

@@ -34,13 +34,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.0.5'
 
-  spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
   spec.add_runtime_dependency 'hanami-router', '~> 2.0.0'
-  spec.add_runtime_dependency 'hanami-utils', '~> 2.0.0'
   spec.add_runtime_dependency 'json_refs', '~> 0.1', '>= 0.1.7'
   spec.add_runtime_dependency 'json_schemer', '~> 0.2.16'
   spec.add_runtime_dependency 'multi_json', '~> 1.14'
-  spec.add_runtime_dependency 'rack', '~> 2.2'
+  spec.add_runtime_dependency 'openapi_parameters', '~> 0.2'
+  spec.add_runtime_dependency 'rack', '>= 2.2', '< 4.0'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rack-test', '~> 1'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: deep_merge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: hanami-router
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: hanami-utils
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json_refs
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +73,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: openapi_parameters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -191,16 +183,17 @@ files:
 - benchmarks/Gemfile
 - benchmarks/Gemfile.lock
 - benchmarks/README.md
-- benchmarks/apps/committee.ru
+- benchmarks/apps/committee_with_hanami_api.ru
 - benchmarks/apps/committee_with_response_validation.ru
 - benchmarks/apps/committee_with_sinatra.ru
 - benchmarks/apps/grape.ru
 - benchmarks/apps/hanami_api.ru
 - benchmarks/apps/hanami_router.ru
 - benchmarks/apps/openapi.yaml
-- benchmarks/apps/openapi_first.ru
 - benchmarks/apps/openapi_first_with_hanami_api.ru
+- benchmarks/apps/openapi_first_with_plain_rack.ru
 - benchmarks/apps/openapi_first_with_response_validation.ru
+- benchmarks/apps/openapi_first_with_sinatra.ru
 - benchmarks/apps/roda.ru
 - benchmarks/apps/sinatra.ru
 - benchmarks/apps/syro.ru
@@ -214,25 +207,17 @@ files:
 - examples/config.ru
 - examples/openapi.yaml
 - lib/openapi_first.rb
-- lib/openapi_first/app.rb
 - lib/openapi_first/body_parser_middleware.rb
-- lib/openapi_first/coverage.rb
-- lib/openapi_first/default_operation_resolver.rb
 - lib/openapi_first/definition.rb
 - lib/openapi_first/errors.rb
-- lib/openapi_first/inbox.rb
 - lib/openapi_first/operation.rb
-- lib/openapi_first/rack_responder.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/schema_validation.rb
 - lib/openapi_first/use_router.rb
 - lib/openapi_first/utils.rb
-- lib/openapi_first/validation.rb
 - lib/openapi_first/validation_format.rb
 - lib/openapi_first/version.rb
 - openapi_first.gemspec
@@ -252,9 +237,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key:

data/benchmarks/apps/openapi_first.ru

@@ -1,22 +0,0 @@
-# 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)