rack-error_to_slack 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fae7b84a0557b3adfc1a873e2e7180c371d68a91
-  data.tar.gz: 8b9b5a2596aa20b51aae08d909109b77a5595804
+  metadata.gz: 810f5c37accd02145848b8d6f1e5cbef69095f04
+  data.tar.gz: 3aab9b26d73df2d1c5077b17b82a13fe28a6257a
 SHA512:
-  metadata.gz: 0970b1be8f09618c6ff6637f5015f426d7030fb973dd7034833f8f86bd90d3f8d70edd3056637ac6358a569dfb0e53094812d1731f9ad6b5c5b187c14e1d1ecb
-  data.tar.gz: 3b1e6a0dda0ba62be52fec40150ebd19cd6e22564ade41eb20e639b5cd49b13b8edc99004fbf86c777ed04cb586de1685230b188361688b4e357923b43e0b61d
+  metadata.gz: 60588c8efc4663ee3eba0aba90a43f19ab4a21309b5271557fdf70e64ab1aae5cd8290b5e9cb7632d5b6f34f65fc1d8de590d91854f0c0d7bba295fb6105f716
+  data.tar.gz: b055bf06e447d0ff1339e29c09af3b873d03d204c7d55cff7c895276de88f77fda68997e6983cf1b430ca828cdff6aad2100806da0126d8681fd18cc3ff987f1

data/README.md

@@ -1,7 +1,9 @@
 # Rack::ErrorToSlack
 This is a rack middleware that post error to slack.  
+Strongly recommended to use **only Development environment**.  
 EXAMPLE: ![](https://github.com/showwin/rack-error_to_slack/blob/master/doc/sample.png)
 
+Inspired by [hitode909/Plack-Middleware-PostErrorToSlack](https://github.com/hitode909/Plack-Middleware-PostErrorToSlack)
 
 ## Installation
 
@@ -22,13 +24,13 @@ Or install it yourself as:
 ## Usage
 ### for Rails 4.x
 #### Step1
-`config/environments/development.rb`
+config/environments/development.rb
 ```
-config.middleware.use Rack::ErrorToSlack
+config.middleware.insert_before ActionDispatch::RemoteIp, Rack::ErrorToSlack
 ```
 
 #### Step2
-`config/initializers/error_to_slack.rb`
+config/initializers/error_to_slack.rb
 ```
 Rack::ErrorToSlack.configure do |config|
   config.webhook_url = 'https://hooks.slack.com/services/your_webhook_url'
@@ -42,5 +44,26 @@ Rack::ErrorToSlack.configure do |config|
 end
 ```
 
+## :warning: WARNING :warning:
+This gem is recommended to use **only Development environment**.  
+Your application cannot respond to users until `rack-error_to_message` succeeds to post error message to Slack.
+
+
+Following settings are recommended.
+
+Gemfile
+```
+gem 'rack-error_to_slack', group: :development
+```
+
+config/initializers/error_to_slack.rb
+```
+if Rails.env == "development"
+  Rack::ErrorToSlack.configure do |config|
+    config.webhook_url = 'https://hooks.slack.com/services/your_webhook_url'
+  end
+end
+```
+
 ## LICENSE
 [MIT](https://github.com/showwin/rack-error_to_slack/blob/master/LICENSE)

data/lib/rack/error_to_slack.rb

@@ -13,7 +13,7 @@ module Rack
       begin
         response = @app.call(env)
       rescue Exception => exception
-        Message.new(env, exception.message).send
+        Message.new(env, exception.message, $@.first).send
         raise exception
       end
       response

data/lib/rack/error_to_slack/message.rb

@@ -6,12 +6,13 @@ module Rack
   class ErrorToSlack
     # Message Class
     class Message
-      def initialize(env, err_msg)
+      def initialize(env, err_msg, err_location)
         @data = {
-          'text': "#{username} encountered an error while " \
-                  "`#{env['REQUEST_METHOD']} #{env['PATH_INFO']}` " \
+          'text': "#{username} encountered an error " \
+                  "while `#{env['REQUEST_METHOD']} #{env['PATH_INFO']}` " \
                   "on branch `#{branch}`\n" \
-                  "```#{err_msg}```",
+                  "```#{err_msg}```\n" \
+                  "`#{err_location.gsub(/^#{root_path}/, '').tr('`', "'")}`",
           'username': slackname,
           'icon_emoji': emoji
         }
@@ -24,6 +25,10 @@ module Rack
 
       private
 
+      def root_path
+        Rails.root.to_s || ''
+      end
+
       def username
         ErrorToSlack.configuration.username
       end

data/lib/rack/error_to_slack/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class ErrorToSlack
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-error_to_slack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - showwin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler