openapi_first 0.12.5 → 0.14.0

data/lib/openapi_first/responder.rb

@@ -2,12 +2,12 @@
 
 require 'rack'
 require_relative 'inbox'
-require_relative 'find_handler'
+require_relative 'default_operation_resolver'
 
 module OpenapiFirst
   class Responder
-    def initialize(spec:, namespace:, resolver: FindHandler.new(spec, namespace))
-      @resolver = resolver
+    def initialize(namespace: nil, resolver: nil)
+      @resolver = resolver || DefaultOperationResolver.new(namespace)
       @namespace = namespace
     end
 
@@ -24,7 +24,7 @@ module OpenapiFirst
     private
 
     def find_handler(operation)
-      handler = @resolver[operation.operation_id]
+      handler = @resolver.call(operation)
       raise NotImplementedError, "Could not find handler for #{operation.name}" unless handler
 
       handler

data/lib/openapi_first/response_validation.rb

@@ -41,7 +41,8 @@ module OpenapiFirst
       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|
+      errors = schema.validate(data)
+      errors = errors.to_a.map! do |error|
         error_message_for(error)
       end
       raise ResponseBodyInvalidError, errors.join(', ') if errors.any?

data/lib/openapi_first/router.rb

@@ -40,7 +40,10 @@ module OpenapiFirst
 
     def raise_error(env)
       req = Rack::Request.new(env)
-      msg = "Could not find definition for #{req.request_method} '#{req.path}' in API description #{@filepath}"
+      msg =
+        "Could not find definition for #{req.request_method} '#{
+          req.path
+        }' in API description #{@filepath}"
       raise NotFoundError, msg
     end
 
@@ -53,13 +56,12 @@ module OpenapiFirst
       env[Rack::PATH_INFO] = env.delete(ORIGINAL_PATH) if env[ORIGINAL_PATH]
     end
 
-    def build_router(operations) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      router = Hanami::Router.new {}
+    def build_router(operations) # rubocop:disable Metrics/AbcSize
+      router = Hanami::Router.new
       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."
-          next
         end
         router.public_send(
           operation.method,

data/lib/openapi_first/schema_validation.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json_schemer'
+
+module OpenapiFirst
+  class SchemaValidation
+    attr_reader :raw_schema
+
+    def initialize(schema, write: true)
+      @raw_schema = schema
+      custom_keywords = {}
+      custom_keywords['writeOnly'] = proc { |data| !data } unless write
+      custom_keywords['readOnly'] = proc { |data| !data } if write
+      @schemer = JSONSchemer.schema(
+        schema,
+        keywords: custom_keywords,
+        before_property_validation: proc do |data, property, property_schema, parent|
+          convert_nullable(data, property, property_schema, parent)
+        end
+      )
+    end
+
+    def validate(input)
+      @schemer.validate(input)
+    end
+
+    private
+
+    def convert_nullable(_data, _property, property_schema, _parent)
+      return unless property_schema.is_a?(Hash) && property_schema['nullable'] && property_schema['type']
+
+      property_schema['type'] = [*property_schema['type'], 'null']
+      property_schema.delete('nullable')
+    end
+  end
+end

data/lib/openapi_first/utils.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'hanami/utils/string'
+require 'hanami/utils/hash'
 require 'deep_merge/core'
 
 module OpenapiFirst
@@ -17,20 +18,12 @@ module OpenapiFirst
       Hanami::Utils::String.classify(string)
     end
 
-    def self.deep_stringify(params) # rubocop:disable Metrics/MethodLength
-      params.each_with_object({}) do |(key, value), output|
-        output[key.to_s] =
-          case value
-          when ::Hash
-            deep_stringify(value)
-          when Array
-            value.map do |item|
-              item.is_a?(::Hash) ? deep_stringify(item) : item
-            end
-          else
-            value
-          end
-      end
+    def self.deep_symbolize(hash)
+      Hanami::Utils::Hash.deep_symbolize(hash)
+    end
+
+    def self.deep_stringify(hash)
+      Hanami::Utils::Hash.deep_stringify(hash)
     end
   end
 end

data/lib/openapi_first/validation_format.rb

@@ -6,17 +6,37 @@ module OpenapiFirst
 
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.error_details(error)
       if error['type'] == 'pattern'
         {
           title: 'is not valid',
           detail: "does not match pattern '#{error['schema']['pattern']}'"
         }
+      elsif error['type'] == 'format'
+        {
+          title: "has not a valid #{error.dig('schema', 'format')} format",
+          detail: "#{error['data'].inspect} is not a valid #{error.dig('schema', 'format')} format"
+        }
+      elsif error['type'] == 'enum'
+        {
+          title: "value #{error['data'].inspect} is not defined in enum",
+          detail: "value can be one of #{error.dig('schema', 'enum')&.join(', ')}"
+        }
       elsif error['type'] == 'required'
         missing_keys = error['details']['missing_keys']
         {
           title: "is missing required properties: #{missing_keys.join(', ')}"
         }
+      elsif error['type'] == 'readOnly'
+        {
+          title: 'appears in request, but is read-only'
+        }
+      elsif error['type'] == 'writeOnly'
+        {
+          title: 'write-only field appears in response:'
+        }
       elsif SIMPLE_TYPES.include?(error['type'])
         {
           title: "should be a #{error['type']}"
@@ -29,5 +49,7 @@ module OpenapiFirst
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
   end
 end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.12.5'
+  VERSION = '0.14.0'
 end

data/openapi_first.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
     spec.metadata['changelog_uri'] = 'https://github.com/ahx/openapi_first/blob/master/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -32,10 +32,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.6.0'
+
   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 'json_schemer', '~> 0.2.16'
   spec.add_runtime_dependency 'multi_json', '~> 1.14'
   spec.add_runtime_dependency 'oas_parser', '~> 0.25.1'
   spec.add_runtime_dependency 'rack', '~> 2.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.14.0
 platform: ruby
 authors:
 - Andreas Haller
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.16
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: 
+description:
 email:
 - andreas.haller@posteo.de
 executables: []
@@ -187,6 +187,7 @@ files:
 - benchmarks/Gemfile.lock
 - benchmarks/apps/committee.ru
 - benchmarks/apps/grape.ru
+- benchmarks/apps/hanami_api.ru
 - benchmarks/apps/hanami_router.ru
 - benchmarks/apps/openapi.yaml
 - benchmarks/apps/openapi_first.ru
@@ -202,8 +203,8 @@ files:
 - lib/openapi_first.rb
 - lib/openapi_first/app.rb
 - lib/openapi_first/coverage.rb
+- lib/openapi_first/default_operation_resolver.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/request_validation.rb
@@ -213,6 +214,7 @@ files:
 - lib/openapi_first/response_validator.rb
 - lib/openapi_first/router.rb
 - lib/openapi_first/router_required.rb
+- lib/openapi_first/schema_validation.rb
 - lib/openapi_first/utils.rb
 - lib/openapi_first/validation.rb
 - lib/openapi_first/validation_format.rb
@@ -225,7 +227,7 @@ metadata:
   https://github.com/ahx/openapi_first: https://github.com/ahx/openapi_first
   source_code_uri: https://github.com/ahx/openapi_first
   changelog_uri: https://github.com/ahx/openapi_first/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -233,15 +235,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Implement REST APIs based on OpenApi.
 test_files: []