fog-proxmox 0.14.0 → 0.15.0

data/lib/fog/proxmox/auth/token/access_ticket.rb

@@ -22,64 +22,75 @@ require 'fog/proxmox/variables'
 require 'fog/proxmox/json'
 
 module Fog
-    module Proxmox
-        # Core module
-        module Auth
-            module Token
-                class AccessTicket
-                    include Fog::Proxmox::Auth::Token
-
-                    NAME = 'access_ticket'
-
-                    attr_reader :csrf_token
-
-                    class URIError < RuntimeError; end
-
-                    EXPIRATION_DELAY = 2 * 60 * 60
-
-                    def auth_method
-                        'POST'
-                    end
-
-                    def auth_path(params = {})
-                        '/access/ticket'
-                    end
-
-                    def auth_body(params = {})
-                        raise URIError, 'URI params is required' if params.nil? || params.empty?
-                        raise URIError, 'proxmox_username is required' if params[:proxmox_username].nil? || params[:proxmox_username].empty?
-                        raise URIError, 'proxmox_password is required' if params[:proxmox_password].nil? || params[:proxmox_password].empty?
-                        URI.encode_www_form(username: params[:proxmox_username], password: params[:proxmox_password])
-                    end
-
-                    def headers(method = 'GET', params = {}, additional_headers = {})
-                        headers_hash = {}
-                        @data ||= {}
-                        unless @data.empty?
-                            headers_hash.store('Cookie', "PVEAuthCookie=#{@data['ticket']}")
-                            if %w[PUT POST DELETE].include? method
-                            headers_hash.store('CSRFPreventionToken', @data['CSRFPreventionToken'])
-                            end
-                        end
-                        headers_hash.merge! additional_headers
-                        headers_hash
-                    end
-
-                    def build_credentials(proxmox_options, data)
-                        @token = data['ticket']
-                        @expires = Time.now.utc.to_i + EXPIRATION_DELAY
-                        @userid = data['username']
-                        @csrf_token = data['CSRFPreventionToken']
-                    end
-
-                    def missing_credentials(options)
-                        missing_credentials = []
-                        missing_credentials << :proxmox_username unless options[:proxmox_username]
-                        missing_credentials << :proxmox_password unless options[:proxmox_password]
-                        raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
-                    end
-                end
+  module Proxmox
+    # Core module
+    module Auth
+      module Token
+        class AccessTicket
+          include Fog::Proxmox::Auth::Token
+
+          NAME = 'access_ticket'
+
+          attr_reader :csrf_token
+
+          class URIError < RuntimeError; end
+
+          EXPIRATION_DELAY = 2 * 60 * 60
+
+          def auth_method
+            'POST'
+          end
+
+          def auth_path(_params = {})
+            '/access/ticket'
+          end
+
+          def auth_body(params = {})
+            raise URIError, 'URI params is required' if params.nil? || params.empty?
+
+            if params[:proxmox_username].nil? || params[:proxmox_username].empty?
+              raise URIError,
+                    'proxmox_username is required'
+            end
+            if params[:proxmox_password].nil? || params[:proxmox_password].empty?
+              raise URIError,
+                    'proxmox_password is required'
+            end
+
+            URI.encode_www_form(username: params[:proxmox_username], password: params[:proxmox_password])
+          end
+
+          def headers(method = 'GET', _params = {}, additional_headers = {})
+            headers_hash = {}
+            @data ||= {}
+            unless @data.empty?
+              headers_hash.store('Cookie', "PVEAuthCookie=#{@data['ticket']}")
+              if %w[PUT POST DELETE].include? method
+                headers_hash.store('CSRFPreventionToken', @data['CSRFPreventionToken'])
+              end
             end
+            headers_hash.merge! additional_headers
+            headers_hash
+          end
+
+          def build_credentials(_proxmox_options, data)
+            @token = data['ticket']
+            @expires = Time.now.utc.to_i + EXPIRATION_DELAY
+            @userid = data['username']
+            @csrf_token = data['CSRFPreventionToken']
+          end
+
+          def missing_credentials(options)
+            missing_credentials = []
+            missing_credentials << :proxmox_username unless options[:proxmox_username]
+            missing_credentials << :proxmox_password unless options[:proxmox_password]
+            return if missing_credentials.empty?
+
+            raise ArgumentError,
+                  "Missing required arguments: #{missing_credentials.join(', ')}"
+          end
         end
+      end
     end
+  end
 end

data/lib/fog/proxmox/auth/token/user_token.rb

@@ -22,73 +22,86 @@ require 'fog/proxmox/variables'
 require 'fog/proxmox/json'
 
 module Fog
-    module Proxmox
-        # Core module
-        module Auth
-            module Token
-                class UserToken
-                    include Fog::Proxmox::Auth::Token
-
-                    NAME = 'user_token'
-
-                    attr_reader :token_id
-
-                    class URIError < RuntimeError; end
-
-                    def auth_method
-                        'GET'
-                    end
-
-                    def auth_path(params = {})
-                        raise URIError, 'URI params are required' if params.nil? || params.empty?
-                        raise URIError, 'proxmox_userid is required' if params[:proxmox_userid].nil? || params[:proxmox_userid].empty?
-                        raise URIError, 'proxmox_tokenid is required' if params[:proxmox_tokenid].nil? || params[:proxmox_tokenid].empty?
-                        "/access/users/#{URI.encode_www_form_component(params[:proxmox_userid])}/token/#{params[:proxmox_tokenid]}"
-                    end
-
-                    def auth_body(params = {})
-                        ''
-                    end        
-                    
-                    def no_token?(params)
-                        (params.respond_to?(:proxmox_token) || params[:proxmox_token].nil? || params[:proxmox_token].empty?) && (@token.nil? || @token.empty?)
-                    end
-
-                    def set_credentials(params)
-                        token = @token
-                        token = params[:proxmox_token] if token.empty?
-                        token_id = @token_id
-                        token_id = params[:proxmox_tokenid] if token_id.empty? 
-                        userid = @userid
-                        userid = params[:proxmox_userid] if userid.empty?
-                        {userid: userid, token_id: token_id, token: token }
-                    end
-
-                    def headers(method = 'GET', params = {}, additional_headers = {})
-                        raise URIError, 'User token is required' if no_token?(params)
-                        credentials = set_credentials(params)
-                        headers_hash = {}
-                        headers_hash.store('Authorization', "PVEAPIToken=#{credentials[:userid]}!#{credentials[:token_id]}=#{credentials[:token]}")
-                        headers_hash.merge! additional_headers
-                        headers_hash
-                    end
-
-                    def build_credentials(proxmox_options, data)
-                        @expires = data['expire']
-                        @token = proxmox_options[:proxmox_token]
-                        @token_id = proxmox_options[:proxmox_tokenid]
-                        @userid = proxmox_options[:proxmox_userid]
-                    end
-
-                    def missing_credentials(options)
-                        missing_credentials = []
-                        missing_credentials << :proxmox_userid unless options[:proxmox_userid]
-                        missing_credentials << :proxmox_tokenid unless options[:proxmox_tokenid]
-                        missing_credentials << :proxmox_token unless options[:proxmox_token]
-                        raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
-                    end
-                end
+  module Proxmox
+    # Core module
+    module Auth
+      module Token
+        class UserToken
+          include Fog::Proxmox::Auth::Token
+
+          NAME = 'user_token'
+
+          attr_reader :token_id
+
+          class URIError < RuntimeError; end
+
+          def auth_method
+            'GET'
+          end
+
+          def auth_path(params = {})
+            raise URIError, 'URI params are required' if params.nil? || params.empty?
+
+            if params[:proxmox_userid].nil? || params[:proxmox_userid].empty?
+              raise URIError,
+                    'proxmox_userid is required'
             end
