openapi_first 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e1915ef20b0c31bd58a5f0bbba3d91b9be2915c9c0e1598e085d4bea142a06
-  data.tar.gz: 42c62a18aab203b1920adf1367cd9bc500c6e31b1e82fb8b4370ca34cedb372d
+  metadata.gz: d09bae8b5126245d86fceeb81b2d0d46fb1a9e1cb10370527327edb3e370fe59
+  data.tar.gz: 2bd5e71bd8022506be07ab7c60b2740d490fc0f2a0995ded0f6a9c6dc4d165e3
 SHA512:
-  metadata.gz: a7985ff17cce925cb8ed24b47efaea39f4a2bef3a7f029de3edbef38a6ae555e57784d1346cfa0acbfd18b3d70124c4019dd0a5533990dccfcc408667b70b693
-  data.tar.gz: 8e28e55faf6de5246ff87c0943f507c2f93afe4d96f5bbde423feb15607295e7888d25c4add8054ec90103a4305161366f72c8088d0d8f64e053f9ba6902b592
+  metadata.gz: 4d7d449f19fe40c49ea701eb28aca2a140ec41a5efb5be7433a5a60d85376a139a18c772ff34f211fbfb02e557ddddfdfad8ca547a695cb849bd62b69015775d
+  data.tar.gz: 6693234aab12e85893fedfa831ff21c831f00aa4040475a8a6e9fdbc5a2500e094f552ff1efef1c459af4df2eff21ad9f7ac4b6f93b2628f76d5f5169c4ad228

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.17.0)
+    openapi_first (0.19.0)
       deep_merge (>= 1.2.1)
       hanami-router (= 2.0.alpha5)
       hanami-utils (= 2.0.alpha3)
@@ -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.20)
+    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)
+      mustermann (= 1.1.2)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    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)
@@ -70,25 +71,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.27.0)
+    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.16.0, < 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.16.0)
+    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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.17.0)
+    openapi_first (0.19.0)
       deep_merge (>= 1.2.1)
       hanami-router (= 2.0.alpha5)
       hanami-utils (= 2.0.alpha3)
@@ -72,7 +72,7 @@ GEM
     json_refs (0.1.7)
       hana
     json_schema (0.21.0)
-    json_schemer (0.2.20)
+    json_schemer (0.2.21)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -88,12 +88,12 @@ 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.2.0)
       rack
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     roda (3.54.0)
       rack
     ruby2_keywords (0.0.5)
@@ -113,6 +113,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   benchmark-ips

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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.17.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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -217,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