resque-pagerduty 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,6 +1,6 @@
-# v0.0.1 (2012-09-19)
+# v0.1.1 (2013-06-27)
 
-* Initial release
+* Bug fix: truncate descriptions longer than 120 character. See issue #1.
 
 # v0.1.0 (2012-09-20)
 
@@ -9,3 +9,7 @@
 * Travis CI integration
 
 [resque-std]: https://github.com/defunkt/resque/blob/master/docs/PLUGINS.md
+
+# v0.0.1 (2012-09-19)
+
+* Initial release

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in resque_pagerduty.gemspec
 gemspec
+
+gem 'pry'

data/lib/resque/failure/generates_pagerduty_desc.rb

@@ -0,0 +1,32 @@
+module Resque
+  module Failure
+    class GeneratesPagerdutyDesc
+      MAX_LENGTH = 120
+      OMISSION = '...'
+
+      def initialize(exception, payload)
+        @exception = exception
+        @payload = payload
+      end
+
+      def execute
+        if full_message.length > MAX_LENGTH
+          full_message.slice(0, MAX_LENGTH - OMISSION.length) + OMISSION
+        else
+          full_message
+        end
+      end
+
+      def self.execute(exception, payload)
+        new(exception, payload).execute
+      end
+
+      private
+
+      def full_message
+        @full_message ||= "#{@exception.class} in #{@payload['class']}: #{@exception.message}"
+      end
+
+    end
+  end
+end

data/lib/resque/failure/pagerduty.rb

@@ -1,5 +1,6 @@
 require 'resque'
 require 'redphone/pagerduty'
+require 'resque/failure/generates_pagerduty_desc'
 
 module Resque
   module Failure
@@ -52,7 +53,7 @@ module Resque
       def save
         if service_key
           pagerduty_client.trigger_incident(
-            :description => "#{exception.class} in #{payload['class']}: #{exception.message}",
+            :description => description,
             :details => {:queue => queue,
                          :worker => worker.to_s,
                          :payload => payload,
@@ -64,6 +65,11 @@ module Resque
       end
 
       private
+
+      def description
+        @description ||= GeneratesPagerdutyDesc.execute(exception, payload)
+      end
+
       def pagerduty_client
         Redphone::Pagerduty.new(
           :service_key => service_key,

data/resque-pagerduty.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "resque-pagerduty"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   s.authors     = ["Maeve Revels"]
   s.email       = ["maeve.revels@g5platform.com"]
   s.homepage    = "http://github.com/maeve/resque-pagerduty"

data/spec/resque/failure/generates_pagerduty_desc_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Resque::Failure::GeneratesPagerdutyDesc do
+  describe '.execute' do
+    let(:payload) { {'class' => 'PayloadClass'} }
+
+    context 'the complete description is 118 characters or more' do
+      let(:exception) { ArgumentError.new('very long message'*8) }
+
+      it 'should return a truncated description ending with an ellipsis' do
+        message = described_class.execute(exception, payload)
+        expect(message).to include('ArgumentError in PayloadClass: very long message')
+        expect(message).to match(/\.{3}$/)
+        expect(message.length).to eq(120)
+      end
+    end
+
+    context 'the complete description is less than 118 characters' do
+      let(:exception) { ArgumentError.new('My message') }
+
+      it 'should return the complete description' do
+        expect(described_class.execute(exception, payload)).
+          to eq('ArgumentError in PayloadClass: My message')
+      end
+    end
+  end
+end

data/spec/resque/failure/pagerduty_spec.rb

@@ -154,6 +154,35 @@ describe Resque::Failure::Pagerduty do
           a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"exception":\{.*"backtrace":\["dummy_file.rb:23","dummy_file.rb:42"\].*\}.*\}/).should have_been_made
         end
 
+        it 'should trigger an incident with a description and details' do
+          pagerduty_client = double
+          Redphone::Pagerduty.stub(:new).with(hash_including(
+            :service_key => service_key,
+            :subdomain => '',
+            :user => '',
+            :password => ''
+          )).and_return(pagerduty_client)
+
+          Resque::Failure::GeneratesPagerdutyDesc.stub(:execute).
+            with(exception, payload).and_return('Generated description')
+
+          pagerduty_client.should_receive(:trigger_incident).with(hash_including(
+            :description => 'Generated description',
+            :details => {
+              :queue => queue,
+              :worker => worker.to_s,
+              :payload => payload,
+              :exception => {
+                :class => exception.class.name,
+                :message => exception.message,
+                :backtrace => exception.backtrace
+              }
+            }
+          ))
+
+          save
+        end
+
       end
 
       context 'when there is no service key' do
@@ -162,7 +191,7 @@ describe Resque::Failure::Pagerduty do
           a_request(:any, /.*.pagerduty.com/).should_not have_been_made
         end
       end
-    end
+    end # end describe #save
 
     it { should respond_to(:log) }
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-pagerduty
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Maeve Revels
@@ -15,10 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-21 00:00:00 Z
+date: 2013-06-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -28,12 +30,12 @@ dependencies:
         - 1
         - 7
         version: "1.7"
-  prerelease: false
   type: :runtime
-  name: resque
-  requirement: *id001
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: redphone
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,12 +46,12 @@ dependencies:
         - 0
         - 6
         version: 0.0.6
-  prerelease: false
   type: :runtime
-  name: redphone
-  requirement: *id002
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -58,12 +60,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :development
-  name: rake
-  requirement: *id003
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -73,12 +75,12 @@ dependencies:
         - 2
         - 11
         version: "2.11"
-  prerelease: false
   type: :development
-  name: rspec
-  requirement: *id004
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -88,12 +90,12 @@ dependencies:
         - 1
         - 7
         version: "1.7"
-  prerelease: false
   type: :development
-  name: webmock
-  requirement: *id005
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -103,12 +105,12 @@ dependencies:
         - 0
         - 8
         version: "0.8"
-  prerelease: false
   type: :development
-  name: yard
-  requirement: *id006
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  name: redcarpet
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -117,10 +119,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :development
-  name: redcarpet
-  requirement: *id007
+  version_requirements: *id007
 description: "  resque-pagerduty provides a Resque failure backend that triggers a Pagerduty\n  incident when an exception is raised by a job.\n"
 email: 
 - maeve.revels@g5platform.com
@@ -141,9 +141,11 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- lib/resque/failure/generates_pagerduty_desc.rb
 - lib/resque/failure/pagerduty.rb
 - lib/resque_pagerduty.rb
 - resque-pagerduty.gemspec
+- spec/resque/failure/generates_pagerduty_desc_spec.rb
 - spec/resque/failure/pagerduty_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/maeve/resque-pagerduty
@@ -175,11 +177,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: resque-pagerduty
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Resque failure backend for Pagerduty
 test_files: 
+- spec/resque/failure/generates_pagerduty_desc_spec.rb
 - spec/resque/failure/pagerduty_spec.rb
 - spec/spec_helper.rb
 has_rdoc: