miq_utilities 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2238911c5afe3bc64b77cf5678044f81a15b3bab44da036c3b6efda38fe7b50
+  data.tar.gz: 615876043211d98d49c2e0898284cbd900b13929155862a9d25c8ec20402737c
+SHA512:
+  metadata.gz: b48663b05141985b94313a9996a33562048fb7b0b20ab655ce7e418b63a4848f5f5d032d8673f70c0946d7952a145996c49322889a8efc3bad8271ee6438ad83
+  data.tar.gz: 4bab43cdb2338c9ef1abeab52dd429ab762542627c1f0f65599387c7f04dd6a215609b8efccdd5c07d84473ab9cd472556b6946a0d2b7809cea18c3d2f23c347

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in miq_utilities.gemspec
+gemspec
+gem 'slack-ruby-client'
+gem 'eventmachine'
+gem 'faye-websocket'
+gem 'rbvmomi'
+gem 'tiny_tds'
+gem 'winrm'
+gem 'rest-client'
+gem 'json'

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    miq_utilities (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    erubis (2.7.0)
+    eventmachine (1.2.6-x64-mingw32)
+    faraday (0.15.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    faye-websocket (0.10.7)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    ffi (1.9.23-x64-mingw32)
+    gli (2.17.1)
+    gssapi (1.2.0)
+      ffi (>= 1.0.1)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashie (3.5.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    netrc (0.11.0)
+    nokogiri (1.8.2-x64-mingw32)
+      mini_portile2 (~> 2.3.0)
+    nori (2.6.0)
+    rake (10.5.0)
+    rbvmomi (1.12.0)
+      builder (~> 3.0)
+      json (>= 1.8)
+      nokogiri (~> 1.5)
+      trollop (~> 2.1)
+    rest-client (2.0.2-x64-mingw32)
+      ffi (~> 1.9)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rubyntlm (0.6.2)
+    slack-ruby-client (0.11.1)
+      activesupport
+      faraday (>= 0.9)
+      faraday_middleware
+      gli
+      hashie
+      websocket-driver
+    thread_safe (0.3.6)
+    tiny_tds (2.1.1-x64-mingw32)
+    trollop (2.1.2)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5-x64-mingw32)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    winrm (2.2.3)
+      builder (>= 2.1.2)
+      erubis (~> 2.7)
+      gssapi (~> 1.2)
+      gyoku (~> 1.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (>= 1.6.1, < 3.0)
+      nori (~> 2.0)
+      rubyntlm (~> 0.6.0, >= 0.6.1)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  eventmachine
+  faye-websocket
+  json
+  miq_utilities!
+  rake (~> 10.0)
+  rbvmomi
+  rest-client
+  slack-ruby-client
+  tiny_tds
+  winrm
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aaron.Mccatty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,277 @@
+# MiqUtilities
+
+## Installation
+
+     $ gem install miq_utilities
+     
+## Usage
+
+    require 'miq_utilities'
+    
+## Dependencies
+
+1. bundler ~> 1.16
+2. rake ~> 10.0
+3. rbvmomi ~> 1.11.3
+4. tiny_tds ~> 2.1.0
+5. winrm ~> 2.2.3
+6. slack-ruby-client ~> 0.11.1
+7. rest-client ~> 1.8.0 x64-mingw32
+8. json ~> 2.0.4
+
+# Class Summary 
+## Sql Server (SqlClass) 
+
+Used to manage Sql Server queries. This Class utilises the `tiny_tds` Ruby Gem (version => 2.1.0).
+
+### Class Method Summary
+
+#### **initialize**
+
+_Create a connection to the client_
+Name   |   Type   | Description
+ ---- | ---- | ----
+user      | String  | Username
+password  | String  | Password
+host      | String  | The host name to connect to
+port      | String  | The port to use, default 1433
+database  | String  | The database name to connect to
+azure     | Boolean | Set to true when connecting to Azure
+
+##### Method usage
+```
+require 'miq_utilities'
+sql = SqlClass.new(user, pwrd, host, 1433, db, azure)
+```
+
+#### **get_client**
+
+_Returns the client to utilise the `tiny_tds` functionality_
+
+##### Method usage
+```
+client = sql.get_client()
+```
+
+#### **run_sql_query**
+
+_Runs the specified SQL query against the client the class was instantiated for._ 
+Name  |   Type   | Description
+ ---- | ---- | ----
+sql   | String  | Sql query to be run
+
+##### Method usage
+```
+query = 'SELECT * FROM tbl_users'
+out = sql.run_sql_query(query)
+out.each {|user| puts "User Details: #{user}"}
+```
+
+#### **close_connection**
+ 
+_closes the connection to the client._
+
+##### Method usage
+```
+sql.close_connection()
+```
+
+## Logging (LoggingClass)
+
+This Class is used to handle the logging for ManageIQ and an IDE. 
+
+### Class Method Summary
+
+#### **initialize**
+
+_Instantiate the class using the name of the class/method/instantiator._
+Name   |   Type   | Description
+ ---- | ---- | ----
+name      | String  | The name of the class/method/instantiator
+
+##### Method usage
+```
+require 'miq_utilities'
+logger = LoggingClass.new('example_method_name')
+```
+
+#### **log**
+
+_Log to the `$evm` object i.e. automation.log._
+Name   |   Type   | Description
+ ---- | ---- | ----
+level           | String  | The level of info/warning/error (no action is taken regardless of level)
+message         | String  | The message to write
+logtoscreenonly | Boolean | Only log to screen
+notify          | Boolean | Process message through the notify process
+
+##### Method usage
+```
+logger.log('info','This is a test message!')
+```
+or to process through the Notify class we would use the follwoing: 
+```
+logger.log('warn', 'This is a warning message', false, true)
+```
+NOTE: When "NOTE" is passed as the level, the notify class turns this into an INFO on-screen message.
+
+## VmWare (VmwareClass) 
+
+This Class is used to handle some of the heavily used VMWare utilities.  This Class utilises the `rbvmomi` Ruby Gem (version => 1.11.3).
+
+### Class Method Summary
+
+#### **initialize**
+
+_Assign the host name._
+Name   |   Type   | Description
+ ---- | ---- | ----
+hostName | String  | The name of the host to be used
+
+##### Method usage
+```
+vmware = VmwareClass.new('MyHostName')
+```
+
+#### **get_vsphere_connection**
+
+_Returns the client connection._
+Name   |   Type   | Description
+ ---- | ---- | ----
+user       | String  | The user to connect with
+password   | String  | The users password
+
+##### Method usage
+```
+vsphereconn  = vmware.get_vsphere_connection(user,pwd)
+```
+
+#### **retrieve_data_centre**
+
+_Returns the datacentre based on the connection and datacentre name._
+Name   |   Type   | Description
+ ---- | ---- | ----
+vsphereconn  | object  | The return of "get_vsphere_connection"
+dcname       | String  | The name of the datacentre
+
+##### Method usage
+```
+ vmdc = vmware.retrieve_data_centre(vsphereconn,'MyDatacentre')
+```
+
+## Run Powershell (WinrmClass)
+
+This Class is used to run PowerShell scripts. This Class utilises the `winrm` Ruby Gem (version => 2.2.3). 
+
+### Class Method Summary
+
+#### **initialize**
+
+_Run a specified PowerShell script._
+Name   |   Type   | Description
+ ---- | ---- | ----
+ps_script    | String  | The name of the script to run (including path to the file)
+host         | String  | The name of the host to connect to
+user         | String  | The user to connect with
+password     | String  | The users password
+
+##### Method usage
+```
+  Name = 'Aaron'
+  ps1 = "C:\\Powershell\\RunHelloWorld.ps1 -name #{Name}"
+  winrm_run(ps1,host,user,pwrd)
+```
+
+## Notification (NotificationClass)
+
+This Class is used to notify users and log messages accordingly. This Class utilises the `slack-ruby-client` Ruby Gem (version => 0.11.1). 
+
+### Class Method Summary
+
+#### **notify**
+
+_Initiate the process._
+Name   |   Type   | Description
+---- | ---- | ----
+event_level    | String  | info, warn, error
+event_message  | String  | The message to be used
+email_to       | String  | Who to send an email to
+email_from     | String  | Sent from which email address
+from           | String  | From who
+slack_channel  | Boolean | The slcak channel to send the message to
+
+
+##### Method usage
+```
+  require 'miq_utilities'
+  logger = LoggingClass.new('Test NotificationCLass')
+  logger.log('error', 'An error occured!', false, true)
+```
+
+#### Levels
+Level   |  Action
+---- | ---- | ----
+INFO  |   Logs to the $evm log                                                               
+WARN  |   Logs to the $evm log, sends an Email and a Slack message                           
+ERROR  |   Logs to the $evm log, sends an Email, a Slack message and an on-screen notification
+NOTE  |   Sends and on-screen notification (As an info message)            
+
+
+#### **send_email**
+_Sends an email to the specified user using the **$evm.execute** MIQ method_
+Name   |   Type   | Description
+---- | ---- | ----
+message    | String | The message to be used
+subject    | String | The Subject to be used
+to_email   | String | Recipient email
+from_email | String | Sender email
+from       | String | Sent from
+
+##### Method usage
+
+```$xslt
+  require 'miq_utilities'
+  notify = NotificationCLass.new
+  notify.send_email('This is an Email.', 'Test', 'aaron@mycompany.com', 'miq@mycompany.com', 'DevOps')
+```
+
+#### **send_slack_message**
+
+_Sends a Slcak message_
+Name   |   Type   | Description
+---- | ---- | ----
+message    | String | The message to be used
+channel    | String | The channel in which to post the message
+token   | String | The API token used to authenticate
+
+##### Method usage
+
+```$xslt
+  require 'miq_utilities'
+  notify = NotificationCLass.new
+  notify.send_slack_message('This a Slack post!', '#MIQ-CHANNEL', 'token-to-use')
+```
+
+#### **on_screen_message**     
+_on_screen_message  - Sends an on-screen notification_
+Name   |   Type   | Description
+---- | ---- | ----
+level   | String | info, warn, error
+message | String | The message to be used
+subject | String | The Subject to be used
+
+##### Method usage
+
+```$xslt
+  require 'miq_utilities'
+  notify = NotificationCLass.new
+  notify.on_screen_message('info', 'This is an on-screen notification', 'Test')
+```
+
+## Contributing
+
+Currently not in a public repo, but you have the source to change at your will.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "miq_utilities"
+
+# 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(__FILE__)

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/miq_utilities/infoblox.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# .SYNOPSIS
+# This Class utilises the rest-client (version => 1.8.0 x64-mingw32) & json (version => 2.0.4) Ruby Gems
+#
+# Methods Summary:
+#  > Name          > Description/Params
+# process_args   - Process Arguments
+#                 inargs - Hash   : Hash Table of key value pairs of arguments to process i.e. { 'name' => some_fdqn }
+#                 inurl  - String : The url to append to
+#
+# process_extattrs  - Process extra attributes
+#                 inargextattrs - Hash    : Hash table of key value pairs of the extra attributes to process i.e. { 'Country' => 'UK' }
+#                 inurl         - String  : The url to append to
+#                 args          - Boolean : Identifies if arguments were processed, if so an ampersand needs to be appended
+#
+# process_returnfields  - Process return fields
+#                 inurl        - String : The url to append to
+#                 returnfields - String : A string listing the return fields, delimited by commas (CSV)
+#                 args         - Boolean (Default:Flase): Identifies if arguments were processed, if so an ampersand needs to be appended
+#
+# call_infoblox  - Process the inputs and make the API call to infoblox
+#                 action     - String : The Action being preformed i.e. GET, DELETE
+#                 resource   - String : The resource being used i.e. record:host
+#                 ibobj      - Object : Custom object created to hold the extra attributes, arguments and return fields.
+#                                       Examples: * vars are suffixed with @ *
+#  infobloxobj = { 'args' => nil, 'returnfields' => nil, 'argextattrs' => { 'Country' => @ib_cmdb_country, '*VLAN Number' => @ib_cmdb_vlan, '*Site' => @ib_site } } or;
+#  infobloxobj = { 'args' => { 'name' => @ib_fdqn }, 'returnfields' => nil, 'argextattrs' => nil } or;
+#  infobloxobj = { 'args' => { 'name' => @ib_fdqn }, 'returnfields' => 'ipv4addrs', 'argextattrs' => nil }......
+#
+#                 body_type  - String (Default json) : The body type
+#                 body       - String : The body to use in the call, if there is one
+#                 servername - String : The server name to connect to
+#                 username   - String : The username to connect with
+#                 password   - String : The password for the user
+#                 baseurl    - String (Default: https://[SERVERNAME]/wapi/v2.3.1/): the base URL to use
+#
+#
+require 'rest-client'
+require 'json'
+require_relative 'logging.rb'
+
+# Class to interact with Infoblox
+class InfobloxClass
+  private def process_args(inargs, inurl)
+    loops = 1
+    outurl = inurl
+    inargs.each do |key, value|
+      outurl = "#{outurl}#{key}~=#{value}" if loops == inargs.count
+      outurl = "#{outurl}#{key}~=#{value}&" if loops != inargs.count
+      loops += 1
+    end
+    outurl.to_s
+  end
+
+  private def process_extattrs(inargextattrs, inurl, args)
+    loops = 1
+    outurl = if args
+               "#{inurl}&_return_fields%2B=extattrs&*"
+             else
+               "#{inurl}_return_fields%2B=extattrs&*"
+             end
+    inargextattrs.each do |key, value|
+      outurl = "#{outurl}#{key}%3A=#{value}" if loops == inargextattrs.count
+      outurl = "#{outurl}#{key}%3A=#{value}&" if loops != inargextattrs.count
+      loops += 1
+    end
+    outurl.to_s
+  end
+
+  private def process_returnfields(inurl, returnfields, inargs = false)
+    inurl = if inargs
+              "#{inurl}&_return_fields%2B=#{returnfields}"
+            else
+              "#{inurl}_return_fields%2B=#{returnfields}"
+            end
+    inurl
+  end
+
+  def call_infoblox(action, resource, ibobj, body_type = :json, body = nil, servername = nil, username = nil, password = nil, baseurl = 'https://[SERVERNAME]/wapi/v2.3.1/')
+    @logger = LoggingClass.new('Infoblox')
+
+    servername ||= $evm.object['InfobloxServername']
+    username   ||= $evm.object['InfobloxUsername']
+    password   ||= $evm.object.decrypt('InfobloxPassword')
+    baseurl    ||= $evm.object['baseURL'].to_s
+    url        = baseurl.sub('[SERVERNAME]', servername.to_s) + resource.to_s
+    refend     = '&_return_as_object=1'
+    argsfound  = false
+
+    unless ibobj['args'].nil?
+      args = ibobj['args']
+      argsfound = true
+    end
+
+    argextattrs = ibobj['argextattrs'] unless ibobj['argextattrs'].nil?
+    returnfields = ibobj['returnfields'] unless ibobj['returnfields'].nil?
+
+    url = process_args(args, url) if args
+    url = process_returnfields(url, returnfields, argsfound) if returnfields
+    url = process_extattrs(argextattrs, url, argsfound) if argextattrs
+
+    url = if argextattrs || returnfields
+            "#{url}#{refend}"
+          else
+            url
+          end
+
+    @logger.log('info', "URL: \"#{url}\"")
+
+    params = {
+      method: action,
+      url: url,
+      user: username,
+      password: password,
+      verify_ssl: false,
+      headers: { content_type: body_type, accept: :json }
+    }
+
+    if body_type == :json
+      params[:payload] = JSON.generate(body) if body
+      @logger.log('info', "Calling -> Infoblox:<#{url}> action:<#{action}> payload:<#{params[:payload]}>") if body
+    elsif body
+      params[:payload] = body
+    end
+
+    response = RestClient::Request.new(params).execute
+    if response.code == 200 || response.code == 201
+      @logger.log('info', "Success <- Infoblox Response:<#{response.code}>")
+    else
+      err_msg = "Error calling infoblox. <#{response.inspect}>"
+      @logger.log('error', err_msg, false, true)
+    end
+    response
+  end
+end

data/lib/miq_utilities/logging.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+#
+# This Class is used to handle the logging for ManageIQ and an IDE
+#
+# Methods Summary:
+#  > Name               > Description/Params
+# initialize   - Create the connection to the client
+#                 name      - String  : The name of the class/method/instantiator
+#
+# log          - Logs detail in the relevant manner
+#                 level           - String   : info, warn, error
+#                 message         - String   : The message
+#                 logtoscreenonly - Boolean  : Log it to screen only
+#                 notify          - Boolean  : process through the notify class
+#
+require_relative 'notification.rb'
+
+# logging class
+class LoggingClass
+  # initialize class
+  def initialize(name)
+    @initializer = name
+    @notification = NotificationClass.new
+  end
+
+  def log(level, message, logtoscreenonly = false, notify = false)
+    levelvalid = %w[info warn error].any? { |msglevel| level.upcase.include? msglevel.to_s.upcase }
+
+    if $evm.nil? || logtoscreenonly
+      puts "#{level}: #{@initializer} - #{message}"
+    elsif levelvalid
+      $evm.log(level, "#{@initializer} - #{message}")
+    else
+      $evm.log('info', "#{@initializer} - #{message}")
+    end
+
+    # Notify - Only if flag (notify) is set to TRUE
+    @notification.notify(level, message) if notify
+  end
+end

data/lib/miq_utilities/notification.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# .SYNOPSIS
+# This Class utilises the slack-ruby-client Ruby Gem (version => 0.11.1).
+#
+# Methods Summary:
+#  > Name                   > Description/Params
+# notify             - based on the params passed, process through and notify in the appropriate ways
+#                     event_level    - String  : info, warn, error
+#                     event_message  - String  : The message to be used
+#                     email_to       - String  : Who to send an email to
+#                     email_from     - String  : Sent from which email address
+#                     from           - String  : From who
+#                     slack_channel  - Boolean : The slcak channel to send the message to
+#
+# send_email         - Sends an email to the specified user
+#                     message    - String : The message to be used
+#                     subject    - String : The Subject to be used
+#                     to_email   - String : Recipient email
+#                     from_email - String : Sender email
+#                     from       - String : Sent from
+#
+# send_slack_message - Sends a Slcak message
+#                     message - String : The message to be used
+#                     channel - String : The channel in which to post the message
+#                     token   - String : The API token used to authenticate
+#
+# on_screen_message  - Sends an on-screen notification
+#                     level   - String : info, warn, error
+#                     message - String : The message to be used
+#                     subject - String : The Subject to be used
+# WIP
+require 'slack-ruby-client'
+
+# notification class
+class NotificationClass
+
+  def notify(event_level, event_message, email_to = nil, email_from = nil, from = nil, slack_channel = nil)
+    case event_level.upcase
+    when %w[WARN WARNING]
+      send_email(event_message, 'Warning Identified', email_to, email_from, from)
+      send_slack_message(event_message, slack_channel)
+    when %w[ERR ERROR]
+      send_email(event_message, 'Error Identified', email_to, email_from, from)
+      send_slack_message(event_message, slack_channel)
+      on_screen_message(event_level, event_message)
+    when 'NOTE'
+      on_screen_message(event_level, event_message)
+    end
+  rescue => err
+    raise("Oopps! Something went wrong trying to notify. Error:<#{err}>")
+  end
+
+  def send_email(message, subject, to_email = nil, from_email, from)
+    # Look in the current object for a VM
+    vm = $evm.object['vm']
+    if vm.nil?
+      vm_id = $evm.object['vm_id'].to_i
+      vm = $evm.vmdb('vm', vm_id) unless vm_id.zero?
+    end
+
+    # Look in the Root Object for a VM
+    if vm.nil?
+      vm = $evm.root['vm']
+      if vm.nil?
+        vm_id = $evm.root['vm_id'].to_i
+        vm = $evm.vmdb('vm', vm_id) unless vm_id.zero?
+      end
+    end
+
+    # Look in the Root Object for a Provision/Request
+    prov = $evm.root['miq_provision_request'] || $evm.root['miq_provision']
+    vm = prov.vm if prov && vm.nil?
+
+    raise 'VM details not found!' if vm.nil?
+
+    # Look at the Event Type in the Current Object or in the Root Object
+    event_type = $evm.object['event'] || $evm.root['event_type']
+
+    # Get VM Owner Name and Email
+    evm_owner_id = vm.attributes['evm_owner_id']
+    owner = nil
+    owner = $evm.vmdb('user', evm_owner_id) unless evm_owner_id.nil?
+
+    # to_email_address from owner.email then from model if nil
+    to = if owner
+           owner.email.to_s.strip
+         else
+           $evm.object['to_email_address'].to_s.strip
+         end
+
+    to ||= to_email unless to_email.nil?
+
+    subject += " - #{event_type}"
+    body = 'Hello, '
+    body += message
+    body += 'Thank you,'
+    body += from
+
+    $evm.execute(:send_email, to, from_email, subject, body)
+  rescue => err
+    raise("Oopps! Something went wrong trying to send an email to:<#{to}>. Error:<#{err}>")
+  end
+
+  # TBD - awaiting webhook setup
+  def send_slack_message(message, channel, token = nil)
+    # https://github.com/slack-ruby/slack-ruby-client - install required
+    if token.nil?
+      Slack.configure do |config|
+        config.token = ENV['SLACK_API_TOKEN']
+        raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+      end
+    else
+      config.token = token
+    end
+
+    begin
+      client = Slack::Web::Client.new
+      client.auth_test
+      client.chat_postMessage(channel: channel, text: message, as_user: true)
+    rescue => err
+      raise("Oopps! Something went wrong trying to send a Slack notification. Error:<#{err}>")
+    end
+  end
+
+  def on_screen_message(level, message, subject = nil)
+    if subject.nil?
+      vm = $evm.root['vm']
+      prov = $evm.root['miq_provision']
+      subject ||= vm unless vm.nil?
+      subject ||= prov.miq_request unless prov.miq_request.nil?
+    end
+
+    levelvalid = %w[info warn error].any? { |msglevel| level.upcase.include? msglevel.to_s.upcase }
+    level = 'info' unless levelvalid
+
+    begin
+      $evm.create_notification(level: level, subject: subject, message: message)
+    rescue => err
+      raise("Oopps! Something went wrong trying to display on-screen notification. Error:<#{err}>")
+    end
+  end
+end

data/lib/miq_utilities/sql.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# .SYNOPSIS
+# This Class utilises the tiny_tds Ruby Gem (version => 2.1.0).
+#
+# Methods Summary:
+#  > Name                   > Description/Params
+# initialize       - Create the connection to the client
+#                     user      - String  : Username
+#                     password  - String  : Password
+#                     host      - String  : The host name to connect to
+#                     port      - String  : The port to use, default (nil) 1433
+#                     database  - String  : The database name to connect to
+#                     azure     - Boolean : Set to true when connecting to Azure
+#
+# get_client       - returns the client to utilise the tiny_tds functionality
+#
+# run_sql_query    - runs the specified sql query against the client when the class was instantiated
+#                     sql       - String  : Sql query to be run
+#
+# close_connection - closes the connection to the client
+#
+require 'tiny_tds'
+
+# Sql class
+class SqlClass
+  # Initialize Class
+  def initialize(user, password, host, port = nil, database, azure)
+    # Logging
+    @logger = LoggingClass.new('SQL')
+
+    # Default port
+    unless port.nil? || port.empty?
+      @logger.log('info', 'Using default port 1433')
+      port = '1433'
+    end
+
+    # Get connection to client
+    client = TinyTds::Client.new(username: user,
+                                 password: password,
+                                 host: host,
+                                 port: port,
+                                 database: database,
+                                 azure: azure)
+    @client = client
+  end
+
+  # Return Client object
+  def return_client
+    @client
+  end
+
+  # Run Sql query
+  def run_sql_query(sql)
+    if @client.nil?
+      @logger.log('warn', 'SQL Server Connection Not Established! Query hasn\'t been run!')
+    else
+      @client.execute(sql)
+    end
+  end
+
+  # Close the connection to the sql client
+  def close_connection
+    @client.close unless @client.closed?
+    @logger.log('info', 'Connection to SQL Client Closed Successfully.') if @client.closed?
+  end
+end

data/lib/miq_utilities/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MiqUtilities
+  VERSION = '0.2.1'
+end

data/lib/miq_utilities/vmware.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+#
+# This Class is used to handle some of the heavily used VMWare utilities
+#
+# Methods Summary:
+#  > Name               > Description/Params
+# initialize   - Assign the host name
+#                 host_name      - String  : The name of the host being utilised
+#
+# get_vsphere_connection  - returns the client connection
+#                 user       - String  : The user to connect with
+#                 password   - String  : The users password
+#
+# get_data_center   - returns the datacenter based on the connection and datacenter
+#                 vsphereconn  - connection  : The return of "get_vsphere_connection"
+#                 dcname       - String      : The name of the datacenter
+#
+require 'rbvmomi'
+
+# vmware wrapper class
+class VmwareClass
+  def initialize(host_name)
+    @host_name = host_name
+  end
+
+  def get_vsphere_connection(user, password)
+    @connection = RbVmomi::VIM.connect(host: @host_name, user: user, password: password, insecure: true)
+    @connection
+  end
+
+  def retrieve_data_center
+    @connection.serviceInstance.find_datacenter || raise('Datacenter not found!') unless @connection.nil?
+    raise("No connection established!\nUse the \"get_vsphere_connection\" method to connect.") if @connection.nil?
+  end
+
+  def find_vm(dc, name)
+    vm = {}
+    dc.datastoreFolder.childEntity.collect do |datastore|
+      vm[:instance] = datastore.vm.find { |x| x.name == name }
+      if vm[:instance]
+        vm[:datastore] = datastore.name
+        break
+      end
+    end
+    vm
+  end
+
+  def upg_tools(vm)
+    instopts = if vm[:instance][:guest][:guestFamily] == 'windowsGuest'
+                 '/s /v "/qn REBOOT=ReallySuppress"'
+               end
+    vm[:instance].UpgradeTools_Task(installerOptions: instopts).wait_for_completion
+  end
+end

data/lib/miq_utilities/winrm.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# .SYNOPSIS
+# This Class utilises the winrm Ruby Gem (version => 2.2.3) and is used to handle the running of powershell scripts using winrm
+#
+# Methods Summary:
+#  > Name          > Description/Params
+# winrm_run      - Run a specified PowerShell script
+#           ps_script    - String  : The name of the script to run (including path to the file)
+#           host         - String  : The name of the host to connect to
+#           user         - String  : The user to connect with
+#           password     - String  : The users password
+#
+require 'winrm'
+require 'logging.rb'
+
+# WinRM class
+class WinrmClass
+  def winrm_run(ps_script, host, user, password)
+    @logger = LoggingClass.new('WinRM')
+    value = ''
+    ps1 = <<~PS_SCRIPT
+      #{ps_script}
+    PS_SCRIPT
+
+    opts = {
+      endpoint: "http://#{host}:5985/wsman",
+      user: user.to_s,
+      password: password.to_s
+    }
+
+    conn = WinRM::Connection.new(opts)
+
+    @logger.log('info', "WinRM is connecting to #{opts[:endpoint]}")
+    msg = ps1.to_s.gsub(password.to_s, '****')
+    @logger.log('info', "Running PowerShell script: #{msg}")
+
+    conn.shell(:powershell) do |shell|
+      err = ''
+      output = shell.run(ps1) do |stdout, stderr|
+        value = stdout
+        err = stderr
+      end
+      if output.exitcode.zero?
+        @logger.log('info', "PS script finished with exit code #{output.exitcode} - Output: <#{value.to_s.strip}>")
+      else
+        @logger.log('error', "PS script failed with exit code #{output.exitcode} and error message #{err}. STDOUT: #{value.to_s.strip}")
+      end
+    end
+    value.to_s.strip
+  end
+end

data/lib/miq_utilities.rb

@@ -0,0 +1,10 @@
+
+module MiqUtilities
+  require_relative 'miq_utilities/version'
+  require_relative 'miq_utilities/infoblox.rb'
+  require_relative 'miq_utilities/logging.rb'
+  require_relative 'miq_utilities/notification.rb'
+  require_relative 'miq_utilities/sql.rb'
+  require_relative 'miq_utilities/winrm.rb'
+  require_relative 'miq_utilities/vmware.rb'
+end

data/miq_utilities.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "miq_utilities/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "miq_utilities"
+  spec.version       = MiqUtilities::VERSION
+  spec.authors       = ["Aaron McCatty"]
+  spec.email         = ["aaronmccatty@hotmail.co.uk"]
+
+  spec.summary       = %q{Commonly used utilities in ManageIQ/Cloudforms }
+  spec.description   = %q{ This Gem was written to hold utilities commonly used within ManageIQ/Cloudforms. }
+  spec.license       = "MIT"
+  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.homepage = 'http://www.rubydoc.info/gems/miq_utilities'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "tiny_tds", "~> 2.1"
+  spec.add_development_dependency "rbvmomi", "~> 1.11"
+  spec.add_development_dependency "winrm", "~> 2.2"
+  spec.add_development_dependency "rest-client", "~>1.8"
+  spec.add_development_dependency "json", "~> 2.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: miq_utilities
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Aaron McCatty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: tiny_tds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rbvmomi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: " This Gem was written to hold utilities commonly used within ManageIQ/Cloudforms. "
+email:
+- aaronmccatty@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/miq_utilities.rb
+- lib/miq_utilities/infoblox.rb
+- lib/miq_utilities/logging.rb
+- lib/miq_utilities/notification.rb
+- lib/miq_utilities/sql.rb
+- lib/miq_utilities/version.rb
+- lib/miq_utilities/vmware.rb
+- lib/miq_utilities/winrm.rb
+- miq_utilities.gemspec
+homepage: http://www.rubydoc.info/gems/miq_utilities
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Commonly used utilities in ManageIQ/Cloudforms
+test_files: []