Merge pull request #340 from Art4/339-add-new-exception-on-unexpected…

…-response Add new UnexpectedResponseException
kbsali · Jan 3, 2024 · c132efc · c132efc
2 parents cd10480 + ec0296e
commit c132efc
Show file tree

Hide file tree

Showing 41 changed files with 756 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New method `Redmine\Api\User::list()` to list users.
 - New method `Redmine\Api\Version::listByProject()` to list versions from a project.
 - New method `Redmine\Api\Wiki::listByProject()` to list wiki pages from a project.
+- New exception `Redmine\Exception\UnexpectedResponseException` if the Redmine server responded with an unexpected body.
 
 ### Deprecated
 

diff --git a/src/Redmine/Api/CustomField.php b/src/Redmine/Api/CustomField.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 
 /**
  * Listing custom fields.
@@ -23,13 +24,17 @@ class CustomField extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of custom fields found
      */
     final public function list(array $params = []): array
     {
-        $this->customFields = $this->retrieveData('/custom_fields.json', $params);
+        try {
+            $this->customFields = $this->retrieveData('/custom_fields.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->customFields;
     }
@@ -56,6 +61,10 @@ public function all(array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/Group.php b/src/Redmine/Api/Group.php
@@ -5,6 +5,7 @@
 use Redmine\Exception;
 use Redmine\Exception\MissingParameterException;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -26,13 +27,17 @@ class Group extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of groups found
      */
     final public function list(array $params = []): array
     {
-        $this->groups = $this->retrieveData('/groups.json', $params);
+        try {
+            $this->groups = $this->retrieveData('/groups.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->groups;
     }
@@ -59,6 +64,10 @@ public function all(array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/Issue.php b/src/Redmine/Api/Issue.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 use Redmine\Serializer\JsonSerializer;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
@@ -40,13 +41,17 @@ class Issue extends AbstractApi
      *
      * @param array $params the additional parameters (cf available $params above)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of issues found
      */
     final public function list(array $params = []): array
     {
-        return $this->retrieveData('/issues.json', $params);
+        try {
+            return $this->retrieveData('/issues.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
     }
 
     /**
@@ -81,6 +86,10 @@ public function all(array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/IssueCategory.php b/src/Redmine/Api/IssueCategory.php
@@ -6,6 +6,7 @@
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\MissingParameterException;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -29,7 +30,7 @@ class IssueCategory extends AbstractApi
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
      * @throws InvalidParameterException if $projectIdentifier is not of type int or string
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of issue categories found
      */
@@ -42,7 +43,11 @@ final public function listByProject($projectIdentifier, array $params = []): arr
             ));
         }
 
-        $this->issueCategories = $this->retrieveData('/projects/'.strval($projectIdentifier).'/issue_categories.json', $params);
+        try {
+            $this->issueCategories = $this->retrieveData('/projects/'.strval($projectIdentifier).'/issue_categories.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->issueCategories;
     }
@@ -70,6 +75,10 @@ public function all($project, array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/IssuePriority.php b/src/Redmine/Api/IssuePriority.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 
 /**
  * Listing issue priorities.
@@ -23,13 +24,17 @@ class IssuePriority extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of issue priorities found
      */
     final public function list(array $params = []): array
     {
-        $this->issuePriorities = $this->retrieveData('/enumerations/issue_priorities.json', $params);
+        try {
+            $this->issuePriorities = $this->retrieveData('/enumerations/issue_priorities.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->issuePriorities;
     }
@@ -56,6 +61,10 @@ public function all(array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/IssueRelation.php b/src/Redmine/Api/IssueRelation.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 use Redmine\Serializer\JsonSerializer;
 
 /**
@@ -25,13 +26,17 @@ class IssueRelation extends AbstractApi
      * @param int   $issueId the issue id
      * @param array $params  optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of relations found
      */
     final public function listByIssueId(int $issueId, array $params = []): array
     {
-        $this->relations = $this->retrieveData('/issues/'.strval($issueId).'/relations.json', $params);
+        try {
+            $this->relations = $this->retrieveData('/issues/'.strval($issueId).'/relations.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->relations;
     }
@@ -59,6 +64,10 @@ public function all($issueId, array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/IssueStatus.php b/src/Redmine/Api/IssueStatus.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 
 /**
  * Listing issue statuses.
@@ -23,13 +24,17 @@ class IssueStatus extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of issue statuses found
      */
     final public function list(array $params = []): array
     {
-        $this->issueStatuses = $this->retrieveData('/issue_statuses.json', $params);
+        try {
+            $this->issueStatuses = $this->retrieveData('/issue_statuses.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->issueStatuses;
     }
@@ -56,6 +61,10 @@ public function all(array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/Membership.php b/src/Redmine/Api/Membership.php
@@ -6,6 +6,7 @@
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\MissingParameterException;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 use Redmine\Serializer\XmlSerializer;
 
 /**
@@ -28,7 +29,7 @@ class Membership extends AbstractApi
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
      * @throws InvalidParameterException if $projectIdentifier is not of type int or string
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of memberships found
      */
@@ -41,7 +42,11 @@ final public function listByProject($projectIdentifier, array $params = []): arr
             ));
         }
 
-        $this->memberships = $this->retrieveData('/projects/'.strval($projectIdentifier).'/memberships.json', $params);
+        try {
+            $this->memberships = $this->retrieveData('/projects/'.strval($projectIdentifier).'/memberships.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->memberships;
     }
@@ -69,6 +74,10 @@ public function all($project, array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }

diff --git a/src/Redmine/Api/News.php b/src/Redmine/Api/News.php
@@ -5,6 +5,7 @@
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\SerializerException;
+use Redmine\Exception\UnexpectedResponseException;
 
 /**
  * @see   http://www.redmine.org/projects/redmine/wiki/Rest_News
@@ -24,7 +25,7 @@ class News extends AbstractApi
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
      * @throws InvalidParameterException if $projectIdentifier is not of type int or string
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of news found
      */
@@ -37,7 +38,11 @@ final public function listByProject($projectIdentifier, array $params = []): arr
             ));
         }
 
-        $this->news = $this->retrieveData('/projects/'.strval($projectIdentifier).'/news.json', $params);
+        try {
+            $this->news = $this->retrieveData('/projects/'.strval($projectIdentifier).'/news.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->news;
     }
@@ -49,13 +54,17 @@ final public function listByProject($projectIdentifier, array $params = []): arr
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @throws SerializerException if response body could not be converted into array
+     * @throws UnexpectedResponseException if response body could not be converted into array
      *
      * @return array list of news found
      */
     final public function list(array $params = []): array
     {
-        $this->news = $this->retrieveData('/news.json', $params);
+        try {
+            $this->news = $this->retrieveData('/news.json', $params);
+        } catch (SerializerException $th) {
+            throw new UnexpectedResponseException('The Redmine server responded with an unexpected body.', $th->getCode(), $th);
+        }
 
         return $this->news;
     }
@@ -87,6 +96,10 @@ public function all($project = null, array $params = [])
                 return false;
             }
 
+            if ($e instanceof UnexpectedResponseException && $e->getPrevious() !== null) {
+                $e = $e->getPrevious();
+            }
+
             return $e->getMessage();
         }
     }