rails_api_logger 0.4.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00489e11faa84622f3557560cf9d989b1fb36f6c6d18fdd41f1f1784e59893dd'
-  data.tar.gz: 54f3202bd8446cce3a32c97a2da3b2f881d317207c511bf1d9ada9250ac751d8
+  metadata.gz: 4b9cef8f177c929097fa995670c4a071e8527b843837eac867bbb75b71fab198
+  data.tar.gz: 58681f53d1a7d9eeb6c3b13646a245a9bd5cbc163a48f656f24900646d74edc1
 SHA512:
-  metadata.gz: 254e3a0054438fa416561f5e34155529f4860d255cb01e80c5ea5a5a65bac694b35bc6b88199775b1fa11bc6532981f6e514b517f703140020c6b9618284ce1e
-  data.tar.gz: bf5537dfcb5eec1c675b9eb68bee42a8700fa756d1728666c67075a77a9f99baf0f573b5090e36dd6e345c0d5471b923fbcaddd8f689c257e89c496e858722cd
+  metadata.gz: ba47e17a09c47b7f8796fe8600b0fd02399ff17c44290da3ed853de40227ece45c8991832ac187a7304072d7e73bc8dad86a749a673069624afe14ff6ea952dc
+  data.tar.gz: 74d30c8338898eff42ebc791ca120546e19054b6aba2f0960c75168f7d3d7aaf6faf297252b8ec658aea682776022363cfd08a70c976a9f1ba2e824982180b50

data/.semaphore/{master-deploy.yml → main-deploy.yml}

@@ -1,19 +1,18 @@
 version: v1.0
-name: master-deploy
+name: main-deploy
 agent:
   machine:
     type: e1-standard-2
     os_image: ubuntu1804
 
 blocks:
-  - name: master-deploy
+  - name: main-deploy
     task:
       secrets:
         - name: rubygems-deploy
       jobs:
-        - name: master-deploy
+        - name: main-deploy
           commands:
             - checkout --use-cache
             - gem build rails_api_logger
-            - chmod 0600 ~/.gem/credentials
             - gem push rails_api_logger-*.gem

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
@@ -27,5 +28,5 @@ blocks:
             - bundle exec standardrb
             - bundle exec rspec
 promotions:
-  - name: master
-    pipeline_file: master-deploy.yml
+  - name: main
+    pipeline_file: main-deploy.yml

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.6.1
+* Fixes the loading of concern into controllers.
+
+# 0.6.0
+* Fixes an important concurrency issue by removing instance variables in the rack middleware.
+
+# 0.5.0
+* Started using Zeitwerk.
+* Removed RailsAdmin specific code.
+* Improved RailsApiLogger class.
+
 # 0.4.1
 * Fixed the `.failed` scope.
 
@@ -18,7 +29,7 @@ add_column :outbound_request_logs, :ended_at, :timestamp
 * Added `formatted_request_body` and `formatted_response_body` methods.
 
 # 0.2.0
-* Switch to a middleware solution
+* Switch to a middleware solution.
 
 # 0.1.0
-* Initial release
+* Initial release.

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.
@@ -186,7 +180,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/renuo/rails_api_logger. 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to 
-the [code of conduct](https://github.com/renuo/rails_api_logger/blob/master/CODE_OF_CONDUCT.md).
+the [code of conduct](https://github.com/renuo/rails_api_logger/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -195,4 +189,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the RailsApiLogger project's codebases, issue trackers, chat rooms and mailing lists is 
-expected to follow the [code of conduct](https://github.com/renuo/rails_api_logger/blob/master/CODE_OF_CONDUCT.md).
+expected to follow the [code of conduct](https://github.com/renuo/rails_api_logger/blob/main/CODE_OF_CONDUCT.md).

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.rb

@@ -4,10 +4,6 @@ module InboundRequestsLogger
   private
 
   def attach_inbound_request_loggable(loggable)
-    request.env["inbound_request_log"].update(loggable: loggable) if loggable&.persisted?
+    request.env["INBOUND_REQUEST_LOG"].update(loggable: loggable) if loggable&.persisted?
   end
 end
-
-ActiveSupport.on_load(:action_controller) do
-  include InboundRequestsLogger
-end

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: /.*/)
@@ -11,13 +11,14 @@ class InboundRequestLoggerMiddleware
     request = ActionDispatch::Request.new(env)
     logging = log?(env, request)
     if logging
-      @inbound_request_log = InboundRequestLog.from_request(request)
-      env["inbound_request_log"] = @inbound_request_log
+      env["INBOUND_REQUEST_LOG"] = InboundRequestLog.from_request(request)
       request.body.rewind
     end
     status, headers, body = @app.call(env)
     if logging
-      @inbound_request_log.update_columns(response_body: parsed_body(body), response_code: status, ended_at: Time.current)
+      env["INBOUND_REQUEST_LOG"].update_columns(response_body: parsed_body(body),
+                                                response_code: status,
+                                                ended_at: Time.current)
     end
     [status, headers, body]
   end
@@ -25,7 +26,7 @@ class InboundRequestLoggerMiddleware
   private
 
   def log?(env, request)
-    env["REQUEST_URI"] =~ path_regexp && (!only_state_change || request_with_state_change?(request))
+    env["PATH_INFO"] =~ path_regexp && (!only_state_change || request_with_state_change?(request))
   end
 
   def parsed_body(body)

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}
@@ -25,3 +27,7 @@ module RailsApiLogger
     log.save!
   end
 end
+
+ActiveSupport.on_load(:action_controller) do
+  include InboundRequestsLogger
+end

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.6.1"
   spec.authors = ["Alessandro Rodi"]
   spec.email = ["alessandro.rodi@renuo.ch"]
 
@@ -27,10 +25,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "railties", ">= 4.1.0"
   spec.add_dependency "activerecord", ">= 4.1.0"
+  spec.add_dependency "actionpack", ">= 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"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Alessandro Rodi
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2022-04-29 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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,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
@@ -108,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Log inbound and outbound API requests in your Rails application
 email:
 - alessandro.rodi@renuo.ch
@@ -118,7 +160,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".semaphore/master-deploy.yml"
+- ".semaphore/main-deploy.yml"
 - ".semaphore/semaphore.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -135,9 +177,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 +186,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 +201,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