action_reporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d04726ad07e0a3930895a3f5f50c570cee75636ba92aa13d142f1d45c84c2812
+  data.tar.gz: 12a7b129dda548f8dca465a2d406b8d6982c4bc34fd8259edafe57451c8cfe07
+SHA512:
+  metadata.gz: 35b4f4953e373d8c45d29a250dc0e0d4ee53b4a6aab4121c779ecc1090d669059c26da764562ff360e5f6e540ced4b8de9d347cfa10dc8e71650ac816ead214b
+  data.tar.gz: 65ea44fc78c36bb0227ad930ff737060b1c6188ebb237a6d5adbc1b13504a91886cd38a7694a64ce1205973525af93e5d95f02e79376f10207271fb95c0d7c1b

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial version

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 amkisko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# 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/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/action_reporter/actions/workflows/test.yml)
+
+Ruby wrapper for multiple reporting services.
+
+Supported services:
+- Rails logger
+- Audited
+- Sentry
+- Honeybadger
+- scoutapm
+
+Sponsored by [Kisko Labs](https://www.kiskolabs.com).
+
+## Install
+
+Using Bundler:
+```sh
+bundle add action_reporter
+```
+
+Using RubyGems:
+```sh
+gem install action_reporter
+```
+
+## Gemfile
+
+```ruby
+gem 'action_reporter'
+```
+
+## Usage
+
+Put this in your `config/initializers/action_reporter.rb` file:
+
+```ruby
+ActionReporter.enabled_reporters = [
+  ActionReporter::Reporters::RailsReporter.new,
+  # ActionReporter::Reporters::AuditedReporter.new,
+  # ActionReporter::Reporters::SentryReporter.new,
+  # ActionReporter::Reporters::HoneybadgerReporter.new,
+  # ActionReporter::Reporters::ScoutApmReporter.new
+]
+```
+
+Then you can use it in your code:
+
+```ruby
+ActionReporter.context(audited_user: current_user)
+ActionReporter.notify('Something went wrong', context: { record: record })
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/action_reporter
+
+## Publishing
+
+```sh
+rm action_reporter-*.gem
+gem build action_reporter.gemspec
+gem push action_reporter-*.gem
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/action_reporter.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = "action_reporter"
+  s.version = "1.0.0"
+
+  s.license = "MIT"
+
+  s.platform = Gem::Platform::RUBY
+
+  s.authors = ["Andrei Makarov"]
+  s.email = ["andrei@kiskolabs.com"]
+  s.homepage = "https://github.com/amkisko/action_reporter"
+  s.description = "Ruby wrapper for multiple reporting services"
+  s.summary = "See description"
+  s.metadata = {
+    "homepage" => "https://github.com/amkisko/action_reporter",
+    "source_code_uri" => "https://github.com/amkisko/action_reporter",
+    "bug_tracker_uri" => "https://github.com/amkisko/action_reporter/issues",
+    "changelog_uri" => "https://github.com/amkisko/action_reporter/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true"
+  }
+
+  s.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"]
+
+  s.required_ruby_version = ">= 3.2.0"
+  s.require_path = "lib"
+end

data/lib/action_reporter/audited_reporter.rb

@@ -0,0 +1,30 @@
+module ActionReporter
+  class AuditedReporter < Base
+    class_accessor "Audited"
+
+    def transform_context?
+      false
+    end
+
+    def notify(*)
+    end
+
+    def context(args)
+      Audited.store[:current_remote_address] = args[:remote_addr] if args[
+        :remote_addr
+      ].present?
+      Audited.store[:audited_user] = args[:audited_user] if args[
+        :audited_user
+      ].present?
+    end
+
+    def reset_context
+      Audited.store.delete(:current_remote_address)
+      Audited.store.delete(:audited_user)
+    end
+
+    def audited_user
+      Audited.store[:audited_user]
+    end
+  end
+end

data/lib/action_reporter/base.rb

@@ -0,0 +1,14 @@
+module ActionReporter
+  class Base
+    def self.class_accessor(class_name)
+      return unless Object.const_defined?(class_name)
+
+      const_name = class_name.gsub("::", "")
+      const_set(const_name, Object.const_get(class_name))
+    end
+
+    def transform_context?
+      true
+    end
+  end
+end

data/lib/action_reporter/honeybadger_reporter.rb

@@ -0,0 +1,17 @@
+module ActionReporter
+  class HoneybadgerReporter < Base
+    class_accessor "Honeybadger"
+
+    def notify(error, context: {})
+      Honeybadger.notify(error, context: context)
+    end
+
+    def context(args)
+      Honeybadger.context(args)
+    end
+
+    def reset_context
+      Honeybadger.context.clear!
+    end
+  end
+end

data/lib/action_reporter/rails_reporter.rb

@@ -0,0 +1,18 @@
+module ActionReporter
+  class RailsReporter < Base
+    class_accessor "Rails"
+
+    def notify(error, context: {})
+      Rails.logger.info(
+        "Reporter notification: #{error.inspect}, #{context.inspect}"
+      )
+    end
+
+    def context(args)
+      Rails.logger.info("Reporter context: #{args.inspect}")
+    end
+
+    def reset_context
+    end
+  end
+end

data/lib/action_reporter/scout_apm_reporter.rb

@@ -0,0 +1,23 @@
+module ActionReporter
+  class ScoutApmReporter < Base
+    class_accessor "ScoutApm::Agent"
+    class_accessor "ScoutApm::Context"
+
+    def notify(*args, **kwargs)
+      ScoutApmAgent.instance.error(*args, **kwargs)
+    end
+
+    def context(args)
+      if args[:audited_user].present?
+        ScoutApmContext.add_user(
+          audited_user_global_id: args[:audited_user].to_global_id
+        )
+      end
+      ScoutApmContext.add(args)
+    end
+
+    def reset_context
+      ScoutApmContext.clear!
+    end
+  end
+end

data/lib/action_reporter/sentry_reporter.rb

@@ -0,0 +1,20 @@
+module ActionReporter
+  class SentryReporter < Base
+    class_accessor "Sentry"
+
+    def notify(error, context: {})
+      self.context(context)
+      Sentry.capture_exception(error)
+    end
+
+    def context(args)
+      args.each do |key, value|
+        Sentry.configure_scope { |scope| scope.set_context(key, value) }
+      end
+    end
+
+    def reset_context
+      Sentry.configure_scope { |scope| scope.clear_breadcrumbs }
+    end
+  end
+end

data/lib/action_reporter/utils.rb

@@ -0,0 +1,19 @@
+module ActionReporter
+  module Utils
+    module_function
+
+    def deep_transform_values(hash, &block)
+      hash.each_with_object({}) do |(k, v), result|
+        value = if v.is_a?(Hash)
+          deep_transform_values(v, &block)
+        elsif v.is_a?(Array)
+          v.map { |e| e.is_a?(Hash) ? deep_transform_values(e, &block) : e }
+        else
+          v
+        end
+
+        result[k] = block.call(value)
+      end
+    end
+  end
+end

data/lib/action_reporter/version.rb

@@ -0,0 +1,3 @@
+module ActionReporter
+  VERSION = '1.0.0'
+end

data/lib/action_reporter.rb

@@ -0,0 +1,63 @@
+require 'action_reporter/version'
+require 'action_reporter/utils'
+require 'action_reporter/base'
+require 'action_reporter/rails_reporter'
+require 'action_reporter/honeybadger_reporter'
+require 'action_reporter/sentry_reporter'
+require 'action_reporter/scout_apm_reporter'
+require 'action_reporter/audited_reporter'
+
+module ActionReporter
+  module_function
+
+  AVAILABLE_REPORTERS = [
+    ActionReporter::RailsReporter,
+    ActionReporter::HoneybadgerReporter,
+    ActionReporter::SentryReporter,
+    ActionReporter::ScoutApmReporter,
+    ActionReporter::AuditedReporter
+  ].freeze
+
+  @enabled_reporters = []
+
+  def enabled_reporters=(reporters)
+    @enabled_reporters = reporters
+  end
+
+  def enabled_reporters
+    @enabled_reporters
+  end
+
+  def notify(error, context: {})
+    enabled_reporters.each do |reporter|
+      new_context =
+        reporter.transform_context? ? transform_context(context) : context
+      reporter.notify(error, context: new_context)
+    end
+  end
+
+  def context(args)
+    enabled_reporters.each do |reporter|
+      new_args = reporter.transform_context? ? transform_context(args) : args
+      reporter.context(new_args)
+    end
+  end
+
+  def reset_context
+    enabled_reporters.each(&:reset_context)
+  end
+
+  def audited_user
+    enabled_reporters.find { |r| r.respond_to?(:audited_user) }&.audited_user
+  end
+
+  def transform_context(context)
+    ActionReporter::Utils.deep_transform_values(context.except(:audited_user)) do |value|
+      if value.respond_to?(:to_global_id)
+        value.to_global_id.to_s
+      else
+        value
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: action_reporter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrei Makarov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-18 00:00:00.000000000 Z
+dependencies: []
+description: Ruby wrapper for multiple reporting services
+email:
+- andrei@kiskolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- action_reporter.gemspec
+- lib/action_reporter.rb
+- lib/action_reporter/audited_reporter.rb
+- lib/action_reporter/base.rb
+- lib/action_reporter/honeybadger_reporter.rb
+- lib/action_reporter/rails_reporter.rb
+- lib/action_reporter/scout_apm_reporter.rb
+- lib/action_reporter/sentry_reporter.rb
+- lib/action_reporter/utils.rb
+- lib/action_reporter/version.rb
+homepage: https://github.com/amkisko/action_reporter
+licenses:
+- MIT
+metadata:
+  homepage: https://github.com/amkisko/action_reporter
+  source_code_uri: https://github.com/amkisko/action_reporter
+  bug_tracker_uri: https://github.com/amkisko/action_reporter/issues
+  changelog_uri: https://github.com/amkisko/action_reporter/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: See description
+test_files: []