rails_api_logger 0.9.0 → 0.10.1

data/app/models/rails_api_logger/loggable.rb

@@ -0,0 +1,27 @@
+module RailsApiLogger
+  module Loggable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # :nodoc:
+    module ClassMethods
+      def has_many_outbound_request_logs
+        has_many :outbound_request_logs, -> { order(:created_at) },
+          class_name: "RailsApiLogger::OutboundRequestLog",
+          inverse_of: :loggable, dependent: :destroy, as: :loggable
+      end
+
+      def has_many_inbound_request_logs
+        has_many :inbound_request_logs, -> { order(:created_at) },
+          class_name: "RailsApiLogger::InboundRequestLog",
+          inverse_of: :loggable, dependent: :destroy, as: :loggable
+      end
+
+      def has_many_request_logs
+        has_many_inbound_request_logs
+        has_many_outbound_request_logs
+      end
+    end
+  end
+end

data/app/models/rails_api_logger/logger.rb

@@ -0,0 +1,22 @@
+module RailsApiLogger
+  class Logger
+    def initialize(loggable = nil, skip_request_body: false, skip_response_body: false)
+      @loggable = loggable
+      @skip_request_body = skip_request_body
+      @skip_response_body = skip_response_body
+    end
+
+    def call(url, request)
+      log = OutboundRequestLog.from_request(request, loggable: @loggable, skip_request_body: @skip_request_body)
+      yield.tap do |response|
+        log.from_response(response, skip_response_body: @skip_response_body)
+      end
+    rescue => e
+      log.response_body = {error: e.message} if log
+      raise
+    ensure
+      log.ended_at = Time.current
+      log.save!
+    end
+  end
+end

data/app/models/rails_api_logger/outbound_request_log.rb

@@ -0,0 +1,5 @@
+module RailsApiLogger
+  class OutboundRequestLog < RequestLog
+    self.table_name = "outbound_request_logs"
+  end
+end

data/app/models/rails_api_logger/request_log.rb

@@ -0,0 +1,85 @@
+module RailsApiLogger
+  class RequestLog < ActiveRecord::Base
+    self.abstract_class = true
+
+    connects_to(**RailsApiLogger.connects_to) if RailsApiLogger.connects_to
+
+    if Gem::Version.new(Rails.version) >= Gem::Version.new("7.1")
+      serialize :request_body, coder: JSON
+      serialize :response_body, coder: JSON
+    else
+      serialize :request_body, JSON
+      serialize :response_body, JSON
+    end
+
+    belongs_to :loggable, optional: true, polymorphic: true
+
+    scope :failed, -> { where(response_code: 400..599).or(where.not(ended_at: nil).where(response_code: nil)) }
+
+    validates :method, presence: true
+    validates :path, presence: true
+
+    def self.from_request(request, loggable: nil, skip_request_body: false)
+      if skip_request_body
+        body = "[Skipped]"
+      else
+        request_body = (request.body.respond_to?(:read) ? request.body.read : request.body)
+        body = request_body&.dup&.force_encoding("UTF-8")
+        begin
+          body = JSON.parse(body) if body.present?
+        rescue JSON::ParserError
+          body
+        end
+      end
+      create(path: request.path, request_body: body, method: request.method, started_at: Time.current, loggable: loggable)
+    end
+
+    def from_response(response, skip_response_body: false)
+      self.response_code = response.code
+      self.response_body = skip_response_body ? "[Skipped]" : manipulate_body(response.body)
+      self
+    end
+
+    def formatted_request_body
+      formatted_body(request_body)
+    end
+
+    def formatted_response_body
+      formatted_body(response_body)
+    end
+
+    def formatted_body(body)
+      if body.is_a?(String) && body.blank?
+        ""
+      elsif body.is_a?(Hash)
+        JSON.pretty_generate(body)
+      else
+        xml = Nokogiri::XML(body)
+        if xml.errors.any?
+          body
+        else
+          xml.to_xml(indent: 2)
+        end
+      end
+    rescue
+      body
+    end
+
+    def duration
+      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
+end

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/rails_api_logger/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "rails", "~> 6.1.0"
+gem "rspec-rails", "~> 6.1.0"
+gem "sqlite3", "~> 1.7.3"
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile.lock

