faraday-openapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 179cc13a116b7e00f6a1e36d860ae280235e2d8693407cdb31e4b4cca624234b
+  data.tar.gz: 14fdb596d1505e47cf59394302c907f02e5f43b2e60a2fe1dc1e278760959f0d
+SHA512:
+  metadata.gz: a190ea86e84c6263c5150057d4b749320076b078d799b528f1ddca0bc345da0e82eb99deeb1fe24580e939de2a120f8da87e910800860fd03252d4efef6bff49
+  data.tar.gz: 4e9bad10ef7d26b02fb07b3645fd7a926e18a541ddbcf5b85b3456d4a5a78e42e58cba85947e1e2e63e76500bb600e1dfff22a582bf30d2bbddd638c28fe49c3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0
+
+Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Andreas Haller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Faraday Openapi
+
+Validate requests/responses against OpenAPI API descriptions.
+
+This middleware raises an error if the request or response does not match the given API description.
+You can use this to test your client code or to make sure your mocks do match the actual implementation, described in the API description.
+
+Note that the middleware currently deliberately ignores **unknown** responses with status codes 401 or higher because those usually don't come with a useful response body.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-openapi'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-openapi
+```
+
+## Usage
+
+```ruby
+require 'faraday/openapi'
+
+conn = Faraday.new do |f|
+  f.use :openapi, 'openapi/openapi.yaml'
+end
+
+# Or validate only requests
+conn = Faraday.new do |f|
+  f.request :openapi, 'openapi/openapi.yaml'
+end
+
+# Or validate only responses
+conn = Faraday.new do |f|
+  f.response :openapi, 'openapi/openapi.yaml'
+end
+```
+
+You can disable the whole middleware globally:
+
+```ruby
+Faraday::Openapi::Middleware.default_options[:enabled] = false
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [Codeberg](https://codeberg.org/ahx/faraday-openapi).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/openapi/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Openapi
+    # Base class for all errors
+    class Error < StandardError; end
+
+    # Raised if request does not match API description or is unknown
+    class RequestInvalidError < Error; end
+
+    # Raised if response does not match API description or is unknown
+    class ResponseInvalidError < Error; end
+  end
+end

data/lib/faraday/openapi/middleware.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'openapi_first'
+require_relative 'request'
+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 initialize(app, filepath)
+        super(app)
+        @filepath = filepath
+        @enabled = options.fetch(:enabled, true)
+        @oad = OpenapiFirst.load(filepath) if @enabled
+      end
+
+      def call(env)
+        return app.call(env) unless @enabled
+
+        super
+      end
+
+      # 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:
+      # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      #
+      # @param env [Faraday::Env] the environment of the request being processed
+      def on_request(env)
+        request = Request.from_env(env)
+        @oad.validate_request(request, raise_error: true)
+      rescue OpenapiFirst::RequestInvalidError => e
+        raise RequestInvalidError, e.message
+      end
+
+      # 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:
+      # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      #
+      # @param env [Faraday::Env] the environment of the response being processed.
+      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)
+
+        raise ResponseInvalidError, e.message
+      end
+    end
+  end
+end

data/lib/faraday/openapi/request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Faraday
+  module Openapi
+    # @visibility private
+    # Build a Rack::Request from a Faraday::Env
+    module Request
+      def self.from_env(env) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        if env.request_body.is_a?(Hash)
+          raise Error,
+                'env.body is a Hash. You probably want to convert the request body ' \
+                'to JSON before calling the Faraday openapi middleware.'
+        end
+
+        rack_env = {
+          'REQUEST_METHOD' => env.method.to_s.upcase,
+          'PATH_INFO' => env.url.path,
+          'QUERY_STRING' => env.url.query || '',
+          'SERVER_NAME' => env.url.host,
+          'SERVER_PORT' => env.url.port.to_s,
+          'rack.url_scheme' => env.url.scheme,
+          'rack.input' => StringIO.new(env.request_body || '')
+        }
+
+        env.request_headers.each do |key, value|
+          rack_env["HTTP_#{key.upcase.tr('-', '_')}"] = value
+        end
+
+        Rack::Request.new(rack_env)
+      end
+    end
+  end
+end

data/lib/faraday/openapi/response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Faraday
+  module Openapi
+    # @visibility private
+    # Build a Rack::Response from a Faraday::Env
+    module Response
+      def self.from_env(env)
+        status = env.status
+        headers = env.response_headers
+        body = [env.response_body]
+
+        Rack::Response.new(body, status, headers)
+      end
+    end
+  end
+end

data/lib/faraday/openapi/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Openapi
+    VERSION = '0.1.0'
+  end
+end

data/lib/faraday/openapi.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'openapi/errors'
+require_relative 'openapi/middleware'
+require_relative 'openapi/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into Faraday::Openapi::Middleware for the correct namespacing.
+  module Openapi
+    # Faraday allows you to register your middleware for easier configuration.
+    # This step is totally optional, but it basically allows users to use a
+    # custom symbol (in this case, `:openapi`), to use your middleware in their connections.
+    # After calling this line, the following are both valid ways to set the middleware in a connection:
+    # * conn.use Faraday::Openapi::Middleware
+    # * conn.use :openapi
+    # Without this line, only the former method is valid.
+    Faraday::Middleware.register_middleware(openapi: Faraday::Openapi::Middleware)
+    Faraday::Request.register_middleware(openapi: Faraday::Openapi::Middleware)
+    Faraday::Response.register_middleware(openapi: Faraday::Openapi::Middleware)
+
+    # Alternatively, you can register your middleware under Faraday::Request or Faraday::Response.
+    # This will allow to load your middleware using the `request` or `response` methods respectively.
+    #
+    # Load middleware with conn.request :openapi
+    # Faraday::Request.register_middleware(openapi: Faraday::Openapi::Middleware)
+    #
+    # Load middleware with conn.response :openapi
+    # Faraday::Response.register_middleware(openapi: Faraday::Openapi::Middleware)
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: faraday-openapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Haller
+bindir: bin
+cert_chain: []
+date: 2025-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: openapi_first
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 'Validate requests/responses against OpenAPI API descriptions.
+
+  '
+email:
+- andreas.haller@posteo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/openapi.rb
+- lib/faraday/openapi/errors.rb
+- lib/faraday/openapi/middleware.rb
+- lib/faraday/openapi/request.rb
+- lib/faraday/openapi/response.rb
+- lib/faraday/openapi/version.rb
+homepage: https://codeberg.com/ahx/faraday-openapi
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://codeberg.com/ahx/faraday-openapi/issues
+  changelog_uri: https://codeberg.com/ahx/faraday-openapi/src/branch/main/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-openapi/0.1.0
+  homepage_uri: https://codeberg.com/ahx/faraday-openapi
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://codeberg.com/ahx/faraday-openapi
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Validate requests/responses against OpenAPI API descriptions
+test_files: []