faraday_middleware-openapi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5af0efe250b2afc8f1a0bdedfa76feed9dc6e8c6d75283eae30e9de8c97b1593
-  data.tar.gz: 183c3a1e0202fc982310b4c57c2b992ce4ba7048706eeda01ca283953cbe9ebc
+  metadata.gz: dfb34ee30b7b4e177eaba4234981418f9c217f8e6a5d270f61f2d39ff18ac8af
+  data.tar.gz: fe0e7c176b712505d14a301966aa67a0118867473940c3450e727a4e5835d838
 SHA512:
-  metadata.gz: 517ef8d5de5309d76ea613ec2518bf70774d65c8ee46bf3fed0019641d1d1efa827c04ae8e1d038b948e9312ee3e30c63d79ff2718e5d4e2d324d7a980802b26
-  data.tar.gz: df07b15c091a34883b941f15ee17392b5fc57c825ffb032a00295f53c6effe08fcac2e3e7b4be3313e4934f959efb7d87d2d15ce8eb6865b0649fa8ed33b1358
+  metadata.gz: 9ef0e5294688a1cb5d1afdb90e3e18eb973e72ce1a5bb94e2d1d93c046ac26a0068bbe245de22d20998de0310bb16807351a3b49d036f15df8aae83e2105e472
+  data.tar.gz: 296e07aed246abe7728199c281c4685f7920e3c47107968dafb55a73c3b2cdf51c02a1009de9c7f25acaa8a51a0ec7fcee019896ed696c5ab1a603c0f1d9606e

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-02-20
+## [0.0.2] - 2021-02-20
+
+- Support multipart/form-data in RequestValidator (#2)
+## [0.0.1] - 2021-02-20
 
 - Initial release

data/Gemfile.lock

@@ -1,19 +1,30 @@
 PATH
   remote: .
   specs:
-    faraday_middleware-openapi (0.0.1)
+    faraday_middleware-openapi (0.0.2)
+      activesupport
       faraday (>= 1.0)
       openapi_parser
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
     faraday (1.3.0)
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
     faraday-net_http (1.0.1)
+    i18n (1.8.8)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
     multipart-post (2.1.1)
     openapi_parser (0.12.1)
     rake (13.0.3)
@@ -31,6 +42,9 @@ GEM
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
     ruby2_keywords (0.0.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -11,6 +11,9 @@ gem 'faraday_middleware-openapi'
 ```ruby
 Faraday.new(...) do |conn|
   conn.request :openapi, "/path/to/openapi_schema.yaml"
+
+  # if using :multipart, it must be defined after :openapi
+  conn.request(:multipart)
 end
 ```
 

data/faraday_middleware-openapi.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["meganemura"]
   spec.email         = ["meganemura@users.noreply.github.com"]
 
-  spec.summary       = ""
-  spec.description   = ""
+  spec.summary       = "Faraday middleware for validation by OpenAPI"
+  spec.description   = spec.summary
   spec.homepage      = "https://github.com/meganemura/faraday_middleware-openapi"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", ">= 1.0"
   spec.add_dependency "openapi_parser"
+  spec.add_dependency "activesupport"
 end

data/lib/faraday_middleware/openapi.rb

@@ -3,6 +3,8 @@
 require "faraday"
 require "yaml"
 require "openapi_parser"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/deep_transform_values"
 require_relative "openapi/request_validator"
 require_relative "openapi/version"
 

data/lib/faraday_middleware/openapi/request_validator.rb

@@ -4,20 +4,7 @@ module FaradayMiddleware
   module OpenAPI
     class RequestValidator < Faraday::Middleware
       def on_request(env)
-        content_type = env.request_headers['Content-Type']
-        operation = request_operation(env.method, env.url.path)
-        operation.validate_request_parameter(env.params || {}, {})
-        request_body = case content_type
-                       when 'application/json' # Use regexp
-                         begin
-                           JSON.parse(env.request_body)
-                         rescue
-                           nil
-                         end
-                       end
-        operation.validate_request_body(content_type, request_body)
-      rescue OpenAPIParser::NotExistRequiredKey, OpenAPIParser::NotNullError => e
-        raise ::FaradayMiddleware::OpenAPI::Error.new(e.message)
+        validate(env)
       end
 
       def initialize(app, options = {})
@@ -30,12 +17,75 @@ module FaradayMiddleware
 
       attr_reader :schema_path
 
-      def openapi_parser
-        @openapi_parser ||= OpenAPIParser.parse(YAML.load_file(schema_path), coerce_value: false)
+      def validate(env)
+        request_operation = RequestOperation.new(env: env, schema_path: schema_path)
+        request_operation.validate_request_parameter
+        request_operation.validate_request_body
       end
 
-      def request_operation(method, path)
-        openapi_parser.request_operation(method, path)
+      def request_operation(env:, schema_path:)
+        RequestOperation.new(env: env, schema_path: schema_path)
+      end
+
+      class RequestOperation
+        def initialize(env:, schema_path:)
+          @env = env
+          @schema_path = schema_path
+        end
+
+        def validate_request_parameter
+          request_operation.validate_request_parameter(env.params || {}, {})
+        rescue OpenAPIParser::OpenAPIError => e
+          raise ::FaradayMiddleware::OpenAPI::Error.new(e.message)
+        end
+
+        def validate_request_body
+          request_operation.validate_request_body(content_type, request_body)
+        rescue OpenAPIParser::OpenAPIError => e
+          raise ::FaradayMiddleware::OpenAPI::Error.new(e.message)
+        end
+
+        private
+
+        attr_reader :env
+        attr_reader :schema_path
+
+        def content_type
+          env.request_headers['Content-Type']
+        end
+
+        def request_body
+          case content_type
+          when 'application/json' # Use regexp
+            begin
+              JSON.parse(env.request_body)
+            rescue
+              nil
+            end
+          when "multipart/form-data"
+            validatablize_multipart_form_data(env.request_body)
+          end
+        end
+
+        def validatablize_multipart_form_data(request_body)
+          body = request_body.deep_stringify_keys
+          body.deep_transform_values do |value|
+            case value
+            when Faraday::FilePart
+              value.yield_self {|x| v = x.read; x.rewind; v }
+            else
+              value
+            end
+          end
+        end
+
+        def request_operation
+          openapi_parser.request_operation(env.method, env.url.path)
+        end
+
+        def openapi_parser
+          @openapi_parser ||= OpenAPIParser.parse(YAML.load_file(schema_path), coerce_value: false)
+        end
       end
     end
   end

data/lib/faraday_middleware/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module FaradayMiddleware
   module OpenAPI
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-openapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - meganemura
@@ -38,7 +38,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Faraday middleware for validation by OpenAPI
 email:
 - meganemura@users.noreply.github.com
 executables: []
@@ -86,5 +100,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Faraday middleware for validation by OpenAPI
 test_files: []