wmi-lite 1.0.0.rc.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTNmZWM2YTNkNDc3MDljMDM0YTc1ZGY1YzU2MTUwOTE4ZWIwYTA2Yw==
+  data.tar.gz: !binary |-
+    YzZiOTUyMzJlMDAwOWExZDRkZGMzOGRkOGU4YTFiNWUwYWQ0OTc0YQ==
+SHA512:
+  metadata.gz: !binary |-
+    N2NiNzRkMzAyYzBiOWEwMzU5OTAyNzU1ODZjYWQxZDExMWVkYzczYjY3NjI5
+    ZWQ3YjFhNjUwNmVkODVmZDUwYmE5ODNjN2I5YTc1MjNmOGJhYTg0ZTZiOGNh
+    MjY0NjJkZjkwOGM1YTEzYmZiOWU0NWVjYjJjZWYzNjQ5ZmM5ZmI=
+  data.tar.gz: !binary |-
+    ZWQ1YTVhMzQ3OGI2Y2Q5YmQ5NThiMGY2N2M2ZTgzMDBkMzA5ZDIyZmZkYzg0
+    YjVmOGFlYjg4YjI4ZWQxOWRkZDY2NTY1MWY4NTVhZjQ1ZDgxOWViNjUwZWVi
+    ZmNmNDY3MDBlNzE0YTMwNDg3NDBiYzJlNjlhNjhlMmYxNDc2Zjg=

data/.gitignore

@@ -0,0 +1,27 @@
+.autotest
+coverage
+.DS_Store
+pkg
+*/tags
+*~
+
+# you should check in your Gemfile.lock in applications, and not in gems
+Gemfile.lock
+Gemfile.local
+
+# Do not check in the .bundle directory, or any of the files inside it. Those files are specific to each particular machine, and are used to persist installation options between runs of the bundle install command.
+.bundle
+
+# ignore some common Bundler 'binstubs' directory names
+# http://gembundler.com/man/bundle-exec.1.html
+b/
+binstubs/
+
+# RVM and RBENV ruby version files
+.rbenv-version
+.rvmrc
+
+# Documentation
+_site/*
+.yardoc/
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-fs

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+bundler_args: --jobs 7
+
+script: bundle exec rspec --color --format progress

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# WMI-Lite  Change Log
+
+## Unreleased
+* Initial implementation
+
+Last Release: v1.0.0 (2014-05-15)
+-------------------
+- First public release
+
+
+

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing to WMI-Lite
+
+We are glad you want to contribute to WMI-Lite. Please see contribution guidelines for
+[Chef](http://wiki.opscode.com/display/chef/How+to+Contribute) for information on contributing to this project.
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,111 @@
+Wmi-Lite
+========
+
+`wmi-lite` is a lightweight Ruby gem utility library for accessing basic
+[Windows Management Instrumentation (WMI)](http://msdn.microsoft.com/en-us/library/aa394582(v=vs.85).aspx)
+functionality on Windows. It has no dependencies other than version 1.9 or greater of the Ruby interpreter
+and libraries and of course the Windows operating system.
+
+Installation
+------------
+
+To install it, run:
+
+    gem install wmi-lite
+
+Usage
+-----
+To use `wmi-lite` in your Ruby source code, just `require` it:
+
+```ruby
+require 'wmi-lite'
+```
+
+You can then instantiate an object through `WmiLite::Wmi.new` that will allow you to query a WMI namespace by calling methods on
+that object.
+
+* The default namespace if no argument is specified to `new` is `root\cimv2`. To override, pass the desired WMI
+  namespace string as an argument to the constructor.
+* To execute queries against the object's namespace, use the `instances_of`, `first_of`, and `query` methods.
+* The `instances_of` method will return all instances of a given class in the namespace as an array of instances.
+* The `query` method returns the results of an arbitrary WMI Query Language (WQL) query as an array of instances.
+* The `first_of` method will return the first of all instances of a given class in the namespace.
+* Each instance is represented by a Ruby `Hash` for which each property value of the instance is indexed by
+  the string name of the property as documented in the [WMI Schema](http://technet.microsoft.com/en-us/library/cc180287.aspx) or
+  as registered in the local system's WMI repository.
+* The string name specified to the aformentioned `Hash` is case insensitive.
+
+#### Examples
+Use of the `instances_of`, `query`, and `first_of` methods of the `WmiLite::Wmi` object is demonstrated below.
+
+##### Count cores in the system
+
+```ruby
+cores = 0
+wmi = WmiLite::Wmi.new
+processors = wmi.instances_of('Win32_Processor')
+processors.each do | processor |
+  cores += processor['numberofcores']
+end
+puts "\nThis system has #{cores} core(s).\n"
+```
+
+##### Determine if the system is domain-joined
+
+```ruby
+wmi = WmiLite::Wmi.new
+computer_system = wmi.first_of('Win32_ComputerSystem')
+is_in_domain = computer_system['partofdomain']
+puts "\nThis system is #{is_in_domain ? '' : 'not '}domain joined.\n"
+```
+
+##### List Group Policy Objects (GPOs) applied to the system
+
+```ruby
+wmi = WmiLite::Wmi.new('root\rsop\computer')
+gpos = wmi.instances_of('RSOP_GPO')
+puts "\n#{'GPO Id'.ljust(40)}\tName"
+puts "#{'------'.ljust(40)}\t----\n"
+gpos.each do | gpo |
+  gpo_id = gpo['guidname']
+  gpo_display_name = gpo['name']
+  puts "#{gpo_id.ljust(40)}\t#{gpo_display_name}"
+end
+puts 'No GPOs' if gpos.count == 0
+puts
+```
+
+##### List ruby-related processes
+```ruby
+puts "Ruby processes:\n"
+wmi = WmiLite::Wmi.new
+processes = wmi.query('select * from Win32_Process where Name LIKE \'%ruby%\'')
+puts "\n#{'Process Id'.ljust(10)} Name"
+puts "#{'----------'.ljust(10)} ----\n"
+processes.each do | process |
+  pid = process['processid']
+  name = process['name']
+  puts "#{pid.to_s.ljust(10)} #{name}"
+end
+puts
+```
+
+License & Authors
+-----------------
+
+Author:: Adam Edwards (<adamed@getchef.com>)
+Copyright:: Copyright (c) 2014 Chef Software, Inc.
+License:: Apache License, Version 2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/wmi-lite.rb

@@ -0,0 +1,20 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+# Copyright:: Copyright 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'wmi-lite/wmi'
+

data/lib/wmi-lite/version.rb

@@ -0,0 +1,3 @@
+module WmiLite
+  VERSION = '1.0.0.rc.0'
+end

data/lib/wmi-lite/wmi.rb

@@ -0,0 +1,97 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+# Copyright:: Copyright 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'win32ole' if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+require 'wmi-lite/wmi_instance'
+require 'wmi-lite/wmi_exception'
+
+module WmiLite
+  class Wmi
+    def initialize(namespace = nil)
+      @namespace = namespace.nil? ? 'root/cimv2' : namespace
+      @connection = nil
+    end
+
+    def query(wql_query)
+      query_with_context(wql_query)
+    end
+
+    def instances_of(wmi_class)
+      query_with_context("select * from #{wmi_class}", wmi_class)
+    end
+
+    def first_of(wmi_class)
+      query_result = start_query("select * from #{wmi_class}", wmi_class)
+      first_result = nil
+      query_result.each do | record |
+        first_result = record
+        break
+      end
+      first_result.nil? ? nil : wmi_result_to_snapshot(first_result)
+    end
+
+    private
+
+    def query_with_context(wql_query, diagnostic_class_name = nil)
+      results = start_query(wql_query, diagnostic_class_name)
+
+      result_set = []
+
+      results.each do | result |
+        result_set.push(wmi_result_to_snapshot(result))
+      end
+
+      result_set
+    end
+
+    def start_query(wql_query, diagnostic_class_name = nil)
+      result = nil
+      connect_to_namespace
+      begin
+        result = @connection.ExecQuery(wql_query)
+        raise_if_failed(result)
+      rescue WIN32OLERuntimeError => native_exception
+        raise WmiException.new(native_exception, :ExecQuery, @namespace, wql_query, diagnostic_class_name)
+      end
+      result
+    end
+
+    def raise_if_failed(result)
+      # Attempting to access the count property of the underlying
+      # COM (OLE) object will trigger an exception if the query
+      # was unsuccessful.
+      result.count
+    end
+
+    def connect_to_namespace
+      if @connection.nil?
+        namespace = @namespace.nil? ? 'root/cimv2' : @namespace
+        locator = WIN32OLE.new("WbemScripting.SWbemLocator")
+        begin
+          @connection = locator.ConnectServer('.', namespace)
+        rescue WIN32OLERuntimeError => native_exception
+          raise WmiException.new(native_exception, :ConnectServer, @namespace)
+        end
+      end
+    end
+
+    def wmi_result_to_snapshot(wmi_object)
+      snapshot = Instance.new(wmi_object)
+    end
+  end
+end

data/lib/wmi-lite/wmi_exception.rb

@@ -0,0 +1,77 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+# Copyright:: Copyright 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module WmiLite
+  class WmiException < Exception
+    def initialize(exception, wmi_method_context, namespace, query = nil, class_name = nil)
+      error_message = exception.message
+      error_code = translate_error_code(error_message)
+
+      case wmi_method_context
+      when :ConnectServer
+        error_message = translate_wmi_connect_error_message(error_message, error_code, namespace)
+      when :ExecQuery
+        error_message = translate_query_error_message(error_message, error_code, namespace, query, class_name)
+      end
+
+      super(error_message)
+    end
+
+    private
+
+    def translate_error_code(error_message)
+      error_code = nil
+
+      # Parse the error to get the error status code
+      error_code_match = error_message.match(/[^\:]+\:\s*([0-9A-Fa-f]{1,8}).*/)
+      error_code = error_code_match.captures.first if error_code_match
+      error_code ? error_code : ''
+    end
+
+    def translate_wmi_connect_error_message(native_message, error_code, namespace)
+      error_message = "An error occurred connecting to the WMI service for namespace \'#{namespace}\'. The namespace may not be valid, access may not be allowed to the WMI service, or the WMI service may not be available.\n#{native_message}"
+
+      if error_code =~ /8004100E/i
+        error_message = "The specified namespace name \'#{namespace}\' is not a valid namespace name or does not exist.\n#{native_message}"
+      end
+
+      error_message
+    end
+
+    def translate_query_error_message(native_message, error_code, namespace, query, class_name)
+      error_message = "An error occurred when querying namespace \'#{namespace}\' with query \'#{query}\'.\n#{native_message}"
+
+      error_code = translate_error_code(error_message)
+
+      # Use the status code to generate a more friendly message
+      case error_code
+      when /80041010/i
+        if class_name
+          error_message = "The specified class \'#{class_name}\' is not valid in the namespace \'#{namespace}\'.\n#{native_message}."
+        else
+          error_message = "The specified query \'#{query}\' referenced a class that is not valid in the namespace \'#{namespace}\'\n#{native_message}."
+        end
+      when /80041017/i
+        error_message = "The specified query \'#{query}\' in namespace \'#{namespace}\' is not a syntactically valid query.\n#{native_message}"
+      end
+
+      error_message
+    end
+  end
+end
+    

data/lib/wmi-lite/wmi_instance.rb

@@ -0,0 +1,48 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+# Copyright:: Copyright 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module WmiLite
+  class Wmi
+    class Instance
+
+      attr_reader :wmi_ole_object
+
+      def initialize(wmi_ole_object)
+        @wmi_ole_object = wmi_ole_object
+        @property_map = wmi_ole_object_to_hash(wmi_ole_object)
+      end
+
+      def [](key)
+        @property_map[key.downcase]
+      end
+
+      private
+
+      def wmi_ole_object_to_hash(wmi_object)
+        property_map = {}
+        wmi_object.properties_.each do |property|
+          property_map[property.name.downcase] = wmi_object.invoke(property.name)
+        end
+
+        @wmi_ole_object = wmi_object
+
+        property_map.freeze
+      end
+
+    end
+  end
+end

data/spec/functional/wmi_spec.rb

@@ -0,0 +1,161 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+#
+# Copyright:: 2014, Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe WmiLite::Wmi, :windows_only do
+  let(:wmi) { WmiLite::Wmi.new(namespace) }
+
+  def validate_wmi_results(results, class_name)
+    result_collection = cardinality_transform.call(results)
+    result_collection.each do | result |
+      # make sure the class name of the instance is what we asked for
+      expect(result['creationclassname'].downcase).to eql(class_name.downcase)
+    end
+  end
+
+  shared_examples_for 'a valid WMI query result' do
+    it 'should successfully return multiple results' do
+      query_parameter = wmi_query.nil? ? wmi_class : wmi_query
+      results = wmi.send(query_method, query_parameter)
+      validate_wmi_results(results, wmi_class)
+    end
+
+    describe 'when the namespace is invalid' do
+      it_behaves_like 'an invalid namespace'
+    end
+  end
+
+  shared_examples_for 'an invalid query' do
+    it 'should raise an exception' do
+      expect { wmi.send(query_method, wmi_query) }.to raise_error(WmiLite::WmiException)
+    end
+  end
+
+  shared_examples_for 'an invalid namespace' do
+    it 'should raise an exception if an invalid namespace is specified' do
+      invalid_wmi = WmiLite::Wmi.new('root/notvalid')
+      expect { invalid_wmi.send(query_method, wmi_query) }.to raise_error(WmiLite::WmiException)
+    end
+  end
+
+  shared_examples_for 'a valid WMI query' do
+    let(:wmi_class) { 'Win32_LogicalDisk' }
+    it_behaves_like 'a valid WMI query result'
+
+    let(:wmi_class) { 'Win32_ComputerSystem' }
+    it_behaves_like 'a valid WMI query result'
+
+    let(:wmi_class) { 'Win32_Process' }
+    it_behaves_like 'a valid WMI query result'
+
+    context 'that return 0 results' do
+      let(:wmi_class) { 'Win32_TapeDrive' }
+      it_behaves_like 'a valid WMI query result'
+    end
+  end
+
+  context 'when making valid queries' do
+    let(:namespace) { nil }
+    let(:wmi_query) { nil }
+    let(:cardinality_transform) { lambda{|x| x} }
+    context 'using first_of' do
+      let(:cardinality_transform) { lambda{|x| x.nil? ? [] : [x] } }
+      let(:query_method) { :first_of } 
+      it_behaves_like 'a valid WMI query'
+    end
+
+    context 'using instances_of' do
+      let(:query_method) { :instances_of } 
+      it_behaves_like 'a valid WMI query'
+    end
+
+    context 'using query' do
+      let(:wmi_query) { "select * from #{wmi_class}" }
+      let(:query_method) { :query } 
+      it_behaves_like 'a valid WMI query'
+    end
+  end
+
+  context 'when making invalid queries' do
+    let(:namespace) { nil }
+
+    let(:wmi_query) { 'invalidclass' }
+    let(:query_method) { :first_of }
+    it_behaves_like 'an invalid query'
+
+    let(:query_method) { :instances_of }
+    it_behaves_like 'an invalid query'
+
+    let(:query_method) { :query }
+    let(:wmi_query) { 'nosql_4_life' }
+    it_behaves_like 'an invalid query'
+  end
+
+  let(:namespace) { nil }
+  describe 'when querying Win32_Environment' do
+    it 'should have the same environment variables as the Ruby ENV environment hash' do
+      results = wmi.instances_of('Win32_Environment')
+
+      variables = {}
+
+      # Skip some environment variables because we can't compare them against what's in ENV.
+      # Path, pathext, psmodulepath are special, they ares "merged" between the user and system value.
+      # PROCESSOR_ARCHITECTURE is actually the real processor arch of the system, so #{ENV['processor_architecture']} will
+      # report X86, while WMI will (correctly) report X64.
+      # And username is oddly the username of the WMI service, i.e. 'SYSTEM'.
+      ignore = {'path' => true, 'pathext' => true, 'processor_architecture' => true, 'psmodulepath' => true, 'username' => true}
+      results.each do | result |
+        if ! variables.has_key?(result['name']) || result['username'] != '<SYSTEM>'
+          variables[result['name']] = result['variablevalue']
+        end
+      end
+
+      verified_count = 0
+      variables.each_pair do | name, value |
+        if ignore[name.downcase] != true
+
+          # Turn %SYSTEMROOT% into c:\windows
+          # so we can compare with what's in ENV
+          evaluated_value = `echo #{value}`.strip 
+
+          expect(evaluated_value).to eql(`echo #{ENV[name]}`.strip)
+          verified_count += 1
+        end
+      end
+      
+      # There are at least 3 variables we could verify in a default
+      # Windows configuration, make sure we saw some
+      expect(verified_count).to be >= 3
+    end
+  end
+
+  let(:namespace) { nil }
+  it 'should ignore case when retrieving WMI properties' do
+    result = wmi.first_of('Win32_ComputerSystem')
+    caption_mixed = result['Caption']
+    caption_lower = result['caption']
+
+    expect(caption_mixed.nil?).to eql(false) 
+    expect(caption_lower.nil?).to eql(false)
+
+    expect(caption_mixed.length).to be > 0
+    expect(caption_lower.length).to be > 0
+    expect(caption_mixed).to eql(caption_lower)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# $:.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'wmi-lite'
+
+RSpec.configure do |config|
+  config.include(RSpec::Matchers)
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.filter_run_excluding :windows_only => true if ! (RUBY_PLATFORM =~ /mswin|mingw32|windows/)
+  config.run_all_when_everything_filtered = true
+end
+

