idrac 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e41b7b9b93deb9e404e63931d7923fcbbbe93ab9fa800f75ae67f7c0e584fe3
-  data.tar.gz: d082799ca43c5d5f84b781e8b1ac2f89600f9c781b8cc3977645e0052d2e609d
+  metadata.gz: 64086a691b3fd5b5811d7d69d40697a72cf7467b6162e3a83fd0eb717f040005
+  data.tar.gz: a7449f049f549858c740dc59ca3c931a3c670c4a99142ef808cec85f29d12e56
 SHA512:
-  metadata.gz: 9a4d52657ed48583f0721dd84b3ef30e08184b613368b511dbabf61242811ef86cf3e3d37e3caf6e49db0ee63a963eac8f6ce692e566223851b9806f469817e8
-  data.tar.gz: 8bea1a7c91c8404b6292688410b9c01e0d894295b4ae44318d452498e01dff5f168b76605a3b40eb2c535b41b3a1e9d5f13c2b8af26bbfbfc61f4f1a31f0818a
+  metadata.gz: 13ddf72ffd57083293314dc546ba68b0e0a70c506fa8c9385d5c37a41301aaa2adf4f7c010c49777cca489e71abba4847f23c026c56373f0ee928e4f2c5c50ae
+  data.tar.gz: c2cb2c1396a8f78e7cb6ed5d9921777a090331c8a5ac24b09169af945b9610d852cc55b7156c2e01298440e1d66587abbf18b0c5977b403decbfe784159e0231

data/Rakefile

@@ -6,3 +6,12 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+# Add a task that tags and pushes to the repository and builds 
+# the gem and pushes it to rubygems.org.
+# Depend on the build task to ensure the gem is up to date.
+task :release => [:build] do
+  system "git tag v#{Idrac::VERSION}"
+  system "git push origin v#{Idrac::VERSION}"
+  system "gem push pkg/idrac-#{Idrac::VERSION}.gem"
+end

data/lib/idrac/client.rb

@@ -0,0 +1,48 @@
+module Idrac
+  class Client
+    def initialize(url:)
+      @url = url
+      @cookies = nil
+    end
+
+    def login(user: 'root', password: 'calvin')
+      login_response = HTTParty.post(
+        "#{@url}/data/login",
+        body: { user: user, password: password },
+        headers: {
+          "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"
+        },
+        verify: false
+      )
+      @cookies = login_response.headers['set-cookie']
+      xml_doc = Nokogiri::XML(login_response.body)
+
+      # Extract the forwardUrl from the XML
+      error_message = xml_doc.at_xpath('//errorMsg')&.text
+      # Error Message: The maximum number of user sessions has been reached!
+      if error_message && !error_message.empty?
+        raise "Error Message: #{error_message}"
+      end
+      forward_url = xml_doc.xpath('//forwardUrl').text
+    end
+
+    def logout
+      path = "data/logout"
+      res = get(path: path)
+      raise "Invalid login." unless res.code.between?(200, 299)
+    end
+      
+    def get(path:, headers: {})
+      response = HTTParty.get(
+        "#{@url}/#{path}",
+        headers: {
+          "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",
+          "Cookie" => @cookies
+        }.merge(headers),
+        verify: false
+      )
+    end
+  end
+end

data/lib/idrac/screenshot.rb

@@ -0,0 +1,24 @@
+module Idrac
+  # Reverse engineered the screenshot functionality in iDRAC 2.X
+  # Emulates the manual screenshot functionality in the web UI.
+  class Client
+    def screenshot
+      forward_url = login
+      # Extract the key-value pairs from the forward URL
+      # index?ST1=ABC,ST2=DEF
+      tokens = forward_url.split("?").last.split(",").inject({}) { |acc,kv| k,v = kv.split("="); acc[k]=v; acc }
+      timestamp_ms = (Time.now.to_f * 1000).to_i
+      path = "data?get=consolepreview[manual%20#{timestamp_ms}]"
+      res = get(path: path, headers: tokens)
+      raise "Invalid login." unless res.code.between?(200, 299)
+      sleep 2
+      path = "capconsole/scapture0.png?#{timestamp_ms}"
+      res = get(path: path, headers: tokens)
+      raise "Invalid login." unless res.code.between?(200, 299)
+      filename = "#{timestamp_ms}.png"
+      File.open(filename, "wb") { |f| f.write(res.body) }
+      logout
+      filename
+    end
+  end
+end

data/lib/idrac/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Idrac
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/idrac.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
+require 'httparty'
+require 'nokogiri'
+# If dev, required debug
+require 'debug' if ENV['RUBY_ENV'] == 'development'
+
 require_relative "idrac/version"
+require_relative "idrac/client"
+require_relative "idrac/screenshot"
 
 module Idrac
   class Error < StandardError; end
   # Your code goes here...
+  def self.new(url:)
+    Client.new(url:)
+  end
 end

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Jonathan Siegel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
-dependencies: []
+date: 2024-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: debug
+  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 Ruby client for the Dell iDRAC API
 email:
 - "<248302+usiegj00@users.noreply.github.com>"
@@ -20,8 +104,9 @@ files:
 - ".rspec"
 - README.md
 - Rakefile
-- idrac.gemspec
 - lib/idrac.rb
+- lib/idrac/client.rb
+- lib/idrac/screenshot.rb
 - lib/idrac/version.rb
 - sig/idrac.rbs
 homepage: http://github.com

data/idrac.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/idrac/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "idrac"
-  spec.version = Idrac::VERSION
-  spec.authors = ["Jonathan Siegel"]
-  spec.email = ["<248302+usiegj00@users.noreply.github.com>"]
-
-  spec.summary = "API Client for Dell iDRAC"
-  spec.description = "A Ruby client for the Dell iDRAC API"
-  spec.homepage = "http://github.com"
-  spec.required_ruby_version = ">= 3.3.0" # Feel free to test and update.
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end