+            if params[:proxmox_tokenid].nil? || params[:proxmox_tokenid].empty?
+              raise URIError,
+                    'proxmox_tokenid is required'
+            end
+
+            "/access/users/#{URI.encode_www_form_component(params[:proxmox_userid])}/token/#{params[:proxmox_tokenid]}"
+          end
+
+          def auth_body(_params = {})
+            ''
+          end
+
+          def no_token?(params)
+            (params.respond_to?(:proxmox_token) || params[:proxmox_token].nil? || params[:proxmox_token].empty?) && (@token.nil? || @token.empty?)
+          end
+
+          def set_credentials(params)
+            token = @token
+            token = params[:proxmox_token] if token.empty?
+            token_id = @token_id
+            token_id = params[:proxmox_tokenid] if token_id.empty?
+            userid = @userid
+            userid = params[:proxmox_userid] if userid.empty?
+            { userid: userid, token_id: token_id, token: token }
+          end
+
+          def headers(_method = 'GET', params = {}, additional_headers = {})
+            raise URIError, 'User token is required' if no_token?(params)
+
+            credentials = set_credentials(params)
+            headers_hash = {}
+            headers_hash.store('Authorization',
+                               "PVEAPIToken=#{credentials[:userid]}!#{credentials[:token_id]}=#{credentials[:token]}")
+            headers_hash.merge! additional_headers
+            headers_hash
+          end
+
+          def build_credentials(proxmox_options, data)
+            @expires = data['expire']
+            @token = proxmox_options[:proxmox_token]
+            @token_id = proxmox_options[:proxmox_tokenid]
+            @userid = proxmox_options[:proxmox_userid]
+          end
+
+          def missing_credentials(options)
+            missing_credentials = []
+            missing_credentials << :proxmox_userid unless options[:proxmox_userid]
+            missing_credentials << :proxmox_tokenid unless options[:proxmox_tokenid]
+            missing_credentials << :proxmox_token unless options[:proxmox_token]
+            return if missing_credentials.empty?
+
+            raise ArgumentError,
+                  "Missing required arguments: #{missing_credentials.join(', ')}"
+          end
         end
+      end
     end
+  end
 end

data/lib/fog/proxmox/auth/token.rb

@@ -23,66 +23,72 @@ require 'fog/proxmox/variables'
 require 'fog/proxmox/json'
 
 module Fog
-    module Proxmox
-        # Core module
-        module Auth
-            module Token
-
-                autoload :AccessTicket, 'fog/proxmox/auth/token/access_ticket'
-                autoload :UserToken, 'fog/proxmox/auth/token/user_token'
-
-                attr_reader :userid, :token, :expires, :data
-
-                class ExpiryError < RuntimeError; end
-                class URLError < RuntimeError; end
-
-                def initialize(proxmox_options, options = {})
-                    raise URLError, 'No proxmox_url provided' if proxmox_options[:proxmox_url].nil? || proxmox_options[:proxmox_url].empty?                    
-                    @token ||= ''
-                    @token_id ||= ''
-                    @userid ||= ''                
-                    @data = authenticate(proxmox_options, options)    
-                    build_credentials(proxmox_options, data)
-                end
-
-                def self.build(proxmox_options, options)
-                    raise ArgumentError, "Missing required proxmox_auth_method in options." unless proxmox_options.key? :proxmox_auth_method
-                    auth_method = proxmox_options[:proxmox_auth_method]
-                    if auth_method == Fog::Proxmox::Auth::Token::AccessTicket::NAME
-                        Fog::Proxmox::Auth::Token::AccessTicket.new(proxmox_options, options)
-                    elsif auth_method == Fog::Proxmox::Auth::Token::UserToken::NAME
-                        Fog::Proxmox::Auth::Token::UserToken.new(proxmox_options, options)
-                    else
-                        raise ArgumentError, "Unkown authentication method: #{auth_method}. Only #{Fog::Proxmox::Auth::Token::AccessTicket::NAME} or #{Fog::Proxmox::Auth::Token::UserToken::NAME} are accepted."
-                    end
-                end
-
-                def authenticate(proxmox_options, connection_options = {})
-                    uri = URI.parse(proxmox_options[:proxmox_url])
-                    request = {
-                        expects: [200, 201],
-                        headers: headers(auth_method, proxmox_options, { Accept: 'application/json' }),
-                        body: auth_body(proxmox_options),
-                        method: auth_method,
-                        path: uri.path + auth_path(proxmox_options)
-                    }
-                    connection = Fog::Core::Connection.new(
-                        uri.to_s,
-                        false,
-                        connection_options
-                    )
-                    response  = connection.request(request)
-                    Json.get_data(response)
-                end
-
-                def expired?
-                    if @expires.nil? || @expires.empty?
-                        raise ExpiryError, 'Missing token expiration data'
-                    end
-                    Time.at(@expires) < Time.now.utc
-                end
-                
-            end
+  module Proxmox
+    # Core module
+    module Auth
+      module Token
+        autoload :AccessTicket, 'fog/proxmox/auth/token/access_ticket'
+        autoload :UserToken, 'fog/proxmox/auth/token/user_token'
+
+        attr_reader :userid, :token, :expires, :data
+
+        class ExpiryError < RuntimeError; end
+        class URLError < RuntimeError; end
+
+        def initialize(proxmox_options, options = {})
+          if proxmox_options[:proxmox_url].nil? || proxmox_options[:proxmox_url].empty?
+            raise URLError,
+                  'No proxmox_url provided'
+          end
+
+          @token ||= ''
+          @token_id ||= ''
+          @userid ||= ''
+          @data = authenticate(proxmox_options, options)
+          build_credentials(proxmox_options, data)
+        end
+
+        def self.build(proxmox_options, options)
+          unless proxmox_options.key? :proxmox_auth_method
+            raise ArgumentError,
+                  'Missing required proxmox_auth_method in options.'
+          end
+
+          auth_method = proxmox_options[:proxmox_auth_method]
+          if auth_method == Fog::Proxmox::Auth::Token::AccessTicket::NAME
+            Fog::Proxmox::Auth::Token::AccessTicket.new(proxmox_options, options)
+          elsif auth_method == Fog::Proxmox::Auth::Token::UserToken::NAME
+            Fog::Proxmox::Auth::Token::UserToken.new(proxmox_options, options)
+          else
+            raise ArgumentError,
+                  "Unkown authentication method: #{auth_method}. Only #{Fog::Proxmox::Auth::Token::AccessTicket::NAME} or #{Fog::Proxmox::Auth::Token::UserToken::NAME} are accepted."
+          end
+        end
+
+        def authenticate(proxmox_options, connection_options = {})
+          uri = URI.parse(proxmox_options[:proxmox_url])
+          request = {
+            expects: [200, 201],
+            headers: headers(auth_method, proxmox_options, { Accept: 'application/json' }),
+            body: auth_body(proxmox_options),
+            method: auth_method,
+            path: uri.path + auth_path(proxmox_options)
+          }
+          connection = Fog::Core::Connection.new(
+            uri.to_s,
+            false,
+            connection_options
+          )
+          response = connection.request(request)
+          Json.get_data(response)
+        end
+
+        def expired?
+          raise ExpiryError, 'Missing token expiration data' if @expires.nil? || @expires.empty?
+
+          Time.at(@expires) < Time.now.utc
         end
+      end
     end
+  end
 end

data/lib/fog/proxmox/compute/models/disk.rb

@@ -23,7 +23,8 @@ require 'fog/proxmox/helpers/controller_helper'
 module Fog
   module Proxmox
     class Compute
