rails_api_logger 0.9.0 → 0.10.1

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -109,47 +109,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.4
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: 0.5.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: 0.5.6
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '1.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '1.31'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: Log inbound and outbound API requests in your Rails application
 email:
 - alessandro.rodi@renuo.ch
@@ -176,22 +190,37 @@ files:
 - ".ruby-version"
 - ".semaphore/main-deploy.yml"
 - ".semaphore/semaphore.yml"
+- ".standard.yml"
+- Appraisals
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/inbound_requests_logger.rb
+- app/middlewares/rails_api_logger/middleware.rb
+- app/models/rails_api_logger/inbound_request_log.rb
+- app/models/rails_api_logger/loggable.rb
+- app/models/rails_api_logger/logger.rb
+- app/models/rails_api_logger/outbound_request_log.rb
+- app/models/rails_api_logger/request_log.rb
 - bin/console
+- bin/rails
 - bin/setup
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_6.1.gemfile.lock
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.0.gemfile.lock
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.1.gemfile.lock
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_7.2.gemfile.lock
+- gemfiles/rails_8.0.gemfile
 - lib/generators/rails_api_logger/install_generator.rb
 - lib/generators/templates/create_rails_api_logger_table.rb.tt
 - 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/request_log.rb
+- lib/rails_api_logger/engine.rb
+- lib/rails_api_logger/version.rb
 - rails_api_logger.gemspec
 homepage: https://github.com/renuo/rails_api_logger
 licenses:
@@ -215,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: "Log API requests like a king \U0001F451"

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at alessandro.rodi@renuo.ch. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/lib/rails_api_logger/inbound_request_log.rb

@@ -1,2 +0,0 @@
-class InboundRequestLog < RequestLog
-end

data/lib/rails_api_logger/inbound_requests_logger_middleware.rb

@@ -1,71 +0,0 @@
-class InboundRequestsLoggerMiddleware
-  attr_accessor :only_state_change, :path_regexp, :skip_request_body_regexp, :skip_response_body_regexp
-
-  def initialize(app, only_state_change: true,
-    path_regexp: /.*/,
-    skip_request_body_regexp: nil,
-    skip_response_body_regexp: nil)
-    @app = app
-    self.only_state_change = only_state_change
-    self.path_regexp = path_regexp
-    self.skip_request_body_regexp = skip_request_body_regexp
-    self.skip_response_body_regexp = skip_response_body_regexp
-  end
-
-  def call(env)
-    request = ActionDispatch::Request.new(env)
-    logging = log?(env, request)
-    if logging
-      env["INBOUND_REQUEST_LOG"] = InboundRequestLog.from_request(request, skip_request_body: skip_request_body?(env))
-      request.body.rewind
-    end
-    status, headers, body = @app.call(env)
-    if logging
-      updates = {response_code: status, ended_at: Time.current}
-      updates[:response_body] = if skip_response_body?(env)
-        "[Skipped]"
-      else
-        parsed_body(body)
-      end
-      # this usually works. let's be optimistic.
-      begin
-        env["INBOUND_REQUEST_LOG"].update_columns(updates)
-      rescue JSON::GeneratorError => _e # this can be raised by activerecord if the string is not UTF-8.
-        env["INBOUND_REQUEST_LOG"].update_columns(updates.except(:response_body))
-      end
-    end
-    [status, headers, body]
-  end
-
-  private
-
-  def skip_request_body?(env)
-    skip_request_body_regexp && env["PATH_INFO"] =~ skip_request_body_regexp
-  end
-
-  def skip_response_body?(env)
-    skip_response_body_regexp && env["PATH_INFO"] =~ skip_response_body_regexp
-  end
-
-  def log?(env, request)
-    env["PATH_INFO"] =~ path_regexp && (!only_state_change || request_with_state_change?(request))
-  end
-
-  def parsed_body(body)
-    return unless body.present?
-
-    if body.respond_to?(:to_ary)
-      JSON.parse(body.to_ary[0])
-    elsif body.respond_to?(:body)
-      JSON.parse(body.body)
-    else
-      body
-    end
-  rescue JSON::ParserError, ArgumentError
-    body
-  end
-
-  def request_with_state_change?(request)
-    request.post? || request.put? || request.patch? || request.delete?
-  end
-end

data/lib/rails_api_logger/outbound_request_log.rb

@@ -1,2 +0,0 @@
-class OutboundRequestLog < RequestLog
-end

data/lib/rails_api_logger/request_log.rb

@@ -1,76 +0,0 @@
-class RequestLog < ActiveRecord::Base
-  self.abstract_class = true
-
-  serialize :request_body, coder: JSON
-  serialize :response_body, coder: JSON
-
-  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