idrac 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c859d5dbe93470744821ac95422ad8e4a1ac065a0bf643b7c6a717b8488da996
-  data.tar.gz: '019a9d9999f1fa8d5c0e1c88783e7ccbf9d8f10b6a32cc11bd38c83a94e5815e'
+  metadata.gz: 04a47e02d37a42167e7007aa92fc8f1d1b4023a52d44bb65ed1132a2035c110a
+  data.tar.gz: d17c640f8c8c238a6ea6aa4c037f39d2a9c2bfeaaebc478b1a464c75a648bbc4
 SHA512:
-  metadata.gz: 483e33a17932027f62dc688b6e9c101f337d9b25cebdaa0e6c150072d934b3950c39c43ff8cab5cc9532c34765d0740ba26ecfbe4a5a3f34a35c96888386495f
-  data.tar.gz: 79c1135bd0ecb5be85fbc746bd20862203b01b0b8d75a2e3444f7496850b870c3b467a5dfe00e77d8c84cd8aae2a0250db916c166a7c3eec6753667eb95bfe98
+  metadata.gz: a64a9f69bf757578c9d3fb6d95aeb54b33b4a6604ba432a0b52cdca1e0fdbb2451b19191e2ebbe2468a025648a985a8e5122559f04063db7be8fb20b9a997759
+  data.tar.gz: 867beff66c1896abe949e87bf65b0c5df5ce65bda9d5e443f31a490792db7a63c737fe1295ea7a85c70a4f43af01ee1d6cc545b43939b581b76ade5b6cd641d1

data/lib/idrac/client.rb

@@ -286,6 +286,16 @@ module IDRAC
       web.capture_screenshot
     end
 
+    # Parse JSON string and convert to OpenStruct
+    # @param json [String] JSON string
+    # @param use_ostruct [Boolean] Whether to convert to OpenStruct (default: true)
+    # @return [OpenStruct, Hash] Parsed response
+    def parse_json(json, use_ostruct = true)
+      parsed = JSON.parse(json)
+      use_ostruct ? IDRAC::Util.to_ostruct(parsed) : parsed
+    end
+    
+    # Kept for backward compatibility 
     def base_url
       protocol = use_ssl ? 'https' : 'http'
       "#{protocol}://#{host}:#{port}"
@@ -294,8 +304,8 @@ module IDRAC
     def redfish_version
       response = authenticated_request(:get, "/redfish/v1")
       if response.status == 200
-        data = JSON.parse(response.body)
-        data["RedfishVersion"]
+        data = parse_json(response.body)
+        data.RedfishVersion
       else
         raise Error, "Failed to get Redfish version: #{response.status} - #{response.body}"
       end

data/lib/idrac/power.rb

@@ -30,9 +30,9 @@ module IDRAC
           break
         when 409
           begin
-            error_data = JSON.parse(response.body)
-            if error_data["error"] && error_data["error"]["@Message.ExtendedInfo"] &&
-               error_data["error"]["@Message.ExtendedInfo"].any? { |m| m["Message"] =~ /Server is already powered ON/ }
+            error_data = parse_json(response.body)
+            if error_data.error && error_data.error['@Message.ExtendedInfo'] &&
+               error_data.error['@Message.ExtendedInfo'].any? { |m| m.Message =~ /Server is already powered ON/ }
               puts "Server is already powered ON.".yellow
               return false
             else
@@ -84,9 +84,9 @@ module IDRAC
       when 409
         # Conflict -- Server is already off
         begin
-          error_data = JSON.parse(response.body)
-          if error_data["error"] && error_data["error"]["@Message.ExtendedInfo"] &&
-             error_data["error"]["@Message.ExtendedInfo"].any? { |m| m["Message"] =~ /Server is already powered OFF/ }
+          error_data = parse_json(response.body)
+          if error_data.error && error_data.error['@Message.ExtendedInfo'] &&
+             error_data.error['@Message.ExtendedInfo'].any? { |m| m.Message =~ /Server is already powered OFF/ }
             puts "Server is already powered OFF.".yellow
             return false
           else
@@ -98,8 +98,8 @@ module IDRAC
       else
         error_message = "Failed to power off server. Status code: #{response.status}"
         begin
-          error_data = JSON.parse(response.body)
-          error_message += ", Message: #{error_data['error']['message']}" if error_data['error'] && error_data['error']['message']
+          error_data = parse_json(response.body)
+          error_message += ", Message: #{error_data.error.message}" if error_data.error && error_data.error.message
         rescue
           # Ignore JSON parsing errors
         end
