openapi_first 1.0.0.beta1 → 1.0.0.beta4

data/lib/openapi_first/router.rb

@@ -7,6 +7,9 @@ require_relative 'body_parser_middleware'
 
 module OpenapiFirst
   class Router
+    # The unconverted path parameters before they are converted to the types defined in the API description
+    RAW_PATH_PARAMS = 'openapi.raw_path_params'
+
     def initialize(
       app,
       options
@@ -63,17 +66,16 @@ module OpenapiFirst
       env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH) if env[ORIGINAL_PATH]
     end
 
-    def handle_body_parsing_error(exception)
-      err = { title: 'Failed to parse body as application/json', status: '400' }
-      err[:detail] = exception.cause unless ENV['RACK_ENV'] == 'production'
-      errors = [err]
-      raise RequestInvalidError, errors if @raise
-
-      Rack::Response.new(
-        MultiJson.dump(errors: errors),
-        400,
-        Rack::CONTENT_TYPE => 'application/vnd.api+json'
-      ).finish
+    def handle_body_parsing_error(_exception)
+      message = 'Failed to parse body as application/json'
+      raise RequestInvalidError, message if @raise
+
+      error = {
+        status: 400,
+        title: message
+      }
+
+      ErrorResponse::Default.new(**error).finish
     end
 
     def build_router(operations)
@@ -89,7 +91,7 @@ module OpenapiFirst
       end
       raise_error = @raise
       Rack::Builder.app do
-        use BodyParserMiddleware, raise_error: raise_error
+        use(BodyParserMiddleware, raise_error:)
         run router
       end
     end
@@ -99,8 +101,7 @@ module OpenapiFirst
         env[OPERATION] = operation
         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[RAW_PATH_PARAMS] = env['router.params']
         env[Rack::PATH_INFO] = path_info
         @app.call(env)
       end

data/lib/openapi_first/schema_validation.rb

@@ -1,46 +1,47 @@
 # frozen_string_literal: true
 
 require 'json_schemer'
+require_relative 'validation_result'
 
 module OpenapiFirst
   class SchemaValidation
     attr_reader :raw_schema
 
-    def initialize(schema, write: true)
+    SCHEMAS = {
+      '3.1' => 'https://spec.openapis.org/oas/3.1/dialect/base',
+      '3.0' => 'json-schemer://openapi30/schema'
+    }.freeze
+
+    def initialize(schema, openapi_version:, write: true)
       @raw_schema = schema
-      custom_keywords = {}
-      custom_keywords['writeOnly'] = proc { |data| !data } unless write
-      custom_keywords['readOnly'] = proc { |data| !data } if write
       @schemer = JSONSchemer.schema(
         schema,
-        keywords: custom_keywords,
+        access_mode: write ? 'write' : 'read',
+        meta_schema: SCHEMAS.fetch(openapi_version),
         insert_property_defaults: true,
-        before_property_validation: proc do |data, property, property_schema, parent|
-          convert_nullable(data, property, property_schema, parent)
-          binary_format(data, property, property_schema, parent)
-        end
+        output_format: 'detailed',
+        before_property_validation: method(:before_property_validation)
       )
     end
 
-    def validate(input)
-      @schemer.validate(input)
+    def validate(data)
+      ValidationResult.new(
+        output: @schemer.validate(data),
+        schema: raw_schema,
+        data:
+      )
     end
 
     private
 
-    def binary_format(data, property, property_schema, _parent)
-      return unless property_schema.is_a?(Hash) && property_schema['format'] == 'binary'
-
-      property_schema['type'] = 'object'
-      property_schema.delete('format')
-      data[property].transform_keys!(&:to_s)
+    def before_property_validation(data, property, property_schema, parent)
+      binary_format(data, property, property_schema, parent)
     end
 
-    def convert_nullable(_data, _property, property_schema, _parent)
-      return unless property_schema.is_a?(Hash) && property_schema['nullable'] && property_schema['type']
+    def binary_format(data, property, property_schema, _parent)
+      return unless property_schema.is_a?(Hash) && property_schema['format'] == 'binary'
 
-      property_schema['type'] = [*property_schema['type'], 'null']
-      property_schema.delete('nullable')
+      data[property] = data[property][:tempfile].read
     end
   end
 end

data/lib/openapi_first/string_keyed_hash.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  class StringKeyedHash
+    extend Forwardable
+    def_delegators :@orig, :empty?
+
+    def initialize(original)
+      @orig = original
+    end
+
+    def key?(key)
+      @orig.key?(key.to_sym)
+    end
+
+    def [](key)
+      @orig[key.to_sym]
+    end
+  end
+end

data/lib/openapi_first/validation_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  ValidationResult = Struct.new(:output, :schema, :data, keyword_init: true) do
+    def valid? = output['valid']
+    def error? = !output['valid']
+
+    # Returns a message that is used in exception messages.
+    def message
+      return if valid?
+
+      (output['errors']&.map { |e| e['error'] }&.join('. ') || output['error'])&.concat('.')
+    end
+  end
+end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -2,6 +2,8 @@
 
 require 'yaml'
 require 'json_refs'
+require_relative 'openapi_first/config'
+require_relative 'openapi_first/plugins'
 require_relative 'openapi_first/definition'
 require_relative 'openapi_first/version'
 require_relative 'openapi_first/errors'
@@ -9,15 +11,40 @@ 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/default_error_response'
 
 module OpenapiFirst
+  # The OpenAPI operation for the current request
   OPERATION = 'openapi.operation'
+
+  # Merged parsed path and query parameters
   PARAMS = 'openapi.params'
+
+  # Parsed query parameters
+  QUERY_PARAMS = 'openapi.query'
+
+  # Parsed path parameters
+  PATH_PARAMS = 'openapi.path_params'
+
+  # Parsed header parameters, except for Content-Type, Accept and Authorization
+  HEADER_PARAMS = 'openapi.headers'
+
+  # Parsed cookie parameter values
+  COOKIE_PARAMS = 'openapi.cookies'
+
+  # The parsed request body
   REQUEST_BODY = 'openapi.parsed_request_body'
-  HANDLER = 'openapi_first.handler'
 
-  def self.env
-    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV.fetch('RAILS_ENV', nil)
+  class << self
+    # Throws an error in the middle of the request validation to stop validation and send a response.
+    def error!(status, location = nil, title: nil, validation_result: nil)
+      throw :error, {
+        status:,
+        location:,
+        title: title || validation_result&.output&.fetch('error') || Rack::Utils::HTTP_STATUS_CODES[status],
+        validation_result:
+      }
+    end
   end
 
   def self.load(spec_path, only: nil)
@@ -28,22 +55,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
 end

data/openapi_first.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['andreas.haller@posteo.de']
   spec.licenses      = ['MIT']
 
-  spec.summary       = 'Implement REST APIs based on OpenApi.'
+  spec.summary       = 'Implement REST APIs based on OpenApi 3.x'
   spec.homepage      = 'https://github.com/ahx/openapi_first'
 
   if spec.respond_to?(:metadata)
@@ -32,22 +32,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.0.5'
+  spec.required_ruby_version = '>= 3.1.1'
 
-  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 'json_schemer', '~> 2.0.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.14'
-  spec.add_runtime_dependency 'mustermann-contrib', '~> 3.0.0'
+  spec.add_runtime_dependency 'openapi_parameters', '~> 0.2.2'
   spec.add_runtime_dependency 'rack', '>= 2.2', '< 4.0'
-
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'openapi_parameters', '~> 0.2', '<= 2.0.0'
-  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'
   }

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta4
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-10-25 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
@@ -78,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: mustermann-contrib
+  name: openapi_parameters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -134,82 +106,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: openapi_parameters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
 description:
 email:
 - andreas.haller@posteo.de
@@ -231,16 +127,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
@@ -255,17 +152,23 @@ files:
 - examples/openapi.yaml
 - lib/openapi_first.rb
 - lib/openapi_first/body_parser_middleware.rb
+- lib/openapi_first/config.rb
+- lib/openapi_first/default_error_response.rb
 - lib/openapi_first/definition.rb
+- lib/openapi_first/error_response.rb
 - lib/openapi_first/errors.rb
 - lib/openapi_first/operation.rb
+- lib/openapi_first/operation_schemas.rb
+- lib/openapi_first/plugins.rb
+- lib/openapi_first/request_body_validator.rb
 - lib/openapi_first/request_validation.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/string_keyed_hash.rb
 - lib/openapi_first/use_router.rb
-- lib/openapi_first/utils.rb
-- lib/openapi_first/validation_format.rb
+- lib/openapi_first/validation_result.rb
 - lib/openapi_first/version.rb
 - openapi_first.gemspec
 homepage: https://github.com/ahx/openapi_first
@@ -281,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.5
+      version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -291,5 +194,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Implement REST APIs based on OpenApi.
+summary: Implement REST APIs based on OpenApi 3.x
 test_files: []

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)

data/lib/openapi_first/utils.rb

@@ -1,35 +0,0 @@
-# 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
-
-    def self.classify(string)
-      Hanami::Utils::String.classify(string)
-    end
-
-    class StringKeyedHash
-      def initialize(original)
-        @orig = original
-      end
-
-      def key?(key)
-        @orig.key?(key.to_sym)
-      end
-
-      def [](key)
-        @orig[key.to_sym]
-      end
-    end
-  end
-end

data/lib/openapi_first/validation_format.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module OpenapiFirst
-  module ValidationFormat
-    SIMPLE_TYPES = %w[string integer].freeze
-
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
-    def self.error_details(error)
-      if error['type'] == 'pattern'
-        {
-          title: 'is not valid',
-          detail: "does not match pattern '#{error['schema']['pattern']}'"
-        }
-      elsif error['type'] == 'format'
-        {
-          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']
-        {
-          title: "is missing required properties: #{missing_keys.join(', ')}"
-        }
-      elsif error['type'] == 'readOnly'
-        {
-          title: 'appears in request, but is read-only'
-        }
-      elsif error['type'] == 'writeOnly'
-        {
-          title: 'write-only field appears in response:'
-        }
-      elsif SIMPLE_TYPES.include?(error['type'])
-        {
-          title: "should be a #{error['type']}"
-        }
-      elsif error['schema'] == false
-        { title: 'unknown fields are not allowed' }
-      else
-        { title: "is not valid: #{error['data'].inspect}" }
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
-  end
-end