reynard 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb3f70f5fd68cbe19747d08687715165595d29a6b81da3329a975cac30bd3cbe
-  data.tar.gz: 73020e57c19507af7ac13b9bc509d3a4b7ac3ae9b74866d7f783cc816436039f
+  metadata.gz: ee7b44612f3b8e0fec7a0a3d1e18bc30366d1bea3470a8b3eb46a8d6180c85cd
+  data.tar.gz: e6c9629439a36c50ff214f932d5997ce004b21d12a1c71a6c727ab7ef38d722a
 SHA512:
-  metadata.gz: d5289ec587b945a0a858537569a4543e9bbfb3daa6dcb8e11cc409d620b89c1d85406d4a1fa0d20dcccc4c00eddcc6ff4b03f5ae24feff865f4cb62661f09638
-  data.tar.gz: af30bf905849a2589e091b0b9655e52375db08ea00f0b28365029900b4101c5d4b94822b30a17b3a1b8e35329886b61cf857fa6d8de1ff6a16fd56ca0dc2a904
+  metadata.gz: 159960b7bb4e38673c00baa531e3586135dcabedadd50dbd12da55eee31b77ea4d4d7d182974144adf602128b664e5d28f3c15c9e6d376f96774e78a45cdba2c
+  data.tar.gz: 5a7cbcc61c772858283855289f9b3a119b716c78994d16a4de6d5f34bc6921c633f023d362417657253885e6c35f157cb98d2771228e2790a0dff4df69bcc7f2

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Reynard
-  VERSION = '0.3.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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -125,6 +125,7 @@ files:
 - 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
@@ -142,7 +143,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,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: []