pagerduty 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a21cba28253d63d4b26aecb45783434ae59fa83
-  data.tar.gz: 44a5dc31dbc4e08d30b3e5253d6ffd37c23a2996
+  metadata.gz: b35425e697bdee8a4b3217052d579505b4655fc5
+  data.tar.gz: 4861fe46da3e2c532a0b351e9519e1e7ec2323ff
 SHA512:
-  metadata.gz: d4ad387665a715603f984b707987e126f9f90436d5f19ba690f4596cc0f75eb14dcbc8e5b6c3a85b7d74df21c769d177271e458f9034ea72c9c7315f726bcba6
-  data.tar.gz: 7599fd83260348840ea8ce61dedb6e982ce0fab3b3b7467913f86c997bc91b7cf419d3300c9c4bf96baef6e6c9042010dec540469e509fa636105a0ca1d3d0c8
+  metadata.gz: 6eb7f43eeaefad73c18f9e285258ebbc4c2381cd5478445f61e5102ed10f4c95fdd1319e4c8cc3950cf3b54b03ff2639b44eedc8917a0159948bdc4be767bbf0
+  data.tar.gz: 4472c21d7aac15ac890ac87a565414aabd573e0f7895d8339cc3b34fe587da915320caa208edc52891285a7c7b0a2d180e8b48d174f02a86a274d192b5b496d2

data/.gitignore

@@ -6,3 +6,4 @@ rdoc
 *.swo
 pkg
 .bundle
+/bin

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/README.md

@@ -1,6 +1,9 @@
 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.
 
 Installation

data/Rakefile

@@ -1,6 +1,13 @@
 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
 
-require 'rdoc/task'
 RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
@@ -9,4 +16,3 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-

data/lib/pagerduty.rb

@@ -1,7 +1,5 @@
-require 'json'
-require 'net/http'
-require 'net/https'
 require 'pagerduty/version'
+require 'pagerduty/http_transport'
 
 class PagerdutyException < Exception
   attr_reader :pagerduty_instance, :api_response
@@ -23,7 +21,7 @@ class Pagerduty
 
   def trigger(description, details = {})
     resp = api_call("trigger", description, details)
-    throw PagerdutyException.new(self, resp) unless resp["status"] == "success"
+    raise PagerdutyException.new(self, resp) unless resp["status"] == "success"
 
     PagerdutyIncident.new @service_key, resp["incident_key"]
   end
@@ -33,34 +31,23 @@ class Pagerduty
   end
 
 protected
-  def api_call(event_type, description, details = {})
-    params = { :event_type => event_type, :service_key => @service_key, :description => description, :details => details }
-    params.merge!({ :incident_key => @incident_key }) unless @incident_key == nil
-
-    url = URI.parse("https://events.pagerduty.com/generic/2010-04-15/create_event.json")
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = (url.scheme == 'https')
-    rootca = '/etc/ssl/certs'
-    if (File.directory?(rootca) && http.use_ssl?)
-      http.ca_path = rootca
-      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      http.verify_depth = 5
-    else
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    end
 
-    req = Net::HTTP::Post.new(url.request_uri)
-    req.body = JSON.generate(params)
+  def api_call(event_type, description, details = {})
+    params = {
+      :event_type => event_type,
+      :service_key => @service_key,
+      :description => description,
+      :details => details
+    }
+    params[:incident_key] = @incident_key if @incident_key
+    Pagerduty.transport.send(params)
+  end
 
-    res = http.request(req)
-    case res
-    when Net::HTTPSuccess, Net::HTTPRedirection
-      JSON.parse(res.body)
-    else
-      res.error!
+  class << self
+    def transport
+      Pagerduty::HttpTransport
     end
   end
-
 end
 
 class PagerdutyIncident < Pagerduty
@@ -72,14 +59,14 @@ class PagerdutyIncident < Pagerduty
 
   def acknowledge(description, details = {})
     resp = api_call("acknowledge", description, details)
-    throw PagerdutyException.new(self, resp) unless resp["status"] == "success"
+    raise PagerdutyException.new(self, resp) unless resp["status"] == "success"
 
     self
   end
 
   def resolve(description, details = {})
     resp = api_call("resolve", description, details)
