lita-pagerduty 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1976196f33f4a430eff395034fd70aeb5ad0ade
-  data.tar.gz: 59f6a07f7e158675e73c5729241adf9d4dc3bc8c
+  metadata.gz: 995b4cc2ce45f281596f3db0ad7e743b41366f78
+  data.tar.gz: c372723772d7453a7d61433a35cabd21d2b55496
 SHA512:
-  metadata.gz: dbc56aedef1af70d73ce6bdb4cc50c6794c1e48e446f06e7727567a3f5a8b75a828b609768145c8d0dcd6c063ebae756793d28e694158a041e55de16974678c0
-  data.tar.gz: 5e60c4a48e19be645a661c8e91dfd3cd1e2fb01cbb940f78719d935a14e4245dfe6f1723aa759cb7313440922848c4c2bbc895382353510114dd7b9f1e3cb72d
+  metadata.gz: fe7ab1d8f578117c52e61d6485e7a9a28af17232cc97d6a62f1ff12a782e390669783a9b4064c2f35a65fa19d874c9519a013b2949dba5a6ca9a884500cc5a63
+  data.tar.gz: e795ce52f3318fc166f85d8b1229eddcfdf915a063aef9006d0b3cc2ad37072c82ff8196f2b58d95253d228ce78107d3328b0d4fb4e12a78ba5d792a85ea0dc7

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.swp
 .bundle
 .config
 .yardoc

data/.rubocop.yml

@@ -1,8 +1,9 @@
-MethodLength:
-  Max: 20
+FileName:
+  Exclude:
+    - lib/lita-pagerduty.rb
 
-ClassLength:
-  Max: 400
+LineLength:
+  Max: 130
 
-Documentation:
+AbcSize:
   Enabled: false

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.1
 script: bundle exec rake
 before_install:
   - gem update --system

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Pull requests are awesome!  Pull requests with tests are even more awesome!
+
+## Quick steps
+
+1. Fork the repo.
+2. Run the tests: `bundle && rake`
+3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, it needs a test!
+4. Make the test pass.
+5. Push to your fork and submit a pull request.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Eric Sigler
+Copyright (c) 2014 PagerDuty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,13 @@
 # lita-pagerduty
 
