proxmox-api 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbf823b601fbcb8595b19af7580881ef311ce140d1e5d971a9451a3a50c7249a
-  data.tar.gz: 246a3d239a3ffa4966022e2f28c95addcf9787b6b1fd236b2c163a54dd2b837b
+  metadata.gz: cfffdfb8c0570120b8dd060da7d5d7fa379c00989d83523a4297264616f2d8f3
+  data.tar.gz: 0a48cc99643a7a2aa894f3f6b5f5ad354b83f428f89b891296701b5bd386aa6e
 SHA512:
-  metadata.gz: 42b320222e6b040bd9d06fa103f61bb177f63b6d9d8c2c034d5ca243387c9526b5cdb0cae56229cabbe2e45f15722c729e8240e880f47c2f4c3da4d67f2789a1
-  data.tar.gz: 2617997f456c221ab6fabfd933c3b3c4b51944a51a43a2204403e23265a59ccef0dbb6b09c3e99b09317f8b3c5d8a05622b48cf17a063f735a16f4fb2a2bd317
+  metadata.gz: 7087e2ceba545878007e3d00a006ab22cc50068058d95acf2d8afb95482d94a68a4152394f1a82a710e612fad085d466413d2fc00b27fabba8e2ac41915f7e98
+  data.tar.gz: a580714df5b78651b3d82583a425f8474825f9c21e4ceee75805802730b9089a7f43ed55acd98ba17596913fd7670eaa5d1a8c2d6b8bde283208ac5d4166e675

data/lib/proxmox_api.rb

@@ -3,13 +3,20 @@
 require 'rest_client'
 require 'json'
 
+# This class is wrapper for Proxmox PVE APIv2.
+# See README for usage examples.
+#
+# @author Eugene Lapeko
 class ProxmoxAPI
-  AUTH_PARAMS  = %i[username realm password otp path privs].freeze
+  AUTH_PARAMS  = %i[username realm password otp].freeze
   REST_METHODS = %i[get post put delete].freeze
-  SSL_OPTIONS  = %i[ssl_client_cert ssl_client_key ssl_ca_file verify_ssl].freeze
 
+  # This class is used to collect api path before request
   class ApiPath
+    # @param [ProxmoxAPI] api ProxmoxAPI object to call when request is executed
     def initialize(api)
+      raise ArgumentError, 'Not an instance of ProxmoxAPI' unless api.is_a? ProxmoxAPI
+
       @api = api
       @path = []
     end
@@ -24,7 +31,7 @@ class ProxmoxAPI
     end
 
     def method_missing(method, *args)
-      return @api.__send__(:submit, method, to_s, *args) if REST_METHODS.include?(method)
+      return @api.__send__(:submit, method, to_s, *args) if REST_METHODS.any? { |rm| /^#{rm}!?$/.match? method }
 
       @path << method.to_s
       self
@@ -35,10 +42,38 @@ class ProxmoxAPI
     end
   end
 
+  # This exception is raised when Proxmox API returns error code
+  #
+  # @!attribute [r] response
+  #   @return [RestClient::Response] answer from Proxmox server
+  class ApiException < RuntimeError
+    attr_reader :response
+
+    def initialize(response, description)
+      @response = response
+
+      super description
+    end
+  end
+
+  # Constructor method for ProxmoxAPI
+  #
+  # @param [String] cluster hostname/ip of cluster to control
+  # @param [Hash] options cluster connection parameters
+  #
+  # @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] :otp - one-time password for two-factor auth
+  #
+  # @option options [Boolean] :verify_ssl - verify server certificate
+  #
+  # 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)
     @connection = RestClient::Resource.new(
       "https://#{cluster}:#{options[:port] || 8006}/api2/json/",
-      options.select { |k, _v| SSL_OPTIONS.include? k }
+      options.select { |k, _v| RestClient::Request::SSLOptionList.unshift('verify_ssl').include? k.to_s }
     )
     @auth_ticket = create_auth_ticket(options.select { |k, _v| AUTH_PARAMS.include? k })
   end
@@ -57,9 +92,16 @@ class ProxmoxAPI
 
   private
 
+  def raise_on_failure(response, message = 'Proxmox API request failed')
+    return unless response.code.to_i >= 400
+
+    raise ApiException.new(response, message)
+  end
+
   def create_auth_ticket(options)
     @connection['access/ticket'].post options do |response, _request, _result, &_block|
-      # TODO: raise unless response.code == 200
+      raise_on_failure(response, 'Proxmox authentication failure')
+
       data = JSON.parse(response.body, symbolize_names: true)[:data]
       {
         cookies: { PVEAuthCookie: data[:ticket] },
@@ -80,8 +122,14 @@ class ProxmoxAPI
   end
 
   def submit(method, url, data = {})
+    if /!$/.match? method
+      method = method.to_s.tr('!', '').to_sym
+      skip_raise = true
+    end
+
     @connection[url].__send__(method, *prepare_options(method, data)) do |response|
-      # TODO: raise unless response.code == 200
+      raise_on_failure(response) unless skip_raise
+
       JSON.parse(response.body, symbolize_names: true)[:data]
     end
   end

data/spec/api_path_spec.rb

@@ -0,0 +1,42 @@
+# 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

@@ -0,0 +1,50 @@
+# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxmox-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Eugene Lapeko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,7 +38,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: A library to manage Proxmox VE cluster using APIv2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Proxmox VE REST API wrapper
 email: eugene@lapeko.info
 executables: []
 extensions: []
@@ -47,6 +89,8 @@ 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
@@ -69,5 +113,7 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: A library to manage Proxmox VE cluster
-test_files: []
+summary: Proxmox VE REST API wrapper
+test_files:
+- spec/spec_helper.rb
+- spec/api_path_spec.rb