finapps_core 6.0.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f8aa98b4a17b4497c2940488e03953b5898ee1d3dfcb2fee61d537484075bf
-  data.tar.gz: 84c70cff196aec1f0b31a534e5c7c3b142f68ba308506ed823a654e89da182b6
+  metadata.gz: d18e32588446fcca7dbf1e07e819e278d3d2abb4bf75207eba374b5c60c5f14c
+  data.tar.gz: 0f7f59132bdf40f76b80925390bacb4067be4a3604d45a0defdbd3f3dbe5b298
 SHA512:
-  metadata.gz: 82aa422c010d8eaa84b5b12f886107ac096b64dbedd07d50ec218ceced322d1fefb72b11cc3bff6a60f4bf466f09918bb081dab9a062ac51adfca2c54d0a2ce3
-  data.tar.gz: 790061688554488ec8fdd3c8522409a1a61813f8063bfdb1083be32305b0a01eb3c6a0c1f60931364112521e71fcbbe846572ee7e8c86a1fd76a47265d977db5
+  metadata.gz: 3278d2d0ca52fcf1042923b9fe641b112b2c7956062e81527c84b5e24d3805df7479b233ded5c2e5c2fa96a7c2457107ee52afdf1c783f3a307c7b0626ad5cef
+  data.tar.gz: d845efa3086595a6b5c024a91a6755d92fe24fa3e85e79cc530074d4469b861c2e54c133289a19762b2c126145d2e01f9891da4617b99d98490c60af6380171e

