openapi_first 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6888d00f37a7dce1f2b22ad9da04f4ecb69236ea18221173fc77dac1b5edba6c
-  data.tar.gz: 8eca9351e46942b1acf6fa47d3394dbfa9a85c4f0dc3dc1f77c075d2818bc3ed
+  metadata.gz: 9c39942d9c5860a92b211d51852ad5633dd573f2a244d85631d2c2c4990e607c
+  data.tar.gz: 8bbfd7a2cdf632338117d689dd770561d5f4a903223800c9a6829e556ab1c26a
 SHA512:
-  metadata.gz: 967dd87e43808f328a5ab72e99cf04c4b37eb756b2a4ef06925e3e419b038583e014cf3c11074168f02fd07b16db4ba266f743a884a608f37e6c1bfeed0ce911
-  data.tar.gz: 9c2a62d290c09417c0c75eaec88427b847f43d787e3cb548dcef543749a98f7252d5915de48fe64c9eb34eca8f579590f1d94bec9455c1ba08932b1a5de5c7f4
+  metadata.gz: 58ab052d0d464da3f37224c943a9da8c990eb6f75b13306b223d1a6d4e36f55588df3e5f2106ca2659a44a048604cd011da50d6b11417efb8b45f05762ab23e4
+  data.tar.gz: 53ba1d5a794cd1561e812c37cc426e6d282bbfd6c7bb5cce547be7eda1d90c342d4b6cdfc490e1b0765b43ba7fba126abea8ae413c0744c444c2c2aae725b2aa

data/CHANGELOG.md

@@ -1,10 +1,21 @@
-# Unreleased
+# Changelog
 
-# 0.6.1
+## Unreleased
+
+
+## 0.6.3
+
+- Add option to parse only certain paths from OAS file
+
+## 0.6.2
+
+- Add support to map operationIds like `things#index` or `web.things_index`
+
+## 0.6.1
 
 - Make ResponseValidator errors easier to read
 
-# 0.6.0
+## 0.6.0
 
 - Set the content-type based on the OpenAPI description [#29](https://github.com/ahx/openapi-first/pull/29)
 - Add CHANGELOG 📝

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.6.1)
+    openapi_first (0.6.3)
       json_schemer (~> 0.2)
       multi_json (~> 1.13)
       oas_parser (~> 0.19)
@@ -10,13 +10,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
@@ -27,29 +28,31 @@ GEM
       regexp_parser (~> 1.2)
     hana (1.3.5)
     hansi (0.2.0)
-    i18n (1.6.0)
+    hash-deep-merge (0.1.1)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
-    json_schemer (0.2.0)
-      ecma-re-validator (~> 0.2.0)
-      hana (~> 1.3.3)
-      regexp_parser (~> 1.2.0)
-      uri_template (~> 0.7.0)
+    json_schemer (0.2.7)
+      ecma-re-validator (~> 0.2)
+      hana (~> 1.3)
+      regexp_parser (~> 1.5)
+      uri_template (~> 0.7)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    minitest (5.12.2)
+    multi_json (1.14.1)
     mustermann (1.0.3)
     mustermann-contrib (1.0.3)
       hansi (~> 0.2.0)
       mustermann (= 1.0.3)
-    nokogiri (1.10.3)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.19.0)
+    oas_parser (0.22.2)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
       deep_merge (~> 1.2.1)
+      hash-deep-merge
       mustermann-contrib (~> 1.0.3s)
       nokogiri
     parallel (1.17.0)
