openapi_first 0.10.1 → 0.12.0.alpha2

data/examples/app.rb

@@ -13,4 +13,9 @@ module Web
 end
 
 oas_path = File.absolute_path('./openapi.yaml', __dir__)
-App = OpenapiFirst.app(oas_path, namespace: Web)
+pp OpenapiFirst.env == 'test'
+App = OpenapiFirst.app(
+  oas_path,
+  namespace: Web,
+  raise_error: OpenapiFirst.env == 'test'
+)

data/lib/openapi_first.rb

@@ -8,7 +8,8 @@ require 'openapi_first/inbox'
 require 'openapi_first/router'
 require 'openapi_first/request_validation'
 require 'openapi_first/response_validator'
-require 'openapi_first/operation_resolver'
+require 'openapi_first/response_validation'
+require 'openapi_first/responder'
 require 'openapi_first/app'
 
 module OpenapiFirst
@@ -18,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
@@ -26,14 +31,14 @@ module OpenapiFirst
     Definition.new(parsed)
   end
 
-  def self.app(spec, namespace:)
+  def self.app(spec, namespace:, raise_error: false)
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    App.new(nil, spec, namespace: namespace)
+    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)
+    AppWithOptions.new(spec, namespace: namespace, raise_error: raise_error)
   end
 
   class AppWithOptions
@@ -48,5 +53,41 @@ module OpenapiFirst
   end
 
   class Error < StandardError; end
+  class NotFoundError < Error; end
+  class NotImplementedError < RuntimeError; end
   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

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
 require 'rack'
+require 'logger'
 
 module OpenapiFirst
   class App
-    def initialize(
-      parent_app,
-      spec,
-      namespace:
-    )
+    def initialize(parent_app, spec, namespace:, raise_error:)
       @stack = Rack::Builder.app do
         freeze_app
-        use OpenapiFirst::Router,
-            spec: spec,
-            namespace: namespace,
-            parent_app: parent_app
-        use OpenapiFirst::RequestValidation
-        run OpenapiFirst::OperationResolver.new
+        use OpenapiFirst::Router, spec: spec, raise_error: raise_error, parent_app: parent_app
+        use OpenapiFirst::RequestValidation, raise_error: raise_error
+        use OpenapiFirst::ResponseValidation if raise_error
+        run OpenapiFirst::Responder.new(
+          spec: spec,
+          namespace: namespace
+        )
       end
     end
 

data/lib/openapi_first/definition.rb

@@ -4,24 +4,15 @@ require_relative 'operation'
 
 module OpenapiFirst
   class Definition
+    attr_reader :filepath
+
     def initialize(parsed)
+      @filepath = parsed.path
       @spec = parsed
     end
 
     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/find_handler.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'utils'
+
+module OpenapiFirst
+  class FindHandler
+    def initialize(spec, namespace)
+      @namespace = namespace
+      @handlers = spec.operations.each_with_object({}) do |operation, hash|
+        operation_id = operation.operation_id
+        handler = find_handler(operation_id)
+        if 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
+          next
+        end
+        hash[operation_id] = handler
+      end
+    end
+
+    def [](operation_id)
+      @handlers[operation_id]
+    end
+
+    def find_handler(operation_id)
+      name = operation_id.match(/:*(.*)/)&.to_a&.at(1)
+      return if name.nil?
+
+      catch :halt do
+        return find_class_method_handler(name) if name.include?('.')
+        return find_instance_method_handler(name) if name.include?('#')
+      end
+      method_name = Utils.underscore(name)
+      return unless @namespace.respond_to?(method_name)
+
+      @namespace.method(method_name)
+    end
+
+    def find_class_method_handler(name)
+      module_name, method_name = name.split('.')
+      klass = find_const(@namespace, module_name)
+      klass.method(Utils.underscore(method_name))
+    end
+
+    def find_instance_method_handler(name)
+      module_name, klass_name = name.split('#')
+      const = find_const(@namespace, module_name)
+      klass = find_const(const, klass_name)
+      return ->(params, res) { klass.new.call(params, res) } if klass.instance_method(:initialize).arity.zero?
+
+      ->(params, res) { klass.new(params.env).call(params, res) }
+    end
+
+    def find_const(parent, name)
+      name = Utils.classify(name)
+      throw :halt unless parent.const_defined?(name, false)
+
+      parent.const_get(name, false)
+    end
+  end
+end

data/lib/openapi_first/operation.rb

@@ -2,6 +2,7 @@
 
 require 'forwardable'
 require_relative 'utils'
+require_relative 'response_object'
 
 module OpenapiFirst
   class Operation
@@ -25,16 +26,33 @@ module OpenapiFirst
     end
 
     def content_type_for(status)
-      content = @operation
-                .response_by_code(status.to_s, use_default: true)
-                .content
+      content = response_for(status)['content']
       content.keys[0] if content
+    end
+
+    def response_schema_for(status, content_type)
+      content = response_for(status)['content']
+      return if content.nil? || content.empty?
+
+      media_type = content[content_type]
+      unless media_type
+        message = "Response content type not found: '#{content_type}' for '#{name}'"
+        raise ResponseMediaTypeNotFoundError, message
+      end
+      media_type['schema']
+    end
+
+    def response_for(status)
+      @operation.response_by_code(status.to_s, use_default: true).raw
     rescue OasParser::ResponseCodeNotFound
-      operation_name = "#{method.upcase} #{path}"
-      message = "Response status code or default not found: #{status} for '#{operation_name}'" # rubocop:disable Layout/LineLength
+      message = "Response status code or default not found: #{status} for '#{name}'"
       raise OpenapiFirst::ResponseCodeNotFoundError, message
     end
 
+    def name
+      "#{method.upcase} #{path} (#{operation_id})"
+    end
+
     private
 
     def build_parameters_json_schema

data/lib/openapi_first/request_validation.rb

@@ -4,12 +4,16 @@ 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, raise_error: false)
       @app = app
+      @raise = raise_error
     end
 
     def call(env) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -44,14 +48,20 @@ module OpenapiFirst
       schema = request_body_schema(content_type, operation)
       return unless schema
 
-      parsed_request_body = MultiJson.load(body)
+      parsed_request_body = parse_request_body!(body)
       errors = validate_json_schema(schema, parsed_request_body)
-      if errors.any?
-        halt(error_response(400, serialize_request_body_errors(errors)))
-      end
+      halt(error_response(400, serialize_request_body_errors(errors))) if errors.any?
       env[INBOX].merge! env[REQUEST_BODY] = parsed_request_body
     end
 
+    def parse_request_body!(body)
+      MultiJson.load(body)
+    rescue MultiJson::ParseError => e
+      err = { title: 'Failed to parse body as JSON' }
+      err[:detail] = e.cause unless ENV['RACK_ENV'] == 'production'
+      halt(error_response(400, [err]))
+    end
+
     def validate_request_content_type!(content_type, operation)
       return if operation.request_body.content[content_type]
 
@@ -76,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,
@@ -105,9 +117,7 @@ module OpenapiFirst
 
       params = filtered_params(json_schema, params)
       errors = JSONSchemer.schema(json_schema).validate(params)
-      if errors.any?
-        halt error_response(400, serialize_query_parameter_errors(errors))
-      end
+      halt error_response(400, serialize_query_parameter_errors(errors)) if errors.any?
       env[PARAMETERS] = params
       env[INBOX].merge! params
     end

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,67 @@
+# 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
+
+      status, headers, body = @app.call(env)
+      content_type = headers[Rack::CONTENT_TYPE]
+      response_schema = operation.response_schema_for(status, content_type)
+      validate_response_body(response_schema, body) if response_schema
+
+      [status, headers, body]
+    end
+
+    private
+
+    def halt(status, body = '')
+      throw :halt, [status, {}, body]
+    end
+
+    def error(message)
+      { title: message }
+    end
+
+    def error_response(status, errors)
+      Rack::Response.new(
+        MultiJson.dump(errors: errors),
+        status,
+        Rack::CONTENT_TYPE => 'application/vnd.api+json'
+      ).finish
+    end
+
+    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|
+        format_error(error)
+      end
+      raise ResponseBodyInvalidError, errors.join(', ') if errors.any?
+    end
+
+    def load_json(string)
+      MultiJson.load(string)
+    rescue MultiJson::ParseError
+      string
+    end
+
+    def format_error(error)
+      err = ValidationFormat.error_details(error)
+      [err[:title], error['data_pointer'], err[:detail]].compact.join(' ')
+    end
+  end
+end