openapi_first 1.0.0.beta1 → 1.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2248133fb2e0b761fb314629dcbfa7c9a6b7e0ac03b59887fe158968b17ed827
-  data.tar.gz: b0012d8af3c9dee1fa94334be7890e260f0173946129b53ec8f930f768f8de28
+  metadata.gz: c02c053192b6b39cb8f05acd35f7a257ee98b449c49f8ceeec4ac6e542f09e15
+  data.tar.gz: c36d3598b263ebd3d1a9bd23e6aa0b66256890f68e2f70fe245ca932d2f004f0
 SHA512:
-  metadata.gz: c615c847efcd10cfd145bcc99ede55da2eaa76fe91b9d0ab3fdb159c20b6cc314309f583ba0b784c3e3493a7a534ed1836309807c549bd8c40b226f2f9bf77e9
-  data.tar.gz: 83c476b9b67ce15ad71e052af8360e013659da13fbbd8f86a55bae9d4bbcf08f4ac291187dfccc5786e957c65d2a3124366f007998c675b4a3e29bccaecf332a
+  metadata.gz: e70192d7c2cb58734b8ebb6ccf53b2f243a98e78adbea271a3b0df1468f400d60080ead1ea68c07dd33bd9985d67de02ec4e0200e3ca0d49272a893c97611ffb
+  data.tar.gz: c59e62cd24dd767330f7e9ce6ad96a9c13005a4498c39f3ccf10bc801b49b6bddccf3ac62f858ae3ecf56fa4c695b4ad010fea7292171f98b640dec968ea357d

data/.github/workflows/ruby.yml

@@ -1,24 +1,12 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
+name: Test
+on: [push, pull_request]
 jobs:
-  build:
-
+  test:
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2 
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake
+        ruby-version: '3.1'
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.0.5
+  TargetRubyVersion: 3.1.1
   NewCops: enable
   SuggestExtensions: false
 Style/Documentation:

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Changelog
 
+## Unreleased
+
+## 1.0.0.beta4
+
+- Update json_schemer to version 2.0
+- Breaking: Requires Ruby 3.1 or later
+- Added: Parameters are available at `env[OpenapiFirst::PATH_PARAMS]`, `env[OpenapiFirst::QUERY_PARAMS]`, `env[OpenapiFirst::HEADER_PARAMS]`, `env[OpenapiFirst::COOKIE_PARAMS]` in case you need to access them separately. Merged path and query parameters are still available at `env[OpenapiFirst::PARAMS]`
+- Breaking / Added: ResponseValidation now validates response headers
+- Breaking / Added: RequestValidation now validates cookie, path and header parameters
+- Breaking: multipart File uploads are now read and then validated
+- Breaking: Remove OpenapiFirst.env method
+- Breaking: Request validation returns 400 instead of 415 if request body is required, but empty
+
+## 1.0.0.beta3
+
+- Remove obsolete dependency: deep_merge
+- Remove obsolete dependency: hanami-utils
+
+## 1.0.0.beta2
+
+- Fixed dependencies. Remove unused code.
+
 ## 1.0.0.beta1
+
 - Removed: `OpenapiFirst::Responder` and `OpenapiFirst::RackResponder`
 - Removed: `OpenapiFirst.app` and `OpenapiFirst.middleware`
 - Removed: `OpenapiFirst::Coverage`

data/Gemfile

@@ -6,6 +6,9 @@ source 'https://rubygems.org'
 gemspec
 
 group :test, :development do
-  gem 'pry'
+  gem 'bundler'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec'
   gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,114 +1,102 @@
 PATH
   remote: .
   specs:
-    openapi_first (1.0.0.beta1)
-      deep_merge (>= 1.2.1)
+    openapi_first (1.0.0.beta4)
       hanami-router (~> 2.0.0)
-      hanami-utils (~> 2.0.0)
       json_refs (~> 0.1, >= 0.1.7)
-      json_schemer (~> 0.2.16)
+      json_schemer (~> 2.0.0)
       multi_json (~> 1.14)
-      mustermann-contrib (~> 3.0.0)
+      openapi_parameters (~> 0.2.2)
       rack (>= 2.2, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    coderay (1.1.3)
-    concurrent-ruby (1.2.2)
-    deep_merge (1.2.2)
+    base64 (0.1.1)
     diff-lcs (1.5.0)
-    dry-core (1.0.0)
-      concurrent-ruby (~> 1.0)
-      zeitwerk (~> 2.6)
-    dry-transformer (1.0.1)
-      zeitwerk (~> 2.6)
-    ecma-re-validator (0.4.0)
-      regexp_parser (~> 2.2)
     hana (1.3.7)
     hanami-router (2.0.2)
       mustermann (~> 3.0)
       mustermann-contrib (~> 3.0)
       rack (~> 2.0)
-    hanami-utils (2.0.3)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
-      dry-transformer (~> 1.0, < 2)
     hansi (0.2.1)
     json (2.6.3)
-    json_refs (0.1.7)
+    json_refs (0.1.8)
       hana
-    json_schemer (0.2.24)
-      ecma-re-validator (~> 0.3)
+    json_schemer (2.0.0)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
-      uri_template (~> 0.7)
-    method_source (1.0.0)
+      simpleidn (~> 0.2)
+    language_server-protocol (3.17.0.3)
     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)
-    openapi_parameters (0.2.0)
+    openapi_parameters (0.2.2)
       rack (>= 2.2)
       zeitwerk (~> 2.6)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rack (2.2.6.4)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+      racc
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    simpleidn (0.2.1)
+      unf (~> 0.1.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
-    uri_template (0.7.0)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2)
+  bundler
   openapi_first!
-  openapi_parameters (~> 0.2, <= 2.0.0)
-  pry
-  rack-test (~> 1)
-  rake (~> 13)
-  rspec (~> 3)
+  rack-test
+  rake
+  rspec
   rubocop
 
 BUNDLED WITH

data/README.md

@@ -2,35 +2,37 @@
 
 [![Join the chat at https://gitter.im/openapi_first/community](https://badges.gitter.im/openapi_first/community.svg)](https://gitter.im/openapi_first/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-OpenapiFirst helps to implement HTTP APIs based on an [OpenApi](https://www.openapis.org/) API description. The idea is that you create an API description first, then add code that returns data and implements your business logic and be done.
+OpenapiFirst helps to implement HTTP APIs based on an [OpenAPI](https://www.openapis.org/) API description. It supports OpenAPI 3.0 and 3.1.
 
-Start with writing an OpenAPI file that describes the API, which you are about to implement. Use a [validator](https://github.com/stoplightio/spectral/) to make sure the file is valid.
+It provides these Rack middlewares:
 
-OpenapiFirst consists of these Rack middlewares:
+- [`OpenapiFirst::RequestValidation`](#request-validation) – Validates the request against the API description and returns 400 if the request is invalid.
+- [`OpenapiFirst::ResponseValidation`](#response-validation) Validates the response and raises an exception if the response body is invalid.
+- [`OpenapiFirst::Router`](#openapifirstrouter) – This internal middleware is added automatically when using request/response validation. It adds the OpenAPI operation for the current request to the Rack env.
 
-- [`OpenapiFirst::RequestValidation`](#OpenapiFirst::RequestValidation) – Validates the request against the API description and returns 400 if the request is invalid.
-- [`OpenapiFirst::ResponseValidation`](#OpenapiFirst::ResponseValidation) Validates the response and raises an exception if the response body is invalid.
-- [`OpenapiFirst::Router`](#OpenapiFirst::Router) – This internal middleware is added automatically when using request/response validation. It adds the OpenAPI operation for the current request to the Rack env or returns 404 if no operation was found.
+Using Request and Response validation together ensures that your implementation follows exactly the API description. This enables you to use the API description as a single source of truth for your API, reason about details and use various tooling.
 
-## OpenapiFirst::RequestValidation
+## Request Validation
 
-This middleware returns a 400 status code with a body that describes the error if the request is not valid.
+The `OpenapiFirst::RequestValidation` middleware returns a 400 status code with a body that describes the error if the request is not valid.
 
 ```ruby
 use OpenapiFirst::RequestValidation, spec: 'openapi.yaml'
 ```
 
-This will add these fields to the Rack env:
-- `env[OpenapiFirst::OPERATION]` – The Operation object for the current request. This is an instance of `OpenapiFirst::Operation`.
+It adds these fields to the Rack env:
+
 - `env[OpenapiFirst::PARAMS]` – The parsed parameters (query, path) for the current request (string keyed)
 - `env[OpenapiFirst::REQUEST_BODY]` – The parsed request body (string keyed)
+- `env[OpenapiFirst::OPERATION]` (Added via Router) – The Operation object for the current request. This is an instance of `OpenapiFirst::Operation`.
 
 ### Options and defaults
 
 | Name           | Possible values | Description                                                                                        | Default                            |
 | :------------- | --------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- |
-| `spec:`        |                      | The path to the spec file or spec loaded via `OpenapiFirst.load`
+| `spec:`        |                 | The path to the spec file or spec loaded via `OpenapiFirst.load`                                   |
 | `raise_error:` | `false`, `true` | If set to true the middleware raises `OpenapiFirst::RequestInvalidError` instead of returning 4xx. | `false` (don't raise an exception) |
+| `error_response:`| `:default`, Your implementation of `ErrorResponse` | :default
 
 The error responses conform with [JSON:API](https://jsonapi.org).
 
@@ -52,8 +54,8 @@ content-type: "application/vnd.api+json"
 }
 ```
 
-### Parameters
 
+### Parameters
 
 The `RequestValidation` middleware adds `env[OpenapiFirst::PARAMS]` (or `env['openapi.params']` ) with the converted query and path parameters. This only includes the parameters that are defined in the API description. It supports every [`style` and `explode` value as described](https://spec.openapis.org/oas/latest.html#style-examples) in the OpenAPI 3.0 and 3.1 specs. So you can do things these:
 
@@ -75,9 +77,10 @@ This middleware adds the parsed request body to `env[OpenapiFirst::REQUEST_BODY]
 
 The middleware will return a status `415` if the requests content type does not match or `400` if the request body is invalid.
 
-### Header, Cookie, Path parameter validation
+### Header, Cookie, Query and Path parameter validation
 
-tbd.
+The `RequestValidation` middleware validates the request headers, cookies and path parameters as defined in you API description. It returns a `400` status code if the request is invalid. It adds the parsed merged _path_ and _query_ parameters to `env['openapi.params']`.
+Separate parsed parameters are made available by location at `env['openapi.path_params']`, `env['openapi.query']`, `env['openapi.headers']`, `env['openapi.cookies']` as well if you need to access them separately.
 
 ### readOnly / writeOnly properties
 
@@ -85,10 +88,9 @@ Request validation fails if request includes a property with `readOnly: true`.
 
 Response validation fails if response body includes a property with `writeOnly: true`.
 
-## OpenapiFirst::ResponseValidation
-
-This middleware is especially useful when testing. It _always_ raises an error if the response is not valid.
+## Response validation
 
+The `OpenapiFirst::ResponseValidation` middleware is especially useful when testing. It _always_ raises an error if the response is not valid.
 
 ```ruby
 use OpenapiFirst::ResponseValidation, spec: 'openapi.yaml' if ENV['RACK_ENV'] == 'test'
@@ -96,25 +98,25 @@ use OpenapiFirst::ResponseValidation, spec: 'openapi.yaml' if ENV['RACK_ENV'] ==
 
 ### Options
 
-| Name           | Possible values      | Description                                                                                                                                                                                                                                                     | Default                            |
-| :------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
-| `spec:`        |                      | The path to the spec file or spec loaded via `OpenapiFirst.load`
+| Name    | Possible values | Description                                                      | Default |
+| :------ | --------------- | ---------------------------------------------------------------- | ------- |
+| `spec:` |                 | The path to the spec file or spec loaded via `OpenapiFirst.load` |
 
 ## OpenapiFirst::Router
 
-This middleware is used automatically, but you can add it to the top of your middleware stack if you want to change configuration.
+This middleware is used automatically, but you can add it to the top of your middleware stack if you want to customize the behavior via options.
 
 ```ruby
 use OpenapiFirst::Router, spec: './openapi/openapi.yaml'
 ```
 
-This middleware adds `env[OpenapiFirst::OPERATION]` which holds an Operation object that responds to `#operation_id`, `#path` (and `#[string]` to access raw fields).
+This middleware adds `env['openapi.operation']` which holds an instance of `OpenapiFirst::Operation` that responds to `#operation_id`, `#path` (and `#[]` to access raw fields).
 
 ### Options and defaults
 
 | Name           | Possible values      | Description                                                                                                                                                                                                                                                     | Default                            |
 | :------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
-| `spec:`        |                      | The path to the spec file or spec loaded via `OpenapiFirst.load` |                                    |
+| `spec:`        |                      | The path to the spec file or spec loaded via `OpenapiFirst.load`                                                                                                                                                                                                |                                    |
 | `raise_error:` | `false`, `true`      | If set to true the middleware raises `OpenapiFirst::NotFoundError` when a path or method was not found in the API description. This is useful during testing to spot an incomplete API description.                                                             | `false` (don't raise an exception) |
 | `not_found:`   | `:continue`, `:halt` | If set to `:continue` the middleware will not return 404 (405, 415), but just pass handling the request to the next middleware or application in the Rack stack. If combined with `raise_error: true` `raise_error` gets preference and an exception is raised. | `:halt` (return 4xx response)      |
 
@@ -164,9 +166,9 @@ run OpenapiFirst.app(spec, namespace: Pets)
 
 Run `bin/setup` to install dependencies.
 
-Run `bundle exec rspec` to run the tests.
+See `bundle exec rake` to run the linter and the tests.
 
-See `bundle exec rake -T` for rubygems related tasks.
+Run `bundle exec rspec` to run the tests only.
 
 ## Benchmarks
 

data/benchmarks/Gemfile.lock

@@ -1,20 +1,18 @@
 PATH
   remote: ..
   specs:
-    openapi_first (1.0.0.beta1)
-      deep_merge (>= 1.2.1)
+    openapi_first (1.0.0.beta3)
       hanami-router (~> 2.0.0)
-      hanami-utils (~> 2.0.0)
       json_refs (~> 0.1, >= 0.1.7)
-      json_schemer (~> 0.2.16)
+      json_schemer (~> 2.0.0)
       multi_json (~> 1.14)
-      mustermann-contrib (~> 3.0.0)
+      openapi_parameters (~> 0.2.2)
       rack (>= 2.2, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -28,7 +26,6 @@ GEM
       openapi_parser (~> 1.0)
       rack (>= 1.5)
     concurrent-ruby (1.2.2)
-    deep_merge (1.2.2)
     dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
@@ -37,22 +34,18 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    dry-transformer (1.0.1)
-      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)
-    ecma-re-validator (0.4.0)
-      regexp_parser (~> 2.2)
-    grape (1.7.0)
+    grape (1.7.1)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
-      rack (>= 1.3.0)
+      rack (>= 1.3.0, < 3)
       rack-accept
     hana (1.3.7)
     hanami-api (0.3.0)
@@ -61,23 +54,18 @@ GEM
       mustermann (~> 3.0)
       mustermann-contrib (~> 3.0)
       rack (~> 2.0)
-    hanami-utils (2.0.3)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
-      dry-transformer (~> 1.0, < 2)
     hansi (0.2.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json_refs (0.1.7)
+    json_refs (0.1.8)
       hana
     json_schema (0.21.0)
-    json_schemer (0.2.24)
-      ecma-re-validator (~> 0.3)
+    json_schemer (2.0.0)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
-      uri_template (~> 0.7)
+      simpleidn (~> 0.2)
     memory_profiler (1.0.1)
-    minitest (5.18.0)
+    minitest (5.20.0)
     multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
@@ -86,24 +74,29 @@ GEM
       mustermann (= 3.0.0)
     mustermann-grape (1.0.2)
       mustermann (>= 1.0.0)
-    nio4r (2.5.8)
+    nio4r (2.5.9)
+    openapi_parameters (0.2.2)
+      rack (>= 2.2)
+      zeitwerk (~> 2.6)
     openapi_parser (1.0.0)
-    puma (6.2.0)
+    puma (6.3.1)
       nio4r (~> 2.0)
-    rack (2.2.6.4)
+    rack (2.2.8)
     rack-accept (0.4.5)
       rack (>= 0.4)
-    rack-protection (3.0.5)
+    rack-protection (3.0.6)
       rack
-    regexp_parser (2.8.0)
-    roda (3.66.0)
+    regexp_parser (2.8.1)
+    roda (3.68.0)
       rack
     ruby2_keywords (0.0.5)
     seg (1.2.0)
-    sinatra (3.0.5)
+    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.5)
+      rack-protection (= 3.0.6)
       tilt (~> 2.0)
     syro (3.2.1)
       rack (>= 1.6.0)
@@ -111,8 +104,10 @@ GEM
     tilt (2.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    uri_template (0.7.0)
-    zeitwerk (2.6.7)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   arm64-darwin-21

data/benchmarks/apps/openapi_first_with_hanami_api.ru

@@ -19,7 +19,6 @@ app = Class.new(Hanami::API) do
   end
 end.new
 
-use OpenapiFirst::Router, spec: File.absolute_path('./openapi.yaml', __dir__)
-use OpenapiFirst::RequestValidation
+use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
 
 run app

data/benchmarks/apps/openapi_first_with_plain_rack.ru

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+
+app = Rack::Builder.new do
+  use OpenapiFirst::RequestValidation, spec: File.expand_path('./openapi.yaml', __dir__)
+
+  handlers = {
+    'find_thing' => lambda do |env|
+      params = env[OpenapiFirst::PARAMS]
+      body = MultiJson.dump(hello: 'world', id: params.fetch('id'))
+      [200, { 'Content-Type' => 'application/json' }, [body]]
+    end,
+    'find_things' => lambda do |_env|
+      body = MultiJson.dump(hello: 'world')
+      [200, { 'Content-Type' => 'application/json' }, [body]]
+    end,
+    'create_thing' => lambda do |_env|
+      body = MultiJson.dump(hello: 'world')
+      [201, { 'Content-Type' => 'application/json' }, [body]]
+    end
+  }
+
+  not_found = ->(_env) { [404, {}, []] }
+
+  run(lambda do |env|
+    handlers.fetch(env[OpenapiFirst::OPERATION]&.operation_id, not_found).call(env)
+  end)
+end
+
+run app

data/benchmarks/apps/openapi_first_with_response_validation.ru

@@ -2,21 +2,24 @@
 
 require 'multi_json'
 require 'openapi_first'
+require 'hanami/api'
 
-namespace = Module.new do
-  def self.find_thing(params, _res)
-    { hello: 'world', id: params.fetch(:id) }
+app = Class.new(Hanami::API) do
+  get '/hello/:id' do
+    json(hello: 'world', id: params.fetch(:id))
   end
 
-  def self.find_things(_params, _res)
-    [{ hello: 'world' }]
+  get '/hello' do
+    json([{ hello: 'world' }])
   end
 
-  def self.create_thing(_params, res)
-    res.status = 201
-    { hello: 'world' }
+  post '/hello' do
+    status 201
+    json(hello: 'world')
   end
-end
+end.new
 
-oas_path = File.absolute_path('./openapi.yaml', __dir__)
-run OpenapiFirst.app(oas_path, namespace: namespace, response_validation: true)
+use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
+use OpenapiFirst::ResponseValidation
+
+run app

data/benchmarks/apps/openapi_first_with_sinatra.ru

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+require 'sinatra'
+
+class SinatraWithOpenapiFirstExample < 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 OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
+
+run SinatraWithOpenapiFirstExample

data/lib/openapi_first/body_parser_middleware.rb

@@ -23,7 +23,7 @@ module OpenapiFirst
       errors = [err]
 
       Rack::Response.new(
-        MultiJson.dump(errors: errors),
+        MultiJson.dump(errors:),
         400,
         Rack::CONTENT_TYPE => 'application/vnd.api+json'
       ).finish

data/lib/openapi_first/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  class Config
+    def initialize(error_response: :default)
+      @error_response = error_response
+    end
+
+    attr_reader :error_response
+
+    def self.default_options
+      @default_options ||= new
+    end
+
+    def self.default_options=(options)
+      @default_options = new(**options)
+    end
+  end
+end