@@ -137,8 +137,8 @@ module IDRAC
       else
         error_message = "Failed to reboot server. Status code: #{response.status}"
         begin
-          error_data = JSON.parse(response.body)
-          error_message += ", Message: #{error_data['error']['message']}" if error_data['error'] && error_data['error']['message']
+          error_data = parse_json(response.body)
+          error_message += ", Message: #{error_data.error.message}" if error_data.error && error_data.error.message
         rescue
           # Ignore JSON parsing errors
         end
@@ -156,8 +156,8 @@ module IDRAC
       
       if response.status == 200
         begin
-          system_data = JSON.parse(response.body)
-          return system_data["PowerState"]
+          system_data = parse_json(response.body)
+          return system_data.PowerState
         rescue JSON::ParserError
           raise Error, "Failed to parse power state response: #{response.body}"
         end
@@ -174,8 +174,8 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
-          watts = data["PowerControl"][0]["PowerConsumedWatts"]
+          data = parse_json(response.body)
+          watts = data.PowerControl[0].PowerConsumedWatts
           # puts "Power usage: #{watts} watts".light_cyan
           return watts.to_f
         rescue JSON::ParserError
@@ -184,8 +184,8 @@ module IDRAC
       else
         error_message = "Failed to get power usage. Status code: #{response.status}"
         begin
-          error_data = JSON.parse(response.body)
-          error_message += ", Message: #{error_data['error']['message']}" if error_data['error'] && error_data['error']['message']
+          error_data = parse_json(response.body)
+          error_message += ", Message: #{error_data.error.message}" if error_data.error && error_data.error.message
         rescue
           # Ignore JSON parsing errors
         end

data/lib/idrac/system.rb

@@ -9,21 +9,21 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
-          memory = data["Members"].map do |m|
-            dimm_name = m["Name"] # e.g. DIMM A1
+          data = parse_json(response.body)
+          memory = data.Members.map do |m|
+            dimm_name = m.Name # e.g. DIMM A1
             bank, index = /DIMM ([A-Z])(\d+)/.match(dimm_name).captures rescue [nil, nil]
             
-            puts "DIMM: #{m["Model"]} #{m["Name"]} > #{m["CapacityMiB"]}MiB > #{m["Status"]["Health"]} > #{m["OperatingSpeedMhz"]}MHz > #{m["PartNumber"]} / #{m["SerialNumber"]}"
+            puts "DIMM: #{m.Model} #{m.Name} > #{m.CapacityMiB}MiB > #{m.Status.Health} > #{m.OperatingSpeedMhz}MHz > #{m.PartNumber} / #{m.SerialNumber}"
             
             { 
-              "model" => m["Model"], 
-              "name" => m["Name"], 
-              "capacity_bytes" => m["CapacityMiB"].to_i.megabyte, 
-              "health" => m["Status"]["Health"] ? m["Status"]["Health"] : "N/A", 
-              "speed_mhz" => m["OperatingSpeedMhz"], 
-              "part_number" => m["PartNumber"], 
-              "serial" => m["SerialNumber"],
+              "model" => m.Model, 
+              "name" => m.Name, 
+              "capacity_bytes" => m.CapacityMiB.to_i.megabyte, 
+              "health" => m.Status.Health ? m.Status.Health : "N/A", 
+              "speed_mhz" => m.OperatingSpeedMhz, 
+              "part_number" => m.PartNumber, 
+              "serial" => m.SerialNumber,
               "bank" => bank,
               "index" => index.to_i
             }
@@ -44,20 +44,20 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
+          data = parse_json(response.body)
           puts "Power Supplies".green
           
-          psus = data["PowerSupplies"].map do |psu|
-            puts "PSU: #{psu["Name"]} > #{psu["PowerInputWatts"]}W > #{psu["Status"]["Health"]}"
+          psus = data.PowerSupplies.map do |psu|
+            puts "PSU: #{psu.Name} > #{psu.PowerInputWatts}W > #{psu.Status.Health}"
             { 
-              "name" => psu["Name"], 
-              "voltage" => psu["LineInputVoltage"], 
-              "voltage_human" => psu["LineInputVoltageType"], # AC240V
-              "watts"  => psu["PowerInputWatts"],
-              "part"   => psu["PartNumber"],
-              "model"  => psu["Model"],
-              "serial" => psu["SerialNumber"],
-              "status" => psu["Status"]["Health"],
+              "name" => psu.Name, 
+              "voltage" => psu.LineInputVoltage, 
+              "voltage_human" => psu.LineInputVoltageType, # AC240V
+              "watts"  => psu.PowerInputWatts,
+              "part"   => psu.PartNumber,
+              "model"  => psu.Model,
+              "serial" => psu.SerialNumber,
+              "status" => psu.Status.Health,
             }
           end
           
@@ -80,15 +80,15 @@ module IDRAC
           response = authenticated_request(:get, "/redfish/v1/Chassis/System.Embedded.1/Thermal?$expand=*($levels=1)")
           
           if response.status == 200
-            data = JSON.parse(response.body)
+            data = parse_json(response.body)
             
-            fans = data["Fans"].map do |fan|
-              puts "Fan: #{fan["Name"]} > #{fan["Reading"]} > #{fan["Status"]["Health"]}"
+            fans = data.Fans.map do |fan|
+              puts "Fan: #{fan.Name} > #{fan.Reading} > #{fan.Status.Health}"
               { 
-                "name" => fan["Name"], 
-                "rpm" => fan["Reading"],
-                "serial" => fan["SerialNumber"],
-                "status" => fan["Status"]["Health"]
+                "name" => fan.Name, 
+                "rpm" => fan.Reading,
+                "serial" => fan.SerialNumber,
+                "status" => fan.Status.Health
               }
             end
             
@@ -96,7 +96,7 @@ module IDRAC
           elsif response.status.between?(400, 499)
             # Check if system is powered off
             power_response = authenticated_request(:get, "/redfish/v1/Systems/System.Embedded.1?$select=PowerState")
-            if power_response.status == 200 && JSON.parse(power_response.body)["PowerState"] == "Off"
+            if power_response.status == 200 && parse_json(power_response.body).PowerState == "Off"
               puts "WARN: System is off. Fans are not available.".yellow
               return []
             end
@@ -120,12 +120,12 @@ module IDRAC
       
       if response.status == 200
         begin
-          adapters_data = JSON.parse(response.body)
+          adapters_data = parse_json(response.body)
           
           # Determine iDRAC version for different port paths
           idrac_version_response = authenticated_request(:get, "/redfish/v1")
-          idrac_version_data = JSON.parse(idrac_version_response.body)
-          server = idrac_version_data["RedfishVersion"] || idrac_version_response.headers["server"]
+          idrac_version_data = parse_json(idrac_version_response.body)
+          server = idrac_version_data.RedfishVersion || idrac_version_response.headers["server"]
           
           is_idrac9 = case server.to_s.downcase
                       when /idrac\/9/
@@ -141,32 +141,32 @@ module IDRAC
           
           port_part = is_idrac9 ? 'Ports' : 'NetworkPorts'
           
-          nics = adapters_data["Members"].map do |adapter|
-            path = "#{adapter["@odata.id"].split("v1/").last}/#{port_part}?$expand=*($levels=1)"
+          nics = adapters_data.Members.map do |adapter|
+            path = "#{adapter['@odata.id'].split("v1/").last}/#{port_part}?$expand=*($levels=1)"
             ports_response = authenticated_request(:get, "/redfish/v1/#{path}")
             
             if ports_response.status == 200
-              ports_data = JSON.parse(ports_response.body)
+              ports_data = parse_json(ports_response.body)
               
-              ports = ports_data["Members"].map do |nic|
+              ports = ports_data.Members.map do |nic|
                 if is_idrac9
-                  link_speed_mbps = nic['CurrentSpeedGbps'].to_i * 1000
-                  mac_addr = nic['Ethernet']['AssociatedMACAddresses'].first
-                  port_num = nic['PortId']
-                  network_technology = nic['LinkNetworkTechnology']
-                  link_status = nic['LinkStatus'] =~ /up/i ? "Up" : "Down"
+                  link_speed_mbps = nic.CurrentSpeedGbps.to_i * 1000
+                  mac_addr = nic.Ethernet.AssociatedMACAddresses.first
+                  port_num = nic.PortId
+                  network_technology = nic.LinkNetworkTechnology
+                  link_status = nic.LinkStatus =~ /up/i ? "Up" : "Down"
                 else # iDRAC 8
