resque-pagerduty 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc/*
+.yardoc/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.8.7@resque-pagerduty

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - ree
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--no-private
+--readme README.md
+lib/**/*.rb
+-
+CHANGELOG.md
+LICENSE.md

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# v0.0.1 (2012-09-19)
+
+* Initial release
+
+# v0.1.0 (2012-09-20)
+
+* Change name of gem to resque-pagerduty to conform with [resque's naming standard][resque-std]
+* Documentation updates
+* Travis CI integration
+
+[resque-std]: https://github.com/defunkt/resque/blob/master/docs/PLUGINS.md

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque_pagerduty.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2012 by Maeve Revels
+
+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,129 @@
+# resque-pagerduty [![build status][build-img]][build-pg]
+
+A Resque failure backend for triggering incidents in Pagerduty.
+
+[build-img]: https://secure.travis-ci.org/maeve/resque-pagerduty.png
+[build-pg]: http://travis-ci.org/#!/maeve/resque-pagerduty
+
+## Dependencies ##
+
+Depends on [Resque][resque] 1.7 or above.
+
+Requires a subscription to [Pagerduty][pagerduty], with at least one Pagerduty
+service configured with a service type of "Generic API".
+
+[resque]: https://github.com/defunkt/resque
+[pagerduty]: http://pagerduty.com
+
+## Installation ##
+
+To install from [Rubygems][rubygems]:
+
+    $ gem install resque-pagerduty
+
+To use with bundler without adding explicit require statements to your code,
+add the following to your Gemfile:
+
+    gem 'resque-pagerduty', :require => 'resque_pagerduty'
+
+[rubygems]: http://rubygems.org/gems/resque-pagerduty
+
+## Documentation ##
+
+Complete documentation for this gem (including this README) is available on
+[rubydoc.info][rubydoc].
+
+General information about resque failure backends is available on the
+[resque wiki][resque-failure].
+
+The Pagerduty website provides more information about the
+[Pagerduty Integration API][pd-integration-api].
+
+[resque-failure]: https://github.com/defunkt/resque/wiki/Failure-Backends
+[rubydoc]: http://rubydoc.info/gems/resque-pagerduty/frames
+[pd-integration-api]: http://developer.pagerduty.com/documentation/integration/events
+
+## Pagerduty Configuration ##
+
+To trigger incidents in the same Pagerduty service across all jobs, configure
+the failure backend with a Pagerduty service key:
+
+    Resque::Failure::Pagerduty.configure do |config|
+      config.service_key = 'my_pagerduty_service_key'
+    end
+
+This service must be set up as a "Generic API" service in Pagerduty. The
+service key GUID can be found on the Pagerduty service details page.
+
+You may want to have different jobs trigger incidents in different Pagerduty
+services. When handling an exception, the failure backend will automatically
+look for a class method named `pagerduty_service_key` on the resque payload
+class, and will preferentially use that callback. If this callback does not
+exist on the job class, it will default to using the `service_key` configured
+on the backend itself. For example:
+
+    class MyJob
+      @queue = :my_queue
+
+      def self.pagerduty_service_key
+        'my_custom_service_key'
+      end
+
+      def self.perform(my_arg)
+        # Some code that could raise an exception goes here
+      end
+    end
+
+If the `MyJob.perform` method raises an exception during processing, the
+failure backend would use the `MyJob.pagerduty_service_key` instead of the
+`Resque::Failure::Pagerduty.service_key` to trigger the incident.
+
+When there is no `Resque::Failure::Pagerduty.service_key` configured, and
+there is no `pagerduty_service_key` callback defined on the job class, then the
+failure backend will exit gracefully. This allows you to selectively enable
+Pagerduty notifications for some jobs without enabling them for all jobs.
+
+## Examples ##
+
+### Single Resque Failure Backend ###
+
+Using only the Pagerduty failure backend:
+
+    require 'resque/failure/pagerduty'
+
+    Resque::Failure::Pagerduty.configure do |config|
+      config.service_key = 'my_pagerduty_service_key'
+    end
+
+    Resque::Failure.backend = Resque::Failure::Pagerduty
+
+### Multiple Resque Failure Backends ###
+
+Using both the Redis and Pagerduty failure backends:
+
+    require 'resque/failure/pagerduty'
+    require 'resque/failure/redis'
+    require 'resque/failure/multiple'
+
+    Resque::Failure::Pagerduty.configure do |config|
+      config.service_key = 'my_pagerduty_service_key'
+    end
+
+    Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Pagerduty]
+    Resque::Failure.backend = Resque::Failure::Multiple
+
+## Contributing ##
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. `bundle install`
+4. `rake spec`
+5. Implement your feature or bug fix, including [specs][rspec].
+6. [Add, commit, and push][gitref] your changes to your fork.
+7. [Submit a pull request.][pr]
+
+[fork]: https://help.github.com/articles/fork-a-repo
+[branch]: http://learn.github.com/p/branching.html
+[rspec]: http://github.com/rspec/rspec
+[gitref]: http://gitref.org/
+[pr]: http://help.github.com/send-pull-requests/

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new
+end

