reynard 0.0.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcfd5e665e0b3fcc8c593d81c15db9560e8abc0125e9a254aeb98d3f53b6fb8a
-  data.tar.gz: 61d7d812f5b5eacf55c9be3fb6463cf1adafeb5e7935d2d0fc0b20a33a4a27b3
+  metadata.gz: bb3f70f5fd68cbe19747d08687715165595d29a6b81da3329a975cac30bd3cbe
+  data.tar.gz: 73020e57c19507af7ac13b9bc509d3a4b7ac3ae9b74866d7f783cc816436039f
 SHA512:
-  metadata.gz: 05a42b85120cb3e519c4fcc3bad7c23a17e5c1a007072b22843421619b1460dabf378750fc83eea406a44a3ec0e08c80b309d53bdce2da0df09d6f3a67643685
-  data.tar.gz: d8e2ce1c77b097a4a3e4a64d8b3fd2d67bc0e8737307e9429452e4d794aedad7c34e7b44a76a1f4ac945f459a4f0497e67d354ebb37f2cb1fdece9e187981efd
+  metadata.gz: d5289ec587b945a0a858537569a4543e9bbfb3daa6dcb8e11cc409d620b89c1d85406d4a1fa0d20dcccc4c00eddcc6ff4b03f5ae24feff865f4cb62661f09638
+  data.tar.gz: af30bf905849a2589e091b0b9655e52375db08ea00f0b28365029900b4101c5d4b94822b30a17b3a1b8e35329886b61cf857fa6d8de1ff6a16fd56ca0dc2a904

data/README.md

@@ -40,7 +40,7 @@ reynard.base_url('http://test.example.com/v1')
 You also have access to all servers in the specification so you can automatically select one however you want.
 
 ```ruby
-base_url = @reynard.servers.map(&:url).find do |url|
+base_url = reynard.servers.map(&:url).find do |url|
   /staging/.match(url)
 end
 reynard.base_url(base_url)
@@ -51,7 +51,7 @@ reynard.base_url(base_url)
 Assuming there is an operation called `employeeByUuid` you can it as shown below.
 
 ```ruby
-employee = reynard.
+response = reynard.
   operation('employeeByUuid').
   params(uuid: uuid).
   execute
@@ -60,12 +60,41 @@ employee = reynard.
 When an operation requires a body, you can add it as structured data.
 
 ```ruby
-employee = reynard.
+response = reynard.
   operation('createEmployee').
   body(name: 'Sam Seven').
   execute
 ```
 
+In case the response matches a response in the specification it will attempt to build an object using the specified schema.
+
+```ruby
+response.object.name #=> 'Sam Seven'
+```
+
+The response object shared much of its interface with `Net::HTTP::Response`.
+
+```ruby
+response.code #=> '200'
+response.content_type #=> 'application/json'
+response['Content-Type'] #=> 'application/json'
+response.body #=> '{"name":"Sam Seven"}'
+```
+
+## 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.
+
+```ruby
+Reynard.http = MyMock.new
+
+class MyMock
+  def request(uri, net_http_request)
+    Net::HTTPResponse::CODE_TO_OBJ['404'].new('HTTP/1.1', '200', 'OK')
+  end
+end
+```
+
 ## Copyright and other legal
 
 See LICENCE.

data/lib/reynard/context.rb

@@ -43,7 +43,7 @@ class Reynard
     end
 
     def execute
-      build_object(build_request.perform)
+      build_response(build_request.perform)
     end
 
     private
@@ -63,32 +63,12 @@ class Reynard
       Reynard::Http::Request.new(request_context: @request_context)
     end
 
-    def build_object(http_response)
-      media_type = @specification.media_type(
-        @request_context.operation.node,
-        http_response.code,
-        http_response.content_type
-      )
-      if media_type
-        build_object_with_media_type(http_response, media_type)
-      else
-        build_object_without_media_type(http_response)
-      end
-    end
-
-    def build_object_with_media_type(http_response, media_type)
-      ObjectBuilder.new(
-        media_type: media_type,
-        schema: @specification.schema(media_type.node),
+    def build_response(http_response)
+      Reynard::Http::Response.new(
+        specification: @specification,
+        request_context: @request_context,
         http_response: http_response
-      ).call
-    end
-
-    def build_object_without_media_type(http_response)
-      # Try to parse the response as JSON and give up otherwise.
-      OpenStruct.new(MultiJson.load(http_response.body))
-    rescue StandardError
-      http_response.body
+      )
     end
   end
 end

data/lib/reynard/http/response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class Reynard
+  class Http
+    # Wraps an HTTP response and returns an object when it can find a definition for the response
+    # in the specification.
+    class Response
+      extend Forwardable
+      def_delegators :@http_response, :code, :content_type, :[], :body
+
+      def initialize(specification:, request_context:, http_response:)
+        @specification = specification
+        @request_context = request_context
+        @http_response = http_response
+      end
+
+      # Instantiates an object based on the schema that fits the response.
+      def object
+        return @object if defined?(@object)
+
+        @object = build_object
+      end
+
+      private
+
+      def build_object
+        media_type = @specification.media_type(
+          @request_context.operation.node,
+          @http_response.code,
+          @http_response.content_type
+        )
+        if media_type
+          build_object_with_media_type(media_type)
+        else
+          build_object_without_media_type
+        end
+      end
+
+      def build_object_with_media_type(media_type)
+        ObjectBuilder.new(
+          media_type: media_type,
+          schema: @specification.schema(media_type.node),
+          http_response: @http_response
+        ).call
+      end
+
+      def build_object_without_media_type
+        # Try to parse the response as JSON and give up otherwise.
+        Reynard::Model.new(MultiJson.load(@http_response.body))
+      rescue StandardError
+        @http_response.body
+      end
+    end
+  end
+end

data/lib/reynard/http.rb

@@ -3,5 +3,6 @@
 class Reynard
   class Http
     autoload :Request, 'reynard/http/request'
+    autoload :Response, 'reynard/http/response'
   end
 end

data/lib/reynard/object_builder.rb

@@ -15,7 +15,7 @@ class Reynard
       if @media_type.schema_name
         self.class.model_class(@media_type.schema_name, @schema.object_type)
       else
-        OpenStruct
+        Reynard::Model
       end
     end
 
@@ -23,7 +23,7 @@ class Reynard
       if @schema.item_schema_name
         self.class.model_class(@schema.item_schema_name, 'object')
       else
-        OpenStruct
+        Reynard::Model
       end
     end
 

data/lib/reynard/specification.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require 'rack'
+
 class Reynard
   # Wraps the YAML representation of an OpenAPI specification.
   class Specification
+    VERBS = %w[get put post delete options head patch trace].freeze
+
     def initialize(filename:)
       @filename = filename
       @data = read
@@ -30,7 +34,15 @@ class Reynard
     def build_grouped_params(operation_node, params)
       return {} unless params
 
-      GroupedParameters.new(dig(*operation_node, 'parameters'), params).to_h
+      GroupedParameters.new(
+        [
+          # Parameters can be shared between methods on a path or be specific to an operation. The
+          # parameters on the operation level override those at the path level.
+          dig(*operation_node, 'parameters'),
+          dig(*operation_node[..-2], 'parameters')
+        ].compact.flatten,
+        params
+      ).to_h
     end
 
     # Returns a serialized body instance to serialize a request body and figure out the request
@@ -41,7 +53,7 @@ class Reynard
 
     def operation(operation_name)
       dig('paths').each do |path, operations|
-        operations.each do |verb, operation|
+        operations.slice(*VERBS).each do |verb, operation|
           return Operation.new(node: ['paths', path, verb]) if operation_name == operation['operationId']
         end
       end
@@ -88,6 +100,15 @@ class Reynard
       false
     end
 
+    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
+      Rack::Utils.unescape_path(name)
+                 .gsub(/[^[:alpha:]]/, ' ')
+                 .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
+    end
+
     private
 
     def read
@@ -105,7 +126,7 @@ class Reynard
         next unless cursor.respond_to?(:key?) && cursor&.key?('$ref')
 
         # We currenly only supply references inside the document starting with #/.
-        path = cursor['$ref'][2..].split('/') + path
+        path = Rack::Utils.unescape_path(cursor['$ref'][2..]).split('/') + path
         cursor = data
       end
       cursor
@@ -113,16 +134,16 @@ class Reynard
 
     def schema_name(response)
       ref = response.dig('schema', '$ref')
-      ref&.split('/')&.last
+      return unless ref
+
+      self.class.normalize_model_name(ref&.split('/')&.last)
     end
 
     def item_schema_name(schema)
       ref = schema.dig('items', '$ref')
-      ref&.split('/')&.last
-    end
+      return unless ref
 
-    def object_name(_schema)
-      'Book'
+      self.class.normalize_model_name(ref&.split('/')&.last)
     end
   end
 end

data/lib/reynard/version.rb

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

data/lib/reynard.rb

@@ -34,6 +34,14 @@ 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
+    attr_writer :http
+  end
+
+  # Returns Reynard's global request interface. This is a global object to allow persistent
+  # connections, caching, and other features that need a persistent object in the process.
   def self.http
     @http ||= begin
       http = Net::HTTP::Persistent.new(name: 'Reynard')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -124,6 +124,7 @@ files:
 - lib/reynard/grouped_parameters.rb
 - lib/reynard/http.rb
 - lib/reynard/http/request.rb
+- lib/reynard/http/response.rb
 - lib/reynard/media_type.rb
 - lib/reynard/model.rb
 - lib/reynard/models.rb
@@ -139,7 +140,8 @@ files:
 homepage: https://github.com/Manfred/reynard
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: