openapi_first 1.0.0.beta1 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2248133fb2e0b761fb314629dcbfa7c9a6b7e0ac03b59887fe158968b17ed827
-  data.tar.gz: b0012d8af3c9dee1fa94334be7890e260f0173946129b53ec8f930f768f8de28
+  metadata.gz: 800354f7ac2847fb16987e6961589aaebb84c161f3b76ea652a00a4cf8762fbe
+  data.tar.gz: f443b72fa8ce1103bfc5a7b30367ce96f84e0dc7ad137722424cab0ac0c13357
 SHA512:
-  metadata.gz: c615c847efcd10cfd145bcc99ede55da2eaa76fe91b9d0ab3fdb159c20b6cc314309f583ba0b784c3e3493a7a534ed1836309807c549bd8c40b226f2f9bf77e9
-  data.tar.gz: 83c476b9b67ce15ad71e052af8360e013659da13fbbd8f86a55bae9d4bbcf08f4ac291187dfccc5786e957c65d2a3124366f007998c675b4a3e29bccaecf332a
+  metadata.gz: e454ee38c95a21915869e5feae0f38f65e0aa9a0a5001b6b752043fa379836164af1bf7eac9bcff192822d66053dda00d6dfa787296cce82bccf346d218f4c6c
+  data.tar.gz: 11a0a0ac1e1bbd350d1edfe1dcae4ccae15bcfe2f1863320f30f554c3ad16934b07891c578225d2d7d128c3cb7dafd4093407c1c153713567db4db3d9c99c938

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Unreleased
+
+## 1.0.0.beta3
+
+- Remove obsolete dependency: deep_merge
+- Remove obsolete dependency: hanami-utils
+
+## 1.0.0.beta2
+- Fixed dependencies. Remove unused code.
+
 ## 1.0.0.beta1
 - Removed: `OpenapiFirst::Responder` and `OpenapiFirst::RackResponder`
 - Removed: `OpenapiFirst.app` and `OpenapiFirst.middleware`

data/Gemfile.lock

@@ -1,14 +1,12 @@
 PATH
   remote: .
   specs:
-    openapi_first (1.0.0.beta1)
-      deep_merge (>= 1.2.1)
+    openapi_first (1.0.0.beta3)
       hanami-router (~> 2.0.0)
-      hanami-utils (~> 2.0.0)
       json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
-      mustermann-contrib (~> 3.0.0)
+      openapi_parameters (~> 0.2)
       rack (>= 2.2, < 4.0)
 
 GEM
@@ -16,14 +14,7 @@ GEM
   specs:
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
-    deep_merge (1.2.2)
     diff-lcs (1.5.0)
-    dry-core (1.0.0)
-      concurrent-ruby (~> 1.0)
-      zeitwerk (~> 2.6)
-    dry-transformer (1.0.1)
-      zeitwerk (~> 2.6)
     ecma-re-validator (0.4.0)
       regexp_parser (~> 2.2)
     hana (1.3.7)
@@ -31,10 +22,6 @@ GEM
       mustermann (~> 3.0)
       mustermann-contrib (~> 3.0)
       rack (~> 2.0)
-    hanami-utils (2.0.3)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
-      dry-transformer (~> 1.0, < 2)
     hansi (0.2.1)
     json (2.6.3)
     json_refs (0.1.7)
@@ -51,7 +38,7 @@ GEM
     mustermann-contrib (3.0.0)
       hansi (~> 0.2.0)
       mustermann (= 3.0.0)
-    openapi_parameters (0.2.0)
+    openapi_parameters (0.2.1)
       rack (>= 2.2)
       zeitwerk (~> 2.6)
     parallel (1.22.1)
@@ -104,7 +91,6 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2)
   openapi_first!
-  openapi_parameters (~> 0.2, <= 2.0.0)
   pry
   rack-test (~> 1)
   rake (~> 13)

data/README.md

