reynard 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee7b44612f3b8e0fec7a0a3d1e18bc30366d1bea3470a8b3eb46a8d6180c85cd
-  data.tar.gz: e6c9629439a36c50ff214f932d5997ce004b21d12a1c71a6c727ab7ef38d722a
+  metadata.gz: 891b142e2ca908078c960db4b36040b407974da43395d02b7ee3f768a1c758b4
+  data.tar.gz: 5deefbad34c0364cfd3c3a04910b882499c3b96d7c4d642fdb10fbdcc3e9898f
 SHA512:
-  metadata.gz: 159960b7bb4e38673c00baa531e3586135dcabedadd50dbd12da55eee31b77ea4d4d7d182974144adf602128b664e5d28f3c15c9e6d376f96774e78a45cdba2c
-  data.tar.gz: 5a7cbcc61c772858283855289f9b3a119b716c78994d16a4de6d5f34bc6921c633f023d362417657253885e6c35f157cb98d2771228e2790a0dff4df69bcc7f2
+  metadata.gz: 393b2cab7867c45c53b761f42b03e609e653600981aa1283cf3f7c0213379adb9a1eeb1530b3a0f826e07d1ceb5c3fab0d8afc114a2001ec773f71d2484bc109
+  data.tar.gz: c14ebcc55481c202c0c3c7b7dd36e68eb5b72f0297c0339867e6c298d4a3605284dff2e041d33b074c8c9e3b8064f450fdf481fa686e56c1e764af59a1050593

data/lib/reynard/external.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+class Reynard
+  # Loads external references.
+  class External
+    def initialize(path:, ref:)
+      @path = path
+      @relative_path, @anchor = ref.split('#', 2)
+    end
+
+    def path
+      return [] unless @anchor
+
+      @anchor.split('/')[1..]
+    end
+
+    def data
+      File.open(filename, encoding: 'UTF-8') do |file|
+        YAML.safe_load(file, aliases: true)
+      end
+    end
+
+    private
+
+    def filename
+      filename = File.expand_path(@relative_path, @path)
+      return filename if filename.start_with?(@path)
+
+      raise 'You are only allowed to reference files relative to the specification file.'
+    end
+  end
+end

data/lib/reynard/http/request.rb

@@ -15,7 +15,7 @@ class Reynard
       end
 
       def perform
-        @request_context.logger.info { "#{@request_context.verb.upcase} #{uri}" }
+        @request_context.logger&.info { "#{@request_context.verb.upcase} #{uri}" }
         Reynard.http.request(uri, build_request)
       end
 
@@ -28,7 +28,7 @@ class Reynard
       def build_request
         request = request_class.new(uri, @request_context.headers)
         if @request_context.body
-          @request_context.logger.debug { @request_context.body }
+          @request_context.logger&.debug { @request_context.body }
           request.body = @request_context.body
         end
         request

data/lib/reynard/object_builder.rb

@@ -14,6 +14,8 @@ class Reynard
     def object_class
       if @media_type.schema_name
         self.class.model_class(@media_type.schema_name, @schema.object_type)
+      elsif @schema.object_type == 'array'
+        Array
       else
         Reynard::Model
       end
@@ -46,7 +48,7 @@ class Reynard
     end
 
     def self.model_class_get(name)
-      Reynard::Models.const_get(name)
+      Kernel.const_get("::Reynard::Models::#{name}")
     rescue NameError
       nil
     end

data/lib/reynard/request_context.rb

@@ -3,6 +3,7 @@
 class Reynard
   # Value class for details about the request.
   RequestContext = Struct.new(
+    :logger,
     :base_url,
     :operation,
     :headers,
@@ -10,14 +11,6 @@ class Reynard
     :body,
     keyword_init: true
   ) do
-    attr_writer :logger
-
-    def logger
-      @logger = nil unless defined?(@logger)
-
-      Reynard::Logger.new(@logger)
-    end
-
     def verb
       operation&.verb
     end

data/lib/reynard/specification.rb

@@ -102,11 +102,22 @@ class Reynard
 
     def self.normalize_model_name(name)
       # 1. Unescape encoded characters to create an UTF-8 string
-      # 2. Replace all non-alphabetic characters with a space (not allowed in Ruby constant)
-      # 3. Camelcase
+      # 2. Remove extensions for regularly used external schema files
+      # 3. Replace all non-alphabetic characters with a space (not allowed in Ruby constant)
+      # 4. Camelcase
       Rack::Utils.unescape_path(name)
+                 .gsub(/(.yml|.yaml|.json)\Z/, '')
                  .gsub(/[^[:alpha:]]/, ' ')
                  .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
+                 .gsub(/\A(.)/) { Regexp.last_match(1).upcase }
+    end
+
+    def self.normalize_model_title(title)
+      title
+        .gsub(/[^[:alpha:]]/, ' ')
+        .gsub(/\s{2,}/, ' ')
+        .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
+        .strip
     end
 
     private
@@ -117,6 +128,9 @@ class Reynard
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength
     def dig_into(data, cursor, path)
       while path.length.positive?
         cursor = cursor[path.first]
@@ -125,25 +139,44 @@ class Reynard
         path.shift
         next unless cursor.respond_to?(:key?) && cursor&.key?('$ref')
 
-        # We currenly only supply references inside the document starting with #/.
-        path = Rack::Utils.unescape_path(cursor['$ref'][2..]).split('/') + path
-        cursor = data
+        case cursor['$ref']
+        # References another element in the current specification.
+        when %r{\A#/}
+          path = Rack::Utils.unescape_path(cursor['$ref'][2..]).split('/') + path
+          cursor = data
+        # References another file, with an optional anchor to an element in the data.
+        when %r{\A\./}
+          external = External.new(path: File.dirname(@filename), ref: cursor['$ref'])
+          path = external.path + path
+          cursor = external.data
+        end
       end
       cursor
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
 
     def schema_name(response)
-      ref = response.dig('schema', '$ref')
-      return unless ref
-
-      self.class.normalize_model_name(ref&.split('/')&.last)
+      extract_schema_name(response['schema'])
     end
 
     def item_schema_name(schema)
-      ref = schema.dig('items', '$ref')
-      return unless ref
+      if schema['type'] == 'array'
+        extract_schema_name(schema['items'])
+      else
+        extract_schema_name(schema)
+      end
+    end
+
+    def extract_schema_name(definition)
+      ref = definition['$ref']
+      return self.class.normalize_model_name(ref&.split('/')&.last) if ref
+
+      title = definition['title']
+      return unless title
 
-      self.class.normalize_model_name(ref&.split('/')&.last)
+      self.class.normalize_model_title(title)
     end
   end
 end

data/lib/reynard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Reynard
-  VERSION = '0.4.0'
+  VERSION = '0.5.1'
 end

data/lib/reynard.rb

@@ -11,10 +11,11 @@ require 'uri'
 # OpenAPI specification.
 class Reynard
   extend Forwardable
-  def_delegators :build_context, :base_url, :operation, :headers, :params
+  def_delegators :build_context, :logger, :base_url, :operation, :headers, :params
   def_delegators :@specification, :servers
 
   autoload :Context, 'reynard/context'
+  autoload :External, 'reynard/external'
   autoload :GroupedParameters, 'reynard/grouped_parameters'
   autoload :Http, 'reynard/http'
   autoload :Logger, 'reynard/logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -121,11 +121,11 @@ files:
 - README.md
 - lib/reynard.rb
 - lib/reynard/context.rb
+- lib/reynard/external.rb
 - lib/reynard/grouped_parameters.rb
 - lib/reynard/http.rb
 - lib/reynard/http/request.rb
 - lib/reynard/http/response.rb
-- lib/reynard/logger.rb
 - lib/reynard/media_type.rb
 - lib/reynard/model.rb
 - lib/reynard/models.rb
@@ -143,7 +143,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Minimal OpenAPI client.
 test_files: []

data/lib/reynard/logger.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-class Reynard
-  # Proxy class for a Logger object. Makes irrelevant logging actions a no-op.
-  class Logger
-    def initialize(logger)
-      @logger = logger
-    end
-
-    def debug(&block)
-      return unless @logger
-      return if @logger.level > ::Logger::DEBUG
-
-      @logger.debug(block.call)
-    end
-
-    def info(&block)
-      return unless @logger
-      return if @logger.level > ::Logger::INFO
-
-      @logger.info(block.call)
-    end
-  end
-end