nine_one_one 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f932d2b4548af5aa6190e8e64e384616d426353c
-  data.tar.gz: 393635fc1515b29de54cab5fb373bd2d67d2e1ab
+  metadata.gz: 78b082ffa0e24bc561db44377acf1355736dc129
+  data.tar.gz: f5fef5647e90a970b7a1eaf6affd592e3733a26d
 SHA512:
-  metadata.gz: 629f7e378c4d8ff5835c61ed60a791bed5d92bedec8688a40f44fafd2d25125cf14d27679aa4b934b3e01eabaabe8f51d6e7b7280f17ac0618fcba166b9e3d61
-  data.tar.gz: 242511982a2132d84a400fdd4306344588ef770b48923dc24cb0834367a83f2397cac924d60bf85c90d8ed7dd6ae9bfadbbc5a212555509d195d453b79c3a183
+  metadata.gz: 88ba14725f3a147bddd56a90134d878a189d25704d60afa2d1ce5dc0868c809a27f105c053dcd0a93088f841cc5060a02bd262b8604af6bd0b29506e2d2b9041
+  data.tar.gz: ca7fed9b2ea62f3d16926e25742961d10108bb453ed9160281e73660b554a67dfc4977ddcacd367a087800dfe6b044c1978a832e4646fca6f7fe205369899173

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   Include:
     - '**/Rakefile'
@@ -16,9 +18,6 @@ Style/Documentation:
 Style/FormatString:
   Enabled: false
 
-Style/WhileUntilModifier:
-  MaxLineLength: 120
-
 Metrics/LineLength:
   Max: 120
   Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,31 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-08 01:39:54 +0100 using RuboCop version 0.47.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Style/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/nine_one_one/pager_duty_service.rb'
+    - 'spec/nine_one_one/pager_duty_service_spec.rb'
+    - 'spec/nine_one_one/slack_service_spec.rb'

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements
@@ -16,6 +16,6 @@ guard :rspec, cmd: "bundle exec rspec" do
 end
 
 guard :rubocop do
-  watch(%r{.+\.rb$})
+  watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end

data/README.md

