openapi_first 1.0.0.beta4 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c02c053192b6b39cb8f05acd35f7a257ee98b449c49f8ceeec4ac6e542f09e15
-  data.tar.gz: c36d3598b263ebd3d1a9bd23e6aa0b66256890f68e2f70fe245ca932d2f004f0
+  metadata.gz: 8173c11075add6c2c7a1a6cf024ea86ba448b185574e346fe288afa3aafcf677
+  data.tar.gz: f3dcd95b9c06adcfcada5430a8412a3ee6ea37c1c117e79546436ade496c5778
 SHA512:
-  metadata.gz: e70192d7c2cb58734b8ebb6ccf53b2f243a98e78adbea271a3b0df1468f400d60080ead1ea68c07dd33bd9985d67de02ec4e0200e3ca0d49272a893c97611ffb
-  data.tar.gz: c59e62cd24dd767330f7e9ce6ad96a9c13005a4498c39f3ccf10bc801b49b6bddccf3ac62f858ae3ecf56fa4c695b4ad010fea7292171f98b640dec968ea357d
+  metadata.gz: d29578cdcc1573ff8903a7060a85e2b334b1ff908d4b3b7973e64b336ba414bfdf7b6fb762aff48cf0feaf78f5a29403d2d063b117fb1278bed628195363dd74
+  data.tar.gz: 0a6409930941ea9a1f4b734f49752ec18f8e9779ce6f5279e2db65022066500d8b7f9067af23625e780e20cf0d62f542c0a4b8388fea6f7cc37f63cd372baaf5

data/.github/workflows/ruby.yml

@@ -9,4 +9,5 @@ jobs:
       with:
         ruby-version: '3.1'
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - run: bundle exec rake
+    - run: BUNDLE_GEMFILE=Gemfile bundle exec rake
+    - run: BUNDLE_GEMFILE=Gemfile.rack2 bundle lock --add-platform x86_64-linux && bundle exec rake

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## 1.0.0.beta6
+- Fix: Make response header validation work with rack 3
+- Refactor router
+  - Remove dependency hanami-router 
+  - PathItem and Operation for a request can be found by calling methods on the Definitnion
+- Fixed https://github.com/ahx/openapi_first/issues/155
+- Breaking / Regression: A paths like /pets/{from}-{to} if there is a path "/pets/{id}"
+
+## 1.0.0.beta5
+
+- Added: `OpenapiFirst::Config.default_options=` to set default options globally
+- Added: You can define custom error responses by subclassing `OpenapiFirst::ErrorResponse` and register it via `OpenapiFirst::Plugins.register_error_response(name, MyCustomErrorResponse)`
+
 ## 1.0.0.beta4
 
 - Update json_schemer to version 2.0

data/Gemfile

@@ -2,9 +2,10 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in openapi_first.gemspec
 gemspec
 
+gem 'rack', '>= 3.0.0'
+
 group :test, :development do
   gem 'bundler'
   gem 'rack-test'

data/Gemfile.lock

@@ -1,25 +1,20 @@
 PATH
   remote: .
   specs:
-    openapi_first (1.0.0.beta4)
-      hanami-router (~> 2.0.0)
+    openapi_first (1.0.0.beta6)
       json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 2.0.0)
-      multi_json (~> 1.14)
-      openapi_parameters (~> 0.2.2)
+      multi_json (~> 1.15)
+      mustermann-contrib (~> 3.0.0)
+      openapi_parameters (>= 0.3.2, < 2.0)
       rack (>= 2.2, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.1.1)
     diff-lcs (1.5.0)
     hana (1.3.7)
-    hanami-router (2.0.2)
-      mustermann (~> 3.0)
-      mustermann-contrib (~> 3.0)
-      rack (~> 2.0)
     hansi (0.2.1)
     json (2.6.3)
     json_refs (0.1.8)
@@ -35,20 +30,20 @@ GEM
     mustermann-contrib (3.0.0)
       hansi (~> 0.2.0)
       mustermann (= 3.0.0)
-    openapi_parameters (0.2.2)
+    openapi_parameters (0.3.2)
       rack (>= 2.2)
       zeitwerk (~> 2.6)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
-    racc (1.7.1)
-    rack (2.2.8)
+    racc (1.7.3)
+    rack (3.0.8)
     rack-test (2.1.0)
       rack (>= 1.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -63,19 +58,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.56.3)
-      base64 (~> 0.1.1)
+    rubocop (1.57.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
@@ -83,9 +77,9 @@ GEM
       unf (~> 0.1.4)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
-    zeitwerk (2.6.11)
+    unf_ext (0.0.9)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21
@@ -94,6 +88,7 @@ PLATFORMS
 DEPENDENCIES
   bundler
   openapi_first!
+  rack (>= 3.0.0)
   rack-test
   rake
   rspec

data/Gemfile.rack2

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rack', '< 3.0.0'
+
+group :test, :development do
+  gem 'bundler'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop'
+end

data/README.md

@@ -28,11 +28,11 @@ It adds these fields to the Rack env:
 
 ### Options and defaults
 
-| Name           | Possible values | Description                                                                                        | Default                            |
-| :------------- | --------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- |
-| `spec:`        |                 | The path to the spec file or spec loaded via `OpenapiFirst.load`                                   |
-| `raise_error:` | `false`, `true` | If set to true the middleware raises `OpenapiFirst::RequestInvalidError` instead of returning 4xx. | `false` (don't raise an exception) |
-| `error_response:`| `:default`, Your implementation of `ErrorResponse` | :default
+| Name              | Possible values                                                 | Description                                                                                        | Default                            |
+| :---------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| `spec:`           |                                                                 | The path to the spec file or spec loaded via `OpenapiFirst.load`                                   |
+| `raise_error:`    | `false`, `true`                                                 | If set to true the middleware raises `OpenapiFirst::RequestInvalidError` instead of returning 4xx. | `false` (don't raise an exception) |
+| `error_response:` | `:default`, `:json_api`, Your implementation of `ErrorResponse` | :default                                                                                           |
 
 The error responses conform with [JSON:API](https://jsonapi.org).
 
@@ -40,7 +40,7 @@ Here's an example response body for a missing query parameter "search":
 
 ```json
 http-status: 400
-content-type: "application/vnd.api+json"
+content-type: "application/json"
 
 {
   "errors": [
@@ -54,7 +54,6 @@ content-type: "application/vnd.api+json"
 }
 ```
 
-
 ### Parameters
 
 The `RequestValidation` middleware adds `env[OpenapiFirst::PARAMS]` (or `env['openapi.params']` ) with the converted query and path parameters. This only includes the parameters that are defined in the API description. It supports every [`style` and `explode` value as described](https://spec.openapis.org/oas/latest.html#style-examples) in the OpenAPI 3.0 and 3.1 specs. So you can do things these:
@@ -120,6 +119,17 @@ This middleware adds `env['openapi.operation']` which holds an instance of `Open
 | `raise_error:` | `false`, `true`      | If set to true the middleware raises `OpenapiFirst::NotFoundError` when a path or method was not found in the API description. This is useful during testing to spot an incomplete API description.                                                             | `false` (don't raise an exception) |
 | `not_found:`   | `:continue`, `:halt` | If set to `:continue` the middleware will not return 404 (405, 415), but just pass handling the request to the next middleware or application in the Rack stack. If combined with `raise_error: true` `raise_error` gets preference and an exception is raised. | `:halt` (return 4xx response)      |
 
+## Global configuration
+
+You can configure default options gobally via `OpenapiFirst::Config`:
+
+```ruby
+OpenapiFirst::Config.default_options = {
+  error_response: :json_api,
+  request_validation_raise_error: true
+}
+```
+
 ## Alternatives
 
 This gem is inspired by [committee](https://github.com/interagent/committee) (Ruby) and [connexion](https://github.com/zalando/connexion) (Python).

data/lib/openapi_first/body_parser.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+
+module OpenapiFirst
+  class BodyParser
+    def parse_body(env)
+      request = Rack::Request.new(env)
+      body = read_body(request)
+      return if body.empty?
+
+      return MultiJson.load(body) if request.media_type =~ (/json/i) && (request.media_type =~ /json/i)
+      return request.POST if request.form_data?
+
+      body
+    rescue MultiJson::ParseError
+      raise BodyParsingError, 'Failed to parse body as application/json'
+    end
+
+    private
+
+    def read_body(request)
+      body = request.body.read
+      request.body.rewind
+      body
+    end
+  end
+end

data/lib/openapi_first/config.rb

@@ -2,11 +2,12 @@
 
 module OpenapiFirst
   class Config
-    def initialize(error_response: :default)
-      @error_response = error_response
+    def initialize(error_response: :default, request_validation_raise_error: false)
+      @error_response = Plugins.find_error_response(error_response)
+      @request_validation_raise_error = request_validation_raise_error
     end
 
-    attr_reader :error_response
+    attr_reader :error_response, :request_validation_raise_error
 
     def self.default_options
       @default_options ||= new

data/lib/openapi_first/definition/cookie_parameters.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'openapi_parameters'
+require_relative 'parameters'
+
+module OpenapiFirst
+  class CookieParameters < Parameters
+    def unpack(env)
+      OpenapiParameters::Cookie.new(@parameter_definitions).unpack(env['HTTP_COOKIE'])
+    end
+  end
+end

data/lib/openapi_first/definition/has_content.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'schema'
+
+module OpenapiFirst
+  module HasContent
+    def schema_for(content_type)
+      return unless content&.any?
+
+      content_schemas&.fetch(content_type) do
+        type = content_type.split(';')[0]
+        content_schemas[type] || content_schemas["#{type.split('/')[0]}/*"] || content_schemas['*/*']
+      end
+    end
+
+    private
+
+    def content
+      raise NotImplementedError
+    end
+
+    def schema_write?
+      raise NotImplementedError
+    end
+
+    def content_schemas
+      @content_schemas ||= content&.each_with_object({}) do |kv, result|
+        type, media_type = kv
+        schema_object = media_type['schema']
+        next unless schema_object
+
+        result[type] = Schema.new(schema_object, write: schema_write?,
+                                                 openapi_version: @operation.openapi_version)
+      end
+    end
+  end
+end

data/lib/openapi_first/definition/header_parameters.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'openapi_parameters'
+require_relative 'parameters'
+
+module OpenapiFirst
+  class HeaderParameters < Parameters
+    def unpack(env)
+      OpenapiParameters::Header.new(@parameter_definitions).unpack_env(env)
+    end
+  end
+end

data/lib/openapi_first/definition/operation.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'set'
+require_relative 'request_body'
+require_relative 'response'
+require_relative 'query_parameters'
+require_relative 'header_parameters'
+require_relative 'path_parameters'
+require_relative 'cookie_parameters'
+require_relative 'schema'
+
+module OpenapiFirst
+  class Operation
+    extend Forwardable
+    def_delegators :operation_object,
+                   :[],
+                   :dig
+
+    WRITE_METHODS = Set.new(%w[post put patch delete]).freeze
+    private_constant :WRITE_METHODS
+
+    attr_reader :path, :method, :openapi_version
+
+    def initialize(path, request_method, path_item_object, openapi_version:)
+      @path = path
+      @method = request_method
+      @path_item_object = path_item_object
+      @openapi_version = openapi_version
+      @operation_object = @path_item_object[request_method]
+    end
+
+    def operation_id
+      operation_object['operationId']
+    end
+
+    def read?
+      !write?
+    end
+
+    def write?
+      WRITE_METHODS.include?(method)
+    end
+
+    def request_body
+      @request_body ||= RequestBody.new(operation_object['requestBody'], self) if operation_object['requestBody']
+    end
+
+    def response_for(status)
+      response_object = operation_object.dig('responses', status.to_s) ||
+                        operation_object.dig('responses', "#{status / 100}XX") ||
+                        operation_object.dig('responses', "#{status / 100}xx") ||
+                        operation_object.dig('responses', 'default')
+      Response.new(status, response_object, self) if response_object
+    end
+
+    def name
+      @name ||= "#{method.upcase} #{path} (#{operation_id})"
+    end
+
+    def query_parameters
+      @query_parameters ||= build_parameters(all_parameters.filter { |p| p['in'] == 'query' }, QueryParameters)
+    end
+
+    def path_parameters
+      @path_parameters ||= build_parameters(all_parameters.filter { |p| p['in'] == 'path' }, PathParameters)
+    end
+
+    IGNORED_HEADERS = Set['Content-Type', 'Accept', 'Authorization'].freeze
+    private_constant :IGNORED_HEADERS
+
+    def header_parameters
+      @header_parameters ||= build_parameters(find_header_parameters, HeaderParameters)
+    end
+
+    def cookie_parameters
+      @cookie_parameters ||= build_parameters(all_parameters.filter { |p| p['in'] == 'cookie' }, CookieParameters)
+    end
+
+    def all_parameters
+      @all_parameters ||= begin
+        parameters = @path_item_object['parameters']&.dup || []
+        parameters_on_operation = operation_object['parameters']
+        parameters.concat(parameters_on_operation) if parameters_on_operation
+        parameters
+      end
+    end
+
+    private
+
+    attr_reader :operation_object
+
+    def build_parameters(parameters, klass)
+      klass.new(parameters, openapi_version:) if parameters.any?
+    end
+
+    def find_header_parameters
+      all_parameters.filter do |p|
+        p['in'] == 'header' && !IGNORED_HEADERS.include?(p['name'])
+      end
+    end
+  end
+end

data/lib/openapi_first/definition/parameters.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'schema'
+
+module OpenapiFirst
+  class Parameters
+    extend Forwardable
+
+    def initialize(parameter_definitions, openapi_version:)
+      @parameter_definitions = parameter_definitions
+      @openapi_version = openapi_version
+    end
+
+    def_delegators :parameters, :map
+
+    def empty?
+      @parameter_definitions.empty?
+    end
+
+    def schema
+      @schema ||= build_schema
+    end
+
+    def parameters
+      @parameter_definitions.map do |parameter_object|
+        OpenapiParameters::Parameter.new(parameter_object)
+      end
+    end
+
+    private
+
+    def build_schema
+      init_schema = {
+        'type' => 'object',
+        'properties' => {},
+        'required' => []
+      }
+      schema = @parameter_definitions.each_with_object(init_schema) do |parameter_def, result|
+        parameter = OpenapiParameters::Parameter.new(parameter_def)
+        result['properties'][parameter.name] = parameter.schema if parameter.schema
+        result['required'] << parameter.name if parameter.required?
+      end
+      Schema.new(schema, openapi_version: @openapi_version)
+    end
+  end
+end

data/lib/openapi_first/definition/path_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'operation'
+
+module OpenapiFirst
+  class PathItem
+    def initialize(path, path_item_object, openapi_version:)
+      @path = path
+      @path_item_object = path_item_object
+      @openapi_version = openapi_version
+    end
+
+    attr_reader :path
+
+    def find_operation(request_method)
+      return unless @path_item_object[request_method]
+
+      Operation.new(
+        @path, request_method, @path_item_object, openapi_version: @openapi_version
+      )
+    end
+  end
+end

data/lib/openapi_first/definition/path_parameters.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'openapi_parameters'
+require_relative 'parameters'
+require_relative '../router'
+
+module OpenapiFirst
+  class PathParameters < Parameters
+    def unpack(env)
+      OpenapiParameters::Path.new(@parameter_definitions).unpack(env[Router::RAW_PATH_PARAMS])
+    end
+  end
+end

data/lib/openapi_first/definition/query_parameters.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'openapi_parameters'
+require_relative 'parameters'
+
+module OpenapiFirst
+  class QueryParameters < Parameters
+    def unpack(env)
+      OpenapiParameters::Query.new(@parameter_definitions).unpack(env['QUERY_STRING'])
+    end
+  end
+end

data/lib/openapi_first/definition/request_body.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'has_content'
+
+module OpenapiFirst
+  class RequestBody
+    include HasContent
+
+    def initialize(request_body_object, operation)
+      @object = request_body_object
+      @operation = operation
+    end
+
+    def description
+      @object['description']
+    end
+
+    def required?
+      !!@object['required']
+    end
+
+    private
+
+    def schema_write?
+      @operation.write?
+    end
+
+    def content
+      @object['content']
+    end
+  end
+end

data/lib/openapi_first/definition/response.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'has_content'
+
+module OpenapiFirst
+  class Response
+    include HasContent
+
+    def initialize(status, response_object, operation)
+      @status = status&.to_i
+      @object = response_object
+      @operation = operation
+    end
+
+    attr_reader :status
+
+    def description
+      @object['description']
+    end
+
+    def headers
+      @object['headers']
+    end
+
+    def content?
+      !!content&.any?
+    end
+
+    private
+
+    def schema_write? = false
+
+    def content
+      @object['content']
+    end
+  end
+end

data/lib/openapi_first/definition/schema/result.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  class Schema
+    Result = Struct.new(:output, :schema, :data, keyword_init: true) do
+      def valid? = output['valid']
+      def error? = !output['valid']
+
+      # Returns a message that is used in exception messages.
+      def message
+        return if valid?
+
+        (output['errors']&.map { |e| e['error'] }&.join('. ') || output['error'])
+      end
+    end
+  end
+end

data/lib/openapi_first/{schema_validation.rb → definition/schema.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require 'json_schemer'
-require_relative 'validation_result'
+require_relative 'schema/result'
 
 module OpenapiFirst
-  class SchemaValidation
-    attr_reader :raw_schema
+  class Schema
+    attr_reader :schema
 
     SCHEMAS = {
       '3.1' => 'https://spec.openapis.org/oas/3.1/dialect/base',
@@ -13,7 +13,7 @@ module OpenapiFirst
     }.freeze
 
     def initialize(schema, openapi_version:, write: true)
-      @raw_schema = schema
+      @schema = schema
       @schemer = JSONSchemer.schema(
         schema,
         access_mode: write ? 'write' : 'read',
@@ -25,9 +25,9 @@ module OpenapiFirst
     end
 
     def validate(data)
-      ValidationResult.new(
+      Result.new(
         output: @schemer.validate(data),
-        schema: raw_schema,
+        schema:,
         data:
       )
     end