openapi_first 0.10.2 → 0.12.0

data/lib/openapi_first/responder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rack'
+require_relative 'inbox'
+require_relative 'find_handler'
+
+module OpenapiFirst
+  class Responder
+    def initialize(spec:, namespace:, resolver: FindHandler.new(spec, namespace))
+      @resolver = resolver
+      @namespace = namespace
+    end
+
+    def call(env)
+      operation = env[OpenapiFirst::OPERATION]
+      res = Rack::Response.new
+      handler = find_handler(operation)
+      result = handler.call(env[INBOX], res)
+      res.write serialize(result) if result && res.body.empty?
+      res[Rack::CONTENT_TYPE] ||= operation.content_type_for(res.status)
+      res.finish
+    end
+
+    private
+
+    def find_handler(operation)
+      handler = @resolver[operation.operation_id]
+      raise NotImplementedError, "Could not find handler for #{operation.name}" unless handler
+
+      handler
+    end
+
+    def serialize(result)
+      return result if result.is_a?(String)
+
+      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_object.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'utils'
+
+module OpenapiFirst
+  # Represents an OpenAPI Response Object
+  class ResponseObject
+    extend Forwardable
+    def_delegators :@parsed,
+                   :content
+
+    def_delegators :@raw,
+                   :[]
+
+    def initialize(parsed)
+      @parsed = parsed
+      @raw = parsed.raw
+    end
+  end
+end

data/lib/openapi_first/response_validation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+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
+
+    def call(env)
+      operation = env[OPERATION]
+      return @app.call(env) unless operation
+
+      response = @app.call(env)
+      validate(response, operation)
+      response
+    end
+
+    def validate(response, operation)
+      status, headers, body = response.to_a
+      content_type = headers[Rack::CONTENT_TYPE]
+      raise ResponseInvalid, "Response has no content-type for '#{operation.name}'" unless content_type
+
+      response_schema = operation.response_schema_for(status, content_type)
+      validate_response_body(response_schema, body) if response_schema
+    end
+
+    private
+
+    def validate_response_body(schema, response)
+      full_body = +''
+      response.each { |chunk| full_body << chunk }
+      data = full_body.empty? ? {} : load_json(full_body)
+      errors = JSONSchemer.schema(schema).validate(data).to_a.map do |error|
+        error_message_for(error)
+      end
+      raise ResponseBodyInvalidError, errors.join(', ') if errors.any?
+    end
+
+    def load_json(string)
+      MultiJson.load(string)
+    rescue MultiJson::ParseError
+      string
+    end
+
+    def error_message_for(error)
+      err = ValidationFormat.error_details(error)
+      [err[:title], error['data_pointer'], err[:detail]].compact.join(' ')
+    end
+  end
+end

data/lib/openapi_first/response_validator.rb

@@ -3,57 +3,20 @@
 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)
+      @response_validation = ResponseValidation.new(->(response) { response.to_a })
     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]
-      unless content_type
-        return ["Content type not found: '#{response.content_type}'"]
-      end
-
-      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)
+      env = request.env.dup
+      @router.call(env)
+      @response_validation.validate(response, env[OPERATION])
     end
   end
 end

data/lib/openapi_first/router.rb

@@ -6,64 +6,49 @@ require_relative 'utils'
 
 module OpenapiFirst
   class Router
-    NOT_FOUND = Rack::Response.new('', 404).finish.freeze
-
-    def initialize(app, options)
+    def initialize(
+      app,
+      spec:,
+      raise_error: false,
+      parent_app: nil
+    )
       @app = app
-      @namespace = options.fetch(:namespace, nil)
-      @parent_app = options.fetch(:parent_app, nil)
-      @router = build_router(options.fetch(:spec).operations)
+      @parent_app = parent_app
+      @raise = raise_error
+      @filepath = spec.filepath
+      @router = build_router(spec.operations)
     end
 
     def call(env)
-      endpoint = find_endpoint(env)
-      return endpoint.call(env) if endpoint
-      return @parent_app.call(env) if @parent_app
+      env[OPERATION] = nil
+      response = call_router(env)
+      status = response[0]
+      if UNKNOWN_ROUTE_STATUS.include?(status)
+        return @parent_app.call(env) if @parent_app # This should only happen if used via OpenapiFirst.middlware
 
-      NOT_FOUND
+        raise_error(env) if @raise
+      end
+      response
     end
 
-    def find_handler(operation_id) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      name = operation_id.match(/:*(.*)/)&.to_a&.at(1)
-      return if name.nil?
+    UNKNOWN_ROUTE_STATUS = [404, 405].freeze
+    ORIGINAL_PATH = 'openapi_first.path_info'
 
