ruby-proxmox 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e21fae3fba8bd653738abd93c225830fe7fe3a70d07e8701ae08265479a69873
+  data.tar.gz: b7cf6351dade3050ac1e60c63a3428ced63f21689bdca1c460bf348105ef1bc2
+SHA512:
+  metadata.gz: c20c5ec02c7afe1e4a0fc5a654cecf045c5e3ed957219e6c9e5ad26698468e5f3ba45173ec7a3131d5dbd066b6055a69f033d940459fbb141c40c1ab1645a0eb
+  data.tar.gz: e68edbd101fb3f49bb5525859a6d419d71f3026d8f07efe21923096c507cf1dbe0a01b0257d0ec98b026af82383d66f01d0966d596dfc2b3d6091ef036993089

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,41 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-11-14 20:39:56 -0600 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/Void:
+  Exclude:
+    - 'spec/lib/proxmox_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 130
+
+# Offense count: 45
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 1094
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/proxmox/version.rb'
+

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+bundler_args: --without developpement
+rvm:
+  - 2.0.0
+  - 2.1.0
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-proxmox.gemspec
+gemspec
+
+group :developpement do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+
+  gem 'growl' if RUBY_PLATFORM =~ /darwin/
+  gem 'wdm' if RUBY_PLATFORM =~ /mingw/
+  gem 'ruby_gntp' if RUBY_PLATFORM =~ /mingw/
+
+  gem 'guard-spork'
+
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'guard-yard'
+end
+
+group :test do
+  gem 'spork'
+  gem 'simplecov'
+  gem 'json', '~> 1.8.3'
+  gem 'coveralls'
+end

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+group :docs do
+  guard 'yard' do
+    watch(%r{lib/.+\.rb})
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicolas Ledez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Proxmox
+
+A ruby gem for managing Proxmox Servers with Ruby. Based on https://github.com/nledez/proxmox
+
+### Usage Information
+
+Current build:
+[RubyGem](http://rubygems.org/gems/ruby-proxmox)
+
+[Rubydoc](http://rubydoc.info/github/nledez/proxmox/master/frames)
+
+Inspirated from:
+https://bitbucket.org/jmoratilla/knife-proxmox/ but I would like to have
+the same without chef.
+https://github.com/maxschulze/uv_proxmox but listing some task does not
+work for me. No tests, use ssh.
+
+Documentation from:
+- http://pve.proxmox.com/wiki/Proxmox_VE_API
+- http://pve.proxmox.com/pve2-api-doc/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'proxmox'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proxmox
+
+## Usage
+
+    require 'awesome_print'
+    require 'proxmox'
+    
+    def wait_status(server1, task)
+      puts task
+      while server1.task_status(task) == "running"
+        puts '.'
+        sleep 1
+      end
+    
+      puts server1.task_status(task)
+    end
+    
+    server1 =
+    Proxmox::Proxmox.new("https://the-proxmox-server:8006/api2/json/",
+    "node", "root", "secret", "pam")
+    ap server1.templates
+    
+    vm1 = server1.openvz_post("ubuntu-10.04-standard_10.04-4_i386", 200)
+    wait_status(server1, vm1)
+    
+    ap server1.openvz_vm_status(200)
+    vm1 = server1.openvz_vm_start(200)
+    begin
+      wait_status(server1, vm1)
+    rescue
+    end
+    sleep 5
+    ap server1.openvz_vm_shutdown(200)
+    begin
+      wait_status(server1, vm1)
+    rescue
+    end
+    sleep 5
+    ap server1.openvz_vm_status(200)
+    
+    vm1 = server1.openvz_delete(200)
+    wait_status(server1, vm1)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create spec (in file spec/lib/proxmox_spec.rb)
+4. Write your code (in lib/proxmox.rb)
+5. Check spec & coverage (`bundle exec rspec` or `bundle exec guard`)
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/proxmox.rb

@@ -0,0 +1,405 @@
+# encoding: utf-8
+
+require 'proxmox/version'
+require 'rest_client'
+require 'json'
+
+# This module encapsulates ability to manage Proxmox server
+module Proxmox
+  # Object to manage Proxmox server
+  class Proxmox
+    # Return connection status
+    # - connected
+    # - error
+    attr_reader :connection_status
+
+    # Create a object to manage a Proxmox server through API
+    #
+    # :call-seq:
+    #   new(pve_cluster, node, username, password, realm, ssl_options) -> Proxmox
+    #
+    # Example:
+    #
+    #   Proxmox::Proxmox.new('https://the-proxmox-server:8006/api2/json/', 'node', 'root', 'secret', 'pam', {verify_ssl: false})
+    #
+    def initialize(pve_cluster, node, username, password, realm, ssl_options = {})
+      @pve_cluster = pve_cluster
+      @node = node
+      @username = username
+      @password = password
+      @realm = realm
+      @ssl_options = ssl_options
+      @connection_status = 'error'
+      @site = RestClient::Resource.new(@pve_cluster, @ssl_options)
+      @auth_params = create_ticket
+    end
+
+    def get(path, args = {})
+      http_action_get(path, args)
+    end
+
+    def post(path, args = {})
+      http_action_post(path, args)
+    end
+
+    def put(path, args = {})
+      http_action_put(path, args)
+    end
+
+    def delete(path)
+      http_action_delete(path)
+    end
+
+    # Get task status
+    #
+    # :call-seq:
+    #   task_status(task-id) -> String
+    #
+    # - taksstatus
+    # - taskstatus:exitstatus
+    #
+    # Example:
+    #
+    #   taskstatus 'UPID:localhost:00051DA0:119EAABC:521CCB19:vzcreate:203:root@pam:'
+    #
+    # Examples return:
+    #   - running
+    #   - stopped:OK
+    #
+    def task_status(upid)
+      data = http_action_get "nodes/#{@node}/tasks/#{URI.encode upid}/status"
+      status = data['status']
+      exitstatus = data['exitstatus']
+      if exitstatus
+        "#{status}:#{exitstatus}"
+      else
+        "#{status}"
+      end
+    end
+
+    # Get template list
+    #
+    # :call-seq:
+    #   templates -> Hash
+    #
+    # Return a Hash of all templates
+    #
+    # Example:
+    #
+    #   templates
+    #
+    # Example return:
+    #
+    #   {
+    #     'ubuntu-10.04-standard_10.04-4_i386' => {
+    #         'format' => 'tgz',
+    #         'content' => 'vztmpl',
+    #         'volid' => 'local:vztmpl/ubuntu-10.04-standard_10.04-4_i386.tar.gz',
+    #         'size' => 142126884
+    #     },
+    #     'ubuntu-12.04-standard_12.04-1_i386' => {
+    #         'format' => 'tgz',
+    #         'content' => 'vztmpl',
+    #         'volid' => 'local:vztmpl/ubuntu-12.04-standard_12.04-1_i386.tar.gz',
+    #          'size' => 130040792
+    #     }
+    #  }
+    #
+    def templates
+      data = http_action_get "nodes/#{@node}/storage/local/content"
+      template_list = {}
+      data.each do |ve|
+        name = ve['volid'].gsub(%r{local:vztmpl\/(.*).tar.gz}, '\1')
+        template_list[name] = ve
+      end
+      template_list
+    end
+
+    # Get CT list
+    #
+    # :call-seq:
+    #   openvz_get -> Hash
+    #
+    # Return a Hash of all openvz container
+    #
+    # Example:
+    #
+    #   openvz_get
+    #
+    # Example return:
+    #   {
+    #     '101' => {
+    #           'maxswap' => 536870912,
+    #           'disk' => 405168128,
+    #           'ip' => '192.168.1.5',
+    #           'status' => 'running',
+    #           'netout' => 272,
+    #           'maxdisk' => 4294967296,
+    #           'maxmem' => 536870912,
+    #           'uptime' => 3068073,
+    #           'swap' => 0,
+    #           'vmid' => '101',
+    #           'nproc' => '10',
+    #           'diskread' => 0,
+    #           'cpu' => 0.00031670581100007,
+    #           'netin' => 0,
+    #           'name' => 'test2.domain.com',
+    #           'failcnt' => 0,
+    #           'diskwrite' => 0,
+    #           'mem' => 22487040,
+    #           'type' => 'openvz',
+    #           'cpus' => 1
+    #     },
+    #     [...]
+    #   }
+    def openvz_get
+      data = http_action_get "nodes/#{@node}/openvz"
+      ve_list = {}
+      data.each do |ve|
+        ve_list[ve['vmid']] = ve
+      end
+      ve_list
+    end
+
+    # Create CT container
+    #
+    # :call-seq:
+    #   openvz_post(ostemplate, vmid) -> String
+    #   openvz_post(ostemplate, vmid, options) -> String
+    #
+    # Return a String as task ID
+    #
+    # Examples:
+    #
+    #   openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200)
+    #   openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200, {'hostname' => 'test.test.com', 'password' => 'testt' })
+    #
+    # Example return:
+    #
+    #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzcreate:200:root@pam:
+    #
+    def openvz_post(ostemplate, vmid, config = {})
+      config['vmid'] = vmid
+      config['ostemplate'] = "local%3Avztmpl%2F#{ostemplate}.tar.gz"
+      vm_definition = config.to_a.map { |v| v.join '=' }.join '&'
+
+      http_action_post("nodes/#{@node}/openvz", vm_definition)
+    end
+
+    # Delete CT
+    #
+    # :call-seq:
+    #   openvz_delete(vmid) -> String
+    #
+    # Return a string as task ID
+    #
+    # Example:
+    #
+    #   openvz_delete(200)
+    #
+    # Example return:
+    #
+    #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzdelete:200:root@pam:
+    #
+    def openvz_delete(vmid)
+      http_action_delete "nodes/#{@node}/openvz/#{vmid}"
+    end
+
+    # Get CT status
+    #
+    # :call-seq:
+    #   openvz_delete(vmid) -> String
+    #
+    # Return a string as task ID
+    #
+    # Example:
+    #
+    #   openvz_delete(200)
+    #
+    # Example return:
+    #
+    #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzdelete:200:root@pam:
+    #
+    def openvz_status(vmid)
+      http_action_get "nodes/#{@node}/openvz/#{vmid}/status/current"
+    end
+
+    # Start CT
+    #
+    # :call-seq:
+    #   openvz_start(vmid) -> String
+    #
+    # Return a string as task ID
+    #
+    # Example:
+    #
+    #   openvz_start(200)
+    #
+    # Example return:
+    #
+    #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzstart:200:root@pam:
+    #
+    def openvz_start(vmid)
+      http_action_post "nodes/#{@node}/openvz/#{vmid}/status/start"
+    end
+
+    # Stop CT
+    #
+    # :call-seq:
+    #   openvz_stop(vmid) -> String
+    #
+    # Return a string as task ID
+    #
+    # Example:
+    #
+    #   openvz_stop(200)
+    #
+    # Example return:
+    #
+    #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzstop:200:root@pam:
+    #
+    def openvz_stop(vmid)
+      http_action_post "nodes/#{@node}/openvz/#{vmid}/status/stop"
+    end
+
+    # Shutdown CT
+    #
+    # :call-seq:
+    #   openvz_shutdown(vmid) -> String
+    #
+    # Return a string as task ID
+    #
+    # Example:
+    #
+    #   openvz_shutdown(200)
+    #
+    # Example return:
+    #
+    #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzshutdown:200:root@pam:
+    #
+    def openvz_shutdown(vmid)
+      http_action_post "nodes/#{@node}/openvz/#{vmid}/status/shutdown"
+    end
+
+    # Get CT config
+    #
+    # :call-seq:
+    #   openvz_config(vmid) -> String
+    #
+    # Return a string as task ID
+    #
+    # Example:
+    #
+    #   openvz_config(200)
+    #
+    # Example return:
+    #
+    #   {
+    #     'quotaugidlimit' => 0,
+    #     'disk' => 0,
+    #     'ostemplate' => 'ubuntu-10.04-standard_10.04-4_i386.tar.gz',
+    #     'hostname' => 'test.test.com',
+    #     'nameserver' => '127.0.0.1 192.168.1.1',
+    #     'memory' => 256,
+    #     'searchdomain' => 'domain.com',
+    #     'onboot' => 0,
+    #     'cpuunits' => 1000,
+    #     'swap' => 256,
+    #     'quotatime' => 0,
+    #     'digest' => 'e7e6e21a215af6b9da87a8ecb934956b8983f960',
+    #     'cpus' => 1,
+    #     'storage' => 'local'
+    #   }
+    #
+    def openvz_config(vmid)
+      http_action_get "nodes/#{@node}/openvz/#{vmid}/config"
+    end
+
+    # Set CT config
+    #
+    # :call-seq:
+    #   openvz_config_set(vmid, parameters) -> Nil
+    #
+    # Return nil
+    #
+    # Example:
+    #
+    #   openvz_config(200, { 'swap' => 2048 })
+    #
+    # Example return:
+    #
+    #   nil
+    #
+    def openvz_config_set(vmid, data)
+      http_action_put("nodes/#{@node}/openvz/#{vmid}/config", data)
+    end
+
+    # Reset Qemu
+    def qemu_reset(vmid)
+      http_action_post("nodes/#{@node}/qemu/#{vmid}/status/reset")
+    end
+
+    private
+
+    # Methods manages auth
+    def create_ticket
+      post_param = { username: @username, realm: @realm, password: @password }
+      @site['access/ticket'].post post_param do |response, _request, _result, &_block|
+        if response.code == 200
+          extract_ticket response
+        else
+          @connection_status = 'error'
+        end
+      end
+    end
+
+    # Method create ticket
+    def extract_ticket(response)
+      data = JSON.parse(response.body)
+      ticket = data['data']['ticket']
+      csrf_prevention_token = data['data']['CSRFPreventionToken']
+      unless ticket.nil?
+        token = 'PVEAuthCookie=' + ticket.gsub!(/:/, '%3A').gsub!(/=/, '%3D')
+      end
+      @connection_status = 'connected'
+      {
+        CSRFPreventionToken: csrf_prevention_token,
+        cookie: token
+      }
+    end
+
+    # Extract data or return error
+    def check_response(response)
+      if response.code == 200
+        JSON.parse(response.body)['data']
+      else
+        'NOK: error code = ' + response.code.to_s
+      end
+    end
+
+    # Methods manage http dialogs
+    def http_action_post(url, data = {})
+      @site[url].post data, @auth_params do |response, _request, _result, &_block|
+        check_response response
+      end
+    end
+
+    def http_action_put(url, data = {})
+      @site[url].put data, @auth_params do |response, _request, _result, &_block|
+        check_response response
+      end
+    end
+
+    def http_action_get(url, data = {})
+      @site[url].get @auth_params.merge(data) do |response, _request, _result, &_block|
+        check_response response
+      end
+    end
+
+    def http_action_delete(url)
+      @site[url].delete @auth_params do |response, _request, _result, &_block|
+        check_response response
+      end
+    end
+  end
+end

data/lib/proxmox/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Proxmox
+  VERSION = '1.0.0'
+end

data/ruby-proxmox.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'proxmox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-proxmox'
+  spec.version       = Proxmox::VERSION
+  spec.authors       = ['Nathaniel Suchy', 'Nicolas Ledez']
+  spec.email         = ['me@lunorian.is']
+  spec.description   = 'A ruby gem for managing Proxmox Servers with Ruby. Based on https://github.com/nledez/proxmox'
+  spec.summary       = 'A ruby gem for managing Proxmox Servers with Ruby. Based on https://github.com/nledez/proxmox'
+  spec.homepage      = 'https://github.com/ulayer/ruby-proxmox'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.add_dependency 'rest-client', '>=1.6.7'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+end

data/spec/lib/proxmox_spec.rb

@@ -0,0 +1,294 @@
+require 'spec_helper'
+require 'webmock/rspec'
+require 'proxmox'
+
+describe Proxmox do
+  before(:each) do
+    @common_headers_in = { 'User-Agent' => 'Ruby',
+                           'Cookie' => /.*/,
+                           'Csrfpreventiontoken' => /.*/ }
+    @common_headers_out = { connection: 'close',
+                            server: 'pve-api-daemon/3.0',
+                            content_type: 'application/json;charset=UTF-8' }
+
+    # Common auth
+    stub_request(:post, 'http://localhost:8006/api2/json/access/ticket').with(
+      headers: {
+        'Content-Type' => 'application/x-www-form-urlencoded',
+        'User-Agent' => 'Ruby'
+      },
+      body: {
+        'username' => 'root',
+        'password' => 'secret',
+        'realm' => 'pam'
+      }
+    ).to_return(
+      status: 200,
+      headers: @common_headers_out,
+      body: '{"data":{"cap":{"dc":{"Sys.Audit":1},"access":{"Group.Allocate":1,"User.Modify":1},"nodes":{"Sys.Audit":1,"Sys.Syslog":1,"Sys.Console":1,"Sys.Modify":1,"Sys.PowerMgmt":1},"vms":{"VM.Backup":1,"VM.Allocate":1,"VM.Config.CPU":1,"VM.Config.Network":1,"VM.Migrate":1,"VM.Config.Memory":1,"VM.Config.Options":1,"Permissions.Modify":1,"VM.Monitor":1,"VM.Console":1,"VM.Config.Disk":1,"VM.Config.HWType":1,"VM.Clone":1,"VM.Snapshot":1,"VM.Audit":1,"VM.PowerMgmt":1,"VM.Config.CDROM":1},"storage":{"Datastore.AllocateTemplate":1,"Datastore.Allocate":1,"Datastore.Audit":1,"Permissions.Modify":1,"Datastore.AllocateSpace":1}},"CSRFPreventionToken":"51F00E60:Pnd0AHehuTE++j87nUz0nLuyW+0","ticket":"PVE:root@pam:51F00E60::OS5lBKlaabgnmekdbVY2JYAbd5Z/MPWCeZ9b33UwjsE1yVB1esIwUQoXJ4Xgb/+UVE9mtS2K3dJ65wyPDsGYTDc0TCl0VmdOGz7djXMlMy5ShRjXcX/GLs77LHXlLQOO+ED/jCoz0tHV55igNSBNMG2UrSLlTGvgm8zf1fNqAsVszrAWgeFu+e/1CLIfs//cWyimBuDx+r3m/NOjaoyeb2u63eBCPrWyEiCJZniMZDVnqqQcOm32tE2XQj4D2LS+xaHn2fdZDlcAo0uY4qVspKiMjf9g2AudRblkobCTf7KdhanIm0kCSqkvHJy2EMcAbxcqnGnjPiYSH0WYZMTnlA==","username":"root@pam"}}'
+    )
+
+    @server1 = Proxmox::Proxmox.new('http://localhost:8006/api2/json/', 'localhost', 'root', 'secret', 'pam')
+  end
+
+  describe 'get' do
+    it 'calls http_action_get' do
+      expect(@server1).to receive(:http_action_get).with("version", {})
+      @server1.get("version")
+    end
+  end
+  
+  describe 'post' do
+    it 'calls http_action_post' do
+      expect(@server1).to receive(:http_action_post).with("version", {})
+      @server1.post("version")
+    end
+  end
+  
+  describe 'put' do
+    it 'calls http_action_put' do
+      expect(@server1).to receive(:http_action_put).with("version", {})
+      @server1.put("version")
+    end
+  end
+  
+  describe 'delete' do
+    it 'calls http_action_delete' do
+      expect(@server1).to receive(:http_action_delete).with("version")
+      @server1.delete("version")
+    end
+  end
+  
+  it 'should connect to Proxmox server' do
+    # Bad auth
+    stub_request(:post, 'http://localhost:8006/api2/json/access/ticket').with(
+      headers: {
+        'Content-Type' => 'application/x-www-form-urlencoded',
+        'User-Agent' => 'Ruby'
+      },
+      body: {
+        'username' => 'root',
+        'password' => 'bad',
+        'realm' => 'pam'
+      }
+    ).to_return(
+      status: 500,
+      headers: @common_headers_out,
+      body: '{"data":null}'
+    )
+    expect(@server1.connection_status).to eq 'connected'
+
+    server2 = Proxmox::Proxmox.new('http://localhost:8006/api2/json/', 'localhost', 'root', 'bad', 'pam')
+    expect(server2.connection_status).to eq 'error'
+  end
+
+  describe 'task_status' do
+    it 'should get task status' do
+      # Status done
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/localhost/tasks/UPID:localhost:00051DA0:119EAABB:521CCB19:vzcreate:200:root@pam:/status').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: {
+            connection: 'close', server: 'pve-api-daemon/3.0', content_type: 'application/json;charset=UTF-8' },
+          body: '{"data":{"exitstatus":"OK","status":"stopped","upid":"UPID:localhost:00051DA0:119EAABB:521CCB19:vzcreate:200:root@pam:","node":"localhost","pid":335264,"starttime":1377618713,"user":"root@pam","type":"vzcreate","id":"200","pstart":295611067}}'
+        )
+
+      # Status running
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/localhost/tasks/UPID:localhost:00055DDA:11A99D07:521CE71F:vzcreate:200:root@pam:/status').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":{"status":"running","upid":"UPID:localhost:00055DDA:11A99D07:521CE71F:vzcreate:200:root@pam:","node":"localhost","pid":351706,"starttime":1377625887,"user":"root@pam","type":"vzcreate","id":"200","pstart":296328455}}'
+        )
+
+      # Get status
+      expect(@server1.task_status('UPID:localhost:00051DA0:119EAABB:521CCB19:vzcreate:200:root@pam:')).to be_eql 'stopped:OK'
+      expect(@server1.task_status('UPID:localhost:00055DDA:11A99D07:521CE71F:vzcreate:200:root@pam:')).to be_eql 'running'
+    end
+  end
+
+  describe 'templates' do
+    it 'should get template list' do
+      # First template list
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/localhost/storage/local/content').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":[{"format":"tgz","content":"vztmpl","volid":"local:vztmpl/ubuntu-10.04-standard_10.04-4_i386.tar.gz","size":142126884},{"format":"tgz","content":"vztmpl","volid":"local:vztmpl/ubuntu-12.04-standard_12.04-1_i386.tar.gz","size":130040792}]}'
+        )
+
+      expect(@server1.templates).to be_an_instance_of Hash
+      expect(@server1.templates.keys.sort).to be_eql ['ubuntu-10.04-standard_10.04-4_i386', 'ubuntu-12.04-standard_12.04-1_i386']
+    end
+  end
+
+  describe 'openvz_get' do
+    it 'should get openvz vm list' do
+      # First VM list
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/localhost/openvz').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":[{"maxswap":536870912,"disk":404037632,"ip":"192.168.1.5","status":"running","netout":272,"maxdisk":4294967296,"maxmem":536870912,"uptime":3847,"swap":0,"vmid":"101","nproc":"10","diskread":0,"cpu":0.00183354942808597,"netin":0,"name":"test2.dummy.tld","failcnt":0,"diskwrite":0,"mem":21303296,"type":"openvz","cpus":1},{"maxswap":536870912,"disk":387186688,"ip":"192.168.1.1","status":"running","netout":272,"maxdisk":4294967296,"maxmem":536870912,"uptime":17120,"swap":0,"vmid":"100","nproc":"17","diskread":0,"cpu":0.000504170031344927,"netin":0,"name":"test.dummy.tld","failcnt":0,"diskwrite":0,"mem":27987968,"type":"openvz","cpus":1}]}'
+        )
+
+      # Second VM list
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/otherone/openvz').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":[{"maxswap":536870912,"disk":404041728,"ip":"192.168.1.5","status":"running","netout":272,"maxdisk":4294967296,"maxmem":536870912,"uptime":6176,"swap":0,"vmid":"101","nproc":"10","diskread":0,"cpu":0.00161487378340585,"netin":0,"name":"test2.dummy.tld","failcnt":0,"diskwrite":0,"mem":21299200,"type":"openvz","cpus":1},{"maxswap":2147483648,"disk":0,"ip":"10.0.0.1","status":"stopped","netout":0,"maxdisk":10737418240,"maxmem":1073741824,"uptime":0,"swap":0,"vmid":"102","nproc":0,"diskread":0,"cpu":0,"netin":0,"name":"test3.other.domain","failcnt":0,"diskwrite":0,"mem":0,"type":"openvz","cpus":2},{"maxswap":536870912,"disk":387194880,"ip":"192.168.1.1","status":"running","netout":272,"maxdisk":4294967296,"maxmem":536870912,"uptime":19449,"swap":0,"vmid":"100","nproc":"17","diskread":0,"cpu":0.000589570582552814,"netin":0,"name":"test.dummy.tld","failcnt":0,"diskwrite":0,"mem":28282880,"type":"openvz","cpus":1}]}'
+        )
+
+      expect(@server1.openvz_get).to be_an_instance_of Hash
+      expect(@server1.openvz_get.keys.sort).to be_eql %w(100 101)
+
+      server2 = Proxmox::Proxmox.new('http://localhost:8006/api2/json/', 'otherone', 'root', 'secret', 'pam')
+      expect(server2.openvz_get).to be_an_instance_of Hash
+      expect(server2.openvz_get.keys.sort).to be_eql %w(100 101 102)
+    end
+  end
+
+  describe 'openvz_post' do
+    it 'should create a container' do
+      # Create VM
+      stub_request(:post, 'http://localhost:8006/api2/json/nodes/localhost/openvz').with(
+        body: 'vmid=200&ostemplate=local%3Avztmpl%2Fubuntu-10.04-standard_10.04-4_i386.tar.gz',
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":"UPID:localhost:00051DA0:119EAABB:521CCB19:vzcreate:200:root@pam:"}'
+        )
+
+      stub_request(:post, 'http://localhost:8006/api2/json/nodes/localhost/openvz').with(
+        body: 'hostname=vm1.domain.com&password=secret&memory=512&swap=512&disk=4&vmid=203&ostemplate=local%3Avztmpl%2Fubuntu-10.04-standard_10.04-4_i386.tar.gz',
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":"UPID:localhost:00051DA0:119EAABC:521CCB19:vzcreate:203:root@pam:"}'
+        )
+
+      stub_request(:post, 'http://localhost:8006/api2/json/nodes/localhost/openvz').with(
+        body: 'vmid=204&ostemplate=local%3Avztmpl%2Fubuntu-10.04-standard_10.04-4_i386.tar.gz',
+        headers: @common_headers_in).to_return(
+          status: 500,
+          headers: { connection: 'close', server: 'pve-api-daemon/3.0', content_type: 'application/json;charset=UTF-8'
+          },
+          body: 'NOK: error code = 500'
+        )
+
+      # Create the vm
+      expect(@server1.openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200)).to be_eql 'UPID:localhost:00051DA0:119EAABB:521CCB19:vzcreate:200:root@pam:'
+      expect(@server1.openvz_post('ubuntu-10.04-standard_10.04-4_i386', 203, 'hostname' => 'vm1.domain.com', 'password' => 'secret', 'memory' => 512, 'swap' => 512, 'disk' => 4)).to be_eql 'UPID:localhost:00051DA0:119EAABC:521CCB19:vzcreate:203:root@pam:'
+      expect(@server1.openvz_post('ubuntu-10.04-standard_10.04-4_i386', 204)).to be_eql 'NOK: error code = 500'
+    end
+  end
+
+  describe 'openvz_delete' do
+    it 'should delete openvz container' do
+      # Delete VM
+      stub_request(:delete, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":"UPID:localhost:0005C1EB:11BAA4EB:521D12B8:vzdestroy:200:root@pam:"}'
+        )
+
+      stub_request(:delete, 'http://localhost:8006/api2/json/nodes/localhost/openvz/201').with(
+        headers: @common_headers_in).to_return(
+          status: 500,
+          headers: @common_headers_out,
+          body: 'NOK: error code = 500'
+        )
+
+      # Delete the vm
+      expect(@server1.openvz_delete(200)).to be_eql 'UPID:localhost:0005C1EB:11BAA4EB:521D12B8:vzdestroy:200:root@pam:'
+      expect(@server1.openvz_delete(201)).to be_eql 'NOK: error code = 500'
+    end
+  end
+
+  describe 'openvz_status' do
+    it 'should get container status' do
+      # VM Status
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200/status/current').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":{"maxswap":268435456,"disk":0,"ip":"-","status":"stopped","ha":0,"netout":0,"maxdisk":9.44473296573929e+21,"maxmem":268435456,"uptime":0,"swap":0,"nproc":0,"diskread":0,"cpu":0,"netin":0,"name":"CT200","failcnt":0,"diskwrite":0,"mem":0,"type":"openvz","cpus":1}}'
+        )
+
+      expect(@server1.openvz_status(200)).to be_an_instance_of Hash
+      expect(@server1.openvz_status(200)['status']).to be_eql 'stopped'
+      expect(@server1.openvz_status(200)['cpus']).to be_eql 1
+    end
+  end
+
+  describe 'openvz_start' do
+    it 'should start vm' do
+      stub_request(:post, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200/status/start').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":"UPID:ks311324:0005D91C:11BE5277:521D1C23:vzstart:200:root@pam:"}'
+        )
+
+      expect(@server1.openvz_start(200)).to be_eql 'UPID:ks311324:0005D91C:11BE5277:521D1C23:vzstart:200:root@pam:'
+    end
+  end
+  
+  describe 'openvz_stop' do
+    it 'should stop vm' do
+      stub_request(:post, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200/status/stop').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":"UPID:ks311324:0005D91C:11BE5277:521D1C23:vzstop:200:root@pam:"}'
+        )
+
+      expect(@server1.openvz_stop(200)).to be_eql 'UPID:ks311324:0005D91C:11BE5277:521D1C23:vzstop:200:root@pam:'
+    end
+  end
+  
+  describe 'openvz_shutdown' do
+    it 'should shutdown vm' do
+      stub_request(:post, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200/status/shutdown').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":"UPID:ks311324:0005D91C:11BE5277:521D1C23:vzshutdown:200:root@pam:"}'
+        )
+
+      expect(@server1.openvz_shutdown(200)).to be_eql 'UPID:ks311324:0005D91C:11BE5277:521D1C23:vzshutdown:200:root@pam:'
+    end
+  end
+
+  describe 'openvz_config' do
+    it 'should get container config' do
+      # VM config
+      stub_request(:get, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200/config').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":{"quotaugidlimit":0,"disk":0,"ostemplate":"ubuntu-10.04-standard_10.04-4_i386.tar.gz","nameserver":"127.0.0.1 192.168.1.1","memory":256,"searchdomain":"domain.com","onboot":0,"cpuunits":1000,"swap":256,"quotatime":0,"digest":"5a6f4052d559d3ecc89c849214f482217018a07e","cpus":1,"storage":"local"}}'
+        )
+
+      expect(@server1.openvz_config(200)).to be_an_instance_of Hash
+      expect(@server1.openvz_config(200)['searchdomain']).to be_eql 'domain.com'
+      expect(@server1.openvz_config(200)['ostemplate']).to be_eql 'ubuntu-10.04-standard_10.04-4_i386.tar.gz'
+    end
+  end
+
+  describe 'openvz_config_set' do
+    it 'should modify container config' do
+      # VM config
+      stub_request(:put, 'http://localhost:8006/api2/json/nodes/localhost/openvz/200/config').with(
+        headers: @common_headers_in).to_return(
+          status: 200,
+          headers: @common_headers_out,
+          body: '{"data":null}'
+        )
+
+      @server1.openvz_config_set(200, 'searchdomain' => 'other.com')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'spork'
+require 'rspec'
+
+Spork.prefork do
+  unless ENV['DRB']
+    require 'simplecov'
+    SimpleCov.start 'rails'
+  end
+end
+
+Spork.each_run do
+  if ENV['DRB']
+    require 'simplecov'
+    SimpleCov.start 'rails'
+  end
+end
+
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: ruby-proxmox
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathaniel Suchy
+- Nicolas Ledez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: webmock
+  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: A ruby gem for managing Proxmox Servers with Ruby. Based on https://github.com/nledez/proxmox
+email:
+- me@lunorian.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/proxmox.rb
+- lib/proxmox/version.rb
+- ruby-proxmox.gemspec
+- spec/lib/proxmox_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ulayer/ruby-proxmox
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A ruby gem for managing Proxmox Servers with Ruby. Based on https://github.com/nledez/proxmox
+test_files:
+- spec/lib/proxmox_spec.rb
+- spec/spec_helper.rb