data/spec/unit/wmi_spec.rb

@@ -0,0 +1,295 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+#
+# Copyright:: 2014, Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe WmiLite::Wmi do
+
+  let(:wbem_locator) { double 'WIN32OLE', :ConnectServer => wbem_connection }
+  let(:wmi_query_instance1) { double 'Wmi::Instance', :wmi_ole_object => native_query_instance1, :[] => native_properties1 }
+  let(:wmi_query_instance2) { double 'Wmi::Instance', :wmi_ole_object => native_query_instance2, :[] => native_properties2 }
+  let(:wmi_query_result1)  { [ wmi_query_instance1 ].to_enum }
+  let(:wmi_query_result2)  { [ wmi_query_instance1, wmi_query_instance2 ].to_enum }
+  let(:native_query_result1)  { [ native_query_instance1 ].to_enum }
+  let(:native_query_result2)  { [ native_query_instance1, native_query_instance2 ].to_enum }
+  let(:wmi_query_result_empty)  { [].to_enum }
+  let(:native_properties1) { wmi_properties1.map { | property, value |  double 'WIN32OLE', :name => property } }
+  let(:native_properties2) { wmi_properties2.map { | property, value |  double 'WIN32OLE', :name => property } }
+  let(:native_query_instance1) { double 'WIN32OLE', :properties_ => native_properties1, :invoke => 'value1' }
+  let(:native_query_instance2) { double 'WIN32OLE', :properties_ => native_properties2, :invoke => 'value2' }
+  let(:wbem_connection) { double 'WIN32OLE', :ExecQuery => native_query_result }
+
+  def validate_query_result(actual, expected)
+    expect(actual.count).to eql(expected.count)
+
+    index = 0
+
+    expected.each do | expected_value |
+      actual_value = actual[index]
+      expected_value.wmi_ole_object.invoke == actual_value.wmi_ole_object.invoke
+      expected_value.wmi_ole_object.properties_.each do | expected_property |
+
+        expect(actual_value[expected_property.name]).not_to eql(nil)
+
+        names = actual_value.wmi_ole_object.properties_.map { | property | property.name }
+
+        expect(names.include?(expected_property.name)).to eql(true)
+
+      end
+      index += 1
+    end
+  end
+
+  before(:each) do
+    stub_const('WIN32OLE', Class.new)
+    WIN32OLE.stub(:new).with("WbemScripting.SWbemLocator").and_return(wbem_locator)
+    stub_const('WIN32OLERuntimeError', Class.new(Exception))
+  end
+
+  let(:wmi) { WmiLite::Wmi.new }
+  let(:wmi_query_result) { wmi_query_result_empty }
+  let(:native_query_result) { [].to_enum }
+
+  it "should not fail with empty query results" do
+    results = wmi.query('')
+    result_count = 0
+    results.each { | result | result_count += 1 }
+
+    expect( result_count ).to eq(0)
+  end
+
+  shared_examples_for "the first_of method" do
+
+    let(:wmi_properties1) { { 'cores' => 4, 'name' => 'mycomputer1', 'diskspace' => 400, 'os' => 'windows' } }
+    let(:wmi_properties2) { { 'cores' => 2, 'name' => 'mycomputer2', 'bios' => 'ami', 'os' => 'windows' } }
+    let(:native_query_result) { [].to_enum }
+
+    it "should not fail with empty query results" do
+      results = wmi.first_of('vm')
+      expect( results ).to eq(nil)
+    end
+
+    context "when returning one instance in the query" do
+      let(:wmi_query_result) { wmi_query_result1 }
+      let(:native_query_result) { native_query_result1 }
+
+      it "should get one instance" do
+        results = wmi.first_of('vm')
+        expected_result = WmiLite::Wmi::Instance.new(native_query_result.first)
+        validate_query_result([results], [expected_result])
+      end
+    end
+
+    context "when returning more than one instance in the query" do
+      let(:wmi_query_result) { wmi_query_result2 }
+      let(:native_query_result) { native_query_result2 }
+
+      it "should get one instance" do
+        results = wmi.first_of('vm')
+        expected_result = WmiLite::Wmi::Instance.new(native_query_result.first)
+        validate_query_result([results], [expected_result])
+      end
+    end
+
+  end
+
+  shared_examples_for "the instances_of method" do
+
+    let(:wmi_properties1) { { 'cores' => 4, 'name' => 'mycomputer1', 'diskspace' => 400, 'os' => 'windows' } }
+    let(:wmi_properties2) { { 'cores' => 2, 'name' => 'mycomputer2', 'bios' => 'ami', 'os' => 'windows' } }
+    let(:native_query_result) { [].to_enum }
+
+    it "should not fail with empty query results" do
+      results = wmi.instances_of('vm')
+      expect( results ).to eq([])
+    end
+
+    context "when returning one instance in the query" do
+      let(:wmi_query_result) { wmi_query_result1 }
+      let(:native_query_result) { native_query_result1 }
+
+      it "should get one instance" do
+        results = wmi.instances_of('vm')
+        index = 0
+        expected_result = results.map do | result |
+          WmiLite::Wmi::Instance.new(result.wmi_ole_object)
+        end
+        validate_query_result(results, expected_result)
+      end
+    end
+
+    context "when returning one instance in the query" do
+      let(:wmi_query_result) { wmi_query_result2 }
+      let(:native_query_result) { native_query_result2 }
+
+      it "should get one instance" do
+        results = wmi.instances_of('vm')
+        index = 0
+        expected_result = results.map do | result |
+          WmiLite::Wmi::Instance.new(result.wmi_ole_object)
+        end
+        validate_query_result(results, expected_result)
+      end
+    end
+
+  end
+
+  shared_examples_for 'an invalid query' do
+    let(:unparseable_error) { 'unparseableerror' }
+    it 'should raise an exception' do
+      wbem_connection.should_receive(:ExecQuery).and_raise(WIN32OLERuntimeError)
+      wmi_service = WmiLite::Wmi.new
+      expect { wmi_service.send(query_method, wmi_query) }.to raise_error(WmiLite::WmiException)
+    end
+
+    it 'should raise an exception that ends with the original exception message' do
+      wbem_connection.should_receive(:ExecQuery).and_raise(WIN32OLERuntimeError.new(unparseable_error))
+      wmi_service = WmiLite::Wmi.new
+      error_message = nil
+      begin
+        wmi_service.send(query_method, wmi_query)
+      rescue WmiLite::WmiException => e
+        error_message = e.message
+      end
+
+      # Exception messages look a like a customized error string followed by
+      # the original, less friendly message. A change here affects only
+      # aestethics of human diagnostics, this may be changed with no effect
+      # on libraries or applications.
+      expect(error_message).not_to eql(nil)
+      expect(e.message.start_with?(unparseable_error)).to eql(false)
+      expect(e.message.end_with?(unparseable_error)).to eql(true)
+    end
+  end
+
+  shared_examples_for 'an invalid namespace' do
+    let(:unparseable_error) { 'unparseableerror' }
+    it 'should raise an exception' do
+      wbem_locator.should_receive(:ConnectServer).and_raise(WIN32OLERuntimeError)
+      wmi_service = WmiLite::Wmi.new('notavalidnamespace')
+      expect { wmi_service.send(query_method, wmi_query) }.to raise_error(WmiLite::WmiException)
+    end
+
+    it 'should raise an exception that starts with the original exception message' do
+      wbem_locator.should_receive(:ConnectServer).and_raise(WIN32OLERuntimeError.new(unparseable_error))
+      wmi_service = WmiLite::Wmi.new
+      error_message = nil
+      begin
+        wmi_service.send(query_method, wmi_query)
+      rescue WmiLite::WmiException => e
+        error_message = e.message
+      end
+
+      # See previous comment on this validation of human readability -- a change
+      # to the format / content of these messages will not break applications.
+      expect(error_message).not_to eql(nil)
+      expect(error_message.start_with?(unparseable_error)).to eql(false)
+      expect(error_message.end_with?(unparseable_error)).to eql(true)
+    end
+  end
+
+  shared_examples_for "the query method" do
+
+    let(:wmi_properties1) { { 'cores' => 4, 'name' => 'mycomputer1', 'diskspace' => 400, 'os' => 'windows' } }
+    let(:wmi_properties2) { { 'cores' => 2, 'name' => 'mycomputer2', 'bios' => 'ami', 'os' => 'windows' } }
+    let(:native_query_result) { [].to_enum }
+
+    it "should not fail with empty query results" do
+      results = wmi.query('vm')
+      expect( results ).to eq([])
+    end
+
+    context "when returning one instance in the query" do
+      let(:wmi_query_result) { wmi_query_result1 }
+      let(:native_query_result) { native_query_result1 }
+
+      it "should get one instance" do
+        results = wmi.query('vm')
+        index = 0
+        expected_result = results.map do | result |
+          WmiLite::Wmi::Instance.new(result.wmi_ole_object)
+        end
+        validate_query_result(results, expected_result)
+      end
+    end
+
+    context "when returning one instance in the query" do
+      let(:wmi_query_result) { wmi_query_result2 }
+      let(:native_query_result) { native_query_result2 }
+
+      it "should get one instance" do
+        results = wmi.query('vm')
+        index = 0
+        expected_result = results.map do | result |
+          WmiLite::Wmi::Instance.new(result.wmi_ole_object)
+        end
+        validate_query_result(results, expected_result)
+      end
+    end
+
+  end
+
+  context "when constructing a Ruby class instance" do
+    it "should not connect to WMI in the constructor" do
+      WmiLite::Wmi.any_instance.should_not_receive(:connect_to_namespace)
+      wmi_service_nil_namespace = WmiLite::Wmi.new
+      wmi_service_explicit_namespace = WmiLite::Wmi.new('root/cimv2')
+    end
+  end
+
+  context "when calling query methods" do
+    it "should only connect to WMI on the first query execution" do
+      WIN32OLE.should_receive(:new).with("WbemScripting.SWbemLocator").exactly(1).times.and_return(wbem_locator)
+      wmi_service = WmiLite::Wmi.new
+
+      # Make a lot of queries to be sure the connection is only created once
+      wmi_service.query('select * from Win32_Process')
+      wmi_service.query('select * from Win32_Process')
+      wmi_service.instances_of('Win32_Processor')
+      wmi_service.instances_of('Win32_Processor')
+      wmi_service.first_of('Win32_Group')
+      wmi_service.first_of('Win32_Group')
+    end
+  end
+
+  context 'when making invalid queries' do
+    let(:namespace) { nil }
+
+    let(:wmi_query) { 'invalidclass' }
+    let(:query_method) { :first_of }
+
+    it_behaves_like 'an invalid query'
+    it_behaves_like 'an invalid namespace'
+
+    let(:query_method) { :instances_of }
+    it_behaves_like 'an invalid query'
+    it_behaves_like 'an invalid namespace'
+
+    let(:query_method) { :query }
+    let(:wmi_query) { 'nosql_4_life' }
+    it_behaves_like 'an invalid query'
+    it_behaves_like 'an invalid namespace'
+  end
+
+  it_should_behave_like "the first_of method"
+
+  it_should_behave_like "the instances_of method"
+
+  it_should_behave_like "the query method"
+
+end

