openapi_first 1.0.0.beta5 → 1.0.0.beta6

data/benchmarks/README.md

@@ -1,29 +0,0 @@
-# How to run these bechmarks
-
-## Setup
-
-```bash
-cd benchmarks
-bundle install
-```
-
-## Run Ruby benchmarks
-
-This compares ips and memory usage for all apps defined in /apps
-
-```bash
-bundle exec ruby benchmarks.rb
-```
-
-## Run benchmark using [wrk](https://github.com/wg/wrk)
-
-1. Start the example app
-Example: openapi_first
-```bash
-bundle exec puma apps/openapi_first_with_response_validation.ru
-```
-
-2. Run wrk
-```bash
-./benchmark-wrk.sh
-```

data/benchmarks/apps/committee_with_hanami_api.ru

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'committee'
-require 'hanami/api'
-
-app = Class.new(Hanami::API) do
-  get '/hello/:id' do
-    json(hello: 'world', id: params.fetch(:id))
-  end
-
-  get '/hello' do
-    json([{ hello: 'world' }])
-  end
-
-  post '/hello' do
-    status 201
-    json(hello: 'world')
-  end
-end.new
-
-use Committee::Middleware::RequestValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__),
-    parse_response_by_content_type: true
-
-run app

data/benchmarks/apps/committee_with_response_validation.ru

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'committee'
-require 'hanami/api'
-
-app = Class.new(Hanami::API) do
-  get '/hello/:id' do
-    json(hello: 'world', id: params.fetch(:id))
-  end
-
-  get '/hello' do
-    json([{ hello: 'world' }])
-  end
-
-  post '/hello' do
-    status 201
-    json(hello: 'world')
-  end
-end.new
-
-use Committee::Middleware::RequestValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__),
-    parse_response_by_content_type: true
-
-use Committee::Middleware::ResponseValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__)
-
-run app

data/benchmarks/apps/committee_with_sinatra.ru

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'committee'
-require 'sinatra'
-
-class SinatraWithCommiteeExample < 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 Committee::Middleware::RequestValidation,
-    schema_path: File.absolute_path('./openapi.yaml', __dir__),
-    parse_response_by_content_type: true
-
-run SinatraWithCommiteeExample

data/benchmarks/apps/grape.ru

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape'
-
-class GrapeExample < Grape::API
-  format :json
-
-  get :hello do
-    [{ hello: 'world' }]
-  end
-
-  post :hello do
-    { hello: 'world' }
-  end
-
-  get 'hello/:id' do
-    { hello: 'world', id: params[:id] }
-  end
-end
-
-run GrapeExample

data/benchmarks/apps/hanami_api.ru

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'hanami/api'
-
-app = Class.new(Hanami::API) do
-  get '/hello/:id' do
-    json(hello: 'world', id: params.fetch(:id))
-  end
-
-  get '/hello' do
-    json([{ hello: 'world' }])
-  end
-
-  post '/hello' do
-    status 201
-    json(hello: 'world')
-  end
-end.new
-
-run app

data/benchmarks/apps/hanami_router.ru

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'hanami/router'
-require 'multi_json'
-
-app = Hanami::Router.new do
-  get '/hello', to: ->(_env) { [200, {}, [MultiJson.dump([{ hello: 'world' }])]] }
-  get '/hello/:id', to: lambda { |env|
-    [200, {}, [MultiJson.dump(hello: 'world', id: env['router.params'][:id])]]
-  }
-  post '/hello', to: ->(_env) { [201, {}, [MultiJson.dump(hello: 'world')]] }
-end
-
-run app

data/benchmarks/apps/openapi.yaml

@@ -1,268 +0,0 @@
-openapi: 3.0.0
-info:
-  title: "API"
-  version: "1.0.0"
-  contact:
-    name: Contact Name
-    email: contact@example.com
-    url: https://example.com/
-tags:
-  - name: Metadata
-    description: Metadata related requests
-paths:
-  /hello/{id}:
-    parameters:
-    - name: id
-      description: ID of the thing to get
-      in: path
-      required: true
-      schema:
-        type: string
-    get:
-      operationId: find_thing
-      description: Get one thing
-      tags: ["Metadata"]
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                type: object
-                required: [hello, id]
-                properties:
-                  hello:
-                    type: string
-                  id:
-                    type: string
-  /hello:
-    get:
-      operationId: find_things
-      description: Get multiple things
-      tags: ["Metadata"]
-      parameters:
-      - name: filter
-        description: filter things
-        in: query
-        required: false
-        schema:
-          type: object
-          required: [id]
-          properties:
-            id:
-              type: string
-              description: Comma separated list of thing-IDs
-
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  type: object
-                  required: [hello]
-                  properties:
-                    hello:
-                      type: string
-        default:
-          description: Error response
-
-    post:
-      operationId: create_thing
-      description: Create a thing
-      tags: ["Metadata"]
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              required:
-                - say
-              properties:
-                say:
-                  type: string
-      responses:
-        "201":
-          description: OK
-          content:
-            application/json:
-              schema:
-                type: object
-                required: [hello]
-                properties:
-                  hello:
-                    type: string
-  /pets:
-    get:
-      description: |
-        Returns all pets from the system that the user has access to
-        Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
-
-        Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
-      operationId: find_pets
-      parameters:
-        - name: tags
-          in: query
-          description: tags to filter by
-          required: false
-          style: form
-          schema:
-            type: array
-            items:
-              type: string
-        - name: limit
-          in: query
-          description: maximum number of results to return
-          required: false
-          schema:
-            type: integer
-            format: int32
-      responses:
-        '200':
-          description: pet response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/Pet'
-        default:
-          description: unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-    post:
-      description: Creates a new pet in the store.  Duplicates are allowed
-      operationId: create_pet
-      requestBody:
-        description: Pet to add to the store
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/NewPet'
-      responses:
-        '200':
-          description: pet response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Pet'
-        default:
-          description: unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-  /pets/{id}:
-    parameters:
-      - name: id
-        in: path
-        description: ID of pet to fetch
-        required: true
-        schema:
-          type: integer
-          format: int64
-    get:
-      description: Returns a user based on a single ID, if the user does not have access to the pet
-      operationId: find_pet
-      responses:
-        '200':
-          description: pet response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Pet'
-        default:
-          description: unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-    delete:
-      description: deletes a single pet based on the ID supplied
-      operationId: delete_pet
-      parameters:
-        - name: id
-          in: path
-          description: ID of pet to delete
-          required: true
-          schema:
-            type: integer
-            format: int64
-      responses:
-        '204':
-          description: pet deleted
-        default:
-          description: unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-    patch:
-      description: Updates a pet
-      operationId: update_pet
-      requestBody:
-        description: Changes
-        required: false
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/NewPet'
-      responses:
-        '200':
-          description: pet response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Pet'
-        default:
-          description: unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-components:
-  schemas:
-    Pet:
-      allOf:
-        - $ref: '#/components/schemas/NewPet'
-        - required:
-          - id
-          properties:
-            id:
-              type: integer
-              format: int64
-
-    NewPet:
-      required:
-        - type
-        - attributes
-      properties:
-        type:
-          type: string
-          enum:
-            - pet
-            - plant
-        attributes:
-          additionalProperties: false
-          type: object
-          required: [name]
-          properties:
-            name:
-              type: string
-
-    Error:
-      required:
-        - code
-        - message
-      properties:
-        code:
-          type: integer
-          format: int32
-        message:
-          type: string

