nine_one_one 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc1d95a66273659ccfaac813c2324de176a55e5b
+  data.tar.gz: 9d32c8fcf3095ff38f665af3b9ed540b8d2a542a
+SHA512:
+  metadata.gz: 8e95ffe1c79216decaace3931588d690365fe1ca98a47eae7f5a5496f52c65ec97382a457acde2dc9e20dfce6a5e8efe793e51ba2b02c06bf34e4a0697859f01
+  data.tar.gz: 08b510ec8a4af089217c21092c502396c95d6923ef2051c0b671521e23518bdf05658677860f7b26bbbc9116b983519d4b3c1faef06e40b292c238092961afed

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.1
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+
+Metrics/LineLength:
+  Max: 120
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+before_install: gem update --remote bundler
+rvm:
+  - 2.1.5
+  - 2.2.5
+  - 2.3.1
+script: "bundle exec rake spec"
+addons:
+  code_climate:
+    repo_token: c422f2d5b2f42f45b2385d368407e350e1862156e14e4a18cab4d32907be570c

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,21 @@
+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
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -0,0 +1,66 @@
+[![Build](https://travis-ci.org/u2i/nine_one_one.svg?branch=master)](https://travis-ci.org/u2i/nine_one_one)
+[![Code
+Climate](https://codeclimate.com/repos/58207e5ee72dfa227600001d/badges/ecd3be37c49334786095/gpa.svg)](https://codeclimate.com/repos/58207e5ee72dfa227600001d/feed)
+[![Test
+Coverage](https://codeclimate.com/repos/58207e5ee72dfa227600001d/badges/ecd3be37c49334786095/coverage.svg)](https://codeclimate.com/repos/58207e5ee72dfa227600001d/coverage)
+[![Issue
+Count](https://codeclimate.com/repos/58207e5ee72dfa227600001d/badges/ecd3be37c49334786095/issue_count.svg)](https://codeclimate.com/repos/58207e5ee72dfa227600001d/feed)
+
+# NineOneOne
+
+Common notification logic for PagerDuty/Slack notifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nine_one_one'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nine_one_one
+
+## Configuration
+
+By default NineOneOne loggs notifications and emegencies to STDOUT. You can override default settings with:
+
+```ruby
+NineOneOne.configure do |config|
+    # Use Pager Duty API for emergencies (defaults to false)
+    config.send_pagers = true
+    config.pager_duty_integration_key = 'pager-api-key'
+
+    # Post notifications using Slack Webhook URL (defaults to false)
+    config.slack_enabled = true
+    config.slack_webhook_url = 'https://hooks.slack.com/services/XXX/YYY/ZZZ'
+
+    # Use custom logger - it must implement .info(string) and .error(string) methods
+    # Defaults to Logger.new(STDOUT)
+    config.logger = Logger.new('incidents.log') 
+end
+```
+
+## Usage
+
+```ruby
+# Send message to Slack channel or log it using logger depending on the `slack_enabled` config parameter
+NineOneOne.notify('Something happened!')
+
+# Send pager or log emergency using logger depending on the `send_pagers` config parameter
+NineOneOne.emergency('INCIDENT_KEY', 'Emergency message!', { optional_hash: 'with details' })
+```
+
+## Development
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/u2i/nine_one_one.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new do |task|
+  task.options = %w(--display-cop-names --format simple)
+end
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nine_one_one"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nine_one_one/configuration.rb

@@ -0,0 +1,55 @@
+require 'logger'
+
+module NineOneOne
+  class Configuration
+    attr_accessor :send_pagers, :pager_duty_integration_key, :slack_enabled, :slack_webhook_url, :logger
+
+    def initialize
+      self.send_pagers = false
+      self.slack_enabled = false
+      self.logger = Logger.new(STDOUT)
+    end
+
+    def validate
+      validate_send_pagers
+      validate_logger
+      validate_pager_duty_key
+      validate_slack_enabled
+    end
+
+    private
+
+    def validate_send_pagers
+      unless [true, false].include?(send_pagers)
+        raise ConfigurationError, "Illegal 'send_pagers' value: #{send_pagers}"
+      end
+
+      raise ConfigurationError, "'send_pagers' is false but no logger given" if !send_pagers && logger.nil?
+    end
+
+    # rubocop:disable Style/GuardClause
+    def validate_logger
+      raise ConfigurationError, "Logger: #{logger.class} doesn't respond to #error" unless logger.respond_to?(:error)
+      raise ConfigurationError, "Logger: #{logger.class} doesn't respond to #info" unless logger.respond_to?(:info)
+    end
+
+    def validate_pager_duty_key
+      return true unless send_pagers
+
+      if pager_duty_integration_key.nil? || pager_duty_integration_key.empty?
+        raise ConfigurationError, "Missing 'pager_duty_integration_key' parameter"
+      end
+    end
+
+    def validate_slack_enabled
+      unless [true, false].include?(slack_enabled)
+        raise ConfigurationError, "Illegal 'slack_enabled' value: #{slack_enabled}"
+      end
+
+      if slack_enabled && (slack_webhook_url.nil? || slack_webhook_url.empty?)
+        raise ConfigurationError, 'Incorrect Slack webhook URL'
+      end
+    end
+    # rubocop:enable Style/GuardClause
+  end
+end

data/lib/nine_one_one/errors.rb

@@ -0,0 +1,12 @@
+module NineOneOne
+  class Error < RuntimeError; end
+
+  class ConfigurationError < Error; end
+  class IncidentReportingError < Error; end
+  class NotificationError < Error; end
+
+  class HttpError < Error; end
+  class SSLError < HttpError; end
+  class TimeoutError < HttpError; end
+  class ConnectionFailedError < HttpError; end
+end

data/lib/nine_one_one/http.rb

@@ -0,0 +1,68 @@
+begin
+  require 'net/https'
+rescue LoadError
+  warn 'Warning: no such file to load -- net/https. Make sure openssl is installed if you want ssl support'
+  require 'net/http'
+end
+require 'zlib'
+
+# a minimal wrapper around Net::HTTP which encapsulates ugly Net::HTTP errors
+# and throws NineOneOne:Errors instead. The implementation is based on
+# Faraday's Net::HTTP adapter
+module NineOneOne
+  class Http
+    # rubocop:disable Style/MutableConstant
+    NET_HTTP_EXCEPTIONS = [
+      EOFError,
+      Errno::ECONNABORTED,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EHOSTUNREACH,
+      Errno::EINVAL,
+      Errno::ENETUNREACH,
+      Errno::EPIPE,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      SocketError,
+      Zlib::GzipFile::Error
+    ]
+    # rubocop:enable Style/MutableConstant
+
+    NET_HTTP_EXCEPTIONS << OpenSSL::SSL::SSLError if defined?(OpenSSL)
+    NET_HTTP_EXCEPTIONS << Net::OpenTimeout if defined?(Net::OpenTimeout)
+
+    attr_reader :net_http
+
+    def initialize(base_host, scheme = 'https')
+      port, use_ssl = scheme == 'https' ? [443, true] : [80, false]
+
+      @net_http = Net::HTTP.new(base_host, port)
+
+      @net_http.use_ssl = use_ssl
+    end
+
+    def post(path, body, headers)
+      post!(path, body, headers)
+    rescue *NET_HTTP_EXCEPTIONS => err
+      err_class = if defined?(OpenSSL) && err.is_a?(OpenSSL::SSL::SSLError)
+                    SSLError
+                  else
+                    ConnectionFailedError
+                  end
+
+      raise err_class, err
+    rescue Timeout::Error, Errno::ETIMEDOUT => err
+      raise TimeoutError, err
+    end
+
+    private
+
+    def post!(path, body, headers)
+      request = Net::HTTP::Post.new(path, headers)
+      request.body = body
+
+      net_http.request(request)
+    end
+  end
+end

data/lib/nine_one_one/log_service.rb

@@ -0,0 +1,19 @@
+module NineOneOne
+  class LogService
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def trigger_event(incident_key, description, details_hash = nil)
+      logger.error "TRIGGERED INCIDENT #{incident_key}: #{description} #{details_hash}"
+    end
+
+    def notify(message)
+      logger.info(message)
+    end
+
+    private
+
+    attr_reader :logger
+  end
+end

data/lib/nine_one_one/pager_duty_service.rb

@@ -0,0 +1,61 @@
+module NineOneOne
+  class PagerDutyService
+    BASE_HOST = 'events.pagerduty.com'.freeze
+    EVENT_ENDPOINT = '/generic/2010-04-15/create_event.json'.freeze
+
+    THROTTLE_HTTP_STATUS = 403
+    THROTTLE_RETRIES = 2
+
+    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)
+      response = nil
+
+      retry_on(THROTTLE_HTTP_STATUS, THROTTLE_RETRIES) do
+        response = make_request(description, details_hash, incident_key)
+        response.code.to_i
+      end
+
+      # rubocop:disable Style/GuardClause
+      unless response.is_a?(Net::HTTPSuccess)
+        raise IncidentReportingError, "Failed to create PagerDuty event: #{response.body}"
+      end
+      # rubocop:enable Style/GuardClause
+    end
+
+    private
+
+    attr_reader :api_integration_key, :http
+
+    def retry_on(value, retries_number)
+      retry_number = 0
+
+      while yield == value && retry_number <= retries_number
+        retry_number += 1
+        sleep 2**retry_number
+      end
+    end
+
+    def make_request(description, details_hash, incident_key)
+      headers = { 'Content-Type' => 'application/json' }
+      body = request_body(incident_key, description, details_hash)
+
+      http.post(EVENT_ENDPOINT, body, headers)
+    end
+
+    def request_body(incident_key, description, details_hash)
+      body = {
+        service_key: api_integration_key,
+        event_type: 'trigger',
+        incident_key: incident_key,
+        description: description
+      }
+      body[:details] = details_hash if details_hash
+
+      body.to_json
+    end
+  end
+end

data/lib/nine_one_one/slack_service.rb

@@ -0,0 +1,27 @@
+module NineOneOne
+  class SlackService
+    def initialize(webhook_url)
+      uri = URI(webhook_url)
+
+      @http = Http.new(uri.host, uri.scheme)
+      @path = uri.path
+    end
+
+    def notify(message)
+      body = request_body(message)
+      headers = { 'Content-Type' => 'application/json' }
+
+      response = http.post(path, body, headers)
+
+      response.is_a?(Net::HTTPSuccess)
+    end
+
+    private
+
+    attr_reader :http, :path
+
+    def request_body(message)
+      { text: message }.to_json
+    end
+  end
+end

data/lib/nine_one_one/version.rb

@@ -0,0 +1,3 @@
+module NineOneOne
+  VERSION = '0.1.0'.freeze
+end

data/lib/nine_one_one.rb

@@ -0,0 +1,47 @@
+require_relative './nine_one_one/errors'
+require_relative './nine_one_one/http'
+require_relative './nine_one_one/version'
+require_relative './nine_one_one/configuration'
+require_relative './nine_one_one/log_service'
+require_relative './nine_one_one/slack_service'
+require_relative './nine_one_one/pager_duty_service'
+
+module NineOneOne
+  def self.emergency_service
+    if config.send_pagers
+      PagerDutyService.new(config.pager_duty_integration_key)
+    else
+      LogService.new(config.logger)
+    end
+  end
+
+  def self.notification_service
+    if config.slack_enabled
+      SlackService.new(config.slack_webhook_url)
+    else
+      LogService.new(config.logger)
+    end
+  end
+
+  def self.configure
+    config = Configuration.new
+
+    yield config
+
+    config.validate
+
+    @config = config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.emergency(incident_key, description, details_hash = nil)
+    emergency_service.trigger_event(incident_key, description, details_hash)
+  end
+
+  def self.notify(message)
+    notification_service.notify(message)
+  end
+end

data/nine_one_one.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nine_one_one/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nine_one_one'
+  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.summary       = %q{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|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  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 '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

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: nine_one_one
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kacper Madej
+- Marek Mateja
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: 
+email:
+- kacper.madej@u2i.com
+- marek.mateja@u2i.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nine_one_one.rb
+- lib/nine_one_one/configuration.rb
+- lib/nine_one_one/errors.rb
+- lib/nine_one_one/http.rb
+- lib/nine_one_one/log_service.rb
+- lib/nine_one_one/pager_duty_service.rb
+- lib/nine_one_one/slack_service.rb
+- lib/nine_one_one/version.rb
+- nine_one_one.gemspec
+homepage: https://github.com/u2i/nine_one_one
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Alerts and notifications via PagerDuty and Slack for Ruby apps
+test_files: []