pagerduty 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35425e697bdee8a4b3217052d579505b4655fc5
-  data.tar.gz: 4861fe46da3e2c532a0b351e9519e1e7ec2323ff
+  metadata.gz: a22fab98bfd9b7ab4f99f8dd824b1ac10a6f7675
+  data.tar.gz: 5eb0a9c4074cd4aed73987137a3a53f81389c65f
 SHA512:
-  metadata.gz: 6eb7f43eeaefad73c18f9e285258ebbc4c2381cd5478445f61e5102ed10f4c95fdd1319e4c8cc3950cf3b54b03ff2639b44eedc8917a0159948bdc4be767bbf0
-  data.tar.gz: 4472c21d7aac15ac890ac87a565414aabd573e0f7895d8339cc3b34fe587da915320caa208edc52891285a7c7b0a2d180e8b48d174f02a86a274d192b5b496d2
+  metadata.gz: 001b8bb1ed10ae2e54f315233bf55f30c7173141c584dfccbb04236e84a5a65b6157c7e088bd525bdb71b42e94481154214e019762c935ad8a2d004a536b99da
+  data.tar.gz: a4f2bfb76c69a3bfe86aa32d45ee7cb285e1920ccc249f270af018ff4971fa8cf246901230302cc72ae9e8fc2aefcc3b492a8c64abf65ce331dfebadf9b9111b

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Envato & Charlie Somerville
+Copyright (c) 2010 Envato, Charlie Somerville & Orien Madgwick
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,37 +1,87 @@
-pagerduty
-=========
+# pagerduty
 
 [![Gem Version](https://badge.fury.io/rb/pagerduty.svg)](http://badge.fury.io/rb/pagerduty)
 [![Build Status](https://travis-ci.org/envato/pagerduty.svg?branch=master)](https://travis-ci.org/envato/pagerduty)
 
-Provides a simple interface for calling into the [Pagerduty](http://pagerduty.com) API.
+Provides a lightweight Ruby interface for calling the [PagerDuty
+Integration API](http://developer.pagerduty.com/documentation/integration/events).
 
-Installation
-------------
+## Installation
 
-Install pagerduty with this command:
+Add this line to your application's Gemfile:
 
-    gem install pagerduty
+```ruby
+gem 'pagerduty'
+```
 
-Usage
------
+And then execute:
 
-Pagerduty exposes three classes, `Pagerduty`, `PagerdutyIncident` and `PagerdutyException`. Instances of `PagerdutyIncident` are created and returned for every API call.
+    $ bundle
 
-`Pagerduty`'s constructor takes 2 arguments - your `service_key` and an optional argument to set the 'incident_key' You can then use the method `trigger` to trigger a new incident with Pagerduty:
+Or install it yourself as:
 
-    require 'pagerduty'
-    p = Pagerduty.new "your_pagerduty_service_key"
-    incident = p.trigger "Everything went down!"
+    $ gem install pagerduty
 
-Incidents can be retriggered, acknowledged with the `PagerdutyIncident#acknowledge` method, and resolved with `PagerdutyIncident#resolve`.
+## Usage
 
-Additionally, all API methods (`trigger`, `acknowledge`, `resolve`) take an optional second parameter `details`, which should be a hash containing any extra information that should be recorded with Pagerduty.
+```ruby
+# Don't forget to require the library
+require "pagerduty"
 
-If the Pagerduty API does not return success, a `PagerdutyException` will be thrown which has the properties `pagerduty_instance` (the instance of either `Pagerduty` or `PagerdutyException` that caused the exception) and `api_response`, which is a hash representation of the JSON response from the Pagerduty API.
+# Instantiate a Pagerduty with your specific service key
+pagerduty = Pagerduty.new("<my-service-key>")
 
-Copyright
----------
+# Trigger an incident
+incident = pagerduty.trigger("incident description")
 
-Copyright (c) 2010 [Envato](http://envato.com) & [Charlie Somerville](http://charliesomerville.com). See LICENSE.txt for further details.
+# Acknowledge and/or resolve the incident
+incident.acknowledge
+incident.resolve
+```
 
+There are a whole bunch of properties you can send to PagerDuty when triggering
+an incident. See the [PagerDuty
+documentation](http://developer.pagerduty.com/documentation/integration/events/trigger)
+for the specifics.
+
+```ruby
+pagerduty.trigger(
+  "incident description",
+  :incident_key => "my unique incident identifier",
+  :client       => "server in trouble",
+  :client_url   => "http://server.in.trouble",
+  :details      => { :my => "extra details" },
+)
+```
+
+### Upgrading to Version 2.0.0
+
+The API has changed in three ways that you need to be aware of:
+
+1. `Pagerduty` class initialiser no longer accepts an `incident_key`. This
+attribute can now be provided when calling the `#trigger` method (see above).
+
+2. `Pagerduty#trigger` arguments have changed to accept all available options
+rather than just details.
+
+    ```ruby
+    # This no longer works post v2.0.0. If you're
+    # providing details in this form, please migrate.
+    pagerduty.trigger("desc", :key => "value")
+
+    # Post v2.0.0 this is how to send details (migrate to this please).
+    pagerduty.trigger("desc", :details => { :key => "value" })
+    ```
+
+3. `PagerdutyException` now extends from `StandardError` rather than
+`Exception`. This may affect how you rescue the error. i.e. `rescue
+StandardError` will now rescue a `PagerdutyException` where it did not
+before.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pagerduty/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,18 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "rdoc/task"
 
 task :default => :spec
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
-
-RDoc::Task.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "pagerduty #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/lib/pagerduty.rb

@@ -1,73 +1,162 @@
 require 'pagerduty/version'
 require 'pagerduty/http_transport'
 
-class PagerdutyException < Exception
+class PagerdutyException < StandardError
   attr_reader :pagerduty_instance, :api_response
 
-  def initialize(instance, resp)
+  def initialize(instance, response, message)
+    super(message)
     @pagerduty_instance = instance
-    @api_response = resp
+    @api_response = response
   end
 end
 
 class Pagerduty
 
-  attr_reader :service_key, :incident_key
+  attr_reader :service_key
 
-  def initialize(service_key, incident_key = nil)
+  # @param [String] service_key The GUID of one of your "Generic API" services.
+  #   This is the "service key" listed on a Generic API's service detail page.
+  #
+  def initialize(service_key)
     @service_key = service_key
-    @incident_key = incident_key
   end
 
-  def trigger(description, details = {})
-    resp = api_call("trigger", description, details)
-    raise PagerdutyException.new(self, resp) unless resp["status"] == "success"
-
-    PagerdutyIncident.new @service_key, resp["incident_key"]
+  # Send PagerDuty a trigger event to report a new or ongoing problem. When
+  # PagerDuty receives a trigger event, it will either open a new incident, or
+  # add a new trigger log entry to an existing incident, depending on the
+  # provided incident_key.
+  #
+  # @param [String] description A short description of the problem that led to
+  #   this trigger. This field (or a truncated version) will be used when
+  #   generating phone calls, SMS messages and alert emails. It will also appear
+  #   on the incidents tables in the PagerDuty UI. The maximum length is 1024
+  #   characters.
+  #
+  # @option options [String] :incident_key Identifies the incident to which
+  #   this trigger event should be applied. If there's no open (i.e. unresolved)
+  #   incident with this key, a new one will be created. If there's already an
+  #   open incident with a matching key, this event will be appended to that
+  #   incident's log. The event key provides an easy way to "de-dup" problem
+  #   reports. If this field isn't provided, PagerDuty will automatically open a
+  #   new incident with a unique key.
+  #
+  # @option options [String] :client The name of the monitoring client that is
+  #   triggering this event.
+  #
+  # @option options [String] :client_url The URL of the monitoring client that
+  #   is triggering this event.
+  #
+  # @option options [Hash] :details An arbitrary hash containing any data you'd
+  #   like included in the incident log.
+  #
+  # @return [PagerdutyIncident] The triggered incident.
+  #
+  # @raise [PagerdutyException] If PagerDuty responds with a status that is not
+  #   "success"
+  #
+  def trigger(description, options = {})
+    resp = api_call("trigger", options.merge(:description => description))
+    ensure_success(resp)
+    PagerdutyIncident.new service_key, resp["incident_key"]
   end
 
+  # @return [PagerdutyIncident] The incident referenced by the key.
+  #
   def get_incident(incident_key)
-    PagerdutyIncident.new @service_key, incident_key
+    PagerdutyIncident.new service_key, incident_key
   end
 
 protected
 
-  def api_call(event_type, description, details = {})
-    params = {
+  def api_call(event_type, args)
+    args = args.merge(
+      :service_key => service_key,
       :event_type => event_type,
-      :service_key => @service_key,
-      :description => description,
-      :details => details
-    }
-    params[:incident_key] = @incident_key if @incident_key
-    Pagerduty.transport.send(params)
+    )
+    Pagerduty.transport.send(args)
   end
 
-  class << self
-    def transport
-      Pagerduty::HttpTransport
+  def ensure_success(response)
+    unless response["status"] == "success"
+      raise PagerdutyException.new(self, response, response["message"])
     end
   end
+
+  # @api private
+  def self.transport
+    Pagerduty::HttpTransport
+  end
 end
 
 class PagerdutyIncident < Pagerduty
+  attr_reader :incident_key
 
+  # @param [String] service_key The GUID of one of your "Generic API" services.
+  #   This is the "service key" listed on a Generic API's service detail page.
+  #
+  # @param [String] incident_key The unique identifier for the incident.
+  #
   def initialize(service_key, incident_key)
     super service_key
     @incident_key = incident_key
   end
 
-  def acknowledge(description, details = {})
-    resp = api_call("acknowledge", description, details)
-    raise PagerdutyException.new(self, resp) unless resp["status"] == "success"
+  # @param (see Pagerduty#trigger)
+  # @option (see Pagerduty#trigger)
+  def trigger(description, options = {})
+    super(description, { :incident_key => incident_key }.merge(options))
+  end
 
-    self
+  # Acknowledge the referenced incident. While an incident is acknowledged, it
+  # won't generate any additional notifications, even if it receives new
+  # trigger events. Send PagerDuty an acknowledge event when you know someone
+  # is presently working on the problem.
+  #
+  # @param [String] description Text that will appear in the incident's log
+  #   associated with this event.
+  #
+  # @param [Hash] details An arbitrary hash containing any data you'd like
+  #   included in the incident log.
+  #
+  # @return [PagerdutyIncident] self
+  #
+  # @raise [PagerdutyException] If PagerDuty responds with a status that is not
+  #   "success"
+  #
+  def acknowledge(description = nil, details = nil)
+    modify_incident("acknowledge", description, details)
+  end
+
+  # Resolve the referenced incident. Once an incident is resolved, it won't
+  # generate any additional notifications. New trigger events with the same
+  # incident_key as a resolved incident won't re-open the incident. Instead, a
+  # new incident will be created. Send PagerDuty a resolve event when the
+  # problem that caused the initial trigger event has been fixed.
+  #
+  # @param [String] description Text that will appear in the incident's log
+  #   associated with this event.
+  #
+  # @param [Hash] details An arbitrary hash containing any data you'd like
+  #   included in the incident log.
+  #
+  # @return [PagerdutyIncident] self
+  #
+  # @raise [PagerdutyException] If PagerDuty responds with a status that is not
+  #   "success"
+  #
+  def resolve(description = nil, details = nil)
+    modify_incident("resolve", description, details)
   end
 
-  def resolve(description, details = {})
-    resp = api_call("resolve", description, details)
-    raise PagerdutyException.new(self, resp) unless resp["status"] == "success"
+private
 
+  def modify_incident(event_type, description, details)
+    options = { :incident_key => incident_key }
+    options[:description] = description if description
+    options[:details] = details if details
+    resp = api_call(event_type, options)
+    ensure_success(resp)
     self
   end
 

data/lib/pagerduty/http_transport.rb

@@ -3,38 +3,38 @@ require 'json'
 require 'net/http'
 require 'net/https'
 
+# @api private
 module Pagerduty::HttpTransport
-  class << self
+  extend self
 
-    HOST = "events.pagerduty.com"
-    PORT = 443
-    PATH = "/generic/2010-04-15/create_event.json"
+  HOST = "events.pagerduty.com"
+  PORT = 443
+  PATH = "/generic/2010-04-15/create_event.json"
 
-    def send(payload = {})
-      response = post payload.to_json
-      response.error! unless transported?(response)
-      JSON.parse(response.body)
-    end
+  def send(payload = {})
+    response = post payload.to_json
+    response.error! unless transported?(response)
+    JSON.parse(response.body)
+  end
 
-  private
+private
 
-    def post(payload)
-      post = Net::HTTP::Post.new(PATH)
-      post.body = payload
-      http.request(post)
-    end
+  def post(payload)
+    post = Net::HTTP::Post.new(PATH)
+    post.body = payload
+    http.request(post)
+  end
 
-    def http
-      http = Net::HTTP.new(HOST, PORT)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      http.open_timeout = 60
-      http.read_timeout = 60
-      http
-    end
+  def http
+    http = Net::HTTP.new(HOST, PORT)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.open_timeout = 60
+    http.read_timeout = 60
+    http
+  end
 
-    def transported?(response)
-      response.kind_of? Net::HTTPSuccess or response.kind_of? Net::HTTPRedirection
-    end
+  def transported?(response)
+    response.kind_of? Net::HTTPSuccess or response.kind_of? Net::HTTPRedirection
   end
 end

data/lib/pagerduty/version.rb

@@ -1,3 +1,3 @@
 class Pagerduty
-  VERSION = "1.4.1"
+  VERSION = "2.0.0"
 end

data/pagerduty.gemspec

@@ -6,13 +6,18 @@ require 'pagerduty/version'
 Gem::Specification.new do |gem|
   gem.name          = "pagerduty"
   gem.version       = Pagerduty::VERSION
-  gem.authors       = ["Charlie Somerville"]
-  gem.email         = ["charlie@charliesomerville.com"]
-  gem.description   = %q{Provides a simple interface for calling into the Pagerduty API}
-  gem.summary       = %q{Pagerduty API client library}
+  gem.authors       = ["Charlie Somerville", "Orien Madgwick"]
+  gem.email         = ["charlie@charliesomerville.com", "_@orien.io"]
+  gem.description   = %q{Provides a lightweight interface for calling the PagerDuty Integration API}
+  gem.summary       = %q{Pagerduty Integration API client library}
   gem.homepage      = "http://github.com/envato/pagerduty"
   gem.license       = "MIT"
 
+  gem.post_install_message = <<-MSG
+If upgrading to pagerduty 2.0.0 please note the API changes:
+https://github.com/envato/pagerduty#upgrading-to-version-200
+  MSG
+
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/spec/pagerduty_spec.rb

@@ -9,20 +9,43 @@ describe Pagerduty do
   Given { Pagerduty.stub(:transport => transport) }
 
   describe "#trigger" do
-    Given(:description) { "a-test-description" }
-    Given(:details) { { key: "value" } }
 
     describe "provides the correct request" do
       Given { transport.stub(:send => standard_response) }
-      When(:incident) { pagerduty.trigger(description, details) }
-      Then {
-        expect(transport).to have_received(:send).with(
-          event_type: "trigger",
-          service_key: "a-test-service-key",
-          description: "a-test-description",
-          details: { key: "value" }
-        )
-      }
+
+      context "no options" do
+        When(:incident) { pagerduty.trigger("a-test-description") }
+        Then {
+          expect(transport).to have_received(:send).with(
+            service_key: "a-test-service-key",
+            event_type:  "trigger",
+            description: "a-test-description",
+          )
+        }
+      end
+
+      context "all options" do
+        When(:incident) {
+          pagerduty.trigger(
+            "a-test-description",
+            incident_key: "a-test-incident-key",
+            client:       "a-test-client",
+            client_url:   "a-test-client-url",
+            details:      { key: "value" },
+          )
+        }
+        Then {
+          expect(transport).to have_received(:send).with(
+            service_key:  "a-test-service-key",
+            event_type:   "trigger",
+            description:  "a-test-description",
+            incident_key: "a-test-incident-key",
+            client:       "a-test-client",
+            client_url:   "a-test-client-url",
+            details:      { key: "value" },
+          )
+        }
+      end
     end
 
     describe "handles all responses" do
@@ -35,7 +58,7 @@ describe Pagerduty do
             "message" => "Event processed",
           })
         }
-        When(:incident) { pagerduty.trigger(description, details) }
+        When(:incident) { pagerduty.trigger("description") }
         Then { expect(incident).to be_a PagerdutyIncident }
         Then { incident.service_key == service_key }
         Then { incident.incident_key == "My Incident Key" }
@@ -48,13 +71,13 @@ describe Pagerduty do
             "message" => "Event not processed",
           })
         }
-        When(:incident) { pagerduty.trigger(description, details) }
+        When(:incident) { pagerduty.trigger("description") }
         Then { expect(incident).to have_raised PagerdutyException }
       end
 
       context "PagerDuty responds with HTTP bad request" do
         Given { transport.stub(:send).and_raise(Net::HTTPServerException.new(nil, nil)) }
-        When(:incident) { pagerduty.trigger(description, details) }
+        When(:incident) { pagerduty.trigger("description") }
         Then { expect(incident).to have_raised Net::HTTPServerException }
       end
     end
@@ -71,23 +94,47 @@ describe Pagerduty do
   describe PagerdutyIncident do
     Given(:incident) { PagerdutyIncident.new(service_key, incident_key) }
     Given(:incident_key) { "a-test-incident-key" }
-    Given(:description) { "a-test-description" }
-    Given(:details) { { key: "value" } }
 
     describe "#acknowledge" do
 
       describe "provides the correct request" do
         Given { transport.stub(:send => standard_response) }
-        When(:acknowledge) { incident.acknowledge(description, details) }
-        Then {
-          expect(transport).to have_received(:send).with(
-            event_type: "acknowledge",
-            service_key: "a-test-service-key",
-            description: "a-test-description",
-            details: { key: "value" },
-            incident_key: "a-test-incident-key",
-          )
-        }
+
+        context "no args" do
+          When(:acknowledge) { incident.acknowledge }
+          Then {
+            expect(transport).to have_received(:send).with(
+              event_type: "acknowledge",
+              service_key: "a-test-service-key",
+              incident_key: "a-test-incident-key",
+            )
+          }
+        end
+
+        context "a description" do
+          When(:acknowledge) { incident.acknowledge("test-description") }
+          Then {
+            expect(transport).to have_received(:send).with(
+              event_type: "acknowledge",
+              service_key: "a-test-service-key",
+              incident_key: "a-test-incident-key",
+              description: "test-description",
+            )
+          }
+        end
+
+        context "a description and details" do
+          When(:acknowledge) { incident.acknowledge("test-description", { my: "detail" }) }
+          Then {
+            expect(transport).to have_received(:send).with(
+              event_type: "acknowledge",
+              service_key: "a-test-service-key",
+              incident_key: "a-test-incident-key",
+              description: "test-description",
+              details: { my: "detail" },
+            )
+          }
+        end
       end
 
       describe "handles all responses" do
@@ -100,7 +147,7 @@ describe Pagerduty do
               "message" => "Event acknowledged",
             })
           }