-                  link_speed_mbps = nic["SupportedLinkCapabilities"].first["LinkSpeedMbps"]
-                  mac_addr = nic["AssociatedNetworkAddresses"].first
-                  port_num = nic["PhysicalPortNumber"]
-                  network_technology = nic["SupportedLinkCapabilities"].first["LinkNetworkTechnology"]
-                  link_status = nic['LinkStatus']
+                  link_speed_mbps = nic.SupportedLinkCapabilities.first.LinkSpeedMbps
+                  mac_addr = nic.AssociatedNetworkAddresses.first
+                  port_num = nic.PhysicalPortNumber
+                  network_technology = nic.SupportedLinkCapabilities.first.LinkNetworkTechnology
+                  link_status = nic.LinkStatus
                 end
                 
-                puts "NIC: #{nic["Id"]} > #{mac_addr} > #{link_status} > #{port_num} > #{link_speed_mbps}Mbps"
+                puts "NIC: #{nic.Id} > #{mac_addr} > #{link_status} > #{port_num} > #{link_speed_mbps}Mbps"
                 
                 { 
-                  "name" => nic["Id"], 
+                  "name" => nic.Id, 
                   "status" => link_status,
                   "mac" => mac_addr,
                   "port" => port_num,
@@ -176,21 +176,21 @@ module IDRAC
               end
               
               {
-                "name" => adapter["Id"],
-                "manufacturer" => adapter["Manufacturer"],
-                "model" => adapter["Model"],
-                "part_number" => adapter["PartNumber"],
-                "serial" => adapter["SerialNumber"],
+                "name" => adapter.Id,
+                "manufacturer" => adapter.Manufacturer,
+                "model" => adapter.Model,
+                "part_number" => adapter.PartNumber,
+                "serial" => adapter.SerialNumber,
                 "ports" => ports
               }
             else
               # Return adapter info without ports if we can't get port details
               {
-                "name" => adapter["Id"],
-                "manufacturer" => adapter["Manufacturer"],
-                "model" => adapter["Model"],
-                "part_number" => adapter["PartNumber"],
-                "serial" => adapter["SerialNumber"],
+                "name" => adapter.Id,
+                "manufacturer" => adapter.Manufacturer,
+                "model" => adapter.Model,
+                "part_number" => adapter.PartNumber,
+                "serial" => adapter.SerialNumber,
                 "ports" => []
               }
             end
@@ -211,17 +211,17 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
+          data = parse_json(response.body)
           
           idrac = {
-            "name" => data["Id"],
-            "status" => data["Status"]["Health"] == 'OK' ? 'Up' : 'Down',
-            "mac" => data["MACAddress"],
-            "mask" => data["IPv4Addresses"].first["SubnetMask"],
-            "ipv4" => data["IPv4Addresses"].first["Address"],
-            "origin" => data["IPv4Addresses"].first["AddressOrigin"], # DHCP or Static
+            "name" => data.Id,
+            "status" => data.Status.Health == 'OK' ? 'Up' : 'Down',
+            "mac" => data.MACAddress,
+            "mask" => data.IPv4Addresses.first.SubnetMask,
+            "ipv4" => data.IPv4Addresses.first.Address,
+            "origin" => data.IPv4Addresses.first.AddressOrigin, # DHCP or Static
             "port" => nil,
-            "speed_mbps" => data["SpeedMbps"],
+            "speed_mbps" => data.SpeedMbps,
             "kind" => "ethernet"
           }
           
@@ -240,32 +240,32 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
+          data = parse_json(response.body)
           
-          pci = data["Members"].map do |stub|
-            manufacturer = stub["Manufacturer"]
+          pci = data.Members.map do |stub|
+            manufacturer = stub.Manufacturer
             
             # Get PCIe function details if available
             pcie_function = nil
-            if stub.dig("Links", "PCIeFunctions", 0, "@odata.id")
-              pcie_function_path = stub.dig("Links", "PCIeFunctions", 0, "@odata.id").split("v1/").last
+            if stub.dig(:Links, :PCIeFunctions, 0, :'@odata.id')
+              pcie_function_path = stub.dig(:Links, :PCIeFunctions, 0, :'@odata.id').split("v1/").last
               function_response = authenticated_request(:get, "/redfish/v1/#{pcie_function_path}")
               
               if function_response.status == 200
-                pcie_function = JSON.parse(function_response.body)
+                pcie_function = parse_json(function_response.body)
               end
             end
             
             # Create device info with available data
             device_info = {
-              device_class: pcie_function ? pcie_function["DeviceClass"] : nil,
+              device_class: pcie_function ? pcie_function.DeviceClass : nil,
               manufacturer: manufacturer,
-              name: stub["Name"],
-              description: stub["Description"],
-              id: pcie_function ? pcie_function["Id"] : stub["Id"],
-              slot_type: pcie_function ? pcie_function.dig("Oem", "Dell", "DellPCIeFunction", "SlotType") : nil,
-              bus_width: pcie_function ? pcie_function.dig("Oem", "Dell", "DellPCIeFunction", "DataBusWidth") : nil,
-              nic: pcie_function ? pcie_function.dig("Links", "EthernetInterfaces", 0, "@odata.id") : nil
+              name: stub.Name,
+              description: stub.Description,
+              id: pcie_function ? pcie_function.Id : stub.Id,
+              slot_type: pcie_function ? pcie_function.dig(:Oem, :Dell, :DellPCIeFunction, :SlotType) : nil,
+              bus_width: pcie_function ? pcie_function.dig(:Oem, :Dell, :DellPCIeFunction, :DataBusWidth) : nil,
+              nic: pcie_function ? pcie_function.dig(:Links, :EthernetInterfaces, 0, :'@odata.id') : nil
             }
             
             puts "PCI Device: #{device_info[:name]} > #{device_info[:manufacturer]} > #{device_info[:device_class]} > #{device_info[:description]} > #{device_info[:id]}"
@@ -331,15 +331,15 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
+          data = parse_json(response.body)
           
-          logs = data["Members"].map do |log|
-            puts "#{log['Id']} : #{log['Created']} : #{log['Message']} : #{log['Severity']}".yellow
+          logs = data.Members.map do |log|
+            puts "#{log.Id} : #{log.Created} : #{log.Message} : #{log.Severity}".yellow
             log
           end
           
           # Sort by creation date, newest first
-          return logs.sort_by { |log| log['Created'] }.reverse
+          return logs.sort_by { |log| log.Created }.reverse
         rescue JSON::ParserError
           raise Error, "Failed to parse system event logs response: #{response.body}"
         end
@@ -364,7 +364,7 @@ module IDRAC
         error_message = "Failed to clear System Event Logs. Status code: #{response.status}"
         
         begin
-          error_data = JSON.parse(response.body)
+          error_data = parse_json(response.body, false)
           error_message += ", Message: #{error_data['error']['message']}" if error_data['error'] && error_data['error']['message']
         rescue
           # Ignore JSON parsing errors

data/lib/idrac/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IDRAC
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/idrac/virtual_media.rb

@@ -9,31 +9,25 @@ module IDRAC
       
       if response.status == 200
         begin
-          data = JSON.parse(response.body)
+          data = parse_json(response.body)
           
-          media = data["Members"].map do |m|
-            if m["Inserted"]
-              puts "#{m["Name"]} #{m["ConnectedVia"]} #{m["Image"]}".green
-            else
-              puts "#{m["Name"]} #{m["ConnectedVia"]}".yellow
-            end
-            
-            action_path = m.dig("Actions", "#VirtualMedia.InsertMedia", "target")
-            
-            { 
-              device: m["Id"], 
-              inserted: m["Inserted"], 
-              image: m["Image"] || m["ConnectedVia"],
-              action_path: action_path
+          media = data.Members.map do |m|
+            {
+              "id" => m.Id,
+              "name" => m.Name,
+              "media_types" => m.MediaTypes,
+              "connected" => m.Inserted,
+              "image" => m.Image,
+              "write_protected" => m.WriteProtected
             }
           end
           
           return media
-        rescue JSON::ParserError
-          raise Error, "Failed to parse virtual media response: #{response.body}"
+        rescue => e
+          raise Error, "Failed to get virtual media status: #{e.message}"
         end
       else
-        raise Error, "Failed to get virtual media. Status code: #{response.status}"
+        raise Error, "Failed to get virtual media status. Status code: #{response.status}"
       end
     end
 

data/lib/idrac.rb

@@ -7,6 +7,7 @@ require 'faraday/multipart'
 require 'base64'
 require 'uri'
 require 'colorize'
+require 'ostruct'
 # If dev, required debug
 require 'debug' if ENV['RUBY_ENV'] == 'development'
 
@@ -29,6 +30,23 @@ module IDRAC
     end
   end
 
+  # Utility methods for the IDRAC module
+  module Util
+    # Recursively converts a hash to an OpenStruct
+    # @param obj [Hash, Array, Object] The object to convert
+    # @return [OpenStruct, Array, Object] The converted object
+    def self.to_ostruct(obj)
+      case obj
+      when Hash
+        OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+      when Array
+        obj.map { |item| to_ostruct(item) }
+      else
+        obj
+      end
+    end
+  end
+
   class Error < StandardError; end
   
   def self.new(options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Jonathan Siegel