openapi_first 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 689e572886b7ca556ffb00c89368195e129d954a03a3899f3d7d8401bd724196
-  data.tar.gz: e2669f12188188ac232d0c52b8a371e221ce65e589f2bd06dc6b7547fd0cafc2
+  metadata.gz: 8f5e77e342d4dba0c6ac4d535511148333efac5bc4b2cea62ee6d8b75219233e
+  data.tar.gz: 9b3341115e77bd4abc4b14d89464093d78483e251cf69e2b2508461c98aa1ccf
 SHA512:
-  metadata.gz: c3409b992b56a09eb9e4bc75d20e6711a4ebda0bd93c0422316343ea48b4f8816394f1506b675c56e42f3dad339a0b7aa9c4834f0372045815a81888724ad45e
-  data.tar.gz: 2893535646d84f3ca6db6efc63c5334961929b9f6e561b8d36f771ca4ad0b9e25af5c5b06292ae9745610fa6dd229516c4aa4b42c01c52fc176294a1713b8767
+  metadata.gz: 86f19dc76569748825731014124b689b7bddf5cce6a6fe38b5d95adb4643eeeeaa3ae6024a290aaf2aed92127147cc948a55faa062b5d97b99b7d2fe65df98cd
+  data.tar.gz: 27cef03d9ef7e0b49af33154e44ca68d3e0e860dcd94cbf6d2cdc4661ff90a4be590b92365aabfcdffe330f2aa2e96c12f7277ee2fa572fe02a2cc2c263e34b5

data/.rubocop.yml

@@ -32,3 +32,5 @@ Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
   Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.12.3
+- Add `response_validation:`, `router_raise_error` options to standalone mode.
+
 ## 0.12.2
 - Allow response to have no media type object specified
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.12.2)
+    openapi_first (0.12.3)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
@@ -26,7 +26,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.6)
     deep_merge (1.2.1)
-    diff-lcs (1.4.2)
+    diff-lcs (1.4.4)
     ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
     hana (1.3.6)
@@ -49,15 +49,15 @@ GEM
     method_source (1.0.0)
     mini_portile2 (2.4.0)
     minitest (5.14.1)
-    multi_json (1.14.1)
+    multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-contrib (1.1.1)
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.2)
+    oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -92,16 +92,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.86.0)
+    rubocop (0.87.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
+    rubocop-ast (0.1.0)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
@@ -111,7 +111,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     uri_template (0.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -150,7 +150,12 @@ end
 
 # In config.ru:
 require 'openapi_first'
-run OpenapiFirst.app('./openapi/openapi.yaml', namespace: Pets)
+run OpenapiFirst.app(
+  './openapi/openapi.yaml',
+  namespace: Pets,
+  response_validation: ENV['RACK_ENV'] == 'test',
+  router_raise_error:  ENV['RACK_ENV'] == 'test'
+)
 ```
 
 The above will use the mentioned Rack middlewares to:
@@ -159,6 +164,17 @@ The above will use the mentioned Rack middlewares to:
 - 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`)
 
+### Options and their defaults:
+
+| Name | Possible values | Description | Default
+|:---|---|---|---|
+| `spec_path` || A filepath to an OpenAPI definition file. |
+| `namespace:` || A class or module where to find the handler methods.|
+| `response_validation:` | `true`, `false` | If set to true it raises an exception if the response is invalid. This is useful during testing. | `false`
+| `router_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request path/method is not specified. This is useful during testing. | `false`
+| `request_validation_raise_error:` | `true`, `false` | If set to true it raises an exception (subclass of `OpenapiFirst::Error` when a request is not valid. | `false`
+
+
 Handler functions (`find_pet`) are called with two arguments:
 
 - `params` - Holds the parsed request body, filtered query params and path parameters

data/benchmarks/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.12.2)
+    openapi_first (0.12.3)
       deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha3)
       hanami-utils (~> 2.0.alpha1)
@@ -25,7 +25,7 @@ GEM
     benchmark-memory (0.1.2)
       memory_profiler (~> 0.9)
     builder (3.2.4)
-    committee (4.0.0)
+    committee (4.1.0)
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (>= 0.11.1)
       rack (>= 1.5)
@@ -83,7 +83,7 @@ GEM
     memory_profiler (0.9.14)
     mini_portile2 (2.4.0)
     minitest (5.14.1)
-    multi_json (1.14.1)
+    multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-contrib (1.1.1)
@@ -91,9 +91,9 @@ GEM
       mustermann (= 1.1.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.2)
+    oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -125,7 +125,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     uri_template (0.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby

data/examples/app.rb

@@ -17,5 +17,6 @@ oas_path = File.absolute_path('./openapi.yaml', __dir__)
 App = OpenapiFirst.app(
   oas_path,
   namespace: Web,
-  raise_error: OpenapiFirst.env == 'test'
+  router_raise_error: OpenapiFirst.env == 'test',
+  response_validation: OpenapiFirst.env == 'test'
 )

data/lib/openapi_first.rb

@@ -31,14 +31,39 @@ module OpenapiFirst
     Definition.new(parsed)
   end
 
-  def self.app(spec, namespace:, raise_error: false)
+  def self.app(
+    spec,
+    namespace:,
+    router_raise_error: false,
+    request_validation_raise_error: false,
+    response_validation: false
+  )
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    App.new(nil, spec, namespace: namespace, raise_error: raise_error)
+    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
 
-  def self.middleware(spec, namespace:, raise_error: false)
+  def self.middleware(
+    spec,
+    namespace:,
+    router_raise_error: false,
+    request_validation_raise_error: false,
+    response_validation: false
+  )
     spec = OpenapiFirst.load(spec) if spec.is_a?(String)
-    AppWithOptions.new(spec, namespace: namespace, raise_error: raise_error)
+    AppWithOptions.new(
+      spec,
+      namespace: namespace,
+      router_raise_error: router_raise_error,
+      request_validation_raise_error: request_validation_raise_error,
+      response_validation: response_validation
+    )
   end
 
   class AppWithOptions

data/lib/openapi_first/app.rb

@@ -5,12 +5,19 @@ require 'logger'
 
 module OpenapiFirst
   class App
-    def initialize(parent_app, spec, namespace:, raise_error:)
+    def initialize( # rubocop:disable Metrics/ParameterLists
+      parent_app,
+      spec,
+      namespace:,
+      router_raise_error: false,
+      request_validation_raise_error: false,
+      response_validation: false
+    )
       @stack = Rack::Builder.app do
         freeze_app
-        use OpenapiFirst::Router, spec: spec, raise_error: raise_error, parent_app: parent_app
-        use OpenapiFirst::RequestValidation, raise_error: raise_error
-        use OpenapiFirst::ResponseValidation if raise_error
+        use OpenapiFirst::Router, spec: spec, raise_error: router_raise_error, parent_app: parent_app
+        use OpenapiFirst::RequestValidation, raise_error: request_validation_raise_error
+        use OpenapiFirst::ResponseValidation if response_validation
         run OpenapiFirst::Responder.new(
           spec: spec,
           namespace: namespace

data/lib/openapi_first/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge