openapi_first 0.14.1 → 0.16.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3791f0c4bae9c39517b960e99ea3581740eaca9ad10b6189242d7690defd621
-  data.tar.gz: bfb77aabdba80a0406ff8909e6fcf98ef7c850465fbf562bb6dd8574bd0dd1e2
+  metadata.gz: 5f46ad8751619914fa7b387ecb8a0178e67a7ba070e863321463f7ae1097e250
+  data.tar.gz: 5961b6bff590f957a8908d62b3c87bd65438dbdfe055020c61739af2862b06cc
 SHA512:
-  metadata.gz: b40805c6536ad7bfe932f8d42bea8580493099afdbd12667f3d646c27d2ac8cd9efe4a3dfd2a44e1460322215bfc184d4cbcf69a8b45f3b84efbcc0bfc6c2ad5
-  data.tar.gz: ed34c78c3b0960aa670876af49124d08175ceb163b503939c0668d4d6104b20931ca823db606503cfe9a95047cf9303a2bee597f5e97ccc3d9625dc1df02c349
+  metadata.gz: 0e08b5d1b12f3379ef2f28ab98da925a43c7adc69ea617c305dedb06fbe63e7843cf0d861cd32d7942f7770b4f7ac9bb2762ffb179374fd15deff2b86f64899f
+  data.tar.gz: ac406a2a868a44b8cfb8d54a71b5c4fb1d1078f666c6f3ee683a191c83c090a8312f59bd399e089edb4062d309ca98df02ee8b2078a445c1e3b16e5e19cfd462

data/CHANGELOG.md

@@ -1,42 +1,68 @@
 # Changelog
 
+## Unreleased
+
+- Use a Hash instead of named arguments for middleware options for better compatibility
+
+## 0.15.0
+
+- Populate default parameter values
+
+## 0.14.3
+
+- Use json_refs to resolve OpenAPI file. This removes oas_parser and ActiveSupport from list of dependencies
+
+## 0.14.2
+
+- Empty query parameters are parsed and request validation returns 400 if an empty string is not allowed. Note that this does not look at `allowEmptyValue` in any way, because allowEmptyValue is deprecated.
 
 ## 0.14.1
+
 - Bugfix: Don't mix path- and operation-level parameters for request validation
 
 ## 0.14.0
+
 - Handle custom x-handler field in the API description to find a handler method not based on operationId
 - Add `resolver` option to provide a custom resolver to find a handler method
 
 ## 0.13.3
+
 - Better error message if string does not match format
 - readOnly and writeOnly just works when used inside allOf
 
 ## 0.13.2
+
 - Return indicator (`source: { parameter: 'list/1' }`) in error response body when array item in query parameter is invalid
 
 ## 0.13.0
+
 - Add support for arrays in query parameters (style: form, explode: false)
 - Remove warning when handler is not implemented
 
 ## 0.12.5
+
 - Add `not_found: :continue` option to Router to make it do nothing if request is unknown
 
 ## 0.12.4
+
 - content-type is found while ignoring additional content-type parameters (`application/json` is found when request/response content-type is `application/json; charset=UTF8`)
 - Support wildcard mime-types when finding the content-type
 
 ## 0.12.3
+
 - Add `response_validation:`, `router_raise_error` options to standalone mode.
 
 ## 0.12.2
+
 - Allow response to have no media type object specified
 
 ## 0.12.1
+
 - Fix response when handler returns 404 or 405
 - Don't validate the response content if status is 204 (no content)
 
 ## 0.12.0
+
 - Change `ResponseValidator` to raise an exception if it found a problem
 - Params have symbolized keys now
 - Remove `not_found` option from Router. Return 405 if HTTP verb is not allowed (via Hanami::Router)
@@ -48,6 +74,7 @@
 - Add `Operation#name` that returns a human readable name for an operation
 
 ## 0.11.0
+
 - Raise error if you forgot to add the Router middleware
 - Make OpenapiFirst.app raise an error in test env when request path is not specified
 - Rename OperationResolver to Responder
@@ -56,48 +83,60 @@
 - Move namespace option from Router to OperationResolver
 
 ## 0.10.2
+
 - Return 400 if request body has invalid JSON ([issue](https://github.com/ahx/openapi_first/issues/73)) thanks Thomas Frütel
 
 ## 0.10.1
+
 - Fix duplicated key in `required` when generating JSON schema for `some[thing]` parameters
 
 ## 0.10.0
+
 - Add support for query parameters named `"some[thing]"` ([issue](https://github.com/ahx/openapi_first/issues/40))
 
 ## 0.9.0
+
 - Make request validation usable standalone
 
 ## 0.8.0
+
 - Add merged parameter and request body available to env at `env[OpenapiFirst::INBOX]` in request validation
 - Path and query parameters with `type: boolean` now get converted to `true`/`false`
 - Rename `OpenapiFirst::PARAMS` to `OpenapiFirst::PARAMETERS`
 
 ## 0.7.1
+
 - Add missing `require` to work with new version of `oas_parser`
 
 ## 0.7.0
+
 - Make use of hanami-router, because it's fast
 - Remove option `allow_unknown_query_paramerters`
 - Move the namespace option to Router
-- Convert numeric path and query parameters  to `Integer` or `Float`
+- Convert numeric path and query parameters to `Integer` or `Float`
 - Pass the Rack env if your action class' initializers accepts an argument
 - Respec rack's `env['SCRIPT_NAME']` in router
 - Add MIT license
 
 ## 0.6.10
+
 - Bugfix: params.env['unknown'] now returns `nil` as expected. Thanks @tristandruyen.
 
 ## 0.6.9
+
 - Removed radix tree, because of a bug (https://github.com/namusyaka/r2ree-ruby/issues/2)
 
 ## 0.6.8
+
 - Performance: About 25% performance increase (i/s) with help of c++ based radix-tree and some optimizations
 - Update dependencies
 
 ## 0.6.7
+
 - Fix: version number of oas_parser
 
 ## 0.6.6
+
 - Remove warnings for Ruby 2.7
 
 ## 0.6.5

data/Gemfile.lock

@@ -1,121 +1,93 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.14.1)
+    openapi_first (0.16.0.beta1)
       deep_merge (>= 1.2.1)
-      hanami-router (~> 2.0.alpha3)
-      hanami-utils (~> 2.0.alpha1)
+      hanami-router (~> 2.0.alpha5)
+      hanami-utils (~> 2.0.alpha3)
+      json_refs (>= 0.1.7)
       json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
-      oas_parser (~> 0.25.1)
       rack (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    builder (3.2.4)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
-    deep_merge (1.2.1)
-    diff-lcs (1.4.4)
+    deep_merge (1.2.2)
+    diff-lcs (1.5.0)
     dry-transformer (0.1.1)
-    ecma-re-validator (0.3.0)
-      regexp_parser (~> 2.0)
+    ecma-re-validator (0.4.0)
+      regexp_parser (~> 2.2)
     hana (1.3.7)
     hanami-router (2.0.0.alpha5)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
-    hanami-utils (2.0.0.alpha2)
+    hanami-utils (2.0.0.alpha3)
       concurrent-ruby (~> 1.0)
       dry-transformer (~> 0.1)
     hansi (0.2.0)
-    hash-deep-merge (0.1.1)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
+    json_refs (0.1.7)
+      hana
     json_schemer (0.2.18)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
     multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-contrib (1.1.1)
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    oas_parser (0.25.4)
-      activesupport (>= 4.0.0)
-      addressable (~> 2.3)
-      builder (~> 3.2.3)
-      deep_merge (~> 1.2.1)
-      hash-deep-merge
-      mustermann-contrib (~> 1.1.1)
-      nokogiri
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
-    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.22.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.15.2)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     uri_template (0.7.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (~> 2)
@@ -127,4 +99,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.2.28
+   2.3.7

data/README.md

@@ -15,6 +15,7 @@ This gem is inspired by [committee](https://github.com/interagent/committee) (Ru
 Here's a [comparison between committee and openapi_first](https://gist.github.com/ahx/1538c31f0652f459861713b5259e366a).
 
 ## Rack middlewares
+
 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.
@@ -23,6 +24,7 @@ OpenapiFirst consists of these Rack middlewares:
 - [`OpenapiFirst::ResponseValidation`](#OpenapiFirst::ResponseValidation) Validates the response and raises an exception if the response body is invalid.
 
 ## OpenapiFirst::Router
+
 You always have to add this middleware first in order to make the other middlewares work.
 
 ```ruby
@@ -33,11 +35,11 @@ This middleware adds `env[OpenapiFirst::OPERATION]` which holds an Operation obj
 
 ### 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)
+| 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)      |
 
 ## OpenapiFirst::RequestValidation
 
@@ -47,12 +49,11 @@ This middleware returns a 400 status code with a body that describes the error i
 use OpenapiFirst::RequestValidation
 ```
 
-
 ### Options and defaults
 
-| Name | Possible values | Description | Default
-|:---|---|---|---|
-| `raise_error:` |`false`, `true` | If set to true the middleware raises `OpenapiFirst::RequestInvalidError` instead of returning 4xx. | `false` (don't raise an exception)
+| Name           | Possible values | Description                                                                                        | Default                            |
+| :------------- | --------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `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).
 
@@ -110,17 +111,18 @@ Response validation fails if response body includes a property with `writeOnly:
 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.
 
 ```ruby
-run OpenapiFirst::Responder, spec: OpenapiFirst.load('./openapi/openapi.yaml')
+run OpenapiFirst::Responder
 ```
 
 ### 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) |
 
+| 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::DefaultOperationResolver
+
 This is the default way to look up a handler method for an operation. Handlers are always looked up in a namespace module that needs to be specified.
 
 It works like this:
@@ -144,13 +146,15 @@ There are two ways to set the response body:
 - 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.
+
+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`.
 
 ```ruby
@@ -181,15 +185,14 @@ The above will use the mentioned Rack middlewares to:
 
 ### Options and defaults
 
-| Name | Possible values | Description | Default
-|:---|---|---|---|
-| `spec_path` || A filepath to an OpenAPI definition file. |
-| `namespace:` || A class or module where to find the handler methods.|
-| `response_validation:` | `true`, `false` | If set to true it raises an exception if the response is invalid. This is useful during testing. | `false`
-| `router_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request path/method is not specified. This is useful during testing. | `false`
-| `request_validation_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request is not valid. | `false`
-| `resolver:` | | Option to customize finding the [handler](#handlers) method for an operation. See [OpenapiFirst::Responder](#OpenapiFirst::Responder) for details.
-
+| Name                              | Possible values | Description                                                                                                                                          | Default |
+| :-------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `spec_path`                       |                 | A filepath to an OpenAPI definition file.                                                                                                            |
+| `namespace:`                      |                 | A class or module where to find the handler methods.                                                                                                 |
+| `response_validation:`            | `true`, `false` | If set to true it raises an exception if the response is invalid. This is useful during testing.                                                     | `false` |
+| `router_raise_error:`             | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request path/method is not specified. This is useful during testing. | `false` |
+| `request_validation_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request is not valid.                                                | `false` |
+| `resolver:`                       |                 | Option to customize finding the [handler](#handlers) method for an operation. See [OpenapiFirst::Responder](#OpenapiFirst::Responder) for details.   |
 
 Handler functions (`find_pet`) are called with two arguments:
 
@@ -289,6 +292,10 @@ Run `bundle exec rspec` to run the tests.
 
 See `bundle exec rake -T` for rubygems related tasks.
 
+## Benchmarks
+
+[Results](https://gist.github.com/ahx/e6ffced58bd2e8d5baffb2f4d2c1f823)
+
 ### Run benchmarks
 
 ```sh

data/benchmarks/Gemfile

@@ -7,7 +7,7 @@ gem 'benchmark-memory'
 gem 'committee'
 gem 'grape'
 gem 'hanami-api'
-gem 'hanami-router', '~> 2.0.0.alpha3'
+gem 'hanami-router', '~> 2.0.0.alpha5'
 gem 'multi_json'
 gem 'openapi_first', path: '../'
 gem 'sinatra'

data/benchmarks/Gemfile.lock

@@ -1,37 +1,34 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.14.1)
+    openapi_first (0.16.0.beta1)
       deep_merge (>= 1.2.1)
-      hanami-router (~> 2.0.alpha3)
-      hanami-utils (~> 2.0.alpha1)
+      hanami-router (~> 2.0.alpha5)
+      hanami-utils (~> 2.0.alpha3)
+      json_refs (>= 0.1.7)
       json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
-      oas_parser (~> 0.25.1)
       rack (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    benchmark-ips (2.9.1)
-    benchmark-memory (0.1.2)
-      memory_profiler (~> 0.9)
+    benchmark-ips (2.9.3)
+    benchmark-memory (0.2.0)
+      memory_profiler (~> 1)
     builder (3.2.4)
     committee (4.4.0)
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (>= 0.11.1, < 1.0)
       rack (>= 1.5)
     concurrent-ruby (1.1.9)
-    deep_merge (1.2.1)
-    dry-configurable (0.13.0)
+    deep_merge (1.2.2)
+    dry-configurable (0.14.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.6)
     dry-container (0.9.0)
@@ -50,9 +47,9 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    ecma-re-validator (0.3.0)
-      regexp_parser (~> 2.0)
-    grape (1.6.0)
+    ecma-re-validator (0.4.0)
+      regexp_parser (~> 2.2)
+    grape (1.6.2)
       activesupport
       builder
       dry-types (>= 1.1)
@@ -66,22 +63,22 @@ GEM
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
-    hanami-utils (2.0.0.alpha2)
+    hanami-utils (2.0.0.alpha6)
       concurrent-ruby (~> 1.0)
       dry-transformer (~> 0.1)
     hansi (0.2.0)
-    hash-deep-merge (0.1.1)
-    i18n (1.8.10)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
+    json_refs (0.1.7)
+      hana
     json_schema (0.21.0)
     json_schemer (0.2.18)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
-    memory_profiler (0.9.14)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
+    memory_profiler (1.0.0)
+    minitest (5.15.0)
     multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -90,26 +87,13 @@ GEM
       mustermann (= 1.1.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    oas_parser (0.25.4)
-      activesupport (>= 4.0.0)
-      addressable (~> 2.3)
-      builder (~> 3.2.3)
-      deep_merge (~> 1.2.1)
-      hash-deep-merge
-      mustermann-contrib (~> 1.1.1)
-      nokogiri
     openapi_parser (0.15.0)
-    public_suffix (4.0.6)
-    racc (1.5.2)
     rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-protection (2.1.0)
       rack
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     ruby2_keywords (0.0.5)
     seg (1.2.0)
     sinatra (2.1.0)
@@ -124,10 +108,9 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     uri_template (0.7.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   benchmark-ips
@@ -135,11 +118,11 @@ DEPENDENCIES
   committee
   grape
   hanami-api
-  hanami-router (~> 2.0.0.alpha3)
+  hanami-router (~> 2.0.0.alpha5)
   multi_json
   openapi_first!
   sinatra
   syro
 
 BUNDLED WITH
-   2.2.3
+   2.2.28

data/benchmarks/apps/committee.ru

@@ -20,7 +20,7 @@ app = Class.new(Hanami::API) do
 end.new
 
 use Committee::Middleware::RequestValidation,
-    schema_path: './apps/openapi.yaml',
+    schema_path: File.absolute_path('./openapi.yaml', __dir__),
     parse_response_by_content_type: true
 
 run app

data/benchmarks/apps/committee_with_response_validation.ru

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

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

@@ -28,15 +28,13 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  type: object
-                  required: [hello, id]
-                  properties:
-                    hello:
-                      type: string
-                    id:
-                      type: string
+                type: object
+                required: [hello, id]
+                properties:
+                  hello:
+                    type: string
+                  id:
+                    type: string
   /hello:
     get:
       operationId: find_things
@@ -61,11 +59,13 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [hello]
-                properties:
-                  hello:
-                    type: string
+                type: array
+                items:
+                  type: object
+                  required: [hello]
+                  properties:
+                    hello:
+                      type: string
         default:
           description: Error response
 

data/benchmarks/apps/openapi_first_with_hanami_api.ru

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+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
+
+oas_path = File.absolute_path('./openapi.yaml', __dir__)
+use OpenapiFirst::Router, spec: OpenapiFirst.load(oas_path)
+use OpenapiFirst::RequestValidation
+
+run app

data/benchmarks/apps/openapi_first_with_response_validation.ru

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+
+namespace = Module.new do
+  def self.find_thing(params, _res)
+    { hello: 'world', id: params.fetch(:id) }
+  end
+
+  def self.find_things(_params, _res)
+    [{ hello: 'world' }]
+  end
+
+  def self.create_thing(_params, res)
+    res.status = 201
+    { hello: 'world' }
+  end
+end
+
+oas_path = File.absolute_path('./openapi.yaml', __dir__)
+run OpenapiFirst.app(oas_path, namespace: namespace, response_validation: true)

data/lib/openapi_first/app.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rack'
-require 'logger'
 
 module OpenapiFirst
   class App

data/lib/openapi_first/operation.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'json_schemer'
+require 'set'
 require_relative 'schema_validation'
 require_relative 'utils'
 require_relative 'response_object'

data/lib/openapi_first/request_validation.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rack'
-require 'json_schemer'
 require 'multi_json'
 require_relative 'inbox'
 require_relative 'router_required'
@@ -11,9 +10,9 @@ module OpenapiFirst
   class RequestValidation # rubocop:disable Metrics/ClassLength
     prepend RouterRequired
 
-    def initialize(app, raise_error: false)
+    def initialize(app, options = {})
       @app = app
-      @raise = raise_error
+      @raise = options.fetch(:raise_error, false)
     end
 
     def call(env) # rubocop:disable Metrics/AbcSize
@@ -106,8 +105,10 @@ module OpenapiFirst
       return unless schema
 
       params = filtered_params(schema.raw_schema, params)
-      errors = schema.validate(Utils.deep_stringify(params))
+      params = Utils.deep_stringify(params)
+      errors = schema.validate(params)
       halt_with_error(400, serialize_query_parameter_errors(errors)) if errors.any?
+      params = Utils.deep_symbolize(params)
       env[PARAMETERS] = params
       env[INBOX].merge! params
     end
@@ -142,6 +143,8 @@ module OpenapiFirst
     end
 
     def parse_array_parameter(value, schema)
+      return value if value.nil? || value.empty?
+
       array = value.is_a?(Array) ? value : value.split(',')
       return array unless schema['items']
 

data/lib/openapi_first/responder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rack'
+require 'multi_json'
 require_relative 'inbox'
 require_relative 'default_operation_resolver'
 

data/lib/openapi_first/response_object.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require_relative 'utils'
 
 module OpenapiFirst
   # Represents an OpenAPI Response Object

data/lib/openapi_first/response_validation.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'json_schemer'
 require 'multi_json'
 require_relative 'router_required'
-require_relative 'validation'
+require_relative 'validation_format'
 
 module OpenapiFirst
   class ResponseValidation

data/lib/openapi_first/response_validator.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'json_schemer'
-require 'multi_json'
-require_relative 'validation'
+require_relative 'response_validation'
 require_relative 'router'
 
 module OpenapiFirst

data/lib/openapi_first/router.rb

@@ -2,21 +2,18 @@
 
 require 'rack'
 require 'hanami/router'
-require_relative 'utils'
 
 module OpenapiFirst
   class Router
     def initialize(
       app,
-      spec:,
-      raise_error: false,
-      not_found: :halt,
-      parent_app: nil
+      options
     )
       @app = app
-      @parent_app = parent_app
-      @raise = raise_error
-      @not_found = not_found
+      @parent_app = options.fetch(:parent_app, nil)
+      @raise = options.fetch(:raise_error, false)
+      @not_found = options.fetch(:not_found, :halt)
+      spec = options.fetch(:spec)
       @filepath = spec.filepath
       @router = build_router(spec.operations)
     end

data/lib/openapi_first/schema_validation.rb

@@ -14,6 +14,7 @@ module OpenapiFirst
       @schemer = JSONSchemer.schema(
         schema,
         keywords: custom_keywords,
+        insert_property_defaults: true,
         before_property_validation: proc do |data, property, property_schema, parent|
           convert_nullable(data, property, property_schema, parent)
         end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.14.1'
+  VERSION = '0.16.0.beta1'
 end

data/lib/openapi_first.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'oas_parser'
-require 'openapi_first/definition'
-require 'openapi_first/version'
-require 'openapi_first/inbox'
-require 'openapi_first/router'
-require 'openapi_first/request_validation'
-require 'openapi_first/response_validator'
-require 'openapi_first/response_validation'
-require 'openapi_first/responder'
-require 'openapi_first/app'
+require 'json_refs'
+require_relative 'openapi_first/definition'
+require_relative 'openapi_first/version'
+require_relative 'openapi_first/inbox'
+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/responder'
+require_relative 'openapi_first/app'
 
 module OpenapiFirst
   OPERATION = 'openapi_first.operation'
@@ -24,8 +24,10 @@ module OpenapiFirst
   end
 
   def self.load(spec_path, only: nil)
-    content = YAML.load_file(spec_path)
-    resolved = OasParser::Parser.new(spec_path, content).resolve
+    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)
+    end
     resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
     Definition.new(resolved, spec_path)
   end

data/openapi_first.gemspec

@@ -35,15 +35,18 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
-  spec.add_runtime_dependency 'hanami-router', '~> 2.0.alpha3'
-  spec.add_runtime_dependency 'hanami-utils', '~> 2.0.alpha1'
+  spec.add_runtime_dependency 'hanami-router', '~> 2.0.alpha5'
+  spec.add_runtime_dependency 'hanami-utils', '~> 2.0.alpha3'
+  spec.add_runtime_dependency 'json_refs', '>= 0.1.7'
   spec.add_runtime_dependency 'json_schemer', '~> 0.2.16'
   spec.add_runtime_dependency 'multi_json', '~> 1.14'
-  spec.add_runtime_dependency 'oas_parser', '~> 0.25.1'
   spec.add_runtime_dependency 'rack', '~> 2.2'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rack-test', '~> 1'
   spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.16.0.beta1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha3
+        version: 2.0.alpha5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha3
+        version: 2.0.alpha5
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha1
+        version: 2.0.alpha3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha1
+        version: 2.0.alpha3
 - !ruby/object:Gem::Dependency
-  name: json_schemer
+  name: json_refs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 0.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 0.2.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 0.2.16
 - !ruby/object:Gem::Dependency
-  name: oas_parser
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.1
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.1
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -185,11 +185,15 @@ files:
 - benchmarks/Gemfile
 - benchmarks/Gemfile.lock
 - benchmarks/apps/committee.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.ru
+- benchmarks/apps/openapi_first_with_hanami_api.ru
+- benchmarks/apps/openapi_first_with_response_validation.ru
 - benchmarks/apps/sinatra.ru
 - benchmarks/apps/syro.ru
 - benchmarks/benchmarks.rb
@@ -223,9 +227,7 @@ 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/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -237,11 +239,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Implement REST APIs based on OpenApi.