-          When(:acknowledge) { incident.acknowledge(description, details) }
+          When(:acknowledge) { incident.acknowledge }
           Then { expect(acknowledge).to be incident}
         end
 
@@ -112,13 +159,13 @@ describe Pagerduty do
               "message" => "Event not acknowledged",
             })
           }
-          When(:acknowledge) { incident.acknowledge(description, details) }
+          When(:acknowledge) { incident.acknowledge }
           Then { expect(acknowledge).to have_failed PagerdutyException }
         end
 
         context "PagerDuty responds with HTTP bad request" do
           Given { transport.stub(:send).and_raise(Net::HTTPServerException.new(nil, nil)) }
-          When(:acknowledge) { incident.acknowledge(description, details) }
+          When(:acknowledge) { incident.acknowledge }
           Then { expect(acknowledge).to have_failed Net::HTTPServerException }
         end
       end
@@ -128,16 +175,42 @@ describe Pagerduty do
 
       describe "provides the correct request" do
         Given { transport.stub(:send => standard_response) }
-        When(:resolve) { incident.resolve(description, details) }
-        Then {
-          expect(transport).to have_received(:send).with(
-            event_type: "resolve",
-            service_key: "a-test-service-key",
-            description: "a-test-description",
-            details: { key: "value" },
-            incident_key: "a-test-incident-key",
-          )
-        }
+
+        context "no args" do
+          When(:resolve) { incident.resolve }
+          Then {
+            expect(transport).to have_received(:send).with(
+              event_type: "resolve",
+              service_key: "a-test-service-key",
+              incident_key: "a-test-incident-key",
+            )
+          }
+        end
+
+        context "a description" do
+          When(:resolve) { incident.resolve("test-description") }
+          Then {
+            expect(transport).to have_received(:send).with(
+              event_type: "resolve",
+              service_key: "a-test-service-key",
+              incident_key: "a-test-incident-key",
+              description: "test-description",
+            )
+          }
+        end
+
+        context "a description and details" do
+          When(:resolve) { incident.resolve("test-description", { my: "detail" }) }
+          Then {
+            expect(transport).to have_received(:send).with(
+              event_type: "resolve",
+              service_key: "a-test-service-key",
+              incident_key: "a-test-incident-key",
+              description: "test-description",
+              details: { my: "detail" },
+            )
+          }
+        end
       end
 
       describe "handles all responses" do
