rails_api_logger 0.2.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '058d907ef19e1e657d9b65e5c0eca5cc926df01496fc3213e4c057c1607bcb21'
-  data.tar.gz: a6434d726dde60f4dadc4db01f64c5a60d27934588f7c971bad6b5dc67728b72
+  metadata.gz: '00489e11faa84622f3557560cf9d989b1fb36f6c6d18fdd41f1f1784e59893dd'
+  data.tar.gz: 54f3202bd8446cce3a32c97a2da3b2f881d317207c511bf1d9ada9250ac751d8
 SHA512:
-  metadata.gz: 69fac1e76d28e62ea3d4d03f6373cccb4179bb735bc5b7ae915c9448fc172315215ce943ebeea91352d66a120e4956b79f7612c238134d3898f4b771c0018ef6
-  data.tar.gz: e73da9b67ee4af50ae219519cf38bdb28083de938f77df56b754708eabb135e4ad66013ff52304862a9e93b14ad3d9a8293c019dc67c40799e9cb827607ca45f
+  metadata.gz: 254e3a0054438fa416561f5e34155529f4860d255cb01e80c5ea5a5a65bac694b35bc6b88199775b1fa11bc6532981f6e514b517f703140020c6b9618284ce1e
+  data.tar.gz: bf5537dfcb5eec1c675b9eb68bee42a8700fa756d1728666c67075a77a9f99baf0f573b5090e36dd6e345c0d5471b923fbcaddd8f689c257e89c496e858722cd

data/.gitignore

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

data/CHANGELOG.md

@@ -1 +1,24 @@
+# 0.4.1
+* Fixed the `.failed` scope.
+
+# 0.4.0
+* Added `started_at`, `ended_at` and `duration` methods.
+
+Migrate your tables with:
+
+```
+add_column :inbound_request_logs, :started_at, :timestamp
+add_column :inbound_request_logs, :ended_at, :timestamp
+add_column :outbound_request_logs, :started_at, :timestamp
+add_column :outbound_request_logs, :ended_at, :timestamp
+```
+
+
+# 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

@@ -1,5 +1,7 @@
 # Rails API Logger
 
+The simplest way to log API requests of your Rails application in your database.
+
 The Rails API logger gem introduces a set of tools to log and debug API requests.
 It works on two sides:
 
@@ -16,6 +18,8 @@ This gem creates two database tables to log the following information:
 * **request_body** what was included in the request body
 * **response_body** what was included in the response body 
 * **response_code** the HTTP response code of the request 
+* **started_at** when the request started
+* **ended_at** when the request finished
 
 ## Installation
 
@@ -29,6 +33,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/generators/templates/create_rails_api_logger_table.rb.tt

@@ -6,6 +6,8 @@ class CreateRailsApiLoggerTable < ActiveRecord::Migration[<%= ActiveRecord::Migr
       t.text :request_body
       t.text :response_body
       t.integer :response_code
+      t.timestamp :started_at
+      t.timestamp :ended_at
       t.references :loggable, index: true, polymorphic: true
       t.timestamps null: false
     end
@@ -16,6 +18,8 @@ class CreateRailsApiLoggerTable < ActiveRecord::Migration[<%= ActiveRecord::Migr
       t.text :request_body
       t.text :response_body
       t.integer :response_code
+      t.timestamp :started_at
+      t.timestamp :ended_at
       t.references :loggable, index: true, polymorphic: true
       t.timestamps null: false
     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_columns(response_body: parsed_body(body), response_code: status)
+      @inbound_request_log.update_columns(response_body: parsed_body(body), response_code: status, ended_at: Time.current)
     end
     [status, headers, body]
   end

data/lib/rails_api_logger/request_log.rb

@@ -6,19 +6,47 @@ class RequestLog < ActiveRecord::Base
 
   belongs_to :loggable, optional: true, polymorphic: true
 
-  scope :failed, -> { where("response_code not like '2%'") }
+  scope :failed, -> { where.not(response_code: 200..299) }
 
-  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).dup.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
       body
     end
-    create(path: request.path, request_body: body, method: request.method)
+    create(path: request.path, request_body: body, method: request.method, started_at: Time.current)
+  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
+
+  def duration
+    return if started_at.nil? || ended_at.nil?
+    ended_at - started_at
   end
 end

data/lib/rails_api_logger/version.rb

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

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"
@@ -20,6 +21,7 @@ module RailsApiLogger
     log.response_body = {error: e.message}
     raise
   ensure
+    log.ended_at = Time.current
     log.save!
   end
 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.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-11-09 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.4)
-      activerecord (>= 4.1.0)
-      railties (>= 4.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    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.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.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)
-      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.2-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.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
-      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