data/wmi-lite.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wmi-lite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wmi-lite'
+  spec.version       = WmiLite::VERSION
+  spec.authors       = ['Adam Edwards']
+  spec.email         = ['dev@getchef.com']
+  spec.description   = 'A lightweight utility over win32ole for accessing basic ' \
+                       'WMI (Windows Management Instrumentation) functionality ' \
+                       'in the Microsoft Windows operating system. It has no '  \
+                       'runtime dependencies other than Ruby, so it can be used ' \
+                       'without concerns around dependency issues.'
+  spec.summary       = 'A lightweight utility library for accessing basic WMI '     \
+                       '(Windows Management Instrumentation) functionality on Windows'
+  spec.homepage      = 'https://github.com/opscode/wmi-lite'
+  spec.license       = 'Apache 2.0'
+
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-debugger'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: wmi-lite
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc.0
+platform: ruby
+authors:
+- Adam Edwards
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  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: A lightweight utility over win32ole for accessing basic WMI (Windows
+  Management Instrumentation) functionality in the Microsoft Windows operating system.
+  It has no runtime dependencies other than Ruby, so it can be used without concerns
+  around dependency issues.
+email:
+- dev@getchef.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/wmi-lite.rb
+- lib/wmi-lite/version.rb
+- lib/wmi-lite/wmi.rb
+- lib/wmi-lite/wmi_exception.rb
+- lib/wmi-lite/wmi_instance.rb
+- spec/functional/wmi_spec.rb
+- spec/spec_helper.rb
+- spec/unit/wmi_spec.rb
+- wmi-lite.gemspec
+homepage: https://github.com/opscode/wmi-lite
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A lightweight utility library for accessing basic WMI (Windows Management
+  Instrumentation) functionality on Windows
+test_files:
+- spec/functional/wmi_spec.rb
+- spec/spec_helper.rb
+- spec/unit/wmi_spec.rb
+has_rdoc: