openapi_first 1.0.0.beta3 → 1.0.0.beta4

data/lib/openapi_first.rb

@@ -2,6 +2,8 @@
 
 require 'yaml'
 require 'json_refs'
+require_relative 'openapi_first/config'
+require_relative 'openapi_first/plugins'
 require_relative 'openapi_first/definition'
 require_relative 'openapi_first/version'
 require_relative 'openapi_first/errors'
@@ -9,15 +11,40 @@ require_relative 'openapi_first/router'
 require_relative 'openapi_first/request_validation'
 require_relative 'openapi_first/response_validator'
 require_relative 'openapi_first/response_validation'
+require_relative 'openapi_first/default_error_response'
 
 module OpenapiFirst
+  # The OpenAPI operation for the current request
   OPERATION = 'openapi.operation'
+
+  # Merged parsed path and query parameters
   PARAMS = 'openapi.params'
+
+  # Parsed query parameters
+  QUERY_PARAMS = 'openapi.query'
+
+  # Parsed path parameters
+  PATH_PARAMS = 'openapi.path_params'
+
+  # Parsed header parameters, except for Content-Type, Accept and Authorization
+  HEADER_PARAMS = 'openapi.headers'
+
+  # Parsed cookie parameter values
+  COOKIE_PARAMS = 'openapi.cookies'
+
+  # The parsed request body
   REQUEST_BODY = 'openapi.parsed_request_body'
-  HANDLER = 'openapi_first.handler'
 
-  def self.env
-    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV.fetch('RAILS_ENV', nil)
+  class << self
+    # Throws an error in the middle of the request validation to stop validation and send a response.
+    def error!(status, location = nil, title: nil, validation_result: nil)
+      throw :error, {
+        status:,
+        location:,
+        title: title || validation_result&.output&.fetch('error') || Rack::Utils::HTTP_STATUS_CODES[status],
+        validation_result:
+      }
+    end
   end
 
   def self.load(spec_path, only: nil)

data/openapi_first.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['andreas.haller@posteo.de']
   spec.licenses      = ['MIT']
 
-  spec.summary       = 'Implement REST APIs based on OpenApi.'
+  spec.summary       = 'Implement REST APIs based on OpenApi 3.x'
   spec.homepage      = 'https://github.com/ahx/openapi_first'
 
   if spec.respond_to?(:metadata)
@@ -32,19 +32,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.0.5'
+  spec.required_ruby_version = '>= 3.1.1'
 
   spec.add_runtime_dependency 'hanami-router', '~> 2.0.0'
   spec.add_runtime_dependency 'json_refs', '~> 0.1', '>= 0.1.7'
-  spec.add_runtime_dependency 'json_schemer', '~> 0.2.16'
+  spec.add_runtime_dependency 'json_schemer', '~> 2.0.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.14'
-  spec.add_runtime_dependency 'openapi_parameters', '~> 0.2'
+  spec.add_runtime_dependency 'openapi_parameters', '~> 0.2.2'
   spec.add_runtime_dependency 'rack', '>= 2.2', '< 4.0'
-
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rack-test', '~> 1'
-  spec.add_development_dependency 'rake', '~> 13'
-  spec.add_development_dependency 'rspec', '~> 3'
   spec.metadata = {
     'rubygems_mfa_required' => 'true'
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta4
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-router
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.16
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -106,62 +106,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
 description:
 email:
 - andreas.haller@posteo.de
@@ -208,17 +152,23 @@ files:
 - examples/openapi.yaml
 - lib/openapi_first.rb
 - lib/openapi_first/body_parser_middleware.rb
+- lib/openapi_first/config.rb
+- lib/openapi_first/default_error_response.rb
 - lib/openapi_first/definition.rb
+- lib/openapi_first/error_response.rb
 - lib/openapi_first/errors.rb
 - lib/openapi_first/operation.rb
+- lib/openapi_first/operation_schemas.rb
+- lib/openapi_first/plugins.rb
+- lib/openapi_first/request_body_validator.rb
 - lib/openapi_first/request_validation.rb
 - lib/openapi_first/response_validation.rb
 - lib/openapi_first/response_validator.rb
 - lib/openapi_first/router.rb
 - lib/openapi_first/schema_validation.rb
+- lib/openapi_first/string_keyed_hash.rb
 - lib/openapi_first/use_router.rb
-- lib/openapi_first/utils.rb
-- lib/openapi_first/validation_format.rb
+- lib/openapi_first/validation_result.rb
 - lib/openapi_first/version.rb
 - openapi_first.gemspec
 homepage: https://github.com/ahx/openapi_first
@@ -234,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.5
+      version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -244,5 +194,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Implement REST APIs based on OpenApi.
+summary: Implement REST APIs based on OpenApi 3.x
 test_files: []

data/lib/openapi_first/utils.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module OpenapiFirst
-  module Utils
-    class StringKeyedHash
-      def initialize(original)
-        @orig = original
-      end
-
-      def key?(key)
-        @orig.key?(key.to_sym)
-      end
-
-      def [](key)
-        @orig[key.to_sym]
-      end
-    end
-  end
-end

data/lib/openapi_first/validation_format.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module OpenapiFirst
-  module ValidationFormat
-    SIMPLE_TYPES = %w[string integer].freeze
-
-    # 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']}"
-        }
-      elsif error['schema'] == false
-        { title: 'unknown fields are not allowed' }
-      else
-        { title: "is not valid: #{error['data'].inspect}" }
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
-  end
-end