@@ -2,28 +2,26 @@
 
 [![Join the chat at https://gitter.im/openapi_first/community](https://badges.gitter.im/openapi_first/community.svg)](https://gitter.im/openapi_first/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-OpenapiFirst helps to implement HTTP APIs based on an [OpenApi](https://www.openapis.org/) API description. The idea is that you create an API description first, then add code that returns data and implements your business logic and be done.
+OpenapiFirst helps to implement HTTP APIs based on an [OpenAPI](https://www.openapis.org/) API description.
 
-Start with writing an OpenAPI file that describes the API, which you are about to implement. Use a [validator](https://github.com/stoplightio/spectral/) to make sure the file is valid.
+It provides these Rack middlewares:
 
-OpenapiFirst consists of these Rack middlewares:
+- [`OpenapiFirst::RequestValidation`](#request-validation) – Validates the request against the API description and returns 400 if the request is invalid.
+- [`OpenapiFirst::ResponseValidation`](#response-validation) Validates the response and raises an exception if the response body is invalid.
+- [`OpenapiFirst::Router`](#openapifirstrouter) – This internal middleware is added automatically when using request/response validation. It adds the OpenAPI operation for the current request to the Rack env.
 
-- [`OpenapiFirst::RequestValidation`](#OpenapiFirst::RequestValidation) – Validates the request against the API description and returns 400 if the request is invalid.
-- [`OpenapiFirst::ResponseValidation`](#OpenapiFirst::ResponseValidation) Validates the response and raises an exception if the response body is invalid.
-- [`OpenapiFirst::Router`](#OpenapiFirst::Router) – This internal middleware is added automatically when using request/response validation. It adds the OpenAPI operation for the current request to the Rack env or returns 404 if no operation was found.
+## Request Validation
 
-## OpenapiFirst::RequestValidation
-
-This middleware returns a 400 status code with a body that describes the error if the request is not valid.
+The `OpenapiFirst::RequestValidation` middleware returns a 400 status code with a body that describes the error if the request is not valid.
 
 ```ruby
 use OpenapiFirst::RequestValidation, spec: 'openapi.yaml'
 ```
 
-This will add these fields to the Rack env:
-- `env[OpenapiFirst::OPERATION]` – The Operation object for the current request. This is an instance of `OpenapiFirst::Operation`.
+It adds these fields to the Rack env:
 - `env[OpenapiFirst::PARAMS]` – The parsed parameters (query, path) for the current request (string keyed)
 - `env[OpenapiFirst::REQUEST_BODY]` – The parsed request body (string keyed)
+- `env[OpenapiFirst::OPERATION]` (Added via Router) – The Operation object for the current request. This is an instance of `OpenapiFirst::Operation`.
 
 ### Options and defaults
 
@@ -54,7 +52,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:
 
 ```ruby
@@ -85,10 +82,9 @@ Request validation fails if request includes a property with `readOnly: true`.
 
 Response validation fails if response body includes a property with `writeOnly: true`.
 
-## OpenapiFirst::ResponseValidation
-
-This middleware is especially useful when testing. It _always_ raises an error if the response is not valid.
+## Response validation
 
+The `OpenapiFirst::ResponseValidation` middleware is especially useful when testing. It _always_ raises an error if the response is not valid.
 
 ```ruby
 use OpenapiFirst::ResponseValidation, spec: 'openapi.yaml' if ENV['RACK_ENV'] == 'test'
@@ -102,7 +98,7 @@ use OpenapiFirst::ResponseValidation, spec: 'openapi.yaml' if ENV['RACK_ENV'] ==
 
 ## OpenapiFirst::Router
 
-This middleware is used automatically, but you can add it to the top of your middleware stack if you want to change configuration.
+This middleware is used automatically, but you can add it to the top of your middleware stack if you want to customize the behavior via options.
 
 ```ruby
 use OpenapiFirst::Router, spec: './openapi/openapi.yaml'

data/benchmarks/Gemfile.lock

@@ -1,14 +1,12 @@
 PATH
   remote: ..
   specs:
-    openapi_first (1.0.0.beta1)
-      deep_merge (>= 1.2.1)
+    openapi_first (1.0.0.beta3)
       hanami-router (~> 2.0.0)
-      hanami-utils (~> 2.0.0)
       json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 0.2.16)
       multi_json (~> 1.14)
-      mustermann-contrib (~> 3.0.0)
+      openapi_parameters (~> 0.2)
       rack (>= 2.2, < 4.0)
 
 GEM
@@ -28,7 +26,6 @@ GEM
       openapi_parser (~> 1.0)
       rack (>= 1.5)
     concurrent-ruby (1.2.2)
-    deep_merge (1.2.2)
     dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
@@ -37,8 +34,6 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
-    dry-transformer (1.0.1)
-      zeitwerk (~> 2.6)
     dry-types (1.7.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
@@ -61,10 +56,6 @@ GEM
       mustermann (~> 3.0)
       mustermann-contrib (~> 3.0)
       rack (~> 2.0)
-    hanami-utils (2.0.3)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
-      dry-transformer (~> 1.0, < 2)
     hansi (0.2.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -86,24 +77,27 @@ GEM
       mustermann (= 3.0.0)
     mustermann-grape (1.0.2)
       mustermann (>= 1.0.0)
-    nio4r (2.5.8)
+    nio4r (2.5.9)
+    openapi_parameters (0.2.1)
+      rack (>= 2.2)
+      zeitwerk (~> 2.6)
     openapi_parser (1.0.0)
-    puma (6.2.0)
+    puma (6.2.2)
       nio4r (~> 2.0)
     rack (2.2.6.4)
     rack-accept (0.4.5)
       rack (>= 0.4)
-    rack-protection (3.0.5)
+    rack-protection (3.0.6)
       rack
     regexp_parser (2.8.0)
-    roda (3.66.0)
+    roda (3.67.0)
       rack
     ruby2_keywords (0.0.5)
     seg (1.2.0)
-    sinatra (3.0.5)
+    sinatra (3.0.6)
       mustermann (~> 3.0)
       rack (~> 2.2, >= 2.2.4)
-      rack-protection (= 3.0.5)
+      rack-protection (= 3.0.6)
       tilt (~> 2.0)
     syro (3.2.1)
       rack (>= 1.6.0)

data/benchmarks/apps/openapi_first_with_hanami_api.ru

@@ -19,7 +19,6 @@ app = Class.new(Hanami::API) do
   end
 end.new
 
-use OpenapiFirst::Router, spec: File.absolute_path('./openapi.yaml', __dir__)
-use OpenapiFirst::RequestValidation
+use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
 
 run app

data/benchmarks/apps/openapi_first_with_plain_rack.ru

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+
+app = Rack::Builder.new do
+  use OpenapiFirst::RequestValidation, spec: File.expand_path('./openapi.yaml', __dir__)
+
+  handlers = {
+    'find_thing' => lambda do |env|
+      params = env[OpenapiFirst::PARAMS]
+      body = MultiJson.dump(hello: 'world', id: params.fetch('id'))
+      [200, { 'Content-Type' => 'application/json' }, [body]]
+    end,
+    'find_things' => lambda do |_env|
+      body = MultiJson.dump(hello: 'world')
+      [200, { 'Content-Type' => 'application/json' }, [body]]
+    end,
+    'create_thing' => lambda do |_env|
+      body = MultiJson.dump(hello: 'world')
+      [201, { 'Content-Type' => 'application/json' }, [body]]
+    end
+  }
+
+  not_found = ->(_env) { [404, {}, []] }
+
+  run lambda do |env|
+    handlers.fetch(env[OpenapiFirst::OPERATION]&.operation_id, not_found).call(env)
+  end
+end
+
+run app

data/benchmarks/apps/openapi_first_with_response_validation.ru

@@ -2,21 +2,24 @@
 
 require 'multi_json'
 require 'openapi_first'
+require 'hanami/api'
 
-namespace = Module.new do
-  def self.find_thing(params, _res)
-    { hello: 'world', id: params.fetch(:id) }
+app = Class.new(Hanami::API) do
+  get '/hello/:id' do
+    json(hello: 'world', id: params.fetch(:id))
   end
 
-  def self.find_things(_params, _res)
-    [{ hello: 'world' }]
+  get '/hello' do
+    json([{ hello: 'world' }])
   end
 
-  def self.create_thing(_params, res)
-    res.status = 201
-    { hello: 'world' }
+  post '/hello' do
+    status 201
+    json(hello: 'world')
   end
-end
+end.new
 
-oas_path = File.absolute_path('./openapi.yaml', __dir__)
-run OpenapiFirst.app(oas_path, namespace: namespace, response_validation: true)
+use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
+use OpenapiFirst::ResponseValidation
+
+run app

data/benchmarks/apps/openapi_first_with_sinatra.ru

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'openapi_first'
+require 'sinatra'
+
+class SinatraWithOpenapiFirstExample < Sinatra::Base
+  set :environment, :production
+
+  get '/hello/:id' do
+    content_type :json
+    MultiJson.dump(hello: 'world', id: params.fetch('id'))
+  end
+
+  get '/hello' do
+    content_type :json
+    MultiJson.dump([{ hello: 'world' }])
+  end
+
+  post '/hello' do
+    content_type :json
+    status 201
+    MultiJson.dump(hello: 'world')
+  end
+end
+
+use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
+
+run SinatraWithOpenapiFirstExample

data/lib/openapi_first/utils.rb

@@ -1,23 +1,7 @@
 # frozen_string_literal: true
 
-require 'hanami/utils/string'
-require 'hanami/utils/hash'
-require 'deep_merge/core'
-
 module OpenapiFirst
   module Utils
-    def self.deep_merge!(dest, source)
-      DeepMerge.deep_merge!(source, dest)
-    end
-
-    def self.underscore(string)
-      Hanami::Utils::String.underscore(string)
-    end
-
-    def self.classify(string)
-      Hanami::Utils::String.classify(string)
-    end
-
     class StringKeyedHash
       def initialize(original)
         @orig = original

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.0.0.beta3'
 end

data/lib/openapi_first.rb

@@ -28,22 +28,4 @@ module OpenapiFirst
     resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
     Definition.new(resolved, spec_path)
   end
-
-  def self.app(
-    spec,
-    namespace:,
-    router_raise_error: false,
-    request_validation_raise_error: false,
-    response_validation: false
-  )
-    spec = OpenapiFirst.load(spec) unless spec.is_a?(Definition)
-    App.new(
-      nil,
-      spec,
-      namespace: namespace,
-      router_raise_error: router_raise_error,
-      request_validation_raise_error: request_validation_raise_error,
-      response_validation: response_validation
-    )
-  end
 end

data/openapi_first.gemspec

@@ -34,17 +34,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.0.5'
 
-  spec.add_runtime_dependency 'deep_merge', '>= 1.2.1'
   spec.add_runtime_dependency 'hanami-router', '~> 2.0.0'
-  spec.add_runtime_dependency 'hanami-utils', '~> 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 'multi_json', '~> 1.14'
-  spec.add_runtime_dependency 'mustermann-contrib', '~> 3.0.0'
+  spec.add_runtime_dependency 'openapi_parameters', '~> 0.2'
   spec.add_runtime_dependency 'rack', '>= 2.2', '< 4.0'
 
   spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'openapi_parameters', '~> 0.2', '<= 2.0.0'
   spec.add_development_dependency 'rack-test', '~> 1'
   spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: deep_merge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: hanami-router
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: hanami-utils
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json_refs
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: mustermann-contrib
+  name: openapi_parameters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -148,26 +120,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: openapi_parameters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -231,16 +183,17 @@ files:
 - benchmarks/Gemfile
 - benchmarks/Gemfile.lock
 - benchmarks/README.md
-- benchmarks/apps/committee.ru
+- benchmarks/apps/committee_with_hanami_api.ru
 - benchmarks/apps/committee_with_response_validation.ru
 - benchmarks/apps/committee_with_sinatra.ru
 - benchmarks/apps/grape.ru
 - benchmarks/apps/hanami_api.ru
 - benchmarks/apps/hanami_router.ru
 - benchmarks/apps/openapi.yaml
-- benchmarks/apps/openapi_first.ru
 - benchmarks/apps/openapi_first_with_hanami_api.ru
+- benchmarks/apps/openapi_first_with_plain_rack.ru
 - benchmarks/apps/openapi_first_with_response_validation.ru
+- benchmarks/apps/openapi_first_with_sinatra.ru
 - benchmarks/apps/roda.ru
 - benchmarks/apps/sinatra.ru
 - benchmarks/apps/syro.ru

data/benchmarks/apps/openapi_first.ru

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'openapi_first'
-
-namespace = Module.new do
-  def self.find_thing(params, _res)
-    { hello: 'world', id: params.fetch('id') }
-  end
-
-  def self.find_things(_params, _res)
-    [{ hello: 'world' }]
-  end
-
-  def self.create_thing(_params, res)
-    res.status = 201
-    { hello: 'world' }
-  end
-end
-
-oas_path = File.absolute_path('./openapi.yaml', __dir__)
-run OpenapiFirst.app(oas_path, namespace: namespace)