openapi_first 0.17.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e1915ef20b0c31bd58a5f0bbba3d91b9be2915c9c0e1598e085d4bea142a06
-  data.tar.gz: 42c62a18aab203b1920adf1367cd9bc500c6e31b1e82fb8b4370ca34cedb372d
+  metadata.gz: 033e7d24a78ecd8cd0c98bad90e49949612c47a2d0b83791cca3ec7149e91ff6
+  data.tar.gz: f2092ebe5ee49b86b9745c2a1d27d4a71b798ed1d91f1fad6ea8cc9750f3ddff
 SHA512:
-  metadata.gz: a7985ff17cce925cb8ed24b47efaea39f4a2bef3a7f029de3edbef38a6ae555e57784d1346cfa0acbfd18b3d70124c4019dd0a5533990dccfcc408667b70b693
-  data.tar.gz: 8e28e55faf6de5246ff87c0943f507c2f93afe4d96f5bbde423feb15607295e7888d25c4add8054ec90103a4305161366f72c8088d0d8f64e053f9ba6902b592
+  metadata.gz: fc80eff5d2f0c30d1df07d9e7d58cec4dfab41b05467e503dfc4200c11670fe336d1f7ac723b770798708006419ddc1da689ce862b12385d673f03f9a4d4aef4
+  data.tar.gz: dbf86b5ce8a3b23f12af0311a5bad788b0b9841deff4f8170fe7de17acbad230b9a65806abf7eb73958bd123a76820f54b84f92a2c09a2dd54364c47bf5203f9

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## Unreleased
+
+## 0.20.0
+- You can pass a filepath to `spec:` now so you no longer have to call `OpenapiFirst.load` anymore.
+- Router is optional now.
+  You no longer have to add `Router` to your middleware stack. You still can add it to customize behaviour by setting options, but you no longer have to add it.
+  If you don't add the Router, make sure you pass `spec:` to your request/response validation middleware.
+- Support "4xx" and "4XX" response definitions.
+  (4XX is defined in the standard, but 2xx is used in the wild as well 🦁.)
+- Removed warning about missing operationId, because operationId is not used until the Responder is used.
+- Raise HandlerNotFoundError when handler cannot be found
+
+## 0.19.0
+
+- Add `RackResponder`
+
+- BREAKING CHANGE: Handler classes are now instantiated only once without any arguments and the same instance is called on each following call/request.
+
+## 0.18.0
+
+Yanked. No useful changes.
+
 ## 0.17.0
 
 - BREAKING CHANGE: Use a Hash instead of named arguments for middleware options for better compatibility

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.17.0)
+    openapi_first (0.20.0)
       deep_merge (>= 1.2.1)
       hanami-router (= 2.0.alpha5)
       hanami-utils (= 2.0.alpha3)
@@ -29,66 +29,69 @@ GEM
     hanami-utils (2.0.0.alpha3)
       concurrent-ruby (~> 1.0)
       dry-transformer (~> 0.1)
-    hansi (0.2.0)
+    hansi (0.2.1)
+    json (2.6.2)
     json_refs (0.1.7)
       hana
-    json_schemer (0.2.20)
+    json_schemer (0.2.22)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     method_source (1.0.0)
     multi_json (1.15.0)
-    mustermann (1.1.1)
+    mustermann (1.1.2)
       ruby2_keywords (~> 0.0.1)
-    mustermann-contrib (1.1.1)
+    mustermann-contrib (1.1.2)
       hansi (~> 0.2.0)
-      mustermann (= 1.1.1)
+      mustermann (= 1.1.2)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
+    rack (2.2.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.27.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.37.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.3.0)
     uri_template (0.7.0)
 
 PLATFORMS
   arm64-darwin-21
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2)

data/README.md

@@ -18,41 +18,28 @@ Here's a [comparison between committee and openapi_first](https://gist.github.co
 
 OpenapiFirst consists of these Rack middlewares:
 
