miq_utilities 0.2.2.pre.WIP → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d184df965af6a4f25ce41107b533b610e98943acabbd7eb1b4f32950132d69c
-  data.tar.gz: 11a0ac88b95da23a66e840535b77b89e4c0a115504befb5d5a2470ab1622de2d
+  metadata.gz: b2b19bb0fcf6f8850ddd88cb84f111b7f638b2b2caa8947d2dbd8ca0d0ea4384
+  data.tar.gz: 0ca998eb10a330141f7b21d50d9310276c7b002d6fc2f5fe9961577406620502
 SHA512:
-  metadata.gz: b2e790149e8b0acafee2a5ea18b8ef7cea2e207cb7d9b6c3de30e24c95e0b5192dd666a6455dbe5c6dc1de4c4ad46974b783c60ba7fbb61e85a595e7cda65aef
-  data.tar.gz: be9bd063f97a37796fd79b542fec1ba297e8629f29efdaa96411725e1f40139d8a6ac0bfedef0965c71cf75ec2fc620e1ab9736b453e429def5c2347988958a3
+  metadata.gz: a1a4dafef4451c2224f9645abfb58064cf6a825449ef45f218c0806de8707bc3e41f7d4f29646b70f6324db73f05be12f22d0d78f7745217fc191ec6b7bb1eea
+  data.tar.gz: e5a4b01286f9d45a6e6b8bba0c26ea9d4abe1984a98170d247a39146678135cb8202b9e97f0907afbc7710649b2b1f2ba07ba5d22775211f8a63445bd4bdfd09

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,27 +1,41 @@
 PATH
   remote: .
   specs:
-    miq_utilities (0.2.2.pre.WIP)
+    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)
@@ -31,7 +45,9 @@ GEM
       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)
@@ -48,9 +64,18 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     rubyntlm (0.6.2)
-    slack-notifier (2.3.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)
@@ -79,7 +104,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rbvmomi
   rest-client
-  slack-notifier
+  slack-ruby-client
   tiny_tds
   winrm
 

data/README.md

@@ -2,7 +2,7 @@
 
 ## Installation
 
-     $ bundle install 
+     $ gem install miq_utilities
      
 ## Usage
 
@@ -15,7 +15,7 @@
 3. rbvmomi ~> 1.11.3
 4. tiny_tds ~> 2.1.0
 5. winrm ~> 2.2.3
-6. slack-notifier ~> 2.3.2
+6. slack-ruby-client ~> 0.11.1
 7. rest-client ~> 1.8.0 x64-mingw32
 8. json ~> 2.0.4
 
@@ -214,7 +214,7 @@ password  ¦ String  ¦ The users password
 
 ## Notification (NotificationClass)
 
-This Class is used to notify users and log messages accordingly. This Class utilises the slack-notifier Ruby Gem (version => 2.3.2). 
+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
 
@@ -229,8 +229,8 @@ 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
-signature     ¦ String  ¦ Who the emails from
-webhookURL    ¦ String  ¦ The webhook to be used
+from          ¦ String  ¦ From who
+slack_channel ¦ Boolean ¦ The slcak channel to send the message to
 ```
 
 ##### Method usage
@@ -240,7 +240,7 @@ webhookURL    ¦ String  ¦ The webhook to be used
   logger.log('error', 'An error occured!', false, true)
 ```
 
-#### Levels (event_level)
+#### Levels
 ```
 Level | Action
 ----------------------------------------------------------------------------------------------
@@ -260,7 +260,7 @@ message    ¦ String ¦ The message to be used
 subject    ¦ String ¦ The Subject to be used
 to_email   ¦ String ¦ Recipient email
 from_email ¦ String ¦ Sender email
-signature  ¦ String ¦ Who the emails from
+from       ¦ String ¦ Sent from
 ```
 ##### Method usage
 
@@ -275,10 +275,11 @@ signature  ¦ String ¦ Who the emails from
 _Sends a Slcak message_
 ##### Parameters
 ```
-Name       | Type    | Description
+Name    | Type    | Description
 --------------------------------------------------------------
-message    ¦ String  ¦ The message to be used
-webhookURL ¦ String  ¦ The webhook to be used
+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
@@ -286,7 +287,7 @@ webhookURL ¦ String  ¦ The webhook to be used
 ```$xslt
   require 'miq_utilities'
   notify = NotificationCLass.new