@@ -0,0 +1,240 @@
+PATH
+  remote: ..
+  specs:
+    rails_api_logger (0.10.1)
+      activejob (>= 6.0)
+      activerecord (>= 6.0)
+      nokogiri
+      railties (>= 6.0)
+      zeitwerk (>= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      actionview (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.10)
+      actionview (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activerecord (6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activestorage (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.10)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.0)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.4)
+    mysql2 (0.5.6)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.2-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.9)
+    racc (1.8.1)
+    rack (2.2.11)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails (6.1.7.10)
+      actioncable (= 6.1.7.10)
+      actionmailbox (= 6.1.7.10)
+      actionmailer (= 6.1.7.10)
+      actionpack (= 6.1.7.10)
+      actiontext (= 6.1.7.10)
+      actionview (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.10)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.10.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    rubocop (1.71.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.7.3-arm64-darwin)
+    standard (1.45.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.71.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin
+
+DEPENDENCIES
+  appraisal (~> 2.5)
+  concurrent-ruby (= 1.3.4)
+  mysql2 (~> 0.5.6)
+  pg (~> 1.5.4)
+  rack
+  rails (~> 6.1.0)
+  rails_api_logger!
+  rake (~> 12.0)
+  rspec-rails (~> 6.1.0)
+  sqlite3 (~> 1.7.3)
+  standard (~> 1.31)
+
+BUNDLED WITH
+   2.5.4

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "rails", "~> 7.0.0"
+gem "rspec-rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7.3"
+
+gemspec path: "../"

data/gemfiles/rails_7.0.gemfile.lock

@@ -0,0 +1,239 @@
+PATH
+  remote: ..
+  specs:
+    rails_api_logger (0.10.0)
+      activejob (>= 6.0)
+      activerecord (>= 6.0)
+      nokogiri
+      railties (>= 6.0)
+      zeitwerk (>= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activestorage (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      actionview (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.8.7)
+      actionview (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activestorage (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.8.7)
+      activesupport (= 7.0.8.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.8.7)
+      activesupport (= 7.0.8.7)
+      globalid (>= 0.3.6)
+    activemodel (7.0.8.7)
+      activesupport (= 7.0.8.7)
+    activerecord (7.0.8.7)
+      activemodel (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+    activestorage (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.8.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.0)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.4)
+    mysql2 (0.5.6)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.2-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.9)
+    racc (1.8.1)
+    rack (2.2.11)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails (7.0.8.7)
+      actioncable (= 7.0.8.7)
+      actionmailbox (= 7.0.8.7)
+      actionmailer (= 7.0.8.7)
+      actionpack (= 7.0.8.7)
+      actiontext (= 7.0.8.7)
+      actionview (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activemodel (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activestorage (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      bundler (>= 1.15.0)
+      railties (= 7.0.8.7)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.10.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (7.1.1)
+      actionpack (>= 7.0)
+      activesupport (>= 7.0)
+      railties (>= 7.0)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    rubocop (1.71.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.7.3-arm64-darwin)
+    standard (1.45.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.71.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin
+
+DEPENDENCIES
+  appraisal (~> 2.5)
+  concurrent-ruby (= 1.3.4)
+  mysql2 (~> 0.5.6)
+  pg (~> 1.5.4)
+  rack
+  rails (~> 7.0.0)
+  rails_api_logger!
+  rake (~> 12.0)
+  rspec-rails (~> 7.1.0)
+  sqlite3 (~> 1.7.3)
+  standard (~> 1.31)
+
+BUNDLED WITH
+   2.5.4

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+gem "rspec-rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7.3"
+
+gemspec path: "../"