resque-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78d0b80f0f855aa5fdc798995494912b2b0af915
+  data.tar.gz: 769178553de497d952e8c7f175b3e6dad0f79d7b
+SHA512:
+  metadata.gz: fa15713942cea5dd021493870cfb1ce164b35109ba1961a1e1fb192b8db0cf0a827c02db25ada984a234b991376e038a38646e369367abb88fda692b2b74784b
+  data.tar.gz: 4ce830385a993b7de64907b3c04c4420bae177e5a1c387cd63e715fef6d53d80818c5b14ecf9f69a0810a1fa61aa7869d4c06b24b0ba0855a7c8a6a57cce68ad

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Julien Blanchard
+
+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.markdown

@@ -0,0 +1,56 @@
+Resque Slack
+============
+
+A [Resque][rq] plugin. Requires Resque >= 1.19 and a >= 1.9 Ruby (MRI, JRuby or Rubinius).
+
+Post a notification in a [Slack][slack] channel when one your jobs fails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-slack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-slack
+
+## Usage
+
+Configure your channel, token and notification verbosity:
+```ruby
+require 'resque/failure/slack'
+
+Resque::Failure::Slack.configure do |config|
+  config.channel = 'CHANNEL_ID'  # required
+  config.token = 'TEAM_TOKEN'    # required
+  config.level = verbosity_level # optional
+end
+
+Resque::Failure.backend = Resque::Failure::Slack
+
+```
+
+Level can be:
+- verbose: worker, payload, exception and full backtrace
+- compact: worker, payload and exception
+- minimal: worker and payload only
+
+NB: Your team token is found [here](https://api.slack.com/#auth)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[rq]: http://github.com/julienXX/resque
+[slack]: http://slack.com
+
+[![Build Status](https://travis-ci.org/julienXX/resque-slack.png)](https://travis-ci.org/julienXX/resque-slack) [![Code Climate](https://codeclimate.com/github/julienXX/resque-slack.png)](https://codeclimate.com/github/julienXX/resque-slack)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/resque/failure/slack.rb

@@ -0,0 +1,108 @@
+require 'resque'
+require 'uri'
+require 'net/http'
+
+module Resque
+  module Failure
+    class Slack < Base
+      LEVELS = %i(verbose compact minimal)
+      SLACK_URL = 'https://slack.com/api'
+
+      class << self
+        attr_accessor :channel # Slack channel id.
+        attr_accessor :token   # Team token
+
+        # Notification style:
+        #
+        # verbose: full backtrace (default)
+        # compact: exception only
+        # minimal: worker and payload
+        attr_accessor :level
+
+        def level
+          @level && LEVELS.include?(@level) ? @level : :verbose
+        end
+      end
+
+      # Configures the failure backend. You will need to set
+      # a channel id and a team token.
+      #
+      # @example Configure your Slack account:
+      #   Resque::Failure::Slack.configure do |config|
+      #     config.channel = 'CHANNEL_ID'
+      #     config.token = 'TOKEN'
+      #     config.verbose = true or false, true is the default
+      #   end
+      def self.configure
+        yield self
+        fail 'Slack channel and token are not configured.' unless configured?
+      end
+
+      def self.configured?
+        !!channel && !!token
+      end
+
+      # Sends the exception data to the Slack channel.
+      #
+      # When a job fails, a new instance is created and #save is called.
+      def save
+        return unless self.class.configured?
+
+        report_exception
+      end
+
+      # Sends a HTTP Post to the Slack api.
+      #
+      def report_exception
+        uri = URI.parse(SLACK_URL + '/chat.postMessage')
+        params = { 'channel' => self.class.channel, 'token' => self.class.token, 'text' => text }
+        Net::HTTP.post_form(uri, params)
+      end
+
+      # Text to be displayed in the Slack notification
+      #
+      def text
+        send("text_#{self.class.level}")
+      end
+
+      protected
+
+      def msg_worker
+       "#{worker} failed processing #{queue}"
+      end
+
+      def msg_payload
+        "Payload:\n#{payload.inspect.split("\n").map { |l| '  ' + l }.join('\n')}"
+      end
+
+      def msg_exception(backtrace)
+        str = "Exception:\n#{exception}"
+        str += "\n#{exception.backtrace.map { |l| '  ' + l }.join('\n')}" if backtrace
+      end
+
+      def text_verbose
+        <<-EOF
+#{msg_worker}
+#{msg_payload}
+#{msg_exception(true)}
+        EOF
+      end
+
+      def text_compact
+        <<-EOF
+#{msg_worker}
+#{msg_payload}
+#{msg_exception(false)}
+        EOF
+      end
+
+      def text_minimal
+        <<-EOF
+#{msg_worker}
+#{msg_payload}
+        EOF
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'resque'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'resque', 'failure', 'slack'))
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end
+
+# Require ruby files in support dir.
+Dir[File.expand_path('spec/support/*.rb')].each { |file| require file }

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: resque-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Blanchard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Slack notifications for your failed jobs
+email:
+- julien@sideburns.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/resque/failure/slack.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/julienXX/resque-slack
+licenses: []
+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: resque-slack
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Post Slack notifications whenever one of your Resque jobs fails
+test_files: []