faraday-openapi 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f4f143b7d1bfe03b425ccb2b7f9551c0f1432495fd49dd9c98f1308a3099901
-  data.tar.gz: 9c0d8e7542a3144f933fdf292ae1fdabfe1a5210a9cea55ac8e035fe769046fb
+  metadata.gz: c5288681710835ea083d20cd469415b3cba5a880cb535692419a0090c0e1432f
+  data.tar.gz: 8e4cbe4290b598c8f9fdb5f15eb1505070c83e1dc8bbc91761a01fb9401d4913
 SHA512:
-  metadata.gz: 989d36d2f1704d3bbfa45630eac87f0cf992c7d9f2d3e50fe9a5c5aa840ed0065b6e0b6cf5eaba87b30c0c3d6c9c2cbe2a88bf5d5cc77692dae7f7935b40381b
-  data.tar.gz: a4d6196f44f0df42271dc88c266797a7238c14f9d10bf6322955353d2dc8f78397dec5041f8124c90f94df6bf703ab076f85b9f46ce870877bfffd618ae1e056
+  metadata.gz: a7e2eb94fdc7d4e6b96d03485cc6364f7f49d6ab4eb1b13928e03015734e40dcf84cfa21e323935794d23d036bc02945926ffb00a007694e1bf7af00d2919707
+  data.tar.gz: 23cfeddcd5ff1dd3cdf7512ae08780799b15bc4ddab990f7edc1246bde72b4cd167bc7b3f8fba76637f702047ec61945b64c5d6eb34ae3fd1808ab80ec1a6c1f

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.3.0
+
+- Breaking change: Use `Faraday::Openapi.enabled=` instead of `Faraday::Openapi::Middleware.enabled=`
+- Fix: Make `f.request :openapi` handle only request, not response validation
+- Support passing a Hash to .register
+
 ## 0.2.0
 
 - Add Faraday::Openapi.register to easily load, cache and reference OADs

data/README.md

@@ -41,7 +41,7 @@ require 'faraday/openapi'
 Faraday::Openapi.register 'dice-openapi.yaml', as: :dice_api
 
 # Only activate in test env
-Faraday::Openapi::Middleware.enabled = ENV['RACK_ENV'] == 'test'
+Faraday::Openapi.enabled = ENV['RACK_ENV'] == 'test'
 ```
 
 ```ruby
@@ -63,10 +63,10 @@ conn = Faraday.new do |f|
 end
 ```
 
-You can disable the whole middleware globally via Faraday's conventional default_options as well:
+You can disable all middlewares in this gem globally, which you probably want to do on production.
 
 ```ruby
-Faraday::Openapi::Middleware.default_options[:enabled] = false
+Faraday::Openapi.enabled = false
 ```
 
 

data/lib/faraday/openapi/middleware.rb

@@ -7,39 +7,24 @@ require_relative 'response'
 
 module Faraday
   module Openapi
-    # This class provides the main implementation for your middleware.
-    # Your middleware can implement any of the following methods:
-    # * on_request - called when the request is being prepared
-    # * on_complete - called when the response is being processed
-    #
-    # Optionally, you can also override the following methods from Faraday::Middleware
-    # * initialize(app, options = {}) - the initializer method
-    # * call(env) - the main middleware invocation method.
-    #   This already calls on_request and on_complete, so you normally don't need to override it.
-    #   You may need to in case you need to "wrap" the request or need more control
-    #   (see "retry" middleware: https://github.com/lostisland/faraday-retry/blob/41b7ea27e30d99ebfed958abfa11d12b01f6b6d1/lib/faraday/retry/middleware.rb#L147).
-    #   IMPORTANT: Remember to call `@app.call(env)` or `super` to not interrupt the middleware chain!
-    class Middleware < Faraday::Middleware
-      DEFAULT_OPTIONS = { enabled: true }.freeze
-
-      def self.enabled=(bool)
-        Faraday::Openapi::Middleware.default_options[:enabled] = bool
-      end
-
+    # Methods for all middlewares
+    module Base
       def initialize(app, path = :default)
         super(app)
-        @enabled = options.fetch(:enabled, true)
-        return unless @enabled
+        return unless Openapi.enabled
 
         @oad = path.is_a?(Symbol) ? Faraday::Openapi[path] : OpenapiFirst.load(path)
       end
 
       def call(env)
-        return app.call(env) unless @enabled
+        return app.call(env) unless Openapi.enabled
 
         super
       end
+    end
 
+    # on_request method to handle request validation
+    module RequestValidation
       # This method will be called when the request is being prepared.
       # You can alter it as you like, accessing things like request_body, request_headers, and more.
       # Refer to Faraday::Env for a list of accessible fields:
@@ -52,7 +37,10 @@ module Faraday
       rescue OpenapiFirst::RequestInvalidError => e
         raise RequestInvalidError, e.message
       end
+    end
 
+    # on_complete method to handle response validation
+    module ResponseValidation
       # This method will be called when the response is being processed.
       # You can alter it as you like, accessing things like response_body, response_headers, and more.
       # Refer to Faraday::Env for a list of accessible fields:
@@ -69,5 +57,21 @@ module Faraday
         raise ResponseInvalidError, e.message
       end
     end
+
+    class Middleware < Faraday::Middleware
+      include Base
+      include RequestValidation
+      include ResponseValidation
+    end
+
+    class RequestMiddleware < Faraday::Middleware
+      include Base
+      include RequestValidation
+    end
+
+    class ResponseMiddleware < Faraday::Middleware
+      include Base
+      include ResponseValidation
+    end
   end
 end

data/lib/faraday/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Openapi
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/faraday/openapi.rb

@@ -16,19 +16,22 @@ module Faraday
     # * conn.use Faraday::Openapi::Middleware
     # * conn.use :openapi
     Faraday::Middleware.register_middleware(openapi: Faraday::Openapi::Middleware)
-    Faraday::Request.register_middleware(openapi: Faraday::Openapi::Middleware)
-    Faraday::Response.register_middleware(openapi: Faraday::Openapi::Middleware)
+    Faraday::Request.register_middleware(openapi: Faraday::Openapi::RequestMiddleware)
+    Faraday::Response.register_middleware(openapi: Faraday::Openapi::ResponseMiddleware)
 
     @registry = {}
+    @enabled = true
 
     class << self
       attr_reader :registry
+      attr_accessor :enabled
     end
 
     def self.register(filepath, as: :default)
       raise AlreadyRegisteredError, "API description #{as} is already registered" if registry.key?(as)
 
-      registry[as] = OpenapiFirst.load(filepath)
+      oad = filepath.is_a?(Hash) ? OpenapiFirst.parse(filepath) : OpenapiFirst.load(filepath)
+      registry[as] = oad
     end
 
     def self.[](key)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: faraday-openapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andreas Haller
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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.2.0
+  documentation_uri: http://www.rubydoc.info/gems/faraday-openapi/0.3.0
   homepage_uri: https://codeberg.org/ahx/faraday-openapi
   rubygems_mfa_required: 'true'
   source_code_uri: https://codeberg.org/ahx/faraday-openapi