exceptions_to_slack 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18cbcfb3bda1a6a6032b8eed4782a3b5a321c1a7
-  data.tar.gz: eb275434209fe2a26010e8b97d5f6776295cd951
+  metadata.gz: e1041c85765abefc1378bcd1474ce18c48d487f3
+  data.tar.gz: 1d982c665a395c011f0c2a83770b3da45ce1cac5
 SHA512:
-  metadata.gz: e4bd13f1154dcf3c13365f81fe56c1b9419244f465224fd50c74f9125c7d12b17cd008ae2ddfac21d1cc8826d815d9584901cd87d866c40bc464052a3cd23393
-  data.tar.gz: 11465da40b9527a066b9853493d069fbd7e4651e1f44e5dc7ec09e58ba4f71bc3f9a7b459df8242404ae5342fc204e0c6df7bab5e080597ca4b8e166d18cd67d
+  metadata.gz: f21b0a3358b1d1a67f5fb162c6bbd04bb899bf96e6da6499483084000e03c842569a5a5efa852bb67b81373ae850169337451d26ea6687de615740ca8b597033
+  data.tar.gz: b72aaa2ac06cf42701b28933267490ccbba023f1fce26d8abef0982fe9fd462e6622f8d57e60cf56b8183263393650ef0940f202b08e4aa1040ea8a16361eab0

data/README.md

@@ -12,9 +12,13 @@ Add this line to your application's Gemfile:
 
 Rails 3: add as rack middleware to `application.rb'
 
-    config.middleware.use ExceptionsToSlack::Notifier,
-        :team => "YOUR TEAM",
-        :token => "YOUR TOKEN",
-        :channel => "YOUR CHANNEL",
-        :user => "USER MESSAGE WILL COME FROM"
+```ruby
+config.middleware.use ExceptionsToSlack::Notifier,
+    team: 'your-team-name',                        # required
+    token: 'your-api-token',                       # required, https://my.slack.com/services/new/incoming-webhook
+    channel: '#general',                           # required
+    user: 'Exception Notifier',                    # optional, defaults to Notifier
+    ignore: /Foo/,                                 # optional pattern for exceptions not to be sent
+    additional_parameters: {icon_emoji: ':ghost:'} # optional parameters to send to slack
+```
 

data/Rakefile

@@ -1,7 +1,8 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+task :test do
+  Dir.glob('./test/**/*_test.rb').each {|file| require file}
+end
 
-task :default => :spec
+task :default => :test
 

data/exceptions_to_slack.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.version       = ExceptionsToSlack::VERSION
 
   gem.add_dependency("slack-notifier", "~> 0.5.0")
-  gem.add_development_dependency("rspec", "~> 2.14.1")
+  gem.add_development_dependency("webmock", "~> 1.18.0")
 end

data/lib/exceptions_to_slack/notifier.rb

@@ -8,6 +8,7 @@ module ExceptionsToSlack
       @notifier.channel = options[:channel] || raise("Channel is required")
       @notifier.username = options[:user] || "Notifier"
       @ignore = options[:ignore]
+      @additional_parameters = options[:additional_parameters] || {}
     end
 
     def call(env)
@@ -17,20 +18,16 @@ module ExceptionsToSlack
       raise exception
     end
 
+    private
+
     def send_to_slack(exception)
       begin
-        @notifier.ping message_for(exception)
+        @notifier.ping message_for(exception), @additional_parameters.merge({attachments: [attachment_for(exception)]})
       rescue => slack_exception
         $stderr.puts "\nWARN: Unable to send message to Slack: #{slack_exception}\n"
       end
     end
 
-    def message_for(exception)
-      "[#{exception.class}] #{exception}"
-    end
-
-    private
-
     def team(options)
       options[:team] || raise("Team name is required")
     end
@@ -38,6 +35,18 @@ module ExceptionsToSlack
     def token(options)
       options[:token] || raise("Token is required")
     end
+
+    def message_for(exception)
+      "[#{exception.class}] #{exception}"
+    end
+
+    def attachment_for(exception)
+      {
+        fallback: 'Stack trace',
+        color: 'warning',
+        text: exception.backtrace.join("\n")
+      }
+    end
   end
 end
 

data/lib/exceptions_to_slack/version.rb

@@ -1,3 +1,3 @@
 module ExceptionsToSlack
-  VERSION = "1.0.0"
+  VERSION = '1.1.0'
 end

data/lib/exceptions_to_slack.rb

@@ -1,2 +1,2 @@
-require "exceptions_to_slack/version"
-require "exceptions_to_slack/notifier"
+require 'exceptions_to_slack/version'
+require 'exceptions_to_slack/notifier'

data/test/exceptions_to_slack/notifier_test.rb

@@ -0,0 +1,47 @@
+require_relative '../test_helper'
+
+class TestNotifier < MiniTest::Unit::TestCase
+  TEAM = 'the-team'
+  TOKEN = 'the-token'
+  CHANNEL = 'the-channel'
+
+  def setup
+    @app = MiniTest::Mock.new
+
+    @notifier = ExceptionsToSlack::Notifier.new(@app, {
+      team: TEAM,
+      token: TOKEN,
+      channel: CHANNEL,
+      ignore: /ignored/
+    })
+  end
+
+  def test_exceptions_are_sent_to_slack
+    def @app.call(env) raise ':boom:' end
+
+    WebMock.stub_request(:post, 'https://the-team.slack.com/services/hooks/incoming-webhook?token=the-token').with do |request|
+      form = URI.decode_www_form(request.body)
+
+      assert_equal 1, form.size
+      assert_equal 2, form[0].size
+      assert_equal 'payload', form[0][0]
+
+      payload = JSON.parse(form[0][1])
+      assert_equal '[RuntimeError] :boom:', payload['text']
+      assert_equal CHANNEL, payload['channel']
+      assert_equal 'Notifier', payload['username']
+      assert !payload['attachments'][0]['text'].empty?
+
+      true
+    end
+
+    -> {@notifier.call([])}.must_raise RuntimeError
+  end
+
+  def test_exceptions_that_are_ignored
+    def @app.call(env) raise 'should be ignored if raised' end
+    # WebMock will raise if we try to send something to slack
+
+    -> {@notifier.call([])}.must_raise RuntimeError
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'exceptions_to_slack'
+
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'webmock/test_unit'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: exceptions_to_slack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Darrin Holst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 1.18.0
 description: 
 email:
 - darrinholst@gmail.com
@@ -45,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -54,6 +54,8 @@ files:
 - lib/exceptions_to_slack.rb
 - lib/exceptions_to_slack/notifier.rb
 - lib/exceptions_to_slack/version.rb
+- test/exceptions_to_slack/notifier_test.rb
+- test/test_helper.rb
 homepage: http://github.com/darrinholst/exceptions_to_slack
 licenses: []
 metadata: {}
@@ -63,12 +65,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -77,4 +79,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Send rails exceptions to Slack
-test_files: []
+test_files:
+- test/exceptions_to_slack/notifier_test.rb
+- test/test_helper.rb