-      # class Disk model
+      # class Disk model: https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/{qemu|lxc}/{vmid}/config
+      # size is in Gb
       class Disk < Fog::Model
         identity  :id
         attribute :volid
@@ -83,6 +84,10 @@ module Fog
         def to_s
           Fog::Proxmox::Hash.flatten(flatten)
         end
+
+        def has_volume?
+          !volid.empty?
+        end
       end
     end
   end

data/lib/fog/proxmox/compute/models/disks.rb

@@ -31,7 +31,7 @@ module Fog
         end
 
         def get(id)
-          all.find { |disk| disk.identity === id }
+          all.find { |disk| disk.identity == id }
         end
 
         def next_device(controller)

data/lib/fog/proxmox/compute/models/interface.rb

@@ -17,7 +17,7 @@
 
 # frozen_string_literal: true
 
-require "fog/proxmox/helpers/nic_helper"
+require 'fog/proxmox/helpers/nic_helper'
 
 module Fog
   module Proxmox

data/lib/fog/proxmox/compute/models/interfaces.rb

@@ -32,7 +32,7 @@ module Fog
         end
 
         def get(id)
-          all.find { |interface| interface.identity === id }
+          all.find { |interface| interface.identity == id }
         end
 
         def next_nicid

data/lib/fog/proxmox/compute/models/node.rb

@@ -61,14 +61,13 @@ module Fog
         end
 
         def backup(options = {})
-          task_upid = service.backup({ node: node }, options)
-          task_upid
+          service.backup({ node: node }, options)
         end
 
-        def statistics(output = 'rrddata', options = { timeframe: 'hour', cf: 'AVERAGE'})
+        def statistics(output = 'rrddata', options = { timeframe: 'hour', cf: 'AVERAGE' })
           path_params = { node: node, output: output }
           query_params = options
-          service.get_node_statistics(path_params,query_params)
+          service.get_node_statistics(path_params, query_params)
         end
 
         private
@@ -88,7 +87,6 @@ module Fog
         def initialize_storages
           attributes[:storages] = Fog::Proxmox::Compute::Storages.new(service: service, node_id: node)
         end
-
       end
     end
   end

data/lib/fog/proxmox/compute/models/nodes.rb

@@ -31,7 +31,7 @@ module Fog
         end
 
         def get(id)
-          all.find { |node| node.identity === id }
+          all.find { |node| node.identity == id }
         end
       end
     end

data/lib/fog/proxmox/compute/models/server.rb

@@ -78,14 +78,11 @@ module Fog
 
         def persisted?
           service.next_vmid(vmid: vmid)
-          persisted = false
-          persisted
+          false
         rescue Excon::Error::InternalServerError
-          persisted = false
-          persisted
+          false
         rescue Excon::Error::BadRequest
-          persisted = true
-          persisted
+          true
         end
 
         # request with async task
@@ -122,6 +119,7 @@ module Fog
           action_known = %w[start stop resume suspend shutdown reset].include? action
           message = "Action #{action} not implemented"
           raise Fog::Errors::Error, message unless action_known
+
           request(:action_server, options, action: action, vmid: vmid)
           reload
         end
@@ -136,11 +134,11 @@ module Fog
         end
 
         def restore(backup, options = {})
-          if container?
-            attr_hash = options.merge(ostemplate: backup.volid, force: 1, restore: 1)
-          else
-            attr_hash = options.merge(archive: backup.volid, force: 1)
-          end
+          attr_hash = if container?
+                        options.merge(ostemplate: backup.volid, force: 1, restore: 1)
+                      else
+                        options.merge(archive: backup.volid, force: 1)
+                      end
           save(attr_hash)
         end
 
@@ -186,14 +184,24 @@ module Fog
         end
 
         def start_console(options = {})
-          raise ::Fog::Proxmox::Errors::ServiceError, "Unable to start console because server not running." unless ready?
+          unless ready?
+            raise ::Fog::Proxmox::Errors::ServiceError,
+                  'Unable to start console because server not running.'
+          end
+
           if container?
             type_console = options[:console]
             options.delete_if { |option| [:console].include? option }
-            raise ::Fog::Proxmox::Errors::ServiceError, "Unable to start console because console container config is not set or unknown." unless type_console
+            unless type_console
+              raise ::Fog::Proxmox::Errors::ServiceError,
+                    'Unable to start console because console container config is not set or unknown.'
+            end
           else
             type_console = config.type_console
-            raise ::Fog::Proxmox::Errors::ServiceError, "Unable to start console because VGA display server config is not set or unknown." unless type_console
+            unless type_console
+              raise ::Fog::Proxmox::Errors::ServiceError,
+                    'Unable to start console because VGA display server config is not set or unknown.'
+            end
           end
           requires :vmid, :node_id, :type
           path_params = { node: node_id, type: type, vmid: vmid }
@@ -238,11 +246,14 @@ module Fog
         private
 
         def initialize_snapshots
-          attributes[:snapshots] = Fog::Proxmox::Compute::Snapshots.new(service: service, server_id: vmid, server_type: type, node_id: node_id)
+          attributes[:snapshots] =
+            Fog::Proxmox::Compute::Snapshots.new(service: service, server_id: vmid, server_type: type, node_id: node_id)
         end
 
         def initialize_tasks
-          attributes[:tasks] = Fog::Proxmox::Compute::Tasks.new(service: service, node_id: node_id).select { |task| task.id == vmid }
+          attributes[:tasks] = Fog::Proxmox::Compute::Tasks.new(service: service, node_id: node_id).select do |task|
+            task.id == vmid
+          end
         end
 
         def node

data/lib/fog/proxmox/compute/models/server_config.rb

@@ -24,7 +24,8 @@ require 'fog/proxmox/helpers/controller_helper'
 module Fog
   module Proxmox
     class Compute
-      # ServerConfig model
+      # ServerConfig model: https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/{qemu|lxc}/{vmid}/config
+      # memory, balloon, shares and swap are in Mb
       class ServerConfig < Fog::Model
         identity  :vmid
         attribute :description
@@ -99,7 +100,7 @@ module Fog
         end
 
         def flatten
-          flat_hash = attributes.reject { |attribute| [:node_id, :type, :vmid, :disks, :interfaces].include? attribute }
+          flat_hash = attributes.reject { |attribute| %i[node_id type vmid disks interfaces].include? attribute }
           flat_hash.merge(interfaces_flatten)
           flat_hash.merge(disks_flatten)
           flat_hash
@@ -128,7 +129,9 @@ module Fog
               model: Fog::Proxmox::NicHelper.extract_nic_id(value),
               macaddr: Fog::Proxmox::NicHelper.extract_mac_address(value)
             }
-            names = Fog::Proxmox::Compute::Interface.attributes.reject { |attribute| [:id, :macaddr, :model].include? attribute }
+            names = Fog::Proxmox::Compute::Interface.attributes.reject do |attribute|
+              %i[id macaddr model].include? attribute
+            end
             names.each { |name| nic_hash.store(name.to_sym, Fog::Proxmox::ControllerHelper.extract(name, value)) }
             attributes[:interfaces] << Fog::Proxmox::Compute::Interface.new(nic_hash)
           end
@@ -145,7 +148,9 @@ module Fog
               volid: volid,
               storage: storage
             }
-            names = Fog::Proxmox::Compute::Disk.attributes.reject { |attribute| [:id, :size, :storage, :volid].include? attribute }
+            names = Fog::Proxmox::Compute::Disk.attributes.reject do |attribute|
+              %i[id size storage volid].include? attribute
+            end
             names.each { |name| disk_hash.store(name.to_sym, Fog::Proxmox::ControllerHelper.extract(name, value)) }
             attributes[:disks] << Fog::Proxmox::Compute::Disk.new(disk_hash)
           end