-    throw PagerdutyException.new(self, resp) unless resp["status"] == "success"
+    raise PagerdutyException.new(self, resp) unless resp["status"] == "success"
 
     self
   end

data/lib/pagerduty/http_transport.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'json'
+require 'net/http'
+require 'net/https'
+
+module Pagerduty::HttpTransport
+  class << self
+
+    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
+
+  private
+
+    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 transported?(response)
+      response.kind_of? Net::HTTPSuccess or response.kind_of? Net::HTTPRedirection
+    end
+  end
+end

data/lib/pagerduty/version.rb

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

data/pagerduty.gemspec

@@ -18,5 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency "json", [">= 1.7.7"]
+  gem.add_runtime_dependency "json", ">= 1.7.7"
+  gem.add_development_dependency "bundler", "~> 1.6"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec-given"
 end

data/script/setup.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+echo "This command will setup your local dev environment, including"
+echo "  * bundle install"
+echo
+
+echo "Bundling..."
+bundle install --binstubs bin --path .bundle

data/spec/pagerduty/http_transport_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require "spec_helper"
+
+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(:post) { double.as_null_object }
+  Given { Net::HTTP::Post.stub(:new => post) }
+
+  describe "::send" do
+    Given(:payload) { {
+      event_type: "trigger",
+      service_key: "test-srvc-key",
+      description: "test-desc",
+      details: { key: "value" },
+    } }
+
+    When(:response) { http_transport.send(payload) }
+
+    describe "provides the correct request" do
+      Then {
+        expect(post).to have_received(:body=).with(
+          '{"event_type":"trigger","service_key":"test-srvc-key","description":"test-desc","details":{"key":"value"}}'
+        )
+      }
+    end
+
+    describe "handles all responses" do
+
+      context "PagerDuty successfully creates the incident" do
+        Given { http.stub(:request => response_with_body(<<-JSON)) }
+          {
+            "status": "success",
+            "incident_key": "My Incident Key",
+            "message": "Event processed"
+          }
+        JSON
+        Then { expect(response).to include("status" => "success") }
+        Then { expect(response).to include("incident_key" => "My Incident Key") }
+      end
+
+      context "PagerDuty fails to create the incident" do
+        Given { http.stub(:request => response_with_body(<<-JSON)) }
+          {
+            "status": "failure",
+            "message": "Event not processed"
+          }
+        JSON
+        Then { expect(response).to include("status" => "failure") }
+        Then { expect(response).to_not include("incident_key") }
+      end
+
+      context "PagerDuty responds with HTTP bad request" do
+        Given { http.stub(:request => bad_request) }
+        Then { expect(response).to have_raised Net::HTTPServerException }
+      end
+    end
+
+    describe "HTTPS use" do
+      Then { expect(http).to have_received(:use_ssl=).with(true) }
+      Then { expect(http).to have_received(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER) }
+      Then { expect(http).to_not have_received(:ca_path=) }
+      Then { expect(http).to_not have_received(:verify_depth=) }
+    end
+
+    describe "timeouts" do
+      Then { expect(http).to have_received(:open_timeout=).with(60) }
+      Then { expect(http).to have_received(:read_timeout=).with(60) }
+    end
+  end
+
+  def standard_response
+    response_with_body '{ "status": "success", "incident_key": "My Incident Key" }'
+  end
+
+  def response_with_body(body)
+    response = Net::HTTPSuccess.new 1.1, "200", "OK"
+    response.stub(:body => body)
+    response
+  end
+
+  def bad_request
+    Net::HTTPBadRequest.new 1.1, "400", "Bad Request"
+  end
+
+end

data/spec/pagerduty_spec.rb

