openapi_first 0.11.0 → 0.12.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7011597803fb49d100073027c9545634d497971b34ac49c2eeb0916258f424
-  data.tar.gz: 1f552e13bd915d41d39e2fffcc7a026b5abd3ba5c19ed4f726e3538c68a893df
+  metadata.gz: 476fbf7b7c6b6d5111d7dcb1fa4cd5197744c989315ea7b82b4e648956d7fee4
+  data.tar.gz: 10e9f751d733284f21eccbad29cf12347ce9924eeba6ed4c4afd43450c952e2e
 SHA512:
-  metadata.gz: 50053573288bde3ce62df411c706dc9fe64a4395b7110a539cf4e1b685b1953140cdbc8d9ad7e7d8b0eee4d9b4211243f7c3e85ef6b79a44720f9b56ae316c3f
-  data.tar.gz: 017b082c94490f45cc0cb90935c0f5a463958740d858b56f2d6baf1b2e579f9e5820acda5cc5f53c0d9fe50cc261600a1f8c93c498f165997f026f68617c888f
+  metadata.gz: b0e7387ededf44b1613c8de8663590086ecc063f940f603e52cae799db52600ac257767bbe5c861ad856270a1c4ac9af8d4eb65b8cdc0166fb84f56e05487f8f
+  data.tar.gz: 636a22a59d02af532543e78f46ba7cb2b1acca3f329ff4a75410e3ccedd7f3c95b999bf99c54842d110f0d605827d935737fc58fa4b048c26df44b34f285d46c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased (0.12.x)
+- Rename `raise` option to `raise_error`
+- Add `raise_error` option to RequestValidation middleware
+
 ## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.11.0)
+    openapi_first (0.12.0.alpha1)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)

data/README.md

@@ -31,7 +31,7 @@ Options and their defaults:
 |:---|---|---|---|
 |`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)
+| `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
 
@@ -41,6 +41,13 @@ This middleware returns a 400 status code with a body that describes the error i
 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":
@@ -117,7 +124,7 @@ 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 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'

data/lib/openapi_first.rb

@@ -19,6 +19,10 @@ module OpenapiFirst
   INBOX = 'openapi_first.inbox'
   HANDLER = 'openapi_first.handler'
 
+  def self.env
+    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV['RAILS_ENV']
+  end
+
   def self.load(spec_path, only: nil)
     content = YAML.load_file(spec_path)
     raw = OasParser::Parser.new(spec_path, content).resolve
@@ -27,15 +31,14 @@ module OpenapiFirst
     Definition.new(parsed)
   end
 
-  def self.app(spec, namespace:)
+  def self.app(spec, namespace:, raise_error: OpenapiFirst.env == 'test')
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    test = ENV['RACK_ENV'] == 'test'
-    App.new(nil, spec, namespace: namespace, router_raise: test)
+    App.new(nil, spec, namespace: namespace, raise_error: raise_error)
   end
 
-  def self.middleware(spec, namespace:)
+  def self.middleware(spec, namespace:, raise_error: false)
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    AppWithOptions.new(spec, namespace: namespace, router_raise: false)
+    AppWithOptions.new(spec, namespace: namespace, raise_error: raise_error)
   end
 
   class AppWithOptions
@@ -54,4 +57,36 @@ module OpenapiFirst
   class ResponseCodeNotFoundError < Error; end
   class ResponseMediaTypeNotFoundError < Error; end
   class ResponseBodyInvalidError < Error; end
+
+  class RequestInvalidError < Error
+    def initialize(serialized_errors)
+      message = error_message(serialized_errors)
+      super message
+    end
+
+    private
+
+    def error_message(errors)
+      errors.map do |error|
+        [human_source(error), human_error(error)].compact.join(' ')
+      end.join(', ')
+    end
+
+    def human_source(error)
+      return unless error[:source]
+
+      source_key = error[:source].keys.first
+      source = {
+        pointer: 'Request body invalid:',
+        parameter: 'Query parameter invalid:'
+      }.fetch(source_key, source_key)
+      name = error[:source].values.first
+      source += " #{name}" unless name.nil? || name.empty?
+      source
+    end
+
+    def human_error(error)
+      error[:title]
+    end
+  end
 end

data/lib/openapi_first/app.rb

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

data/lib/openapi_first/definition.rb

@@ -14,17 +14,5 @@ module OpenapiFirst
     def operations
       @spec.endpoints.map { |e| Operation.new(e) }
     end
-
-    def find_operation!(request)
-      @spec
-        .path_by_path(request.path)
-        .endpoint_by_method(request.request_method.downcase)
-    end
-
-    def find_operation(request)
-      find_operation!(request)
-    rescue OasParser::PathNotFound, OasParser::MethodNotFound
-      nil
-    end
   end
 end

