faraday-openapi 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e41cd473bab30a829372fc6edf2f638e834d857ab865761c2e393771fef55700
-  data.tar.gz: b9a3a5c4bb6005de564292011cc33b651c3c5099cb7fe9aca522ed56288fc22a
+  metadata.gz: 571ee2451eee11277b3645a3851a4738791b94272326bbe36a320a4bf75d79d1
+  data.tar.gz: 77cf157de1852b404718d1f6cd482a13e2512133faa606fa4200040151e296a5
 SHA512:
-  metadata.gz: 0e5bc74395489346a44cb5104522b114b18e87d97e534569bbaeaf0e7915a55ee830f6a4c47e2cf20dd07ec9b27cc375f9c881c95115c8bacc383422a13596ed
-  data.tar.gz: 4aa000125ce9e034c1d379eb4fc96fe33bd26061bbbadbc26f40a50cad6a416ae92166b11e88336e24f8016855ece8d90321fe9b566807150b650daeb478f08d
+  metadata.gz: a450a0755f226635c42101561ed97a9363133701b28e60d004101941280cf66f0fe262551b46659a676b9acb0d341f95015759101557cb49330e1f4db86ecb6d
+  data.tar.gz: c2eb79c33c7449b07bc369bf9c13e94ef4acec4b02e2d0bd5d7e2318a117a70a40335ead528f784b5619cb4f6896080174936fd107996ffa6b89d968f8bcdacf

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## 0.6.0
+
+- Added `allow_partial_responses` option to allow skipping required properties in response body validation:
+  ```ruby
+  Faraday::Openapi.register('openapi.yaml', allow_partial_responses: true)
+  ```
+
+  This can be useful if you would have to mock very large response bodies, but your consumer just needs a few fields.
+
+## 0.5.0
+
+- Update openapi_first from version 2 to 3
+
 ## 0.4.0
 
 - Fix setting request content-type header

data/README.md

@@ -39,9 +39,6 @@ register your API description (OAD) globally and reference it via a Symbol in yo
 
 require 'faraday/openapi'
 Faraday::Openapi.register 'dice-openapi.yaml', as: :dice_api
-
-# Only activate in test env
-Faraday::Openapi.enabled = ENV['RACK_ENV'] == 'test'
 ```
 
 ```ruby
@@ -63,7 +60,15 @@ conn = Faraday.new do |f|
 end
 ```
 
-You can disable all middlewares in this gem globally, which you probably want to do on production.
+## Configuration
+
+Allow partial response bodies via `allow_partial_responses: true` (default: false). This can be useful if you would have to mock very large response bodies in tests where your consumer just uses a few fields.
+
+```ruby
+  Faraday::Openapi.register 'dice-openapi.yaml', as: :dice_api, allow_partial_responses: true
+```
+
+You can disable all middlewares in this gem globally, which you want to do on production.
 
 ```ruby
 Faraday::Openapi.enabled = false
@@ -83,7 +88,7 @@ See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-th
 
 ## Contributing
 
-Bug reports and pull requests are welcome on [Codeberg](https://codeberg.org/ahx/faraday-openapi) or [Github](https://github.com/ahx/faraday-openapi).
+Bug reports and pull requests are welcome on [Codeberg](https://codeberg.org/ahx/faraday-openapi).
 
 ## License
 

data/lib/faraday/openapi/errors.rb

@@ -13,5 +13,7 @@ module Faraday
 
     class AlreadyRegisteredError < Error; end
     class NotRegisteredError < Error; end
+
+    class FileNotFoundError < Error; end
   end
 end

data/lib/faraday/openapi/middleware.rb

@@ -14,6 +14,7 @@ module Faraday
         return unless Openapi.enabled
 
         @oad = path.is_a?(Symbol) ? Faraday::Openapi[path] : OpenapiFirst.load(path)
+        @configuration = Faraday::Openapi.configurations[path]
       end
 
       def call(env)
@@ -50,11 +51,23 @@ module Faraday
       def on_complete(env)
         request = Request.from_env(env)
         response = Response.from_env(env)
-        @oad.validate_response(request, response, raise_error: true)
-      rescue OpenapiFirst::ResponseInvalidError, OpenapiFirst::ResponseNotFoundError => e
-        return if e.is_a?(OpenapiFirst::ResponseNotFoundError) && (response.status >= 401)
+        validated_response = @oad.validate_response(request, response, raise_error: false)
 
-        raise ResponseInvalidError, e.message
+        return if validated_response.valid?
+        return if !validated_response.known? && (validated_response.status >= 401)
+        return if ignore_error?(validated_response)
+
+        raise ResponseInvalidError, validated_response.error.message
+      end
+
+      private
+
+      def ignore_error?(validated_response)
+        partial_mocking_enabled? && validated_response.error.errors.all? { |err| err.type == 'required' }
+      end
+
+      def partial_mocking_enabled?
+        @configuration && @configuration[:allow_partial_responses]
       end
     end
 

data/lib/faraday/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Openapi
-    VERSION = '0.4.0'
+    VERSION = '0.6.0'
   end
 end

data/lib/faraday/openapi.rb

@@ -20,18 +20,22 @@ module Faraday
     Faraday::Response.register_middleware(openapi: Faraday::Openapi::ResponseMiddleware)
 
     @registry = {}
+    @configurations = {}
     @enabled = true
 
     class << self
-      attr_reader :registry
+      attr_reader :registry, :configurations
       attr_accessor :enabled
     end
 
-    def self.register(filepath, as: :default)
+    def self.register(filepath, as: :default, allow_partial_responses: false)
       raise AlreadyRegisteredError, "API description #{as} is already registered" if registry.key?(as)
 
       oad = filepath.is_a?(Hash) ? OpenapiFirst.parse(filepath) : OpenapiFirst.load(filepath)
       registry[as] = oad
+      configurations[as] = { allow_partial_responses: }
+    rescue OpenapiFirst::FileNotFoundError => e
+      raise Faraday::Openapi::FileNotFoundError, e.message
     end
 
     def self.[](key)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: faraday-openapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andreas Haller
 bindir: bin
 cert_chain: []
-date: 2025-05-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -35,20 +35,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 3.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 3.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://codeberg.org/ahx/faraday-openapi/issues
   changelog_uri: https://codeberg.org/ahx/faraday-openapi/src/branch/main/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-openapi/0.4.0
+  documentation_uri: http://www.rubydoc.info/gems/faraday-openapi/0.6.0
   homepage_uri: https://codeberg.org/ahx/faraday-openapi
   rubygems_mfa_required: 'true'
   source_code_uri: https://codeberg.org/ahx/faraday-openapi
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Validate requests/responses against OpenAPI API descriptions
 test_files: []