@@ -10,6 +10,10 @@ Count](https://codeclimate.com/repos/58207e5ee72dfa227600001d/badges/ecd3be37c49
 
 Common notification logic for PagerDuty/Slack notifications.
 
+Please note that starting with version 1.0.0 this gem uses Pager Duty events api V2, which breaks backwards compatibility. 
+If you don't want to change your existing API V1 calls made via this game please stick to 0.X.0 version. If you migrate 
+though, please make sure all the trigger_event function calls in your app got updated and meet the new param requirements.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -69,9 +73,11 @@ end
 ```ruby
 # Send message to Slack channel or log it using logger depending on the `slack_enabled` config parameter
 NineOneOne.notify('Something happened!')
+# You can also send a hash message (compatible with the slack message spec: https://api.slack.com/docs/messages/builder) 
+NineOneOne.notify({attachments: [{title: 'Something happened!', text: 'More info'}]})
 
 # Send pager or log emergency using logger depending on the `send_pagers` config parameter
-NineOneOne.emergency('INCIDENT_KEY', 'Emergency message!', { optional_hash: 'with details' })
+NineOneOne.emergency('Emergency message!', 'Error source info', { optional_hash: 'with details' })
 
 # same for custom configurations
 NineOneOne.use(:my_custom_configuration).notify('Something happened!')
@@ -82,6 +88,16 @@ NineOneOne.use(:my_custom_configuration).emergency('INCIDENT_KEY', 'Emergency me
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+# Changelog
+
+1.0.0 Migrate to Pager Duty Events API V2 (backwards incompatible!) and add support for slack hash message.
+
+0.3.0 Allow to have multiple configurations for notifications 
+
+0.2.0 Add the ability to customize slack username and channel
+
+0.1.0 Initial version of the gem implementing Slack and Pager Duty services
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/u2i/nine_one_one.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 RuboCop::RakeTask.new do |task|
-  task.options = %w(--display-cop-names --format simple)
+  task.options = %w[--display-cop-names --format simple]
 end
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/lib/nine_one_one/configuration.rb

@@ -23,9 +23,7 @@ module NineOneOne
     private
 
     def validate_send_pagers
-      unless [true, false].include?(send_pagers)
-        raise ConfigurationError, "Illegal 'send_pagers' value: #{send_pagers}"
-      end
+      raise ConfigurationError, "Illegal 'send_pagers' value: #{send_pagers}" unless [true, false].include?(send_pagers)
 
       raise ConfigurationError, "'send_pagers' is false but no logger given" if !send_pagers && logger.nil?
     end

data/lib/nine_one_one/log_service.rb

@@ -4,8 +4,8 @@ module NineOneOne
       @logger = logger
     end
 
-    def trigger_event(incident_key, description, details_hash = nil)
-      logger.error "TRIGGERED INCIDENT #{incident_key}: #{description} #{details_hash}"
+    def trigger_event(description, source, details_hash, severity)
+      logger.error "TRIGGERED INCIDENT (#{severity}): #{description} | #{details_hash} | #{source}"
     end
 
     def notify(message)

data/lib/nine_one_one/notifier.rb

@@ -4,8 +4,8 @@ module NineOneOne
       @config = config
     end
 
-    def emergency(incident_key, description, details_hash = nil)
-      emergency_service.trigger_event(incident_key, description, details_hash)
+    def emergency(description, source, details_hash, severity)
+      emergency_service.trigger_event(description, source, details_hash, severity)
     end
 
     def notify(message)

data/lib/nine_one_one/pager_duty_service.rb

@@ -1,21 +1,22 @@
 module NineOneOne
   class PagerDutyService
     BASE_HOST = 'events.pagerduty.com'.freeze
-    EVENT_ENDPOINT = '/generic/2010-04-15/create_event.json'.freeze
-
+    EVENTS_API_V2_ENDPOINT = '/v2/enqueue'.freeze
     THROTTLE_HTTP_STATUS = 403
     THROTTLE_RETRIES = 2
+    HIGH_URGENCY_ERROR = 'error'.freeze
 
     def initialize(api_integration_key)
       @api_integration_key = api_integration_key
       @http = Http.new(BASE_HOST)
     end
 
-    def trigger_event(incident_key, description, details_hash = nil)
+    def trigger_event(description, source, details_hash, severity)
       response = nil
 
       retry_on(THROTTLE_HTTP_STATUS, THROTTLE_RETRIES) do
-        response = make_request(description, details_hash, incident_key)
+        body = request_body(description, severity, source, details_hash)
+        response = make_request(body)
         response.code.to_i
       end
 
@@ -39,21 +40,23 @@ module NineOneOne
       end
     end
 
-    def make_request(description, details_hash, incident_key)
-      headers = { 'Content-Type' => 'application/json' }
-      body = request_body(incident_key, description, details_hash)
+    def make_request(body)
+      headers = {'Content-Type' => 'application/json'}
 
-      http.post(EVENT_ENDPOINT, body, headers)
+      http.post(EVENTS_API_V2_ENDPOINT, body, headers)
     end
 
-    def request_body(incident_key, description, details_hash)
+    def request_body(description, severity, source, details_hash)
       body = {
-        service_key: api_integration_key,
-        event_type: 'trigger',
-        incident_key: incident_key,
-        description: description
+        routing_key: api_integration_key,
+        event_action: 'trigger',
+        payload: {
+          summary: description,
+          severity: severity,
+          source: source,
+          custom_details: details_hash
+        }
       }
-      body[:details] = details_hash if details_hash
 
       body.to_json
     end

data/lib/nine_one_one/slack_service.rb

@@ -11,12 +11,8 @@ module NineOneOne
 
     def notify(message)
       body = request_body(message)
-
       headers = { 'Content-Type' => 'application/json' }
-
-      response = http.post(path, body, headers)
-
-      response.is_a?(Net::HTTPSuccess)
+      http.post(path, body, headers)
     end
 
     private
@@ -24,8 +20,7 @@ module NineOneOne
     attr_reader :channel, :http, :path, :username
 
     def request_body(message)
-      body = { text: message }
-
+      body = message.is_a?(Hash) ? message : { text: message }
       body[:channel]  = channel  unless channel.nil?
       body[:username] = username unless username.nil?
 

data/lib/nine_one_one/version.rb

@@ -1,3 +1,3 @@
 module NineOneOne
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/nine_one_one.rb

@@ -27,8 +27,8 @@ module NineOneOne
     @configs ||= {}
   end
 
-  def self.emergency(incident_key, description, details_hash = nil)
-    use(:default).emergency(incident_key, description, details_hash)
+  def self.emergency(description, source, details_hash = nil, severity = PagerDutyService::HIGH_URGENCY_ERROR)
+    use(:default).emergency(description, source, details_hash, severity)
   end
 
   def self.notify(message)

data/nine_one_one.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'nine_one_one/version'
@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = NineOneOne::VERSION
   spec.licenses      = ['MIT']
   spec.authors       = ['Kacper Madej', 'Marek Mateja']
-  spec.email         = %w(kacper.madej@u2i.com marek.mateja@u2i.com)
+  spec.email         = %w[kacper.madej@u2i.com marek.mateja@u2i.com]
 
-  spec.summary       = %q{Alerts and notifications via PagerDuty and Slack for Ruby apps}
+  spec.summary       = 'Alerts and notifications via PagerDuty and Slack for Ruby apps'
   spec.homepage      = 'https://github.com/u2i/nine_one_one'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -20,16 +20,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.1'
+  spec.post_install_message = 'From Ver 1.0.0 emergency method call is not backwards compatible!'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
   spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 2.3'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
-  spec.add_development_dependency 'simplecov', '~> 0.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nine_one_one
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kacper Madej
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -110,61 +124,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.47'
 - !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.3'
 description: 
 email:
 - kacper.madej@u2i.com
@@ -176,6 +176,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -197,7 +198,7 @@ homepage: https://github.com/u2i/nine_one_one
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: From Ver 1.0.0 emergency method call is not backwards compatible!
 rdoc_options: []
 require_paths:
 - lib