-- [`OpenapiFirst::Router`](#OpenapiFirst::Router) – Finds the OpenAPI operation for the current request or returns 404 if no operation was found. This can be customized.
 - [`OpenapiFirst::RequestValidation`](#OpenapiFirst::RequestValidation) – Validates the request against the API description and returns 400 if the request is invalid.
-- [`OpenapiFirst::Responder`](#OpenapiFirst::Responder) calls the [handler](#handlers) found for the operation, sets the correct content-type and serialized the response body to json if needed.
 - [`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 before request/response validation. Finds the OpenAPI operation for the current request or returns 404 if no operation was found. This can be customized by adding it yourself.
 
-## OpenapiFirst::Router
-
-You always have to add this middleware first in order to make the other middlewares work.
-
-```ruby
-use OpenapiFirst::Router, spec: OpenapiFirst.load('./openapi/openapi.yaml')
-```
-
-This middleware adds `env[OpenapiFirst::OPERATION]` which holds an Operation object that responds to `#operation_id`, `#path` (and `#[]` to access raw fields).
 
-### Options and defaults
-
-| Name           | Possible values      | Description                                                                                                                                                                                                                                                     | Default                            |
-| :------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
-| `spec:`        |                      | The 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)      |
+And these Rack apps:
+- [`OpenapiFirst::Responder`](#OpenapiFirst::Responder) calls the [handler](#handlers) found for the operation, sets the correct content-type and serializes the response body to json if needed.
+- [`OpenapiFirst::RackResponder`](#OpenapiFirst::RackResponder) calls the [handler](#handlers) found for the operation as a normal Rack application (`call(env)`) and returns the result as is.
 
 ## OpenapiFirst::RequestValidation
 
 This middleware returns a 400 status code with a body that describes the error if the request is not valid.
 
 ```ruby
-use OpenapiFirst::RequestValidation
+use OpenapiFirst::RequestValidatio, spec: 'openapi.yaml'
 ```
 
 ### Options and defaults
 
 | Name           | Possible values | Description                                                                                        | Default                            |
 | :------------- | --------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `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) |
 
 The error responses conform with [JSON:API](https://jsonapi.org).
@@ -106,6 +93,56 @@ 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.
+
+
+```ruby
+use OpenapiFirst::ResponseValidation, spec: 'openapi.yaml' if ENV['RACK_ENV'] == 'test'
+```
+
+### Options
+
+| Name           | Possible values      | Description                                                                                                                                                                                                                                                     | Default                            |
+| :------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `spec:`        |                      | The path to the spec file or spec loaded via `OpenapiFirst.load`
+
+## OpenapiFirst::Router
+
+This middleware first always used automatically, but you can add it to the top of your middleware stack if you want to change configuration.
+
+```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 `#[]` 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`
+                                                                                                  |                                    |
+| `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)      |
+
+## OpenapiFirst::RackResponder
+
+This Rack endpoint maps the HTTP request to a method call based on the [operationId](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) in your API description and calls it as a normal Rack application.
+It does not not serialize objects as JSON or adds a content-type.
+
+```ruby
+run OpenapiFirst::RackResponder
+```
+
+### Options
+
+| Name         | Description                                                                                                                                                                                       |
+| :----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `namespace:` | Optional. A class or module where to find the handler method.                                                                                                                                     |
+| `resolver:`  | Optional. An object that responds to `#call(operation)` and returns a [handler](#handlers). By default this is an instance of [DefaultOperationResolver](#OpenapiFirst::DefaultOperationResolver) |
+
 ## OpenapiFirst::Responder
 
 This Rack endpoint maps the HTTP request to a method call based on the [operationId](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) in your API description and calls it. Responder also adds a content-type to the response.
@@ -129,7 +166,7 @@ It works like this:
 
 - An operationId "create_pet" or "createPet" or "create pet" calls `MyApi.create_pet(params, response)`
 - "some_things.create" calls: `MyApi::SomeThings.create(params, response)`
-- "pets#create" calls: `MyApi::Pets::Create.new.call(params, response)` If `MyApi::Pets::Create.new` accepts an argument, it will pass the rack `env`.
+- "pets#create" instantiates the class once (`MyApi::Pets::Create.new) and calls it on every request(`instance.call(params, response)`).
 
 ### Handlers
 
@@ -145,14 +182,6 @@ There are two ways to set the response body:
 - Calling `res.write "things"` (see [Rack::Response](https://www.rubydoc.info/github/rack/rack/Rack/Response))
 - Returning a value which will get converted to JSON
 
-## OpenapiFirst::ResponseValidation
-
-This middleware is especially useful when testing. It _always_ raises an error if the response is not valid.
-
-```ruby
-use OpenapiFirst::ResponseValidation if ENV['RACK_ENV'] == 'test'
-```
-
 ## Standalone usage
 
 Instead of composing these middlewares yourself you can use `OpenapiFirst.app`.
@@ -229,8 +258,7 @@ Instead of using the ResponseValidation middleware you can validate the response
 ```ruby
 # In your test (rspec example):
 require 'openapi_first'
-spec = OpenapiFirst.load('petstore.yaml')
-validator = OpenapiFirst::ResponseValidator.new(spec)
+validator = OpenapiFirst::ResponseValidator.new('petstore.yaml')
 
 # This will raise an exception if it found an error
 validator.validate(last_request, last_response)
@@ -241,7 +269,7 @@ validator.validate(last_request, last_response)
 You can filter the URIs that should be handled by passing `only` to `OpenapiFirst.load`:
 
 ```ruby
-spec = OpenapiFirst.load './openapi/openapi.yaml', only: '/pets'.method(:==)
+spec = OpenapiFirst.load('./openapi/openapi.yaml', only: '/pets'.method(:==))
 run OpenapiFirst.app(spec, namespace: Pets)
 ```
 
@@ -259,8 +287,7 @@ describe MyApp do
   include Rack::Test::Methods
 
   before(:all) do
-    spec = OpenapiFirst.load('petstore.yaml')
-    @app_wrapper = OpenapiFirst::Coverage.new(MyApp, spec)
+    @app_wrapper = OpenapiFirst::Coverage.new(MyApp, 'petstore.yaml')
   end
 
   after(:all) do

data/benchmarks/Gemfile

@@ -10,6 +10,7 @@ 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,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.17.0)
+    openapi_first (0.20.0)
       deep_merge (>= 1.2.1)
       hanami-router (= 2.0.alpha5)
       hanami-utils (= 2.0.alpha3)
@@ -72,7 +72,7 @@ GEM
     json_refs (0.1.7)
       hana
     json_schema (0.21.0)
-    json_schemer (0.2.20)
+    json_schemer (0.2.22)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -87,13 +87,16 @@ GEM
       mustermann (= 1.1.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
+    nio4r (2.5.8)
     openapi_parser (0.15.0)
-    rack (2.2.3)
+    puma (5.6.5)
+      nio4r (~> 2.0)
+    rack (2.2.3.1)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-protection (2.2.0)
       rack
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.0)
     roda (3.54.0)
       rack
     ruby2_keywords (0.0.5)
@@ -113,6 +116,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   benchmark-ips
@@ -123,6 +127,7 @@ DEPENDENCIES
   hanami-router
   multi_json
   openapi_first!
+  puma
   roda
   sinatra
   syro

data/benchmarks/README.md

@@ -0,0 +1,29 @@
+# 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/openapi.yaml

@@ -73,6 +73,16 @@ paths:
       operationId: create_thing
       description: Create a thing
       tags: ["Metadata"]
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - say
+              properties:
+                say:
+                  type: string
       responses:
         "201":
           description: OK
@@ -84,3 +94,175 @@ paths:
                 properties:
                   hello:
                     type: string
+  /pets:
+    get:
+      description: |
+        Returns all pets from the system that the user has access to
+        Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
+
+        Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
+      operationId: find_pets
+      parameters:
+        - name: tags
+          in: query
+          description: tags to filter by
+          required: false
+          style: form
+          schema:
+            type: array
+            items:
+              type: string
+        - name: limit
+          in: query
+          description: maximum number of results to return
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    post:
+      description: Creates a new pet in the store.  Duplicates are allowed
+      operationId: create_pet
+      requestBody:
+        description: Pet to add to the store
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NewPet'
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /pets/{id}:
+    parameters:
+      - name: id
+        in: path
+        description: ID of pet to fetch
+        required: true
+        schema:
+          type: integer
+          format: int64
+    get:
+      description: Returns a user based on a single ID, if the user does not have access to the pet
+      operationId: find_pet
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    delete:
+      description: deletes a single pet based on the ID supplied
+      operationId: delete_pet
+      parameters:
+        - name: id
+          in: path
+          description: ID of pet to delete
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '204':
+          description: pet deleted
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    patch:
+      description: Updates a pet
+      operationId: update_pet
+      requestBody:
+        description: Changes
+        required: false
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NewPet'
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
+components:
+  schemas:
+    Pet:
+      allOf:
+        - $ref: '#/components/schemas/NewPet'
+        - required:
+          - id
+          properties:
+            id:
+              type: integer
+              format: int64
+
+    NewPet:
+      required:
+        - type
+        - attributes
+      properties:
+        type:
+          type: string
+          enum:
+            - pet
+            - plant
+        attributes:
+          additionalProperties: false
+          type: object
+          required: [name]
+          properties:
+            name:
+              type: string
+
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

data/benchmarks/apps/openapi_first_with_hanami_api.ru

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

data/benchmarks/benchmark-wrk.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+wrk -t12 -c400 -d10s --latency -s post.lua http://localhost:9292/hello

data/benchmarks/benchmarks.rb

@@ -3,12 +3,16 @@
 require 'benchmark/ips'
 require 'benchmark/memory'
 require 'rack'
+require 'json'
 ENV['RACK_ENV'] = 'production'
 
 examples = [
   [Rack::MockRequest.env_for('/hello'), 200],
   [Rack::MockRequest.env_for('/unknown'), 404],
-  [Rack::MockRequest.env_for('/hello', method: 'POST'), 201],
+  [
+    Rack::MockRequest.env_for('/hello', method: 'POST', input: JSON.dump({ say: 'hi!' }),
+                                        'CONTENT_TYPE' => 'application/json'), 201
+  ],
   [Rack::MockRequest.env_for('/hello/1'), 200],
   [Rack::MockRequest.env_for('/hello/123'), 200],
   [Rack::MockRequest.env_for('/hello?filter[id]=1,2'), 200]
@@ -24,7 +28,7 @@ bench = lambda do |app|
     env, expected_status = example
     100.times { app.call(env) }
     response = app.call(env)
-    raise unless response[0] == expected_status
+    raise "expected status #{expected_status}, but was #{response[0]}" unless response[0] == expected_status
   end
 end
 

data/benchmarks/post.lua

@@ -0,0 +1,3 @@
+wrk.method = "POST"
+wrk.body   = "{\"say\":\"hi!\"}"
+wrk.headers["Content-Type"] = "application/json"

data/lib/openapi_first/default_operation_resolver.rb

@@ -10,11 +10,14 @@ module OpenapiFirst
     end
 
     def call(operation)
-      @handlers[operation.name] ||= find_handler(operation['x-handler'] || operation['operationId'])
+      @handlers[operation.name] ||= begin
+        id = handler_id(operation)
+        find_handler(id) if id
+      end
     end
 
-    def find_handler(operation_id)
-      name = operation_id.match(/:*(.*)/)&.to_a&.at(1)
+    def find_handler(id)
+      name = id.match(/:*(.*)/)&.to_a&.at(1)
       return if name.nil?
 
       catch :halt do
@@ -27,6 +30,16 @@ module OpenapiFirst
       @namespace.method(method_name)
     end
 
+    def handler_id(operation)
+      id = operation['x-handler'] || operation['operationId']
+      if id.nil?
+        raise HandlerNotFoundError,
+              "operationId or x-handler is missing in '#{operation.method} #{operation.path}' so I cannot find a handler for this operation." # rubocop:disable Layout/LineLength
+      end
+
+      id
+    end
+
     def find_class_method_handler(name)
       module_name, method_name = name.split('.')
       klass = find_const(@namespace, module_name)
@@ -37,9 +50,7 @@ module OpenapiFirst
       module_name, klass_name = name.split('#')
       const = find_const(@namespace, module_name)
       klass = find_const(const, klass_name)
-      return ->(params, res) { klass.new.call(params, res) } if klass.instance_method(:initialize).arity.zero?
-
-      ->(params, res) { klass.new(params.env).call(params, res) }
+      klass.new
     end
 
     def find_const(parent, name)

data/lib/openapi_first/errors.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  class Error < StandardError; end
+
+  class NotFoundError < Error; end
+
+  class HandlerNotFoundError < Error; end
+
+  class NotImplementedError < Error
+    def initialize(message)
+      warn 'NotImplementedError is deprecated. Handle HandlerNotFoundError instead'
+      super
+    end
+  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/lib/openapi_first/inbox.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  # An instance of this gets passed to handler functions as first argument.
+  # An instance of this gets passed to handler functions in the Responder.
   class Inbox < Hash
     attr_reader :env
 

data/lib/openapi_first/operation.rb

@@ -47,9 +47,8 @@ module OpenapiFirst
       end
     end
 
-    def content_type_for(status)
-      content = response_for(status)['content']
-      content.keys[0] if content
+    def content_types_for(status)
+      response_for(status)['content']&.keys
     end
 
     def response_schema_for(status, content_type)
@@ -94,6 +93,7 @@ module OpenapiFirst
     def response_by_code(status)
       operation_object.dig('responses', status.to_s) ||
         operation_object.dig('responses', "#{status / 100}XX") ||
+        operation_object.dig('responses', "#{status / 100}xx") ||
         operation_object.dig('responses', 'default')
     end
 

data/lib/openapi_first/rack_responder.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'responder'
+
+module OpenapiFirst
+  class RackResponder < Responder
+    def call(env)
+      operation = env[OpenapiFirst::OPERATION]
+      find_handler(operation)&.call(env)
+    end
+  end
+end

data/lib/openapi_first/request_validation.rb

@@ -3,12 +3,12 @@
 require 'rack'
 require 'multi_json'
 require_relative 'inbox'
-require_relative 'router_required'
+require_relative 'use_router'
 require_relative 'validation_format'
 
 module OpenapiFirst
   class RequestValidation # rubocop:disable Metrics/ClassLength
-    prepend RouterRequired
+    prepend UseRouter
 
     def initialize(app, options = {})
       @app = app
@@ -16,10 +16,10 @@ module OpenapiFirst
     end
 
     def call(env) # rubocop:disable Metrics/AbcSize
-      operation = env[OpenapiFirst::OPERATION]
+      operation = env[OPERATION]
       return @app.call(env) unless operation
 
-      env[INBOX] = Inbox.new(env)
+      env[INBOX] = {}
       catch(:halt) do
         validate_query_parameters!(env, operation, env[PARAMETERS])
         req = Rack::Request.new(env)

data/lib/openapi_first/responder.rb

@@ -16,14 +16,18 @@ module OpenapiFirst
       operation = env[OpenapiFirst::OPERATION]
       res = Rack::Response.new
       handler = find_handler(operation)
-      result = handler.call(env[INBOX], res)
+      result = handler.call(inbox(env), res)
       res.write serialize(result) if result && res.body.empty?
-      res[Rack::CONTENT_TYPE] ||= operation.content_type_for(res.status)
+      res[Rack::CONTENT_TYPE] ||= operation.content_types_for(res.status)&.first
       res.finish
     end
 
     private
 
+    def inbox(env)
+      Inbox.new(env).tap { |i| i.merge!(env[INBOX]) if env[INBOX] }
+    end
+
     def find_handler(operation)
       handler = @resolver.call(operation)
       raise NotImplementedError, "Could not find handler for #{operation.name}" unless handler
@@ -37,11 +41,4 @@ module OpenapiFirst
       MultiJson.dump(result)
     end
   end
-
-  class OperationResolver < Responder
-    def initialize(spec:, namespace:)
-      warn "#{self.class.name} was renamed to #{OpenapiFirst::Responder.name}"
-      super
-    end
-  end
 end

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

@@ -14,6 +14,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 +32,7 @@ module OpenapiFirst
 
         return @app.call(env) if @not_found == :continue
       end
+
       response
     end
 
@@ -53,13 +58,10 @@ module OpenapiFirst
       env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH) if env[ORIGINAL_PATH]
     end
 
-    def build_router(operations) # rubocop:disable Metrics/AbcSize
+    def build_router(operations)
       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."
-        end
         router.public_send(
           operation.method,
           normalized_path,

data/lib/openapi_first/use_router.rb

@@ -0,0 +1,20 @@
+# 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(lambda { |e|
+                               super(e)
+                             }, spec: @options.fetch(:spec), raise_error: @options.fetch(:raise_error, false))
+      @router.call(env)
+    end
+  end
+end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.17.0'
+  VERSION = '0.20.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'
@@ -20,7 +21,7 @@ module OpenapiFirst
   HANDLER = 'openapi_first.handler'
 
   def self.env
-    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV['RAILS_ENV']
+    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV.fetch('RAILS_ENV', nil)
   end
 
   def self.load(spec_path, only: nil)
@@ -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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -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
@@ -215,16 +218,18 @@ files:
 - 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
 - lib/openapi_first/request_validation.rb
 - lib/openapi_first/responder.rb
 - lib/openapi_first/response_object.rb
 - 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

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