resque_slack_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8e2809889856e72c43bff16e5875243b99ca0ad
+  data.tar.gz: 5ae329eb29f2153b31ea48134c10a4ce1df122bb
+SHA512:
+  metadata.gz: 0d93749bee8ae46f876851ce209dba907e538d031322c4dbf212c5b7e858ea6c20267c67597df63f1beff6c4991f0458a3e6cfa1c791bff83c3852a47bf079b6
+  data.tar.gz: 9ff66a8def879896a9bae64c1540a91b4dcccf31228f25c384556db128f38fe170faa851d7d776b4da56a6b3a50c0529e9b126fdd01d7c692d5d9287a5bb5efc

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Keegan Leitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# ResqueSlackNotifier
+
+Sends a message to Slack whenever a Resque job raises an uncaught exception.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque_slack_notifier'
+```
+
+And then do a `bundle install`:
+
+```
+$ bundle
+```
+
+## Setup
+
+Configure the notifier in `config/initializers/resque.rb`:
+
+```ruby
+require "resque/failure/multiple"
+require "resque/failure/redis"
+require "resque/failure/slack_notifier"
+
+Resque::Failure::SlackNotifier.configure(
+  webhook_url:  "your slack webhook url",
+  channel:      "#some-channel-name",
+  display_name: "The Display Name for the Messages",
+  notify_channel: true # if you want the messages to start with "@channel"
+)
+
+Resque::Failure::Multiple.classes = [ Resque::Failure::Redis, Resque::Failure::SlackNotifier ]
+Resque::Failure.backend = Resque::Failure::Multiple
+```
+
+You can supply a YAML file for the configuration instead, and point to its path:
+
+```ruby
+require "resque/failure/multiple"
+require "resque/failure/redis"
+require "resque/failure/slack_notifier"
+                                             # use your project's root if it's not a Rails app, obviously
+Resque::Failure::SlackNotifier.config_path = File.join(Rails.root, 'path/to/slack_notifier_config.yml')
+
+Resque::Failure::Multiple.classes = [ Resque::Failure::Redis, Resque::Failure::SlackNotifier ]
+Resque::Failure.backend = Resque::Failure::Multiple
+```
+
+...where `path/to/slack_notifier_config.yml` looks like this:
+
+```yaml
+# path/to/slack_notifier_config.yml
+
+webhook_url:    https://hooks.slack.com/services/s0m3/g4rb4g3/l1k3th1s
+channel:        '#resque-failures' # or whatever channel you'd like to be notified in
+display_name:   Failed Resque Job Notifier
+notify_channel: true
+```
+
+The only _required_ option, no matter which configuration method you choose, is `webhook_url`. The `channel` option defaults to `"#general"`, `display_name` defaults to `"Resque worker failure"`, and `notify_channel` defaults to `false`.
+
+## Usage
+
+That's all there is, really. As long as you have Slack set up properly, you should get a notification any time an exception goes uncaught in a Resque job.
+
+## Bug reports
+
+If you encounter a bug, you can report it at https://github.com/kjleitz/resque_slack_notifier/issues. Please include the following information, if possible:
+
+- the contents of your `config/initializers/resque.rb` file
+- the contents of your configuration `.yml` file (if applicable)
+- your soul (for eating)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kjleitz/resque_slack_notifier.

data/lib/resque/failure/slack_notifier.rb

@@ -0,0 +1,58 @@
+require 'yaml'
+require 'slack-notifier'
+
+module Resque
+  module Failure
+    class SlackNotifier < Base
+      DEFAULT_CONFIG_OPTIONS = {
+        channel:        "#general",
+        display_name:   "Resque worker failure",
+        notify_channel: false
+      }.freeze
+
+      class << self
+        attr_accessor :config, :client
+
+        def configure(**options)
+          valid_keys      = %i(webhook_url channel display_name notify_channel)
+          config_options  = options.select { |key| valid_keys.include? key }
+
+          self.config = DEFAULT_CONFIG_OPTIONS.merge config_options
+          self.client = Slack::Notifier.new config[:webhook_url],
+            channel:  config[:channel],
+            username: config[:display_name]
+        end
+
+        def config_path=(path)
+          configure YAML.load_file(path).symbolize_keys
+        end
+
+        def count
+          Stat[:failed]
+        end
+      end
+
+      def client
+        self.class.client
+      end
+
+      def config
+        self.class.config
+      end
+
+      def save
+        raise "Client not configured" unless client && config
+
+        message = [
+          "#{"<!channel> " if config[:notify_channel]}Resque worker failure!",
+          "Worker: #{worker}",
+          "Queue:  #{queue}",
+          "Job:    #{payload['class']}",
+          "Args:   #{payload['args']}"
+        ].join "\n"
+
+        client.ping message
+      end
+    end
+  end
+end

data/lib/resque_slack_notifier/version.rb

@@ -0,0 +1,3 @@
+module ResqueSlackNotifier
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: resque_slack_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keegan Leitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Resque::Failure back-end which sends a Slack message whenever a Resque
+  worker fails.
+email:
+- kjleitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/resque/failure/slack_notifier.rb
+- lib/resque_slack_notifier/version.rb
+homepage: https://github.com/kjleitz/resque_slack_notifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Slack notifier for failed Resque jobs
+test_files: []