reynard 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ca8eb7744c1550bfcf705a92d97331d9c558b08dec5f2369b166b285b38edc
-  data.tar.gz: a140a0dbe5f74c95f43d2aa785dd3c96a322eab2893b2d8a629abd3b9859724e
+  metadata.gz: 7df788fc69d73d417d6b9490299d2552befb4fa4764ebc4621e9d20cd27cab49
+  data.tar.gz: 053775ac81400f50ad28436a122fc0316c3b6037afb1fe41b4c1638a80912509
 SHA512:
-  metadata.gz: 77148ca6897e1e7b0479348cfe536ff94afc5c1741b6fe59afea7940b442d7c46a71914868f572f3588b7d85d95f38446bd8d28885a22a032c91a86e71e3da28
-  data.tar.gz: eab59f1738c99af0f2c8fba6a4fb09f15a5a26f31f86de91125d9f299d2d50844060bd3c13db33b260f267a82e269175e0c69d2cdeb4f32d397e99bca74e9694
+  metadata.gz: 5d2bee0211247407c99e0d5fd180bca0738230c89024cdddaae96de8eaa3afdf1b41fd2e11d95ef4c8c2210ff8f269ad7b4070959065ac48063f1ba8355056c0
+  data.tar.gz: f81ba585b5db0cea43659269ebdffc73ac4e234353f902a663e43203985a576e55874ccf2a6524eba9e029c04bf3174cf53f6ea3a35f44393ed036a37e66adc9

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/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

@@ -46,7 +46,7 @@ class Reynard
 
       def build_object_without_media_type
         # Try to parse the response as JSON and give up otherwise.
-        OpenStruct.new(MultiJson.load(@http_response.body))
+        Reynard::Model.new(MultiJson.load(@http_response.body))
       rescue StandardError
         @http_response.body
       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

@@ -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

@@ -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.2.0'
+  VERSION = '0.4.1'
 end

data/lib/reynard.rb

@@ -11,12 +11,13 @@ 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 :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.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -142,7 +142,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,7 +158,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: []