openapi_first 1.0.0.beta4 → 1.0.0.beta6

data/lib/openapi_first/router.rb

@@ -2,14 +2,17 @@
 
 require 'rack'
 require 'multi_json'
-require 'hanami/router'
-require_relative 'body_parser_middleware'
+require 'mustermann'
+require_relative 'body_parser'
 
 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'
 
+    NOT_FOUND = Rack::Response.new('Not Found', 404).finish.freeze
+    METHOD_NOT_ALLOWED = Rack::Response.new('Method Not Allowed', 405).finish.freeze
+
     def initialize(
       app,
       options
@@ -17,25 +20,32 @@ module OpenapiFirst
       @app = app
       @raise = options.fetch(:raise_error, false)
       @not_found = options.fetch(:not_found, :halt)
+      @error_response_class = options.fetch(:error_response, Config.default_options.error_response)
       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)
+      @definition = spec.is_a?(Definition) ? spec : OpenapiFirst.load(spec)
+      @filepath = @definition.filepath
     end
 
     def call(env)
       env[OPERATION] = nil
-      response = call_router(env)
-      if env[OPERATION].nil?
-        raise_error(env) if @raise
+      request = Rack::Request.new(env)
+      path_item, path_params = @definition.find_path_item_and_params(request.path)
+      operation = path_item&.find_operation(request.request_method.downcase)
 
+      env[OPERATION] = operation
+      env[RAW_PATH_PARAMS] = path_params
+
+      if operation.nil?
+        raise_error(env) if @raise
         return @app.call(env) if @not_found == :continue
       end
 
-      response
+      return NOT_FOUND unless path_item
+      return METHOD_NOT_ALLOWED unless operation
+
+      @app.call(env)
     end
 
     ORIGINAL_PATH = 'openapi_first.path_info'
@@ -54,57 +64,5 @@ module OpenapiFirst
         }' in API description #{@filepath}"
       raise NotFoundError, msg
     end
-
-    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.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 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)
-      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
-      end
-      raise_error = @raise
-      Rack::Builder.app do
-        use(BodyParserMiddleware, raise_error:)
-        run router
-      end
-    end
-
-    def build_route(operation)
-      lambda do |env|
-        env[OPERATION] = operation
-        path_info = env.delete(ORIGINAL_PATH)
-        env[REQUEST_BODY] = env.delete(ROUTER_PARSED_BODY) if env.key?(ROUTER_PARSED_BODY)
-        env[RAW_PATH_PARAMS] = env['router.params']
-        env[Rack::PATH_INFO] = path_info
-        @app.call(env)
-      end
-    end
   end
 end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -11,7 +11,8 @@ 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'
+require_relative 'openapi_first/error_responses/default'
+require_relative 'openapi_first/error_responses/json_api'
 
 module OpenapiFirst
   # The OpenAPI operation for the current request
@@ -35,18 +36,6 @@ module OpenapiFirst
   # The parsed request body
   REQUEST_BODY = 'openapi.parsed_request_body'
 
-  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)
     resolved = Dir.chdir(File.dirname(spec_path)) do
       content = YAML.load_file(File.basename(spec_path))

data/openapi_first.gemspec

