openapi_first 0.16.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3d5709b36ac797521a16ec11af5fe1106faf2aa2a48daf502516cc875fad47
-  data.tar.gz: 311e4b513cb5e655397e38cadfec1eff07ae70d1136c75197f87dba8b058073c
+  metadata.gz: d09bae8b5126245d86fceeb81b2d0d46fb1a9e1cb10370527327edb3e370fe59
+  data.tar.gz: 2bd5e71bd8022506be07ab7c60b2740d490fc0f2a0995ded0f6a9c6dc4d165e3
 SHA512:
-  metadata.gz: 85d40c11308a34a3f1a7c9886cf9826d5a36b6e9d8dc15f0a6bf9ae0d435b88f9e16576b339b0dc3b4e2a3c13bc00710fdbe6dd6bdabf1d8aa644f7f34f6cfd7
-  data.tar.gz: ce475547d199cfabd050e4bdcbf995cecd9a72480b9bfe32e8b84e3287b4be5a95970063542522437362dd65154719c40bb3bc8449b5e4ec82a30c9bfec3f337
+  metadata.gz: 4d7d449f19fe40c49ea701eb28aca2a140ec41a5efb5be7433a5a60d85376a139a18c772ff34f211fbfb02e557ddddfdfad8ca547a695cb849bd62b69015775d
+  data.tar.gz: 6693234aab12e85893fedfa831ff21c831f00aa4040475a8a6e9fdbc5a2500e094f552ff1efef1c459af4df2eff21ad9f7ac4b6f93b2628f76d5f5169c4ad228

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.19.0
+
+- Add `RackResponder`
+
+- BREAKING CHANGE: Handler classes are now instantiated only once without any arguments and the same instance is called on each following call/request.
+
+## 0.18.0
+
+Yanked. No useful changes.
+
+## 0.17.0
+
+- BREAKING CHANGE: Use a Hash instead of named arguments for middleware options for better compatibility
+  Using named arguments is actually not supported in Rack.
+
+## 0.16.1
+
+- Pin hanami-router version, because alpha6 is broken.
+
 ## 0.16.0
 
 - Support status code wildcards like "2XX", "4XX"

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.16.0)
+    openapi_first (0.19.0)
       deep_merge (>= 1.2.1)
-      hanami-router (~> 2.0.alpha5)
-      hanami-utils (~> 2.0.alpha3)
-      json_refs (>= 0.1.7)
+      hanami-router (= 2.0.alpha5)
+      hanami-utils (= 2.0.alpha3)
+      json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
       rack (~> 2.2)
@@ -29,33 +29,34 @@ GEM
     hanami-utils (2.0.0.alpha3)
       concurrent-ruby (~> 1.0)
       dry-transformer (~> 0.1)
-    hansi (0.2.0)
+    hansi (0.2.1)
+    json (2.6.2)
     json_refs (0.1.7)
       hana
-    json_schemer (0.2.19)
+    json_schemer (0.2.21)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     method_source (1.0.0)
     multi_json (1.15.0)
-    mustermann (1.1.1)
+    mustermann (1.1.2)
       ruby2_keywords (~> 0.0.1)
-    mustermann-contrib (1.1.1)
+    mustermann-contrib (1.1.2)
       hansi (~> 0.2.0)
-      mustermann (= 1.1.1)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+      mustermann (= 1.1.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
+    rack (2.2.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -66,29 +67,31 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.25.1)
+    rubocop (1.32.0)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.2)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
     uri_template (0.7.0)
 
 PLATFORMS
   arm64-darwin-21
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2)

data/README.md

@@ -20,7 +20,8 @@ OpenapiFirst consists of these Rack middlewares:
 
 - [`OpenapiFirst::Router`](#OpenapiFirst::Router) – Finds the OpenAPI operation for the current request or returns 404 if no operation was found. This can be customized.
 - [`OpenapiFirst::RequestValidation`](#OpenapiFirst::RequestValidation) – Validates the request against the API description and returns 400 if the request is invalid.
-- [`OpenapiFirst::Responder`](#OpenapiFirst::Responder) calls the [handler](#handlers) found for the operation, sets the correct content-type and serialized the response body to json if needed.
+- [`OpenapiFirst::Responder`](#OpenapiFirst::Responder) calls the [handler](#handlers) found for the operation, sets the correct content-type and serializes the response body to json if needed.
+- [`OpenapiFirst::RackResponder`](#OpenapiFirst::RackResponder) calls the [handler](#handlers) found for the operation as a normal Rack application (`call(env)`) and returns the result as is.
 - [`OpenapiFirst::ResponseValidation`](#OpenapiFirst::ResponseValidation) Validates the response and raises an exception if the response body is invalid.
 
 ## OpenapiFirst::Router
@@ -121,6 +122,24 @@ run OpenapiFirst::Responder
 | `namespace:` | Optional. A class or module where to find the handler method.                                                                                                                                     |
 | `resolver:`  | Optional. An object that responds to `#call(operation)` and returns a [handler](#handlers). By default this is an instance of [DefaultOperationResolver](#OpenapiFirst::DefaultOperationResolver) |
 
+
+## OpenapiFirst::RackResponder
+
+This Rack endpoint maps the HTTP request to a method call based on the [operationId](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) in your API description and calls it as a normal Rack application.
+It does not not serialize objects as JSON or adds a content-type.
+
+```ruby
+run OpenapiFirst::RackResponder
+```
+
+### Options
+
+| Name         | Description                                                                                                                                                                                       |
+| :----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `namespace:` | Optional. A class or module where to find the handler method.                                                                                                                                     |
+| `resolver:`  | Optional. An object that responds to `#call(operation)` and returns a [handler](#handlers). By default this is an instance of [DefaultOperationResolver](#OpenapiFirst::DefaultOperationResolver) |
+
+
 ### OpenapiFirst::DefaultOperationResolver
 
 This is the default way to look up a handler method for an operation. Handlers are always looked up in a namespace module that needs to be specified.
@@ -129,7 +148,7 @@ It works like this:
 
 - An operationId "create_pet" or "createPet" or "create pet" calls `MyApi.create_pet(params, response)`
 - "some_things.create" calls: `MyApi::SomeThings.create(params, response)`
-- "pets#create" calls: `MyApi::Pets::Create.new.call(params, response)` If `MyApi::Pets::Create.new` accepts an argument, it will pass the rack `env`.
+- "pets#create" instantiates the class once (`MyApi::Pets::Create.new) and calls it on every request(`instance.call(params, response)`).
 
 ### Handlers
 

data/benchmarks/Gemfile

@@ -7,8 +7,9 @@ gem 'benchmark-memory'
 gem 'committee'
 gem 'grape'
 gem 'hanami-api'
-gem 'hanami-router', '~> 2.0.0.alpha5'
+gem 'hanami-router'
 gem 'multi_json'
 gem 'openapi_first', path: '../'
+gem 'roda'
 gem 'sinatra'
 gem 'syro'

data/benchmarks/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.15.0)
+    openapi_first (0.19.0)
       deep_merge (>= 1.2.1)
-      hanami-router (~> 2.0.alpha5)
-      hanami-utils (~> 2.0.alpha3)
-      json_refs (>= 0.1.7)
+      hanami-router (= 2.0.alpha5)
+      hanami-utils (= 2.0.alpha3)
+      json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
       rack (~> 2.2)
@@ -13,12 +13,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.2)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    benchmark-ips (2.9.3)
+    benchmark-ips (2.10.0)
     benchmark-memory (0.2.0)
       memory_profiler (~> 1)
     builder (3.2.4)
@@ -26,7 +26,7 @@ GEM
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (>= 0.11.1, < 1.0)
       rack (>= 1.5)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     deep_merge (1.2.2)
     dry-configurable (0.14.0)
       concurrent-ruby (~> 1.0)
@@ -63,16 +63,16 @@ GEM
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
-    hanami-utils (2.0.0.alpha6)
+    hanami-utils (2.0.0.alpha3)
       concurrent-ruby (~> 1.0)
       dry-transformer (~> 0.1)
     hansi (0.2.0)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     json_refs (0.1.7)
       hana
     json_schema (0.21.0)
-    json_schemer (0.2.18)
+    json_schemer (0.2.21)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -88,18 +88,20 @@ GEM
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
     openapi_parser (0.15.0)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rack-accept (0.4.5)
       rack (>= 0.4)
-    rack-protection (2.1.0)
+    rack-protection (2.2.0)
+      rack
+    regexp_parser (2.5.0)
+    roda (3.54.0)
       rack
-    regexp_parser (2.2.1)
     ruby2_keywords (0.0.5)
     seg (1.2.0)
-    sinatra (2.1.0)
+    sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.0)
       tilt (~> 2.0)
     syro (3.2.1)
       rack (>= 1.6.0)
@@ -110,7 +112,8 @@ GEM
     uri_template (0.7.0)
 
 PLATFORMS
-  x86_64-darwin-20
+  arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   benchmark-ips
@@ -118,11 +121,12 @@ DEPENDENCIES
   committee
   grape
   hanami-api
-  hanami-router (~> 2.0.0.alpha5)
+  hanami-router
   multi_json
   openapi_first!
+  roda
   sinatra
   syro
 
 BUNDLED WITH
-   2.2.28
+   2.3.10

data/benchmarks/apps/roda.ru

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'multi_json'
+
+class App < Roda
+  route do |r|
+    r.on 'hello' do
+      r.on :id do
+        r.get do
+          MultiJson.dump({ hello: 'world', id: r.params[:id] })
+        end
+      end
+
+      r.get do
+        MultiJson.dump([{ hello: 'world' }])
+      end
+
+      r.post do
+        response.status = 201
+        MultiJson.dump({ hello: 'world' })
+      end
+    end
+  end
+end
+
+run App.freeze.app

data/lib/openapi_first/default_operation_resolver.rb

@@ -37,9 +37,7 @@ module OpenapiFirst
       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) }
+      klass.new
     end
 
     def find_const(parent, name)

data/lib/openapi_first/operation.rb

@@ -47,9 +47,8 @@ module OpenapiFirst
       end
     end
 
-    def content_type_for(status)
-      content = response_for(status)['content']
-      content.keys[0] if content
+    def content_types_for(status)
+      response_for(status)['content']&.keys
     end
 
     def response_schema_for(status, content_type)

data/lib/openapi_first/rack_responder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'multi_json'
+require_relative 'inbox'
+require_relative 'default_operation_resolver'
+
+module OpenapiFirst
+  class RackResponder
+    def initialize(namespace: nil, resolver: nil)
+      @resolver = resolver || DefaultOperationResolver.new(namespace)
+      @namespace = namespace
+    end
+
+    def call(env)
+      operation = env[OpenapiFirst::OPERATION]
+      find_handler(operation)&.call(env)
+    end
+
+    private
+
+    def find_handler(operation)
+      handler = @resolver.call(operation)
+      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
+end

data/lib/openapi_first/request_validation.rb

@@ -10,9 +10,9 @@ module OpenapiFirst
   class RequestValidation # rubocop:disable Metrics/ClassLength
     prepend RouterRequired
 
-    def initialize(app, raise_error: false)
+    def initialize(app, options = {})
       @app = app
-      @raise = raise_error
+      @raise = options.fetch(:raise_error, false)
     end
 
     def call(env) # rubocop:disable Metrics/AbcSize

data/lib/openapi_first/responder.rb

@@ -18,7 +18,7 @@ module OpenapiFirst
       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[Rack::CONTENT_TYPE] ||= operation.content_types_for(res.status)&.first
       res.finish
     end
 

data/lib/openapi_first/router.rb

@@ -7,15 +7,13 @@ module OpenapiFirst
   class Router
     def initialize(
       app,
-      spec:,
-      raise_error: false,
-      not_found: :halt,
-      parent_app: nil
+      options
     )
       @app = app
-      @parent_app = parent_app
-      @raise = raise_error
-      @not_found = not_found
+      @parent_app = options.fetch(:parent_app, nil)
+      @raise = options.fetch(:raise_error, false)
+      @not_found = options.fetch(:not_found, :halt)
+      spec = options.fetch(:spec)
       @filepath = spec.filepath
       @router = build_router(spec.operations)
     end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -20,7 +20,7 @@ module OpenapiFirst
   HANDLER = 'openapi_first.handler'
 
   def self.env
-    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV['RAILS_ENV']
+    ENV['RACK_ENV'] || ENV['HANAMI_ENV'] || ENV.fetch('RAILS_ENV', nil)
   end
 
   def self.load(spec_path, only: nil)

data/openapi_first.gemspec

@@ -35,9 +35,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
-  spec.add_runtime_dependency 'hanami-router', '~> 2.0.alpha5'
-  spec.add_runtime_dependency 'hanami-utils', '~> 2.0.alpha3'
-  spec.add_runtime_dependency 'json_refs', '>= 0.1.7'
+  spec.add_runtime_dependency 'hanami-router', '2.0.alpha5'
+  spec.add_runtime_dependency 'hanami-utils', '2.0.alpha3'
+  spec.add_runtime_dependency 'json_refs', '~> 0.1', '>= 0.1.7'
   spec.add_runtime_dependency 'json_schemer', '~> 0.2.16'
   spec.add_runtime_dependency 'multi_json', '~> 1.14'
   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.16.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -28,34 +28,37 @@ dependencies:
   name: hanami-router
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.alpha5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.alpha5
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.alpha3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.alpha3
 - !ruby/object:Gem::Dependency
   name: json_refs
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.7
@@ -63,6 +66,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.7
@@ -194,6 +200,7 @@ files:
 - benchmarks/apps/openapi_first.ru
 - benchmarks/apps/openapi_first_with_hanami_api.ru
 - benchmarks/apps/openapi_first_with_response_validation.ru
+- benchmarks/apps/roda.ru
 - benchmarks/apps/sinatra.ru
 - benchmarks/apps/syro.ru
 - benchmarks/benchmarks.rb
@@ -210,6 +217,7 @@ files:
 - lib/openapi_first/definition.rb
 - lib/openapi_first/inbox.rb
 - lib/openapi_first/operation.rb
+- lib/openapi_first/rack_responder.rb
 - lib/openapi_first/request_validation.rb
 - lib/openapi_first/responder.rb
 - lib/openapi_first/response_object.rb