data/lib/finapps_core/logging/content_type_formatter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'faraday/logging/formatter'
+
+module FinAppsCore
+  module Logging
+    class ContenTypeFormatter < Faraday::Logging::Formatter
+      CONTENT_TYPE = 'Content-Type' unless defined?(ContenTypeFormatter::CONTENT_TYPE)
+
+      def response(env)
+        status = proc { "Status #{env.status}" }
+        public_send(log_level, 'response', &status)
+
+        log_headers('response', env.response_headers) if log_headers?(:response)
+        log_body('response', env[:body]) if env[:body] && log_body?(:response) && loggable?(env)
+      end
+
+      private
+
+      def loggable?(env)
+        loggable_types = ['application/json', 'text/plain']
+        process_response_type?(env, loggable_types)
+      end
+
+      def process_response_type?(env, content_types)
+        type = response_type(env)
+        content_types.empty? || content_types.any? do |pattern|
+          pattern.is_a?(Regexp) ? type.match?(pattern) : type == pattern
+        end
+      end
+
+      def response_type(env)
+        type = env[:response_headers][CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+    end
+  end
+end

data/lib/finapps_core/rest/configuration.rb

@@ -27,7 +27,7 @@ module FinAppsCore
       def assign_attributes(new_attributes)
         unless new_attributes.respond_to?(:each_pair)
           fail ArgumentError, 'When assigning attributes, '\
-            "you must pass a hash argument, #{new_attributes.class} passed."
+                              "you must pass a hash argument, #{new_attributes.class} passed."
         end
         return if new_attributes.empty?
 

data/lib/finapps_core/rest/connection.rb

@@ -19,7 +19,10 @@ module FinAppsCore
       end
 
       def init_connection_response(conn, logger)
-        conn.response :logger, logger, bodies: true
+        conn.response :logger, logger, bodies: true,
+                                       headers: true,
+                                       formatter: FinAppsCore::Logging::ContenTypeFormatter,
+                                       log_level: :debug
         conn.response :json,
                       content_type: /\bjson$/,
                       parser_options: {symbolize_names: true}

data/lib/finapps_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinAppsCore
-  VERSION = '6.0.0'
+  VERSION = '6.0.1'
 end

data/lib/finapps_core.rb

@@ -12,6 +12,8 @@ require 'finapps_core/utils/loggeable'
 require 'finapps_core/utils/validatable'
 require 'finapps_core/error'
 
+require 'finapps_core/logging/content_type_formatter'
+
 require 'finapps_core/middleware/request/tenant_authentication'
 require 'finapps_core/middleware/request/no_encoding_basic_authentication'
 require 'finapps_core/middleware/request/accept_json'

data/spec/logging/conten_type_formatter_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'stringio'
+require 'logger'
+
+RSpec.describe Faraday::Response::Logger do
+  let(:string_io) { StringIO.new }
+  let(:logger) { Logger.new(string_io) }
+  let(:conn) do
+    rubbles = %w(Barney Betty)
+    logger_options = {
+      bodies: true,
+      formatter: FinAppsCore::Logging::ContenTypeFormatter
+    }
+
+    Faraday.new do |b|
+      b.response :logger, logger, logger_options
+      b.adapter :test do |stubs|
+        stubs.get('/text') { [200, {'Content-Type' => 'text/plain'}, 'hello'] }
+        stubs.get('/json') { [200, {'Content-Type' => 'application/json'}, rubbles] }
+        stubs.get('/pdf') { [200, {'Content-Type' => 'application/pdf'}, 'binary-here'] }
+      end
+    end
+  end
+
+  before do
+    logger.level = Logger::DEBUG
+  end
+
+  context 'when content type is text/plain' do
+    before { conn.get '/text' }
+
+    it 'logs response body' do
+      expect(string_io.string).to match('hello')
+    end
+  end
+
+  context 'when content type is application/json' do
+    before { conn.get '/json' }
+
+    it 'logs response body' do
+      expect(string_io.string).to match('[\"Barney\", \"Betty\"]')
+    end
+  end
+
+  context 'when content type is something else' do
+    before { conn.get '/pdf' }
+
+    it 'does not log response body' do
+      expect(string_io.string).not_to match('binary-here')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps_core
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -299,6 +299,7 @@ files:
 - lib/core_extensions/string/json_to_hash.rb
 - lib/finapps_core.rb
 - lib/finapps_core/error.rb
+- lib/finapps_core/logging/content_type_formatter.rb
 - lib/finapps_core/middleware/middleware.rb
 - lib/finapps_core/middleware/request/accept_json.rb
 - lib/finapps_core/middleware/request/no_encoding_basic_authentication.rb
@@ -319,6 +320,7 @@ files:
 - lib/finapps_core/version.rb
 - lib/tasks/releaser.rake
 - spec/core_extensions/object/is_integer_spec.rb
+- spec/logging/conten_type_formatter_spec.rb
 - spec/middleware/request/accept_json_spec.rb
 - spec/middleware/request/no_encoding_basic_authentication_spec.rb
 - spec/middleware/request/request_id_spec.rb
@@ -372,21 +374,22 @@ signing_key:
 specification_version: 4
 summary: FinApps REST API ruby client - Core.
 test_files:
-- spec/core_extensions/object/is_integer_spec.rb
-- spec/support/fake_api.rb
-- spec/spec_helper.rb
+- spec/rest/base_client_spec.rb
+- spec/rest/defaults_spec.rb
+- spec/rest/configuration_spec.rb
+- spec/rest/resources_spec.rb
+- spec/rest/credentials_spec.rb
 - spec/spec_helpers/client.rb
 - spec/middleware/request/user_agent_spec.rb
+- spec/middleware/request/request_id_spec.rb
 - spec/middleware/request/x_consumer_id_spec.rb
-- spec/middleware/request/accept_json_spec.rb
 - spec/middleware/request/x_tenant_id_spec.rb
 - spec/middleware/request/tenant_authentication_spec.rb
+- spec/middleware/request/accept_json_spec.rb
 - spec/middleware/request/no_encoding_basic_authentication_spec.rb
-- spec/middleware/request/request_id_spec.rb
 - spec/middleware/response/raise_error_spec.rb
+- spec/support/fake_api.rb
+- spec/core_extensions/object/is_integer_spec.rb
+- spec/logging/conten_type_formatter_spec.rb
+- spec/spec_helper.rb
 - spec/utils/validatable_spec.rb
-- spec/rest/configuration_spec.rb
-- spec/rest/resources_spec.rb
-- spec/rest/credentials_spec.rb
-- spec/rest/defaults_spec.rb
-- spec/rest/base_client_spec.rb