wbem 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.1.0
+
+* First public version

data/README.rdoc

@@ -0,0 +1,48 @@
+
+= ruby-wbem
+
+* http://github.com/kkaempf/ruby-wbem
+
+== INTRODUCTION
+
+ruby-wbem provides an abstraction layer on top of ruby-sfcc (CIM/XML)
+and openwsman (WS-Management)
+
+You can use it to connect to any CIMOM talking CIM-XML or WS-Management
+
+== Requirements
+
+=== Ruby interpreters
+
+ruby-wbem has been built and the testsuite ran against:
+  
+  * ruby 1.8.7
+  * ruby 1.9.2
+  
+== Quick Start
+
+You can create a gem by running rake gem.
+
+See the testsuite for more examples. Or run rake docs.
+
+    require 'rubygems'
+    require 'wbem'
+
+    client = Wbem.connect('http://user:password@hostname:5988')
+    client.namespaces.each do |ns|
+      puts "Namespace: #{ns}"
+    end
+
+== Links
+
+=== Documentation
+
+* http://rdoc.info/projects/kkaempf/ruby-wbem
+
+=== Code Metrics
+
+* http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fkkaempf%2Fruby-wbem.git
+
+== Authors
+
+* Klaus Kämpf <kkaempf@suse.de>

data/lib/wbem/cimxml.rb

@@ -0,0 +1,79 @@
+#
+# wbem/cimxml.rb
+# CimxmlClient implementation for ruby-wbem
+#
+# Copyright (c) SUSE Linux Products GmbH 2011
+# Written by Klaus Kämpf <kkaempf@suse.de>
+#
+# Licensed under the MIT license
+#
+require "wbem/wbem"
+
+module Wbem
+class CimxmlClient < WbemClient
+  require "sfcc"
+
+  def initialize url
+    super url
+    @client = Sfcc::Cim::Client.connect url
+  end
+  
+  def objectpath namespace, classname = nil
+    Sfcc::Cim::ObjectPath.new(namespace, classname)
+  end
+
+  #
+  # identify client
+  # return identification string
+  # on error return nil and set @response to http response code
+  #
+  def identify
+    "CIM/XML client at #{@url.host}:#{@url.port}"
+  end
+
+  #
+  # Return instances for namespace and classname
+  #
+  def each_instance( ns, cn )
+    op = Sfcc::Cim::ObjectPath.new(ns, cn)
+    begin
+      @client.instances(op).each do |inst|
+        yield inst
+      end
+    rescue Sfcc::Cim::ErrorInvalidClass, Sfcc::Cim::ErrorInvalidNamespace
+    end
+  end
+  
+  #
+  # Return list of classnames for given namespace
+  #
+  def classnames namespace, deep_inheritance = false
+    STDERR.puts "#{@client}.classnames(#{namespace})"
+    ret = []
+    op = Sfcc::Cim::ObjectPath.new(namespace)
+    flags = deep_inheritance ? Sfcc::Flags::DeepInheritance : 0
+    begin
+      @client.class_names(op,flags).each do |name|
+	ret << name.to_s
+      end
+    rescue Sfcc::Cim::ErrorInvalidNamespace
+    end
+    ret
+  end
+
+  #
+  # Return list of instance_names (object pathes) for given objectpath
+  #
+  def instance_names objectpath
+    STDERR.puts "#{@client}.instance_names(#{objectpath})"
+    ret = []
+    begin
+      @client.instance_names(objectpath).each do |path|
+	ret << path
+      end
+    rescue Sfcc::Cim::ErrorInvalidClass, Sfcc::Cim::ErrorInvalidNamespace
+    end
+    ret
+  end
+end # class
+end # module

data/lib/wbem/version.rb

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

data/lib/wbem/wbem.rb

@@ -0,0 +1,70 @@
+#
+# wbem/wbem.rb
+# WbemClient implementation for ruby-wbem
+#
+# Copyright (c) SUSE Linux Products GmbH 2011
+# Written by Klaus Kämpf <kkaempf@suse.de>
+#
+# Licensed under the MIT license
+#
+module Wbem
+  #
+  # WbemClient - base class for CimxmlClient and WsmanClient
+  #
+  class WbemClient
+    require 'uri'
+
+    attr_reader :url, :response
+
+    def initialize url
+      @url = (url.is_a? URI) ? url : URI.parse(url)
+    end
+
+    def response_code
+      @client.response_code
+    end
+
+    def fault_string
+      @client.fault_string
+    end
+
+    def objectpath namespace, classname
+      raise "#{self.class}.objectpath not implemented"
+    end
+
+private
+    def _namespaces ns, cn
+      result = nil
+      each_instance( ns, cn ) do |inst|
+        result ||= [ns]
+        name = "#{ns}/#{inst.Name}"
+        unless result.include? name
+          result << name
+          result.concat(_namespaces name, cn)
+        end
+      end
+      result || []
+    end
+public
+    # return list of namespaces
+    def namespaces
+      STDERR.puts "Namespaces for #{@url}"
+      result = []
+      ['root', 'Interop', 'interop'].each do |ns|
+        ["CIM_Namespace", "__Namespace", "__NAMESPACE"].each do |cn|
+          result.concat(_namespaces ns, cn)
+        end
+      end
+      result.uniq
+    end
+
+    # return list of classnames for namespace ns
+    def classnames ns, deep_inheritance=false
+      raise "#{self.class}.classnames not implemented"
+    end
+  
+    def instance_names classname
+      raise "#{self.class}.instance_names not implemented"
+    end
+  end # Class
+end # Module

