miq_dev_util 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b23d75b67044ef97db93725264cbdacdd4eaf5f9
+  data.tar.gz: 6ba5859a40cab3b6378ef6622f3c570bb5833cd3
+SHA512:
+  metadata.gz: f90fe8f16a8e3973c904af770d495d0f8a6e4ca353d27c7320789c46a06e4b09896097d92186afc4726b95bd638631b87dd32611032bd45fa73f0c287a411f53
+  data.tar.gz: f6a08f6822e0709994576b47fb459248de002d7ba7b53a2eb5825d74656519b45ac49a30df50516352d2e7f05fcc9e6ee96229c299930ca55d12515e14111cfb

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in miq_dev_util.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eric Wannemacher
+
+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,29 @@
+# MiqDevUtil
+
+This is a set of helper classes to make developing in the ManageIQ automate
+model less cumbersome. By putting helper code and commonly used methods in this
+gem we can reduce the amount of code copied and pasted between methods.
+
+## Installation
+
+    $ gem install miq_dev_util
+
+## Usage
+
+    require 'miq_dev_util'
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ewannema/miq_dev_util.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "miq_dev_util"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/miq_dev_util/automate.rb

@@ -0,0 +1,34 @@
+# The Automate class is intended to hold methods that are useful when
+# interacting with the ManageIQ automate system directly.
+
+class MiqDevUtil::Automate
+
+  def initialize(evm)
+    @evm = evm
+  end
+
+  # Instantiate an automate instance at path or raise an exception with the
+  # message provided if the instantiation returns nil (not found).
+  def instantiate_or_raise(path, message)
+    object = @evm.instantiate(path)
+    if object.nil?
+      raise message
+    end
+
+    object
+  end
+
+  # This is a hacky workaround used to get an instance without executing the
+  # methods on it. It fails if a message is passed in the path or if the
+  # message field on the any of the methods are *.
+  def get_instance_with_attributes(path)
+    if path =~ /#/
+      raise "Does not work with messages in the path."
+    end
+    fake_message = "callingWithAFakeMessage"
+    empty_instance = @evm.instantiate("#{path}##{fake_message}")
+    instance_name = empty_instance.name
+    @evm.instance_get(instance_name)
+  end
+end
+

data/lib/miq_dev_util/code.rb

@@ -0,0 +1,10 @@
+# The Code class is a container for miscellaneous methods that a developer may
+# find useful. The focus is on standard Ruby oriented tasks that could apply
+# outside of the ManageIQ environment.
+
+class MiqDevUtil::Code
+  # Perform a deep copy on objects that support marshalling.
+  def deep_copy(o)
+    Marshal.load(Marshal.dump(o))
+  end
+end

data/lib/miq_dev_util/ems.rb

@@ -0,0 +1,20 @@
+# The External Management System (EMS) class holds methods that apply to EMS
+# objects in ManageIQ.
+
+class MiqDevUtil::EMS
+  # Return a hash containing the attributes that are commonly used to connect
+  # directly to the EMS.
+  # * :host
+  # * :user
+  # * :password
+  # * :insecure
+  def self.get_credentials(ems, insecure=true)
+    {
+      host: ems['hostname'],
+      user: ems.authentication_userid,
+      password: ems.authentication_password,
+      insecure: insecure
+    }
+  end
+end
+

data/lib/miq_dev_util/logger.rb

@@ -0,0 +1,66 @@
+# A utility class to write information to the ManageIQ logs.
+
+class MiqDevUtil::Logger
+  def initialize(evm, method_name)
+    @evm = evm
+    @method_name = method_name
+    @dump_log_level = :info
+  end
+
+  # Write message to the logging system with the given logging level.
+  def log(level, message)
+    @evm.log(level, "#{@_method_name} - #{message}")
+  end
+
+  # Write the attributes of the given object to the log with a prefix of
+  # my_object_name to make finding the entries a little easier.
+  def dump_attributes(my_object, my_object_name)
+    if my_object.respond_to?("attributes")
+      self.log(@dump_log_level, "Begin #{my_object_name}.attributes")
+      my_object.attributes.sort.each { |k, v| $evm.log(:info, "#{my_object_name} Attribute - #{k}: #{v}")}
+      self.log(@dump_log_level, "End #{my_object_name}.attributes")
+      self.log(@dump_log_level, "")
+    else
+      self.log(@dump_log_level, "No attributes for #{my_object_name}")
+    end
+  end
+
+  # Write the associations of the given object to the log with a prefix of
+  # my_object_name to make finding the entries a little easier.
+  def dump_associations(my_object, my_object_name)
+    if my_object.respond_to?("associations")
+      self.log(@dump_log_level, "Begin #{my_object_name}.associations")
+      my_object.associations.sort.each { |a| $evm.log(:info, "#{my_object_name} Association - #{a}")}
+      self.log(@dump_log_level, "End #{my_object_name}.associations")
+      self.log(@dump_log_level, "")
+    else
+      self.log(@dump_log_level, "No associations for #{my_object_name}")
+    end
+  end
+
+  # Write the virtual columns of the given object to the log with a prefix of
+  # my_object_name to make finding the entries a little easier.
+  def dump_virtual_columns(my_object, my_object_name)
+    if my_object.respond_to?("virtual_columns")
+      self.log(@dump_log_level, "Begin #{my_object_name}.virtual_columns")
+      my_object.virtual_column_names.sort.each { |vcn| $evm.log(:info, "#{my_object_name} Virtual Column - #{vcn}")}
+      self.log(@dump_log_level, "End #{my_object_name}.virtual_columns")
+      self.log(@dump_log_level, "")
+    else
+      log(@dump_log_level, "No virtual_columns for #{my_object_name}")
+    end
+  end
+
+  # A shortcut for dumping multiple types of information about the given object.
+  def dump_info(my_object, my_object_name)
+    self.dump_attributes(my_object, my_object_name)
+    self.dump_associations(my_object, my_object_name)
+    self.dump_virtual_columns(my_object, my_object_name)
+  end
+
+  # A shortcut to dump the $evm.root object.
+  def dump_root()
+    self.dump_info(@evm.root, "$evm.root")
+  end
+end
+

data/lib/miq_dev_util/version.rb

@@ -0,0 +1,3 @@
+module MiqDevUtil
+  VERSION = "0.1.0"
+end

data/lib/miq_dev_util.rb

@@ -0,0 +1,8 @@
+require "miq_dev_util/version"
+
+module MiqDevUtil
+  require 'miq_dev_util/automate'
+  require 'miq_dev_util/ems'
+  require 'miq_dev_util/logger'
+  require 'miq_dev_util/code'
+end

data/miq_dev_util.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'miq_dev_util/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "miq_dev_util"
+  spec.version       = MiqDevUtil::VERSION
+  spec.authors       = ["Eric Wannemacher"]
+  spec.email         = ["eric@wannemacher.us"]
+
+  spec.summary       = %q{A set of helper classes to make ManageIQ automate
+    development easier and to try and eliminate copy and paste of commonly
+    used code.}
+  spec.homepage      = "https://github.com/ewannema/miq_dev_util"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: miq_dev_util
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Wannemacher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eric@wannemacher.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/miq_dev_util.rb
+- lib/miq_dev_util/automate.rb
+- lib/miq_dev_util/code.rb
+- lib/miq_dev_util/ems.rb
+- lib/miq_dev_util/logger.rb
+- lib/miq_dev_util/version.rb
+- miq_dev_util.gemspec
+homepage: https://github.com/ewannema/miq_dev_util
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A set of helper classes to make ManageIQ automate development easier and
+  to try and eliminate copy and paste of commonly used code.
+test_files: []