reynard 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d703f01c7c60de48b48ae223cd9c2e3a94a8639bb866eca234298331ad746d2a
-  data.tar.gz: 9e88b9e21dc1b1d00357fcf8bdf2b6952676c5237369d7d950e97b379727e731
+  metadata.gz: ee7b44612f3b8e0fec7a0a3d1e18bc30366d1bea3470a8b3eb46a8d6180c85cd
+  data.tar.gz: e6c9629439a36c50ff214f932d5997ce004b21d12a1c71a6c727ab7ef38d722a
 SHA512:
-  metadata.gz: b1cccaf532a955569236a07c5c8861519cf58c0c2abe3cdf218a8a57619a41d650e9f7226ccdb1a6ef1fddfe412cd9780032dcf8f68ecf995cd2176bb8774642
-  data.tar.gz: 56acfbbabfea8a77e76cbee676bd0b397a608994f03f774022fd54d4e65fad06730de36aa9b122767edddb229f854eff9e8819d8a93d506ee5af66d799d18e82
+  metadata.gz: 159960b7bb4e38673c00baa531e3586135dcabedadd50dbd12da55eee31b77ea4d4d7d182974144adf602128b664e5d28f3c15c9e6d376f96774e78a45cdba2c
+  data.tar.gz: 5a7cbcc61c772858283855289f9b3a119b716c78994d16a4de6d5f34bc6921c633f023d362417657253885e6c35f157cb98d2771228e2790a0dff4df69bcc7f2

data/README.md

@@ -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,43 @@ 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"}'
+```
+
+## 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.
@@ -82,4 +113,4 @@ end
 
 ## Copyright and other legal
 
-See LICENCE.
+See LICENCE.

data/lib/reynard/context.rb

@@ -42,8 +42,12 @@ class Reynard
       copy(headers: @request_context.headers.merge(headers))
     end
 
+    def logger(logger)
+      copy(logger: logger)
+    end
+
     def execute
-      build_object(build_request.perform)
+      build_response(build_request.perform)
     end
 
     private
@@ -63,32 +67,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/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/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/logger.rb

@@ -0,0 +1,26 @@
+# 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

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/request_context.rb

@@ -10,6 +10,14 @@ 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

@@ -5,6 +5,8 @@ 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
@@ -32,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
@@ -43,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

data/lib/reynard/version.rb

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

data/lib/reynard.rb

@@ -17,6 +17,7 @@ class Reynard
   autoload :Context, 'reynard/context'
   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 +35,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.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -124,6 +124,8 @@ files:
 - 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
@@ -139,8 +141,9 @@ files:
 homepage: https://github.com/Manfred/reynard
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,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: []