reynard 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb3f70f5fd68cbe19747d08687715165595d29a6b81da3329a975cac30bd3cbe
-  data.tar.gz: 73020e57c19507af7ac13b9bc509d3a4b7ac3ae9b74866d7f783cc816436039f
+  metadata.gz: d85681365ddb46b06c062b39bdea10bf46810d80d813c9737df0ee3aeb38e843
+  data.tar.gz: '007908692ed0a3c437befba30a29d0f694429033097b7ae47ca2aaf7050c05ea'
 SHA512:
-  metadata.gz: d5289ec587b945a0a858537569a4543e9bbfb3daa6dcb8e11cc409d620b89c1d85406d4a1fa0d20dcccc4c00eddcc6ff4b03f5ae24feff865f4cb62661f09638
-  data.tar.gz: af30bf905849a2589e091b0b9655e52375db08ea00f0b28365029900b4101c5d4b94822b30a17b3a1b8e35329886b61cf857fa6d8de1ff6a16fd56ca0dc2a904
+  metadata.gz: 1e23bf2702660623a61039bb8444ea3e0f4bdd7eaceab42d22dbca2ea157e705a54af69558ce84812d4ef2f13c1330071781e8da61d3ed44c8b0d2a944816752
+  data.tar.gz: 9e973c551d30a6b7e6ab8ef494d270b5dac05dfd96de86c49448c5889b070a07ee8d8aa486de1f80c3d372c73ed7b11e37da49625fdeb64d21e84352130e55f3

data/README.md

@@ -81,6 +81,22 @@ response['Content-Type'] #=> 'application/json'
 response.body #=> '{"name":"Sam Seven"}'
 ```
 
+## Logging
+
+When you want to know what the Reynard client is doing you can enable logging.
+
+```ruby
+logger = Logger.new($stdout)
+logger.level = Logger::INFO
+reynard.logger(logger).execute
+```
+
+The logging should be compatible with the Ruby on Rails logger.
+
+```ruby
+reynard.logger(Rails.logger).execute
+```
+
 ## Mocking
 
 You can mock Reynard requests by changing the HTTP implementation. The class **must** implement a single `request` method that accepts an URI and net/http request object. It **must** return a net/http response object or an object with the exact same interface.
@@ -97,4 +113,4 @@ end
 
 ## Copyright and other legal
 
-See LICENCE.
+See LICENCE.

data/lib/reynard/context.rb

@@ -42,6 +42,10 @@ class Reynard
       copy(headers: @request_context.headers.merge(headers))
     end
 
+    def logger(logger)
+      copy(logger: logger)
+    end
+
     def execute
       build_response(build_request.perform)
     end

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,50 +15,23 @@ class Reynard
       end
 
       def perform
+        @request_context.logger&.info { "#{@request_context.verb.upcase} #{uri}" }
         Reynard.http.request(uri, build_request)
       end
 
       private
 
-      def build_request
-        case @request_context.verb
-        when 'get'
-          build_http_get
-        when 'post'
-          build_http_post
-        when 'put'
-          build_http_put
-        when 'patch'
-          build_http_patch
-        when 'delete'
-          build_http_delete
-        end
-      end
-
-      def build_http_get
-        Net::HTTP::Get.new(uri, @request_context.headers)
-      end
-
-      def build_http_post
-        post = Net::HTTP::Post.new(uri, @request_context.headers)
-        post.body = @request_context.body
-        post
+      def request_class
+        Net::HTTP.const_get(@request_context.verb.capitalize)
       end
 
-      def build_http_put
-        put = Net::HTTP::Put.new(uri, @request_context.headers)
-        put.body = @request_context.body
-        put
-      end
-
-      def build_http_patch
-        patch = Net::HTTP::Patch.new(uri, @request_context.headers)
-        patch.body = @request_context.body
-        patch
-      end
-
-      def build_http_delete
-        Net::HTTP::Delete.new(uri, @request_context.headers)
+      def build_request
+        request = request_class.new(uri, @request_context.headers)
+        if @request_context.body
+          @request_context.logger&.debug { @request_context.body }
+          request.body = @request_context.body
+        end
+        request
       end
     end
   end

data/lib/reynard/object_builder.rb

@@ -46,7 +46,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,

data/lib/reynard/specification.rb

@@ -102,11 +102,14 @@ 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
 
     private
@@ -117,6 +120,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,12 +131,23 @@ 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')

data/lib/reynard/version.rb

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

data/lib/reynard.rb

@@ -11,12 +11,14 @@ 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'
   autoload :MediaType, 'reynard/media_type'
   autoload :Model, 'reynard/model'
   autoload :Models, 'reynard/models'
@@ -34,9 +36,9 @@ class Reynard
     @specification = Specification.new(filename: filename)
   end
 
-  # Assign an object that follows Reynard's internal request interface to mock requests or use a
-  # different HTTP client.
   class << self
+    # Assign an object that follows Reynard's internal request interface to mock requests or use a
+    # different HTTP client.
     attr_writer :http
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -121,6 +121,7 @@ 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