rails_api_logger 0.1.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 436fe06f5a60eb0cfe6e341c526958b5d2e568ce44eb5e0d45fc704d8cc0151c
-  data.tar.gz: b633e7b6ff50358f91f6096adaa0d693f5e39144316af68e6b821f06bf0858cc
+  metadata.gz: '058d907ef19e1e657d9b65e5c0eca5cc926df01496fc3213e4c057c1607bcb21'
+  data.tar.gz: a6434d726dde60f4dadc4db01f64c5a60d27934588f7c971bad6b5dc67728b72
 SHA512:
-  metadata.gz: e17c8a4a95a6ef87c497257e5da27ed41b81fe9fede8b44767eeadaf8335ab68a63d15d6a27436dac72da6a3316b670927c72b3d7cb60a32a73361c8148e7654
-  data.tar.gz: 914a5cd684eac764b416441f1e1f1a78318e3e0eb68a842620a4f4a7f867d94aebe06fea37faceb49a8a4aa25b349748ef1c14bdae9bcb1e71972a6a69c05195
+  metadata.gz: 69fac1e76d28e62ea3d4d03f6373cccb4179bb735bc5b7ae915c9448fc172315215ce943ebeea91352d66a120e4956b79f7612c238134d3898f4b771c0018ef6
+  data.tar.gz: e73da9b67ee4af50ae219519cf38bdb28083de938f77df56b754708eabb135e4ad66013ff52304862a9e93b14ad3d9a8293c019dc67c40799e9cb827607ca45f

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    rails_api_logger (0.1.1)
+    rails_api_logger (0.2.4)
       activerecord (>= 4.1.0)
       railties (>= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.1)
-      actionview (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.1)
-      activesupport (= 6.1.1)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activerecord (6.1.1)
-      activemodel (= 6.1.1)
-      activesupport (= 6.1.1)
-    activesupport (6.1.1)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -38,16 +38,14 @@ GEM
     crass (1.0.6)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    i18n (1.8.8)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.5.0)
-    minitest (5.14.3)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    minitest (5.14.4)
+    nokogiri (1.11.2-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.0)
@@ -61,9 +59,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.1)
-      actionpack (= 6.1.1)
-      activesupport (= 6.1.1)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)

data/README.md

@@ -77,23 +77,31 @@ This will guarantee that the log is always persisted, even in case of errors.
 ## Log Inbound Requests
 
 If you are exposing some API you might be interested in logging the requests you receive.
-You can do so in your controller by adding:
+You can do so by adding this middleware in `config/application.rb`
 
 ```ruby
-around_action :log_inbound_request
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestLoggerMiddleware
 ``` 
 
-you can also log only requests that have an impact in your system with:
+this will by default only log requests that have an impact in your system (POST, PUT, and PATCH calls).
+If you want to log all requests (also GET ones) use
 
 ```ruby
-around_action :log_inbound_request, if: :request_with_state_change?
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestLoggerMiddleware, only_state_change: false
+```
+
+If you want to log only requests on a certain path, you can pass a regular expression:
+
+```ruby
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestLoggerMiddleware, path_regexp: /api/
 ```
 
-this will create a log entry only for POST, PUT, and PATCH calls. 
 
 In the implementation of your API, you can call any time `attach_inbound_request_loggable(model)`
 to attach an already persisted model to the log record.
 
+
+
 For example:
 ```ruby
 

data/lib/rails_api_logger.rb

@@ -4,6 +4,7 @@ require "rails_api_logger/request_log"
 require "rails_api_logger/inbound_request_log"
 require "rails_api_logger/outbound_request_log"
 require "rails_api_logger/inbound_requests_logger"
+require "rails_api_logger/inbound_requests_logger_middleware"
 
 module RailsApiLogger
   class Error < StandardError; end

data/lib/rails_api_logger/inbound_requests_logger.rb

@@ -3,29 +3,11 @@ module InboundRequestsLogger
 
   private
 
-  def log_inbound_request
-    @inbound_request_log = InboundRequestLog.from_request(request)
-    yield
-    @inbound_request_log.update(response_body: JSON.parse(response.body), response_code: response.code)
-  end
-
-  def request_with_state_change?
-    request.post? || request.put? || request.patch? || request.delete?
-  end
-
-  def request_without_body?
-    request.get? || request.head? || request.options? || request.delete?
-  end
-
   def attach_inbound_request_loggable(loggable)
-    @inbound_request_log.loggable = loggable if loggable&.persisted?
+    request.env["inbound_request_log"].update(loggable: loggable) if loggable&.persisted?
   end
 end
 
 ActiveSupport.on_load(:action_controller) do
   include InboundRequestsLogger
 end
-
-ActiveSupport.on_load(:action_controller_api) do
-  include InboundRequestsLogger
-end

data/lib/rails_api_logger/inbound_requests_logger_middleware.rb

@@ -0,0 +1,48 @@
+class InboundRequestLoggerMiddleware
+  attr_accessor :only_state_change, :path_regexp
+
+  def initialize(app, only_state_change: true, path_regexp: /.*/)
+    @app = app
+    self.only_state_change = only_state_change
+    self.path_regexp = path_regexp
+  end
+
+  def call(env)
+    request = ActionDispatch::Request.new(env)
+    logging = log?(env, request)
+    if logging
+      @inbound_request_log = InboundRequestLog.from_request(request)
+      env["inbound_request_log"] = @inbound_request_log
+      request.body.rewind
+    end
+    status, headers, body = @app.call(env)
+    if logging
+      @inbound_request_log.update_columns(response_body: parsed_body(body), response_code: status)
+    end
+    [status, headers, body]
+  end
+
+  private
+
+  def log?(env, request)
+    env["REQUEST_URI"] =~ path_regexp && (!only_state_change || request_with_state_change?(request))
+  end
+
+  def parsed_body(body)
+    return unless body.present?
+
+    if body.respond_to?(:body)
+      JSON.parse(body.body)
+    elsif body.respond_to?(:[])
+      JSON.parse(body[0])
+    else
+      body
+    end
+  rescue JSON::ParserError
+    body
+  end
+
+  def request_with_state_change?(request)
+    request.post? || request.put? || request.patch? || request.delete?
+  end
+end

data/lib/rails_api_logger/request_log.rb

@@ -13,7 +13,7 @@ class RequestLog < ActiveRecord::Base
   validates :path, presence: true
 
   def self.from_request(request)
-    body = (request.body.respond_to?(:read) ? request.body.read : request.body).force_encoding("UTF-8")
+    body = (request.body.respond_to?(:read) ? request.body.read : request.body).dup.force_encoding("UTF-8")
     begin
       body = JSON.parse(body) if body.present?
     rescue JSON::ParserError

data/lib/rails_api_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsApiLogger
-  VERSION = "0.1.1"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -92,6 +92,7 @@ files:
 - lib/rails_api_logger.rb
 - lib/rails_api_logger/inbound_request_log.rb
 - lib/rails_api_logger/inbound_requests_logger.rb
+- lib/rails_api_logger/inbound_requests_logger_middleware.rb
 - lib/rails_api_logger/outbound_request_log.rb
 - lib/rails_api_logger/rails_api_logger_rails_admin_configuration.rb
 - lib/rails_api_logger/request_log.rb