lita-statuspage 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b01c5dde801876bc1c207904cd809f701ee23424
-  data.tar.gz: e150d1e626521658e5062ff5d9170085e6aed973
+  metadata.gz: 79269c762a45f49d7289a9bd740576eff2f0ed63
+  data.tar.gz: 218cca7791ea9dbed9a38ea8e805826616e4f7be
 SHA512:
-  metadata.gz: a39ecbcc04239e4b3960beb39c7e9a6fce42ea9fc8de8168928fdee9911ecf0e40bf3f98291f6e9101f07dc5243bd55e2fbe59ebfd76e8bf573c6e64ea9b8a4f
-  data.tar.gz: 37e3281f82bed4712d5e9145c8b9c2f911ad4eb2dee0e25487a3474de96980e9502ee88d6e76ba3b6288a69305617d7e0ba3e225ac1a466dd70f2c0bdc9ae462
+  metadata.gz: 6a367bde834b533daf0a75caeab2bf15137e2a2c0a9094cb410c2914bd5307cdc93ca6f91cc07eeee726a2484a958dca8a1a6585a70a70bce97ca80843e058c6
+  data.tar.gz: 0eb8b4400b3740db4fe561d545fe724694a0d8eaeb99011a27c85d9c7b21b38ddce51eca9b55c7ff9050b31ab8a9e5554f662a7225d065d4088642003df4312b

data/.rspec

@@ -0,0 +1 @@
+--color --profile 5

data/.rubocop.yml

@@ -1,17 +1,16 @@
 ClassLength:
-  Max: 400
-
-CyclomaticComplexity:
-  Max: 10
+  Max: 260
 
 Documentation:
-  Enabled: false
+  Exclude:
+    - lib/lita/handlers/statuspage.rb
 
 FileName:
+  Exclude:
+    - lib/lita-statuspage.rb
+
+AbcSize:
   Enabled: false
 
 LineLength:
   Max: 130
-
-MethodLength:
-  Max: 30

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.1.0
-script: bundle exec rake
-before_install:
-  - gem update --system
+  - 2.1
+  - 2.2
 services:
   - redis-server
+sudo: false
+cache: bundler

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,10 +1,13 @@
 # lita-statuspage
 
-[![Build Status](https://travis-ci.org/esigler/lita-statuspage.png?branch=master)](https://travis-ci.org/esigler/lita-statuspage)
-[![Code Climate](https://codeclimate.com/github/esigler/lita-statuspage.png)](https://codeclimate.com/github/esigler/lita-statuspage)
-[![Coverage Status](https://coveralls.io/repos/esigler/lita-statuspage/badge.png?branch=master)](https://coveralls.io/r/esigler/lita-statuspage?branch=master)
-
-Statuspage.io (http://statuspage.io) handler for updating incidents, service status, etc.
+[![Build Status](https://img.shields.io/travis/esigler/lita-statuspage/master.svg)](https://travis-ci.org/esigler/lita-statuspage)
+[![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-statuspage.svg)](https://rubygems.org/gems/lita-statuspage)
+[![Coveralls Coverage](https://img.shields.io/coveralls/esigler/lita-statuspage/master.svg)](https://coveralls.io/r/esigler/lita-statuspage)
+[![Code Climate](https://img.shields.io/codeclimate/github/esigler/lita-statuspage.svg)](https://codeclimate.com/github/esigler/lita-statuspage)
+[![Gemnasium](https://img.shields.io/gemnasium/esigler/lita-statuspage.svg)](https://gemnasium.com/esigler/lita-statuspage)
+
+A [Statuspage.io](http://statuspage.io) plugin for [Lita](https://github.com/jimmycuadra/lita).
 
 ## Installation
 

data/Rakefile

@@ -3,6 +3,6 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-Rubocop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: [ :spec, :rubocop ]
+task default: [:spec, :rubocop]

data/lib/lita/handlers/statuspage.rb

@@ -1,19 +1,15 @@
 module Lita
   module Handlers
     class Statuspage < Handler
+      config :api_key, required: true
+      config :page_id, required: true
+
       route(
         /^(?:statuspage|sp)\sincident\snew\s(.+)$/,
         :incident_new,
         command: true,
         help: {
-          '(statuspage|sp) incident new name:"<name>"'       => 'Create a new realtime incident',
-          '                             status:<status>'     => '(Optional) One of: investigating|identified|monitoring' \
-                                                                '|resolved (default: investigating)',
-          '                             message:"<message>"' => '(Optional) The initial message',
-          '                             twitter:<state>'     => '(Optional) Post the new incident to Twitter, one of: ' \
-                                                                '(true|t|false|f) (default:false)',
-          '                             impact:<state>'      => '(Optional) Override calculated impact value, one of: ' \
-                                                           '(minor|major|critical)'
+          t('help.incident.new.syntax') => t('help.incident.new.desc')
         }
       )
 
@@ -22,7 +18,7 @@ module Lita
         :incident_update,
         command: true,
         help: {
-          '(statuspage|sp) incident update id:ABC123 (...)' => 'Update an incident (takes same arguments as new)'
+          t('help.incident.update.syntax') => t('help.incident.update.desc')
         }
       )
 
@@ -31,7 +27,7 @@ module Lita
         :incident_list_all,
         command: true,
         help: {
-          '(statuspage|sp) incident list all' => 'List all incidents'
+          t('help.incident.list_all.syntax') => t('help.incident.list_all.desc')
         }
       )
 
@@ -40,7 +36,7 @@ module Lita
         :incident_list_scheduled,
         command: true,
         help: {
-          '(statuspage|sp) incident list scheduled' => 'List scheduled incidents'
+          t('help.incident.list_sch.syntax') => t('help.incident.list_sch.desc')
         }
       )
 
@@ -49,7 +45,7 @@ module Lita
         :incident_list_unresolved,
         command: true,
         help: {
-          '(statuspage|sp) incident list unresolved' => 'List unresolved incidents'
+          t('help.incident.list_unr.syntax') => t('help.incident.list_unr.desc')
         }
       )
 
@@ -58,7 +54,7 @@ module Lita
         :incident_delete_latest,
         command: true,
         help: {
-          '(statuspage|sp) incident delete latest' => 'Delete latest incident'
+          t('help.incident.delete_l.syntax') => t('help.incident.delete_l.desc')
         }
       )
 
@@ -67,7 +63,7 @@ module Lita
         :incident_delete,
         command: true,
         help: {
-          '(statuspage|sp) incident delete id:<id>' => 'Delete a specific incident'
+          t('help.incident.delete_i.syntax') => t('help.incident.delete_i.desc')
         }
       )
 
@@ -76,7 +72,7 @@ module Lita
         :component_list,
         command: true,
         help: {
-          '(statuspage|sp) component list' => 'Lists all components'
+          t('help.component.list.syntax') => t('help.component.list.desc')
         }
       )
 
@@ -85,37 +81,14 @@ module Lita
         :component_update,
         command: true,
         help: {
-          '(statuspage|sp) component update' => 'Updates the component'
+          t('help.component.update.syntax') => t('help.component.update.desc')
         }
       )
 
-      def self.default_config(config)
-        config.api_key = nil
-        config.page_id = nil
-      end
-
       def incident_new(response)
         args = parse_args(response.matches[0][0])
 
-        unless args.key?('name')
-          response.reply('Can\'t create incident, missing incident name')
-          return
-        end
-
-        if args.key?('status') && !valid_incident_status?(args['status'])
-          response.reply('Can\'t create incident, invalid incident state')
-          return
-        end
-
-        if args.key?('twitter') && !valid_twitter_status?(args['twitter'])
-          response.reply('Can\'t create incident, invalid twitter state')
-          return
-        end
-
-        if args.key?('impact') && !valid_impact_value?(args['impact'])
-          response.reply('Can\'t create incident, invalid impact value')
-          return
-        end
+        return response.reply(t('error.invalid_arguments')) unless valid_args?(args)
 
         response.reply(create_incident(args))
       end
@@ -123,30 +96,7 @@ module Lita
       def incident_update(response)
         args = parse_args(response.matches[0][0])
 
-        unless args.key?('id')
-          response.reply('Can\'t update incident, missing incident ID')
-          return
-        end
-
-        if args.length < 2
-          response.reply('Can\'t update incident, nothing to update')
-          return
-        end
-
-        if args.key?('status') && !valid_incident_status?(args['status'])
-          response.reply('Can\'t update incident, invalid incident state')
-          return
-        end
-
-        if args.key?('twitter') && !valid_twitter_status?(args['twitter'])
-          response.reply('Can\'t update incident, invalid twitter state')
-          return
-        end
-
-        if args.key?('impact') && !valid_impact_value?(args['impact'])
-          response.reply('Can\'t update incident, invalid impact value')
-          return
-        end
+        return response.reply(t('error.invalid_arguments')) unless valid_args?(args)
 
         response.reply(update_incident(args['id'], args))
       end
@@ -171,11 +121,10 @@ module Lita
 
       def incident_delete_latest(response)
         incident = latest_incident
-        if incident
-          response.reply(delete_incident(incident['id']))
-        else
-          response.reply('No latest incident found')
-        end
+
+        return response.reply(t('incident.not_found')) unless incident
+
+        response.reply(delete_incident(incident['id']))
       end
 
       def incident_delete(response)
@@ -185,148 +134,118 @@ module Lita
 
       def component_list(response)
         components = api_request('get', 'components')
-        if components
-          if components.count > 0
-            components.each do |component|
-              response.reply(format_component(component))
-            end
-          else
-            response.reply('No components to list')
-          end
-        else
-          response.reply('Error fetching components')
+
+        return response.reply(t('error.api_request')) if components.nil?
+        return response.reply(t('component.none')) if components.count == 0
+
+        components.each do |component|
+          response.reply(format_component(component))
         end
       end
 
       def component_update(response)
         args = parse_args(response.matches[0][0])
-        request_args = {}
-        if !args.key?('name') && !args.key?('id')
-          response.reply('Need an identifier for the component')
-        else
-          if args.key?('status')
-            if valid_component_status?(args['status'])
-              request_args['component[status]'] = args['status']
-            else
-              response.reply('Invalid status to use in updates')
-              return
-            end
-          else
-            request_args['component[status]='] = ''
-          end
-
-          if args.key?('id')
-            response.reply(update_component(args['id'], request_args))
-          elsif args.key?('name')
-            component = component(args['name'])
-            response.reply(update_component(component['id'], request_args))
-          else
-            response.reply('Need an identifier for the component')
-          end
-        end
+        c_id = identify_component(args)
+
+        return response.reply(t('component.need_identifier')) unless c_id
+        return response.reply(t('component.invalid_status')) unless valid_component_status?(args['status'])
+
+        response.reply(update_component(c_id, 'component[status]' => args['status']))
       end
 
       private
 
       def incident(id)
         incidents = api_request('get', 'incidents')
-        if incidents && incidents.count > 0
-          incidents.each do |incident|
-            return incident if incident['id'] == id
-          end
+        return nil unless incidents && incidents.count > 0
+
+        incidents.each do |incident|
+          return incident if incident['id'] == id
         end
+
         nil
       end
 
       def latest_incident
         incidents = api_request('get', 'incidents')
         return nil unless incidents && incidents.count > 0
+
         incidents.first
       end
 
       def list_incidents(resource)
         incidents = api_request('get', resource)
+        return [t('error.api_request')] unless incidents
+
         response = []
-        if incidents
-          response = ['No incidents to list'] unless incidents.count > 0
-          incidents.each do |incident|
-            response.push("#{format_incident(incident)}")
-          end
-        else
-          response = ['Error fetching incidents']
+        response = ['No incidents to list'] unless incidents.count > 0
+        incidents.each do |incident|
+          response.push("#{format_incident(incident)}")
         end
+
         response
       end
 
       def create_incident(args)
-        request_args = {}
-        request_args['incident[name]'] = args['name']
-        request_args['incident[status]'] = args['status'] if args.key?('status')
-        request_args['incident[wants_twitter_update]'] = args['twitter'] if args.key?('twitter')
-        request_args['incident[message]'] = args['message'] if args.key?('message')
-        request_args['incident[impact_override]'] = args['impact'] if args.key?('impact')
-        result = api_request('post', 'incidents.json', request_args)
-        if result
-          "Incident #{result['id']} created"
-        else
-          'Error creating incident'
-        end
+        api_args = {}
+        api_args['incident[name]'] = args['name']
+        api_args['incident[status]'] = args['status'] if args.key?('status')
+        api_args['incident[wants_twitter_update]'] = args['twitter'] if args.key?('twitter')
+        api_args['incident[message]'] = args['message'] if args.key?('message')
+        api_args['incident[impact_override]'] = args['impact'] if args.key?('impact')
+
+        result = api_request('post', 'incidents.json', api_args)
+        result ? t('incident.created', id: result['id']) : t('error.api_request')
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def update_incident(id, args)
-        incident = incident(id)
-        if incident
-          request_args = {}
-          request_args['incident[status]'] = args['status'] if args.key?('status')
-          request_args['incident[wants_twitter_update]'] = args['twitter'] if args.key?('twitter')
-          request_args['incident[message]'] = args['message'] if args.key?('message')
-          request_args['incident[impact_override]'] = args['impact'] if args.key?('impact')
-          result = api_request('patch', "incidents/#{id}.json", request_args)
-          if result
-            "Incident #{id} updated"
-          else
-            'Error updating incident'
-          end
-        else
-          'Can\'t update incident, does not exist'
-        end
+        return t('incident.not_found') unless incident(id)
+
+        api_args = {}
+        api_args['incident[status]'] = args['status'] if args.key?('status')
+        api_args['incident[wants_twitter_update]'] = args['twitter'] if args.key?('twitter')
+        api_args['incident[message]'] = args['message'] if args.key?('message')
+        api_args['incident[impact_override]'] = args['impact'] if args.key?('impact')
+
+        result = api_request('patch', "incidents/#{id}.json", api_args)
+        result ? t('incident.updated', id: id) : t('error.api_request')
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def delete_incident(id)
         incident = incident(id)
-        if incident
-          result = api_request('delete', "incidents/#{id}.json")
-          if result
-            "Incident #{id} deleted"
-          else
-            'Error deleting incident'
-          end
-        else
-          'Incident not found'
-        end
+        return t('incident.not_found') unless incident
+
+        result = api_request('delete', "incidents/#{id}.json")
+        result ? t('incident.deleted', id: id) : t('error.api_request')
       end
 
       def component(identifier)
         components = api_request('get', 'components')
-        if components && components.count > 0
-          components.each do |component|
-            return component if component['id'] == identifier ||
-                                component['name'] == identifier
-          end
+        return unless components && components.count > 0
+        components.each do |component|
+          return component if component['id'] == identifier ||
+                              component['name'] == identifier
         end
       end
 
       def update_component(id, args)
         component = component(id)
-        if component
-          result = api_request('patch', "components/#{id}.json", args)
-          if result
-            "Component #{id} updated"
-          else
-            'Error updating component'
-          end
-        else
-          'Component not found'
+        return t('component.not_found') unless component
+
+        result = api_request('patch', "components/#{id}.json", args)
+        result ? t('component.updated', id: id) : t('error.api_request')
+      end
+
+      def identify_component(args)
+        return nil unless args.key?('name') || args.key?('id')
+
+        if args.key?('id')
+          return args['id']
+        elsif args.key?('name')
+          component = component(args['name'])
+          return component['id']
         end
       end
 
@@ -363,9 +282,31 @@ module Lita
       end
 
       def valid_component_status?(status)
-        %w(operational degraded_performance partial_outage major_outage).include?(status)
+        %w(operational
+           degraded_performance
+           partial_outage
+           major_outage).include?(status)
       end
 
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def valid_args?(args)
+        return false unless args.key?('name') || args.key?('id')
+
+        return false if args.key?('status') &&
+                        !valid_incident_status?(args['status'])
+
+        return false if args.key?('twitter') &&
+                        !valid_twitter_status?(args['twitter'])
+
+        return false if args.key?('impact') &&
+                        !valid_impact_value?(args['impact'])
+
+        true
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+
       def parse_args(string)
         results = {}
         # TODO: Error handling on parse errors
@@ -378,30 +319,19 @@ module Lita
       end
 
       def api_request(method, component, args = {})
-        if Lita.config.handlers.statuspage.api_key.nil? ||
-           Lita.config.handlers.statuspage.page_id.nil?
-          Lita.logger.error('Missing API key or Page ID for Statuspage')
-          fail 'Missing config'
-        end
-
-        url = "https://api.statuspage.io/v1/pages/" \
-              "#{Lita.config.handlers.statuspage.page_id}" \
-              "/#{component}"
+        url = "https://api.statuspage.io/v1/pages/#{config.page_id}/#{component}"
 
         http_response = http.send(method) do |req|
           req.url url, args
-          req.headers['Authorization'] =
-            "OAuth #{Lita.config.handlers.statuspage.api_key}"
+          req.headers['Authorization'] = "OAuth #{config.api_key}"
         end
 
-        if http_response.status == 200 ||
-           http_response.status == 201
-          MultiJson.load(http_response.body)
-        else
-          Lita.logger.error("HTTP #{method} for #{url} with #{args} returned #{http_response.status}")
-          Lita.logger.error(http_response.body)
-          nil
+        unless http_response.status == 200 || http_response.status == 201
+          Lita.logger.error("#{method} for #{url} with #{args}: #{http_response.status}")
+          return nil
         end
+
+        MultiJson.load(http_response.body)
       end
     end