rails_api_logger 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fbcb1b4b9bd0ac439819b399b94cb27ae816c8d76afec1e700deada25d4934f
-  data.tar.gz: ddfa3c8d1528fb7b1bd18bcac71bc6499023d641496116c7db6b67f36839f9af
+  metadata.gz: 1f13c4887a4835f4654755c70748676106fd20649619fad63084f6a0fc2c9787
+  data.tar.gz: 42309cf04f2727b76bb88818e3c694cf5ba80d63f0535b4223c2a4a29d93db99
 SHA512:
-  metadata.gz: d40aa71d6d9c9229b93fabece22e6fbb51ef5dc4024edbfa2e914b433dfd4421c2bdae6218f7de33000896c8fdfbf1b0db4d253938db18bb9e36f70a0b8483d0
-  data.tar.gz: 94f7bc3f052d87c8f1cb8072febc193a43710b2f949737e0ea52fc5849097f1a6bd29d5eac6da3d06da51b2057bf649e76d64a3eef88873ebb0b79550cdd020f
+  metadata.gz: e7b7c914d762daeba5c54d617f4d6802d506b72db0023775ad3548820327e2199608a40af3534b28224744ebcfcd9e8944d2cb313dc9fc30440e8bcfc377711a
+  data.tar.gz: 16dbc39a87e88cbed4eadc2dccd24eac17140c349addd336e32f6c55b895316752f07bbc49c7b2b953cbfc3bbb854cf8126b786f0b4298a7df4f941de9b22d81

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/CHANGELOG.md

@@ -1 +1,8 @@
+# 0.3.0
+* Added `formatted_request_body` and `formatted_response_body` methods.
+
+# 0.2.0
+* Switch to a middleware solution
+
+# 0.1.0
 * Initial release

data/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in rails_api_logger.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/README.md

@@ -29,6 +29,7 @@ And then execute:
 
 ```bash
 bundle install
+spring stop # if it's running. otherwise it does not see the new generator 
 bundle exec rails generate rails_api_logger:install
 bundle exec rails db:migrate
 ```

data/lib/rails_api_logger.rb

@@ -1,4 +1,5 @@
 require "active_record"
+require "nokogiri"
 require "rails_api_logger/version"
 require "rails_api_logger/request_log"
 require "rails_api_logger/inbound_request_log"

data/lib/rails_api_logger/inbound_requests_logger.rb

@@ -4,7 +4,7 @@ module InboundRequestsLogger
   private
 
   def attach_inbound_request_loggable(loggable)
-    request.env["inbound_request_log"].loggable = loggable if loggable&.persisted?
+    request.env["inbound_request_log"].update(loggable: loggable) if loggable&.persisted?
   end
 end
 

data/lib/rails_api_logger/inbound_requests_logger_middleware.rb

@@ -17,7 +17,7 @@ class InboundRequestLoggerMiddleware
     end
     status, headers, body = @app.call(env)
     if logging
-      @inbound_request_log.update(response_body: parsed_body(body), response_code: status)
+      @inbound_request_log.update_columns(response_body: parsed_body(body), response_code: status)
     end
     [status, headers, body]
   end

data/lib/rails_api_logger/request_log.rb

@@ -8,12 +8,12 @@ class RequestLog < ActiveRecord::Base
 
   scope :failed, -> { where("response_code not like '2%'") }
 
-  validates :request_body, presence: true
   validates :method, presence: true
   validates :path, presence: true
 
   def self.from_request(request)
-    body = (request.body.respond_to?(:read) ? request.body.read : request.body).force_encoding("UTF-8")
+    request_body = (request.body.respond_to?(:read) ? request.body.read : request.body)
+    body = request_body ? request_body.dup.force_encoding("UTF-8") : nil
     begin
       body = JSON.parse(body) if body.present?
     rescue JSON::ParserError
@@ -21,4 +21,27 @@ class RequestLog < ActiveRecord::Base
     end
     create(path: request.path, request_body: body, method: request.method)
   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?(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
 end

data/lib/rails_api_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsApiLogger
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/rails_api_logger.gemspec

@@ -25,9 +25,12 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("railties", ">= 4.1.0")
-  spec.add_dependency("activerecord", ">= 4.1.0")
+  spec.add_dependency "railties", ">= 4.1.0"
+  spec.add_dependency "activerecord", ">= 4.1.0"
+  spec.add_dependency "nokogiri"
 
   spec.add_development_dependency "sqlite3", "~> 1.4.0"
   spec.add_development_dependency "standard", "~> 0.13.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Log inbound and outbound API requests in your Rails application
 email:
 - alessandro.rodi@renuo.ch
@@ -81,7 +123,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -120,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: "Log API requests like a king \U0001F451"

data/Gemfile.lock

@@ -1,121 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rails_api_logger (0.2.1)
-      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)
-      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)
-      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)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.8)
-    crass (1.0.6)
-    diff-lcs (1.4.4)
-    erubi (1.10.0)
-    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)
-    minitest (5.14.4)
-    nokogiri (1.11.1-x86_64-darwin)
-      racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.1.1)
-      actionpack (= 6.1.1)
-      activesupport (= 6.1.1)
-      method_source
-      rake (>= 0.8.7)
-      thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.10.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    sqlite3 (1.4.2)
-    standard (0.13.0)
-      rubocop (= 1.10.0)
-      rubocop-performance (= 1.9.2)
-    thor (1.1.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rails_api_logger!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  sqlite3 (~> 1.4.0)
-  standard (~> 0.13.0)
-
-BUNDLED WITH
-   2.1.4