Class: Pvectl::Repositories::Base Abstract

Inherits:

Object

Object
Pvectl::Repositories::Base

show all

Defined in:: lib/pvectl/repositories/base.rb

Overview

This class is abstract.

Subclass and implement #list, #get, and #build_model.

Abstract base class for repositories.

Repositories encapsulate Proxmox API communication and are responsible for converting raw API data to domain models. Each repository handles one resource type (VMs, Containers, Nodes, etc.).

Examples:

Implementing a repository

class Vm < Base
  def list(node: nil)
    response = connection.client["cluster/resources"].get(params: { type: "vm" })
    response.map { |data| build_model(data) }
  end

  def get(vmid)
    list.find { |vm| vm.vmid == vmid.to_i }
  end

  protected

  def build_model(data)
    Models::Vm.new(data)
  end
end

Direct Known Subclasses

Apt, Backup, Capabilities, Container, Disk, Dns, Hosts, Journal, Node, Service, Snapshot, Storage, Subscription, Syslog, Task, TaskList, TaskLog, TimeConfig, Vm, Volume

Instance Method Summary collapse

#get(id) ⇒ Models::Base^?

Gets a single resource by ID.
#initialize(connection) ⇒ Base constructor

Creates repository with connection.
#list ⇒ Array<Models::Base>

Lists all resources.

Constructor Details

#initialize(connection) ⇒ `Base`

Creates repository with connection.

Parameters:

connection (Connection) —

Proxmox API connection



38
39
40

# File 'lib/pvectl/repositories/base.rb', line 38

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(id) ⇒ `Models::Base`^?

Gets a single resource by ID.

Parameters:

id (String, Integer) —

resource identifier

Returns:

(Models::Base, nil) —

model or nil if not found

Raises:

(NotImplementedError) —

if not implemented by subclass



55
56
57

# File 'lib/pvectl/repositories/base.rb', line 55

def get(id)
  raise NotImplementedError, "#{self.class}#get must be implemented"
end

#list ⇒ `Array<Models::Base>`

Lists all resources.