talk-notifier 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84ac79987e8da4eaa1e0c3aa291bafe91ce3271f
-  data.tar.gz: 0e3da3d5c2a9b27bf61117d4a104c54bbb03d557
+  metadata.gz: 9b2d7e1e5ce60d32b1422c83e56b19c2cd5438b8
+  data.tar.gz: 337212f25be65b6280ff877b2d86416e4bbd7508
 SHA512:
-  metadata.gz: 34c6de2fe1eee2e1a10df93ecfac6b45f0f42f70c6ff3df50c8bb7a1f62ae0ff170ec6db8ff67a99f1c37b63b91ec2da19a49d1445b7f1bf91ea725994820582
-  data.tar.gz: 2538225cc39d23f49ef71760176569b4ab1229c2a5ed9edbaeb27ce106a227a7af11b72d43f4d406ac31be263b8ec0a53dd0be1c8d9028462be7246f395ddaf5
+  metadata.gz: 80265fc627645229368b4990905001e885392af321fcf283fdf2f57b39477c4e7a04266f81eb7a87d95ceeca7003b5ca2e61477bbee2c897b2397c3d30bf4dbf
+  data.tar.gz: 75beddf531c91f784ae8af79d1c68c0fc44c4d7d3a6fae551752383da30b322fcfb0645f9f22df963530bfd3e6acfa0205c0f858fe16d16d42725c67e89406fa

data/README.md

@@ -1,6 +1,6 @@
-# Talk::Notifier
+# ExceptionNotifier::TalkNotifier
 
-Notify exceptions using Talk.
+Notify exceptions using [Talk](http://jianliao.com).
 
 ## Installation
 
@@ -23,12 +23,15 @@ Or install it yourself as:
 Add following lines to your `exception-notification` configurations.
 
 ```ruby
-  Rails.application.config.middleware.use ExceptionNotification::Rack,
-                                          :talk => {
-                                              author_name: 'something you like', # message author name
-                                              hook_url: 'your hook url', # your hook url
-                                              backtrace_depth: 10, # (optional) backtrace depth you want, default 10
-                                          }
+  Rails.application.config.middleware.use(
+      ExceptionNotification::Rack,
+      :talk => {
+          hook_url: 'your hook url',         # your webhook url
+          author_name: 'something you like', # (optional) author name, default hostname
+          backtrace_depth: 10,               # (optional) backtrace depth you want, nil if you want full backtrace, default nil
+          clean_backtrace: false,            # (optional) whether or not to clean backtrace using Rails::BacktraceCleaner, default false
+      }
+  )
 ```
 
 ## Contributing

data/lib/exception_notifier/talk_notifier.rb

@@ -1,10 +1,14 @@
 require 'faraday'
+require 'socket'
 
 module ExceptionNotifier
   class TalkNotifier
+    include BacktraceCleaner
+
     def initialize(options)
-      @author_name = options[:author_name]
-      @backtrace_depth = options[:backtrace_depth] || 10
+      @author_name = options[:author_name] || Socket.gethostname
+      @backtrace_depth = options[:backtrace_depth]
+      @clean_backtrace = options[:clean_backtrace]
       @hook_url = options[:hook_url]
     end
 
@@ -12,8 +16,18 @@ module ExceptionNotifier
       Faraday.post(@hook_url, {
           authorName: @author_name,
           title: "#{exception.class.name}: #{exception.message}",
-          text: exception.backtrace.try(:[], 0, @backtrace_depth).try(:join, "\n")
+          text: stringify_exception(exception)
       })
     end
+
+    def stringify_exception(e)
+      if e.backtrace.present?
+        backtrace = @clean_backtrace ? clean_backtrace(e) : e.backtrace
+        backtrace = backtrace.first(@backtrace_depth) if @backtrace_depth
+        ["#{e.class.name}: #{e.message}", 'Backtrace: ', backtrace].join("\n")
+      else
+        "#{e.class.name}: #{e.message}"
+      end
+    end
   end
 end

data/talk-notifier.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'talk-notifier'
-  spec.version       = '1.0.0'
+  spec.version       = '1.0.1'
   spec.authors       = ['于湛']
   spec.email         = ['yuzhan1994@gmail.com']
 
@@ -16,5 +16,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'exception_notification', '~> 4.0'
-  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday', '~> 0.9', '>= 0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talk-notifier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - "于湛"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exception_notification
@@ -30,14 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: 
 email:
 - yuzhan1994@gmail.com