proxmox-api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfffdfb8c0570120b8dd060da7d5d7fa379c00989d83523a4297264616f2d8f3
-  data.tar.gz: 0a48cc99643a7a2aa894f3f6b5f5ad354b83f428f89b891296701b5bd386aa6e
+  metadata.gz: f471fb9bb0268e38e3b45da32b2572d29a53d9805e4702e47a6a0c784351f971
+  data.tar.gz: 0364feb0db15bea88f86358ca5299e6c16a70f56a045024db1c63957defa26ec
 SHA512:
-  metadata.gz: 7087e2ceba545878007e3d00a006ab22cc50068058d95acf2d8afb95482d94a68a4152394f1a82a710e612fad085d466413d2fc00b27fabba8e2ac41915f7e98
-  data.tar.gz: a580714df5b78651b3d82583a425f8474825f9c21e4ceee75805802730b9089a7f43ed55acd98ba17596913fd7670eaa5d1a8c2d6b8bde283208ac5d4166e675
+  metadata.gz: 4172c20fc513e1772ab19d0acdd94d2393601ac5a6ad4067a24e30ac52698208580d2a011ee2047d0d41edf93a081aeaf2ae988fbaf4f78b2da94a72c1c16d29
+  data.tar.gz: 95d4895f5e6323b6f0ab9fb79b3bc64e36ed8a735b3d3f9f80fb244db5559f0d744ba587ca047de6290b5dc6408d62124f3754f9357fa4bc4c85ac93613ffd54

data/lib/proxmox_api.rb

@@ -8,7 +8,8 @@ require 'json'
 #
 # @author Eugene Lapeko
 class ProxmoxAPI
-  AUTH_PARAMS  = %i[username realm password otp].freeze
+  AUTH_PARAMS = %i[username realm password otp].freeze
+  RESOURCE_OPTIONS = %i[headers].freeze
   REST_METHODS = %i[get post put delete].freeze
 
   # This class is used to collect api path before request
@@ -64,6 +65,8 @@ class ProxmoxAPI
   # @option options [String] :username - username to be used for connection
   # @option options [String] :password - password to be used for connection
   # @option options [String] :realm - auth realm, can be given in :username ('user@realm')
+  # @option options [String] :token - token to be used instead of username, password, and realm
+  # @option options [String] :secret - secret to be used with token
   # @option options [String] :otp - one-time password for two-factor auth
   #
   # @option options [Boolean] :verify_ssl - verify server certificate
@@ -71,11 +74,15 @@ class ProxmoxAPI
   # You can also pass here all ssl options supported by rest-client gem
   # @see https://github.com/rest-client/rest-client
   def initialize(cluster, options)
+    if options.key?(:token) && options.key?(:secret)
+      options[:headers] = { Authorization: "PVEAPIToken=#{options[:token]}=#{options[:secret]}" }
+    end
+
     @connection = RestClient::Resource.new(
       "https://#{cluster}:#{options[:port] || 8006}/api2/json/",
-      options.select { |k, _v| RestClient::Request::SSLOptionList.unshift('verify_ssl').include? k.to_s }
+      options.select { |k, _v| connection_options.include?(k.to_s) }
     )
-    @auth_ticket = create_auth_ticket(options.select { |k, _v| AUTH_PARAMS.include? k })
+    @auth_ticket = options.key?(:token) ? {} : create_auth_ticket(options.select { |k, _v| AUTH_PARAMS.include? k })
   end
 
   def [](index)
@@ -90,6 +97,11 @@ class ProxmoxAPI
     true
   end
 
+  # The list of options to be passed to RestClient object
+  def self.connection_options
+    RestClient::Request::SSLOptionList.unshift('verify_ssl') + RESOURCE_OPTIONS
+  end
+
   private
 
   def raise_on_failure(response, message = 'Proxmox API request failed')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxmox-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Eugene Lapeko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -89,12 +89,11 @@ files:
 - Gemfile
 - LICENSE
 - lib/proxmox_api.rb
-- spec/api_path_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/L-Eugene/proxmox-api
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,17 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Proxmox VE REST API wrapper
-test_files:
-- spec/spec_helper.rb
-- spec/api_path_spec.rb
+test_files: []

data/spec/api_path_spec.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec'
-
-describe 'ApiPath' do
-  before(:each) do
-    @api_object = double('ProxmoxAPI')
-    allow(@api_object).to receive(:is_a?).with(ProxmoxAPI) { true }
-  end
-
-  it 'raises exception when object is not ProxmoxAPI' do
-    [1, 'String', Class].each do |item|
-      expect { ProxmoxAPI::ApiPath.new(item) }.to raise_error(ArgumentError)
-    end
-  end
-
-  it 'collects api path using methods' do
-    expect(ProxmoxAPI::ApiPath.new(@api_object).ticket.to_s).to eq 'ticket'
-    expect(ProxmoxAPI::ApiPath.new(@api_object).nodes.pve1.to_s).to eq 'nodes/pve1'
-  end
-
-  it 'collects api path using []' do
-    expect(ProxmoxAPI::ApiPath.new(@api_object)[:ticket].to_s).to eq 'ticket'
-    expect(ProxmoxAPI::ApiPath.new(@api_object)[:nodes]['pve1'][15].to_s).to eq 'nodes/pve1/15'
-  end
-
-  it 'collects api path combining [] and methods' do
-    expect(ProxmoxAPI::ApiPath.new(@api_object).nodes['pve1'].lxc.to_s).to eq 'nodes/pve1/lxc'
-  end
-
-  %i[get post delete put].each do |method|
-    it "should send #{method} to ProxmoxAPI" do
-      expect(@api_object).to receive(:submit).with(method, 'nodes/pve')
-      ProxmoxAPI::ApiPath.new(@api_object).nodes.pve.__send__(method)
-    end
-
-    it "should send #{method}! to ProxmoxAPI" do
-      expect(@api_object).to receive(:submit).with("#{method}!".to_sym, 'nodes/pve')
-      ProxmoxAPI::ApiPath.new(@api_object).nodes.pve.__send__("#{method}!")
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require 'proxmox_api'
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-end