rails_api_logger 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99069d517d5cd82e5e073121ebb94306335c052644115cc56765a0a3c166447
-  data.tar.gz: bfac0a6e391ff5c1e29e481e313c47419a6b6f4835871e9f12624638b38d497e
+  metadata.gz: 6a49586120262a132a0601faa23ace3fb929b04f115b900a54e3d86f68f04de9
+  data.tar.gz: 48e8cb9dcd6172532b96ac823910965102277bb10ec39956ee006a8bdbfc71b4
 SHA512:
-  metadata.gz: 3b97315feb5e4792465a85819c829d33733a854fe77a9af907935058eb468c44829f524a29fb6c969cef6efe342903bcd6384989720bd54180f274fbde2bb0c7
-  data.tar.gz: 7139532155a71e2f9d068438164425acebb9f5bb6825f6fbdac0a5f0d0b0f58204dd824b7dcfd474776133b2c4e616a6b7834bd40a94f6500d845c885d45f326
+  metadata.gz: 4468f3a723f56fd098cefe32fac6b937f63270636ac06fbd316920586516917b380120532c527d6cbd54d3808278eff28a633ad61aae5a4741a89a214d0411e2
+  data.tar.gz: ba10ec2838b308faad8b368ced02945a39663a34839f25b096760af9da6b108d316cf82669fd5dca5f9e2a3bccb2487bf6cb94ef84abdab5dd1743e4af7acc96

data/.semaphore/main-deploy.yml

@@ -3,7 +3,7 @@ name: main-deploy
 agent:
   machine:
     type: e1-standard-2
-    os_image: ubuntu1804
+    os_image: ubuntu2004
 
 blocks:
   - name: main-deploy

data/.semaphore/semaphore.yml

@@ -3,7 +3,7 @@ name: rails_api_logger
 agent:
   machine:
     type: e1-standard-2
-    os_image: ubuntu1804
+    os_image: ubuntu2004
 auto_cancel:
   running:
     when: "true"

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.8.1
+* Fix Rails 7.1 warnings.
+
+# 0.8.0
+* Add option skip_body to skip the body for request responses. Use this option when you don't want to persist the response body. `[Skipped]` will be persisted instead. This is not a breaking change.
+
 # 0.7.0
 * Fix an issue in the middleware where the request body was not read correctly if there were encoding issues.
 * Improved documentation about outboud request logging.

data/README.md

@@ -103,8 +103,8 @@ end
 OutboundRequestLog.include(OutboundRequestLogTransactionPatch)
 ```
 
-another way to do the same is to start a new thread to log the request. 
-See the [linked test for an example](https://github.com/renuo/rails_api_logger/blob/main/spec/outbound_request_log_spec.rb:15)
+You can also log the request in a separate thread to provoke the checkout of a separate database connection.
+Have a look at [this example here](https://github.com/renuo/rails_api_logger/blob/28d4ced88fea5a5f4fd72f5a1db42ad4734eb547/spec/outbound_request_log_spec.rb#L28-L30).
 
 ## Log Inbound Requests
 

data/lib/rails_api_logger/request_log.rb

@@ -1,8 +1,8 @@
 class RequestLog < ActiveRecord::Base
   self.abstract_class = true
 
-  serialize :request_body, JSON
-  serialize :response_body, JSON
+  serialize :request_body, coder: JSON
+  serialize :response_body, coder: JSON
 
   belongs_to :loggable, optional: true, polymorphic: true
 
@@ -22,15 +22,9 @@ class RequestLog < ActiveRecord::Base
     create(path: request.path, request_body: body, method: request.method, started_at: Time.current, loggable: loggable)
   end
 
-  def from_response(response)
+  def from_response(response, skip_body: false)
     self.response_code = response.code
-    body = response.body&.dup&.force_encoding("UTF-8")
-    begin
-      body = JSON.parse(body) if body.present?
-    rescue JSON::ParserError
-      body
-    end
-    self.response_body = body
+    self.response_body = skip_body ? "[Skipped]" : manipulate_body(response.body)
     self
   end
 
@@ -61,4 +55,16 @@ class RequestLog < ActiveRecord::Base
     return if started_at.nil? || ended_at.nil?
     ended_at - started_at
   end
+
+  private
+
+  def manipulate_body(body)
+    body_duplicate = body&.dup&.force_encoding("UTF-8")
+    begin
+      body_duplicate = JSON.parse(body_duplicate) if body_duplicate.present?
+    rescue JSON::ParserError
+      body_duplicate
+    end
+    body_duplicate
+  end
 end

data/lib/rails_api_logger.rb

@@ -10,14 +10,15 @@ loader.setup
 class RailsApiLogger
   class Error < StandardError; end
 
-  def initialize(loggable = nil)
+  def initialize(loggable = nil, skip_body: false)
     @loggable = loggable
+    @skip_body = skip_body
   end
 
   def call(url, request)
     log = OutboundRequestLog.from_request(request, loggable: @loggable)
     yield.tap do |response|
-      log.from_response(response)
+      log.from_response(response, skip_body: @skip_body)
     end
   rescue => e
     log.response_body = {error: e.message}

data/rails_api_logger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "rails_api_logger"
-  spec.version = "0.7.0"
+  spec.version = "0.8.1"
   spec.authors = ["Alessandro Rodi"]
   spec.email = ["alessandro.rodi@renuo.ch"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties