ilorb 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dda8bc7feb3994e4cfbd360716f380af125b2e0
+  data.tar.gz: 9c2b8b3d6f61d440df5039feaf2f94769b9c2ec9
+SHA512:
+  metadata.gz: 423966543881ffd1e3720fdc0d44bd2858dd4f4cbd2681c72d2ed7d7b9b64b92b4b796d733df0e0d2120c4f8adf1e2e698350e1a24e0377e6a6c3c90e81a76f2
+  data.tar.gz: d43910027cb1dc97efe24c9f81c743d49fc56731d744a73f7f508b9b3755998949b64a2ae9361599b61af2cbf4348e636d83e61f632a3305e7623b08e78b3a57

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ilorb (0.0.1)
+    ilorb (0.0.2)
       nokogiri
       nori
 
@@ -14,10 +14,10 @@ GEM
       safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
     method_source (0.8.1)
-    mini_portile (0.5.0)
-    nokogiri (1.6.0)
+    mini_portile (0.5.3)
+    nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
-    nori (2.2.0)
+    nori (2.4.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README.md

@@ -16,11 +16,13 @@ HP, Integrated Lights Out and iLO are trademarks of HP, with whom the author of
 
 ## Examples
 
+WARNING: as of 0.0.2, `ILORb::ILO` content has been moved to `ILORb`. Just use `ILORb#new`
+
 ```ruby
 require 'json'
 require 'ilorb'
 
-ilo = ILORb::ILO.new(
+ilo = ILORb.new(
   :hostname => "10.200.0.1",
   :login => "Admin",
   :password => "SECRET",
@@ -91,7 +93,7 @@ Dependencies:
 Install:
  * git clone https://github.com/josqu4red/ilorb
 OR
- * gem install ilorb (soon)
+ * gem install ilorb
 
 ## Credits
 

data/lib/ilorb/ribcl.rb

@@ -1,4 +1,4 @@
-module ILORb
+class ILORb
   class RIBCL < Hash
     def initialize
       super

data/lib/ilorb/version.rb

@@ -1,3 +1,3 @@
-module ILORb
-  VERSION = "0.0.1"
+class ILORb
+  VERSION = "0.0.2"
 end

data/lib/ilorb.rb

@@ -1,5 +1,206 @@
+require 'logger'
+require 'socket'
+require 'openssl'
+require 'net/https'
+require 'nokogiri'
+require 'nori'
 require 'ilorb/ribcl'
-require 'ilorb/ilo'
 
-module ILORb
+class ILORb
+
+  class NotImplemented < StandardError; end
+
+  def initialize(config = {})
+    @hostname = config[:hostname]
+    @login = config[:login] || "Administrator"
+    @password = config[:password]
+    @port = config[:port] || 443
+    @protocol = config[:protocol] || :http
+    @verify_ssl = config[:verify_ssl] || false
+    @ribcl_path = "/ribcl"
+
+    @log = Logger.new(STDOUT)
+    @log.level = config[:debug] ? Logger::DEBUG : Logger::WARN
+
+    @nori = Nori.new(:convert_tags_to => lambda{|tag| tag.downcase.to_sym})
+
+    setup_commands
+  end
+
+  # args should be empty or contain a hash anytime
+  def method_missing(name, *args, &block)
+    if @ribcl.has_command?(name)
+      command = @ribcl.command(name)
+
+      raise NotImplemented, "#{name} is not supported" unless command.supported?
+
+      params = args.first || {}
+      attributes = {}
+      element_map = nil
+
+      #TODO check for text
+
+      command.get_attributes.each do |attr|
+        # Attributes are mandatory
+        error("Attribute #{attr} missing in #{name} call") unless params.has_key?(attr)
+        attributes.store(attr, @ribcl.encode(params.delete(attr)))
+      end
+
+      element_map = command.map_elements
+
+      elements_array = []
+
+      [ params ].flatten.each do |params_hash|
+        elements = {}
+        params_hash.each do |key, value|
+          # Elements are not mandatory for now
+          elements.store(key, @ribcl.encode(params_hash.delete(key))) if element_map.has_key?(key)
+        end
+        elements_array << elements
+      end
+
+      #TODO check for CDATA
+
+      @log.info("Calling method #{name}")
+      request = ribcl_request(command, attributes) do |xml|
+        elements_array.each do |elements_hash|
+          elements_hash.each do |key, value|
+            elt = command.get_elements[element_map[key].first]
+            if elt.is_a?(Array)
+              attrs = Hash[elt.map{|x| [x, elements_hash.delete(element_map.invert[[element_map[key].first, x]])]}]
+            else
+              attrs = {element_map[key].last => value}
+            end
+            xml.send(element_map[key].first, attrs)
+          end
+        end
+      end
+
+      response = send_request(request)
+      parse_response(response, name)
+    else
+      super
+    end
+  end
+
+  def respond_to(name)
+    @ribcl.has_command?(name) ? true : super
+  end
+
+  def supported_commands
+    @ribcl.select{|name, command| command.supported?}.keys
+  end
+
+  private
+
+  def send_request(xml)
+    case @protocol
+    when :http
+      send_http_request(xml)
+    when :raw
+      send_raw_request(xml)
+    end
+  end
+
+  # ILO >= 3 speak HTTP
+  # Send XML request with HTTP POST and get back XML messages
+  def send_http_request(xml)
+    http = Net::HTTP.new(@hostname, @port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @verify_ssl
+
+    @log.info("Sending POST request to #{@hostname}:#{@port}#{@ribcl_path}")
+    @log.debug("Request:\n#{xml}")
+    response = http.post(@ribcl_path, xml)
+    if response.is_a?(Net::HTTPNotFound)
+      @protocol = :raw
+      @log.info("Got 404, switching to RAW protocol")
+      send_raw_request(xml)
+    else
+      response.body
+    end
+  end
+
+  # Older ILO just eat raw XML
+  # Send XML over raw SSL-wrapped TCP socket and read XML stream
+  def send_raw_request(xml)
+    sock = TCPSocket.new(@hostname, @port)
+
+    ctx = OpenSSL::SSL::SSLContext.new(:TLSv1)
+    ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    ssl_sock = OpenSSL::SSL::SSLSocket.new(sock, ctx)
+    ssl_sock.sync_close = true
+
+    @log.info("Connecting to #{@hostname}:#{@port}")
+    ssl_sock.connect
+    @log.debug("Request:\n#{xml}")
+    ssl_sock.puts("#{xml}\r\n")
+    response = ""
+    while line = ssl_sock.gets
+      response += line
+    end
+    ssl_sock.close
+
+    response
+  end
+
+  def parse_response(xml, command)
+    @log.debug("Response:\n#{xml}")
+
+    # ILO sends back multiple XML documents, split by XML header and remove first (empty)
+    messages = xml.split(/<\?xml.*?\?>\r?\n/).drop(1)
+
+    output = {}
+
+    messages.each do |doc|
+      xml_doc = Nokogiri::XML(doc){|cfg| cfg.nonet.noblanks}
+
+      xml_doc.root.children.each do |node|
+        case node.name
+        when "RESPONSE"
+          code = node.attr("STATUS").to_i(16)
+          message = node.attr("MESSAGE")
+          if code == 0
+            output[:status] = { :code => code, :message => message }
+          else
+            output[:status] = { :code => code, :message => message }
+            @log.error("#{message} (#{code})")
+            break
+          end
+        when "INFORM"
+          # OSEF
+        else # actual result
+          output.merge!(@nori.parse(node.to_s))
+        end
+      end
+    end
+
+    output
+  end
+
+  def ribcl_request(command, args = {}, &block)
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.ribcl(:version => "2.0") {
+        xml.login(:password => @password, :user_login => @login) {
+          xml.send(command.context, :mode => command.mode) {
+            xml.send(command.name, args) {
+              yield xml if block_given?
+            }
+          }
+        }
+      }
+    end
+
+    builder.to_xml
+  end
+
+  def setup_commands
+    @ribcl = ILORb::RIBCL.load(File.join(File.dirname(__FILE__), "ilorb/definitions", "*.rb"))
+    nil
+  end
+
+  def error(message)
+    @log.error(message)
+    raise message
+  end
 end

data/spec/ilo_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ILORb::ILO do
+describe ILORb do
   let(:hostname) { "10.200.0.1" }
   let(:login) { "Admin" }
   let(:password) { "SECRET" }
-  let(:ilo) { ILORb::ILO.new(hostname: hostname, login: login, password: password) }
+  let(:ilo) { ILORb.new(hostname: hostname, login: login, password: password) }
 
   describe "#get_network_settings" do
     before do

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: ilorb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonathan Amiez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: HP ILO Ruby interface
@@ -122,7 +109,6 @@ files:
 - lib/ilorb/definitions/rib.rb
 - lib/ilorb/definitions/server.rb
 - lib/ilorb/definitions/user.rb
-- lib/ilorb/ilo.rb
 - lib/ilorb/ribcl.rb
 - lib/ilorb/version.rb
 - spec/assets/basic_response.xml
@@ -132,27 +118,26 @@ files:
 homepage: https://github.com/josqu4red/ilorb
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Configure and retrieve data from server's ILO management card
 test_files:
 - spec/assets/basic_response.xml

data/lib/ilorb/ilo.rb

@@ -1,207 +0,0 @@
-require 'logger'
-require 'socket'
-require 'openssl'
-require 'net/https'
-require 'nokogiri'
-require 'nori'
-
-module ILORb
-
-  class NotImplemented < StandardError; end
-
-  class ILO
-    def initialize(config = {})
-      @hostname = config[:hostname]
-      @login = config[:login] || "Administrator"
-      @password = config[:password]
-      @port = config[:port] || 443
-      @protocol = config[:protocol] || :http
-      @verify_ssl = config[:verify_ssl] || false
-      @ribcl_path = "/ribcl"
-
-      @log = Logger.new(STDOUT)
-      @log.level = config[:debug] ? Logger::DEBUG : Logger::WARN
-
-      @nori = Nori.new(:convert_tags_to => lambda{|tag| tag.downcase.to_sym})
-
-      setup_commands
-    end
-
-    # args should be empty or contain a hash anytime
-    def method_missing(name, *args, &block)
-      if @ribcl.has_command?(name)
-        command = @ribcl.command(name)
-
-        raise NotImplemented, "#{name} is not supported" unless command.supported?
-
-        params = args.first || {}
-        attributes = {}
-        element_map = nil
-
-        #TODO check for text
-
-        command.get_attributes.each do |attr|
-          # Attributes are mandatory
-          error("Attribute #{attr} missing in #{name} call") unless params.has_key?(attr)
-          attributes.store(attr, @ribcl.encode(params.delete(attr)))
-        end
-
-        element_map = command.map_elements
-
-        elements_array = []
-
-        [ params ].flatten.each do |params_hash|
-          elements = {}
-          params_hash.each do |key, value|
-            # Elements are not mandatory for now
-            elements.store(key, @ribcl.encode(params_hash.delete(key))) if element_map.has_key?(key)
-          end
-          elements_array << elements
-        end
-
-        #TODO check for CDATA
-
-        @log.info("Calling method #{name}")
-        request = ribcl_request(command, attributes) do |xml|
-          elements_array.each do |elements_hash|
-            elements_hash.each do |key, value|
-              elt = command.get_elements[element_map[key].first]
-              if elt.is_a?(Array)
-                attrs = Hash[elt.map{|x| [x, elements_hash.delete(element_map.invert[[element_map[key].first, x]])]}]
-              else
-                attrs = {element_map[key].last => value}
-              end
-              xml.send(element_map[key].first, attrs)
-            end
-          end
-        end
-
-        response = send_request(request)
-        parse_response(response, name)
-      else
-        super
-      end
-    end
-
-    def respond_to(name)
-      @ribcl.has_command?(name) ? true : super
-    end
-
-    def supported_commands
-      @ribcl.select{|name, command| command.supported?}.keys
-    end
-
-    private
-
-    def send_request(xml)
-      case @protocol
-      when :http
-        send_http_request(xml)
-      when :raw
-        send_raw_request(xml)
-      end
-    end
-
-    # ILO >= 3 speak HTTP
-    # Send XML request with HTTP POST and get back XML messages
-    def send_http_request(xml)
-      http = Net::HTTP.new(@hostname, @port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @verify_ssl
-
-      @log.info("Sending POST request to #{@hostname}:#{@port}#{@ribcl_path}")
-      @log.debug("Request:\n#{xml}")
-      response = http.post(@ribcl_path, xml)
-      if response.is_a?(Net::HTTPNotFound)
-        @protocol = :raw
-        @log.info("Got 404, switching to RAW protocol")
-        send_raw_request(xml)
-      else
-        response.body
-      end
-    end
-
-    # Older ILO just eat raw XML
-    # Send XML over raw SSL-wrapped TCP socket and read XML stream
-    def send_raw_request(xml)
-      sock = TCPSocket.new(@hostname, @port)
-
-      ctx = OpenSSL::SSL::SSLContext.new(:TLSv1)
-      ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      ssl_sock = OpenSSL::SSL::SSLSocket.new(sock, ctx)
-      ssl_sock.sync_close = true
-
-      @log.info("Connecting to #{@hostname}:#{@port}")
-      ssl_sock.connect
-      @log.debug("Request:\n#{xml}")
-      ssl_sock.puts("#{xml}\r\n")
-      response = ""
-      while line = ssl_sock.gets
-        response += line
-      end
-      ssl_sock.close
-
-      response
-    end
-
-    def parse_response(xml, command)
-      @log.debug("Response:\n#{xml}")
-
-      # ILO sends back multiple XML documents, split by XML header and remove first (empty)
-      messages = xml.split(/<\?xml.*?\?>\r?\n/).drop(1)
-
-      output = {}
-
-      messages.each do |doc|
-        xml_doc = Nokogiri::XML(doc){|cfg| cfg.nonet.noblanks}
-
-        xml_doc.root.children.each do |node|
-          case node.name
-          when "RESPONSE"
-            code = node.attr("STATUS").to_i(16)
-            message = node.attr("MESSAGE")
-            if code == 0
-              output[:status] = { :code => code, :message => message }
-            else
-              output[:status] = { :code => code, :message => message }
-              @log.error("#{message} (#{code})")
-              break
-            end
-          when "INFORM"
-            # OSEF
-          else # actual result
-            output.merge!(@nori.parse(node.to_s))
-          end
-        end
-      end
-
-      output
-    end
-
-    def ribcl_request(command, args = {}, &block)
-      builder = Nokogiri::XML::Builder.new do |xml|
-        xml.ribcl(:version => "2.0") {
-          xml.login(:password => @password, :user_login => @login) {
-            xml.send(command.context, :mode => command.mode) {
-              xml.send(command.name, args) {
-                yield xml if block_given?
-              }
-            }
-          }
-        }
-      end
-
-      builder.to_xml
-    end
-
-    def setup_commands
-      @ribcl = ILORb::RIBCL.load(File.join(File.dirname(__FILE__), "definitions", "*.rb"))
-      nil
-    end
-
-    def error(message)
-      @log.error(message)
-      raise message
-    end
-  end
-end