idrac 0.1.38 → 0.1.41

data/lib/idrac/version.rb

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

data/lib/idrac/web.rb

@@ -0,0 +1,187 @@
+require 'httparty'
+require 'nokogiri'
+require 'uri'
+require 'colorize'
+
+module IDRAC
+  class Web
+    attr_reader :client, :session_id, :cookies
+
+    def initialize(client)
+      @client = client
+      @session_id = nil
+      @cookies = nil
+      @tried_clearing_sessions = false
+    end
+
+    # Login to the WebUI
+    def login(retry_count = 0)
+      # Limit retries to prevent infinite loops
+      if retry_count >= 3
+        puts "Maximum retry count reached for WebUI login".red
+        return false
+      end
+      
+      # Skip if we already have a session ID
+      return true if @session_id
+      
+      begin
+        puts "Logging in to WebUI...".light_cyan
+        
+        # Create the login URL
+        login_url = "#{base_url}/data/login"
+        
+        # Create the login payload
+        payload = {
+          'user' => client.username,
+          'password' => client.password
+        }
+        
+        # Make the login request
+        response = HTTParty.post(
+          login_url,
+          body: payload,
+          verify: client.verify_ssl,
+          headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        )
+        
+        # Check if the login was successful
+        if response.code == 200
+          # Extract the session ID from the response
+          if response.body.include?('ST2')
+            @session_id = response.body.match(/ST2=([^;]+)/)[1]
+            @cookies = response.headers['set-cookie']
+            puts "WebUI login successful".green
+            return response.body
+          else
+            puts "WebUI login failed: No session ID found in response".red
+            return false
+          end
+        elsif response.code == 400 && response.body.include?("maximum number of user sessions")
+          puts "Maximum sessions reached during WebUI login".light_red
+          
+          # Try to clear sessions if auto_delete_sessions is enabled
+          if client.auto_delete_sessions && !@tried_clearing_sessions
+            puts "Auto-delete sessions is enabled, attempting to clear sessions".light_cyan
+            @tried_clearing_sessions = true
+            
+            if client.session.force_clear_sessions
+              puts "Successfully cleared sessions, trying WebUI login again".green
+              return login(retry_count + 1)
+            else
+              puts "Failed to clear sessions for WebUI login".red
+              return false
+            end
+          else
+            puts "Auto-delete sessions is disabled or already tried clearing".light_yellow
+            return false
+          end
+        else
+          puts "WebUI login failed: #{response.code} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during WebUI login: #{e.message}".red.bold
+        return false
+      end
+    end
+
+    # Logout from the WebUI
+    def logout
+      return unless @session_id
+      
+      begin
+        puts "Logging out from WebUI...".light_cyan
+        
+        # Create the logout URL
+        logout_url = "#{base_url}/data/logout"
+        
+        # Make the logout request
+        response = HTTParty.get(
+          logout_url,
+          verify: client.verify_ssl,
+          headers: { 'Cookie' => @cookies }
+        )
+        
+        # Check if the logout was successful
+        if response.code == 200
+          puts "WebUI logout successful".green
+          @session_id = nil
+          @cookies = nil
+          return true
+        else
+          puts "WebUI logout failed: #{response.code} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during WebUI logout: #{e.message}".red.bold
+        return false
+      end
+    end
+
+    # Capture a screenshot
+    def capture_screenshot
+      # Login to get the forward URL and cookies
+      forward_url = login
+      return nil unless forward_url
+      
+      # Extract the key-value pairs from the forward URL (format: index?ST1=ABC,ST2=DEF)
+      tokens = forward_url.split("?").last.split(",").inject({}) do |acc, kv| 
+        k, v = kv.split("=")
+        acc[k] = v
+        acc
+      end
+      
+      # Generate a timestamp for the request
+      timestamp_ms = (Time.now.to_f * 1000).to_i
+      
+      # First request to trigger the screenshot capture
+      path = "data?get=consolepreview[manual%20#{timestamp_ms}]"
+      res = get(path: path, headers: tokens)
+      raise Error, "Failed to trigger screenshot capture." unless res.code.between?(200, 299)
+      
+      # Wait for the screenshot to be generated
+      sleep 2
+      
+      # Second request to get the actual screenshot image
+      path = "capconsole/scapture0.png?#{timestamp_ms}"
+      res = get(path: path, headers: tokens)
+      raise Error, "Failed to retrieve screenshot image." unless res.code.between?(200, 299)
+      
+      # Save the screenshot to a file
+      filename = "idrac_screenshot_#{timestamp_ms}.png"
+      File.open(filename, "wb") { |f| f.write(res.body) }
+      
+      # Return the filename
+      filename
+    end
+
+    # HTTP GET request for WebUI operations
+    def get(path:, headers: {})
+      headers_to_use = {
+        "User-Agent" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
+        "Accept-Encoding" => "deflate, gzip"
+      }
+      
+      if @cookies
+        headers_to_use["Cookie"] = @cookies
+      elsif client.direct_mode
+        # In direct mode, use Basic Auth
+        headers_to_use["Authorization"] = "Basic #{Base64.strict_encode64("#{client.username}:#{client.password}")}"
+      end
+      
+      HTTParty.get(
+        "#{base_url}/#{path}",
+        headers: headers_to_use.merge(headers),
+        verify: false
+      )
+    end
+
+    private
+
+    def base_url
+      protocol = client.use_ssl ? 'https' : 'http'
+      "#{protocol}://#{client.host}:#{client.port}"
+    end
+  end
+end 

data/lib/idrac.rb

@@ -10,17 +10,39 @@ require 'colorize'
 # If dev, required debug
 require 'debug' if ENV['RUBY_ENV'] == 'development'
 
-require_relative "idrac/version"
-require_relative "idrac/error"
-require_relative "idrac/client"
-require_relative "idrac/screenshot"
-require_relative "idrac/firmware"
-require_relative "idrac/firmware_catalog"
-
 module IDRAC
+  # Provides debugging functionality to IDRAC classes
+  module Debuggable
+    # Debug output helper - only outputs if verbosity level is high enough
+    def debug(message, level = 0, color = :light_cyan)
+      return unless respond_to?(:verbosity) && verbosity >= level
+      color_method = color.is_a?(Symbol) && String.method_defined?(color) ? color : :to_s
+      puts message.send(color_method)
+      
+      # For highest verbosity, also print stack trace
+      if respond_to?(:verbosity) && verbosity >= 3 && caller.length > 1
+        puts "  Called from:".light_yellow
+        caller[1..3].each do |call|
+          puts "    #{call}".light_yellow
+        end
+      end
+    end
+  end
+
   class Error < StandardError; end
   
   def self.new(options = {})
     Client.new(options)
   end
 end
+
+require_relative "idrac/version"
+require_relative "idrac/error"
+require_relative "idrac/session"
+require_relative "idrac/web"
+require_relative "idrac/power"
+require_relative "idrac/jobs"
+require_relative "idrac/lifecycle"
+require_relative "idrac/client"
+require_relative "idrac/firmware"
+require_relative "idrac/firmware_catalog"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.1.38
+  version: 0.1.41
 platform: ruby
 authors:
 - Jonathan Siegel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-02 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -224,8 +224,12 @@ files:
 - lib/idrac/error.rb
 - lib/idrac/firmware.rb
 - lib/idrac/firmware_catalog.rb
-- lib/idrac/screenshot.rb
+- lib/idrac/jobs.rb
+- lib/idrac/lifecycle.rb
+- lib/idrac/power.rb
+- lib/idrac/session.rb
 - lib/idrac/version.rb
+- lib/idrac/web.rb
 homepage: http://github.com
 licenses:
 - MIT
@@ -246,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: API Client for Dell iDRAC

data/lib/idrac/screenshot.rb

@@ -1,49 +0,0 @@
-require 'httparty'
-require 'nokogiri'
-
-module IDRAC
-  # Reverse engineered screenshot functionality for iDRAC
-  # This uses introspection on how the web UI creates screenshots rather than the Redfish API
-  class Screenshot
-    attr_reader :client
-
-    def initialize(client)
-      @client = client
-    end
-
-    def capture
-      # Login to get the forward URL and cookies
-      forward_url = client.login
-      
-      # Extract the key-value pairs from the forward URL (format: index?ST1=ABC,ST2=DEF)
-      tokens = forward_url.split("?").last.split(",").inject({}) do |acc, kv| 
-        k, v = kv.split("=")
-        acc[k] = v
-        acc
-      end
-      
-      # Generate a timestamp for the request
-      timestamp_ms = (Time.now.to_f * 1000).to_i
-      
-      # First request to trigger the screenshot capture
-      path = "data?get=consolepreview[manual%20#{timestamp_ms}]"
-      res = client.get(path: path, headers: tokens)
-      raise Error, "Failed to trigger screenshot capture." unless res.code.between?(200, 299)
-      
-      # Wait for the screenshot to be generated
-      sleep 2
-      
-      # Second request to get the actual screenshot image
-      path = "capconsole/scapture0.png?#{timestamp_ms}"
-      res = client.get(path: path, headers: tokens)
-      raise Error, "Failed to retrieve screenshot image." unless res.code.between?(200, 299)
-      
-      # Save the screenshot to a file
-      filename = "idrac_screenshot_#{timestamp_ms}.png"
-      File.open(filename, "wb") { |f| f.write(res.body) }
-      
-      # Return the filename
-      filename
-    end
-  end
-end