@@ -26,19 +26,22 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`
       .split("\x0")
-      .reject { |f| f.match(%r{^(test|spec|features)/}) }
-      .reject { |f| %w[Dockerfile Jenkinsfile .tool-versions].include?(f) }
+      .reject { |f| f.match(%r{^(test|spec|features|benchmarks|examples|bin)/}) }
+      .reject do |f|
+      %w[Dockerfile Jenkinsfile .tool-versions CODEOWNERS .rspec .rubocop.yml .tool-versions
+         Rakefile].include?(f)
+    end
   end
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 3.1.1'
 
-  spec.add_runtime_dependency 'hanami-router', '~> 2.0.0'
   spec.add_runtime_dependency 'json_refs', '~> 0.1', '>= 0.1.7'
   spec.add_runtime_dependency 'json_schemer', '~> 2.0.0'
-  spec.add_runtime_dependency 'multi_json', '~> 1.14'
-  spec.add_runtime_dependency 'openapi_parameters', '~> 0.2.2'
+  spec.add_runtime_dependency 'multi_json', '~> 1.15'
+  spec.add_runtime_dependency 'mustermann-contrib', '~> 3.0.0'
+  spec.add_runtime_dependency 'openapi_parameters', '>= 0.3.2', '< 2.0'
   spec.add_runtime_dependency 'rack', '>= 2.2', '< 4.0'
   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.beta4
+  version: 1.0.0.beta6
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hanami-router
-  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
@@ -64,28 +50,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: openapi_parameters
+  name: mustermann-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: openapi_parameters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -116,59 +122,40 @@ files:
 - ".github/CODEOWNERS"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Gemfile.rack2
 - LICENSE.txt
 - README.md
-- Rakefile
-- benchmarks/Gemfile
-- benchmarks/Gemfile.lock
-- benchmarks/README.md
-- 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_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
-- benchmarks/benchmark-wrk.sh
-- benchmarks/benchmarks.rb
-- benchmarks/post.lua
-- bin/console
-- bin/setup
-- examples/README.md
-- examples/app.rb
-- examples/config.ru
-- examples/openapi.yaml
 - lib/openapi_first.rb
-- lib/openapi_first/body_parser_middleware.rb
+- lib/openapi_first/body_parser.rb
 - lib/openapi_first/config.rb
-- lib/openapi_first/default_error_response.rb
 - lib/openapi_first/definition.rb
+- lib/openapi_first/definition/cookie_parameters.rb
+- lib/openapi_first/definition/has_content.rb
+- lib/openapi_first/definition/header_parameters.rb
+- lib/openapi_first/definition/operation.rb
+- lib/openapi_first/definition/parameters.rb
+- lib/openapi_first/definition/path_item.rb
+- lib/openapi_first/definition/path_parameters.rb
+- lib/openapi_first/definition/query_parameters.rb
+- lib/openapi_first/definition/request_body.rb
+- lib/openapi_first/definition/response.rb
+- lib/openapi_first/definition/schema.rb
+- lib/openapi_first/definition/schema/result.rb
 - lib/openapi_first/error_response.rb
+- lib/openapi_first/error_responses/default.rb
+- lib/openapi_first/error_responses/json_api.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/request_validation_error.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/validation_result.rb
 - lib/openapi_first/version.rb
 - openapi_first.gemspec
 homepage: https://github.com/ahx/openapi_first

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,14 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.1.1
-  NewCops: enable
-  SuggestExtensions: false
-Style/Documentation:
-  Enabled: false
-Style/ExponentialNotation:
-  Enabled: true
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*.rb"
-    - "*.gemspec"
-Metrics/MethodLength:
-  Max: 20

data/Rakefile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task :version do
-  puts Gem::Specification.load('openapi_first.gemspec').version
-end
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: %i[spec rubocop]

data/benchmarks/Gemfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'benchmark-ips'
-gem 'benchmark-memory'
-gem 'committee'
-gem 'grape'
-gem 'hanami-api'
-gem 'hanami-router'
-gem 'multi_json'
-gem 'openapi_first', path: '../'
-gem 'puma'
-gem 'roda'
-gem 'sinatra'
-gem 'syro'

data/benchmarks/Gemfile.lock

@@ -1,131 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    openapi_first (1.0.0.beta3)
-      hanami-router (~> 2.0.0)
-      json_refs (~> 0.1, >= 0.1.7)
-      json_schemer (~> 2.0.0)
-      multi_json (~> 1.14)
-      openapi_parameters (~> 0.2.2)
-      rack (>= 2.2, < 4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.8)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    benchmark-ips (2.12.0)
-    benchmark-memory (0.2.0)
-      memory_profiler (~> 1)
-    builder (3.2.4)
-    committee (5.0.0)
-      json_schema (~> 0.14, >= 0.14.3)
-      openapi_parser (~> 1.0)
-      rack (>= 1.5)
-    concurrent-ruby (1.2.2)
-    dry-core (1.0.0)
-      concurrent-ruby (~> 1.0)
-      zeitwerk (~> 2.6)
-    dry-inflector (1.0.0)
-    dry-logic (1.5.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
-      zeitwerk (~> 2.6)
-    dry-types (1.7.1)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0)
-      dry-inflector (~> 1.0)
-      dry-logic (~> 1.4)
-      zeitwerk (~> 2.6)
-    grape (1.7.1)
-      activesupport
-      builder
-      dry-types (>= 1.1)
-      mustermann-grape (~> 1.0.0)
-      rack (>= 1.3.0, < 3)
-      rack-accept
-    hana (1.3.7)
-    hanami-api (0.3.0)
-      hanami-router (~> 2.0)
-    hanami-router (2.0.2)
-      mustermann (~> 3.0)
-      mustermann-contrib (~> 3.0)
-      rack (~> 2.0)
-    hansi (0.2.1)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    json_refs (0.1.8)
-      hana
-    json_schema (0.21.0)
-    json_schemer (2.0.0)
-      hana (~> 1.3)
-      regexp_parser (~> 2.0)
-      simpleidn (~> 0.2)
-    memory_profiler (1.0.1)
-    minitest (5.20.0)
-    multi_json (1.15.0)
-    mustermann (3.0.0)
-      ruby2_keywords (~> 0.0.1)
-    mustermann-contrib (3.0.0)
-      hansi (~> 0.2.0)
-      mustermann (= 3.0.0)
-    mustermann-grape (1.0.2)
-      mustermann (>= 1.0.0)
-    nio4r (2.5.9)
-    openapi_parameters (0.2.2)
-      rack (>= 2.2)
-      zeitwerk (~> 2.6)
-    openapi_parser (1.0.0)
-    puma (6.3.1)
-      nio4r (~> 2.0)
-    rack (2.2.8)
-    rack-accept (0.4.5)
-      rack (>= 0.4)
-    rack-protection (3.0.6)
-      rack
-    regexp_parser (2.8.1)
-    roda (3.68.0)
-      rack
-    ruby2_keywords (0.0.5)
-    seg (1.2.0)
-    simpleidn (0.2.1)
-      unf (~> 0.1.4)
-    sinatra (3.0.6)
-      mustermann (~> 3.0)
-      rack (~> 2.2, >= 2.2.4)
-      rack-protection (= 3.0.6)
-      tilt (~> 2.0)
-    syro (3.2.1)
-      rack (>= 1.6.0)
-      seg
-    tilt (2.1.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
-    zeitwerk (2.6.11)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  benchmark-ips
-  benchmark-memory
-  committee
-  grape
-  hanami-api
-  hanami-router
-  multi_json
-  openapi_first!
-  puma
-  roda
-  sinatra
-  syro
-
-BUNDLED WITH
-   2.3.10

data/benchmarks/README.md

@@ -1,29 +0,0 @@
-# How to run these bechmarks
-
-## Setup
-
-```bash
-cd benchmarks
-bundle install
-```
-
-## Run Ruby benchmarks
-
-This compares ips and memory usage for all apps defined in /apps
-
-```bash
-bundle exec ruby benchmarks.rb
-```
-
-## Run benchmark using [wrk](https://github.com/wg/wrk)
-
-1. Start the example app
-Example: openapi_first
-```bash
-bundle exec puma apps/openapi_first_with_response_validation.ru
-```
-
-2. Run wrk
-```bash
-./benchmark-wrk.sh
-```

data/benchmarks/apps/committee_with_hanami_api.ru

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'committee'
-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
-
-use Committee::Middleware::RequestValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__),
-    parse_response_by_content_type: true
-
-run app

data/benchmarks/apps/committee_with_response_validation.ru

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'committee'
-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
-
-use Committee::Middleware::RequestValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__),
-    parse_response_by_content_type: true
-
-use Committee::Middleware::ResponseValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__)
-
-run app

data/benchmarks/apps/committee_with_sinatra.ru

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'committee'
-require 'sinatra'
-
-class SinatraWithCommiteeExample < Sinatra::Base
-  set :environment, :production
-
-  get '/hello/:id' do
-    content_type :json
-    MultiJson.dump(hello: 'world', id: params.fetch('id'))
-  end
-
-  get '/hello' do
-    content_type :json
-    MultiJson.dump([{ hello: 'world' }])
-  end
-
-  post '/hello' do
-    content_type :json
-    status 201
-    MultiJson.dump(hello: 'world')
-  end
-end
-
-use Committee::Middleware::RequestValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__),
-    parse_response_by_content_type: true
-
-run SinatraWithCommiteeExample

data/benchmarks/apps/grape.ru

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape'
-
-class GrapeExample < Grape::API
-  format :json
-
-  get :hello do
-    [{ hello: 'world' }]
-  end
-
-  post :hello do
-    { hello: 'world' }
-  end
-
-  get 'hello/:id' do
-    { hello: 'world', id: params[:id] }
-  end
-end
-
-run GrapeExample

data/benchmarks/apps/hanami_api.ru

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-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
-
-run app