pagerduty 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22fab98bfd9b7ab4f99f8dd824b1ac10a6f7675
-  data.tar.gz: 5eb0a9c4074cd4aed73987137a3a53f81389c65f
+  metadata.gz: 79dcf1ccf6b3223a64d07a152f55b8a0b6a99f26
+  data.tar.gz: bd86c131d6b99b475ffe82082a307defff905ec7
 SHA512:
-  metadata.gz: 001b8bb1ed10ae2e54f315233bf55f30c7173141c584dfccbb04236e84a5a65b6157c7e088bd525bdb71b42e94481154214e019762c935ad8a2d004a536b99da
-  data.tar.gz: a4f2bfb76c69a3bfe86aa32d45ee7cb285e1920ccc249f270af018ff4971fa8cf246901230302cc72ae9e8fc2aefcc3b492a8c64abf65ce331dfebadf9b9111b
+  metadata.gz: e2d66e8ea5d2d101c6d5c484c51b5bbc0d9f7b462f2ef2a449344f7e8dd8b0b0b411fb336f978f2e28bf1d42b0ef46d1801f7ff04b2b953e0e9b046a8d71891c
+  data.tar.gz: 0d6614d6104796bda5868fc529da1ac8b75de6688c67df41fda5aae39e3a386654ad49178304a375483465c9585935a41b33327ac2c6b48b92db15f378e30400

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.2.0
+  - 2.1.5
   - 2.0.0
   - 1.9.3

data/README.md

@@ -1,5 +1,7 @@
 # pagerduty
 