@@ -150,7 +223,7 @@ describe Pagerduty do
               "message" => "Event resolved",
             })
           }
-          When(:resolve) { incident.resolve(description, details) }
+          When(:resolve) { incident.resolve }
           Then { expect(resolve).to be incident}
         end
 
@@ -161,17 +234,48 @@ describe Pagerduty do
               "message" => "Event not resolved",
             })
           }
-          When(:resolve) { incident.resolve(description, details) }
+          When(:resolve) { incident.resolve }
           Then { expect(resolve).to have_failed PagerdutyException }
         end
 
         context "PagerDuty responds with HTTP bad request" do
           Given { transport.stub(:send).and_raise(Net::HTTPServerException.new(nil, nil)) }
-          When(:resolve) { incident.resolve(description, details) }
+          When(:resolve) { incident.resolve }
           Then { expect(resolve).to have_failed Net::HTTPServerException }
         end
       end
     end
+
+    describe "#trigger" do
+      describe "provides the correct request" do
+        Given { transport.stub(:send => standard_response) }
+
+        context "no options" do
+          Given(:incident_key) { "instance incident_key" }
+          When(:trigger) { incident.trigger("description") }
+          Then {
+            expect(transport).to have_received(:send).with(
+              incident_key: "instance incident_key",
+              service_key:  "a-test-service-key",
+              event_type:   "trigger",
+              description:  "description",
+            )
+          }
+        end
+
+        context "with incident_key option" do
+          When(:trigger) { incident.trigger("description", incident_key: "method param incident_key") }
+          Then {
+            expect(transport).to have_received(:send).with(
+              incident_key: "method param incident_key",
+              service_key:  "a-test-service-key",
+              event_type:   "trigger",
+              description:  "description",
+            )
+          }
+        end
+      end
+    end
   end
 
   def standard_response
