Exception Unit Tests + Exception Abstraction

src/Endpoint/Abstracts/AbstractCollectionEndpoint.php

@@ -121,7 +121,7 @@ public function update(array $collection){
     //Collection Interface
     /**
      * @inheritdoc
-     * @throws \MRussell\REST\Exception\Endpoint\InvalidRequestException
+     * @throws \MRussell\REST\Exception\Endpoint\InvalidRequest
      */
     public function fetch() {
         $this->setProperty('httpMethod',Curl::HTTP_GET);

src/Endpoint/Abstracts/AbstractEndpoint.php

@@ -7,10 +7,10 @@
 use MRussell\REST\Endpoint\Data\AbstractEndpointData;
 use MRussell\REST\Endpoint\Data\DataInterface;
 use MRussell\REST\Endpoint\Interfaces\EndpointInterface;
-use MRussell\REST\Exception\Endpoint\InvalidRequestException;
-use MRussell\REST\Exception\Endpoint\InvalidURLException;
-use MRussell\REST\Exception\Endpoint\RequiredDataException;
-use MRussell\REST\Exception\Endpoint\RequiredOptionsException;
+use MRussell\REST\Exception\Endpoint\InvalidRequest;
+use MRussell\REST\Exception\Endpoint\InvalidURLEndpointException;
+use MRussell\REST\Exception\Endpoint\InvalidData;
+use MRussell\REST\Exception\Endpoint\InvalidOptions;
 use MRussell\Http\Response\ResponseInterface;
 use MRussell\Http\Request\RequestInterface;
 
@@ -221,8 +221,8 @@ public function getResponse()
      * @inheritdoc
      * @param null $data - short form data for Endpoint, which is configure by configureData method
      * @return $this
-     * @throws InvalidRequestException
-     * @throws InvalidURLException
+     * @throws InvalidRequest
+     * @throws InvalidURLEndpointException
      */
     public function execute()
     {
@@ -232,7 +232,7 @@ public function execute()
                 $this->configureResponse($this->Response);
             }
         } else {
-            throw new InvalidRequestException(get_called_class(), "Request property not configured");
+            throw new InvalidRequest(get_called_class(), "Request property not configured");
         }
         return $this;
     }
@@ -271,8 +271,8 @@ public function getAuth()
      * Verifies URL and Data are setup, then sets them on the Request Object
      * @param RequestInterface $Request
      * @return RequestInterface
-     * @throws InvalidURLException
-     * @throws RequiredDataException
+     * @throws InvalidURLEndpointException
+     * @throws InvalidData
      */
     protected function configureRequest(RequestInterface $Request)
     {
@@ -365,12 +365,12 @@ protected function configureURL(array $options)
      * Verify if URL is configured properly
      * @param string $url
      * @return bool
-     * @throws InvalidURLException
+     * @throws InvalidURLEndpointException
      */
     private function verifyUrl($url)
     {
         if (strpos($url, static::$_URL_VAR_CHARACTER) !== false) {
-            throw new InvalidURLException(get_called_class(), "Configured URL is ".$url);
+            throw new InvalidURLEndpointException(get_called_class(), "Configured URL is ".$url);
         }
         return true;
     }

src/Endpoint/Abstracts/AbstractModelEndpoint.php

@@ -7,7 +7,7 @@
 use MRussell\REST\Endpoint\Data\AbstractEndpointData;
 use MRussell\REST\Endpoint\Data\DataInterface;
 use MRussell\REST\Endpoint\Interfaces\ModelInterface;
-use MRussell\REST\Exception\Endpoint\Exception;
+use MRussell\REST\Exception\Endpoint\EndpointException;
 
 /**
  * Class AbstractModelEndpoint
@@ -184,7 +184,7 @@ public function set($key, $value) {
 
     /**
      * @inheritdoc
-     * @throws \MRussell\REST\Exception\Endpoint\InvalidRequestException
+     * @throws \MRussell\REST\Exception\Endpoint\InvalidRequest
      */
     public function retrieve($id = NULL) {
         $idKey = $this->modelIdKey();
@@ -195,7 +195,7 @@ public function retrieve($id = NULL) {
             }
         } else {
             if (!isset($this->model[$idKey])){
-                throw new Exception("Cannot retrieve Model without an ID");
+                throw new EndpointException("Cannot retrieve Model without an ID");
             }
         }
         $this->action = self::MODEL_ACTION_RETRIEVE;
@@ -205,7 +205,7 @@ public function retrieve($id = NULL) {
 
     /**
      * @inheritdoc
-     * @throws \MRussell\REST\Exception\Endpoint\InvalidRequestException
+     * @throws \MRussell\REST\Exception\Endpoint\InvalidRequest
      */
     public function save() {
         if (isset($this->model[$this->modelIdKey()])){

src/Endpoint/Abstracts/AbstractSmartEndpoint.php

@@ -4,7 +4,7 @@
 
 use MRussell\REST\Endpoint\Data\AbstractEndpointData;
 use MRussell\REST\Endpoint\Data\EndpointData;
-use MRussell\REST\Exception\Endpoint\Exception;
+use MRussell\REST\Exception\Endpoint\EndpointException;
 
 abstract class AbstractSmartEndpoint extends AbstractEndpoint
 {
@@ -73,7 +73,7 @@ public function setData($data) {
             $this->data->reset();
             $this->data->update($data);
         } else {
-            throw new Exception("Invalid data passed to Endpoint");
+            throw new EndpointException("Invalid data passed to Endpoint");
         }
         return $this;
     }

src/Endpoint/Data/AbstractEndpointData.php

@@ -2,7 +2,7 @@
 
 namespace MRussell\REST\Endpoint\Data;
 
-use MRussell\REST\Exception\Endpoint\RequiredDataException;
+use MRussell\REST\Exception\Endpoint\InvalidData;
 
 abstract class AbstractEndpointData implements DataInterface
 {
@@ -118,7 +118,7 @@ public function offsetGet($offset) {
      * Return the entire Data array
      * @param bool $verify - Whether or not to verify if Required Data is filled in
      * @return array
-     * @throws RequiredDataException
+     * @throws InvalidData
      */
     public function asArray($verify = FALSE){
         if ($verify){
@@ -192,7 +192,7 @@ protected function configureDefaultData(){
     /**
      * Validate Required Data for the Endpoint
      * @return bool
-     * @throws RequiredDataException
+     * @throws InvalidData
      */
     protected function verifyRequiredData()
     {
@@ -208,7 +208,7 @@ protected function verifyRequiredData()
             }
         }
         if ($error){
-            throw new RequiredDataException(get_called_class());
+            throw new InvalidData(get_called_class());
         }
         return $error;
     }

src/Endpoint/Provider/AbstractEndpointProvider.php

@@ -5,7 +5,7 @@
 use MRussell\REST\Auth\AuthControllerInterface;
 use MRussell\REST\Endpoint\ControllerInterface;
 use MRussell\REST\Endpoint\Interfaces\EndpointInterface;
-use MRussell\REST\Exception\Endpoint\RegistrationException;
+use MRussell\REST\Exception\Endpoint\InvalidEndpointRegistration;
 use MRussell\REST\Exception\Endpoint\UnknownEndpoint;
 
 abstract class AbstractEndpointProvider implements EndpointProviderInterface
@@ -33,7 +33,7 @@ public function __construct() {
 
     /**
      * @inheritdoc
-     * @throws RegistrationException
+     * @throws InvalidEndpointRegistration
      */
     public function registerEndpoint($name, $className, array $properties = array())
     {
@@ -44,7 +44,7 @@ public function registerEndpoint($name, $className, array $properties = array())
                 'properties' => $properties
             );
         } else {
-            throw new RegistrationException($className);
+            throw new InvalidEndpointRegistration($className);
         }
         return $this;
     }

src/Exception/Auth/AuthException.php

@@ -2,8 +2,9 @@
 
 namespace MRussell\REST\Exception\Auth;
 
+use MRussell\REST\Exception\RestClientException;
 
-class AuthException extends \Exception
+class AuthException extends RestClientException
 {
-    protected $message = 'Unknown Auth Exception occurred.';
+    protected $message = 'Unknown Auth Exception occurred on Controller: %s';
 }

src/Exception/Auth/NotAuthenticated.php

@@ -2,7 +2,6 @@
 
 namespace MRussell\REST\Exception\Auth;
 
-
 class NotAuthenticated extends AuthException
 {
     protected $message = 'Auth Controller not currently authenticated.';

src/Exception/Client/ClientException.php

@@ -1,16 +1,11 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mrussell
- * Date: 1/20/17
- * Time: 10:51 AM
- */
 
 namespace MRussell\REST\Exception\Client;
 
+use MRussell\REST\Exception\RestClientException;
 
-class ClientException extends \Exception {
+class ClientException extends RestClientException {
 
-    protected $message = 'Unknown REST Client Exception occurred.';
+    protected $message = 'Unknown Exception occurred on REST Client: %s';
 
 }

src/Exception/Endpoint/EndpointException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace MRussell\REST\Exception\Endpoint;
+
+use MRussell\REST\Exception\RestClientException;
+
+class EndpointException extends RestClientException
+{
+    protected $message = 'Unknown Exception occurred on Endpoint: %s';
+
+}

src/Exception/Endpoint/RequiredDataException.php → src/Exception/Endpoint/InvalidData.php

@@ -2,8 +2,7 @@
 
 namespace MRussell\REST\Exception\Endpoint;
 
-class RequiredDataException extends \Exception
+class InvalidData extends EndpointException
 {
     protected $message = "Missing or Invalid data on Endpoint [%s].";
-
 }

src/Exception/Endpoint/InvalidOptions.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MRussell\REST\Exception\Endpoint;
+
+class InvalidOptions extends EndpointException
+{
+    protected $message = 'Invalid or missing options of Endpoint: %s';
+}

src/Exception/Endpoint/RegistrationException.php → src/Exception/Endpoint/InvalidRegistration.php

@@ -2,7 +2,7 @@
 
 namespace MRussell\REST\Exception\Endpoint;
 
-class RegistrationException extends Exception {
+class InvalidRegistration extends EndpointException {
 
     protected $message = 'Endpoint Object [%s] must extend MRussell\REST\Endpoint\EndpointInterface';
 

src/Exception/Endpoint/InvalidRequest.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MRussell\REST\Exception\Endpoint;
+
+class InvalidRequest extends EndpointException
+{
+    protected $message = 'Request Property not configured on Endpoint: %s';
+}

src/Exception/Endpoint/UnknownEndpoint.php

@@ -1,17 +1,10 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mrussell
- * Date: 1/19/17
- * Time: 10:35 PM
- */
 
 namespace MRussell\REST\Exception\Endpoint;
 
-
-class UnknownEndpoint extends Exception
+class UnknownEndpoint extends EndpointException
 {
     protected $message = 'An Unknown Endpoint [%s] was requested.';
 
-
+    protected $code = 404;
 }

src/Exception/RestClientException.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace MRussell\REST\Exception;
+
+class RestClientException extends \Exception
+{
+    protected $message = 'An Unknown Exception occurred in the REST Client Framework';
+
+    public function __construct($args = array()) {
+        if (!empty($args)){
+            $this->message = vsprintf($this->message,$args);
+        }
+        parent::__construct($this->message);
+    }
+}