openapi_first 1.0.0.beta5 → 1.0.0

data/lib/openapi_first.rb

@@ -1,47 +1,51 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'multi_json'
 require 'json_refs'
-require_relative 'openapi_first/config'
+require_relative 'openapi_first/errors'
+require_relative 'openapi_first/configuration'
 require_relative 'openapi_first/plugins'
 require_relative 'openapi_first/definition'
 require_relative 'openapi_first/version'
-require_relative 'openapi_first/errors'
-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/error_responses/default'
-require_relative 'openapi_first/error_responses/json_api'
+require_relative 'openapi_first/error_response'
+require_relative 'openapi_first/middlewares/response_validation'
+require_relative 'openapi_first/middlewares/request_validation'
 
 module OpenapiFirst
-  # The OpenAPI operation for the current request
-  OPERATION = 'openapi.operation'
+  extend Plugins
 
-  # Merged parsed path and query parameters
-  PARAMS = 'openapi.params'
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-  # Parsed query parameters
-  QUERY_PARAMS = 'openapi.query'
+    def configure
+      yield configuration
+    end
+  end
 
-  # Parsed path parameters
-  PATH_PARAMS = 'openapi.path_params'
+  # Key in rack to find instance of RuntimeRequest
+  REQUEST = 'openapi.request'
 
-  # Parsed header parameters, except for Content-Type, Accept and Authorization
-  HEADER_PARAMS = 'openapi.headers'
+  def self.load(spec_path, only: nil)
+    resolved = Bundle.resolve(spec_path)
+    resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
+    Definition.new(resolved, spec_path)
+  end
 
-  # Parsed cookie parameter values
-  COOKIE_PARAMS = 'openapi.cookies'
+  module Bundle
+    def self.resolve(spec_path)
+      Dir.chdir(File.dirname(spec_path)) do
+        content = load_file(File.basename(spec_path))
+        JsonRefs.call(content, resolve_local_ref: true, resolve_file_ref: true)
+      end
+    end
 
-  # The parsed request body
-  REQUEST_BODY = 'openapi.parsed_request_body'
+    def self.load_file(spec_path)
+      return MultiJson.load(File.read(spec_path)) if File.extname(spec_path) == '.json'
 
-  def self.load(spec_path, only: nil)
-    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)
+      YAML.unsafe_load_file(spec_path)
     end
-    resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
-    Definition.new(resolved, spec_path)
   end
 end

data/openapi_first.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     spec.metadata['https://github.com/ahx/openapi_first'] = spec.homepage
     spec.metadata['source_code_uri'] = 'https://github.com/ahx/openapi_first'
-    spec.metadata['changelog_uri'] = 'https://github.com/ahx/openapi_first/blob/master/CHANGELOG.md'
+    spec.metadata['changelog_uri'] = 'https://github.com/ahx/openapi_first/blob/main/CHANGELOG.md'
+    spec.metadata['rubygems_mfa_required'] = 'true'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
           'public gem pushes.'
@@ -26,21 +27,21 @@ 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 'json_schemer', '~> 2.1.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.15'
-  spec.add_runtime_dependency 'openapi_parameters', '>= 0.3.1', '< 2.0'
+  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'
-  }
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2024-01-06 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
@@ -50,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -72,13 +58,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: mustermann-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: openapi_parameters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -88,7 +88,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -122,66 +122,54 @@ files:
 - ".github/CODEOWNERS"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Gemfile.rack2
+- Gemfile.rack2.lock
 - 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/config.rb
+- lib/openapi_first/body_parser.rb
+- lib/openapi_first/configuration.rb
 - lib/openapi_first/definition.rb
+- lib/openapi_first/definition/cookie_parameters.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/responses.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/json_schema.rb
-- lib/openapi_first/json_schema/result.rb
-- lib/openapi_first/operation.rb
+- lib/openapi_first/failure.rb
+- lib/openapi_first/middlewares/request_validation.rb
+- lib/openapi_first/middlewares/response_validation.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/string_keyed_hash.rb
-- lib/openapi_first/use_router.rb
+- lib/openapi_first/plugins/default.rb
+- lib/openapi_first/plugins/default/error_response.rb
+- lib/openapi_first/plugins/jsonapi.rb
+- lib/openapi_first/plugins/jsonapi/error_response.rb
+- lib/openapi_first/request_validation/request_body_validator.rb
+- lib/openapi_first/request_validation/validator.rb
+- lib/openapi_first/response_validation/validator.rb
+- lib/openapi_first/runtime_request.rb
+- lib/openapi_first/runtime_response.rb
+- lib/openapi_first/schema.rb
+- lib/openapi_first/schema/validation_error.rb
+- lib/openapi_first/schema/validation_result.rb
 - lib/openapi_first/version.rb
 - openapi_first.gemspec
 homepage: https://github.com/ahx/openapi_first
 licenses:
 - MIT
 metadata:
+  https://github.com/ahx/openapi_first: https://github.com/ahx/openapi_first
+  source_code_uri: https://github.com/ahx/openapi_first
+  changelog_uri: https://github.com/ahx/openapi_first/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -194,11 +182,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Implement REST APIs based on OpenApi 3.x

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,142 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    openapi_first (1.0.0.beta5)
-      hanami-router (~> 2.0.0)
-      json_refs (~> 0.1, >= 0.1.7)
-      json_schemer (~> 2.0.0)
-      multi_json (~> 1.15)
-      openapi_parameters (>= 0.3.1, < 2.0)
-      rack (>= 2.2, < 4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.1.2)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    base64 (0.2.0)
-    benchmark-ips (2.12.0)
-    benchmark-memory (0.2.0)
-      memory_profiler (~> 1)
-    bigdecimal (3.1.4)
-    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)
-    connection_pool (2.4.1)
-    drb (2.2.0)
-      ruby2_keywords
-    dry-core (1.0.1)
-      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 (2.0.0)
-      activesupport (>= 5)
-      builder
-      dry-types (>= 1.1)
-      mustermann-grape (~> 1.0.0)
-      rack (>= 1.3.0)
-      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)
-    mutex_m (0.2.0)
-    nio4r (2.5.9)
-    openapi_parameters (0.3.1)
-      rack (>= 2.2)
-      zeitwerk (~> 2.6)
-    openapi_parser (1.0.0)
-    puma (6.4.0)
-      nio4r (~> 2.0)
-    rack (2.2.8)
-    rack-accept (0.4.5)
-      rack (>= 0.4)
-    rack-protection (3.1.0)
-      rack (~> 2.2, >= 2.2.4)
-    regexp_parser (2.8.2)
-    roda (3.73.0)
-      rack
-    ruby2_keywords (0.0.5)
-    seg (1.2.0)
-    simpleidn (0.2.1)
-      unf (~> 0.1.4)
-    sinatra (3.1.0)
-      mustermann (~> 3.0)
-      rack (~> 2.2, >= 2.2.4)
-      rack-protection (= 3.1.0)
-      tilt (~> 2.0)
-    syro (3.2.1)
-      rack (>= 1.6.0)
-      seg
-    tilt (2.3.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.9)
-    zeitwerk (2.6.12)
-
-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