implement better bulk responses (#2)

* implement better bulk responses * phpunit fix * rename BasicMetaResponse to simple MetaData * remove composer version
mittwald · Jul 9, 2020 · 63ab718 · 63ab718
1 parent 0eefbb5
commit 63ab718
Show file tree

Hide file tree

Showing 20 changed files with 523 additions and 174 deletions.
diff --git a/composer.json b/composer.json
@@ -2,17 +2,17 @@
     "name": "mittwald/vault-php",
     "type": "library",
     "license": "MIT",
-    "version": "0.0.1",
     "homepage": "https://www.mittwald.de/",
     "description": "PHP library for Vault",
     "require": {
         "ext-json": "*",
-        "guzzlehttp/psr7": ">=1.6",
+        "guzzlehttp/psr7": "^1.6",
         "php": ">=5.6",
         "php-http/httplug": ">=1.1.0"
     },
     "suggest": {
-        "php-http/curl-client": "CURL Client Adapter"
+        "php-http/curl-client": "CURL Client Adapter",
+        "tuupola/http-factory": "HTTP Factory"
     },
     "require-dev": {
         "phpunit/phpunit": ">=5.0.0"

diff --git a/examples/BulkOperations.php b/examples/BulkOperations.php
@@ -10,6 +10,7 @@
 use VaultPHP\SecretEngines\Engines\Transit\Request\EncryptData\EncryptData;
 use VaultPHP\SecretEngines\Engines\Transit\Request\EncryptData\EncryptDataBulkRequest;
 use VaultPHP\SecretEngines\Engines\Transit\Request\UpdateKeyConfigRequest;
+use VaultPHP\SecretEngines\Engines\Transit\Response\EncryptDataResponse;
 use VaultPHP\SecretEngines\Engines\Transit\Transit;
 use VaultPHP\SecretEngines\Engines\Transit\EncryptionType;
 use VaultPHP\VaultClient;
@@ -52,11 +53,15 @@
     ]);
     $encryptBulkResponse = $transitApi->encryptDataBulk($encryptRequest);
 
+    // indicates that one or more bulk results contains errors
+    var_dump($encryptBulkResponse->hasErrors());
+
+    /** @var EncryptDataResponse $bulkResult */
     foreach($encryptBulkResponse as $bulkResult) {
         // BULK REQUEST WON'T THROW INVALID DATA EXCEPTIONS
         // SO YOU ARE RESPONSABLE TO CHECK IF EVERY BULK WAS
         // SUCCESSFULLY PROCESSED
-        if (!$bulkResult->getBasicMetaResponse()->hasErrors()) {
+        if (!$bulkResult->getMetaData()->hasErrors()) {
             var_dump($bulkResult->getCiphertext());
         }
     }

diff --git a/src/VaultPHP/Authentication/Provider/Kubernetes.php b/src/VaultPHP/Authentication/Provider/Kubernetes.php
@@ -57,7 +57,7 @@ public function authenticate()
             false
         );
 
-        if ($auth = $response->getBasicMetaResponse()->getAuth()) {
+        if ($auth = $response->getMetaData()->getAuth()) {
             return new AuthenticationMetaData($auth);
         }
 

diff --git a/src/VaultPHP/Authentication/Provider/UserPassword.php b/src/VaultPHP/Authentication/Provider/UserPassword.php
@@ -56,7 +56,7 @@ public function authenticate()
             false
         );
 
