openapi_first 0.12.5 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8692df035f2c27738cc74a8265ad45f6235397c0ce35059fdeef29ef54402ba
-  data.tar.gz: 156a0c22674e9eed4b2a7ffdfff1cde726b721bf63e8cede6c0d006442c72890
+  metadata.gz: 4f1e3ae677c078e5e4b64641c76c40a66994edb8599d9001e3673458eb83338d
+  data.tar.gz: 6e394c9017964515be4e8970899fe697480600753ca6e81db78d34faed7c982b
 SHA512:
-  metadata.gz: 7f4bedb9b730bb1c27a29d04fe7b915f2e61b0ac6305d6faccb52fd7baa962356704ce0ec85c192f36b9bb5ba9323d29cefa014d287c564fc48dcdaa8bd953a1
-  data.tar.gz: 9341ba6927183ad541b0b5d3dbc4096112a74204ce14abd1b2c72bfa339c757853f93041f80df85aa51d83377380d9ba034ce260885a5ddbbc64cb769e177d16
+  metadata.gz: e41290229c5e5bc7d65179783b6b1ec0403ab987433c5b65535c10d3fee00a42440626f26f2a8ffd02d69a63b64684780165cc4398baf873842e20731570a076
+  data.tar.gz: b93594502a2dff93be5b0bff277f49431c40cae4a77a263acfac14370c855dbd424ac36156b832ec2f2ef1f892e44c0c7aaf84d6b567d772220da0ec991357a5

data/.rubocop.yml

@@ -1,54 +1,14 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
 Style/Documentation:
   Enabled: false
 Style/ExponentialNotation:
   Enabled: true
 Metrics/BlockLength:
   Exclude:
-  - 'spec/**/*.rb'
-  - '*.gemspec'
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Lint/DuplicateElsifCondition:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-Style/RedundantRegexpEscape:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: false
-Style/AccessorGrouping:
-  Enabled: true
-Style/ArrayCoercion:
-  Enabled: true
-Style/BisectedAttrAccessor:
-  Enabled: true
-Style/CaseLikeIf:
-  Enabled: true
-Style/HashAsLastArrayItem:
-  Enabled: true
-Style/HashLikeCase:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/RedundantAssignment:
-  Enabled: true
-Style/RedundantFetchBlock:
-  Enabled: true
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
+    - "spec/**/*.rb"
+    - "*.gemspec"
+Metrics/MethodLength:
+  Max: 20

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 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
 
@@ -15,7 +30,7 @@
 
 ## 0.12.1
 - Fix response when handler returns 404 or 405
-- Don't validate the response content if status is 205 (no content)
+- 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

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.12.5)
+    openapi_first (0.14.0)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
-      json_schemer (~> 0.2)
+      json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
       oas_parser (~> 0.25.1)
       rack (~> 2.2)
@@ -13,51 +13,53 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
+      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.1)
+    ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     deep_merge (1.2.1)
     diff-lcs (1.4.4)
-    ecma-re-validator (0.2.1)
-      regexp_parser (~> 1.2)
-    hana (1.3.6)
-    hanami-router (2.0.0.alpha3)
+    dry-transformer (0.1.1)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    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.alpha1)
+    hanami-utils (2.0.0.alpha2)
       concurrent-ruby (~> 1.0)
-      transproc (~> 1.0)
+      dry-transformer (~> 0.1)
     hansi (0.2.0)
     hash-deep-merge (0.1.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json_schemer (0.2.13)
-      ecma-re-validator (~> 0.2)
+    json_schemer (0.2.18)
+      ecma-re-validator (~> 0.3)
       hana (~> 1.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    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.10.10)
-      mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.1)
+    nokogiri (1.12.2)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    oas_parser (0.25.4)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -65,53 +67,52 @@ GEM
       hash-deep-merge
       mustermann-contrib (~> 1.1.1)
       nokogiri
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.5)
+    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)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.6)
+    regexp_parser (2.1.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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.88.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.4)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.8.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.2.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
-    thread_safe (0.3.6)
-    transproc (1.1.1)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.0)
+      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.0.0)
     uri_template (0.7.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -126,4 +127,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -19,7 +19,7 @@ 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.
+- [`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
@@ -29,9 +29,9 @@ You always have to add this middleware first in order to make the other middlewa
 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` and `path`.
+This middleware adds `env[OpenapiFirst::OPERATION]` which holds an Operation object that responds to `#operation_id`, `#path` (and `#[]` to access raw fields).
 
-Options and their defaults:
+### Options and defaults
 
 | Name | Possible values | Description | Default
 |:---|---|---|---|
@@ -48,7 +48,7 @@ use OpenapiFirst::RequestValidation
 ```
 
 
-Options and their defaults:
+### Options and defaults
 
 | Name | Possible values | Description | Default
 |:---|---|---|---|
@@ -79,7 +79,12 @@ This middleware adds `env[OpenapiFirst::INBOX]` which holds the (filtered) path
 ### Parameter validation
 
 The middleware filteres all top-level query parameters and paths parameters and tries to convert numeric values. Meaning, if you have an `:something_id` path with `type: integer`, it will try convert the value to an integer.
-Note that is currently does not convert date, date-time or time formats and that conversion is currently done only for path and query parameters, but not for the request body. It just works with a parameter with `name: filter[age]`.
+
+It just works with a parameter with `name: filter[age]`.
+
+OpenapiFirst also supports `type: array` for query parameters and will convert `items` just as described above. [`style`](http://spec.openapis.org/oas/v3.0.3#style-values) and `explode` attributes are not supported for query parameters. It will always act as if `style: form` and `explode: false` were used for query parameters.
+
+Conversion is currently done only for path and query parameters, but not for the request body. OpenapiFirst currently does not convert date, date-time or time formats.
 
 If you want to forbid _nested_ query parameters you will need to use [`additionalProperties: false`](https://json-schema.org/understanding-json-schema/reference/object.html#properties) in your query parameter JSON schema.
 
@@ -94,20 +99,29 @@ This will also add the parsed request body to `env[OpenapiFirst::REQUEST_BODY]`.
 
 tbd.
 
+### readOnly / writeOnly properties
+
+Request validation fails if request includes a property with `readOnly: true`.
+
+Response validation fails if response body includes a property with `writeOnly: true`.
+
 ## 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.
 
-Currently there are no customization options for this part. Please [share your ideas](#contributing) on how to best meet your needs and preferred style.
-
 ```ruby
 run OpenapiFirst::Responder, spec: OpenapiFirst.load('./openapi/openapi.yaml')
 ```
 
+### Options
 | Name | Description
 |:---|---|
-|`spec:`| The spec loaded via `OpenapiFirst.load` |
-| `namespace:` | A class or module where to find the handler method. |
+| `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)[#handler]. 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:
 
@@ -165,7 +179,7 @@ The above will use the mentioned Rack middlewares to:
 - Map the request to a method call `Pets.find_pet` based on the `operationId` in the API description
 - Set the response content type according to your spec (here with the default status code `200`)
 
-### Options and their defaults:
+### Options and defaults
 
 | Name | Possible values | Description | Default
 |:---|---|---|---|
@@ -174,6 +188,7 @@ The above will use the mentioned Rack middlewares to:
 | `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](#handler) method for an operation. See [OpenapiFirst::Responder](#OpenapiFirst::Responder) for details.
 
 
 Handler functions (`find_pet`) are called with two arguments:

data/benchmarks/Gemfile

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

data/benchmarks/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.12.5)
+    openapi_first (0.14.0)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
-      json_schemer (~> 0.2)
+      json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
       oas_parser (~> 0.25.1)
       rack (~> 2.2)
@@ -13,76 +13,75 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
+      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.8.2)
+    benchmark-ips (2.9.1)
     benchmark-memory (0.1.2)
       memory_profiler (~> 0.9)
     builder (3.2.4)
-    committee (4.1.0)
+    committee (4.4.0)
       json_schema (~> 0.14, >= 0.14.3)
-      openapi_parser (>= 0.11.1)
+      openapi_parser (>= 0.11.1, < 1.0)
       rack (>= 1.5)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     deep_merge (1.2.1)
-    dry-configurable (0.11.6)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.8.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.0.6)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-types (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-transformer (0.1.1)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    ecma-re-validator (0.2.1)
-      regexp_parser (~> 1.2)
-    grape (1.4.0)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    grape (1.5.3)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    hana (1.3.6)
-    hanami-router (2.0.0.alpha3)
+    hana (1.3.7)
+    hanami-api (0.2.0)
+      hanami-router (~> 2.0.alpha)
+    hanami-router (2.0.0.alpha5)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
-    hanami-utils (2.0.0.alpha1)
+    hanami-utils (2.0.0.alpha2)
       concurrent-ruby (~> 1.0)
-      transproc (~> 1.0)
+      dry-transformer (~> 0.1)
     hansi (0.2.0)
     hash-deep-merge (0.1.1)
-    i18n (1.8.4)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json_schema (0.20.9)
-    json_schemer (0.2.13)
-      ecma-re-validator (~> 0.2)
+    json_schema (0.21.0)
+    json_schemer (0.2.18)
+      ecma-re-validator (~> 0.3)
       hana (~> 1.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     memory_profiler (0.9.14)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
     multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -91,9 +90,10 @@ GEM
       mustermann (= 1.1.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.1)
+    nokogiri (1.12.2)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    oas_parser (0.25.4)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -101,31 +101,30 @@ GEM
       hash-deep-merge
       mustermann-contrib (~> 1.1.1)
       nokogiri
-    openapi_parser (0.11.2)
-    public_suffix (4.0.5)
+    openapi_parser (0.14.1)
+    public_suffix (4.0.6)
+    racc (1.5.2)
     rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
-    rack-protection (2.0.8.1)
+    rack-protection (2.1.0)
       rack
-    regexp_parser (1.7.1)
-    ruby2_keywords (0.0.2)
+    regexp_parser (2.1.1)
+    ruby2_keywords (0.0.5)
     seg (1.2.0)
-    sinatra (2.0.8.1)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.8.1)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
-    syro (3.2.0)
+    syro (3.2.1)
       rack (>= 1.6.0)
       seg
-    thread_safe (0.3.6)
     tilt (2.0.10)
-    transproc (1.1.1)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     uri_template (0.7.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -135,11 +134,12 @@ DEPENDENCIES
   benchmark-memory
   committee
   grape
-  hanami-router (~> 2.0.0.alpha2)
+  hanami-api
+  hanami-router (~> 2.0.0.alpha3)
   multi_json
   openapi_first!
   sinatra
   syro
 
 BUNDLED WITH
-   2.1.4
+   2.2.3