lita-pagerduty 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fa275bada173401c6fdac456b713176375ae8f5
-  data.tar.gz: 410ca4278874a6cd332f9e134d982a3f7830c80a
+  metadata.gz: 4a28972f5fc4c637f95ea379c642402c8857feca
+  data.tar.gz: 2e2622aacc42cdaa1140447a83ad253c6423e2e3
 SHA512:
-  metadata.gz: af72dc0772235f9202fc14ebabe43594a56bd2782a4e432b92424e2984383d083cf77e9aa84dd2d561f7716d8a63f7d34e96df9f93877baa9f6ba51beb548727
-  data.tar.gz: f65a55fb1c4802f2ec3420b0e3af35ee4ed24bd779849f6107f53826fbface9241d2b7b6f0b46807c190bf11f2cd39d2709939b52ca50a2659dc0298bec223ee
+  metadata.gz: 0730876673981ee24e02c9a1c00f45bd0689de3bb4ffb06fb4506cb730f1f04c77c55b5fc0c70ba36b998ff10992a14ea54bbe0bf76683ca1741c7cf46adb8c7
+  data.tar.gz: 44bfee93a0e97ac22c1d1700cd5f4be54f0e1be66e9d22c1be155212bcf40fbe0c5b39d1e876caad6f84065840d85aa9a75a5f7273ba79dbcc2e37dea06c5083

data/.gitignore

@@ -1,3 +1,4 @@
+.ruby-version
 *.gem
 *.rbc
 *.swp

data/README.md