-        if ($auth = $response->getBasicMetaResponse()->getAuth()) {
+        if ($auth = $response->getMetaData()->getAuth()) {
             return new AuthenticationMetaData($auth);
         }
 

diff --git a/src/VaultPHP/Exceptions/VaultResponseException.php b/src/VaultPHP/Exceptions/VaultResponseException.php
@@ -30,7 +30,7 @@ public function __construct(ResponseInterface $response, RequestInterface $reque
         $this->request = $request;
 
         $parsedResponse = EndpointResponse::fromResponse($response);
-        $returnedErrors = $parsedResponse->getBasicMetaResponse()->getErrors();
+        $returnedErrors = $parsedResponse->getMetaData()->getErrors();
         $errors = implode(', ',  is_array($returnedErrors) ? $returnedErrors : []);
 
         parent::__construct($errors, $response->getStatusCode(), $prevException);

diff --git a/src/VaultPHP/Response/BulkEndpointResponse.php b/src/VaultPHP/Response/BulkEndpointResponse.php
@@ -0,0 +1,134 @@
+<?php
+
+namespace VaultPHP\Response;
+
+use ArrayAccess;
+use Countable;
+use Iterator;
+use VaultPHP\Exceptions\VaultException;
+
+/**
+ * Class BulkEndpointResponse
+ * @package VaultPHP\Response
+ */
+class BulkEndpointResponse extends EndpointResponse implements Iterator, ArrayAccess, Countable
+{
+    /** @var integer */
+    private $iteratorPosition = 0;
+
+    /**
+     * @var array
+     */
+    protected $batch_results = [];
+
+    /**
+     * @return bool
+     */
+    public function hasErrors() {
+        $errorOccurred = $this->getMetaData()->hasErrors();
+
+        if (!$errorOccurred) {
+            /** @var EndpointResponse $batchResult */
+            foreach ($this as $batchResult) {
+                $errorOccurred = $batchResult->getMetaData()->hasErrors();
+                if ($errorOccurred) {
+                    return true;
+                }
+            }
+        }
+
+        return $errorOccurred;
+    }
+
+    /**
+     * @return array
+     */
+    public function getBatchResults() {
+        return $this->batch_results;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function current()
+    {
+        return $this->batch_results[$this->iteratorPosition];
+    }
+
+    /**
+     * @return void
+     */
+    public function next()
+    {
+        ++$this->iteratorPosition;
+    }
+
+    /**
+     * @return integer
+     */
+    public function key()
+    {
+        return (int) $this->iteratorPosition;
+    }
+
+    /**
+     * @return bool
+     */
+    public function valid()
+    {
+        return isset($this->batch_results[$this->iteratorPosition]);
+    }
+
+    /**
+     * @return void
+     */
+    public function rewind()
+    {
+        $this->iteratorPosition = 0;
+    }
+
+    /**
+     * @return int
+     */
+    public function count()
+    {
+        return count($this->batch_results);
+    }
+
+    /**
+     * @param integer $offset
+     * @return bool
+     */
+    public function offsetExists($offset)
+    {
+        return isset($this->batch_results[$offset]);
+    }
+
+    /**
+     * @param integer $offset
+     * @return mixed
+     */
+    public function offsetGet($offset)
+    {
+        return $this->batch_results[$offset];
+    }
+
+    /**
+     * @param mixed $offset
+     * @param mixed $value
+     * @throws VaultException
+     */
+    public function offsetSet($offset, $value)
+    {
+        throw new VaultException('readonly');
+    }
+
+    /**
+     * @param mixed $offset
+     * @throws VaultException
+     */
+    public function offsetUnset($offset)
+    {
+        throw new VaultException('readonly');
+    }
+}
diff --git a/src/VaultPHP/Response/EndpointResponse.php b/src/VaultPHP/Response/EndpointResponse.php
@@ -10,24 +10,25 @@
  */
 class EndpointResponse implements EndpointResponseInterface
 {
-    /** @var BasicMetaResponse */
-    private $basicMetaResponse;
+    /** @var MetaData */
+    protected $metaData;
 
     /**
      * EndpointResponse constructor.
      * @param array|object $data
+     * @param array $meta
      */
-    public function __construct($data = [])
+    public function __construct($data = [], $meta = [])
     {
-        $this->basicMetaResponse = new BasicMetaResponse();
+        $this->metaData = new MetaData($meta);
         $this->populateData($data);
     }
 
     /**
      * @param $response
      * @return array
      */
-    private static function getResponseContent(ResponseInterface $response) {
+    protected static function getResponseContent(ResponseInterface $response) {
         $responseBody = $response->getBody();
         $responseBody->rewind();
         $responseBodyContents = $responseBody->getContents();
@@ -41,54 +42,40 @@ private static function getResponseContent(ResponseInterface $response) {
      * @param ResponseInterface $response
      * @return static
      */
-    static function fromResponse(ResponseInterface $response)
+    public static function fromResponse(ResponseInterface $response)
     {
         $metaData = static::getResponseContent($response);
 
         /** @var object|array $domainData */
         $domainData = isset($metaData['data']) ? $metaData['data'] : [];
         unset($metaData['data']);
 
-        $responseDTO = new static($domainData);
-        $responseDTO->basicMetaResponse = new BasicMetaResponse($metaData);
-
-        return $responseDTO;
+        return new static($domainData, $metaData);
     }
 
     /**
      * @param ResponseInterface $response
-     * @return static[]
+     * @return BulkEndpointResponse
      */
     static function fromBulkResponse(ResponseInterface $response)
     {
-        $resultArray = [];
         $metaData = static::getResponseContent($response);
 
-        /** @var object $domainData */
+        /** @var object|array $domainData */
         $domainData = isset($metaData['data']) ? $metaData['data'] : [];
         unset($metaData['data']);
 
-        if ($domainData && is_array($domainData->batch_results)) {
+        $responseDTO = new BulkEndpointResponse($domainData, $metaData);
+        $responseDTO->batch_results = array_map(function($batchResult) {
             /** @var object $batchResult */
-            foreach($domainData->batch_results as $batchResult) {
-                /** @var array $batchMetaData */
-                $batchMetaData = $metaData;
-
-                if (isset($batchResult->error)) {
-                    /** @var array $currentErrors */
-                    $currentErrors = isset($metaData['errors']) ? $metaData['errors'] : [];
-                    array_push($currentErrors, $batchResult->error);
 
-                    $batchMetaData['errors'] = $currentErrors;
-                }
-
-                $responseDTO = new static($batchResult);
-                $responseDTO->basicMetaResponse = new BasicMetaResponse($batchMetaData);
-                $resultArray[] = $responseDTO;
-            }
-        }
+            $errors = isset($batchResult->error) && $batchResult->error ? explode(', ', (string) $batchResult->error) : [];
+            return new static($batchResult, [
+                'errors' => $errors,
+            ]);
+        }, $responseDTO->batch_results);
 
-        return $resultArray;
+        return $responseDTO;
     }
 
     /**
@@ -107,10 +94,18 @@ private function populateData($data)
     }
 
     /**
-     * @return BasicMetaResponse
+     * @return MetaData
+     */
+    public function getMetaData()
+    {
+        return $this->metaData;
+    }
+
+    /**
+     * @return bool
      */
-    public function getBasicMetaResponse()
+    public function hasErrors()
     {
-        return $this->basicMetaResponse;
+        return (bool) $this->getMetaData()->hasErrors();
     }
 }
diff --git a/src/VaultPHP/Response/EndpointResponseInterface.php b/src/VaultPHP/Response/EndpointResponseInterface.php
@@ -12,12 +12,24 @@ interface EndpointResponseInterface
 {
     /**
      * @param ResponseInterface $response
-     * @return mixed
+     * @return static
      */
     static function fromResponse(ResponseInterface $response);
 
     /**
-     * @return BasicMetaResponse
+     * @param ResponseInterface $response
+     * @return BulkEndpointResponse
+     */
+    static function fromBulkResponse(ResponseInterface $response);
+
+
+    /**
+     * @return MetaData
+     */
+    public function getMetaData();
+
+    /**
+     * @return bool
      */
-    public function getBasicMetaResponse();
+    public function hasErrors();
 }
diff --git a/src/VaultPHP/Response/BasicMetaResponse.php → src/VaultPHP/Response/MetaData.php b/src/VaultPHP/Response/BasicMetaResponse.php → src/VaultPHP/Response/MetaData.php
@@ -3,10 +3,10 @@
 namespace VaultPHP\Response;
 
 /**
- * Class BasicMetaResponse
+ * Class MetaData
  * @package VaultPHP\Response
  */
-class BasicMetaResponse implements BasicMetaResponseInterface
+class MetaData implements MetaDataInterface
 {
     /** @var string|null */
     private $request_id;
@@ -33,7 +33,7 @@ class BasicMetaResponse implements BasicMetaResponseInterface
     private $errors;
 
     /**
-     * BasicMetaResponse constructor.
+     * MetaData constructor.
      * @param array|object $data
      */
     public function __construct($data = [])

diff --git a/...P/Response/BasicMetaResponseInterface.php → src/VaultPHP/Response/MetaDataInterface.php b/...P/Response/BasicMetaResponseInterface.php → src/VaultPHP/Response/MetaDataInterface.php
@@ -3,10 +3,10 @@
 namespace VaultPHP\Response;
 
 /**
- * Interface BasicMetaResponseInterface
+ * Interface MetaDataInterface
  * @package VaultPHP\Response
  */
-interface BasicMetaResponseInterface
+interface MetaDataInterface
 {
     /**
      * GenericEndpointResponse constructor.
-Original file line number
+Diff line change
@@ Expand Up / @@ -57,7 +57,7 @@ public function authenticate() @@
                 false
             );
-            if ($auth = $response->getBasicMetaResponse()->getAuth()) {
+            if ($auth = $response->getMetaData()->getAuth()) {
                 return new AuthenticationMetaData($auth);
             }
@@ Expand Down @@