-[![Build Status](https://travis-ci.org/esigler/lita-pagerduty.png?branch=master)](https://travis-ci.org/esigler/lita-pagerduty)
-[![Code Climate](https://codeclimate.com/github/esigler/lita-pagerduty.png)](https://codeclimate.com/github/esigler/lita-pagerduty)
-[![Coverage Status](https://coveralls.io/repos/esigler/lita-pagerduty/badge.png?branch=master)](https://coveralls.io/r/esigler/lita-pagerduty?branch=master)
+[![Build Status](https://img.shields.io/travis/PagerDuty/lita-pagerduty/master.svg)](https://travis-ci.org/PagerDuty/lita-pagerduty)
+[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
+[![RubyGems :: RMuh Gem Version](http://img.shields.io/gem/v/lita-pagerduty.svg)](https://rubygems.org/gems/lita-pagerduty)
+[![Coveralls Coverage](https://img.shields.io/coveralls/PagerDuty/lita-pagerduty/master.svg)](https://coveralls.io/r/PagerDuty/lita-pagerduty)
+[![Code Climate](https://img.shields.io/codeclimate/github/PagerDuty/lita-pagerduty.svg)](https://codeclimate.com/github/PagerDuty/lita-pagerduty)
+[![Gemnasium](https://img.shields.io/gemnasium/PagerDuty/lita-pagerduty.svg)](https://gemnasium.com/PagerDuty/lita-pagerduty)
 
-PagerDuty (http://pagerduty.com) handler for checking who's on call, scheduling, ack, resolve, etc.
+A [PagerDuty](http://pagerduty.com) plugin for [Lita](https://github.com/jimmycuadra/lita).
 
 ## Installation
 
@@ -28,38 +31,38 @@ config.handlers.pagerduty.subdomain = ''
 ### Specific incidents
 
 ```
-Lita pager incidents all                - Show all open incidents
-Lita pager incidents mine               - Show all open incidents assigned to me
-Lita pager incident <incident ID>       - Show a specific incident
+pager incidents all                - Show all open incidents
+pager incidents mine               - Show all open incidents assigned to me
+pager incident <incident ID>       - Show a specific incident
 ```
 
 ### Incident notes
 
 ```
-Lita pager notes <incident ID>          - Show all notes for a specific incident
+pager notes <incident ID>          - Show all notes for a specific incident
 ```
 
 ### Acknowledging an incident
 
 ```
-Lita pager ack all                      - Acknowledge all triggered incidents
-Lita pager ack mine                     - Acknowledge all triggered incidents assigned to me
-Lita pager ack <incident ID>            - Acknowledge a specific incident
+pager ack all                      - Acknowledge all triggered incidents
+pager ack mine                     - Acknowledge all triggered incidents assigned to me
+pager ack <incident ID>            - Acknowledge a specific incident
 ```
 
 ### Resolving an incident
 
 ```
-Lita pager resolve all                  - Resolve all triggered incidents
-Lita pager resolve mine                 - Resolve all triggered incidents assigned to me
-Lita pager resolve <incident ID>        - Resolve a specific incident
+pager resolve all                  - Resolve all triggered incidents
+pager resolve mine                 - Resolve all triggered incidents assigned to me
+pager resolve <incident ID>        - Resolve a specific incident
 ```
 
 ### Misc
 
 ```
-Lita pager identify <email address>     - Associate your chat user with your email address
-Lita pager forget                       - Remove your chat user / email association
+pager identify <email address>     - Associate your chat user with your email address
+pager forget                       - Remove your chat user / email association
 ```
 
 ## License

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: :spec
+task default: [:spec, :rubocop]

data/lib/lita/handlers/pagerduty_ack.rb

@@ -0,0 +1,73 @@
+# Lita-related code
+module Lita
+  # Plugin-related code
+  module Handlers
+    # Acknowledge-related routes
+    class PagerdutyAck < Handler
+      namespace 'Pagerduty'
+
+      include ::PagerdutyHelper::Incident
+      include ::PagerdutyHelper::Regex
+      include ::PagerdutyHelper::Utility
+
+      route(
+        /^pager\sack\sall$/,
+        :ack_all,
+        command: true,
+        help: {
+          t('help.ack_all.syntax') => t('help.ack_all.desc')
+        }
+      )
+
+      route(
+        /^pager\sack\smine$/,
+        :ack_mine,
+        command: true,
+        help: {
+          t('help.ack_mine.syntax') => t('help.ack_mine.desc')
+        }
+      )
+
+      route(
+        /^pager\sack\s#{INCIDENT_ID_PATTERN}$/,
+        :ack,
+        command: true,
+        help: {
+          t('help.ack.syntax') => t('help.ack.desc')
+        }
+      )
+
+      def ack_all(response)
+        incidents = fetch_all_incidents
+        return response.reply(t('incident.none')) unless incidents.count > 0
+        completed = []
+        incidents.each do |incident|
+          result = acknowledge_incident(incident.id)
+          completed.push(incident.id) if result == "#{incident.id}: Incident acknowledged"
+          response.reply(t('all.acknowledged', list: completed.join(', ')))
+        end
+      end
+
+      def ack_mine(response)
+        email = fetch_user(response.user)
+        return response.reply(t('identify.missing')) unless email
+        incidents = fetch_my_incidents(email)
+        return response.reply(t('incident.none_mine')) unless incidents.count > 0
+        completed = []
+        incidents.each do |incident|
+          result = acknowledge_incident(incident.id)
+          completed.push(incident.id) if result == "#{incident.id}: Incident acknowledged"
+          response.reply(t('all.acknowledged', list: completed.join(', ')))
+        end
+      end
+
+      def ack(response)
+        incident_id = response.match_data['incident_id']
+        return if incident_id == 'all' || incident_id == 'mine'
+        response.reply(acknowledge_incident(incident_id))
+      end
+    end
+
+    Lita.register_handler(PagerdutyAck)
+  end
+end

data/lib/lita/handlers/pagerduty_incident.rb

@@ -0,0 +1,68 @@
+# Lita-related code
+module Lita
+  # Plugin-related code
+  module Handlers
+    # Incident-related routes
+    class PagerdutyIncident < Handler
+      namespace 'Pagerduty'
+
+      include ::PagerdutyHelper::Incident
+      include ::PagerdutyHelper::Regex
+      include ::PagerdutyHelper::Utility
+
+      route(
+        /^pager\sincidents\sall$/,
+        :incidents_all,
+        command: true,
+        help: {
+          t('help.incidents_all.syntax') => t('help.incidents_all.desc')
+        }
+      )
+
+      route(
+        /^pager\sincidents\smine$/,
+        :incidents_mine,
+        command: true,
+        help: {
+          t('help.incidents_mine.syntax') => t('help.incidents_mine.desc')
+        }
+      )
+
+      route(
+        /^pager\sincident\s#{INCIDENT_ID_PATTERN}$/,
+        :incident,
+        command: true,
+        help: {
+          t('help.incident.syntax') => t('help.incident.desc')
+        }
+      )
+
+      def incidents_all(response)
+        incidents = fetch_all_incidents
+        return response.reply(t('incident.none')) unless incidents.count > 0
+        incidents.each do |incident|
+          response.reply(format_incident(incident))
+        end
+      end
+
+      def incidents_mine(response)
+        email = fetch_user(response.user)
+        return response.reply(t('identify.missing')) unless email
+        incidents = fetch_my_incidents(email)
+        response.reply(t('incident.none_mine')) unless incidents.count > 0
+        incidents.each do |incident|
+          response.reply(format_incident(incident))
+        end
+      end
+
+      def incident(response)
+        incident_id = response.match_data['incident_id']
+        incident = fetch_incident(incident_id)
+        return response.reply(t('incident.not_found', id: incident_id)) if incident == 'No results'
+        response.reply(format_incident(incident))
+      end
+    end
+
+    Lita.register_handler(PagerdutyIncident)
+  end
+end

data/lib/lita/handlers/pagerduty_note.rb

@@ -0,0 +1,48 @@
+# Lita-related code
+module Lita
+  # Plugin-related code
+  module Handlers
+    # Note-related routes
+    class PagerdutyNote < Handler
+      namespace 'Pagerduty'
+
+      include ::PagerdutyHelper::Incident
+      include ::PagerdutyHelper::Regex
+      include ::PagerdutyHelper::Utility
+
+      route(
+        /^pager\snotes\s#{INCIDENT_ID_PATTERN}$/,
+        :notes,
+        command: true,
+        help: {
+          t('help.notes.syntax') => t('help.notes.desc')
+        }
+      )
+
+      route(
+        /^pager\snote\s#{INCIDENT_ID_PATTERN}\s(.+)$/,
+        :note,
+        command: true,
+        help: {
+          t('help.note.syntax') => t('help.note.desc')
+        }
+      )
+
+      def notes(response)
+        incident_id = response.match_data['incident_id']
+        incident = fetch_incident(incident_id)
+        return response.reply(t('incident.not_found', id: incident_id)) if incident == 'No results'
+        return response.reply("#{incident_id}: No notes") unless incident.notes.notes.count > 0
+        incident.notes.notes.each do |note|
+          response.reply(format_note(incident, note))
+        end
+      end
+
+      def note(response)
+        response.reply(t('error.not_implemented'))
+      end
+    end
+
+    Lita.register_handler(PagerdutyNote)
+  end
+end

data/lib/lita/handlers/pagerduty_resolve.rb

@@ -0,0 +1,73 @@
+# Lita-related code
+module Lita
+  # Plugin-related code
+  module Handlers
+    # Resolve-related routes
+    class PagerdutyResolve < Handler
+      namespace 'Pagerduty'
+
+      include ::PagerdutyHelper::Incident
+      include ::PagerdutyHelper::Regex
+      include ::PagerdutyHelper::Utility
+
+      route(
+        /^pager\sresolve\sall$/,
+        :resolve_all,
+        command: true,
+        help: {
+          t('help.resolve_all.syntax') => t('help.resolve_all.desc')
+        }
+      )
+
+      route(
+        /^pager\sresolve\smine$/,
+        :resolve_mine,
+        command: true,
+        help: {
+          t('help.resolve_mine.syntax') => t('help.resolve_mine.desc')
+        }
+      )
+
+      route(
+        /^pager\sresolve\s#{INCIDENT_ID_PATTERN}$/,
+        :resolve,
+        command: true,
+        help: {
+          t('help.resolve.syntax') => t('help.resolve.desc')
+        }
+      )
+
+      def resolve_all(response)
+        incidents = fetch_all_incidents
+        return response.reply(t('incident.none')) unless incidents.count > 0
+        completed = []
+        incidents.each do |incident|
+          result = resolve_incident(incident.id)
+          completed.push(incident.id) if result == "#{incident.id}: Incident resolved"
+          response.reply(t('all.resolved', list: completed.join(',')))
+        end
+      end
+
+      def resolve_mine(response)
+        email = fetch_user(response.user)
+        return response.reply(t('identify.missing')) unless email
+        incidents = fetch_my_incidents(email)
+        return response.reply(t('incident.none_mine')) unless incidents.count > 0
+        completed = []
+        incidents.each do |incident|
+          result = resolve_incident(incident.id)
+          completed.push(incident.id) if result == "#{incident.id}: Incident resolved"
+          response.reply(t('all.resolved', list: completed.join(',')))
+        end
+      end
+
+      def resolve(response)
+        incident_id = response.match_data['incident_id']
+        return if incident_id == 'all' || incident_id == 'mine'
+        response.reply(resolve_incident(incident_id))
+      end
+    end
+
+    Lita.register_handler(PagerdutyResolve)
+  end
+end

data/lib/lita/handlers/pagerduty_utility.rb

@@ -0,0 +1,108 @@
+require 'time'
+
+# Lita-related code
+module Lita
+  # Plugin-related code
+  module Handlers
+    # Utility-ish routes
+    class PagerdutyUtility < Handler
+      config :api_key, required: true
+      config :subdomain, required: true
+
+      namespace 'Pagerduty'
+
+      include ::PagerdutyHelper::Incident
+      include ::PagerdutyHelper::Regex
+      include ::PagerdutyHelper::Utility
+
+      route(
+        /^pager\soncall$/,
+        :on_call_list,
+        command: true,
+        help: {
+          t('help.on_call_list.syntax') => t('help.on_call_list.desc')
+        }
+      )
+
+      route(
+        /^pager\soncall\s(.*)$/,
+        :on_call_lookup,
+        command: true,
+        help: {
+          t('help.on_call_lookup.syntax') => t('help.on_call_lookup.desc')
+        }
+      )
+
+      route(
+        /^pager\sidentify\s#{EMAIL_PATTERN}$/,
+        :identify,
+        command: true,
+        help: {
+          t('help.identify.syntax') => t('help.identify.desc')
+        }
+      )
+
+      route(
+        /^pager\sforget$/,
+        :forget,
+        command: true,
+        help: {
+          t('help.forget.syntax') => t('help.forget.desc')
+        }
+      )
+
+      def on_call_list(response)
+        schedules = pd_client.get_schedules.schedules
+        if schedules.any?
+          schedule_list = schedules.map(&:name).join(', ')
+          response.reply(t('on_call_list.response', schedules: schedule_list))
+        else
+          response.reply(t('on_call_list.no_schedules_found'))
+        end
+      end
+
+      def on_call_lookup(response)
+        schedule_name = response.match_data[1].strip
+        schedule = pd_client.get_schedules.schedules.find { |s| s.name == schedule_name }
+
+        unless schedule
+          return response.reply(t('on_call_lookup.no_matching_schedule', schedule_name: schedule_name))
+        end
+
+        if (user = lookup_on_call_user(schedule.id))
+          response.reply(t('on_call_lookup.response', name: user.name, email: user.email, schedule_name: schedule_name))
+        else
+          response.reply(t('on_call_lookup.no_one_on_call', schedule_name: schedule_name))
+        end
+      end
+
+      def identify(response)
+        email = response.match_data['email']
+        stored_email = fetch_user(response.user)
+        return response.reply(t('identify.already')) if stored_email
+        store_user(response.user, email)
+        response.reply(t('identify.complete'))
+      end
+
+      def forget(response)
+        stored_email = fetch_user(response.user)
+        return response.reply(t('forget.unknown')) unless stored_email
+        delete_user(response.user)
+        response.reply(t('forget.complete'))
+      end
+
+      private
+
+      def lookup_on_call_user(schedule_id)
+        now = Time.now.utc
+        pd_client.get_schedule_users(
+          id: schedule_id,
+          since: now.iso8601,
+          until: (now + 3600).iso8601
+        ).first
+      end
+    end
+
+    Lita.register_handler(PagerdutyUtility)
+  end
+end

data/lib/lita-pagerduty.rb

@@ -1 +1,17 @@
-require 'lita/handlers/pagerduty'
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'pagerduty'
+
+require 'pagerduty_helper/incident'
+require 'pagerduty_helper/regex'
+require 'pagerduty_helper/utility'
+
+require 'lita/handlers/pagerduty_ack'
+require 'lita/handlers/pagerduty_incident'
+require 'lita/handlers/pagerduty_note'
+require 'lita/handlers/pagerduty_resolve'
+require 'lita/handlers/pagerduty_utility'

data/lib/pagerduty_helper/incident.rb

@@ -0,0 +1,61 @@
+# Helper Code for PagerDuty Lita Handler
+module PagerdutyHelper
+  # Incident-related functions
+  module Incident
+    def format_incident(incident)
+      t('incident.info', id: incident.id,
+                         subject: incident.trigger_summary_data.subject,
+                         assigned: incident.assigned_to_user.email)
+    end
+
+    def resolve_incident(incident_id)
+      incident = fetch_incident(incident_id)
+      return t('incident.not_found', id: incident_id) if incident == 'No results'
+      return t('incident.already_set', id: incident_id, status: incident.status) if incident.status == 'resolved'
+      results = incident.resolve
+      if results.key?('status') && results['status'] == 'resolved'
+        t('incident.resolved', id: incident_id)
+      else
+        t('incident.unable_to_resolve', id: incident_id)
+      end
+    end
+
+    def fetch_all_incidents
+      client = pd_client
+      list = []
+      # FIXME: Workaround on current PD Gem
+      client.incidents.incidents.each do |incident|
+        list.push(incident) if incident.status != 'resolved'
+      end
+      list
+    end
+
+    def fetch_my_incidents(email)
+      # FIXME: Workaround
+      incidents = fetch_all_incidents
+      list = []
+      incidents.each do |incident|
+        list.push(incident) if incident.assigned_to_user.email == email
+      end
+      list
+    end
+
+    def fetch_incident(incident_id)
+      client = pd_client
+      client.get_incident(id: incident_id)
+    end
+
+    def acknowledge_incident(incident_id)
+      incident = fetch_incident(incident_id)
+      return t('incident.not_found', id: incident_id) if incident == 'No results'
+      return t('incident.already_set', id: incident_id, status: incident.status) if incident.status == 'acknowledged'
+      return t('incident.already_set', id: incident_id, status: incident.status) if incident.status == 'resolved'
+      results = incident.acknowledge
+      if results.key?('status') && results['status'] == 'acknowledged'
+        t('incident.acknowledged', id: incident_id)
+      else
+        t('incident.unable_to_acknowledge', id: incident_id)
+      end
+    end
+  end
+end

data/lib/pagerduty_helper/regex.rb

@@ -0,0 +1,8 @@
+# Helper Code for PagerDuty Lita Handler
+module PagerdutyHelper
+  # Utility functions
+  module Regex
+    INCIDENT_ID_PATTERN = /(?<incident_id>[a-zA-Z0-9+]{1,6})/
+    EMAIL_PATTERN       = /(?<email>[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+)/i
+  end
+end

data/lib/pagerduty_helper/utility.rb

@@ -0,0 +1,29 @@
+# Helper Code for PagerDuty Lita Handler
+module PagerdutyHelper
+  # Utility functions
+  module Utility
+    def pd_client
+      ::Pagerduty.new(token: config.api_key, subdomain: config.subdomain)
+    end
+
+    def format_note(incident, note)
+      t('note.show', id: incident.id, content: note.content, email: note.user.email)
+    end
+
+    def store_user(user, email)
+      redis.set(format_user(user), email)
+    end
+
+    def fetch_user(user)
+      redis.get(format_user(user))
+    end
+
+    def delete_user(user)
+      redis.del(format_user(user))
+    end
+
+    def format_user(user)
+      "email_#{user.id}"
+    end
+  end
+end