@@ -13,21 +13,28 @@ A [PagerDuty](http://pagerduty.com) plugin for [Lita](https://github.com/jimmycu
 
 Add lita-pagerduty to your Lita instance's Gemfile:
 
-``` ruby
+```ruby
 gem "lita-pagerduty"
 ```
 
 ## Configuration
 
-Create a PagerDuty api Key(v1 legacy) You will need to give it FullAccess to update incidents
+Create a PagerDuty API key (v2). You will need to give it FullAccess to update incidents.
 
 Add the following variables to your Lita config file:
 
-``` ruby
+```ruby
 config.handlers.pagerduty.api_key = ''
 config.handlers.pagerduty.email   = ''
 ```
 
+If your account has the teams capability and you want to scope Lita's access to a specific set of
+teams, you can set the list of teams by adding the following to your config file:
+
+```ruby
+config..handlers.pagerduty.teams = [ "team-a", "team-b" ]
+```
+
 ## Usage
 
 ### Misc

data/lib/lita-pagerduty.rb

@@ -1,14 +1,16 @@
 require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
 require 'exceptions'
 require 'pagerduty'
 require 'store'
 require 'lita/handlers/pagerduty'
 require 'lita/commands/base'
-Dir[File.join(__dir__, 'lita', 'commands', '*.rb')].each { |file| require file }
 
-Lita.load_locales Dir[File.expand_path(
-  File.join('..', '..', 'locales', '*.yml'), __FILE__
-)]
+Dir[File.join(__dir__, 'lita', 'commands', '*.rb')].each { |file| require file }
 
 Lita::Handlers::Pagerduty.template_root File.expand_path(
   File.join('..', '..', 'templates'), __FILE__

data/lib/lita/commands/base.rb

@@ -65,7 +65,12 @@ module Commands
     end
 
     def pagerduty
-      @pagerduty ||= ::Pagerduty.new(http, config.api_key, config.email)
+      @pagerduty ||= ::Pagerduty.new(
+        http,
+        config.api_key,
+        config.email,
+        config.teams
+      )
     end
 
     def store

data/lib/lita/handlers/pagerduty.rb

@@ -4,6 +4,7 @@ module Lita
       namespace 'Pagerduty'
       config :api_key, required: true
       config :email, required: true
+      config :teams, required: false
 
       COMMANDS_PATH = File.read("#{File.dirname(__FILE__)}/commands.yml")
       COMMANDS = YAML.safe_load(COMMANDS_PATH)
@@ -13,8 +14,8 @@ module Lita
           command['method'].to_sym,
           command: true,
           help: {
-            "help.#{command['method']}.syntax" =>
-              "help.#{command['method']}.desc"
+            t("help.#{command['method']}.syntax") =>
+              t("help.#{command['method']}.desc")
           }
         )
       end
@@ -32,7 +33,12 @@ module Lita
       end
 
       def pagerduty
-        @pagerduty ||= ::Pagerduty.new(http, config.api_key, config.email)
+        @pagerduty ||= ::Pagerduty.new(
+          http,
+          config.api_key,
+          config.email,
+          config.teams
+        )
       end
 
       def store

data/lib/pagerduty.rb

@@ -1,57 +1,54 @@
 class Pagerduty
-  def initialize(http, token, email)
-    @token = token
+  attr_reader :http, :teams
+
+  def initialize(http, token, email, teams = [])
     @http = http
+    @teams = teams || []
+
     http.url_prefix = 'https://api.pagerduty.com/'
-    http.headers = headers(email)
+    http.headers = auth_headers(email, token)
   end
 
   def get_incidents(params = {})
-    response = @http.get '/incidents', params
-    data = JSON.parse(response.body, symbolize_names: true)
-               .fetch(:incidents, [])
+    data = get_resources(:incidents, params)
     raise Exceptions::IncidentsEmptyList if data.empty?
 
     data
   end
 
   def get_users(params = {})
-    response = @http.get '/users', params
-    data = JSON.parse(response.body, symbolize_names: true).fetch(:users, [])
+    data = get_resources(:users, params)
     raise Exceptions::UsersEmptyList if data.empty?
 
     data
   end
 
   def get_schedules(params = {})
-    response = @http.get '/schedules', params
-    data = JSON.parse(response.body, symbolize_names: true)
-               .fetch(:schedules, [])
+    data = get_resources(:schedules, params)
     raise Exceptions::SchedulesEmptyList if data.empty?
 
     data
   end
 
   def get_oncall_user(params = {})
-    response = @http.get '/oncalls', params
-    data = JSON.parse(response.body, symbolize_names: true).fetch(:oncalls, [])
+    data = get_resources(:oncalls, params)
     raise Exceptions::NoOncallUser if data.empty?
 
     data.first.fetch(:user)
   end
 
   def get_incident(id = '404stub')
-    response = @http.get "/incidents/#{id}"
+    response = http.get "/incidents/#{id}"
     raise Exceptions::IncidentNotFound if response.status == 404
 
-    JSON.parse(response.body, symbolize_names: true).fetch(:incident, nil)
+    parse_json_response(response, :incident)
   end
 
   def get_notes_by_incident_id(incident_id)
-    response = @http.get "/incidents/#{incident_id}/notes"
+    response = http.get "/incidents/#{incident_id}/notes"
     raise Exceptions::IncidentNotFound if response.status == 404
 
-    data = JSON.parse(response.body, symbolize_names: true).fetch(:notes, [])
+    data = parse_json_response(response, :notes, [])
     raise Exceptions::NotesEmptyList if data.empty?
 
     data
@@ -62,33 +59,60 @@ class Pagerduty
       { id: id, type: 'incident_reference', status: "#{action}d" }
     end
     payload = { incidents: incidents }
-    response = @http.put '/incidents', payload
+    response = http.put '/incidents', payload
     raise Exceptions::IncidentManageUnsuccess if response.status != 200
 
     response
   end
 
   def override(schedule_id, user_id, minutes)
-    from = ::Time.now.utc + 10
-    to = from + (60 * minutes)
-    payload = { override: {
-      start: from.iso8601,
-      end: to.iso8601,
-      user: { id: user_id, type: 'user_reference' }
-    } }
-    response = @http.post "/schedules/#{schedule_id}/overrides", payload
+    payload = override_payload(user_id, minutes)
+    response = http.post("/schedules/#{schedule_id}/overrides", payload)
     raise Exceptions::OverrideUnsuccess if response.status != 201
 
-    JSON.parse(response.body, symbolize_names: true).fetch(:override, nil)
+    parse_json_response(response, :override)
   end
 
   private
 
-  def headers(email)
+  def auth_headers(email, token)
     {
       'Accept' => 'application/vnd.pagerduty+json;version=2',
-      'Authorization' => "Token token=#{@token}",
+      'Authorization' => "Token token=#{token}",
       'From' => email
     }
   end
+
+  # Fetches a list of resources from a given collection using Pagerduty REST API
+  def get_resources(collection_name, params = {})
+    # Scope down to a single team
+    params[:team_ids] = teams if teams.any?
+
+    # Get the resources
+    response = http.get("/#{collection_name}", params)
+
+    # Parse the reponse and get the objects from the collection
+    parse_json_response(response, collection_name, [])
+  end
+
+  # Parses a JSON response and fetches a specific key from it
+  def parse_json_response(response, response_key, default_value = nil)
+    data = JSON.parse(response.body, symbolize_names: true)
+    data.fetch(response_key, default_value)
+  end
+
+  # Returns a payload for overriding a schedule and putting the user
+  # identified by +user_id+ on-call for the period defined by +minutes+
+  def override_payload(user_id, minutes)
+    # start 10 sec from now
+    from = ::Time.now.utc + 10
+    to = from + (60 * minutes)
+
+    {
+      override: {
+        start: from.iso8601, end: to.iso8601,
+        user: { id: user_id, type: 'user_reference' }
+      }
+    }
+  end
 end

data/lita-pagerduty.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-pagerduty'
-  spec.version       = '1.0.0'
+  spec.version       = '1.1.0'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['eric@pagerduty.com']
   spec.description   = 'A Lita handler to interact with PagerDuty'

data/spec/pagerduty_spec.rb

@@ -2,9 +2,10 @@ require 'spec_helper'
 
 describe Pagerduty do
   let(:http) { double }
-  let(:pagerduty) { Pagerduty.new(http, 'token', 'email') }
+  let(:teams) { nil }
+  let(:pagerduty) { Pagerduty.new(http, 'token', 'email', teams) }
 
-  before :each do
+  before do
     expect(http).to receive(:url_prefix=).with('https://api.pagerduty.com/')
     expect(http).to receive(:headers=).with({
       'Accept' => 'application/vnd.pagerduty+json;version=2',
@@ -13,86 +14,127 @@ describe Pagerduty do
     })
   end
 
-  it 'get_incidents' do
-    expect(http).to receive(:get).with('/incidents', {}).and_return(
-      OpenStruct.new(body: { incidents: [{id: 1}]}.to_json)
-    )
-    expect(pagerduty.get_incidents).to eq([{ id: 1 }])
+  def stub_response(response_hash)
+    OpenStruct.new(body: response_hash.to_json)
+  end
 
-    expect(http).to receive(:get).with('/incidents', {}).and_return(
-      OpenStruct.new(body: { incidents: []}.to_json)
-    )
-    expect{ pagerduty.get_incidents }.to raise_exception Exceptions::IncidentsEmptyList
+  def stub_collection_response(collection, params, response)
+    uri = "/#{collection}"
+    json = stub_response(collection => response)
+    expect(http).to receive(:get).with(uri, params).and_return(json)
   end
 
-  it 'get_incident' do
-    expect(http).to receive(:get).with('/incidents/ABC123').and_return(
-      OpenStruct.new(body: { incident: {}}.to_json)
-    )
-    pagerduty.get_incident('ABC123')
+  #-------------------------------------------------------------------------------------------------
+  context "without teams filtering" do
+    it 'get_incidents' do
+      stub_collection_response(:incidents, {}, [{ id: 1 }])
+      expect(pagerduty.get_incidents).to eq([{ id: 1 }])
+
+      stub_collection_response(:incidents, {}, [])
+      expect{ pagerduty.get_incidents }.to raise_exception Exceptions::IncidentsEmptyList
+    end
+
+    it 'get_users' do
+      stub_collection_response(:users, {}, [{ id: 1 }])
+      expect(pagerduty.get_users).to eq [{ id: 1 }]
+
+      stub_collection_response(:users, {}, [])
+      expect{ pagerduty.get_users }.to raise_exception Exceptions::UsersEmptyList
+    end
+
+    it 'get_schedules' do
+      stub_collection_response(:schedules, {}, [{ id: 1 }])
+      expect(pagerduty.get_schedules).to eq [{ id: 1 }]
+
+      stub_collection_response(:schedules, {}, [])
+      expect{ pagerduty.get_schedules }.to raise_exception Exceptions::SchedulesEmptyList
+    end
+
+    it 'get_oncall_user' do
+      stub_collection_response(:oncalls, {}, [{ id: 1, user: 'abc' }])
+      expect(pagerduty.get_oncall_user).to eq('abc')
+
+      stub_collection_response(:oncalls, {}, [])
+      expect{ pagerduty.get_oncall_user }.to raise_exception Exceptions::NoOncallUser
+    end
   end
 
-  it 'get_users' do
-    expect(http).to receive(:get).with('/users', {}).and_return(
-      OpenStruct.new(body: { users: [{ id: 1 }]}.to_json)
-    )
-    expect(pagerduty.get_users).to eq [{ id: 1 }]
+  #-------------------------------------------------------------------------------------------------
+  context "with teams filtering enabled" do
+    let(:teams) { [ 'team-a', 'team-b' ] }
+    let(:teams_filter) { { team_ids: teams } }
+
+    it 'get_incidents' do
+      stub_collection_response(:incidents, teams_filter, [{ id: 1 }])
+      expect(pagerduty.get_incidents).to eq([{ id: 1 }])
+
+      stub_collection_response(:incidents, teams_filter, [])
+      expect{ pagerduty.get_incidents }.to raise_exception Exceptions::IncidentsEmptyList
+    end
+
+    it 'get_users' do
+      stub_collection_response(:users, teams_filter, [{ id: 1 }])
+      expect(pagerduty.get_users).to eq [{ id: 1 }]
 
-    expect(http).to receive(:get).with('/users', {}).and_return(
-      OpenStruct.new(body: { users: []}.to_json)
+      stub_collection_response(:users, teams_filter, [])
+      expect{ pagerduty.get_users }.to raise_exception Exceptions::UsersEmptyList
+    end
+
+    it 'get_schedules' do
+      stub_collection_response(:schedules, teams_filter, [{ id: 1 }])
+      expect(pagerduty.get_schedules).to eq [{ id: 1 }]
+
+      stub_collection_response(:schedules, teams_filter, [])
+      expect{ pagerduty.get_schedules }.to raise_exception Exceptions::SchedulesEmptyList
+    end
+
+    it 'get_oncall_user' do
+      stub_collection_response(:oncalls, teams_filter, [{ id: 1, user: 'abc' }])
+      expect(pagerduty.get_oncall_user).to eq('abc')
+
+      stub_collection_response(:oncalls, teams_filter, [])
+      expect{ pagerduty.get_oncall_user }.to raise_exception Exceptions::NoOncallUser
+    end
+  end
+
+  #-------------------------------------------------------------------------------------------------
+  # Methods that do not change their semantics with teams filtering enabled
+  #-------------------------------------------------------------------------------------------------
+  it 'get_incident' do
+    expect(http).to receive(:get).with('/incidents/ABC123').and_return(
+      stub_response(incident: {})
     )
-    expect{ pagerduty.get_users }.to raise_exception Exceptions::UsersEmptyList
+    pagerduty.get_incident('ABC123')
   end
 
   it 'get_notes_by_incident_id' do
     expect(http).to receive(:get).with('/incidents/ABC123/notes').and_return(
-      OpenStruct.new(body: { notes: [{ id: 1 }]}.to_json)
+      stub_response(notes: [{ id: 1 }])
     )
     expect(pagerduty.get_notes_by_incident_id('ABC123')).to eq [{ id: 1 }]
 
     expect(http).to receive(:get).with('/incidents/ABC123/notes').and_return(
-      OpenStruct.new(body: { notes: []}.to_json)
+      stub_response(notes: [])
     )
     expect{ pagerduty.get_notes_by_incident_id('ABC123') }.to raise_exception Exceptions::NotesEmptyList
   end
 
   it 'manage_incidents' do
-    params = { incidents: [
-      { id: 'a', status: 'acknowledged', type: 'incident_reference' },
-      { id: 'b', status: 'acknowledged', type: 'incident_reference' }
-    ]}
+    params = {
+      incidents: [
+        { id: 'a', status: 'acknowledged', type: 'incident_reference' },
+        { id: 'b', status: 'acknowledged', type: 'incident_reference' },
+      ]
+    }
     expect(http).to receive(:put).with('/incidents', params).and_return(
       OpenStruct.new(body: { users: [] }.to_json, status: 200)
     )
     pagerduty.manage_incidents(:acknowledge, ['a', 'b'])
   end
 
-  it 'get_schedules' do
-    expect(http).to receive(:get).with('/schedules', {}).and_return(
-      OpenStruct.new(body: { schedules: [{ id: 1 }]}.to_json)
-    )
-    expect(pagerduty.get_schedules).to eq [{ id: 1 }]
-
-    expect(http).to receive(:get).with('/schedules', {}).and_return(
-      OpenStruct.new(body: { incidents: []}.to_json)
-    )
-    expect{ pagerduty.get_schedules }.to raise_exception Exceptions::SchedulesEmptyList
-  end
-
-  it 'get_oncall_user' do
-    expect(http).to receive(:get).with('/oncalls', {}).and_return(
-      OpenStruct.new(body: { oncalls: [{ id: 1, user: 'abc' }]}.to_json)
-    )
-    expect(pagerduty.get_oncall_user).to eq('abc')
-
-    expect(http).to receive(:get).with('/oncalls', {}).and_return(
-      OpenStruct.new(body: { incidents: []}.to_json)
-    )
-    expect{ pagerduty.get_oncall_user }.to raise_exception Exceptions::NoOncallUser
-  end
 
   it 'override' do
-    expect(Time).to receive(:now).and_return(Time.new(2000))
+    expect(Time).to receive(:now).and_return(Time.new(2000, 1, 1, 0, 0, 0, 0))
     params = { override: {
         end: '2000-01-01T00:01:10Z',
         start: '2000-01-01T00:00:10Z',

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+# We rely on timezone being in UTC
+ENV['TZ'] = 'UTC'
+
 require 'simplecov'
 require 'coveralls'
 SimpleCov.formatters = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-pagerduty
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita