proxmox-sdk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7fa64e7b8d1feec0ae521242312a0c2d46d122435b15b6053bebe6105661dbc
-  data.tar.gz: e2cd741a0e09a87b78416d39bfb55d6f9815c95a9fd83d62a6e7bf80386c47fe
+  metadata.gz: 18becda6b3edf4aba2a1146a3f889e618c9c49ad9d476f45197b63bae0930f5e
+  data.tar.gz: bc2b3f12e06eb9ef9941acf1035a81bdad3be29627fbdec33ee520e374ddb221
 SHA512:
-  metadata.gz: 96a721ba56f055791c9281e9dd0d007944c3ee0de6e2889c7a5dc2675a70724a9b2dea4da79eb001597e6c6a9b190347379089bdcc90648780f454eeccdc8edc
-  data.tar.gz: 104b3087f769b3a3da6a15ca6a5e2e2f5049a8a07fbf0da719b54475bc80741b38ba7b6edd50a699f0760ea31ecb2f381270e74a09bbf4cc2f9bbfa4b03b62b3
+  metadata.gz: 4aa011f0cb9ea2ca0694a095e549a410f572cd96325d3cf4886bc1a9ba80536e8d4f64ea9005bdf9836368c2b8a5c823e8d28cc81da77601958a96cd27132865
+  data.tar.gz: 3628b92158ebb7288bdd9f231e9db71eb180789df6e36fc7faa69d744b41bcde25535efc90bec9f0b48c1c959a5d9f0811a9aa54850a4a83ab75af6c4016ccb5

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,6 @@
 # Proxmox
 
+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

@@ -22,21 +22,54 @@ module Proxmox
     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
+      response = perform_http_call(method, path, params, body)
+
+      ensure_success!(response)
+      extract_data(response)
+    end
+
+    private
+
+    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)
       raise ApiError, response.body unless response.success?
+    end
 
+    def extract_data(response)
       JSON.parse(response.body)["data"]
     end
 
-    private
-
     def http
       @http ||= Faraday.new(url: @base_url, ssl: { verify: @verify_ssl }) do |f|
         f.request :url_encoded

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/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.1"
 end

data/lib/proxmox.rb

@@ -2,6 +2,8 @@
 
 require "proxmox/version"
 require "proxmox/client"
+require "proxmox/resources/cluster"
+require "proxmox/resources/clusters/acme"
 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.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Wellnitz
@@ -36,6 +36,8 @@ files:
 - Rakefile
 - lib/proxmox.rb
 - lib/proxmox/client.rb
+- lib/proxmox/resources/cluster.rb
+- lib/proxmox/resources/clusters/acme.rb
 - lib/proxmox/resources/node.rb
 - lib/proxmox/version.rb
 - sig/proxmox.rbs