-      if name.include?('.')
-        module_name, method_name = name.split('.')
-        klass = find_const(@namespace, module_name)
-        return klass&.method(Utils.underscore(method_name))
-      end
-      if name.include?('#')
-        module_name, klass_name = name.split('#')
-        const = find_const(@namespace, module_name)
-        klass = find_const(const, klass_name)
-        if klass.instance_method(:initialize).arity.zero?
-          return ->(params, res) { klass.new.call(params, res) }
-        end
-
-        return ->(params, res) { klass.new(params.env).call(params, res) }
-      end
-      method_name = Utils.underscore(name)
-      return unless @namespace.respond_to?(method_name)
+    private
 
-      @namespace.method(method_name)
+    def raise_error(env)
+      req = Rack::Request.new(env)
+      msg = "Could not find definition for #{req.request_method} '#{req.path}' in API description #{@filepath}"
+      raise NotFoundError, msg
     end
 
-    private
-
-    def find_endpoint(env)
-      original_path_info = env[Rack::PATH_INFO]
-      # Overwrite PATH_INFO temporarily, because hanami-router does not respect SCRIPT_NAME # rubocop:disable Layout/LineLength
+    def call_router(env)
+      # Changing and restoring PATH_INFO is needed, because Hanami::Router does not respect existing script_path
+      env[ORIGINAL_PATH] = env[Rack::PATH_INFO]
       env[Rack::PATH_INFO] = Rack::Request.new(env).path
-      @router.recognize(env).endpoint
+      @router.call(env)
     ensure
-      env[Rack::PATH_INFO] = original_path_info
-    end
-
-    def find_const(parent, name)
-      name = Utils.classify(name)
-      return unless parent.const_defined?(name, false)
-
-      parent.const_get(name, false)
+      env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH) if env[ORIGINAL_PATH]
     end
 
     def build_router(operations) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -71,12 +56,7 @@ module OpenapiFirst
       operations.each do |operation|
         normalized_path = operation.path.gsub('{', ':').gsub('}', '')
         if operation.operation_id.nil?
-          warn "operationId is missing in '#{operation.method} #{operation.path}'. I am ignoring this operation." # rubocop:disable Layout/LineLength
-          next
-        end
-        handler = @namespace && find_handler(operation.operation_id)
-        if @namespace && handler.nil?
-          warn "#{self.class.name} cannot not find handler for '#{operation.operation_id}' (#{operation.method} #{operation.path}). This operation will be ignored." # rubocop:disable Layout/LineLength
+          warn "operationId is missing in '#{operation.method} #{operation.path}'. I am ignoring this operation."
           next
         end
         router.public_send(
@@ -84,8 +64,8 @@ module OpenapiFirst
           normalized_path,
           to: lambda do |env|
             env[OPERATION] = operation
-            env[PARAMETERS] = Utils.deep_stringify(env['router.params'])
-            env[HANDLER] = handler
+            env[PARAMETERS] = env['router.params']
+            env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH)
             @app.call(env)
           end
         )

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/validation_format.rb

@@ -5,6 +5,7 @@ module OpenapiFirst
     SIMPLE_TYPES = %w[string integer].freeze
 
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def self.error_details(error)
       if error['type'] == 'pattern'
         {
@@ -23,9 +24,10 @@ module OpenapiFirst
       elsif error['schema'] == false
         { title: 'unknown fields are not allowed' }
       else
-        { title: 'is not valid' }
+        { title: "is not valid: #{error['data'].inspect}" }
       end
     end
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.10.2'
+  VERSION = '0.12.0'
 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.alpha2'
-  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.10.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha2
+        version: 2.0.alpha3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.alpha2
+        version: 2.0.alpha3
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
@@ -203,12 +203,16 @@ files:
 - lib/openapi_first/app.rb
 - lib/openapi_first/coverage.rb
 - lib/openapi_first/definition.rb
+- 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

data/lib/openapi_first/operation_resolver.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'rack'
-require_relative 'inbox'
-
-module OpenapiFirst
-  class OperationResolver
-    def call(env)
-      operation = env[OpenapiFirst::OPERATION]
-      res = Rack::Response.new
-      inbox = env[INBOX]
-      handler = env[HANDLER]
-      result = handler.call(inbox, res)
-      res.write serialize(result) if result && res.body.empty?
-      res[Rack::CONTENT_TYPE] ||= operation.content_type_for(res.status)
-      res.finish
-    end
-
-    private
-
-    def serialize(result)
-      return result if result.is_a?(String)
-
-      MultiJson.dump(result)
-    end
-  end
-end