data/lib/wbem/wsman.rb

@@ -0,0 +1,187 @@
+#
+# wbem/wsman.rb
+# WsmanClient implementation for ruby-wbem
+#
+# Copyright (c) SUSE Linux Products GmbH 2011
+# Written by Klaus Kämpf <kkaempf@suse.de>
+#
+# Licensed under the MIT license
+#
+require "wbem/wbem"
+require "openwsman"
+
+class AuthError < StandardError
+end
+
+module Openwsman
+  class Transport
+    def Transport.auth_request_callback( client, auth_type )
+      STDERR.puts "\t *** Transport.auth_request_callback"
+      return nil
+    end
+  end
+  class ObjectPath
+    attr_reader :namespace, :classname
+    def initialize namespace, classname = nil
+      @namespace = namespace
+      @classname = classname
+    end
+  end
+end
+
+module Wbem
+class WsmanClient < WbemClient
+  def initialize uri
+    super uri
+    @url.path = "/wsman" if @url.path.nil? || @url.path.empty?
+#    Openwsman::debug = -1
+    STDERR.puts "WsmanClient connecting to #{uri}" if Wbem.debug
+
+    @client = Openwsman::Client.new @url.to_s
+    raise "Cannot create Openwsman client" unless @client
+    @client.transport.timeout = 5
+    @client.transport.verify_peer = 0
+    @client.transport.verify_host = 0
+    # FIXME
+#    @client.transport.auth_method = (@url.scheme == 'http') ? Openwsman::BASIC_AUTH_STR : Openwsman::DIGEST_AUTH_STR
+    @client.transport.auth_method = Openwsman::BASIC_AUTH_STR
+    @options = Openwsman::ClientOptions.new
+
+    doc = identify
+#    STDERR.puts doc.to_xml
+    @protocol_version = doc.ProtocolVersion.text
+    @product_vendor = doc.ProductVendor.text
+    @product_version = doc.ProductVersion.text
+    if Wbem.debug
+      STDERR.puts "Protocol_version '#{@protocol_version}'"
+      STDERR.puts "Product vendor '#{@product_vendor}'"
+      STDERR.puts  "Product version '#{@product_version}'"
+    end
+    #
+    # Windows winrm 2.0
+    # Protocol "http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd"
+    # Vendor "Microsoft Corporation"
+    # Version "OS: 5.2.3790 SP: 2.0 Stack: 2.0"
+    #
+    # Windows winrm 1.1
+    # Protocol "http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd"
+    # Vendor "Microsoft Corporation"
+    # Version "OS: 5.1.2600 SP: 3.0 Stack: 1.1"
+    #
+    # Openwsman 2.2
+    # Protocol "http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd"
+    # Vendor "Openwsman Project"
+    # Version "2.2"
+    #
+
+    unless @protocol_version == Openwsman::XML_NS_WS_MAN
+      raise "Unsupported WS-Management protocol '#{@protocol_version}'"
+    end
+
+    case @product_vendor
+    when "Microsoft Corporation"
+      @prefix = "http://schemas.microsoft.com/wbem/wsman/1/wmi/"
+      if @product_version =~ /^OS:\s([\d\.]+)\sSP:\s([\d\.]+)\sStack:\s([\d\.]+)$/
+        @product_version = $3
+      else
+        STDERR.puts "Unrecognized product version #{@product_version}"
+      end
+      @product = :winrm
+    when "Openwsman Project"
+      @prefix = "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/"
+      @product = :openwsman
+    else
+      STDERR.puts "Unsupported WS-Management vendor #{@product_vendor}"
+      @prefix = "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/"
+      @product = :unknown
+    end
+    STDERR.puts "Connected to vendor '#{@product_vendor}', Version #{@product_version}" if Wbem.debug
+
+  end
+
+  def objectpath classname, namespace
+    Openwsman::ObjectPath.new classname, namespace
+  end
+
+  #
+  # WS-Identify
+  # returns Openwsman::XmlDoc
+  #
+  def identify
+    STDERR.puts "Identify client #{@client} with #{@options}" if Wbem.debug
+    doc = @client.identify( @options )
+    unless doc
+      raise RuntimeError.new "Identify failed: HTTP #{@client.response_code}, Err #{@client.last_error}:#{@client.fault_string}"
+    end
+    if doc.fault?
+      fault = doc.fault
+      STDERR.puts "Fault: #{fault.to_xml}"
+      raise fault.to_s
+    end
+#    STDERR.puts "Return #{doc.to_xml}"
+    doc
+  end
+  
+  def each_instance( ns, cn )
+    @options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
+    @options.max_elements = 999
+    resource = "#{@prefix}#{ns}/#{cn}"
+    result = @client.enumerate( @options, nil, resource )
+    return unless result
+#    STDERR.puts "Result '#{result.to_xml}'"
+    return if result.fault?
+    items = result.body.EnumerateResponse.Items rescue nil
+    items.each do |inst|
+      yield inst
+    end if items
+  end
+
+  def classnames namespace, deep_inheritance
+    # enum_classnames is Openwsman-specific
+    unless @product_vendor =~ /Openwsman/ && @product_version >= "2.2"
+      STDERR.puts "ENUMERATE_CLASS_NAMES unsupported for #{@product_vendor} #{@product_version}"
+      return []
+    end
+    @options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
+    @options.max_elements = 999
+    @options.cim_namespace = namespace
+    method = Openwsman::CIM_ACTION_ENUMERATE_CLASS_NAMES
+    uri = Openwsman::XML_NS_CIM_INTRINSIC
+    result = @client.invoke( @options, uri, method )
+    if result.fault?
+      puts "Enumerate class names (#{uri}) failed:\n\tResult code #{@client.response_code}, Fault: #{@client.fault_string}"
+      return []
+    end
+    output = result.body[method]
+    classes = []
+    output.each do |c|
+      classes << c.to_s
+    end
+    return classes
+  end
+
+  def instance_names object_path
+    @options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
+    @options.max_elements = 999
+    @options.cim_namespace = object_path.namespace
+    # http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/
+    # CIM=http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2
+    # OpenWBEM=http://schema.openwbem.org/wbem/wscim/1/cim-schema/2
+    # Linux=http://sblim.sf.net/wbem/wscim/1/cim-schema/2
+    # OMC=http://schema.omc-project.org/wbem/wscim/1/cim-schema/2
+    # PG=http://schema.openpegasus.org/wbem/wscim/1/cim-schema/2
+    uri = "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/"+object_path.classname
+    result = @client.enumerate( @options, nil, uri )
+    if result.fault?
+      puts "Enumerate instances (#{uri}) failed:\n\tResult code #{@client.response_code}, Fault: #{@client.fault_string}"
+      return []
+    end
+    output = result.body[method]
+    instances = []
+    output.each do |i|
+      instances << i.to_s
+    end
+    return instances
+  end
+end
+end # module

