rails_api_logger 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00489e11faa84622f3557560cf9d989b1fb36f6c6d18fdd41f1f1784e59893dd'
-  data.tar.gz: 54f3202bd8446cce3a32c97a2da3b2f881d317207c511bf1d9ada9250ac751d8
+  metadata.gz: 545d9a066433986966d131cd6f874fbe58607fe03f2aae947eec494815e2bc60
+  data.tar.gz: 8565825afc3af8704877c534df8e7f334a3d90ddedca4813879a89846e5b745c
 SHA512:
-  metadata.gz: 254e3a0054438fa416561f5e34155529f4860d255cb01e80c5ea5a5a65bac694b35bc6b88199775b1fa11bc6532981f6e514b517f703140020c6b9618284ce1e
-  data.tar.gz: bf5537dfcb5eec1c675b9eb68bee42a8700fa756d1728666c67075a77a9f99baf0f573b5090e36dd6e345c0d5471b923fbcaddd8f689c257e89c496e858722cd
+  metadata.gz: 1334657ab5a74509d0a5be48e344b439038207577c80e6ced192043b13fb6005804a2b1275c195b813f5993ee104d0e8ed6b2f8dc575b038a4b5728dcb31f4aa
+  data.tar.gz: 9ca93777e0035586de21dbfb19bac23e01b235a1556d78f824a88a2f191a61938e6fc12d44e4990a1de3b546a52d04006591641e4e053229d87d0e326b917316

data/.semaphore/semaphore.yml

@@ -19,7 +19,8 @@ blocks:
         commands:
           - checkout --use-cache
           - cache restore
-          - bundle install --deployment -j 4 --path vendor/bundle
+          - bundle config set path 'vendor/bundle'
+          - bundle install -j 4
           - cache store
       jobs:
         - name: tests

data/README.md

@@ -72,9 +72,9 @@ You can also use the provided logger class to do that in a simpler and safer man
 
 ```ruby
 uri = URI('http://example.com/some_path?query=string')
-http = Net::HTTP.start(uri.host, uri.port)
+http = Net::HTTP.new(uri.host, uri.port)
 request = Net::HTTP::Get.new(uri)
-response = RailsApiLogger.call(uri, http, request)
+response = RailsApiLogger.new.call(uri, request) { http.start { |http| http.request(request) } }
 ``` 
 
 This will guarantee that the log is always persisted, even in case of errors.
@@ -170,12 +170,6 @@ This configuration will give you some nice views, and searches to work with the
 end
 ```
 
-you can also add this configuration directly in `rails_admin.rb` with
-
-```ruby
- include RailsApiLoggerRailsAdminConfiguration 
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/generators/rails_api_logger/install_generator.rb

@@ -3,7 +3,7 @@
 require "rails/generators/base"
 require "rails/generators/migration"
 
-module RailsApiLogger
+class RailsApiLogger
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration

data/lib/rails_api_logger/inbound_requests_logger_middleware.rb

@@ -1,4 +1,4 @@
-class InboundRequestLoggerMiddleware
+class InboundRequestsLoggerMiddleware
   attr_accessor :only_state_change, :path_regexp
 
   def initialize(app, only_state_change: true, path_regexp: /.*/)

data/lib/rails_api_logger/request_log.rb

@@ -11,7 +11,7 @@ class RequestLog < ActiveRecord::Base
   validates :method, presence: true
   validates :path, presence: true
 
-  def self.from_request(request)
+  def self.from_request(request, loggable: nil)
     request_body = (request.body.respond_to?(:read) ? request.body.read : request.body)
     body = request_body ? request_body.dup.force_encoding("UTF-8") : nil
     begin
@@ -19,7 +19,18 @@ class RequestLog < ActiveRecord::Base
     rescue JSON::ParserError
       body
     end
-    create(path: request.path, request_body: body, method: request.method, started_at: Time.current)
+    create(path: request.path, request_body: body, method: request.method, started_at: Time.current, loggable: loggable)
+  end
+
+  def from_response(response)
+    self.response_code = response.code
+    body = response.body ? response.body.dup.force_encoding("UTF-8") : nil
+    begin
+      body = JSON.parse(body) if body.present?
+    rescue JSON::ParserError
+      body
+    end
+    self.response_body = body
   end
 
   def formatted_request_body

data/lib/rails_api_logger.rb

@@ -1,21 +1,23 @@
 require "active_record"
 require "nokogiri"
-require "rails_api_logger/version"
-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"
+require "zeitwerk"
 
-module RailsApiLogger
+loader = Zeitwerk::Loader.for_gem
+loader.collapse("#{__dir__}/rails_api_logger")
+loader.do_not_eager_load("#{__dir__}/generators")
+loader.setup
+
+class RailsApiLogger
   class Error < StandardError; end
 
-  def self.call(uri, http, request)
-    log = OutboundRequestLog.from_request(request)
+  def initialize(loggable = nil)
+    @loggable = loggable
+  end
 
-    http.request(request).tap do |response|
-      log.response_code = response.code
-      log.response_body = response.body
+  def call(url, request)
+    log = OutboundRequestLog.from_request(request, loggable: @loggable)
+    yield.tap do |response|
+      log.from_response(response)
     end
   rescue => e
     log.response_body = {error: e.message}

data/rails_api_logger.gemspec

@@ -1,8 +1,6 @@
-require_relative "lib/rails_api_logger/version"
-
 Gem::Specification.new do |spec|
   spec.name = "rails_api_logger"
-  spec.version = RailsApiLogger::VERSION
+  spec.version = "0.5.0"
   spec.authors = ["Alessandro Rodi"]
   spec.email = ["alessandro.rodi@renuo.ch"]
 
@@ -28,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "railties", ">= 4.1.0"
   spec.add_dependency "activerecord", ">= 4.1.0"
   spec.add_dependency "nokogiri"
+  spec.add_dependency "zeitwerk", ">= 2.0.0"
 
   spec.add_development_dependency "sqlite3", "~> 1.4.0"
   spec.add_development_dependency "standard", "~> 0.13.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Alessandro Rodi
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -135,9 +149,7 @@ files:
 - 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
-- lib/rails_api_logger/version.rb
 - rails_api_logger.gemspec
 homepage: https://github.com/renuo/rails_api_logger
 licenses:
@@ -146,7 +158,7 @@ metadata:
   homepage_uri: https://github.com/renuo/rails_api_logger
   source_code_uri: https://github.com/renuo/rails_api_logger
   changelog_uri: https://github.com/renuo/rails_api_logger/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: "Log API requests like a king \U0001F451"
 test_files: []

data/lib/rails_api_logger/rails_api_logger_rails_admin_configuration.rb

@@ -1,33 +0,0 @@
-%w[InboundRequestLog OutboundRequestLog].each do |logging_model|
-  config.model logging_model do
-    list do
-      filters %i[method path response_code request_body response_body created_at]
-      scopes [nil, :failed]
-
-      include_fields :method, :path, :response_code, :created_at
-
-      field :request_body, :string do
-        visible false
-        searchable true
-        filterable true
-      end
-
-      field :response_body, :string do
-        visible false
-        searchable true
-        filterable true
-      end
-    end
-
-    show do
-      include_fields :loggable, :method, :path, :response_code
-      field(:created_at)
-      field(:request_body) do
-        formatted_value { "<pre>#{JSON.pretty_generate(bindings[:object].request_body)}</pre>".html_safe }
-      end
-      field(:response_body) do
-        formatted_value { "<pre>#{JSON.pretty_generate(bindings[:object].response_body)}</pre>".html_safe }
-      end
-    end
-  end
-end

data/lib/rails_api_logger/version.rb

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