openapi_first 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3628fb4b2c3839480899102cfa770b7dc5fbed43503689a475e3e969dc1f8c13
-  data.tar.gz: 27fd6a6c02cd48a56e99e9e6bb7c8edc9ccbc5a0423d59c9186ec1ea3e2daecd
+  metadata.gz: 82bb84c8685503083fd1b5ef61e6839c706e2a2152c093af842fe96e9a0004cd
+  data.tar.gz: 20165b2fcb4f10004cd6ee4cab55eeec912bcac6d8d86255cb08c2f2e9f0e8a6
 SHA512:
-  metadata.gz: e7577b4277603b753ad5b30970c1f479e9c16843400636b6718730459a8f5b1847a12d78b4582ed72d4431e9a45d9d7f1b850e39575cf08da927470a839eb371
-  data.tar.gz: 8afb057b842fe5759878f8f6b1a4ea16bbf223bdcfcd0823dd99715b3ba3ff492be7dbf2257868fb252a14c90f820942576b3e975e394287a349c3e493277358
+  metadata.gz: dd403e00cdd880573c10de5949db863afd3791eb3271ef26d227e4dffe9efa9775dbb84847acbc3fd79fbc1630be1dc6e71b0c6e7362a992f6350ab2fadf4b1f
+  data.tar.gz: 9080c126f4a6083ed3e16bcb7f7fd5503b0efaa6633f40cfce2ce85afae4531f15c845ecb76e0138c9395626ec860a7bc9ac51df29c0d11fb2a4970583b5e86e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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`
+- Rename `OpenapiFirst::PARAMS` to `OpenapiFirst::PARAMETERS`
+
 ## 0.7.1
 - Add missing `require` to work with new version of `oas_parser`
 

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.7.1)
+    openapi_first (0.8.0)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
       multi_json (~> 1.14)
-      oas_parser (~> 0.24)
+      oas_parser (~> 0.25.1)
       rack (~> 2.2)
 
 GEM
@@ -57,7 +57,7 @@ GEM
       mustermann (= 1.1.1)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.0)
+    oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)

data/benchmarks/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.7.1)
+    openapi_first (0.8.0)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
       multi_json (~> 1.14)
-      oas_parser (~> 0.24)
+      oas_parser (~> 0.25.1)
       rack (~> 2.2)
 
 GEM
@@ -92,7 +92,7 @@ GEM
       mustermann (>= 1.0.0)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.0)
+    oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)

data/lib/openapi_first.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'oas_parser/path' # TODO: Remove when Nexmo/oas_parser/pull/49 is merged
 require 'oas_parser'
 require 'openapi_first/definition'
 require 'openapi_first/version'
+require 'openapi_first/inbox'
 require 'openapi_first/router'
 require 'openapi_first/request_validation'
 require 'openapi_first/response_validator'
@@ -13,8 +13,9 @@ require 'openapi_first/app'
 
 module OpenapiFirst
   OPERATION = 'openapi_first.operation'
-  PARAMS = 'openapi_first.params'
+  PARAMETERS = 'openapi_first.parameters'
   REQUEST_BODY = 'openapi_first.parsed_request_body'
+  INBOX = 'openapi_first.inbox'
   HANDLER = 'openapi_first.handler'
 
   def self.load(spec_path, only: nil)

data/lib/openapi_first/inbox.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  # An instance of this gets passed to handler functions as first argument.
+  class Inbox < Hash
+    attr_reader :env
+
+    def initialize(env)
+      @env = env
+      super()
+    end
+  end
+end

data/lib/openapi_first/operation_resolver.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 require 'rack'
+require_relative 'inbox'
 
 module OpenapiFirst
   class OperationResolver
     def call(env)
       operation = env[OpenapiFirst::OPERATION]
       res = Rack::Response.new
-      params = build_params(env)
+      inbox = env[INBOX]
       handler = env[HANDLER]
-      result = handler.call(params, res)
+      result = handler.call(inbox, res)
       res.write serialize(result) if result && res.body.empty?
       res[Rack::CONTENT_TYPE] ||= operation.content_type_for(res.status)
       res.finish
@@ -22,22 +23,5 @@ module OpenapiFirst
 
       MultiJson.dump(result)
     end
-
-    def build_params(env)
-      sources = [
-        env[PARAMS],
-        env[REQUEST_BODY]
-      ].tap(&:compact!)
-      Params.new(env).merge!(*sources)
-    end
-  end
-
-  class Params < Hash
-    attr_reader :env
-
-    def initialize(env)
-      @env = env
-      super()
-    end
   end
 end

data/lib/openapi_first/request_validation.rb

@@ -3,6 +3,7 @@
 require 'rack'
 require 'json_schemer'
 require 'multi_json'
+require_relative 'inbox'
 require_relative 'validation_format'
 
 module OpenapiFirst
@@ -15,8 +16,9 @@ module OpenapiFirst
       operation = env[OpenapiFirst::OPERATION]
       return @app.call(env) unless operation
 
+      env[INBOX] = Inbox.new(env)
       catch(:halt) do
-        validate_query_parameters!(env, operation, env[PARAMS])
+        validate_query_parameters!(env, operation, env[PARAMETERS])
         req = Rack::Request.new(env)
         content_type = req.content_type
         return @app.call(env) unless operation.request_body
@@ -47,7 +49,7 @@ module OpenapiFirst
       if errors.any?
         halt(error_response(400, serialize_request_body_errors(errors)))
       end
-      env[OpenapiFirst::REQUEST_BODY] = parsed_request_body
+      env[INBOX].merge! env[REQUEST_BODY] = parsed_request_body
     end
 
     def validate_request_content_type!(content_type, operation)
@@ -106,7 +108,8 @@ module OpenapiFirst
       if errors.any?
         halt error_response(400, serialize_query_parameter_errors(errors))
       end
-      env[PARAMS] = params
+      env[PARAMETERS] = params
+      env[INBOX].merge! params
     end
 
     def filtered_params(json_schema, params)
@@ -137,6 +140,14 @@ module OpenapiFirst
       rescue ArgumentError
         value
       end
+      return to_boolean(value) if schema['type'] == 'boolean'
+
+      value
+    end
+
+    def to_boolean(value)
+      return true if value == 'true'
+      return false if value == 'false'
 
       value
     end

data/lib/openapi_first/router.rb

@@ -84,7 +84,7 @@ module OpenapiFirst
           normalized_path,
           to: lambda do |env|
             env[OPERATION] = operation
-            env[PARAMS] = Utils.deep_stringify(env['router.params'])
+            env[PARAMETERS] = Utils.deep_stringify(env['router.params'])
             env[HANDLER] = handler
             @app.call(env)
           end

data/lib/openapi_first/version.rb

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

data/openapi_first.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hanami-utils', '~> 2.0.alpha1'
   spec.add_dependency 'json_schemer', '~> 0.2'
   spec.add_dependency 'multi_json', '~> 1.14'
-  spec.add_dependency 'oas_parser', '~> 0.24'
+  spec.add_dependency 'oas_parser', '~> 0.25.1'
   spec.add_dependency 'rack', '~> 2.2'
 
   spec.add_development_dependency 'bundler', '~> 2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-router
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: 0.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: 0.25.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,7 @@ files:
 - lib/openapi_first/app.rb
 - lib/openapi_first/coverage.rb
 - lib/openapi_first/definition.rb
+- lib/openapi_first/inbox.rb
 - lib/openapi_first/operation.rb
 - lib/openapi_first/operation_resolver.rb
 - lib/openapi_first/request_validation.rb