@@ -181,10 +285,12 @@ describe Pagerduty do
   describe PagerdutyException do
     Given(:pagerduty_instance) { double }
     Given(:api_response) { double }
+    Given(:message) { "a test error message" }
 
-    When(:pagerduty_exception) { PagerdutyException.new(pagerduty_instance, api_response) }
+    When(:pagerduty_exception) { PagerdutyException.new(pagerduty_instance, api_response, message) }
 
     Then { pagerduty_exception.pagerduty_instance == pagerduty_instance }
     Then { pagerduty_exception.api_response == api_response }
+    Then { pagerduty_exception.message == message }
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pagerduty
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Charlie Somerville
+- Orien Madgwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,14 +67,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides a simple interface for calling into the Pagerduty API
+description: Provides a lightweight interface for calling the PagerDuty Integration
+  API
 email:
 - charlie@charliesomerville.com
+- _@orien.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".document"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -92,7 +94,9 @@ homepage: http://github.com/envato/pagerduty
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  If upgrading to pagerduty 2.0.0 please note the API changes:
+  https://github.com/envato/pagerduty#upgrading-to-version-200
 rdoc_options: []
 require_paths:
 - lib
@@ -111,7 +115,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Pagerduty API client library
+summary: Pagerduty Integration API client library
 test_files:
 - spec/pagerduty/http_transport_spec.rb
 - spec/pagerduty_spec.rb

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt