openapi_first 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82bb84c8685503083fd1b5ef61e6839c706e2a2152c093af842fe96e9a0004cd
-  data.tar.gz: 20165b2fcb4f10004cd6ee4cab55eeec912bcac6d8d86255cb08c2f2e9f0e8a6
+  metadata.gz: 50a431b59d4568cede6b8a110ada173691c698517231299795ee22fc8f54115a
+  data.tar.gz: be49aa45dd7b95ee0ec2149b4ec6476c78a42a0e46204c321e5350368bee2d54
 SHA512:
-  metadata.gz: dd403e00cdd880573c10de5949db863afd3791eb3271ef26d227e4dffe9efa9775dbb84847acbc3fd79fbc1630be1dc6e71b0c6e7362a992f6350ab2fadf4b1f
-  data.tar.gz: 9080c126f4a6083ed3e16bcb7f7fd5503b0efaa6633f40cfce2ce85afae4531f15c845ecb76e0138c9395626ec860a7bc9ac51df29c0d11fb2a4970583b5e86e
+  metadata.gz: b6b29dab24a951716e9fb73a7f852a4acd3de577cce82008cd329906ef77d73c4cff182face7adb1d36e9ecb9ea170d1655accb9cdc3bba682a818c3c81000b0
+  data.tar.gz: d0ad9c915cb4e637dce9ff4f0e6a8bc35cf705c684f69f38d9abbc8edada4b8aef0d2ba226cfae187f9d80da3a229e0f9493ac78bddb0045206ed816cbfe022e

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.9.0
+- Make request validation usable standalone
+
 ## 0.8.0
 - Add merged parameter and request body available to env at `env[OpenapiFirst::INBOX]` in request validation
 - Path and query parameters with `type: boolean` now get converted to `true`/`false`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.8.0)
+    openapi_first (0.9.0)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)

data/README.md

@@ -35,27 +35,31 @@ Handler functions (`find_pet`) 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
   If you want to access to plain Rack env you can call `params.env`.
+  
+## Rack middlewares 
+OpenapiFirst consists of these Rack middlewares:
 
-### Handling only certain paths
+- `OpenapiFirst::Router` finds the operation for the current request and finds a handler (if namespace option is given)
+- `OpenapiFirst::RequestValidation` validates the request and returns 400 if it's invalid
+- `OpenapiFirst::OperationResolver` calls the handler
 
-You can filter the URIs that should be handled by pass ing `only` to `OpenapiFirst.load`:
+Instead of using `OpenapiFirst.app` you can use these middlwares by itself.
 
-```ruby
-spec = OpenapiFirst.load './openapi/openapi.yaml', only: '/pets'.method(:==)
-run OpenapiFirst.app(spec, namespace: Pets)
-```
-
-### Usage as Rack middleware
+## Usage within your Rack webframework
+If you just want to use the request validation part without any handlers you can use the rack middlewares standalone and don't need to pass a `namespace` option:
 
 ```ruby
-# Just like the above, except the last line
-# ...
-run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
+use OpenapiFirst::Router, spec: OpenapiFirst.load('./openapi/openapi.yaml')
+use OpenapiFirst::RequestValidation
 ```
 
-When using the middleware, all requests that are not part of the API description will be passed to the next app.
+### Rack env variables
+These variables will available in your rack env:
 
-### Try it out
+- `env[OpenapiFirst::OPERATION]` - Holds an Operation object that responsed about `operation_id` and `path`. This is useful for introspection.
+- `env[OpenapiFirst::INBOX]`. Holds the (filtered) path and query parameters and the response body.
+
+## Try it out
 
 See [examples](examples).
 
@@ -147,6 +151,24 @@ validator = OpenapiFirst::ResponseValidator.new(spec)
 expect(validator.validate(last_request, last_response).errors).to be_empty
 ```
 
+## If your API description does not contain all endpoints
+
+```ruby
+run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
+```
+
+Here all requests that are not part of the API description will be passed to the next app.
+
+## Handling only certain paths
+
+You can filter the URIs that should be handled by passing `only` to `OpenapiFirst.load`:
+
+```ruby
+spec = OpenapiFirst.load './openapi/openapi.yaml', only: '/pets'.method(:==)
+run OpenapiFirst.app(spec, namespace: Pets)
+```
+
+
 ## Coverage
 
 (This is a bit experimental. Please try it out and give feedback.)

data/benchmarks/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.8.0)
+    openapi_first (0.9.0)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)

data/examples/app.rb

@@ -2,11 +2,15 @@
 
 require 'openapi_first'
 
-module Example
-  def self.find_thing(_params, _res)
-    { hello: 'world' }
+module Web
+  module Things
+    class Index
+      def call(_params, _response)
+        { hello: 'world' }
+      end
+    end
   end
 end
 
 oas_path = File.absolute_path('./openapi.yaml', __dir__)
-App = OpenapiFirst.app(oas_path, namespace: Example)
+App = OpenapiFirst.app(oas_path, namespace: Web)

data/examples/openapi.yaml

@@ -12,7 +12,7 @@ tags:
 paths:
   /:
     get:
-      operationId: find_thing
+      operationId: things#index
       summary: Get metadata from the root of the API
       tags: ["Metadata"]
       responses:

data/lib/openapi_first/router.rb

@@ -10,7 +10,7 @@ module OpenapiFirst
 
     def initialize(app, options)
       @app = app
-      @namespace = options.fetch(:namespace)
+      @namespace = options.fetch(:namespace, nil)
       @parent_app = options.fetch(:parent_app, nil)
       @router = build_router(options.fetch(:spec).operations)
     end
@@ -74,8 +74,8 @@ module OpenapiFirst
           warn "operationId is missing in '#{operation.method} #{operation.path}'. I am ignoring this operation." # rubocop:disable Layout/LineLength
           next
         end
-        handler = find_handler(operation.operation_id)
-        if handler.nil?
+        handler = @namespace && find_handler(operation.operation_id)
+        if @namespace && handler.nil?
           warn "#{self.class.name} cannot not find handler for '#{operation.operation_id}' (#{operation.method} #{operation.path}). This operation will be ignored." # rubocop:disable Layout/LineLength
           next
         end

data/lib/openapi_first/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-router
@@ -176,7 +176,6 @@ files:
 - benchmarks/apps/hanami_router.ru
 - benchmarks/apps/openapi.yaml
 - benchmarks/apps/openapi_first.ru
-- benchmarks/apps/openapi_first_resolve_only.ru
 - benchmarks/apps/sinatra.ru
 - benchmarks/apps/syro.ru
 - benchmarks/benchmarks.rb

data/benchmarks/apps/openapi_first_resolve_only.ru

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