openapi_first 0.10.1 → 0.12.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e09e897264d21c6e932f5c01fb4e2a9ae9c3dab065ebf12dee3bffde0c15c3
-  data.tar.gz: 21441c2a7ecf5cda139e8341191b409f7c7848d6ac77f3d21077693292672b91
+  metadata.gz: 4d0848ff82fa49a93053ec107ca28c419c1be8b9122301a8819742685e8b7995
+  data.tar.gz: 11cf9a3c60b619cd55d7f3f552a2c367553aa69ed047ddd101eff1b460ee4c53
 SHA512:
-  metadata.gz: 2609d6c686ae07f9e2a73ea6d32432f08e5fa951a4608789fdaafbe7b3734a2f039b6c9beab55829aedbc0a7fc14d0c0b80dae9b8c5a83ffb2938916e546900a
-  data.tar.gz: 6bcfb9cebdd1f2263006234bdda7739abe2486e530bfa9f94e2d9825a8788344f968b4afaf1fb616765babe4762b210625026817a80d02a985621286ccc6299e
+  metadata.gz: 5cabc3434dd9c4801b3f6ec030ec4ad5ef6905762a2643ef59a99f78057e6b108f90bf24696d29cab776dfa61a571be4973af7f62af07f5672f64996fb77086d
+  data.tar.gz: b7391c86d982be35d680e56f904261b8cfbd846a8206c2f339adc703248ad2476121fb8534a9562a20e081a2e5d5a8696231937affb23a72fe917a546a7e34c2

data/.rubocop.yml

@@ -8,10 +8,22 @@ Metrics/BlockLength:
   Exclude:
   - 'spec/**/*.rb'
   - '*.gemspec'
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  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:

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## Unreleased
+- Add `raise_error` option to OpenapiFirst.app (false by default)
+- Add ResponseValidation to OpenapiFirst.app if raise_error option is true
+- Rename `raise` option to `raise_error`
+- Add `raise_error` option to RequestValidation middleware
+- Raise error if handler could not be found by Responder
+- 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
+- Add ResponseValidation middleware that validates the response body
+- Add `raise` option to Router middleware to raise an error if request could not be found in the API description similar to committee's raise option.
+- 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))
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.10.1)
+    openapi_first (0.12.0.alpha2)
       deep_merge (>= 1.2.1)
-      hanami-router (~> 2.0.alpha2)
+      hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
       multi_json (~> 1.14)
@@ -13,7 +13,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -23,14 +23,14 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     builder (3.2.4)
-    coderay (1.1.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
     deep_merge (1.2.1)
     diff-lcs (1.3)
     ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
     hana (1.3.6)
-    hanami-router (2.0.0.alpha2)
+    hanami-router (2.0.0.alpha3)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
@@ -39,9 +39,8 @@ GEM
       transproc (~> 1.0)
     hansi (0.2.0)
     hash-deep-merge (0.1.1)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     json_schemer (0.2.11)
       ecma-re-validator (~> 0.2)
       hana (~> 1.3)
@@ -49,7 +48,7 @@ GEM
       uri_template (~> 0.7)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multi_json (1.14.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -67,12 +66,12 @@ GEM
       mustermann-contrib (~> 1.1.1)
       nokogiri
     parallel (1.19.1)
-    parser (2.7.1.2)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.4)
+    public_suffix (4.0.5)
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -86,21 +85,24 @@ GEM
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.2)
       rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.1)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.85.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
     thread_safe (0.3.6)

data/README.md

@@ -1,32 +1,143 @@
 # OpenapiFirst
 
+[![Join the chat at https://gitter.im/openapi_first/community](https://badges.gitter.im/openapi_first/community.svg)](https://gitter.im/openapi_first/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 OpenapiFirst helps to implement HTTP APIs based on an [OpenApi](https://www.openapis.org/) API description. The idea is that you create an API description first, then add code that returns data and implements your business logic and be done.
 
-Start with writing an OpenAPI file that describes the API, which you are about to write. Use a [validator](https://github.com/stoplightio/spectral/) to make sure the file is valid.
+Start with writing an OpenAPI file that describes the API, which you are about to implement. Use a [validator](https://github.com/stoplightio/spectral/) to make sure the file is valid.
+
+You can use OpenapiFirst via its [Rack middlewares](#rack-middlewares) or in [standalone mode](#standalone-usage).
+
+## Alternatives
+
+This gem is inspired by [committee](https://github.com/interagent/committee) (Ruby) and [connexion](https://github.com/zalando/connexion) (Python).
+
+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` finds the operation for the current request or returns 404 if no operation was found.
-- `OpenapiFirst::RequestValidation` validates the request against the found operation and returns 400 if the request is invalid.
-- `OpenapiFirst::OperationResolver` calls the [handler](#handlers) found for the operation.
+- [`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::ResponseValidation`](#OpenapiFirst::ResponseValidation) Validates the response and raises an exception if the response body is invalid.
 
-## Usage within your Rack webframework
-If you just want to use the request validation part without any handlers you can use the rack middlewares standalone:
+## 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` and `path`.
+
+Options and their defaults:
+
+| Name | Possible values | Description | Default
+|:---|---|---|---|
+|`spec:`| | The spec loaded via `OpenapiFirst.load` ||
+| `not_found:` |`nil`, `:continue`, `Proc`| Specifies what to do if the path was not found in the API description. `nil` (default) returns a 404 response. `:continue` does nothing an calls the next app. `Proc` (or something that responds to `call`) to customize the response. | `nil` (return 404)
+| `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)
+
+## 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
 ```
 
-### Rack env variables
-These variables will available in your rack env:
 
-- `env[OpenapiFirst::OPERATION]` - Holds an Operation object that responsed about `operation_id` and `path`. This is useful for introspection.
-- `env[OpenapiFirst::INBOX]`. Holds the (filtered) path and query parameters and the parsed request body.
+Options and their 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)
+
+The error responses conform with [JSON:API](https://jsonapi.org).
+
+Here's an example response body for a missing query parameter "search":
+
+```json
+http-status: 400
+content-type: "application/vnd.api+json"
+
+{
+  "errors": [
+    {
+      "title": "is missing",
+      "source": {
+        "parameter": "search"
+      }
+    }
+  ]
+}
+```
+
+This middleware adds `env[OpenapiFirst::INBOX]` which holds the (filtered) path and query parameters and the parsed request body.
+
+### 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]`.
+
+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.
+
+_OpenapiFirst always treats query parameters like [`style: deepObject`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#style-values), **but** it just works with nested objects (`filter[foo][bar]=baz`) (see [this discussion](https://github.com/OAI/OpenAPI-Specification/issues/1706))._
+
+### Request body validation
+
+The middleware will return a status `415` if the requests content type does not match or `400` if the request body is invalid.
+This will also add the parsed request body to `env[OpenapiFirst::REQUEST_BODY]`.
+
+### Header, Cookie, Path parameter validation
+
+tbd.
+
+## 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')
+```
+
+| Name | Description
+|:---|---|
+|`spec:`| The spec loaded via `OpenapiFirst.load` |
+| `namespace:` | A class or module where to find the handler method. |
+
+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`.
+
+### Handlers
+
+These handler methods are called with two arguments:
+
+- `params` - Holds the parsed request body, filtered query params and path parameters (same as `env[OpenapiFirst::INBOX]`)
+- `res` - Holds a Rack::Response that you can modify if needed
+
+You can call `params.env` to access the Rack env (just like in [Hanami actions](https://guides.hanamirb.org/actions/parameters/))
+
+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
-You can implement your API in conveniently with just OpenapiFirst.
+Instead of composing these middlewares yourself you can use `OpenapiFirst.app`.
 
 ```ruby
 module Pets
@@ -55,29 +166,7 @@ Handler functions (`find_pet`) are called with two arguments:
 - `res` - Holds a Rack::Response that you can modify if needed
   If you want to access to plain Rack env you can call `params.env`.
 
-### Handlers
-
-OpenapiFirst 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 via the `OperationResolver` middleware.
-
-It works like this:
-
-- "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`.
-
-These handler methods are called with two arguments:
-
-- `params` - Holds the parsed request body, filtered query params and path parameters
-- `res` - Holds a Rack::Response that you can modify if needed
-
-You can call `params.env` to access the Rack env (just like in [Hanami actions](https://guides.hanamirb.org/actions/parameters/))
-
-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 from the function (see example above) (this will always converted to JSON)
-
-### If your API description does not contain all endpoints
+## If your API description does not contain all endpoints
 
 ```ruby
 run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
@@ -85,7 +174,7 @@ run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
 
 Here all requests that are not part of the API description will be passed to the next app.
 
-### Try it out
+## Try it out
 
 See [examples](examples).
 
@@ -99,49 +188,7 @@ gem 'openapi_first'
 
 OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
 
-## Request validation
-
-If the request is not valid, these middlewares return a 400 status code with a body that describes the error.
-
-The error responses conform with [JSON:API](https://jsonapi.org).
-
-Here's an example response body for a missing query parameter "search":
-
-```json
-http-status: 400
-content-type: "application/vnd.api+json"
-
-{
-  "errors": [
-    {
-      "title": "is missing",
-      "source": {
-        "parameter": "search"
-      }
-    }
-  ]
-}
-```
-
-### 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 on done for path and query parameters, but not for request bodies.
-
-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.
-
-_OpenapiFirst always treats query parameters like [`style: deepObject`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#style-values), **but** it just works with nested objects (`filter[foo][bar]=baz`) (see [this discussion](https://github.com/OAI/OpenAPI-Specification/issues/1706))._
-
-### Request body validation
-
-The middleware will return a `415` if the requests content type does not match or `400` if the request body is invalid.
-This will add the parsed request body to `env[OpenapiFirst::REQUEST_BODY]`.
-
-### Header, Cookie, Path parameter validation
-
-tbd.
-
-## Response validation
+## Manual response validation
 
 Response validation is useful to make sure your app responds as described in your API description. You usually do this in your tests using [rack-test](https://github.com/rack-test/rack-test).
 
@@ -202,10 +249,6 @@ end
 
 Out of scope. Use [Prism](https://github.com/stoplightio/prism) or [fakeit](https://github.com/JustinFeng/fakeit).
 
-## Alternatives
-
-This gem is inspired by [committee](https://github.com/interagent/committee), which has much more features like response stubs or support for Hyper-Schema or OpenAPI 2.
-
 ## Development
 
 Run `bin/setup` to install dependencies.
@@ -224,6 +267,6 @@ bundle exec ruby benchmarks.rb
 
 ## Contributing
 
-If you have a question or an idea or found a bug don't hesitate to [create an issue on GitHub](https://github.com/ahx/openapi_first/issues).
+If you have a question or an idea or found a bug don't hesitate to [create an issue on GitHub](https://github.com/ahx/openapi_first/issues) or [reach out via chat](https://gitter.im/openapi_first/community).
 
 Pull requests are very welcome as well, of course. Feel free to create a "draft" pull request early on, even if your change is still work in progress. 🤗

data/benchmarks/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.10.1)
+    openapi_first (0.12.0.alpha2)
       deep_merge (>= 1.2.1)
-      hanami-router (~> 2.0.alpha2)
+      hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
       multi_json (~> 1.14)
@@ -13,7 +13,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -25,9 +25,9 @@ GEM
     benchmark-memory (0.1.2)
       memory_profiler (~> 0.9)
     builder (3.2.4)
-    committee (3.3.0)
+    committee (4.0.0)
       json_schema (~> 0.14, >= 0.14.3)
-      openapi_parser (>= 0.6.1)
+      openapi_parser (>= 0.11.1)
       rack (>= 1.5)
     concurrent-ruby (1.1.6)
     deep_merge (1.2.1)
@@ -55,7 +55,7 @@ GEM
       dry-logic (~> 1.0, >= 1.0.2)
     ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
-    grape (1.3.2)
+    grape (1.3.3)
       activesupport
       builder
       dry-types (>= 1.1)
@@ -63,7 +63,7 @@ GEM
       rack (>= 1.3.0)
       rack-accept
     hana (1.3.6)
-    hanami-router (2.0.0.alpha2)
+    hanami-router (2.0.0.alpha3)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
@@ -82,7 +82,7 @@ GEM
       uri_template (~> 0.7)
     memory_profiler (0.9.14)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multi_json (1.14.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -101,14 +101,14 @@ GEM
       hash-deep-merge
       mustermann-contrib (~> 1.1.1)
       nokogiri
-    openapi_parser (0.10.0)
-    public_suffix (4.0.4)
+    openapi_parser (0.11.2)
+    public_suffix (4.0.5)
     rack (2.2.2)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-protection (2.0.8.1)
       rack
-    regexp_parser (1.7.0)
+    regexp_parser (1.7.1)
     ruby2_keywords (0.0.2)
     seg (1.2.0)
     sinatra (2.0.8.1)