proxmox-sdk 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18becda6b3edf4aba2a1146a3f889e618c9c49ad9d476f45197b63bae0930f5e
-  data.tar.gz: bc2b3f12e06eb9ef9941acf1035a81bdad3be29627fbdec33ee520e374ddb221
+  metadata.gz: f7c0b67d16c5998e774ca622ca64f157b586080e958323c97d10225595a3372f
+  data.tar.gz: c2ced47a6a4c274adf06a69b728b2c5c175b964696d7f2984927376502390c2c
 SHA512:
-  metadata.gz: 4aa011f0cb9ea2ca0694a095e549a410f572cd96325d3cf4886bc1a9ba80536e8d4f64ea9005bdf9836368c2b8a5c823e8d28cc81da77601958a96cd27132865
-  data.tar.gz: 3628b92158ebb7288bdd9f231e9db71eb180789df6e36fc7faa69d744b41bcde25535efc90bec9f0b48c1c959a5d9f0811a9aa54850a4a83ab75af6c4016ccb5
+  metadata.gz: d5157b2839030a07102344ff43188e6f4b54bcb2c631016bce6d373c45ebda9519447a4f80a6446bdf1e81d40e68b8c1129bd2208db19676221c566a4b846cec
+  data.tar.gz: fa53ebc0acac4c23b3cda3d6a4687bf8bbb67740ef32da50e4fd1e5c2626371daf5dab7aaf09b3000ce91416ad361ebf325d4b8a94644bfc80c524f861991cdc

data/README.md

@@ -1,5 +1,7 @@
 # Proxmox
 
+[![Gem Version](https://badge.fury.io/rb/proxmox-sdk.svg)](https://badge.fury.io/rb/proxmox-sdk)
+
 A lightweight Ruby gem that provides a clean, idiomatic interface to the Proxmox VE REST API. It handles authentication, token management, and all common API endpoints (nodes, virtual machines, storage, containers, etc.) so you can focus on building automation, orchestration, or custom tooling without dealing with raw HTTP calls.
 
 ## Installation

data/lib/proxmox/client.rb

@@ -1,27 +1,64 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "json"
+require "time"
 
 module Proxmox
   # Proxmox SDK Http Client
   class Client
+    # Konstanten für die Gültigkeit des Tokens
+    # Proxmox Tickets sind standardmäßig 2 Stunden (7200 Sekunden) gültig.
+    TOKEN_VALIDITY_SECONDS = 7200
+    # Wir erneuern den Token 5 Minuten (300 Sekunden) vor Ablauf.
+    RENEWAL_BUFFER_SECONDS = 300
+
     attr_reader :ticket, :csrf_token, :base_url
 
     def initialize(base_url:, username:, password:, realm: "pam", ignore_ssl: false)
       @base_url = base_url
       @verify_ssl = !ignore_ssl
-      login(username, password, realm)
+
+      # Anmeldedaten für die automatische Erneuerung speichern
+      @username = username
+      @password = password
+      @realm = realm
+
+      # Initiales Login
+      login
     end
 
-    def login(user, pass, realm)
+    def cluster
+      @cluster ||= Proxmox::Resources::Cluster.new(self)
+    end
+
+    def node(name)
+      Proxmox::Resources::Node.new(self, name)
+    end
+
+    def nodes
+      request(:get, "/nodes").map do |node_data|
+        Proxmox::Resources::Node.new(self, node_data)
+      end
+    end
+
+    def login
       resp = http.post("/api2/json/access/ticket",
-                       { username: "#{user}@#{realm}", password: pass })
+                       { username: "#{@username}@#{@realm}", password: @password })
+
+      raise "Login failed: #{resp.body}" unless resp.success?
+
       data = JSON.parse(resp.body)["data"]
-      @ticket     = data["ticket"]
+      @ticket = data["ticket"]
       @csrf_token = data["CSRFPreventionToken"]
+      # Zeitstempel der Ticketerstellung speichern
+      @ticket_creation_time = Time.now
     end
 
     def request(method, path, params = {}, body = nil)
+      # Vor jeder Anfrage die Gültigkeit des Tokens prüfen und ggf. erneuern
+      ensure_token_validity
+
       response = perform_http_call(method, path, params, body)
 
       ensure_success!(response)
@@ -30,6 +67,23 @@ module Proxmox
 
     private
 
+    # NEUE METHODE: Stellt sicher, dass der Token gültig ist
+    def ensure_token_validity
+      login if token_expired?
+    end
+
+    # NEUE METHODE: Prüft, ob der Token abgelaufen ist oder bald abläuft
+    def token_expired?
+      # Wenn noch kein Ticket erstellt wurde, nicht als abgelaufen betrachten
+      return false if @ticket_creation_time.nil?
+
+      # Berechne die Ablaufzeit (Erstellungszeit + Gültigkeit - Puffer)
+      renewal_time = @ticket_creation_time + TOKEN_VALIDITY_SECONDS - RENEWAL_BUFFER_SECONDS
+
+      # Ist die aktuelle Zeit nach der errechneten Erneuerungszeit?
+      Time.now > renewal_time
+    end
+
     def perform_http_call(method, path, params, body)
       http.send(method) do |req|
         set_url(req, path)
@@ -59,14 +113,22 @@ module Proxmox
     end
 
     def set_body(req, body)
-      req.body = body.to_json if body
+      req.body = body if body
     end
 
     def ensure_success!(response)
-      raise ApiError, response.body unless response.success?
+      # Optional: Wenn ein 401 (Unauthorized) Fehler kommt, könnte man hier auch ein erneutes Login erzwingen.
+      # if response.status == 401
+      #   login
+      #   # Hier könnte man die Anfrage wiederholen.
+      # end
+      raise "ApiError: #{response.body}" unless response.success?
     end
 
     def extract_data(response)
+      # Sicherstellen, dass der Body nicht leer ist, bevor geparst wird
+      return nil if response.body.nil? || response.body.empty?
+
       JSON.parse(response.body)["data"]
     end
 
@@ -77,4 +139,7 @@ module Proxmox
       end
     end
   end
+
+  # Eigene Fehlerklasse (optional, aber guter Stil)
+  class ApiError < StandardError; end
 end

data/lib/proxmox/resources/cluster.rb

@@ -8,6 +8,10 @@ module Proxmox
         @client = client
       end
 
+      def inspect
+        "#<Proxmox::Resources::Cluster client_url=#{@client.base_url}>"
+      end
+
       def log(max: nil)
         params = {}
         params[:max] = max unless max.nil?
@@ -38,9 +42,8 @@ module Proxmox
         @client.request(:get, "/cluster/tasks")
       end
 
-      # Getting all Nodes
       def nodes
-        @client.request(:get, "/nodes")
+        @client.nodes
       end
     end
   end

data/lib/proxmox/resources/clusters/backup.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Proxmox
+  module Resources
+    module Clusters
+      # Proxmox Cluster Acme class
+      class Backup
+        def initialize(client)
+          @client = client
+        end
+
+        def all
+          @client.request(:get, "/cluster/backup")
+        end
+      end
+    end
+  end
+end

data/lib/proxmox/resources/node.rb

@@ -4,9 +4,37 @@ module Proxmox
   module Resources
     # Proxmox Node Class
     class Node
-      def initialize(client, node_name)
+      # Define the attributes we expect from the API
+      STATS_ATTRIBUTES = %i[id cpu maxcpu mem maxmem uptime].freeze
+      attr_reader :node, *STATS_ATTRIBUTES
+      alias name node
+
+      def initialize(client, name_or_data)
         @client = client
-        @node   = node_name
+        if name_or_data.is_a?(Hash)
+          @node = name_or_data["node"]
+          @raw_status = name_or_data["status"]
+
+          # Dynamically set known attributes to avoid boilerplate
+          STATS_ATTRIBUTES.each do |attr|
+            instance_variable_set("@#{attr}", name_or_data[attr.to_s])
+          end
+        else
+          @node = name_or_data
+        end
+      end
+
+      def inspect
+        "#<Proxmox::Resources::Node name=#{@node} status=#{@raw_status}>"
+      end
+
+      def online?
+        @raw_status == "online"
+      end
+
+      # Access the Cluster resource
+      def cluster
+        @client.cluster
       end
 
       # Getting status of the Node

data/lib/proxmox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proxmox
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/proxmox.rb

@@ -4,6 +4,7 @@ require "proxmox/version"
 require "proxmox/client"
 require "proxmox/resources/cluster"
 require "proxmox/resources/clusters/acme"
+require "proxmox/resources/clusters/backup"
 require "proxmox/resources/node"
 
 module Proxmox

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proxmox-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Alex Wellnitz
@@ -38,6 +38,7 @@ files:
 - lib/proxmox/client.rb
 - lib/proxmox/resources/cluster.rb
 - lib/proxmox/resources/clusters/acme.rb
+- lib/proxmox/resources/clusters/backup.rb
 - lib/proxmox/resources/node.rb
 - lib/proxmox/version.rb
 - sig/proxmox.rbs
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A gem that provides a client interface for Proxmox
 test_files: []