data/lib/resque/failure/pagerduty.rb

@@ -0,0 +1,77 @@
+require 'resque'
+require 'redphone/pagerduty'
+
+module Resque
+  module Failure
+    # A Resque failure backend that handles exceptions by triggering
+    # incidents in the Pagerduty API
+    class Pagerduty < Base
+      class << self
+        # The default GUID of the Pagerduty "Generic API" service to be notified.
+        # This is the "service key" listed on a Generic API's service detail page
+        # in the Pagerduty app.
+        attr_accessor :service_key
+      end
+
+      # The GUID of the Pagerduty "Generic API" service to be notified.
+      # If a `pagerduty_service_key` callback is implemented on the payload
+      # class, then that will be used. Otherwise, the default
+      # {Resque::Failure::Pagerduty.service_key} will be used.
+      #
+      # @see .configure
+      def service_key
+        payload_class = Module.const_get(payload['class'])
+        if (payload_class.respond_to?(:pagerduty_service_key) &&
+            !payload_class.pagerduty_service_key.nil?)
+          payload_class.pagerduty_service_key
+        else
+          self.class.service_key
+        end
+      end
+
+      # Configure the failure backend for the Pagerduty API.
+      #
+      # @example Minimal configuration
+      #   Resque::Failure::Pagerduty.configure do |config|
+      #     config.service_key = '123abc456def'
+      #   end
+      #
+      # @see .service_key
+      def self.configure
+        yield self
+        self
+      end
+
+      # Reset configured values.
+      # @see .configure
+      def self.reset
+        self.service_key = nil
+      end
+
+      # Trigger an incident in Pagerduty when a job fails.
+      def save
+        if service_key
+          pagerduty_client.trigger_incident(
+            :description => "#{exception.class} in #{payload['class']}: #{exception.message}",
+            :details => {:queue => queue,
+                         :worker => worker.to_s,
+                         :payload => payload,
+                         :exception => {:class => exception.class.name,
+                                        :message => exception.message,
+                                        :backtrace => exception.backtrace}}
+          )
+        end
+      end
+
+      private
+      def pagerduty_client
+        Redphone::Pagerduty.new(
+          :service_key => service_key,
+          :subdomain => '',
+          :user => '',
+          :password => ''
+        )
+      end
+    end
+  end
+end

data/lib/resque_pagerduty.rb

@@ -0,0 +1 @@
+require 'resque/failure/pagerduty'

data/resque-pagerduty.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "resque-pagerduty"
+  s.version     = "0.1.0"
+  s.authors     = ["Maeve Revels"]
+  s.email       = ["maeve.revels@g5platform.com"]
+  s.homepage    = "http://github.com/maeve/resque-pagerduty"
+  s.summary     = "A Resque failure backend for Pagerduty"
+  s.description = <<-HERE
+  resque-pagerduty provides a Resque failure backend that triggers a Pagerduty
+  incident when an exception is raised by a job.
+  HERE
+
+  s.rubyforge_project = "resque-pagerduty"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('resque', '~>1.7')
+  s.add_dependency('redphone', '~>0.0.6')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~>2.11')
+  s.add_development_dependency('webmock', '~>1.7')
+  s.add_development_dependency('yard', '~>0.8')
+  s.add_development_dependency('redcarpet')
+end

data/spec/resque/failure/pagerduty_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+describe Resque::Failure::Pagerduty do
+  after { Resque::Failure::Pagerduty.reset }
+
+  describe 'instance methods' do
+    subject { backend }
+    let(:backend) { Resque::Failure::Pagerduty.new(exception, worker, queue, payload) }
+
+    let(:exception) do
+      error = StandardError.new('This is a test exception message')
+      error.set_backtrace(['dummy_file.rb:23','dummy_file.rb:42'])
+      error
+    end
+
+    let(:worker) { mock(:worker, :log => nil, :to_s => 'local.worker:1234') }
+    let(:queue) { 'my_queue' }
+
+    let(:payload) do
+      {'class' => payload_class.name,
+       'args' => payload_args}
+    end
+    let(:payload_class) { Class.new }
+    before { stub_const('TestPayloadClass', payload_class) }
+
+    let(:payload_args) { [123] }
+
+    describe '#initialize' do
+      its(:exception) { should == exception }
+      its(:worker) { should == worker }
+      its(:queue) { should == queue }
+      its(:payload) { should == payload }
+    end
+
+    describe '#service_key' do
+      subject { backend.service_key }
+
+      context 'when the backend class has a service_key' do
+        before { Resque::Failure::Pagerduty.service_key = default_service_key }
+        let(:default_service_key) { 'class123abc456def' }
+
+        context 'when the payload class has a pagerduty_service_key' do
+          before { payload_class.stub(:pagerduty_service_key => payload_service_key) }
+          let(:payload_service_key) { 'payloadfed654cba321' }
+
+          it { should == payload_service_key }
+        end
+
+        context 'when the payload class does not respond to service_key' do
+          it { should == default_service_key }
+        end
+
+        context 'when the payload class has a nil service_key' do
+          before { payload_class.stub(:pagerduty_service_key => nil) }
+
+          it { should == default_service_key }
+        end
+      end
+
+      context 'when the backend class has no service_key' do
+        context 'when the payload class has a service_key' do
+          before { payload_class.stub(:pagerduty_service_key => payload_service_key) }
+          let(:payload_service_key) { 'payloadfed654cba321' }
+
+          it { should == payload_service_key }
+        end
+
+        context 'when the payload class does not respond to service_key' do
+          it { should be_nil }
+        end
+
+        context 'when the payload class has a nil service_key' do
+          before { payload_class.stub(:pagerduty_service_key => nil) }
+
+          it { should be_nil }
+        end
+      end
+    end
+
+    describe '#save' do
+      subject(:save) { backend.save }
+
+      before do
+        stub_request(:any, /.*\.pagerduty\.com.*/).to_return(
+          :status => 200,
+          :headers => {'Content-Type' => 'application/json'},
+          :body => {'status' => 'success',
+                    'message' => 'Event processed',
+                    'incident_key' => '112358abcdef'}.to_json
+        )
+      end
+
+      context 'when there is a service key' do
+        before { Resque::Failure::Pagerduty.service_key = service_key }
+        let(:service_key) { 'my_key' }
+
+        it 'should send a post request to the pagerduty api' do
+          save
+          a_request(:post, /.*\.pagerduty\.com/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct endpoint' do
+          save
+          a_request(:any, 'https://events.pagerduty.com/generic/2010-04-15/create_event.json').should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct service key' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"service_key":"#{service_key}"/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct event_type' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"event_type":"trigger"/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct description' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"description":"#{exception.class} in #{payload_class}: #{exception.message}"/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct class in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"payload":\{.*"class":"#{payload_class.name}".*\}.*\}/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct args in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"payload":\{.*"args":\[123\].*\}.*\}/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct queue in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"queue":"#{queue}".*\}/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct worker in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"worker":"#{worker.to_s}".*\}/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct exception class in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"exception":\{.*"class":"#{exception.class.name}".*\}.*\}/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct exception message in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"exception":\{.*"message":"#{exception.message}".*\}.*\}/).should have_been_made
+        end
+
+        it 'should call the pagerduty api with the correct exception backtrace in the details' do
+          save
+          a_request(:any, /.*\.pagerduty\.com/).with(:body => /"details":\{.*"exception":\{.*"backtrace":\["dummy_file.rb:23","dummy_file.rb:42"\].*\}.*\}/).should have_been_made
+        end
+
+      end
+
+      context 'when there is no service key' do
+        it 'should not attempt to trigger an incident in pagerduty' do
+          save
+          a_request(:any, /.*.pagerduty.com/).should_not have_been_made
+        end
+      end
+    end
+
+    it { should respond_to(:log) }
+  end
+
+  describe 'class methods' do
+    subject { Resque::Failure::Pagerduty }
+
+    describe '.configure' do
+      subject(:configure) do
+        Resque::Failure::Pagerduty.configure do |config|
+          config.service_key = service_key
+        end
+      end
+
+      let(:service_key) { 'my_key' }
+
+      it 'should change the service key on the backend class' do
+        expect { configure }.to change { Resque::Failure::Pagerduty.service_key }.to(service_key)
+      end
+    end
+
+    describe '.reset' do
+      subject(:reset) { Resque::Failure::Pagerduty.reset }
+
+      before do
+        Resque::Failure::Pagerduty.configure do |config|
+          config.service_key = 'foo'
+        end
+      end
+
+      it 'should change the service key on the backend class' do
+        expect { reset }.to change { Resque::Failure::Pagerduty.service_key }.to(nil)
+      end
+    end
+
+    it { should respond_to(:count) }
+    it { should respond_to(:all) }
+    it { should respond_to(:url) }
+    it { should respond_to(:clear) }
+    it { should respond_to(:requeue) }
+    it { should respond_to(:remove) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+end
+
+require 'resque_pagerduty'

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification 
+name: resque-pagerduty
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Maeve Revels
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
+  prerelease: false
+  type: :runtime
+  name: resque
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
+        version: 0.0.6
+  prerelease: false
+  type: :runtime
+  name: redphone
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rake
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  prerelease: false
+  type: :development
+  name: rspec
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
+  prerelease: false
+  type: :development
+  name: webmock
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  prerelease: false
+  type: :development
+  name: yard
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: redcarpet
+  requirement: *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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/resque/failure/pagerduty.rb
+- lib/resque_pagerduty.rb
+- resque-pagerduty.gemspec
+- spec/resque/failure/pagerduty_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/maeve/resque-pagerduty
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: resque-pagerduty
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Resque failure backend for Pagerduty
+test_files: 
+- spec/resque/failure/pagerduty_spec.rb
+- spec/spec_helper.rb
+has_rdoc: