faraday-openapi 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cecade70e78308caa40373dfb520b6fa3f970c7113e62ce116c3a8dde4404bfd
-  data.tar.gz: ee5789e11fd934282384fe8a92d0a9370ca865c5aa08cfcaa25d53d5aa1306fd
+  metadata.gz: 5e437d23f0221b37e8eecc7cafa6ea93fbc34fa5e1c85a88e9132bec56f56f2a
+  data.tar.gz: d961589d81e7f8359fcaefd09bf0d82037afd3c2431d2b481e8a26e0472bdc4a
 SHA512:
-  metadata.gz: 31210ba4b06e64ff1886548d6eba1d3a41c5aa19ad5027b8116331df8f9f83ee5242dd4a73c50bfc1c98dc648c8c2e3f29fad29078e1186bb31dca0c6f54d701
-  data.tar.gz: cf51b54547212804022fec02f6efc172b2a2b9dc4dc394107d1053055de989eb8d2ad52b78f6c98e1a8739f5718de606fe33f974ae5493c185ce35025f0f5269
+  metadata.gz: c1d42c5151bb776b5e36a1536f76316e9330d704dc80cf4fdfda6bc5731a2490fae727dc17463679b573f34ebc5fd5f96dbd618f81beb965a1dae4eac0e1cdca
+  data.tar.gz: 9f11cf5ed8550bfa405007aca347f3408595a1f3fc1652a2853d834bed80cbb2d9baabaff4e84fa57e2e6a9d3e3315531cb5cbd6cfe884cf6fe48941478c528b

data/CHANGELOG.md

@@ -2,9 +2,11 @@
 
 ## Unreleased
 
-## 0.9.0
+## 0.9.1
 
-- Faraday::Openapi.register is a no-op if the middleware is not enabled (Faraday::Openapi.enabled returns false)
+- Changed: `Faraday::Openapi.register` is lazy now. It load or downloads the API description on first use. A failed download now raises on first use of the API description instead of in `register`.
+
+## 0.9.0 (yanked)
 
 ## 0.8.3
 

data/README.md

@@ -31,8 +31,8 @@ bundle install
 
 ## Usage
 
-In order to avoid loading YAML files at inappropriate times you should
-register your API description (OAD) globally and reference it via a Symbol in your client code
+Register your API description (OAD) globally and reference it via a Symbol in your client code.
+Registering is cheap: the OAD is loaded on first use.
 
 ```ruby
 # initializer.rb
@@ -81,7 +81,7 @@ You can define the origin of the used OAD via the :source option:
 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.
+If 'consumed/dice.yaml' does NOT exist, it will download the file from the defined source on first use.
 You can call `Faraday::Openapi.update_registered` to re-download all registered files.
 
 

data/lib/faraday/openapi/registered.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'rack'
+
+module Faraday
+  module Openapi
+    Registered = Struct.new(:name, :allow_partial_responses, :source, :filepath) do
+      def oad
+        download if source && !File.exist?(filepath)
+        @oad ||= filepath.is_a?(Hash) ? OpenapiFirst.parse(filepath) : OpenapiFirst.load(filepath)
+      rescue OpenapiFirst::FileNotFoundError => e
+        raise Faraday::Openapi::FileNotFoundError, e.message
+      end
+
+      def update!
+        download
+        @oad = nil
+      end
+
+      private
+
+      def download
+        FileUtils.mkdir_p(File.dirname(filepath))
+        File.write(filepath, connection.get(source).body)
+        Openapi.logger.info("Loaded API description for #{name.inspect} from #{source.inspect}")
+      rescue Faraday::Error => e
+        raise Faraday::Openapi::Error,
+              "I was not able to download the OAD for #{name.inspect}  from #{source}: #{e.message}"
+      end
+
+      def connection
+        Faraday.new(request: { open_timeout: 5, timeout: 5 }) do |f|
+          f.response :raise_error, include_request: true
+        end
+      end
+    end
+  end
+end

data/lib/faraday/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Openapi
-    VERSION = '0.9.0'
+    VERSION = '0.9.1'
   end
 end

data/lib/faraday/openapi.rb

@@ -5,6 +5,7 @@ require 'logger'
 require 'openapi_first'
 require_relative 'openapi/errors'
 require_relative 'openapi/middleware'
+require_relative 'openapi/registered'
 require_relative 'openapi/version'
 
 module Faraday
@@ -33,55 +34,21 @@ module Faraday
     class << self
       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(
-          "Loaded API description for #{name.inspect} from #{url.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
 
-    Registered = Struct.new(:oad, :allow_partial_responses, :source, :filepath)
-    private_constant :Registered
-
     def self.register(filepath, as: :default, allow_partial_responses: false, source: nil)
-      return unless enabled
-
       raise AlreadyRegisteredError, "API description #{as} is already registered" if registry.key?(as)
 
-      download(as, from: source, to: filepath) if source && !File.exist?(filepath)
+      if source.nil? && filepath.is_a?(String) && !File.exist?(filepath)
+        raise Faraday::Openapi::FileNotFoundError, "File not found: #{filepath}"
+      end
 
-      oad = filepath.is_a?(Hash) ? OpenapiFirst.parse(filepath) : OpenapiFirst.load(filepath)
-      registry[as] = Registered.new(oad:, allow_partial_responses:, source:, filepath:)
+      registry[as] = Registered.new(name: as, 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
+      registry.each_value { |registered| registered.update! if registered.source }
     end
 
     def self.[](key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-openapi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Andreas Haller
@@ -84,6 +84,7 @@ files:
 - lib/faraday/openapi.rb
 - lib/faraday/openapi/errors.rb
 - lib/faraday/openapi/middleware.rb
+- lib/faraday/openapi/registered.rb
 - lib/faraday/openapi/request.rb
 - lib/faraday/openapi/response.rb
 - lib/faraday/openapi/version.rb
@@ -93,7 +94,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.9.0
+  documentation_uri: http://www.rubydoc.info/gems/faraday-openapi/0.9.1
   homepage_uri: https://codeberg.org/ahx/faraday-openapi
   rubygems_mfa_required: 'true'
   source_code_uri: https://codeberg.org/ahx/faraday-openapi