update readme, guzzle 7 support, PMG support

Author: linushstge

README.md

@@ -1,135 +1,7 @@
-ProxmoxVE API Client
+Proxmox API Client for Proxmox VE & Proxmox MG
 ====================
 
-This **PHP 5.5+** library allows you to interact with your Proxmox server via API.
-
-[![Build Status](https://travis-ci.org/ZzAntares/ProxmoxVE.svg?branch=master)](https://travis-ci.org/ZzAntares/ProxmoxVE)
-[![Latest Stable Version](https://poser.pugx.org/zzantares/proxmoxve/v/stable.svg)](https://packagist.org/packages/zzantares/proxmoxve)
-[![Total Downloads](https://poser.pugx.org/zzantares/proxmoxve/downloads.svg)](https://packagist.org/packages/zzantares/proxmoxve)
-[![Latest Unstable Version](https://poser.pugx.org/zzantares/proxmoxve/v/unstable.svg)](https://packagist.org/packages/zzantares/proxmoxve)
-[![License](https://poser.pugx.org/zzantares/proxmoxve/license.svg)](https://packagist.org/packages/zzantares/proxmoxve)
-
-> I'm not actively maintaining this library anymore (I've left PHP behind) but **the API is pretty stable**, if it doesn't suit your needs take a look at the forks or better yet create a PR to add the things you're missing, if you're interested I can transfer the project to you.
-
-**Looking for a PHP 5.3 library version?** Search through the [releases](https://github.com/ZzAntares/ProxmoxVE/releases) one that fits your needs, I recommend using the [2.1.1](https://github.com/ZzAntares/ProxmoxVE/releases/tag/v2.1.1) version.
-
-
-Installation
-------------
-
-Recommended installation is using [Composer], if you do not have [Composer] what are you waiting?
-
-In the root of your project execute the following:
-
-```sh
-$ composer require zzantares/proxmoxve ~4.0
-```
-
-Or add this to your `composer.json` file:
-
-```json
-{
-    "require": {
-        "zzantares/proxmoxve": "~4.0"
-    }
-}
-```
-
-Then perform the installation:
-```sh
-$ composer install --no-dev
-```
-
-
-Usage
------
-
-```php
-<?php
-
-// Require the autoloader
-require_once 'vendor/autoload.php';
-
-// Use the library namespace
-use ProxmoxVE\Proxmox;
-
-// Create your credentials array
-$credentials = [
-    'hostname' => 'proxmox.server.com',  // Also can be an IP
-    'username' => 'root',
-    'password' => 'secret',
-];
-
-// realm and port defaults to 'pam' and '8006' but you can specify them like so
-$credentials = [
-    'hostname' => 'proxmox.server.com',
-    'username' => 'root',
-    'password' => 'secret',
-    'realm' => 'pve',
-    'port' => '9009',
-];
-
-// Then simply pass your credentials when creating the API client object.
-$proxmox = new Proxmox($credentials);
-
-$allNodes = $proxmox->get('/nodes');
-
-print_r($allNodes);
-```
-
-
-Sample output:
-
-```php
-Array
-(
-    [data] => Array
-        (
-            [0] => Array
-                (
-                    [disk] => 2539465464
-                    [cpu] => 0.031314446882002
-                    [maxdisk] => 30805066770
-                    [maxmem] => 175168446464
-                    [node] => mynode1
-                    [maxcpu] => 24
-                    [level] =>
-                    [uptime] => 139376
-                    [id] => node/mynode1
-                    [type] => node
-                    [mem] => 20601992182
-                )
-
-        )
-
-)
-```
-
-
-Want to know more nifty tricks?
--------------------------------
-
-Checkout our [wiki](https://github.com/ZzAntares/ProxmoxVE/wiki).
-
-
-Docs
-----
-
-On your proxmox client object you can use `get()`, `create()`, `set()` and `delete()` functions for all resources specified at [PVE2 API Documentation], params are passed as the second parameter in an associative array.
-
-**What resources or paths can I interact with and how?**
-
-In your proxmox server you can use the [pvesh CLI Tool](http://pve.proxmox.com/wiki/Proxmox_VE_API#Using_.27pvesh.27_to_access_the_API) to manage all the pve resources, you can use this library in the exact same way you would use the pvesh tool. For instance you could run `pvesh` then, as the screen message should say, you can type `help [path] [--verbose]` to see how you could use a path and what params you should pass to it. Be sure to [read about the pvesh CLI Tool](http://pve.proxmox.com/wiki/Proxmox_VE_API#Using_.27pvesh.27_to_access_the_API) at the [Proxmox wiki].
-
-**How does the Proxmox API works?**
-
-Consult the [ProxmoxVE API] article at the [Proxmox wiki].
-
-**I feel you're hiding some cool tricks! I need more docs!**
-
-See the project's [wiki](https://github.com/ZzAntares/ProxmoxVE/wiki) for a more
-detailed documentation, it's all in there I swear it... I think.
-
+Forked from [https://github.com/ZzAntares/ProxmoxVE](ZzAntares)
 
 License
 -------

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "zzantares/proxmoxve",
     "type": "library",
-    "description": "A simple PHP 5.5+ Proxmox API client.",
+    "description": "A simple PHP 7+ Proxmox API client for VE and MG.",
     "keywords": ["Proxmox", "API", "KVM", "OpenVZ", "Virtualization"],
     "homepage": "https://github.com/ZzAntares/ProxmoxVE",
     "license": "MIT",
@@ -11,6 +11,11 @@
             "name": "César Muñoz",
             "email": "[email protected]",
             "role": "Developer"
+        },
+        {
+            "name": "Linus Holtstiege",
+            "email": "[email protected]",
+            "role": "Developer"
         }
     ],
 
@@ -20,9 +25,9 @@
     },
 
     "require": {
-        "php": ">=5.5.0",
+        "php": ">=7.0.0",
         "lib-curl": "*",
-        "guzzlehttp/guzzle": "~6.0 || ~7.0"
+        "guzzlehttp/guzzle": "^7.0"
     },
 
     "require-dev": {

src/Credentials.php

@@ -44,6 +44,11 @@ class Credentials
      */
     private $port;
 
+    /**
+     * @var string The Proxmox system being used (defaults to "pve" if not provided).
+     */
+    private $system;
+
     /**
      * Construct.
      *
@@ -65,6 +70,7 @@ public function __construct($credentials)
         $this->password = $credentials['password'];
         $this->realm = $credentials['realm'];
         $this->port = $credentials['port'];
+        $this->system = $credentials['system'];
     }
 
 
@@ -150,6 +156,15 @@ public function getPort()
         return $this->port;
     }
 
+    /**
+     * Gets the system configured in this credentials object.
+     *
+     * @return string The port in the credentials.
+     */
+    public function getSystem()
+    {
+        return $this->system;
+    }
 
     /**
      * Given the custom credentials object it will try to find the required
@@ -184,6 +199,10 @@ public function parseCustomCredentials($credentials)
                 $credentials['port'] = '8006';
             }
 
+            if (!isset($credentials['system'])) {
+                $credentials['system'] = 'pve';
+            }
+
             return $credentials;
         }
 
@@ -206,12 +225,17 @@ public function parseCustomCredentials($credentials)
                 ? $credentials->port
                 : '8006';
 
+            $system = in_array('system', $objectProperties)
+                ? $credentials->system
+                : 'pve';
+
             return [
                 'hostname' => $credentials->hostname,
                 'username' => $credentials->username,
                 'password' => $credentials->password,
                 'realm' => $realm,
                 'port' => $port,
+                'system' => $system,
             ];
         }
 
@@ -231,12 +255,17 @@ public function parseCustomCredentials($credentials)
                 ? $credentials->getPort()
                 : '8006';
 
+            $system = method_exists($credentials, 'getSystem')
+                ? $credentials->getSystem()
+                : 'pve';
+
             return [
                 'hostname' => $credentials->getHostname(),
                 'username' => $credentials->getUsername(),
                 'password' => $credentials->getPassword(),
                 'realm' => $realm,
                 'port' => $port,
+                'system' => $system,
             ];
         }
 
@@ -253,6 +282,7 @@ public function parseCustomCredentials($credentials)
                     'password' => $credentials->password,
                     'realm' => $credentials->realm ?: 'pam',
                     'port' => $credentials->port ?: '8006',
+                    'system' => $credentials->system ?: 'pve',
                 ];
             }
         }

src/Proxmox.php

@@ -109,7 +109,7 @@ private function requestResource($actionPath, $params = [], $method = 'GET')
         $url = $this->getApiUrl() . $actionPath;
 
         $cookies = CookieJar::fromArray([
-            'PVEAuthCookie' => $this->authToken->getTicket(),
+            $this->getCookieName() => $this->authToken->getTicket(),
         ], $this->credentials->getHostname());
 
         switch ($method) {
@@ -166,6 +166,21 @@ private function processHttpResponse($response)
         }
     }
 
+    /**
+     * Returns the name of the cookie that should be used to authenticate requests.
+     *
+     * @return string The required cookie for the system being used
+     */
+    private function getCookieName()
+    {
+        switch ($this->credentials->getSystem()) {
+            default:
+            case 'pve': $cookiename = 'PVEAuthCookie'; break;
+            case 'pmg': $cookiename = 'PMGAuthCookie'; break;
+        }
+
+        return $cookiename;
+    }
 
     /**
      * Sets the HTTP client to be used to send requests over the network, for

tests/ProxmoxTest.php

@@ -138,6 +138,23 @@ public function testLoginErrorThrowsException()
         new Proxmox($credentials, null, $httpClient);
     }
 
+    public function testCredentialsWithMailGatewaySystem()
+    {
+        $ids = [
+            'hostname' => 'some.proxmox.tld',
+            'username' => 'root',
+            'password' => 'I was here',
+            'system' => 'pmg',
+        ];
+
+        $fakeAuthToken = new AuthToken('csrf', 'ticket', 'username');
+        $proxmox = $this->getMockProxmox('login', $fakeAuthToken);
+        $proxmox->setCredentials($ids);
+
+        $credentials = $proxmox->getCredentials();
+
+        $this->assertEquals($credentials->getSystem(), 'pmg');
+    }
 
     public function testGetAndSetResponseType()
     {