@@ -58,13 +61,13 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (10.5.0)
-    regexp_parser (1.2.0)
+    regexp_parser (1.6.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -91,6 +94,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     uri_template (0.7.0)
+    zeitwerk (2.2.0)
 
 PLATFORMS
   ruby
@@ -105,4 +109,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -1,9 +1,15 @@
 # OpenapiFirst
 
-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 minimal code about your business logic (some call this "Resolver") and be done.
+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 minimal code about your business logic (some call this "handler") and be done.
 
 ## TL;DR
 
+Start with writing an OpenAPI file that describes the API, which you are about to write. Use a [validator](http://speccy.io/) to make sure the file is valid.
+
+We recommend saving the file as `openapi/openapi.yaml`.
+
+Now implement your API:
+
 ```ruby
 module Pets
   def self.find_pet(params, res)
@@ -21,7 +27,7 @@ run OpenapiFirst.app('./openapi/openapi.yaml', namespace: Pets)
 
 The above will:
 
-- Validate the request and respond with 400 if the request does not match against your spec
+- Validate the request and respond with 400 if the request does not match with your API description
 - Map the request to a method call `Pets.find_pet` based on the `operationId` in the API description
 - Set the response content type according to your spec (here with the default status code `200`)
 
@@ -31,6 +37,17 @@ Resolver functions (`find_pet`) are called with two arguments:
 - `res` - Holds a Rack::Response that you can modify if needed
   If you want to access to plain Rack env you can call `params.env`.
 
+You can also use the provided Rack middlewares to auto-implement only certain aspects of the request-response flow like query parameter or request body parameter validation based on your OpenAPI file. Read on to learn how.
+
+### Handling only certain paths
+
+You can filter the URIs that should be handled by pass ing `only` to `OpenapiFirst.load`:
+
+```ruby
+spec = OpenapiFirst.load './openapi/openapi.yaml', only: '/pets'.method(:==)
+run OpenapiFirst.app(spec, namespace: Pets)
+```
+
 ### Usage as Rack middleware
 
 ```ruby
@@ -45,15 +62,6 @@ When using the middleware, all requests that are not part of the API description
 
 See [example](examples)
 
-## Missing features
-
-See [issues](https://github.com/ahx/openapi_first/issues).
-
-## Start
-
-Start with writing an OpenAPI file that describes the API, which you are about to write. Use a [validator](http://speccy.io/) to make sure the file is valid.
-
-We recommend saving the file as `openapi/openapi.yaml`.
 
 ## Installation
 
@@ -65,76 +73,15 @@ gem 'openapi_first'
 
 OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
 
-## Testing
-
-OpenapiFirst offers tools to help testing your app against your API description.
-
-### Response validation
-
-Response validation is to make sure your app responds as described in your API description. You usually do this in your tests using [rack-test](https://github.com/rack-test/rack-test).
-
-```ruby
-# In your test:
-require 'openapi_first/response_validator'
-spec = OpenapiFirst.load('petstore.yaml')
-validator = OpenapiFirst::ResponseValidator.new(spec)
-validator.validate(last_request, last_response).errors? # => true or false
-```
-
-TODO: Add RSpec matcher (via extra rubygem)
-
-### Coverage
-
-(This is a bit experimental. Please try it out and give feedback.)
-
-`OpenapiFirst::Coverage` helps you make sure, that you have called all endpoints of your OAS file when running tests via `rack-test`.
-
-```ruby
-# In your test (rspec example):
-require 'openapi_first/coverage'
-
-describe MyApp do
-  include Rack::Test::Methods
-
-  before(:all) do
-    spec = OpenapiFirst.load('petstore.yaml')
-    @app_wrapper = OpenapiFirst::Coverage.new(MyApp, spec)
-  end
-
-  after(:all) do
-    message = "The following paths have not been called yet: #{@app_wrapper.to_be_called}"
-    expect(@app_wrapper.to_be_called).to be_empty
-  end
-
-  # Overwrite `#app` to make rack-test call the wrapped app
-  def app
-    @app_wrapper
-  end
-
-  it 'does things' do
-    get '/i/my/stuff'
-    # …
-  end
-end
-```
-
-## Mocking
-
-Mocking is currently out of scope. Try https://github.com/JustinFeng/fakeit or something else.
-
-## Alternatives
-
-This gem is inspired by [committee](https://github.com/interagent/committee), which has much more features like response stubs or support for Hyper-Schema or OpenAPI 2.
-
 ## How it works
 
-OpenapiFirst offers Rack middlewares to auto-implement different aspects of request validation:
+OpenapiFirst offers Rack middlewares to auto-implement different aspects for request handling:
 
 - Query parameter validation
 - Request body validation
 - Mapping request to a function call
 
-It starts with a router middleware:
+It starts by adding a router middleware:
 
 ```ruby
 spec = OpenapiFirst.load('petstore.yaml')
@@ -163,7 +110,7 @@ content-type: "application/vnd.api+json"
 }
 ```
 
-### Query parameter validation
+## Query parameter validation
 
 ```ruby
 use OpenapiFirst::QueryParameterValidation
@@ -181,11 +128,11 @@ If you want to forbid nested query parameters you will need to use `additionalPr
 
 OpenapiFirst does not support parameters set to `explode: false` and treats nested query parameters (`filter[foo]=bar`) like [`style: deepObject`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#style-values).
 
-### TODO: Header, Cookie, Path parameter validation
+## Header, Cookie, Path parameter validation
 
 tbd.
 
-### Request Body validation
+## Request Body validation
 
 ```ruby
 # Add the middleware:
@@ -197,14 +144,34 @@ This will add the parsed request body to `env[OpenapiFirst::REQUEST_BODY]`.
 
 OpenAPI request (and response) body validation is based on [JSON Schema](http://json-schema.org/).
 
-### Mapping request to a function call
+## Mapping the request to a method call
+
+OpenapiFirst uses a `OperationResolver` middleware to map the HTTP request to a method call.
+
+The resolver function is found via the [`operationId`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) attribute in your API description like this:
+
+- `create_pet` will map to `MyApi.create_pet(params, response)`
+- `some_things.create` will map to `MyApi::SomeThings.create(params, response)`
+- `pets#create` will map to `MyApi::Pets::Create.new.call(params, response)` (like [Hanami::Router](https://github.com/hanami/router#controllers))
+
+These handler methods are called with two arguments:
 
-OpenapiFirst has a `OperationResolver` middleware to map the HTTP request to a function (method) call
+- `params` - Holds the parsed request body, filtered query params and path parameters
+- `res` - Holds a Rack::Response that you can modify if needed
+
+You can call `params.env` to access the Rack env (just like in [Hanami actions](https://guides.hanamirb.org/actions/parameters/))
+
+There are two ways to set the response body:
+
+- Calling `res.write "things"` (see [Rack::Response](https://www.rubydoc.info/github/rack/rack/Rack/Response))
+- Returning a value from the function (see example above) (this will always converted to JSON)
+
+### Adding the middleware
 
 ```ruby
 # Define some methods
 module MyApi
-  def create_pet(params, res)
+  def self.create_pet(params, res)
     res.status = 201
     {
       id: '1',
@@ -225,40 +192,20 @@ run OpenapiFirst::OperationResolver, namespace: Pets
 # POST /pets, { name: 'Oscar' }
 ```
 
-The resolver function is found via the [`operationId`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) attribute in your API description. If your operationId has dots like `Pets.find`, the resolver above would call `MyApi::Pets.find(params, req)`.
+## Response validation
 
-These resolver functions are called with two arguments:
-
-- `params` - Holds the parsed request body, filtered query params and path parameters
-- `res` - Holds a Rack::Response that you can modify if needed
-
-You can call `params.env` to access the Rack env (just like in [Hanami actions](https://guides.hanamirb.org/actions/parameters/))
-
-There are two ways to set the response body:
-
-- Calling `res.write "things"` (see [Rack::Response](https://www.rubydoc.info/github/rack/rack/Rack/Response))
-- Returning a value from the function (see example above) (this will always converted to JSON)
-
-## Testing
-
-OpenapiFirst offers tools to help testing your app.
-
-### Response validation
-
-Response validation is to make sure your app responds as described in your OpenAPI spec. You usually do this in your tests using [rack-test](https://github.com/rack-test/rack-test).
+Response validation is useful to make sure your app responds as described in your API description. You usually do this in your tests using [rack-test](https://github.com/rack-test/rack-test).
 
 ```ruby
-# In your test:
-require 'openapi_first/response_validator'
+# In your test (rspec example):
+require 'openapi_first'
 spec = OpenapiFirst.load('petstore.yaml')
 validator = OpenapiFirst::ResponseValidator.new(spec)
 
 expect(validator.validate(last_request, last_response).errors).to be_empty
 ```
 
-TODO: Add RSpec matcher (via extra rubygem)
-
-### Coverage
+## Coverage
 
 (This is a bit experimental. Please try it out and give feedback.)
 
@@ -307,6 +254,16 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Run benchmarks
+
+```sh
+cd benchmarks
+bundle
+bundle exec ruby benchmarks.rb
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ahx/openapi_first.
+If you have a question or an idea or found a bug don't hesitate to [create an issue on GitHub](https://github.com/ahx/openapi_first/issues).
+
+Pull requests are very welcome as well, of course. Feel free to create a "draft" pull request early on, even if your change is still work in progress. 🤗

data/benchmarks/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'benchmark-ips'
+gem 'benchmark-memory'
+gem 'committee'
+gem 'grape'
+gem 'hanami-router', '~> 2.0.0.alpha1'
+gem 'multi_json'
+gem 'openapi_first', path: '../'
+gem 'sinatra'
+gem 'syro'

data/benchmarks/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: ..
+  specs:
+    openapi_first (0.6.3)
+      json_schemer (~> 0.2)
+      multi_json (~> 1.13)
+      oas_parser (~> 0.19)
+      rack (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    benchmark-ips (2.7.2)
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
+    builder (3.2.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    committee (3.2.1)
+      json_schema (~> 0.14, >= 0.14.3)
+      openapi_parser (>= 0.6.1)
+      rack (>= 1.5)
+    concurrent-ruby (1.1.5)
+    deep_merge (1.2.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    dry-inflector (0.2.0)
+    ecma-re-validator (0.2.0)
+      regexp_parser (~> 1.2)
+    equalizer (0.0.11)
+    grape (1.2.4)
+      activesupport
+      builder
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    hana (1.3.5)
+    hanami-router (2.0.0.alpha1)
+      dry-inflector (~> 0.1)
+      hanami-utils (~> 2.0.alpha)
+      mustermann (~> 1.0)
+      mustermann-contrib (~> 1.0)
+      rack (~> 2.0)
+    hanami-utils (2.0.0.alpha1)
+      concurrent-ruby (~> 1.0)
+      transproc (~> 1.0)
+    hansi (0.2.0)
+    hash-deep-merge (0.1.1)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json_schema (0.20.8)
+    json_schemer (0.2.7)
+      ecma-re-validator (~> 0.2)
+      hana (~> 1.3)
+      regexp_parser (~> 1.5)
+      uri_template (~> 0.7)
+    memory_profiler (0.9.14)
+    mini_portile2 (2.4.0)
+    minitest (5.12.2)
+    multi_json (1.14.1)
+    mustermann (1.0.3)
+    mustermann-contrib (1.0.3)
+      hansi (~> 0.2.0)
+      mustermann (= 1.0.3)
+    mustermann-grape (1.0.0)
+      mustermann (~> 1.0.0)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    oas_parser (0.22.2)
+      activesupport (>= 4.0.0)
+      addressable (~> 2.3)
+      builder (~> 3.2.3)
+      deep_merge (~> 1.2.1)
+      hash-deep-merge
+      mustermann-contrib (~> 1.0.3s)
+      nokogiri
+    openapi_parser (0.6.1)
+    public_suffix (4.0.1)
+    rack (2.0.7)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-protection (2.0.7)
+      rack
+    regexp_parser (1.6.0)
+    seg (1.2.0)
+    sinatra (2.0.7)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.7)
+      tilt (~> 2.0)
+    syro (3.1.1)
+      rack (>= 1.6.0)
+      seg
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    transproc (1.1.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uri_template (0.7.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  benchmark-memory
+  committee
+  grape
+  hanami-router (~> 2.0.0.alpha1)
+  multi_json
+  openapi_first!
+  sinatra
+  syro
+
+BUNDLED WITH
+   2.0.2

data/benchmarks/apps/committee.ru

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'committee'
+require 'syro'
+require 'multi_json'
+
+app = Syro.new do
+  on 'hello' do
+    on :id do
+      get do
+        res.json MultiJson.dump(hello: 'world', id: inbox[:id])
+      end
+    end
+
+    get do
+      res.json [MultiJson.dump(hello: 'world')]
+    end
+
+    post do
+      res.status = 201
+      res.json MultiJson.dump(hello: 'world')
+    end
+  end
+end
+
+use Committee::Middleware::RequestValidation,
+    schema_path: './apps/openapi.yaml',
+    coerce_date_times: false
+
+run app

data/benchmarks/apps/grape.ru

@@ -0,0 +1,21 @@
+# 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_router.ru

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

@@ -0,0 +1,86 @@
+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: array
+                items:
+                  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: object
+                required: [hello]
+                properties:
+                  hello:
+                    type: string
+        default:
+          description: Error response
+
+    post:
+      operationId: create_thing
+      description: Create a thing
+      tags: ["Metadata"]
+      responses:
+        "201":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [hello]
+                properties:
+                  hello:
+                    type: string

data/benchmarks/apps/openapi_first.ru

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

data/benchmarks/apps/openapi_first_request_validation_only.ru

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'openapi_first'
+require 'syro'
+require 'multi_json'
+
+app = Syro.new do
+  on 'hello' do
+    on :id do
+      get do
+        res.json MultiJson.dump(hello: 'world', id: inbox[:id])
+      end
+    end
+
+    get do
+      res.json [MultiJson.dump(hello: 'world')]
+    end
+
+    post do
+      res.status = 201
+      res.json MultiJson.dump(hello: 'world')
+    end
+  end
+end
+
+spec = OpenapiFirst.load(File.absolute_path('./openapi.yaml', __dir__))
+use OpenapiFirst::Router, spec: spec
+use OpenapiFirst::QueryParameterValidation
+use OpenapiFirst::RequestBodyValidation
+
+run app

data/benchmarks/apps/openapi_first_resolve_only.ru

@@ -0,0 +1,23 @@
+# 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
+
+spec = OpenapiFirst.load(File.absolute_path('./openapi.yaml', __dir__))
+use OpenapiFirst::Router, spec: spec
+run OpenapiFirst::OperationResolver.new(namespace: namespace)

data/benchmarks/apps/sinatra.ru

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

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

data/benchmarks/benchmarks.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'benchmark/memory'
+require 'rack'
+ENV['RACK_ENV'] = 'production'
+
+examples = [
+  [Rack::MockRequest.env_for('/hello'), 200],
+  [Rack::MockRequest.env_for('/unknown'), 404],
+  [Rack::MockRequest.env_for('/hello', method: 'POST'), 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]
+]
+
+apps = Dir['./apps/*.ru'].each_with_object({}) do |config, hash|
+  hash[config] = Rack::Builder.parse_file(config).first
+end
+apps.freeze
+
+Benchmark.ips do |x|
+  apps.each do |config, app|
+    x.report(config) do
+      examples.each do |example|
+        env, expected_status = example
+        response = app.call(env)
+        raise unless response[0] == expected_status
+      end
+    end
+  end
+  x.compare!
+end
+
+Benchmark.memory do |x|
+  apps.each do |config, app|
+    x.report(config) do
+      examples.each do |example|
+        env, expected_status = example
+        response = app.call(env)
+        raise unless response[0] == expected_status
+      end
+    end
+  end
+  x.compare!
+end

data/lib/openapi_first.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'yaml'
 require 'oas_parser'
 require 'openapi_first/definition'
 require 'openapi_first/version'
 require 'openapi_first/router'
 require 'openapi_first/query_parameter_validation'
 require 'openapi_first/request_body_validation'
+require 'openapi_first/response_validator'
 require 'openapi_first/operation_resolver'
 require 'openapi_first/app'
 
@@ -15,8 +17,12 @@ module OpenapiFirst
   REQUEST_BODY = 'openapi_first.parsed_request_body'
   QUERY_PARAMS = 'openapi_first.query_params'
 
-  def self.load(spec_path)
-    Definition.new(OasParser::Definition.resolve(spec_path))
+  def self.load(spec_path, only: nil)
+    content = YAML.load_file(spec_path)
+    raw = OasParser::Parser.new(spec_path, content).resolve
+    raw['paths'].filter!(&->(key, _) { only.call(key) }) if only
+    parsed = OasParser::Definition.new(raw, spec_path)
+    Definition.new(parsed)
   end
 
   def self.app(spec, namespace:)

data/lib/openapi_first/error_response_method.rb

@@ -14,7 +14,7 @@ module OpenapiFirst
         MultiJson.dump(errors: errors),
         status,
         Rack::CONTENT_TYPE => 'application/vnd.api+json'
-      )
+      ).finish
     end
   end
 end

data/lib/openapi_first/operation_resolver.rb

@@ -4,23 +4,40 @@ require 'rack'
 
 module OpenapiFirst
   class OperationResolver
-    DEFAULT_APP = ->(_env) { Rack::Response.new('', 404) }
+    NOT_FOUND = Rack::Response.new('', 404).finish.freeze
+    DEFAULT_APP = ->(_env) { NOT_FOUND }
 
     def initialize(app = DEFAULT_APP, namespace:)
       @app = app
       @namespace = namespace
     end
 
-    def call(env)
+    def call(env) # rubocop:disable Metrics/AbcSize
       operation = env[OpenapiFirst::OPERATION]
       return @app.call(env) unless operation
 
       operation_id = operation.operation_id
       res = Rack::Response.new
-      result = call_operation_method(operation_id, env, res)
+      params = build_params(env)
+      handler = find_handler(operation_id)
+      result = handler.call(params, res)
       res.write MultiJson.dump(result) if result && res.body.empty?
       res[Rack::CONTENT_TYPE] ||= find_content_type(operation, res.status)
-      res
+      res.finish
+    end
+
+    def find_handler(operation_id)
+      if operation_id.include?('.')
+        module_name, method_name = operation_id.split('.')
+        return @namespace.const_get(module_name.camelize).method(method_name)
+      end
+
+      if operation_id.include?('#')
+        module_name, class_name = operation_id.split('#')
+        return @namespace.const_get(module_name.camelize)
+                         .const_get(class_name.camelize).new
+      end
+      @namespace.method(operation_id)
     end
 
     private
@@ -32,15 +49,6 @@ module OpenapiFirst
       content.keys[0] if content
     end
 
-    def call_operation_method(operation_id, env, res)
-      target = @namespace
-      methods = operation_id.split('.')
-      final = methods.pop
-      methods.each { |m| target = target.send(m) }
-      params = build_params(env)
-      target.send(final, params, res)
-    end
-
     def build_params(env)
       sources = [
         env[PATH_PARAMS],

data/lib/openapi_first/query_parameter_schemas.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  class QueryParameterSchemas
+    def initialize(allow_additional_parameters:)
+      @additional_properties = allow_additional_parameters
+    end
+
+    def find(operation)
+      build_parameter_schema(operation)
+    end
+
+    private
+
+    def build_parameter_schema(operation)
+      return unless operation&.query_parameters&.any?
+
+      operation.query_parameters.each_with_object(
+        'type' => 'object',
+        'required' => [],
+        'additionalProperties' => @additional_properties,
+        'properties' => {}
+      ) do |parameter, schema|
+        schema['required'] << parameter.name if parameter.required
+        schema['properties'][parameter.name] = parameter.schema
+      end
+    end
+  end
+end

data/lib/openapi_first/query_parameter_validation.rb

@@ -5,6 +5,7 @@ require 'json_schemer'
 require 'multi_json'
 require_relative 'validation_format'
 require_relative 'error_response_method'
+require_relative 'query_parameter_schemas'
 
 module OpenapiFirst
   class QueryParameterValidation
@@ -12,14 +13,18 @@ module OpenapiFirst
 
     def initialize(app, allow_additional_parameters: false)
       @app = app
+      @schemas = QueryParameterSchemas.new(
+        allow_additional_parameters: allow_additional_parameters
+      )
       @additional_properties = allow_additional_parameters
     end
 
     def call(env)
       req = Rack::Request.new(env)
-      schema = parameter_schema(env[OpenapiFirst::OPERATION])
-      params = req.params
+      operation = env[OpenapiFirst::OPERATION]
+      schema = operation && @schemas.find(operation)
       if schema
+        params = req.params
         errors = schema && JSONSchemer.schema(schema).validate(params)
         return error_response(400, serialize_errors(errors)) if errors&.any?
 
@@ -38,20 +43,6 @@ module OpenapiFirst
         end
     end
 
-    def parameter_schema(operation)
-      return unless operation&.query_parameters&.any?
-
-      operation.query_parameters.each_with_object(
-        'type' => 'object',
-        'required' => [],
-        'additionalProperties' => @additional_properties,
-        'properties' => {}
-      ) do |parameter, schema|
-        schema['required'] << parameter.name if parameter.required
-        schema['properties'][parameter.name] = parameter.schema
-      end
-    end
-
     def serialize_errors(validation_errors)
       validation_errors.map do |error|
         {

data/lib/openapi_first/router.rb

@@ -7,6 +7,8 @@ require 'mustermann/template'
 
 module OpenapiFirst
   class Router
+    NOT_FOUND = Rack::Response.new('', 404).finish.freeze
+
     def initialize(app, spec:, allow_unknown_operation: false)
       @app = app
       @spec = spec
@@ -20,7 +22,7 @@ module OpenapiFirst
       env[PATH_PARAMS] = path_params if path_params
       return @app.call(env) if operation || @allow_unknown_operation
 
-      Rack::Response.new('', 404)
+      NOT_FOUND
     end
 
     def find_path_params(operation, req)

data/lib/openapi_first/version.rb

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

data/openapi_first.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['andreas.haller@posteo.de']
   spec.licenses      = ['MIT']
 
-  spec.summary       = 'Implement REST APIs based on an OpenApi API description'
+  spec.summary       = 'Implement REST APIs based on OpenApi.'
   spec.homepage      = 'https://github.com/ahx/openapi_first'
 
   if spec.respond_to?(:metadata)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schemer
@@ -139,6 +139,18 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- benchmarks/Gemfile
+- benchmarks/Gemfile.lock
+- benchmarks/apps/committee.ru
+- benchmarks/apps/grape.ru
+- benchmarks/apps/hanami_router.ru
+- benchmarks/apps/openapi.yaml
+- benchmarks/apps/openapi_first.ru
+- benchmarks/apps/openapi_first_request_validation_only.ru
+- benchmarks/apps/openapi_first_resolve_only.ru
+- benchmarks/apps/sinatra.ru
+- benchmarks/apps/syro.ru
+- benchmarks/benchmarks.rb
 - bin/console
 - bin/setup
 - examples/README.md
@@ -151,6 +163,7 @@ files:
 - lib/openapi_first/definition.rb
 - lib/openapi_first/error_response_method.rb
 - lib/openapi_first/operation_resolver.rb
+- lib/openapi_first/query_parameter_schemas.rb
 - lib/openapi_first/query_parameter_validation.rb
 - lib/openapi_first/request_body_validation.rb
 - lib/openapi_first/response_validator.rb
@@ -182,5 +195,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Implement REST APIs based on an OpenApi API description
+summary: Implement REST APIs based on OpenApi.
 test_files: []