Merge pull request #310 from Art4/improve-retrieve-all

Improve retrieveAll()

Author: Art4

CHANGELOG.md

@@ -11,6 +11,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Allow unassign user from an issue
 
+### Added
+
+- New method `Redmine\Client\AbstractApi::retrieveData()` to retrieve as many elements as you want as array (even if the total number of elements is greater than 100).
+- New exception `Redmine\Client\SerializerException` for JSON/XML serializer related exceptions
+
+### Deprecated
+
+- `Redmine\Api\AbstractApi::retrieveAll()` is deprecated, use `Redmine\Api\AbstractApi::retrieveData()` instead
+
 ## [v2.1.1](https://github.com/kbsali/php-redmine-api/compare/v2.1.0...v2.1.1) - 2022-01-15
 
 ### Fixed

src/Redmine/Api/AbstractApi.php

@@ -5,6 +5,10 @@
 use JsonException;
 use Redmine\Api;
 use Redmine\Client\Client;
+use Redmine\Exception\SerializerException;
+use Redmine\Serializer\JsonSerializer;
+use Redmine\Serializer\PathSerializer;
+use Redmine\Serializer\XmlSerializer;
 use SimpleXMLElement;
 
 /**
@@ -51,7 +55,7 @@ public function lastCallFailed()
      */
     protected function get($path, $decodeIfJson = true)
     {
-        $this->client->requestGet($path);
+        $this->client->requestGet(strval($path));
 
         $body = $this->client->getLastResponseBody();
         $contentType = $this->client->getLastResponseContentType();
@@ -63,9 +67,9 @@ protected function get($path, $decodeIfJson = true)
 
         if (true === $decodeIfJson && '' !== $body && 0 === strpos($contentType, 'application/json')) {
             try {
-                return json_decode($body, true, 512, \JSON_THROW_ON_ERROR);
-            } catch (JsonException $e) {
-                return 'Error decoding body as JSON: '.$e->getMessage();
+                return JsonSerializer::createFromString($body)->getNormalized();
+            } catch (SerializerException $e) {
+                return 'Error decoding body as JSON: '.$e->getPrevious()->getMessage();
             }
         }
 
@@ -161,23 +165,54 @@ protected function sanitizeParams(array $defaults, array $params)
      * Retrieves all the elements of a given endpoint (even if the
      * total number of elements is greater than 100).
      *
+     * @deprecated the `retrieveAll()` method is deprecated, use `retrieveData()` instead.
+     *
      * @param string $endpoint API end point
      * @param array  $params   optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @return array elements found
+     * @return array|false elements found
      */
     protected function retrieveAll($endpoint, array $params = [])
+    {
+        @trigger_error('The '.__METHOD__.' method is deprecated, use `retrieveData()` instead.', E_USER_DEPRECATED);
+
+        try {
+            $data = $this->retrieveData(strval($endpoint), $params);
+        } catch (SerializerException $e) {
+            $data = false;
+        }
+
+        return $data;
+    }
+
+    /**
+     * Retrieves all the elements of a given endpoint (even if the
+     * total number of elements is greater than 100).
+     *
+     * @param string $endpoint API end point
+     * @param array  $params   optional query parameters to be passed to the api (offset, limit, ...)
+     *
+     * @throws SerializerException if response body could not be converted into array
+     *
+     * @return array elements found
+     */
+    protected function retrieveData(string $endpoint, array $params = []): array
     {
         if (empty($params)) {
-            return $this->get($endpoint);
+            $this->client->requestGet($endpoint);
+
+            return $this->getLastResponseBodyAsArray();
         }
-        $defaults = [
-            'limit' => 25,
-            'offset' => 0,
-        ];
-        $params = $this->sanitizeParams($defaults, $params);
 
-        $ret = [];
+        $params = $this->sanitizeParams(
+            [
+                'limit' => 25,
+                'offset' => 0,
+            ],
+            $params
+        );
+
+        $returnData = [];
 
         $limit = $params['limit'];
         $offset = $params['offset'];
@@ -193,10 +228,16 @@ protected function retrieveAll($endpoint, array $params = [])
             $params['limit'] = $_limit;
             $params['offset'] = $offset;
 
-            $newDataSet = (array) $this->get($endpoint.'?'.preg_replace('/%5B[0-9]+%5D/simU', '%5B%5D', http_build_query($params)));
-            $ret = array_merge_recursive($ret, $newDataSet);
+            $this->client->requestGet(
+                PathSerializer::create($endpoint, $params)->getPath()
+            );
+
+            $newDataSet = $this->getLastResponseBodyAsArray();
+
+            $returnData = array_merge_recursive($returnData, $newDataSet);
 
             $offset += $_limit;
+
             if (empty($newDataSet) || !isset($newDataSet['limit']) || (
                     isset($newDataSet['offset']) &&
                     isset($newDataSet['total_count']) &&
@@ -207,7 +248,7 @@ protected function retrieveAll($endpoint, array $params = [])
             }
         }
 
-        return $ret;
+        return $returnData;
     }
 
     /**
@@ -254,4 +295,31 @@ protected function attachCustomFieldXML(SimpleXMLElement $xml, array $fields)
 
         return $xml;
     }
+
+    /**
+     * returns the last response body as array
+     *
+     * @throws SerializerException if response body could not be converted into array
+     */
+    private function getLastResponseBodyAsArray(): array
+    {
+        $body = $this->client->getLastResponseBody();
+        $contentType = $this->client->getLastResponseContentType();
+        $returnData = null;
+
+        // parse XML
+        if (0 === strpos($contentType, 'application/xml')) {
+            $returnData = XmlSerializer::createFromString($body)->getNormalized();
+        } else if (0 === strpos($contentType, 'application/json')) {
+            $returnData = JsonSerializer::createFromString($body)->getNormalized();
+        }
+
+        if (! is_array($returnData)) {
+            throw new SerializerException(
+                'Could not convert response body into array: ' . $body
+            );
+        }
+
+        return $returnData;
+    }
 }

src/Redmine/Api/Attachment.php

@@ -2,6 +2,8 @@
 
 namespace Redmine\Api;
 
+use Redmine\Serializer\PathSerializer;
+
 /**
  * Attachment details.
  *
@@ -51,7 +53,10 @@ public function download($id)
      */
     public function upload($attachment, $params = [])
     {
-        return $this->post('/uploads.json?'.http_build_query($params), $attachment);
+        return $this->post(
+            PathSerializer::create('/uploads.json', $params)->getPath(),
+            $attachment
+        );
     }
 
     /**

src/Redmine/Api/CustomField.php

@@ -24,7 +24,7 @@ class CustomField extends AbstractApi
      */
     public function all(array $params = [])
     {
-        $this->customFields = $this->retrieveAll('/custom_fields.json', $params);
+        $this->customFields = $this->retrieveData('/custom_fields.json', $params);
 
         return $this->customFields;
     }

src/Redmine/Api/Group.php

@@ -4,6 +4,7 @@
 
 use Exception;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Serializer\PathSerializer;
 
 /**
  * Handling of groups.
@@ -27,7 +28,7 @@ class Group extends AbstractApi
      */
     public function all(array $params = [])
     {
-        $this->groups = $this->retrieveAll('/groups.json', $params);
+        $this->groups = $this->retrieveData('/groups.json', $params);
 
         return $this->groups;
     }
@@ -110,7 +111,9 @@ public function update($id, array $params = [])
      */
     public function show($id, array $params = [])
     {
-        return $this->get('/groups/'.urlencode($id).'.json?'.http_build_query($params));
+        return $this->get(
+            PathSerializer::create('/groups/'.urlencode($id).'.json', $params)->getPath()
+        );
     }
 
     /**

src/Redmine/Api/Issue.php

@@ -2,6 +2,8 @@
 
 namespace Redmine\Api;
 
+use Redmine\Serializer\PathSerializer;
+
 /**
  * Listing issues, searching, editing and closing your projects issues.
  *
@@ -38,7 +40,7 @@ class Issue extends AbstractApi
      */
     public function all(array $params = [])
     {
-        return $this->retrieveAll('/issues.json', $params);
+        return $this->retrieveData('/issues.json', $params);
     }
 
     /**
@@ -59,7 +61,9 @@ public function show($id, array $params = [])
             $params['include'] = implode(',', $params['include']);
         }
 
-        return $this->get('/issues/'.urlencode($id).'.json?'.http_build_query($params));
+        return $this->get(
+            PathSerializer::create('/issues/'.urlencode($id).'.json', $params)->getPath()
+        );
     }
 
     /**

src/Redmine/Api/IssueCategory.php

@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception\MissingParameterException;
+use Redmine\Serializer\PathSerializer;
 
 /**
  * Listing issue categories, creating, editing.
@@ -27,7 +28,7 @@ class IssueCategory extends AbstractApi
      */
     public function all($project, array $params = [])
     {
-        $this->issueCategories = $this->retrieveAll('/projects/'.$project.'/issue_categories.json', $params);
+        $this->issueCategories = $this->retrieveData('/projects/'.$project.'/issue_categories.json', $params);
 
         return $this->issueCategories;
     }
@@ -158,6 +159,8 @@ public function update($id, array $params)
      */
     public function remove($id, array $params = [])
     {
-        return $this->delete('/issue_categories/'.$id.'.xml?'.http_build_query($params));
+        return $this->delete(
+            PathSerializer::create('/issue_categories/'.$id.'.xml', $params)->getPath()
+        );
     }
 }

src/Redmine/Api/IssuePriority.php

@@ -24,7 +24,7 @@ class IssuePriority extends AbstractApi
      */
     public function all(array $params = [])
     {
-        $this->issuePriorities = $this->retrieveAll('/enumerations/issue_priorities.json', $params);
+        $this->issuePriorities = $this->retrieveData('/enumerations/issue_priorities.json', $params);
 
         return $this->issuePriorities;
     }

src/Redmine/Api/IssueRelation.php

@@ -2,6 +2,8 @@
 
 namespace Redmine\Api;
 
+use Redmine\Serializer\JsonSerializer;
+
 /**
  * Handling issue relations.
  *
@@ -25,7 +27,7 @@ class IssueRelation extends AbstractApi
      */
     public function all($issueId, array $params = [])
     {
-        $this->relations = $this->retrieveAll('/issues/'.urlencode($issueId).'/relations.json', $params);
+        $this->relations = $this->retrieveData('/issues/'.urlencode($issueId).'/relations.json', $params);
 
         return $this->relations;
     }
@@ -85,6 +87,8 @@ public function create($issueId, array $params = [])
 
         $params = json_encode(['relation' => $params]);
 
-        return json_decode($this->post('/issues/'.urlencode($issueId).'/relations.json', $params), true);
+        $response = $this->post('/issues/'.urlencode($issueId).'/relations.json', $params);
+
+        return JsonSerializer::createFromString($response)->getNormalized();
     }
 }

src/Redmine/Api/IssueStatus.php

@@ -24,7 +24,7 @@ class IssueStatus extends AbstractApi
      */
     public function all(array $params = [])
     {
-        $this->issueStatuses = $this->retrieveAll('/issue_statuses.json', $params);
+        $this->issueStatuses = $this->retrieveData('/issue_statuses.json', $params);
 
         return $this->issueStatuses;
     }