+
+[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/pagerduty/blob/master/LICENSE.txt)
 [![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)
 
@@ -54,6 +56,20 @@ pagerduty.trigger(
 )
 ```
 
+### Debugging Error Responses
+
+The gem doesn't encapsulate HTTP error responses from PagerDuty. Here's how to go about debugging these unhappy cases:
+
+```ruby
+begin
+  pagerduty.trigger("incident description")
+rescue Net::HTTPServerException => error
+  error.response.code    #=> "400"
+  error.response.message #=> "Bad Request"
+  error.response.body    #=> "{\"status\":\"invalid event\",\"message\":\"Event object is invalid\",\"errors\":[\"Service key is the wrong length (should be 32 characters)\"]}"
+end
+```
+
 ### Upgrading to Version 2.0.0
 
 The API has changed in three ways that you need to be aware of:

data/lib/pagerduty/http_transport.rb

@@ -11,7 +11,7 @@ module Pagerduty::HttpTransport
   PORT = 443
   PATH = "/generic/2010-04-15/create_event.json"
 
-  def send(payload = {})
+  def send_payload(payload = {})
     response = post payload.to_json
     response.error! unless transported?(response)
     JSON.parse(response.body)

data/lib/pagerduty/version.rb

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

data/lib/pagerduty.rb

@@ -74,7 +74,7 @@ protected
       :service_key => service_key,
       :event_type => event_type,
     )
-    Pagerduty.transport.send(args)
+    Pagerduty.transport.send_payload(args)
   end
 
   def ensure_success(response)

data/pagerduty.gemspec

@@ -24,7 +24,8 @@ https://github.com/envato/pagerduty#upgrading-to-version-200
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency "json", ">= 1.7.7"
-  gem.add_development_dependency "bundler", "~> 1.6"
+  gem.add_development_dependency "bundler", "~> 1.7"
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
   gem.add_development_dependency "rspec-given"
 end

data/spec/pagerduty/http_transport_spec.rb

@@ -5,12 +5,12 @@ describe Pagerduty::HttpTransport do
   Given(:http_transport) { Pagerduty::HttpTransport }
 
   Given(:http) { double.as_null_object }
-  Given { http.stub(:request => standard_response) }
-  Given { Net::HTTP.stub(:new => http) }
+  Given { allow(http).to receive(:request).and_return(standard_response) }
+  Given { allow(Net::HTTP).to receive(:new).and_return(http) }
   Given(:post) { double.as_null_object }
-  Given { Net::HTTP::Post.stub(:new => post) }
+  Given { allow(Net::HTTP::Post).to receive(:new).and_return(post) }
 
-  describe "::send" do
+  describe "::send_payload" do
     Given(:payload) { {
       event_type: "trigger",
       service_key: "test-srvc-key",
@@ -18,7 +18,7 @@ describe Pagerduty::HttpTransport do
       details: { key: "value" },
     } }
 
-    When(:response) { http_transport.send(payload) }
+    When(:response) { http_transport.send_payload(payload) }
 
     describe "provides the correct request" do
       Then {
@@ -31,7 +31,7 @@ describe Pagerduty::HttpTransport do
     describe "handles all responses" do
 
       context "PagerDuty successfully creates the incident" do
-        Given { http.stub(:request => response_with_body(<<-JSON)) }
+        Given { allow(http).to receive(:request).and_return(response_with_body(<<-JSON)) }
           {
             "status": "success",
             "incident_key": "My Incident Key",
@@ -43,7 +43,7 @@ describe Pagerduty::HttpTransport do
       end
 
       context "PagerDuty fails to create the incident" do
-        Given { http.stub(:request => response_with_body(<<-JSON)) }
+        Given { allow(http).to receive(:request).and_return(response_with_body(<<-JSON)) }
           {
             "status": "failure",
             "message": "Event not processed"
@@ -54,7 +54,7 @@ describe Pagerduty::HttpTransport do
       end
 
       context "PagerDuty responds with HTTP bad request" do
-        Given { http.stub(:request => bad_request) }
+        Given { allow(http).to receive(:request).and_return(bad_request) }
         Then { expect(response).to have_raised Net::HTTPServerException }
       end
     end
@@ -78,7 +78,7 @@ describe Pagerduty::HttpTransport do
 
   def response_with_body(body)
     response = Net::HTTPSuccess.new 1.1, "200", "OK"
-    response.stub(:body => body)
+    allow(response).to receive(:body).and_return(body)
     response
   end
 

data/spec/pagerduty_spec.rb

@@ -6,17 +6,17 @@ describe Pagerduty do
   Given(:service_key) { "a-test-service-key" }
 
   Given(:transport) { double.as_null_object }
-  Given { Pagerduty.stub(:transport => transport) }
+  Given { allow(Pagerduty).to receive(:transport).and_return(transport) }
 
   describe "#trigger" do
 
     describe "provides the correct request" do
-      Given { transport.stub(:send => standard_response) }
+      Given { allow(transport).to receive(:send_payload).and_return(standard_response) }
 
       context "no options" do
         When(:incident) { pagerduty.trigger("a-test-description") }
         Then {
-          expect(transport).to have_received(:send).with(
+          expect(transport).to have_received(:send_payload).with(
             service_key: "a-test-service-key",
             event_type:  "trigger",
             description: "a-test-description",
@@ -35,7 +35,7 @@ describe Pagerduty do
           )
         }
         Then {
-          expect(transport).to have_received(:send).with(
+          expect(transport).to have_received(:send_payload).with(
             service_key:  "a-test-service-key",
             event_type:   "trigger",
             description:  "a-test-description",
@@ -51,12 +51,11 @@ describe Pagerduty do
     describe "handles all responses" do
 
       context "PagerDuty successfully creates the incident" do
-        Given {
-          transport.stub(:send => {
+        Given { allow(transport).to receive(:send_payload).and_return(
             "status" => "success",
             "incident_key" => "My Incident Key",
             "message" => "Event processed",
-          })
+          )
         }
         When(:incident) { pagerduty.trigger("description") }
         Then { expect(incident).to be_a PagerdutyIncident }
@@ -66,17 +65,17 @@ describe Pagerduty do
 
       context "PagerDuty fails to create the incident" do
         Given {
-          transport.stub(:send => {
+          allow(transport).to receive(:send_payload).and_return(
             "status" => "failure",
-            "message" => "Event not processed",
-          })
+            "message" => "Event not processed"
+          )
         }
         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)) }
+        Given { allow(transport).to receive(:send_payload).and_raise(Net::HTTPServerException.new(nil, nil)) }
         When(:incident) { pagerduty.trigger("description") }
         Then { expect(incident).to have_raised Net::HTTPServerException }
       end
@@ -98,12 +97,12 @@ describe Pagerduty do
     describe "#acknowledge" do
 
       describe "provides the correct request" do
-        Given { transport.stub(:send => standard_response) }
+        Given { allow(transport).to receive(:send_payload).and_return(standard_response) }
 
         context "no args" do
           When(:acknowledge) { incident.acknowledge }
           Then {
-            expect(transport).to have_received(:send).with(
+            expect(transport).to have_received(:send_payload).with(
               event_type: "acknowledge",
               service_key: "a-test-service-key",
               incident_key: "a-test-incident-key",
@@ -114,7 +113,7 @@ describe Pagerduty do
         context "a description" do
           When(:acknowledge) { incident.acknowledge("test-description") }
           Then {
-            expect(transport).to have_received(:send).with(
+            expect(transport).to have_received(:send_payload).with(
               event_type: "acknowledge",
               service_key: "a-test-service-key",
               incident_key: "a-test-incident-key",
@@ -126,7 +125,7 @@ describe Pagerduty do
         context "a description and details" do
           When(:acknowledge) { incident.acknowledge("test-description", { my: "detail" }) }
           Then {
-            expect(transport).to have_received(:send).with(
+            expect(transport).to have_received(:send_payload).with(
               event_type: "acknowledge",
               service_key: "a-test-service-key",
               incident_key: "a-test-incident-key",
@@ -141,11 +140,11 @@ describe Pagerduty do
 
         context "PagerDuty successfully acknowledges the incident" do
           Given {
-            transport.stub(:send => {
+            allow(transport).to receive(:send_payload).and_return(
               "status" => "success",
               "incident_key" => "a-test-incident-key",
-              "message" => "Event acknowledged",
-            })
+              "message" => "Event acknowledged"
+            )
           }
           When(:acknowledge) { incident.acknowledge }
           Then { expect(acknowledge).to be incident}
@@ -153,18 +152,18 @@ describe Pagerduty do
 
         context "PagerDuty fails to acknowledge the incident" do
           Given {
-            transport.stub(:send => {
+            allow(transport).to receive(:send_payload).and_return(
               "status" => "failure",
               "incident_key" => "a-test-incident-key",
               "message" => "Event not acknowledged",
-            })
+            )
           }
           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)) }
+          Given { allow(transport).to receive(:send_payload).and_raise(Net::HTTPServerException.new(nil, nil)) }
           When(:acknowledge) { incident.acknowledge }
           Then { expect(acknowledge).to have_failed Net::HTTPServerException }
         end
@@ -174,12 +173,12 @@ describe Pagerduty do
     describe "#resolve" do
 
       describe "provides the correct request" do
-        Given { transport.stub(:send => standard_response) }
+        Given { allow(transport).to receive(:send_payload).and_return(standard_response) }
 
         context "no args" do
           When(:resolve) { incident.resolve }
           Then {
-            expect(transport).to have_received(:send).with(
+            expect(transport).to have_received(:send_payload).with(
               event_type: "resolve",
               service_key: "a-test-service-key",
               incident_key: "a-test-incident-key",
@@ -190,7 +189,7 @@ describe Pagerduty do
         context "a description" do
           When(:resolve) { incident.resolve("test-description") }
           Then {
-            expect(transport).to have_received(:send).with(
+            expect(transport).to have_received(:send_payload).with(
               event_type: "resolve",
               service_key: "a-test-service-key",
               incident_key: "a-test-incident-key",
@@ -202,7 +201,7 @@ describe Pagerduty do
         context "a description and details" do
           When(:resolve) { incident.resolve("test-description", { my: "detail" }) }
           Then {
-            expect(transport).to have_received(:send).with(
+            expect(transport).to have_received(:send_payload).with(
               event_type: "resolve",
               service_key: "a-test-service-key",
               incident_key: "a-test-incident-key",
@@ -217,11 +216,11 @@ describe Pagerduty do
 
         context "PagerDuty successfully resolves the incident" do
           Given {
-            transport.stub(:send => {
+            allow(transport).to receive(:send_payload).and_return(
               "status" => "success",
               "incident_key" => "a-test-incident-key",
-              "message" => "Event resolved",
-            })
+              "message" => "Event resolved"
+            )
           }
           When(:resolve) { incident.resolve }
           Then { expect(resolve).to be incident}
@@ -229,17 +228,17 @@ describe Pagerduty do
 
         context "PagerDuty fails to create the incident" do
           Given {
-            transport.stub(:send => {
+            allow(transport).to receive(:send_payload).and_return(
               "status" => "failure",
-              "message" => "Event not resolved",
-            })
+              "message" => "Event not resolved"
+            )
           }
           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)) }
+          Given { allow(transport).to receive(:send_payload).and_raise(Net::HTTPServerException.new(nil, nil)) }
           When(:resolve) { incident.resolve }
           Then { expect(resolve).to have_failed Net::HTTPServerException }
         end
@@ -248,13 +247,13 @@ describe Pagerduty do
 
     describe "#trigger" do
       describe "provides the correct request" do
-        Given { transport.stub(:send => standard_response) }
+        Given { allow(transport).to receive(:send_payload).and_return(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(
+            expect(transport).to have_received(:send_payload).with(
               incident_key: "instance incident_key",
               service_key:  "a-test-service-key",
               event_type:   "trigger",
@@ -266,7 +265,7 @@ describe Pagerduty do
         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(
+            expect(transport).to have_received(:send_payload).with(
               incident_key: "method param incident_key",
               service_key:  "a-test-service-key",
               event_type:   "trigger",

data/spec/spec_helper.rb

@@ -5,5 +5,5 @@ require "rspec/given"
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
-  config.color_enabled = true
+  config.color = true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagerduty
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Charlie Somerville
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec-given
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Pagerduty Integration API client library