openapi_first 0.10.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49ebcf2af159defac87d97f5d9cc1b2c76a1f76ce09376f209bc38458c2eee07
-  data.tar.gz: dbe17ecf51792614df624c91a704f9a319bf1bf2b1b1cded454a748f193c2e21
+  metadata.gz: '03752095ad50ff4a6142b3f716f00aba532191a12f700227eca0d2d3c9c7a6b1'
+  data.tar.gz: 7c0271d081181b18999ce75dc72ee9fa4677eb18fc0ee02ed1a40505da9aa072
 SHA512:
-  metadata.gz: 9d478201cf1e856d745dff02e4977552b95c09500956be61c6d169cf179a1f15968bca460a63a9ce76fb97bba0c5d5713e94d5e802d8fe0446428fdfd6b3feb8
-  data.tar.gz: dac17e6ec186b821a6fbdf09c47c20478f43bb21d30175b5d3e8150e0e99cf98110b2a7c01e143207176733485b52df1972277bc6790a7730c6a365dde32e3b1
+  metadata.gz: f7a2454ed16c69e7d0b32f610ed985640735bba36a1e28798319b501f3f1eb80bb14b8329c8794f0dd87e3d38db037210319e3e25f82b1b5e0110f63c24ea4d3
+  data.tar.gz: 479eedd62e341f834ed258504d2699a94cfa924301ae85a016d075c56df870041e3b0504829bbce456694e138f7598129c20684731257ff6be23d5dba4b9b2f8

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,24 @@
 # Changelog
 
+## 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)
+- 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
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.10.2)
+    openapi_first (0.12.0)
       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)
@@ -21,16 +21,16 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.1)
     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,18 +66,18 @@ 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)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.0)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -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.1)
       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,73 +1,124 @@
 # 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')
-use OpenapiFirst::RequestValidation
 ```
 
-### Rack env variables
-These variables will available in your rack env:
+This middleware adds `env[OpenapiFirst::OPERATION]` which holds an Operation object that responds to `operation_id` and `path`.
 
-- `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:
 
-## Standalone usage
-You can implement your API in conveniently with just OpenapiFirst.
+| 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)
+
+## OpenapiFirst::RequestValidation
+
+This middleware returns a 400 status code with a body that describes the error if the request is not valid.
 
 ```ruby
-module Pets
-  def self.find_pet(params, res)
+use OpenapiFirst::RequestValidation
+```
+
+
+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": [
     {
-      id: params['id'],
-      name: 'Oscar'
+      "title": "is missing",
+      "source": {
+        "parameter": "search"
+      }
     }
-  end
-end
-
-# In config.ru:
-require 'openapi_first'
-run OpenapiFirst.app('./openapi/openapi.yaml', namespace: Pets)
+  ]
+}
 ```
 
-The above will use the mentioned Rack middlewares to:
+This middleware adds `env[OpenapiFirst::INBOX]` which holds the (filtered) path and query parameters and the parsed request body.
 
-- Validate the request and respond with 400 if the request does not match with your API description
-- 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`)
+### Parameter validation
 
-Handler functions (`find_pet`) are called with two arguments:
+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]`.
 
-- `params` - Holds the parsed request body, filtered query params and path parameters
-- `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`.
+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.
 
-### Handlers
+_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 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.
+## 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:
 
-- "create_pet" or "createPet" or "create pet" calls `MyApi.create_pet(params, response)`
+- 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
+- `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/))
@@ -75,75 +126,70 @@ You can call `params.env` to access the Rack env (just like in [Hanami actions](
 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)
+- Returning a value which will get converted to JSON
 
-### If your API description does not contain all endpoints
+## OpenapiFirst::ResponseValidation
+This middleware is especially useful when testing. It *always* raises an error if the response is not valid.
 
 ```ruby
-run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
+use OpenapiFirst::ResponseValidation if ENV['RACK_ENV'] == 'test'
 ```
 
-Here all requests that are not part of the API description will be passed to the next app.
-
-### Try it out
-
-See [examples](examples).
-
-## Installation
-
-Add this line to your application's Gemfile:
+## Standalone usage
+Instead of composing these middlewares yourself you can use `OpenapiFirst.app`.
 
 ```ruby
-gem 'openapi_first'
+module Pets
+  def self.find_pet(params, res)
+    {
+      id: params[:id],
+      name: 'Oscar'
+    }
+  end
+end
+
+# In config.ru:
+require 'openapi_first'
+run OpenapiFirst.app('./openapi/openapi.yaml', namespace: Pets)
 ```
 
-OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
+The above will use the mentioned Rack middlewares to:
 
-## Request validation
+- Validate the request and respond with 400 if the request does not match with your API description
+- 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`)
 
-If the request is not valid, these middlewares return a 400 status code with a body that describes the error.
+Handler functions (`find_pet`) are called with two arguments:
 
-The error responses conform with [JSON:API](https://jsonapi.org).
+- `params` - Holds the parsed request body, filtered query params and path parameters
+- `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`.
 
-Here's an example response body for a missing query parameter "search":
+## If your API description does not contain all endpoints
 
-```json
-http-status: 400
-content-type: "application/vnd.api+json"
-
-{
-  "errors": [
-    {
-      "title": "is missing",
-      "source": {
-        "parameter": "search"
-      }
-    }
-  ]
-}
+```ruby
+run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
 ```
 
-### 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.
+Here all requests that are not part of the API description will be passed to the next app.
 
-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.
+## Try it out
 
-_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))._
+See [examples](examples).
 
-### Request body validation
+## Installation
 
-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]`.
+Add this line to your application's Gemfile:
 
-### Header, Cookie, Path parameter validation
+```ruby
+gem 'openapi_first'
+```
 
-tbd.
+OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
 
-## 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).
+Instead of using the ResponseValidation middleware you can validate the response in your test manually via [rack-test](https://github.com/rack-test/rack-test) and ResponseValidator.
 
 ```ruby
 # In your test (rspec example):
@@ -151,7 +197,8 @@ require 'openapi_first'
 spec = OpenapiFirst.load('petstore.yaml')
 validator = OpenapiFirst::ResponseValidator.new(spec)
 
-expect(validator.validate(last_request, last_response).errors).to be_empty
+# This will raise an exception if it found an error
+validator.validate(last_request, last_response)
 ```
 
 ## Handling only certain paths
@@ -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. 🤗