action_reporter 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14d5c87c8d8a4b89f4f0e18f67588d41b01d56e3fecc4ee3bcf40f634c08e9d9
-  data.tar.gz: 0d49b5255bad01955454477adc0166d077e403976823e75659ed996a9843123a
+  metadata.gz: f663c691abaa4b55ce115001639b405521d07ee55b9bb37ec838c26f28e2fd4d
+  data.tar.gz: 4acb1954e62b1ecbfe19ba4112b1147bba8c44cbd703052bfba433b7aacd4cea
 SHA512:
-  metadata.gz: 49dac3148afba57f4f7ebaf7e17ef2ca57cf4ea9d1f14a5ad5e748bbad3d143c2e2be28f99990295a66d307d4cb9c7dbb36a71a9a163701b825402bd3eebfd2e
-  data.tar.gz: 5e66cdd226d395f552c56b9616fba0357a7695225f431dfbf5f3b4d302cfac58f68017720839b3911b190415fff55e319b761c82c718399d67926cd8b2b936e2
+  metadata.gz: 2d4554027681577f761d588d77a61e6745951de6b39671e8ff75e0d8190bb81173ece7cd521190a801a277cbf52392b7f816e40ae470115fa424381c75a3018e
+  data.tar.gz: 37265ec7091183773a6261ac2ae1b0e006f77bbd050bd03bfd48b18d1c17f3a1d661707024602cfeb76a4a5a1cc87a78193f0aa0f0d64c563b59a526e4213c88

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.5.0
+
+* BREAKING: Rename `audited_user` to `current_user`
+* Add `current_request_uuid` and `current_remote_addr` getters and setters
+* Memoize `current_user`, `current_request_uuid`, and `current_remote_addr`
+
+# 1.4.1
+
+* Add paper_trail support
+
 # 1.4.0
 
 * Set minimum ruby version requirement to 2.5.0

data/README.md

@@ -1,12 +1,15 @@
 # action_reporter
 
-[![Gem Version](https://badge.fury.io/rb/action_reporter.svg)](https://badge.fury.io/rb/action_reporter) [![Test Status](https://github.com/amkisko/action_reporter.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/action_reporter.rb/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/action_reporter.svg)](https://badge.fury.io/rb/action_reporter) [![Test Status](https://github.com/amkisko/action_reporter.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/action_reporter.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/action_reporter.rb/graph/badge.svg?token=JCV2A7NWTE)](https://codecov.io/gh/amkisko/action_reporter.rb)
+
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f4bef9a52eac43a5a0f6d8c1b58cc6af)](https://app.codacy.com/gh/amkisko/action_reporter.rb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f4bef9a52eac43a5a0f6d8c1b58cc6af)](https://app.codacy.com/gh/amkisko/action_reporter.rb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 
 Ruby wrapper for multiple reporting services.
 
 Supported services:
 - Rails logger
 - Audited
+- PaperTrail
 - Sentry
 - Honeybadger
 - scoutapm
@@ -39,6 +42,7 @@ Put this in your `config/initializers/action_reporter.rb` file:
 ActionReporter.enabled_reporters = [
   ActionReporter::RailsReporter.new,
   # ActionReporter::AuditedReporter.new,
+  # ActionReporter::PaperTrailReporter.new,
   # ActionReporter::SentryReporter.new,
   # ActionReporter::HoneybadgerReporter.new,
   # ActionReporter::ScoutApmReporter.new
@@ -48,15 +52,40 @@ ActionReporter.enabled_reporters = [
 Then you can use it in your code:
 
 ```ruby
-ActionReporter.audited_user = current_user
+ActionReporter.current_user = current_user
+ActionReporter.current_request_uuid = request.env['action_dispatch.request_id']
+ActionReporter.current_remote_addr = request.env['action_dispatch.remote_ip']
 ActionReporter.context(entry_id: entry.id)
 ActionReporter.notify('Something went wrong', context: { record: record })
 ```
 
+## Hook debugger to notify method
+
+Apply patch on initializer level or before running the main code:
+
+```ruby
+module ActionReporter
+  class RailsReporter < Base
+    def notify(error, context: {})
+      super
+      binding.pry
+    end
+  end
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/action_reporter.rb
 
+Contribution policy:
+- It might take up to 2 calendar weeks to review and merge critical fixes
+- It might take up to 6 calendar months to review and merge pull request
+- It might take up to 1 calendar year to review an issue
+- New integrations and third-party features are not nessessarily added to the gem
+- Pull request should have test coverage for affected parts
+- Pull request should have changelog entry
+
 ## Publishing
 
 ```sh

data/action_reporter.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name = "action_reporter"
-  gem.version = File.read(File.expand_path('../lib/action_reporter.rb', __FILE__)).match(/VERSION\s*=\s*'(.*?)'/)[1]
+  gem.version = File.read(File.expand_path("../lib/action_reporter.rb", __FILE__)).match(/VERSION\s*=\s*'(.*?)'/)[1]
 
   gem.license = "MIT"
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
     "rubygems_mfa_required" => "true"
   }
 
-  gem.files = Dir.glob("lib/**/*.rb") + Dir.glob("bin/**/*") + %w(CHANGELOG.md LICENSE.md README.md action_reporter.gemspec)
+  gem.files = Dir.glob("lib/**/*.rb") + Dir.glob("bin/**/*") + %w[CHANGELOG.md LICENSE.md README.md action_reporter.gemspec]
 
   # s.bindir      = "bin"
   # s.executables = ["action_reporter"]
@@ -29,15 +29,17 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.5.0"
   gem.require_path = "lib"
 
-  gem.add_runtime_dependency 'rails', '> 5'
-  gem.add_runtime_dependency 'audited', '~> 5'
-  gem.add_runtime_dependency 'honeybadger', '~> 5'
-  gem.add_runtime_dependency 'sentry-ruby', '~> 5'
-  gem.add_runtime_dependency 'scout_apm', '~> 5'
-
-  gem.add_development_dependency 'rspec', '~> 3'
-  gem.add_development_dependency 'webmock', '~> 3'
-  gem.add_development_dependency 'pry', '~> 0.14'
-  gem.add_development_dependency 'simplecov', '~> 0.21'
-  gem.add_development_dependency 'simplecov-cobertura', '~> 2'
+  gem.add_runtime_dependency "rails", "> 5"
+
+  gem.add_development_dependency "audited", "~> 5"
+  gem.add_development_dependency "honeybadger", "~> 5"
+  gem.add_development_dependency "sentry-ruby", "~> 5"
+  gem.add_development_dependency "scout_apm", "~> 5"
+  gem.add_development_dependency "paper_trail", "~> 15"
+
+  gem.add_development_dependency "rspec", "~> 3"
+  gem.add_development_dependency "webmock", "~> 3"
+  gem.add_development_dependency "pry", "~> 0.14"
+  gem.add_development_dependency "simplecov", "~> 0.21"
+  gem.add_development_dependency "simplecov-cobertura", "~> 2"
 end

data/lib/action_reporter/audited_reporter.rb

@@ -6,22 +6,36 @@ module ActionReporter
     end
 
     def context(args)
-      Audited.store[:current_remote_address] = args[:remote_addr] if args[
-        :remote_addr
-      ].present?
     end
 
     def reset_context
       Audited.store.delete(:current_remote_address)
-      Audited.store.delete(:audited_user)
+      Audited.store.delete(:current_request_uuid)
+      Audited.store.delete(:current_user)
     end
 
-    def audited_user
-      Audited.store[:audited_user]
+    def current_user
+      Audited.store[:current_user]
     end
 
-    def audited_user=(user)
-      Audited.store[:audited_user] = user
+    def current_user=(user)
+      Audited.store[:current_user] = user
+    end
+
+    def current_request_uuid
+      Audited.store[:current_request_uuid]
+    end
+
+    def current_request_uuid=(request_uuid)
+      Audited.store[:current_request_uuid] = request_uuid
+    end
+
+    def current_remote_addr
+      Audited.store[:current_remote_address]
+    end
+
+    def current_remote_addr=(remote_addr)
+      Audited.store[:current_remote_address] = remote_addr
     end
   end
 end

data/lib/action_reporter/honeybadger_reporter.rb

@@ -21,7 +21,7 @@ module ActionReporter
       honeybadger_class.check_in(check_in_id)
     end
 
-    def audited_user=(user)
+    def current_user=(user)
       honeybadger_class.context(user_global_id: user.to_global_id.to_s) if user
     end
   end

data/lib/action_reporter/paper_trail_reporter.rb

@@ -0,0 +1,23 @@
+module ActionReporter
+  class PaperTrailReporter < Base
+    class_accessor "PaperTrail", gem_spec: "paper_trail (~> 15)"
+
+    def notify(*)
+    end
+
+    def context(args)
+    end
+
+    def reset_context
+      PaperTrail.request.whodunnit = nil
+    end
+
+    def current_user
+      PaperTrail.request.whodunnit
+    end
+
+    def current_user=(user)
+      PaperTrail.request.whodunnit = user
+    end
+  end
+end

data/lib/action_reporter/scout_apm_reporter.rb

@@ -13,8 +13,12 @@ module ActionReporter
       scoutapm_context_class.add(new_context)
     end
 
-    def audited_user=(user)
+    def current_user=(user)
       scoutapm_context_class.add_user(user_global_id: user&.to_global_id&.to_s)
     end
+
+    def ignore_transaction!
+      scoutapm_context_class.ignore_transaction!
+    end
   end
 end

data/lib/action_reporter/sentry_reporter.rb

@@ -22,7 +22,7 @@ module ActionReporter
       sentry_class.get_current_scope.set_context("context", {})
     end
 
-    def audited_user=(user)
+    def current_user=(user)
       sentry_class.set_user(user_global_id: user&.to_global_id&.to_s)
     end
   end

data/lib/action_reporter.rb

@@ -5,18 +5,20 @@ require 'action_reporter/honeybadger_reporter'
 require 'action_reporter/sentry_reporter'
 require 'action_reporter/scout_apm_reporter'
 require 'action_reporter/audited_reporter'
+require 'action_reporter/paper_trail_reporter'
 
 module ActionReporter
   module_function
 
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.5.0'.freeze
 
   AVAILABLE_REPORTERS = [
     ActionReporter::RailsReporter,
     ActionReporter::HoneybadgerReporter,
     ActionReporter::SentryReporter,
     ActionReporter::ScoutApmReporter,
-    ActionReporter::AuditedReporter
+    ActionReporter::AuditedReporter,
+    ActionReporter::PaperTrailReporter
   ].freeze
 
   @enabled_reporters = []
@@ -53,15 +55,42 @@ module ActionReporter
     end
   end
 
-  def audited_user
-    enabled_reporters.find { |r| r.respond_to?(:audited_user) }&.audited_user
+  def current_user
+    @current_user
   end
 
-  def audited_user=(user)
+  def current_user=(user)
+    @current_user = user
     enabled_reporters.each do |reporter|
-      next unless reporter.respond_to?(:audited_user=)
+      next unless reporter.respond_to?(:current_user=)
 
-      reporter.audited_user = user
+      reporter.current_user = user
+    end
+  end
+
+  def current_request_uuid
+    @current_request_uuid
+  end
+
+  def current_request_uuid=(request_uuid)
+    @current_request_uuid = request_uuid
+    enabled_reporters.each do |reporter|
+      next unless reporter.respond_to?(:current_request_uuid=)
+
+      reporter.current_request_uuid = request_uuid
+    end
+  end
+
+  def current_remote_addr
+    @current_remote_addr
+  end
+
+  def current_remote_addr=(remote_addr)
+    @current_remote_addr = remote_addr
+    enabled_reporters.each do |reporter|
+      next unless reporter.respond_to?(:current_remote_addr=)
+
+      reporter.current_remote_addr = remote_addr
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_reporter
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Andrei Makarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +45,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,7 +59,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -73,13 +73,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '15'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +180,7 @@ files:
 - lib/action_reporter/base.rb
 - lib/action_reporter/error.rb
 - lib/action_reporter/honeybadger_reporter.rb
+- lib/action_reporter/paper_trail_reporter.rb
 - lib/action_reporter/rails_reporter.rb
 - lib/action_reporter/scout_apm_reporter.rb
 - lib/action_reporter/sentry_reporter.rb
@@ -194,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: See description