data/lib/openapi_first/request_validation.rb

@@ -11,8 +11,9 @@ module OpenapiFirst
   class RequestValidation # rubocop:disable Metrics/ClassLength
     prepend RouterRequired
 
-    def initialize(app)
+    def initialize(app, raise_error: false)
       @app = app
+      @raise = raise_error
     end
 
     def call(env) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -85,6 +86,8 @@ module OpenapiFirst
     end
 
     def error_response(status, errors = [default_error(status)])
+      raise RequestInvalidError, errors if @raise
+
       Rack::Response.new(
         MultiJson.dump(errors: errors),
         status,

data/lib/openapi_first/response_validator.rb

@@ -3,31 +3,33 @@
 require 'json_schemer'
 require 'multi_json'
 require_relative 'validation'
+require_relative 'router'
 
 module OpenapiFirst
   class ResponseValidator
     def initialize(spec)
       @spec = spec
+      @router = Router.new(->(_env) {}, spec: spec, raise_error: true)
     end
 
     def validate(request, response)
       errors = validation_errors(request, response)
       Validation.new(errors || [])
-    rescue OasParser::ResponseCodeNotFound, OasParser::MethodNotFound => e
+    rescue OpenapiFirst::ResponseCodeNotFoundError, OpenapiFirst::NotFoundError => e
       Validation.new([e.message])
     end
 
     def validate_operation(request, response)
       errors = validation_errors(request, response)
       Validation.new(errors || [])
-    rescue OasParser::ResponseCodeNotFound, OasParser::MethodNotFound => e
+    rescue OpenapiFirst::ResponseCodeNotFoundError, OpenapiFirst::NotFoundError => e
       Validation.new([e.message])
     end
 
     private
 
     def validation_errors(request, response)
-      content = response_for(request, response)&.content
+      content = response_for(request, response)&.fetch('content', nil)
       return unless content
 
       content_type = content[response.content_type]
@@ -55,9 +57,10 @@ module OpenapiFirst
     end
 
     def response_for(request, response)
-      @spec
-        .find_operation!(request)
-        &.response_by_code(response.status.to_s, use_default: true)
+      env = request.env.dup
+      @router.call(env)
+      operation = env[OPERATION]
+      operation&.response_for(response.status)
     end
   end
 end

data/lib/openapi_first/router.rb

@@ -9,24 +9,29 @@ module OpenapiFirst
     NOT_FOUND = Rack::Response.new('', 404).finish.freeze
     DEFAULT_NOT_FOUND_APP = ->(_env) { NOT_FOUND }
 
-    def initialize(app, options) # rubocop:disable Metrics/MethodLength
+    def initialize(
+      app,
+      spec:,
+      raise_error: false,
+      parent_app: nil,
+      not_found: nil
+    )
       @app = app
-      @parent_app = options.fetch(:parent_app, nil)
-      @raise = options.fetch(:raise, false)
-      @failure_app = find_failure_app(options[:not_found])
+      @parent_app = parent_app
+      @raise = raise_error
+      @failure_app = find_failure_app(not_found)
       if @failure_app.nil?
         raise ArgumentError,
               'not_found must be nil, :continue or must respond to call'
       end
-      spec = options.fetch(:spec)
       @filepath = spec.filepath
       @router = build_router(spec.operations)
     end
 
     def call(env)
       env[OPERATION] = nil
-      endpoint = find_endpoint(env)
-      return endpoint.call(env) if endpoint
+      route = find_route(env)
+      return route.call(env) if route.routable?
 
       if @raise
         req = Rack::Request.new(env)
@@ -47,10 +52,10 @@ module OpenapiFirst
       option if option.respond_to?(:call)
     end
 
-    def find_endpoint(env)
+    def find_route(env)
       original_path_info = env[Rack::PATH_INFO]
       env[Rack::PATH_INFO] = Rack::Request.new(env).path
-      @router.recognize(env).endpoint
+      @router.recognize(env)
     ensure
       env[Rack::PATH_INFO] = original_path_info
     end

data/lib/openapi_first/version.rb

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

data/openapi_first.gemspec

@@ -32,13 +32,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'deep_merge', '>= 1.2.1'
-  spec.add_dependency 'hanami-router', '~> 2.0.alpha3'
-  spec.add_dependency 'hanami-utils', '~> 2.0.alpha1'
-  spec.add_dependency 'json_schemer', '~> 0.2'
-  spec.add_dependency 'multi_json', '~> 1.14'
-  spec.add_dependency 'oas_parser', '~> 0.25.1'
-  spec.add_dependency 'rack', '~> 2.2'
+  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 'json_schemer', '~> 0.2'
+  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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0.alpha1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -236,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: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: