openapi_first 0.12.0.alpha1 → 0.12.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 476fbf7b7c6b6d5111d7dcb1fa4cd5197744c989315ea7b82b4e648956d7fee4
-  data.tar.gz: 10e9f751d733284f21eccbad29cf12347ce9924eeba6ed4c4afd43450c952e2e
+  metadata.gz: 4d0848ff82fa49a93053ec107ca28c419c1be8b9122301a8819742685e8b7995
+  data.tar.gz: 11cf9a3c60b619cd55d7f3f552a2c367553aa69ed047ddd101eff1b460ee4c53
 SHA512:
-  metadata.gz: b0e7387ededf44b1613c8de8663590086ecc063f940f603e52cae799db52600ac257767bbe5c861ad856270a1c4ac9af8d4eb65b8cdc0166fb84f56e05487f8f
-  data.tar.gz: 636a22a59d02af532543e78f46ba7cb2b1acca3f329ff4a75410e3ccedd7f3c95b999bf99c54842d110f0d605827d935737fc58fa4b048c26df44b34f285d46c
+  metadata.gz: 5cabc3434dd9c4801b3f6ec030ec4ad5ef6905762a2643ef59a99f78057e6b108f90bf24696d29cab776dfa61a571be4973af7f62af07f5672f64996fb77086d
+  data.tar.gz: b7391c86d982be35d680e56f904261b8cfbd846a8206c2f339adc703248ad2476121fb8534a9562a20e081a2e5d5a8696231937affb23a72fe917a546a7e34c2

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 # Changelog
 
-## Unreleased (0.12.x)
+## Unreleased
+- 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.12.0.alpha1)
+    openapi_first (0.12.0.alpha2)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
@@ -39,7 +39,7 @@ 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)
     json_schemer (0.2.11)
       ecma-re-validator (~> 0.2)

data/README.md

@@ -8,6 +8,12 @@ Start with writing an OpenAPI file that describes the API, which you are about t
 
 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:
 
@@ -243,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) (Ruby) and [connexion](https://github.com/zalando/connexion) (Python).
-
 ## Development
 
 Run `bin/setup` to install dependencies.

data/benchmarks/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.11.0)
+    openapi_first (0.12.0.alpha2)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
@@ -108,7 +108,7 @@ GEM
       rack (>= 0.4)
     rack-protection (2.0.8.1)
       rack
-    regexp_parser (1.7.0)
+    regexp_parser (1.7.1)
     ruby2_keywords (0.0.2)
     seg (1.2.0)
     sinatra (2.0.8.1)

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

@@ -31,7 +31,7 @@ module OpenapiFirst
     Definition.new(parsed)
   end
 
-  def self.app(spec, namespace:, raise_error: OpenapiFirst.env == 'test')
+  def self.app(spec, namespace:, raise_error: false)
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
     App.new(nil, spec, namespace: namespace, raise_error: raise_error)
   end
@@ -54,6 +54,7 @@ module OpenapiFirst
 
   class Error < StandardError; end
   class NotFoundError < Error; end
+  class NotImplementedError < RuntimeError; end
   class ResponseCodeNotFoundError < Error; end
   class ResponseMediaTypeNotFoundError < Error; end
   class ResponseBodyInvalidError < Error; end

data/lib/openapi_first/app.rb

@@ -10,6 +10,7 @@ module OpenapiFirst
         freeze_app
         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

data/lib/openapi_first/find_handler.rb

@@ -5,14 +5,10 @@ require_relative 'utils'
 module OpenapiFirst
   class FindHandler
     def initialize(spec, namespace)
-      @spec = spec
       @namespace = namespace
-    end
-
-    def all
-      @spec.operations.each_with_object({}) do |operation, hash|
+      @handlers = spec.operations.each_with_object({}) do |operation, hash|
         operation_id = operation.operation_id
-        handler = find_by_operation_id(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
@@ -21,22 +17,17 @@ module OpenapiFirst
       end
     end
 
-    def find_by_operation_id(operation_id) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def [](operation_id)
+      @handlers[operation_id]
+    end
+
+    def find_handler(operation_id)
       name = operation_id.match(/:*(.*)/)&.to_a&.at(1)
       return if name.nil?
 
-      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)
-        return ->(params, res) { klass.new.call(params, res) } if klass.instance_method(:initialize).arity.zero?
-
-        return ->(params, res) { klass.new(params.env).call(params, res) }
+      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)
@@ -44,11 +35,24 @@ module OpenapiFirst
       @namespace.method(method_name)
     end
 
-    private
+    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)
-      return unless parent.const_defined?(name, false)
+      throw :halt unless parent.const_defined?(name, false)
 
       parent.const_get(name, false)
     end

data/lib/openapi_first/operation.rb

@@ -36,7 +36,7 @@ module OpenapiFirst
 
       media_type = content[content_type]
       unless media_type
-        message = "Response media type found: '#{content_type}' for '#{operation_name}'"
+        message = "Response content type not found: '#{content_type}' for '#{name}'"
         raise ResponseMediaTypeNotFoundError, message
       end
       media_type['schema']
@@ -45,16 +45,16 @@ module OpenapiFirst
     def response_for(status)
       @operation.response_by_code(status.to_s, use_default: true).raw
     rescue OasParser::ResponseCodeNotFound
-      message = "Response status code or default not found: #{status} for '#{operation_name}'"
+      message = "Response status code or default not found: #{status} for '#{name}'"
       raise OpenapiFirst::ResponseCodeNotFoundError, message
     end
 
-    private
-
-    def operation_name
-      "#{method.upcase} #{path}"
+    def name
+      "#{method.upcase} #{path} (#{operation_id})"
     end
 
+    private
+
     def build_parameters_json_schema
       return unless @operation.parameters&.any?
 

data/lib/openapi_first/responder.rb

@@ -6,15 +6,15 @@ require_relative 'find_handler'
 
 module OpenapiFirst
   class Responder
-    def initialize(spec:, namespace:)
-      @handlers = FindHandler.new(spec, namespace).all
+    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 = @handlers[operation.operation_id]
+      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)
@@ -23,6 +23,13 @@ module OpenapiFirst
 
     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)
 

data/lib/openapi_first/response_validation.rb

@@ -46,16 +46,22 @@ module OpenapiFirst
     def validate_response_body(schema, response)
       full_body = +''
       response.each { |chunk| full_body << chunk }
-      data = full_body.empty? ? {} : MultiJson.load(full_body)
+      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], 'at', error['data_pointer'], err[:detail]].compact.join(' ')
+      [err[:title], error['data_pointer'], err[:detail]].compact.join(' ')
     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.12.0.alpha1'
+  VERSION = '0.12.0.alpha2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.12.0.alpha1
+  version: 0.12.0.alpha2
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge