proxmox-sdk 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7fa64e7b8d1feec0ae521242312a0c2d46d122435b15b6053bebe6105661dbc
-  data.tar.gz: e2cd741a0e09a87b78416d39bfb55d6f9815c95a9fd83d62a6e7bf80386c47fe
+  metadata.gz: 366fb7b7ffeb686acc3a60998150f76bd28422038f8df24581b25cc0181819b0
+  data.tar.gz: 7cf6a08e8838aae0f74f9b6e0e5a7e44decbc1fabea47f16e6ddf433bd5cd143
 SHA512:
-  metadata.gz: 96a721ba56f055791c9281e9dd0d007944c3ee0de6e2889c7a5dc2675a70724a9b2dea4da79eb001597e6c6a9b190347379089bdcc90648780f454eeccdc8edc
-  data.tar.gz: 104b3087f769b3a3da6a15ca6a5e2e2f5049a8a07fbf0da719b54475bc80741b38ba7b6edd50a699f0760ea31ecb2f381270e74a09bbf4cc2f9bbfa4b03b62b3
+  metadata.gz: 0b557b203e667b509053a55c9fb921b92bb3b7895a57e5e89117ad93339cc7ccaf2a69990ed0ecb527b9bf5f0bf2f82367f34e75b121b235bb03f547be932a1e
+  data.tar.gz: 2da70d05399e669f1a804d50aac56900f8a2f0300f61450eb43341fd891eff1bbfa5c9fa79b8991ba1f9b296e80d5a521357705d98bc2090555168a61b114d5e

data/CHANGELOG.md

@@ -3,3 +3,8 @@
 ## [0.1.0] - 2025-09-30
 
 - Initial release
+
+## [0.1.1] - 2025-09-30
+
+- Add Cluster functionallity
+- Add Node functionallity

data/README.md

@@ -1,5 +1,8 @@
 # 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,42 +1,123 @@
 # 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 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)
-      response = http.send(method) do |req|
-        req.url "/api2/json#{path}"
-        req.headers["Cookie"] = "PVEAuthCookie=#{ticket}"
-        req.headers["CSRFPreventionToken"] = csrf_token if %i[post put delete].include?(method)
-        req.params.update(params) if method == :get
-        req.body = body.to_json if body
-      end
+      # Vor jeder Anfrage die Gültigkeit des Tokens prüfen und ggf. erneuern
+      ensure_token_validity
 
-      raise ApiError, response.body unless response.success?
+      response = perform_http_call(method, path, params, body)
 
-      JSON.parse(response.body)["data"]
+      ensure_success!(response)
+      extract_data(response)
     end
 
     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)
+        add_cookie_header(req)
+        set_csrf_header(req, method)
+        set_query_params(req, method, params)
+        set_body(req, body)
+      end
+    end
+
+    def set_url(req, path)
+      req.url "/api2/json#{path}"
+    end
+
+    def add_cookie_header(req)
+      req.headers["Cookie"] = "PVEAuthCookie=#{ticket}"
+    end
+
+    def set_csrf_header(req, method)
+      return unless %i[post put delete].include?(method)
+
+      req.headers["CSRFPreventionToken"] = csrf_token
+    end
+
+    def set_query_params(req, method, params)
+      req.params.update(params) if method == :get && params.any?
+    end
+
+    def set_body(req, body)
+      req.body = body.to_json if body
+    end
+
+    def ensure_success!(response)
+      # 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
+
     def http
       @http ||= Faraday.new(url: @base_url, ssl: { verify: @verify_ssl }) do |f|
         f.request :url_encoded
@@ -44,4 +125,7 @@ module Proxmox
       end
     end
   end
+
+  # Eigene Fehlerklasse (optional, aber guter Stil)
+  class ApiError < StandardError; end
 end

data/lib/proxmox/resources/cluster.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Proxmox
+  module Resources
+    # Proxmox Cluster Class
+    class Cluster
+      def initialize(client)
+        @client = client
+      end
+
+      def log(max: nil)
+        params = {}
+        params[:max] = max unless max.nil?
+
+        @client.request(:get, "/cluster/log", params)
+      end
+
+      def nextid(vmid: nil)
+        params = {}
+        params[:vmid] = vmid unless vmid.nil?
+
+        @client.request(:get, "/cluster/nextid", params)
+      end
+
+      def options
+        @client.request(:get, "/cluster/options")
+      end
+
+      def resources
+        @client.request(:get, "/cluster/resources")
+      end
+
+      def status
+        @client.request(:get, "/cluster/status")
+      end
+
+      def tasks
+        @client.request(:get, "/cluster/tasks")
+      end
+
+      # Getting all Nodes
+      def nodes
+        @client.request(:get, "/nodes")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Proxmox
+  module Resources
+    module Clusters
+      # Proxmox Cluster Acme class
+      class Acme
+        def initialize(client)
+          @client = client
+        end
+
+        def tos
+          @client.request(:get, "/cluster/acme/tos")
+        end
+      end
+    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

@@ -9,10 +9,17 @@ module Proxmox
         @node   = node_name
       end
 
+      # Getting status of the Node
       def status
         @client.request(:get, "/nodes/#{@node}/status")
       end
 
+      # Getting a list of updates for the Node
+      def updates
+        @client.request(:get, "/nodes/#{@node}/apt/update")
+      end
+
+      # Creating Resources
       def create_vm(params)
         @client.request(:post, "/nodes/#{@node}/qemu", {}, params)
       end

data/lib/proxmox/version.rb

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

data/lib/proxmox.rb

@@ -2,6 +2,9 @@
 
 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,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxmox-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Wellnitz
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -36,6 +37,9 @@ files:
 - Rakefile
 - lib/proxmox.rb
 - 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
@@ -47,6 +51,7 @@ metadata:
   homepage_uri: https://github.com/alexohneander/proxmox-sdk-ruby
   source_code_uri: https://github.com/alexohneander/proxmox-sdk-ruby
   changelog_uri: https://raw.githubusercontent.com/alexohneander/proxmox-sdk-ruby/refs/heads/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,7 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A gem that provides a client interface for Proxmox
 test_files: []