Add possibility to specify custom response verifier

Author: vbaranovskiy-plesk

src/PleskX/Api/Client.php

@@ -25,6 +25,11 @@ class Client
 
     protected $_operatorsCache = [];
 
+    /**
+     * @var callable
+     */
+    protected $_verifyResponseCallback;
+
     /**
      * Create client
      *
@@ -71,6 +76,16 @@ public function setVersion($version)
         $this->_version = $version;
     }
 
+    /**
+     * Set custom function to verify response of API call according your own needs. Default verifying will be used if it is not specified
+     *
+     * @param callable|null $function
+     */
+    public function setVerifyResponse(callable $function = null)
+    {
+        $this->_verifyResponseCallback = $function;
+    }
+
     /**
      * Retrieve host used for communication
      *
@@ -143,7 +158,10 @@ public function request($request, $mode = self::RESPONSE_SHORT)
         } else {
             $xml = $this->_performHttpRequest($request);
         }
-        $this->_verifyResponse($xml);
+
+        $this->_verifyResponseCallback
+            ? call_user_func($this->_verifyResponseCallback, $xml)
+            : $this->_verifyResponse($xml);
 
         return (self::RESPONSE_FULL == $mode) ? $xml : $xml->xpath('//result')[0];
     }

tests/ApiClientTest.php

@@ -1,5 +1,6 @@
 <?php
 // Copyright 1999-2016. Parallels IP Holdings GmbH.
+use \PleskX\Api\Client\Exception;
 
 class ApiClientTest extends TestCase
 {
@@ -155,4 +156,19 @@ public function testGetProtocol()
         $this->assertEquals('http', $client->getProtocol());
     }
 
+    public function testSetVerifyResponse()
+    {
+        static::$_client->setVerifyResponse(function ($xml) {
+            if ($xml->xpath('//proto')) {
+                throw new Exception('proto');
+            }
+        });
+        try {
+            static::$_client->server()->getProtos();
+        } catch (Exception $e) {
+            $this->assertEquals('proto', $e->getMessage());
+        } finally {
+            static::$_client->setVerifyResponse();
+        }
+    }
 }