openapi_first 0.19.0 → 0.21.0

data/lib/openapi_first/response_validation.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'multi_json'
-require_relative 'router_required'
+require_relative 'use_router'
 require_relative 'validation_format'
 
 module OpenapiFirst
   class ResponseValidation
-    prepend RouterRequired
+    prepend UseRouter
 
-    def initialize(app)
+    def initialize(app, _options = {})
       @app = app
     end
 
@@ -42,20 +42,21 @@ module OpenapiFirst
       data = full_body.empty? ? {} : load_json(full_body)
       errors = schema.validate(data)
       errors = errors.to_a.map! do |error|
-        error_message_for(error)
+        format_error(error)
       end
       raise ResponseBodyInvalidError, errors.join(', ') if errors.any?
     end
 
+    def format_error(error)
+      return "Write-only field appears in response: #{error['data_pointer']}" if error['type'] == 'writeOnly'
+
+      JSONSchemer::Errors.pretty(error)
+    end
+
     def load_json(string)
       MultiJson.load(string)
     rescue MultiJson::ParseError
       string
     end
-
-    def error_message_for(error)
-      err = ValidationFormat.error_details(error)
-      [err[:title], error['data_pointer'], err[:detail]].compact.join(' ')
-    end
   end
 end

data/lib/openapi_first/router.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'rack'
+require 'multi_json'
 require 'hanami/router'
+require_relative 'body_parser_middleware'
 
 module OpenapiFirst
   class Router
@@ -14,6 +16,10 @@ module OpenapiFirst
       @raise = options.fetch(:raise_error, false)
       @not_found = options.fetch(:not_found, :halt)
       spec = options.fetch(:spec)
+      raise "You have to pass spec: when initializing #{self.class}" unless spec
+
+      spec = OpenapiFirst.load(spec) unless spec.is_a?(Definition)
+
       @filepath = spec.filepath
       @router = build_router(spec.operations)
     end
@@ -28,6 +34,7 @@ module OpenapiFirst
 
         return @app.call(env) if @not_found == :continue
       end
+
       response
     end
 
@@ -49,29 +56,50 @@ module OpenapiFirst
       env[ORIGINAL_PATH] = env[Rack::PATH_INFO]
       env[Rack::PATH_INFO] = Rack::Request.new(env).path
       @router.call(env)
+    rescue BodyParsingError => e
+      handle_body_parsing_error(e)
     ensure
       env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH) if env[ORIGINAL_PATH]
     end
 
-    def build_router(operations) # rubocop:disable Metrics/AbcSize
-      router = Hanami::Router.new
-      operations.each do |operation|
-        normalized_path = operation.path.gsub('{', ':').gsub('}', '')
-        if operation.operation_id.nil?
-          warn "operationId is missing in '#{operation.method} #{operation.path}'. I am ignoring this operation."
+    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
+    end
+
+    def build_router(operations)
+      router = Hanami::Router.new.tap do |r|
+        operations.each do |operation|
+          normalized_path = operation.path.gsub('{', ':').gsub('}', '')
+          r.public_send(
+            operation.method,
+            normalized_path,
+            to: build_route(operation)
+          )
         end
-        router.public_send(
-          operation.method,
-          normalized_path,
-          to: lambda do |env|
-            env[OPERATION] = operation
-            env[PARAMETERS] = env['router.params']
-            env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH)
-            @app.call(env)
-          end
-        )
       end
-      router
+      raise_error = @raise
+      Rack::Builder.app do
+        use BodyParserMiddleware, raise_error: raise_error
+        run router
+      end
+    end
+
+    def build_route(operation)
+      lambda do |env|
+        env[OPERATION] = operation
+        env[PARAMETERS] = env['router.params']
+        env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH)
+        @app.call(env)
+      end
     end
   end
 end

data/lib/openapi_first/schema_validation.rb

@@ -17,6 +17,7 @@ module OpenapiFirst
         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
       )
     end
@@ -27,6 +28,14 @@ module OpenapiFirst
 
     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)
+    end
+
     def convert_nullable(_data, _property, property_schema, _parent)
       return unless property_schema.is_a?(Hash) && property_schema['nullable'] && property_schema['type']
 

data/lib/openapi_first/use_router.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module UseRouter
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+      super
+    end
+
+    def call(env)
+      return super if env.key?(OPERATION)
+
+      @router ||= Router.new(->(e) { super(e) }, @options)
+      @router.call(env)
+    end
+  end
+end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -4,6 +4,7 @@ require 'yaml'
 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'
@@ -39,7 +40,7 @@ module OpenapiFirst
     request_validation_raise_error: false,
     response_validation: false
   )
-    spec = OpenapiFirst.load(spec) if spec.is_a?(String)
+    spec = OpenapiFirst.load(spec) unless spec.is_a?(Definition)
     App.new(
       nil,
       spec,
@@ -57,7 +58,7 @@ module OpenapiFirst
     request_validation_raise_error: false,
     response_validation: false
   )
-    spec = OpenapiFirst.load(spec) if spec.is_a?(String)
+    spec = OpenapiFirst.load(spec) unless spec.is_a?(Definition)
     AppWithOptions.new(
       spec,
       namespace: namespace,
@@ -77,50 +78,4 @@ module OpenapiFirst
       App.new(app, @spec, **@options)
     end
   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
-    def initialize(serialized_errors)
-      message = error_message(serialized_errors)
-      super message
-    end
-
-    private
-
-    def error_message(errors)
-      errors.map do |error|
-        [human_source(error), human_error(error)].compact.join(' ')
-      end.join(', ')
-    end
-
-    def human_source(error)
-      return unless error[:source]
-
-      source_key = error[:source].keys.first
-      source = {
-        pointer: 'Request body invalid:',
-        parameter: 'Query parameter invalid:'
-      }.fetch(source_key, source_key)
-      name = error[:source].values.first
-      source += " #{name}" unless name.nil? || name.empty?
-      source
-    end
-
-    def human_error(error)
-      error[:title]
-    end
-  end
 end

data/openapi_first.gemspec

@@ -32,11 +32,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 3.0.5'
 
   spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
-  spec.add_runtime_dependency 'hanami-router', '2.0.alpha5'
-  spec.add_runtime_dependency 'hanami-utils', '2.0.alpha3'
+  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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -28,30 +28,30 @@ dependencies:
   name: hanami-router
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha5
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha5
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha3
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha3
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json_refs
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,7 @@ files:
 - Rakefile
 - benchmarks/Gemfile
 - benchmarks/Gemfile.lock
+- benchmarks/README.md
 - benchmarks/apps/committee.ru
 - benchmarks/apps/committee_with_response_validation.ru
 - benchmarks/apps/committee_with_sinatra.ru
@@ -203,7 +204,9 @@ files:
 - benchmarks/apps/roda.ru
 - benchmarks/apps/sinatra.ru
 - benchmarks/apps/syro.ru
+- benchmarks/benchmark-wrk.sh
 - benchmarks/benchmarks.rb
+- benchmarks/post.lua
 - bin/console
 - bin/setup
 - examples/README.md
@@ -212,9 +215,11 @@ files:
 - 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
@@ -224,8 +229,8 @@ files:
 - 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/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
@@ -244,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/openapi_first/router_required.rb

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