gl_exception_notifier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0140b506d32bf3272bb2c400553c538e5cd50e7bba93a1b4992d089185ffcf75
+  data.tar.gz: 32a19cd04ad7b6c4e15080efbd906167f478bb3e9946e51695534532dbc7f45c
+SHA512:
+  metadata.gz: 8f9a91f405b558c288f801ec4c11e47ca0deb898420930a98cb6de4349f79205cdeac46ff9d0f6f5c7adb7718a6960b286f1eed62b671d8b0cbb7106ec54be1d
+  data.tar.gz: 5d7291d7e040efd25363bd69f5ca0f7d782b24b8a594294a1b7c4aaa1891236c9d942f836db1112adce78ff1660f6c5e20cca4bc154ccf72420c053b756843ec

data/lib/gl_exception_notifier.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class GLExceptionNotifier
+  CONTEXT_TYPES = %i[extra_context tags_context user_context].freeze
+
+  class << self
+    def call(*args)
+      if exceptionable?(args.first)
+        capture_exception(args)
+      else
+        capture_message(args)
+      end
+    end
+
+    def capture_exception(args)
+      error_client.capture_exception(*args)
+    end
+
+    def capture_message(args)
+      if args.first.is_a?(String)
+        message = args.first
+        extra = args.length == 2 && args.last.is_a?(Hash) ? args.last : { parameters: args.drop(1) }
+      else
+        message_info = if args.first.is_a?(Hash)
+                         'called with kwargs, should have been positional'
+                       else
+                         'Unknown parameter set'
+                       end
+        message = "GLExceptionNotifier: #{message_info}"
+        extra = { parameters: args }
+      end
+
+      error_client.capture_message(message, extra:)
+    end
+
+    def exceptionable?(obj)
+      obj.is_a?(Exception) ||
+        (obj.respond_to?(:ancestors) && obj.ancestors.include?(Exception))
+    end
+
+    # @parmas type [Symbol] the type of context to add, either `:tags_context`, `:user_context`, or `:extra_context`
+    # @params context [Hash] the key values to add as context
+    def add_context(type, context)
+      unless CONTEXT_TYPES.include?(type)
+        raise ArgumentError,
+              'type paramater must be one of: :extra_context, :tags_context, :user_context'
+      end
+      raise ArgumentError, 'contexts must be a hash' unless context.is_a?(Hash)
+
+      case type
+      when :user_context
+        error_client.set_user(context)
+      when :tags_context
+        error_client.set_tags(context)
+      when :extra_context
+        error_client.set_extras(context)
+      end
+    end
+
+    # @params data [Hash] the key values to add to the breadcrumb
+    # @params message [String] the message string to add to the breadcrumb
+    def breadcrumbs(data:, message: nil)
+      raise ArgumentError, 'data must be a hash' unless data.is_a?(Hash)
+      raise ArgumentError, 'when providing a message, it must be a string' if message && !message.is_a?(String)
+
+      crumb = breadcrumb.new(message:, data:)
+      error_client.add_breadcrumb(crumb)
+      crumb
+    end
+
+    def last_breadcrumb
+      error_client.get_current_scope&.breadcrumbs&.peek
+    end
+
+    private
+
+    def error_client
+      Sentry
+    end
+
+    def breadcrumb
+      error_client::Breadcrumb
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: gl_exception_notifier
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Give Lively
+- Tim Lawrenz
+- Joe Anzalone
+- Dave Urban
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-rails
+  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: sentry-ruby
+  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: sentry-sidekiq
+  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'
+description: |-
+  To avoid having to update exception notifiers in all the different repositories,
+      we pull out commonalities and wrap them into gems
+email: tim@givelively.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gl_exception_notifier.rb
+homepage: https://github.com/givelively/gl_exception_notifier/
+licenses:
+- Apache
+metadata:
+  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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A wrapper for GiveLively's exception notifier
+test_files: []