rails_api_logger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 436fe06f5a60eb0cfe6e341c526958b5d2e568ce44eb5e0d45fc704d8cc0151c
-  data.tar.gz: b633e7b6ff50358f91f6096adaa0d693f5e39144316af68e6b821f06bf0858cc
+  metadata.gz: b613afbb5fea833002c8cefd748428314e45df42344a41aacf0230aa7cdd9ffa
+  data.tar.gz: 28ed28bde3d2aacfeee818600fb336d06355b0acbfab26cddd2ba779585dcb90
 SHA512:
-  metadata.gz: e17c8a4a95a6ef87c497257e5da27ed41b81fe9fede8b44767eeadaf8335ab68a63d15d6a27436dac72da6a3316b670927c72b3d7cb60a32a73361c8148e7654
-  data.tar.gz: 914a5cd684eac764b416441f1e1f1a78318e3e0eb68a842620a4f4a7f867d94aebe06fea37faceb49a8a4aa25b349748ef1c14bdae9bcb1e71972a6a69c05195
+  metadata.gz: 8e435ae3d44e5be4307ba6fa8239687ba2f95a6dba1841d857305cdb6f7c6d5471e07b9cab659e35ea432d9e76eb6f62658be24ee21582cef7cc52789aa5a6db
+  data.tar.gz: cb0e8be6fba1f7108a93e124f57c0e10998c8354da03759ce5607ca8b4dd0f4fcb3d1a83ee442303290792f03a15098610ce2188d452c494a8c76174d9d40fae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_api_logger (0.1.1)
+    rails_api_logger (0.2.0)
       activerecord (>= 4.1.0)
       railties (>= 4.1.0)
 
@@ -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.1-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.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"].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,47 @@
+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)
+    if log?(request)
+      @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 log?(request)
+      @inbound_request_log.update(response_body: parsed_body(body), response_code: status)
+    end
+    [status, headers, body]
+  end
+
+  private
+
+  def log?(request)
+    request.path =~ 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/version.rb

@@ -1,3 +1,3 @@
 module RailsApiLogger
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 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.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-03-02 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