openapi_first 0.11.0.alpha → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16372f591f02e7332d7d010c0a91e239e38592f41bf2eb5d88d7777058f66fd
-  data.tar.gz: e02ab1188d3cd8bc64ece82381316f4d7e8012c784e21d1ae2bb0b16bc24b141
+  metadata.gz: 3a7011597803fb49d100073027c9545634d497971b34ac49c2eeb0916258f424
+  data.tar.gz: 1f552e13bd915d41d39e2fffcc7a026b5abd3ba5c19ed4f726e3538c68a893df
 SHA512:
-  metadata.gz: 8d8f44debbe60e787de68246b822669991ba6d1aac3721cbe68f04ee51cffb99ea02b280be0ba3e6e28d0bf11a26b565d2e23792fb08f451462ab36990026970
-  data.tar.gz: 2545816e97f18afde6947c61893b81a2606fa5e27262d037f3fd1475430acf7c1ffa2bf5db70b6d06316cd6524380ac47290b656ae457200e29e8384da860dc9
+  metadata.gz: 50053573288bde3ce62df411c706dc9fe64a4395b7110a539cf4e1b685b1953140cdbc8d9ad7e7d8b0eee4d9b4211243f7c3e85ef6b79a44720f9b56ae316c3f
+  data.tar.gz: 017b082c94490f45cc0cb90935c0f5a463958740d858b56f2d6baf1b2e579f9e5820acda5cc5f53c0d9fe50cc261600a1f8c93c498f165997f026f68617c888f

data/.rubocop.yml

@@ -16,6 +16,12 @@ 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:

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
-## Unreleased
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.11.0.alpha)
+    openapi_first (0.11.0)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
@@ -23,7 +23,7 @@ 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)
@@ -66,7 +66,7 @@ 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)
@@ -92,10 +92,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.84.0)
+    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)

data/README.md

@@ -1,42 +1,130 @@
 # 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).
 
 ## 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. This can be customized.
-- `OpenapiFirst::RequestValidation` – Validates the request against the API description 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.
 
 ## 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
 |:---|---|---|---|
-| `not_found:` |`nil`, `:continue`, `Proc`| Specifies what to do if 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)
+|`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:` |`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
 
-## 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:
+This middleware returns a 400 status code with a body that describes the error if the request is not valid.
 
 ```ruby
-use OpenapiFirst::Router, spec: OpenapiFirst.load('./openapi/openapi.yaml')
 use OpenapiFirst::RequestValidation
 ```
 
-### Rack env variables
-These variables will available in your rack env:
+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
 
-- `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.
+## OpenapiFirst::ResponseValidation
+This middleware is especially useful when testing. It 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
@@ -65,29 +153,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)
@@ -95,7 +161,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).
 
@@ -109,49 +175,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).
 
@@ -234,6 +258,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.11.0.alpha)
+    openapi_first (0.11.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)

data/lib/openapi_first.rb

@@ -9,7 +9,7 @@ require 'openapi_first/router'
 require 'openapi_first/request_validation'
 require 'openapi_first/response_validator'
 require 'openapi_first/response_validation'
-require 'openapi_first/operation_resolver'
+require 'openapi_first/responder'
 require 'openapi_first/app'
 
 module OpenapiFirst
@@ -29,12 +29,13 @@ module OpenapiFirst
 
   def self.app(spec, namespace:)
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    App.new(nil, spec, namespace: namespace)
+    test = ENV['RACK_ENV'] == 'test'
+    App.new(nil, spec, namespace: namespace, router_raise: test)
   end
 
   def self.middleware(spec, namespace:)
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    AppWithOptions.new(spec, namespace: namespace)
+    AppWithOptions.new(spec, namespace: namespace, router_raise: false)
   end
 
   class AppWithOptions

data/lib/openapi_first/app.rb

@@ -5,16 +5,12 @@ require 'logger'
 
 module OpenapiFirst
   class App
-    def initialize(
-      parent_app,
-      spec,
-      namespace:
-    )
+    def initialize(parent_app, spec, namespace:, router_raise:)
       @stack = Rack::Builder.app do
         freeze_app
-        use OpenapiFirst::Router, spec: spec, parent_app: parent_app
+        use OpenapiFirst::Router, spec: spec, raise: router_raise, parent_app: parent_app
         use OpenapiFirst::RequestValidation
-        run OpenapiFirst::OperationResolver.new(
+        run OpenapiFirst::Responder.new(
           spec: spec,
           namespace: namespace
         )

data/lib/openapi_first/request_validation.rb

@@ -4,11 +4,14 @@ require 'rack'
 require 'json_schemer'
 require 'multi_json'
 require_relative 'inbox'
+require_relative 'router_required'
 require_relative 'validation_format'
 
 module OpenapiFirst
   class RequestValidation # rubocop:disable Metrics/ClassLength
-    def initialize(app, _options = {})
+    prepend RouterRequired
+
+    def initialize(app)
       @app = app
     end
 

data/lib/openapi_first/{operation_resolver.rb → responder.rb}

@@ -5,7 +5,7 @@ require_relative 'inbox'
 require_relative 'find_handler'
 
 module OpenapiFirst
-  class OperationResolver
+  class Responder
     def initialize(spec:, namespace:)
       @handlers = FindHandler.new(spec, namespace).all
       @namespace = namespace
@@ -29,4 +29,11 @@ module OpenapiFirst
       MultiJson.dump(result)
     end
   end
+
+  class OperationResolver < Responder
+    def initialize(spec:, namespace:)
+      warn "#{self.class.name} was renamed to #{OpenapiFirst::Responder.name}"
+      super
+    end
+  end
 end

data/lib/openapi_first/response_validation.rb

@@ -2,10 +2,13 @@
 
 require 'json_schemer'
 require 'multi_json'
+require_relative 'router_required'
 require_relative 'validation'
 
 module OpenapiFirst
   class ResponseValidation
+    prepend RouterRequired
+
     def initialize(app)
       @app = app
     end
@@ -56,61 +59,3 @@ module OpenapiFirst
     end
   end
 end
-
-# frozen_string_literal: true
-
-require 'json_schemer'
-require 'multi_json'
-require_relative 'validation'
-
-module OpenapiFirst
-  class ResponseValidator
-    def initialize(spec)
-      @spec = spec
-    end
-
-    def validate(request, response)
-      errors = validation_errors(request, response)
-      Validation.new(errors || [])
-    rescue OasParser::ResponseCodeNotFound, OasParser::MethodNotFound => e
-      Validation.new([e.message])
-    end
-
-    private
-
-    def validation_errors(request, response)
-      content = response_for(request, response)&.content
-      return unless content
-
-      content_type = content[response.content_type]
-      return ["Content type not found: '#{response.content_type}'"] unless content_type
-
-      response_schema = content_type['schema']
-      return unless response_schema
-
-      response_data = MultiJson.load(response.body)
-      validate_json_schema(response_schema, response_data)
-    end
-
-    def validate_json_schema(schema, data)
-      JSONSchemer.schema(schema).validate(data).to_a.map do |error|
-        format_error(error)
-      end
-    end
-
-    def format_error(error)
-      ValidationFormat.error_details(error)
-                      .merge!(
-                        data_pointer: error['data_pointer'],
-                        schema_pointer: error['schema_pointer']
-                      ).tap do |formatted|
-      end
-    end
-
-    def response_for(request, response)
-      @spec
-        .find_operation!(request)
-        &.response_by_code(response.status.to_s, use_default: true)
-    end
-  end
-end

data/lib/openapi_first/router.rb

@@ -24,6 +24,7 @@ module OpenapiFirst
     end
 
     def call(env)
+      env[OPERATION] = nil
       endpoint = find_endpoint(env)
       return endpoint.call(env) if endpoint
 

data/lib/openapi_first/router_required.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module RouterRequired
+    def call(env)
+      unless env.key?(OPERATION)
+        raise 'OpenapiFirst::Router missing in middleware stack. Did you forget adding OpenapiFirst::Router?'
+      end
+
+      super
+    end
+  end
+end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.11.0.alpha'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.11.0.alpha
+  version: 0.11.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -206,12 +206,13 @@ files:
 - lib/openapi_first/find_handler.rb
 - lib/openapi_first/inbox.rb
 - lib/openapi_first/operation.rb
-- lib/openapi_first/operation_resolver.rb
 - lib/openapi_first/request_validation.rb
+- lib/openapi_first/responder.rb
 - lib/openapi_first/response_object.rb
 - lib/openapi_first/response_validation.rb
 - lib/openapi_first/response_validator.rb
 - lib/openapi_first/router.rb
+- lib/openapi_first/router_required.rb
 - lib/openapi_first/utils.rb
 - lib/openapi_first/validation.rb
 - lib/openapi_first/validation_format.rb
@@ -235,9 +236,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: