faraday-openapi 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124fb060a81c107c6ab137815d17b225a8aed4dff872525d097012cfd89316a2
-  data.tar.gz: 84347db962ab71d9022d214b8e887e14f5d9f2c844316d39bedea58869493f00
+  metadata.gz: 5d3c71ef695361f23541f335033fdf9b508711d99638deafe46b15e85fa6c21f
+  data.tar.gz: 196061fad20d239b70243f23e666d1e319a556210b9dd50e46ee9ba1596f9e33
 SHA512:
-  metadata.gz: 074fcb13c202c0dc1cb15c985e748d59d5616d99fd3e3324413f3e64f97d40134c918aa5d8bc8f5ab71e27391572378194974ef2cc6abfdcab755974d3b265b7
-  data.tar.gz: 17f3913b1ab7faa712bf7b9d441ce2b404ddcd5c36386a3aacd2c901445c1d2acaeef3bb3d8b2dc680dd528423587ea30242c00c300f0e723db10cde562ce145
+  metadata.gz: 6e19aafe69037f5073a16d007c9e2147e0112b73ab22fe551614fb6f2885f55b3c7592b1ac46a26e862a7664ba8381dd2ef04549034f8ecc72452b5c2131ae11
+  data.tar.gz: '078590082998dece96c35935a23489c550d802478a82cf992a2e2402f49330e0954601f441e27536e6bd31f88b5ba0bb50ce531c1512bfac2db216dcc232dfa7'

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 0.8.0
+- New Feature: `Faraday::Openapi.register` now takes a `source:` option where you can pass an URL. If the registered file does not exist it will fetch the file from that URL. You can call `Faraday::Openapi.update_registered` to update the registered files.
+- Breaking Change: You know have to user `Faraday::Openapi.register` before using the middleware. Passing a filepath like `f.use :openapi, 'my-openapi.yaml` is no longer supported
+
 ## 0.7.1
 - Fix an issue with unknown responses (like unknown content-type) when partial_responses are allowed
 

data/README.md

@@ -74,6 +74,16 @@ You can disable all middlewares in this gem globally, which you want to do on pr
 Faraday::Openapi.enabled = false
 ```
 
+### Working with remote OADs
+You can define the origin of the used OAD via the :source option:
+
+```rb
+Faraday::Openapi.register 'consumed/dice.yaml', as: :dice_api, source: 'http://localhost:8080/apis/dice/openapi.yaml',
+```
+
+If 'consumed/dice.yaml' does NOT exist, it will try to download the file from the defined source.
+You can call `Faraday::Openapi.update_registered` to re-download all registered files.
+
 
 ## Development
 
@@ -83,9 +93,6 @@ 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).

data/lib/faraday/openapi/middleware.rb

@@ -9,12 +9,12 @@ module Faraday
   module Openapi
     # Methods for all middlewares
     module Base
-      def initialize(app, path = :default)
+      def initialize(app, name = :default)
         super(app)
         return unless Openapi.enabled
 
-        @oad = path.is_a?(Symbol) ? Faraday::Openapi[path] : OpenapiFirst.load(path)
-        @configuration = Faraday::Openapi.configurations[path]
+        @config = Faraday::Openapi[name]
+        @oad = @config.oad
       end
 
       def call(env)
@@ -67,7 +67,7 @@ module Faraday
       end
 
       def partial_mocking_enabled?
-        @configuration && @configuration[:allow_partial_responses]
+        @config&.allow_partial_responses
       end
     end
 

data/lib/faraday/openapi/request.rb

@@ -7,7 +7,7 @@ module Faraday
     # @visibility private
     # Build a Rack::Request from a Faraday::Env
     module Request
-      def self.from_env(env) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def self.from_env(env) # rubocop:disable Metrics/MethodLength
         if env.request_body.is_a?(Hash)
           raise Error,
                 'env.body is a Hash. You probably want to convert the request body ' \

data/lib/faraday/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Openapi
-    VERSION = '0.7.1'
+    VERSION = '0.8.0'
   end
 end

data/lib/faraday/openapi.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+require 'logger'
 require 'openapi_first'
 require_relative 'openapi/errors'
 require_relative 'openapi/middleware'
@@ -20,29 +22,72 @@ module Faraday
     Faraday::Response.register_middleware(openapi: Faraday::Openapi::ResponseMiddleware)
 
     @registry = {}
-    @configurations = {}
     @enabled = true
+    @logger = Logger.new(
+      $stdout,
+      formatter: proc do |_severity, _datetime, _progname, msg|
+        "Faraday::Openapi: #{msg}\n"
+      end
+    )
 
     class << self
-      attr_reader :registry, :configurations
-      attr_accessor :enabled
+      attr_reader :registry
+      attr_accessor :enabled, :logger
+
+      private
+
+      def connection
+        @connection ||= Faraday.new(request: {
+                                      open_timeout: 5,
+                                      timeout: 5
+                                    }) do |f|
+          f.response :raise_error, include_request: true
+        end
+      end
+
+      def download(name, from:, to:)
+        filepath = to
+        url = from
+        FileUtils.mkdir_p(File.dirname(filepath))
+        File.write(filepath, connection.get(url).body)
+        logger.info(
+          "#{self.class.name} loaded API description for #{name.inspect} " \
+          "from #{url.inspect} to #{filepath.inspect}"
+        )
+      rescue Faraday::Error => e
+        raise Faraday::Openapi::Error,
+              "I was not able to download the OAD for #{name.inspect}  from #{url}: #{e.message}"
+      end
     end
 
-    def self.register(filepath, as: :default, allow_partial_responses: false)
+    Registered = Struct.new(:oad, :allow_partial_responses, :source, :filepath)
+    private_constant :Registered
+
+    def self.register(filepath, as: :default, allow_partial_responses: false, source: nil)
       raise AlreadyRegisteredError, "API description #{as} is already registered" if registry.key?(as)
 
+      download(as, from: source, to: filepath) if source && !File.exist?(filepath)
+
       oad = filepath.is_a?(Hash) ? OpenapiFirst.parse(filepath) : OpenapiFirst.load(filepath)
-      registry[as] = oad
-      configurations[as] = { allow_partial_responses: }
+      registry[as] = Registered.new(oad:, allow_partial_responses:, source:, filepath:)
+      self
     rescue OpenapiFirst::FileNotFoundError => e
       raise Faraday::Openapi::FileNotFoundError, e.message
     end
 
+    def self.update_registered
+      registry.each do |name, config|
+        next unless config.source
+
+        download(name, from: config.source, to: config.filepath)
+      end
+    end
+
     def self.[](key)
       registry.fetch(key) do
         message = if registry.empty?
                     'No API descriptions have been registered. Please register your API description via ' \
-                      "Faraday::Openapi.register('myopenapi.yaml')"
+                      "Faraday::Openapi.register('myopenapi.yaml') before using the middleware"
                   else
                     "API description #{key.inspect} was not found. Please register your API description via " \
                       "Faraday::Openapi.register('myopenapi.yaml'#{key == :default ? '' : ", as: #{key.inspect}"})"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-openapi
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Andreas Haller
@@ -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.7.1
+  documentation_uri: http://www.rubydoc.info/gems/faraday-openapi/0.8.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: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Validate requests/responses against OpenAPI API descriptions
 test_files: []