data/lib/wbem.rb

@@ -0,0 +1,61 @@
+module Wbem
+  @@debug = nil
+  def Wbem.debug
+    @@debug
+  end
+  def Wbem.debug= level
+    @@debug = (level == 0) ? nil : level
+  end
+  class Client
+    require 'uri'
+    require 'wbem/wsman'
+    require 'wbem/cimxml'
+
+    attr_reader :url, :response
+
+    #
+    # Wbem::Client.connect uri, protocol = nil
+    #
+    # Connect to remote client identified by uri and protocol
+    # Possible values for protocol:
+    # :cimxml - connect via CIM/XML
+    # :wsman  - connect via WS-Management
+    # else    - probe connection (cim/xml first)
+    #
+    def self.connect uri, protocol = nil
+      STDERR.puts "Wbem::Client.connect(#{uri},#{protocol})" if Wbem.debug
+      u = uri.is_a?(URI) ? uri : URI.parse(uri)
+      case protocol
+      when :wsman
+        return WsmanClient.new u
+      when :cimxml
+        return CimxmlClient.new u
+      end
+      STDERR.puts "no connect, check known ports"
+      # no connect, check known ports
+      case u.port
+      when 8888, 8889, 5985, 5986
+        return WsmanClient.new u
+      when 5988, 5989
+        return CimxmlClient.new u
+      end
+      STDERR.puts "no known ports"
+      port = u.port # keep orig port as we change u.port below
+      [:wsman, :cimxml].each do |protocol|
+        # enforce port if uri provides scheme and host only
+        if port == 80 && u.scheme == 'http' # http://hostname
+          u.port = (protocol == :cimxml) ? 5988: 5985
+        end
+        if port == 443 && u.scheme == 'https' # https://hostname
+          u.port = (protocol == :cimxml) ? 5989: 5986
+        end
+        c = Wbem::Client.connect u, protocol
+        if c
+          STDERR.puts "Connect #{u} as #{c}"
+          return c
+        end
+      end
+    end
+
+  end # Class
+end # Module

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: wbem
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Klaus K\xC3\xA4mpf"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :development
+  version_requirements: *id001
+description: ruby-wbem allows to access a CIMOM transparently through CIM/XML or WS-Management
+email: 
+- kkaempf@suse.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/wbem.rb
+- lib/wbem/wbem.rb
+- lib/wbem/cimxml.rb
+- lib/wbem/version.rb
+- lib/wbem/wsman.rb
+- CHANGELOG.rdoc
+- README.rdoc
+has_rdoc: true
+homepage: http://www.github.com/kkaempf/ruby-wbem
+licenses: []
+
+post_install_message: "  ____\n\
+  /@    ~-.\n\
+  / __ .- | remember to have fun! \n // //  @  \n\n"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: WBEM client for Ruby based on ruby-sfcc and openwsman
+test_files: []
+