smartnotify2 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e687c007b40ebd3e8771c1fb9cf437bdfad4987d92c427d2bdc093d195ee10d1
+  data.tar.gz: eefb144a2d6eaf3a065ac8139dea554221541670a26348e9cde5ef6421e4c12a
+SHA512:
+  metadata.gz: 9c37becbabaf10e56fd0d526685faaeec249c90c9bcbcfc0c10d4bba4ab0501ea6b40d9cc465479c20f1ca966a2062b1a9346655f9bae85b58e32629687f4a12
+  data.tar.gz: c60957633ede9af4f60ce2c43db426c6c88ebe2477eb012661d0ddce476fd1b30eba07a07a163a9d7196a10ef28f345dfef3fdba54dd8e64f3113e1cb3e07bdf

data/README.md

@@ -0,0 +1,54 @@
+# SmartNotify
+
+Ruby Gem designed for sending various types of notifications via a common configurable interface.
+ 
+## Overview
+The gem makes use of two components, modules, and templates. 
+
+Modules are defined within this gem, and provide various forms of generic notification functionality. The modules are created to be reusable. A module could be responsible for sending emails, posting Slack notifications, making a REST call to an external API, whatever. 
+ 
+Templates on the other hand, consume a specific module, in conjunction with template specific configuration, creating very specific use cases. These use cases could be team specific, allowing different consumers to tweak who, and how notifications are distributed. 
+ 
+## Why
+There was a need to easily send SLA incident emails to the correct person on support, as well as to a MS Teams channel. A module was created `rotation_emailer` which could send emails, based on a given email template, and support rotation csv file. With that in place, a template was created `incident_start_email` which defines where the specific email template, and support rotation csv file is located for this particular instance. This is awesome, because a new team or solution could create a template, changing only the support rotation csv location, and get the same functionality for next to no setup cost.
+ 
+
+## Usage
+Add smartnotify to your Gemfile, pointing at GitHub.
+```
+gem 'smartnotify', git: 'https://github.cerner.com/PHPerfImp/smartnotify.git', branch: 'master'
+```
+
+Within your code add:
+```ruby
+ require 'smartnotify'
+ # ... your logic ...
+ smartnotify = SmartNotify.new
+ smartnotify.run(template, json, [debug], [dryrun])
+```
+
+*Note: when updates are made to the gem in github, bundle update & bundle install must be run to pull in the changes.
+
+| Param | Type | Requirement | Default |  Description |
+| ---- | ---- | ----------- | ------- | --------------- |
+| template | String | Required | | The id of the template to use. The templates are configured externally in [PHPerfImp/smartnotify-config](https://github.cerner.com/PHPerfImp/smartnotify-config) |
+| json | String | Required | | The JSON key/value pairs to be used as input to the selected template. Each template defines what keys must be provided. |
+| environment | String | Optional | production | The id of the environment configuration to use. Choices are local, development, staging, and production. |
+| debug | Boolean | Optional | false | Enables debug logging within SmartNotify. |
+| dryrun | Boolean | Optional |  false | Enables debug logging within SmartNotify, and disables sending any notifications for testing purposes. |
+
+### Example
+```ruby
+smartnotify = SmartNotify.new
+smartnotify.run('incident_start_email', "{\"mnemonic\": \"sbmcin\", \"cerner_mnemonic\": \"UNVR_NY\", \"link\": \"https://jira2.cerner.com/browse/PERFIMPDEV-1349\", \"title\": \"Readmission SLA Exceeded\", \"message\": \"Readmission SLA exceeded, please check the JIRA for more information.\"}", 'production')
+```
+
+## Modules
+The following are the currently available modules that can be consumed. Follow the link to get more information on 
+intended usage, and configuration.
+
+* [Rotation Emailer](modules/roatation_emailer/README.md)
+ 
+## Releasing New Version
+
+*N/A - As long as we are using our internal GitHub for storage of the gem, there is no need to 'release' a new version. Using a different version of the branch can be achieved by pointing the Gemfile reference at a different ref. See http://bundler.io/v1.12/git.html for more information.

data/lib/config/config.yml

@@ -0,0 +1 @@
+external-config-path: 'https://raw.github.cerner.com/PHPerfImp/smartnotify-config/master/config/config.yml'

data/lib/modules/rotation_emailer/README.md

@@ -0,0 +1,31 @@
+# Module - Rotation Emailer
+  
+**Module ID:** `rotation_emailer`
+
+## Required Configuration
+
+* *email_template* - A URL pointed to the template of the email message to send. This document should be a .erb file. 
+The data is fed into the template from the provided json, as a hash. *e.g accessing a title key would look like
+`<%= data['title'] %>`*
+
+* *support_rotation* - A URL pointed to a CSV file containing email addresses, combined with start/end times for 
+when the given address is valid to email. On each run, the file will be parsed looking for emails that are valid at that
+time and will send the message to all the addresses as one group email. At a minimum, the following three columns 
+with headers must be specified:
+
+    * `Start Time` - Formatted as 12/Aug/2017. This is the date, starting at the beginning of the day, that the email 
+    address can start being emailed.
+    * `End Time` - Formatted as 18/Aug/2017.  This is the date, ending at midnight, that the email address is no longer 
+    valid to notify after. 
+    * `Email Address` - Email address to notify.
+    
+ *Note:*
+ * *All times a calculated with the configured timezone of Central Time (US & Canada)*
+ * *Column headers are case sensitive.*
+
+## Required JSON keys
+While most of the JSON key/value pairs are defined based on what 
+the template needs, this module requires that a `title` JSON key
+be provided which is used as the subject of the email. If no title
+key is defined, a fallback *'Rotation Emailer Notification'* title 
+will be used as the email subject instead. 

data/lib/modules/rotation_emailer/rotation_emailer.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+
+require 'mail'
+require 'yaml'
+require 'csv'
+require 'open-uri'
+require 'logging'
+
+class NotificationModule
+
+  def initialize(config)
+    @config = config
+    @log = Logging.logger['rotation_emailer']
+  end
+
+  def run
+
+    c = @config
+
+    @log.info ''
+    @log.info 'Starting rotation_emailer.rb logic...'
+
+    # Setup Mailer
+    @log.info ''
+    @log.info 'Setting up Mail.defaults with the following configuration:'
+    @log.info "  host: #{c[:global]['smtp_host']}"
+    @log.info "  port: #{c[:global]['smtp_port']}"
+
+
+    Mail.defaults do
+      delivery_method :smtp, {
+          :address => c[:global]['smtp_host'],
+          :port => c[:global]['smtp_port']
+      }
+    end
+
+    # Load Email Addresses
+
+    send_list = c[:config]['always_email']
+
+    unless c[:config]['support_rotation'].nil?
+      @log.info ''
+      @log.info 'Loading support rotation from:'
+      @log.info "  #{c[:config]['support_rotation']}"
+      CSV.new(open(c[:config]['support_rotation']), :headers => :first_row).each do |email|
+        send_list.push("#{email['Email Address']}") if active_email(email, c[:global]['timezone'])
+      end
+    end
+
+    send_list.uniq!
+
+    if send_list.empty?
+      @log.error 'No email addresses are setup for the current time.'
+      return false
+    end
+
+    @log.info ''
+    @log.info 'Found the following email addresses to notify:'
+
+    send_list.each do |recipient|
+      @log.info " #{recipient}"
+    end
+
+    # Load Template
+    @log.info ''
+    @log.info 'Loading email template from:'
+    @log.info " #{c[:config]['email_template']}"
+
+    email_template = open(c[:config]['email_template']).read
+
+    # Populate Template
+    b = binding
+    b.local_variable_set(:data, c[:data])
+    message = ERB.new(email_template).result(b)
+
+    if c[:global]['dryrun']
+      @log.info ''
+      @log.info 'Not sending email because dryrun is enabled.'
+      @log.info 'Would have emailed the following message:'
+      @log.info ''
+      @log.info "SUBJECT: #{c[:data]['title']}"
+      @log.info ''
+      @log.info '--- MESSAGE START ---'
+      message.each_line do |line|
+        @log.info " #{line.chomp}"
+      end
+      @log.info '--- MESSAGE END ---'
+    else
+      # Send The Emails
+      @log.info ''
+      @log.info 'Sending Emails...'
+
+      title = c[:data]['title'].nil? ? 'Rotation Emailer Notification' : c[:data]['title']
+      send_email(title, c[:global]['smtp_from'], send_list, message)
+    end
+    @log.info ''
+    @log.info ' Finished rotation_emailer.rb logic.'
+  end
+
+  private
+
+  def active_email(email, tz)
+    start_time = DateTime.parse(email['Start Time'] + ' ' + tz)
+    end_time = DateTime.parse(email['End Time'] + ' ' + tz) + 1
+    current_time = DateTime.now
+    start_time <= current_time and end_time > current_time
+  end
+
+  def send_email(subject_text, from_email, to_email, body_text)
+    Mail.deliver do
+      to to_email
+      from from_email
+      subject subject_text
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body body_text
+      end
+    end
+  end
+end

data/lib/modules/slack_notifier/slack_notifier.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'mail'
+require 'yaml'
+require 'csv'
+require 'open-uri'
+require 'logging'
+require 'slack-notifier'
+
+class NotificationModule
+
+  def initialize(config)
+    @config = config
+    @log = Logging.logger['slack_notifier']
+  end
+
+  def run
+
+    c = @config
+
+    @log.info ''
+    @log.info 'Starting slack_notifier.rb logic...'
+
+    # Load Template
+    @log.info ''
+    @log.info 'Loading message template from:'
+    @log.info " #{c[:config]['message_template']}"
+
+    message_template = open(c[:config]['message_template']).read
+
+    # Populate Template
+    b = binding
+    b.local_variable_set(:data, c[:data])
+    message = ERB.new(message_template).result(b)
+
+    if c[:global]['dryrun']
+      @log.info ''
+      @log.info 'Not sending slack message because dryrun is enabled.'
+      @log.info 'Would have posted the following message:'
+      @log.info ''
+      @log.info '--- MESSAGE START ---'
+      message.each_line do |line|
+        @log.info " #{line.chomp}"
+      end
+      @log.info '--- MESSAGE END ---'
+    else
+      # Send The Emails
+      @log.info ''
+      @log.info 'Posting Message to Slack...'
+      @log.info " Channel: #{c[:config]['channel']} "
+      @log.info " Username: #{c[:config]['username']} "
+
+      notifier = Slack::Notifier.new "#{c[:config]['webhook']}" do
+        defaults channel: "#{c[:config]['channel']}",
+                 username: "#{c[:config]['username']}"
+      end
+      notifier.ping message
+    end
+    @log.info ''
+    @log.info ' Finished slack_notifier.rb logic.'
+  end
+end

data/lib/smartnotify.rb

@@ -0,0 +1,99 @@
+require 'yaml'
+require 'erb'
+require 'json'
+require 'open-uri'
+require 'logging'
+
+class SmartNotify
+  attr_accessor :config
+
+  def initialize
+    Logging.logger.root.appenders = Logging.appenders.stdout
+    Logging.logger.root.level = :debug
+    @log = Logging.logger['smartnotify']
+  end
+
+  def run(template, json, env = 'production', debug = false, dryrun = false)
+
+    # Ensure Options Provided
+    if json.nil? || template.nil? || env.nil?
+      @log.error 'Must provide template, JSON data, and environment name.'
+      return false
+    end
+
+    # Load Configuration
+    internal_config = YAML.load_file(File.join(__dir__, 'config/config.yml'))
+    @log.info 'Loading SmartNotify config from:'
+    @log.info " #{internal_config['external-config-path']}"
+
+    external_config = nil
+    begin
+      external_config = YAML.load(open(internal_config['external-config-path']).read)
+    rescue
+      @log.error 'Unable to load and parse configuration.'
+      @log.error 'Check that the file exists, and that it is valid YMAL.'
+      return false
+    end
+
+    # Load Environment Configuration
+    env = env.downcase
+
+    @log.info ''
+    @log.info "SmartNotify Environment: #{env}"
+
+    config = external_config[env]
+    if config.nil?
+      @log.error 'Configuration does not contain configuration for specified environment.'
+      return false
+    end
+
+    # Load Template Configuration
+    template_config = config[template]
+    if template_config.nil?
+      @log.error "Template '#{template}' not found."
+      return false
+    end
+
+    # Configure Development Flags
+    config['global']['dryrun'] = dryrun
+
+
+    # Load JSON
+    begin
+      template_data = JSON.parse(json)
+    rescue JSON::ParserError => e
+      puts 'ERROR: JSON provided is unable to be parsed.'
+      return false
+    end
+
+    # Prepare Module Configuration
+    module_config = Hash.new
+    module_config[:config] = template_config
+    module_config[:data] = template_data
+    module_config[:global] = config['global']
+
+    # Ensure Required Fields Present
+    unless module_config[:config]['required_fields'].nil?
+      module_config[:config]['required_fields'].each do |field|
+        if module_config[:data][field].nil?
+          @log.error "JSON provided is missing required field '#{field}'"
+          return false
+        end
+      end
+    end
+
+    if module_config[:config]['module'] == 'rotation_emailer'
+      require_relative 'modules/rotation_emailer/rotation_emailer'
+    elsif module_config[:config]['module'] == 'slack_notifier'
+      require_relative 'modules/slack_notifier/slack_notifier'
+    else
+      @log.error "'#{module_config[:config]['module']}' module does not exist."
+      @log.error 'Ensure the correct module name is defined in the configuration.'
+      return false
+    end
+
+    # Run Module
+    NotificationModule.new(module_config).run
+  end
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: smartnotify2
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Performance Improvement Dev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Utility for sending various types of notifications via a common configurable
+  interface.
+email:
+- kristopher.williams@cerner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/config/config.yml
+- lib/modules/rotation_emailer/README.md
+- lib/modules/rotation_emailer/rotation_emailer.rb
+- lib/modules/slack_notifier/README.md
+- lib/modules/slack_notifier/slack_notifier.rb
+- lib/smartnotify.rb
+homepage: https://github.cerner.com/PHPerfImp/smartnotify
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Common interface notification utility
+test_files: []