@@ -0,0 +1,190 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Pagerduty do
+  Given(:pagerduty) { Pagerduty.new(service_key) }
+  Given(:service_key) { "a-test-service-key" }
+
+  Given(:transport) { double.as_null_object }
+  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" }
+        )
+      }
+    end
+
+    describe "handles all responses" do
+
+      context "PagerDuty successfully creates the incident" do
+        Given {
+          transport.stub(:send => {
+            "status" => "success",
+            "incident_key" => "My Incident Key",
+            "message" => "Event processed",
+          })
+        }
+        When(:incident) { pagerduty.trigger(description, details) }
+        Then { expect(incident).to be_a PagerdutyIncident }
+        Then { incident.service_key == service_key }
+        Then { incident.incident_key == "My Incident Key" }
+      end
+
+      context "PagerDuty fails to create the incident" do
+        Given {
+          transport.stub(:send => {
+            "status" => "failure",
+            "message" => "Event not processed",
+          })
+        }
+        When(:incident) { pagerduty.trigger(description, details) }
+        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) }
+        Then { expect(incident).to have_raised Net::HTTPServerException }
+      end
+    end
+  end
+
+  describe "#get_incident" do
+    Given(:incident_key) { "a-test-incident-key" }
+    When(:incident) { pagerduty.get_incident(incident_key) }
+    Then { expect(incident).to be_a PagerdutyIncident }
+    Then { incident.service_key == service_key }
+    Then { incident.incident_key == incident_key }
+  end
+
+  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",
+          )
+        }
+      end
+
+      describe "handles all responses" do
+
+        context "PagerDuty successfully acknowledges the incident" do
+          Given {
+            transport.stub(:send => {
+              "status" => "success",
+              "incident_key" => "a-test-incident-key",
+              "message" => "Event acknowledged",
+            })
+          }
+          When(:acknowledge) { incident.acknowledge(description, details) }
+          Then { expect(acknowledge).to be incident}
+        end
+
+        context "PagerDuty fails to acknowledge the incident" do
+          Given {
+            transport.stub(:send => {
+              "status" => "failure",
+              "incident_key" => "a-test-incident-key",
+              "message" => "Event not acknowledged",
+            })
+          }
+          When(:acknowledge) { incident.acknowledge(description, details) }
+          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) }
+          Then { expect(acknowledge).to have_failed Net::HTTPServerException }
+        end
+      end
+    end
+
+    describe "#resolve" 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",
+          )
+        }
+      end
+
+      describe "handles all responses" do
+
+        context "PagerDuty successfully resolves the incident" do
+          Given {
+            transport.stub(:send => {
+              "status" => "success",
+              "incident_key" => "a-test-incident-key",
+              "message" => "Event resolved",
+            })
+          }
+          When(:resolve) { incident.resolve(description, details) }
+          Then { expect(resolve).to be incident}
+        end
+
+        context "PagerDuty fails to create the incident" do
+          Given {
+            transport.stub(:send => {
+              "status" => "failure",
+              "message" => "Event not resolved",
+            })
+          }
+          When(:resolve) { incident.resolve(description, details) }
+          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) }
+          Then { expect(resolve).to have_failed Net::HTTPServerException }
+        end
+      end
+    end
+  end
+
+  def standard_response
+    { "status" => "success", "incident_key" => "My Incident Key" }
+  end
+
+  describe PagerdutyException do
+    Given(:pagerduty_instance) { double }
+    Given(:api_response) { double }
+
+    When(:pagerduty_exception) { PagerdutyException.new(pagerduty_instance, api_response) }
+
+    Then { pagerduty_exception.pagerduty_instance == pagerduty_instance }
+    Then { pagerduty_exception.api_response == api_response }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require "pagerduty"
+require "rspec/given"
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagerduty
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Charlie Somerville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,6 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a simple interface for calling into the Pagerduty API
 email:
 - charlie@charliesomerville.com
@@ -33,13 +75,19 @@ extra_rdoc_files: []
 files:
 - ".document"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/pagerduty.rb
+- lib/pagerduty/http_transport.rb
 - lib/pagerduty/version.rb
 - pagerduty.gemspec
+- script/setup.sh
+- spec/pagerduty/http_transport_spec.rb
+- spec/pagerduty_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/envato/pagerduty
 licenses:
 - MIT
@@ -60,8 +108,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Pagerduty API client library
-test_files: []
+test_files:
+- spec/pagerduty/http_transport_spec.rb
+- spec/pagerduty_spec.rb
+- spec/spec_helper.rb