data/benchmarks/apps/openapi_first_with_hanami_api.ru

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'openapi_first'
-require 'hanami/api'
-
-app = Class.new(Hanami::API) do
-  get '/hello/:id' do
-    json(hello: 'world', id: params.fetch(:id))
-  end
-
-  get '/hello' do
-    json([{ hello: 'world' }])
-  end
-
-  post '/hello' do
-    status 201
-    json(hello: 'world')
-  end
-end.new
-
-use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
-
-run app

data/benchmarks/apps/openapi_first_with_plain_rack.ru

@@ -1,32 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'openapi_first'
-require 'hanami/api'
-
-app = Class.new(Hanami::API) do
-  get '/hello/:id' do
-    json(hello: 'world', id: params.fetch(:id))
-  end
-
-  get '/hello' do
-    json([{ hello: 'world' }])
-  end
-
-  post '/hello' do
-    status 201
-    json(hello: 'world')
-  end
-end.new
-
-use OpenapiFirst::RequestValidation, spec: File.absolute_path('./openapi.yaml', __dir__)
-use OpenapiFirst::ResponseValidation
-
-run app

data/benchmarks/apps/openapi_first_with_sinatra.ru

@@ -1,29 +0,0 @@
-# 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/benchmarks/apps/roda.ru

@@ -1,27 +0,0 @@
-# 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/benchmarks/apps/sinatra.ru

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'multi_json'
-require 'sinatra/base'
-
-class SinatraExample < 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
-
-run SinatraExample

data/benchmarks/apps/syro.ru

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'syro'
-require 'multi_json'
-
-app = Syro.new do
-  on 'hello' do
-    on :id do
-      get do
-        res.json({ hello: 'world', id: inbox[:id] })
-      end
-    end
-
-    get do
-      res.json([{ hello: 'world' }])
-    end
-
-    post do
-      res.status = 201
-      res.json({ hello: 'world' })
-    end
-  end
-end
-
-run app

data/benchmarks/benchmark-wrk.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-wrk -t12 -c400 -d10s --latency -s post.lua http://localhost:9292/hello

data/benchmarks/benchmarks.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-require 'benchmark/memory'
-require 'rack'
-require 'json'
-ENV['RACK_ENV'] = 'production'
-
-examples = [
-  [Rack::MockRequest.env_for('/hello'), 200],
-  [Rack::MockRequest.env_for('/unknown'), 404],
-  [
-    Rack::MockRequest.env_for('/hello', method: 'POST', input: JSON.dump({ say: 'hi!' }),
-                                        'CONTENT_TYPE' => 'application/json'), 201
-  ],
-  [Rack::MockRequest.env_for('/hello/1'), 200],
-  [Rack::MockRequest.env_for('/hello/123'), 200],
-  [Rack::MockRequest.env_for('/hello?filter[id]=1,2'), 200]
-]
-
-glob = ARGV[0] || './apps/*.ru'
-apps = Dir[glob].each_with_object({}) do |config, hash|
-  hash[config] = Rack::Builder.parse_file(config).first
-end
-apps.freeze
-
-bench = lambda do |app|
-  examples.each do |example|
-    env, expected_status = example
-    100.times { app.call(env) }
-    response = app.call(env)
-    raise "expected status #{expected_status}, but was #{response[0]}" unless response[0] == expected_status
-  end
-end
-
-Benchmark.ips do |x|
-  apps.each do |config, app|
-    x.report(config) { bench.call(app) }
-  end
-  x.compare!
-end
-
-Benchmark.memory do |x|
-  apps.each do |config, app|
-    x.report(config) { bench.call(app) }
-  end
-  x.compare!
-end