exception_notification-lark-notifier 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0a0ee12c91e89f27b20f8af7803b09cc1cad5c4c81de4f4740add60409af83
-  data.tar.gz: 5c9d14db23ec2f71276cd1cfbfe026fdc620f465dee858b32a5f2876903ee3c8
+  metadata.gz: e5f0ab0e3d65f71e4078769b0261b913088a32b48c400e731f6bc88b97db15b9
+  data.tar.gz: e54d66cb04d799fa8f6df66e13b3b5ea2befa83b9f22c75daeff8e6bd5b3aa4b
 SHA512:
-  metadata.gz: 2045bebbcc8ef6f9428b28c80203660d37109fc96267b9123a2e0e00872b91b4914ca12695bf2e153d0d86e2df1715ce7129fb62d7be95e098da2fc432425350
-  data.tar.gz: b3bc14d8e61f6caa17d373becb1baeca121ba0b0892c6a28fa7db5664c601f4431b30731ad6356cd190ca78bdf4e49ca4a61282c1364e3458d5b4a5a3eebfee2
+  metadata.gz: aca1f9d76f52fcdbc8cb5b994862a6b1af7867bc5db0b77ab89fa5f664387ecb9ee095e7795d3a18d2eb4f152b08d9b8c27559c0f1ca4db8fbdbe2b5286db57b
+  data.tar.gz: 7ddb0447939c148d101d174a6c9c2dfc4922e2c8ea71d0be8d7218f425953eab4e9e3faf3bd69187bbb35856e9e5359c66b8e214c93efd98dcfc06a221b4273f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_notification-lark-notifier (0.0.1)
+    exception_notification-lark-notifier (1.0.1)
       exception_notification (~> 4.0)
       http (~> 5.0)
 

data/README.md

@@ -55,6 +55,18 @@ The Incoming WebHook URL on Lark.
 
 The secret key for *Signature validation*.
 
+#### app_name
+
+*String, optional*
+
+Your application name, shown in the notification.
+
+#### env_name
+
+*String, optional*
+
+Your env name, shown in the notification.
+
 #### http
 
 *Hash, optional*

data/lib/exception_notification-lark-notifier/version.rb

@@ -1,3 +1,3 @@
 module ExceptionNotificationLarkNotifier
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/exception_notifier/lark_notifier.rb

@@ -2,19 +2,44 @@ module ExceptionNotifier
   class LarkNotifier
     include ExceptionNotifier::BacktraceCleaner
 
+    class << self
+      def rails_app_name
+        return unless defined?(::Rails) && ::Rails.respond_to?(:application)
+        if ::Gem::Version.new(::Rails.version) >= ::Gem::Version.new("6.0")
+          ::Rails.application.class.module_parent_name
+        else
+          ::Rails.application.class.parent_name
+        end
+      end
+
+      def rails_env_name
+        return unless defined?(::Rails) && ::Rails.respond_to?(:env)
+        ::Rails.env
+      end
+    end
+
     def initialize(options)
-      @default_appname = "#{rails_app_name} (env: #{rails_env_name})" if rails_app_name && rails_env_name
+      @default_app_name = self.class.rails_app_name
+      @default_env_name = self.class.rails_env_name
+      @default_options = options
+
       @notifier = ExceptionNotificationLarkNotifier::Client.new(
         options.slice(:webhook_url, :webhook_secret, :http)
       )
     end
 
-    def call(exception, options = {})
-      title = @default_appname ? "Exception Occurred in #{@default_appname}" : "Exception Occurred"
-      clean_message = exception.message.tr("`", "'")
-      backtrace = exception.backtrace ? clean_backtrace(exception) : ""
-      info, data = information_from_options(exception.class, options)
-      fields = fields(clean_message, backtrace, data)
+    def call(exception, call_options = {})
+      options = call_options.merge(@default_options)
+      app_name = options.delete(:app_name) || @default_app_name
+      env_name = options.delete(:env_name) || @default_env_name
+
+      title = "Exception Occurred"
+      title += " in #{app_name}" if app_name
+      title += " (env: #{env_name})" if env_name
+
+      backtrace = exception.backtrace ? clean_backtrace(exception) : []
+      summary, data = information_from_options(exception.class, options)
+      fields = fields(exception.message, backtrace, data)
 
       @notifier.post interactive: {
         header: {
@@ -22,7 +47,7 @@ module ExceptionNotifier
         },
         elements: [{
           tag: "div",
-          text: {tag: "lark_md", content: info},
+          text: {tag: "lark_md", content: summary},
           fields: fields
         }]
       }
@@ -30,26 +55,26 @@ module ExceptionNotifier
 
     private
 
-    def fields(clean_message, backtrace, data)
+    def fields(message, backtrace, data)
       fields = []
 
-      unless clean_message.empty?
+      unless message.empty?
         fields << {is_short: false, text: {tag: "lark_md", content: "**Message:**"}}
-        fields << {is_short: false, text: {tag: "plain_text", content: clean_message}}
-        fields << {is_short: false, text: {tag: "lark_md", content: "\n"}}
+        fields << {is_short: false, text: {tag: "plain_text", content: message}}
+        fields << {is_short: false, text: {tag: "plain_text", content: "\n"}}
       end
 
       unless backtrace.empty?
         fields << {is_short: false, text: {tag: "lark_md", content: "**Backtrace:**"}}
         fields << {is_short: false, text: {tag: "plain_text", content: backtrace.first(10).join("\n")}}
-        fields << {is_short: false, text: {tag: "lark_md", content: "\n"}}
+        fields << {is_short: false, text: {tag: "plain_text", content: "\n"}}
       end
 
       unless data.empty?
         data = data.map { |k, v| "#{k}: #{v}" }.join("\n")
         fields << {is_short: false, text: {tag: "lark_md", content: "**Data:**"}}
         fields << {is_short: false, text: {tag: "plain_text", content: data}}
-        fields << {is_short: false, text: {tag: "lark_md", content: "\n"}}
+        fields << {is_short: false, text: {tag: "plain_text", content: "\n"}}
       end
 
       fields
@@ -79,19 +104,5 @@ module ExceptionNotifier
 
       [text, data]
     end
-
-    def rails_app_name
-      return unless defined?(::Rails) && ::Rails.respond_to?(:application)
-      if ::Gem::Version.new(::Rails.version) >= ::Gem::Version.new("6.0")
-        ::Rails.application.class.module_parent_name
-      else
-        ::Rails.application.class.parent_name
-      end
-    end
-
-    def rails_env_name
-      return unless defined?(::Rails) && ::Rails.respond_to?(:env)
-      ::Rails.env
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-lark-notifier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - John Doe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exception_notification