resque-notifier 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 833e7246647a929aab42f3baf7269274ffada518
-  data.tar.gz: ba0e756e3e3a1b96e6c1ef9f72767bd3a4cc8d58
+  metadata.gz: 4eaa19742898bd370221847670522b38c4adbb50
+  data.tar.gz: 4cf637b5f47fd8e4b1fdafa50e8609a467752c71
 SHA512:
-  metadata.gz: 5fb9acc085ffb3b66e9ebd79f3feb27fadbe16bad1ada57ea30e51780659ff122983afce52a48480ba073651f4f6f0893285b4aae4f140e9037b4ea433682ab0
-  data.tar.gz: 022940ae48e9937c86c39f148b9aaa50c320411c481232e1586082c316511f80e67e2a807dd670182899fda86d2e57ddd312f9812ed4d83396ca8e1abc971d7f
+  metadata.gz: 23ccbd9239ea132a31d19e018057e1ef2f1faecee89908aec37cbf5a24a5459265ad87cd53ae42b3b193bf3547e3f61b68dcf034bc8d62bf3b44c85fc23e7e6d
+  data.tar.gz: 15c7615b67e4bd5806cf0720fd11c4aa35d0276ffd97c72a38252c6cb26c7d137924cf8247c0440fca63bbf3d18b5e7e9397f5030c9755273fa8d0cf481b5632

data/README.md

@@ -1,5 +1,6 @@
 # Resque::Notifier
 
+[![Build Status](https://circleci.com/gh/daveed/resque-notifier.svg?style=shield&circle-token=6c0248354723eb52f17d7fcee18969620278f6a6)](https://circleci.com/gh/daveed/resque-notifier/tree/master)
 [![Code Climate](https://codeclimate.com/github/daveed/resque-notifier/badges/gpa.svg)](https://codeclimate.com/github/daveed/resque-notifier) [![Test Coverage](https://codeclimate.com/github/daveed/resque-notifier/badges/coverage.svg)](https://codeclimate.com/github/daveed/resque-notifier/coverage)
 
 Resque Notifier is a Resque plugin that sends notifications when a job fails.
@@ -26,7 +27,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### This gem activates a notifier when environment variables are set.
+
+    example: Slack
+    RESQUE_HOOK=https://hooks.slack.com/services/<generated_hash>
+    RESQUE_CHANNEL="#channel-name"
+
+### Add the Notifier backend to your existing Resque configuration (config/initializers/resque.rb)
+
+```ruby
+require 'resque/failure/notifier'
+Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Notifier]
+Resque::Failure.backend = Resque::Failure::Multiple
+```
+    
+
 
 ## Contributing
 

data/lib/core_ext/string.rb

@@ -0,0 +1,22 @@
+# from activesupport/lib/active_support/core_ext/object/blank.rb
+
+class String
+  BLANK_REGEX = /\A[[:space:]]*\z/
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    BLANK_REGEX === self
+  end
+
+end

data/lib/env_resque.rb

@@ -0,0 +1,25 @@
+require "core_ext/string"
+
+module EnvResque
+
+  def env_resque_channel
+    ENV["RESQUE_CHANNEL"]
+  end
+
+  def env_resque_hook
+    ENV["RESQUE_HOOK"]
+  end
+
+  def env_resque_host
+    ENV["RESQUE_HOST"]
+  end
+
+  def haz_env_resque_host?
+    !env_resque_host.blank?
+  end
+
+  def haz_required_envs?
+    !env_resque_channel.blank? && !env_resque_hook.blank?
+  end
+
+end

data/lib/resque/failure/notifier.rb

@@ -1,21 +1,66 @@
-require 'resque'
-require 'uri'
-require 'net/http'
+require "uri"
+require "resque"
+require "net/http"
+require "env_resque"
 
 module Resque
   module Failure
     class Notifier < Base
 
+      include EnvResque
+
       def save
-        uri     = URI(ENV['RESQUE_HOOK'])
-        payload = { channel:    ENV['RESQUE_CHANNEL'],
-                   username:   "resque",
-                   text:       "text",
-                   icon_emoji: ":ghost:"}.to_json
-        Net::HTTP.post_form(uri, payload: payload)
+        return unless haz_required_envs?
+        unless exception_logged_already?
+          uri     = URI(env_resque_hook)
+          payload = {
+            channel:    env_resque_channel,
+            username:   "resque",
+            text:       text,
+            icon_emoji: ":ghost:"
+          }.to_json
+          Net::HTTP.post_form(uri, payload: payload)
+        end
       end
 
-    end
+      def exception_logged_already?
+        count = 0
+        failed_resque_jobs.each do |failed_job|
+          break if count > 1
+          if failed_job.include?(error_class) && failed_job.include?(error_exception)
+            count += 1
+          end
+        end
+        count > 1 ? true : false
+      end
+
+      def failed_resque_jobs
+        Resque.redis.lrange("failed", 0, 1000)
+      end
+
+      def text
+        "Worker: #{worker.to_s}      \n" \
+        "Class: #{link_to_class}      \n" \
+        "Exception: #{error_exception} \n" \
+        "Error: #{exception.to_s}       \n"
+      end
 
+      def link_to_class
+        if haz_env_resque_host?
+          "#{env_resque_host}/resque/failed/?class=#{error_class}"
+        else
+          error_class
+        end
+      end
+
+      def error_exception
+        (exception && exception.class).to_s
+      end
+
+      def error_class
+        (payload && payload["class"]).to_s
+      end
+
+    end
   end
 end

data/lib/resque/notifier/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module Notifier
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/resque_notifier_spec.rb

@@ -2,4 +2,17 @@ require 'spec_helper'
 
 describe Resque::Notifier do
 
+  context "Slack Notifications" do
+
+    it 'should display the exception message in Slack' do
+    end
+
+    it 'should return the exception type' do
+    end
+
+    it 'should prevent too many messages being displayed' do
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - daveed
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -182,8 +182,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/core_ext/string.rb
+- lib/env_resque.rb
 - lib/resque/failure/notifier.rb
-- lib/resque/notifier.rb
 - lib/resque/notifier/version.rb
 - resque-notifier.gemspec
 - spec/resque_notifier_spec.rb

data/lib/resque/notifier.rb

@@ -1,6 +0,0 @@
-require "resque/notifier/version"
-
-module Resque
-  module Notifier
-  end
-end