-  notify.send_slack_message('This a Slack post!', 'https://hooks.slack.com/services/token')
+  notify.send_slack_message('This a Slack post!', '#MIQ-CHANNEL', 'token-to-use')
 ```
 
 #### **on_screen_message**     

data/lib/miq_utilities/infoblox.rb

@@ -133,4 +133,4 @@ class InfobloxClass
     end
     response
   end
-end
+end

data/lib/miq_utilities/notification.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # .SYNOPSIS
-# This Class utilises the slack-notifier Ruby Gem (version => 2.3.2).
+# This Class utilises the slack-ruby-client Ruby Gem (version => 0.11.1).
 #
 # Methods Summary:
 #  > Name                   > Description/Params
@@ -10,37 +10,39 @@
 #                     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
-#                     signature      - String  : Who the emails from
-#                     webhookurl     - String  : The slcak channel to send the message to
+#                     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
-#                     from_email - String : Sender email
-#                     signature  - String : Who the emails from
 #                     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
-#                     webhookurl - String : The webhook to be used
+#                     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-notifier'
+require 'slack-ruby-client'
 
 # notification class
 class NotificationClass
-  def notify(event_level, event_message, email_to = nil, email_from = nil, signature = nil, webhookurl = nil)
+
+  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_from, signature, email_to)
-      send_slack_message(event_message, webhookurl)
+      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_from, signature, email_to)
-      send_slack_message(event_message, webhookurl)
+      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)
@@ -49,7 +51,7 @@ class NotificationClass
     raise("Oopps! Something went wrong trying to notify. Error:<#{err}>")
   end
 
-  def send_email(message, subject, from_email, signature, to_email = nil)
+  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?
@@ -93,7 +95,7 @@ class NotificationClass
     body = 'Hello, '
     body += message
     body += 'Thank you,'
-    body += signature
+    body += from
 
     $evm.execute(:send_email, to, from_email, subject, body)
   rescue => err
@@ -101,11 +103,24 @@ class NotificationClass
   end
 
   # TBD - awaiting webhook setup
-  def send_slack_message(message, webhookurl)
-    notifier = Slack::Notifier.new webhookurl
-    notifier.ping message
-  rescue => err
-    raise("Oopps! Something went wrong trying to send a Slack notification. Error:<#{err}>")
+  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)

data/lib/miq_utilities/sql.rb

@@ -9,9 +9,9 @@
 #                     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
-#                     port      - String  : The port to use, default (nil) 1433
 #
 # get_client       - returns the client to utilise the tiny_tds functionality
 #
@@ -25,7 +25,7 @@ require 'tiny_tds'
 # Sql class
 class SqlClass
   # Initialize Class
-  def initialize(user, password, host, database, azure, port = nil)
+  def initialize(user, password, host, port = nil, database, azure)
     # Logging
     @logger = LoggingClass.new('SQL')
 

data/lib/miq_utilities/version.rb

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

data/lib/miq_utilities/vmware.rb

@@ -12,12 +12,10 @@
 #                 user       - String  : The user to connect with
 #                 password   - String  : The users password
 #
-# retrieve_data_center   - returns the datacenter based on the connection and datacenter
+# 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
 #
-#
-# find_vm                - Get the VM details from vmware
-#                 datacenter  - String  : datacenter name returned from retrieve_data_center
-#                 vmname      - String  : The vmname
 require 'rbvmomi'
 
 # vmware wrapper class
@@ -36,10 +34,10 @@ class VmwareClass
     raise("No connection established!\nUse the \"get_vsphere_connection\" method to connect.") if @connection.nil?
   end
 
-  def find_vm(datacenter, vmname)
+  def find_vm(dc, name)
     vm = {}
-    datacenter.datastoreFolder.childEntity.collect do |datastore|
-      vm[:instance] = datastore.vm.find { |x| x.name == vmname }
+    dc.datastoreFolder.childEntity.collect do |datastore|
+      vm[:instance] = datastore.vm.find { |x| x.name == name }
       if vm[:instance]
         vm[:datastore] = datastore.name
         break
@@ -48,10 +46,10 @@ class VmwareClass
     vm
   end
 
-  def upg_tools(vmobj)
-    instopts = if vmobj[:instance][:guest][:guestFamily] == 'windowsGuest'
+  def upg_tools(vm)
+    instopts = if vm[:instance][:guest][:guestFamily] == 'windowsGuest'
                  '/s /v "/qn REBOOT=ReallySuppress"'
                end
-    vmobj[:instance].UpgradeTools_Task(installerOptions: instopts).wait_for_completion
+    vm[:instance].UpgradeTools_Task(installerOptions: instopts).wait_for_completion
   end
 end

data/lib/miq_utilities.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
 
-# Module to include resources
 module MiqUtilities
   require_relative 'miq_utilities/version'
   require_relative 'miq_utilities/infoblox.rb'

data/miq_utilities.gemspec

@@ -28,5 +28,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "winrm", "~> 2.2"
   spec.add_development_dependency "rest-client", "~>1.8"
   spec.add_development_dependency "json", "~> 2.0"
-  spec.add_development_dependency "slack-notifier", "~> 2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miq_utilities
 version: !ruby/object:Gem::Version
-  version: 0.2.2.pre.WIP
+  version: 0.2.2
 platform: ruby
 authors:
 - Aaron McCatty
@@ -108,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: slack-notifier
-  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'
 description: " This Gem was written to hold utilities commonly used within ManageIQ/Cloudforms. "
 email:
 - aaronmccatty@hotmail.co.uk
@@ -130,7 +116,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -162,9 +147,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/.rubocop.yml

@@ -1,29 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.4
-  Exclude:
-    - vendor/**/*
-    - Guardfile
-
-ClassLength:
-  Enabled: false
-CyclomaticComplexity:
-  Enabled: false
-GlobalVars:
-  AllowedVariables:
-    - $evm
-LineLength:
-  Enabled: false
-MethodLength:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/LineLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-Metrics/ParameterLists:
-  Enabled: false
-Style/RescueStandardError:
-  Enabled: false