fix: tests relating to errors

Justintime50 · Justintime50 · commit b75c045f886c · 2022-12-13T12:12:26.000-07:00
diff --git a/lib/EasyPost/Constant/Constants.php b/lib/EasyPost/Constant/Constants.php
@@ -33,6 +33,6 @@ abstract class Constants
     const NO_ID_URL_ERROR = "Could not determine which URL to request: %s instance has invalid ID: %s";
     const NO_RATES_ERROR = 'No rates found.';
     const NO_RESPONSE_ERROR = 'Did not receive a response from %s.';
-    const SEND_STIPE_DETAILS_ERROR = 'Could not send card details to Stripe, please try again later.';
+    const SEND_STRIPE_DETAILS_ERROR = 'Could not send card details to Stripe, please try again later.';
     const UNDEFINED_PROPERTY_ERROR = "EasyPost Notice: Undefined property of %s instance: %s";
 }
diff --git a/lib/EasyPost/Exception/Api/ApiException.php b/lib/EasyPost/Exception/Api/ApiException.php
@@ -83,7 +83,7 @@ public function getHttpBody()
      */
     public function prettyPrint()
     {
-        print($this->ecode . ' (' . $this->getHttpStatus() . '): ' .
+        print($this->code . ' (' . $this->getHttpStatus() . '): ' .
             $this->getMessage() . "\n");
         if (!empty($this->errors)) {
             print("Field errors:\n");
diff --git a/lib/EasyPost/Service/CarrierAccountService.php b/lib/EasyPost/Service/CarrierAccountService.php
@@ -78,7 +78,7 @@ public function create($params = null)
             throw new MissingParameterException(sprintf(Constants::MISSING_PARAMETER_ERROR, 'type'));
         }
 
-        $url = self::selectCarrierAccountCreationEndpoint(!isset($params['carrier_account']['type']));
+        $url = self::selectCarrierAccountCreationEndpoint($params['carrier_account']['type']);
         $response = Requestor::request($this->client, 'post', $url, $params);
 
         return InternalUtil::convertToEasyPostObject($this->client, $response);
diff --git a/lib/EasyPost/Service/ReferralCustomerService.php b/lib/EasyPost/Service/ReferralCustomerService.php
@@ -84,7 +84,7 @@ public function addCreditCard($referralApiKey, $number, $expirationMonth, $expir
         try {
             $stripeToken = self::createStripeToken($number, $expirationMonth, $expirationYear, $cvc, $easypostStripeApiKey);
         } catch (\Exception $error) {
-            throw new ExternalApiException(Constants::SEND_STIPE_DETAILS_ERROR);
+            throw new ExternalApiException(Constants::SEND_STRIPE_DETAILS_ERROR);
         }
 
         $stripeToken = $stripeToken['id'] ?? '';
diff --git a/test/EasyPost/AddressTest.php b/test/EasyPost/AddressTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\Api\ApiException;
 
 class AddressTest extends \PHPUnit\Framework\TestCase
 {
@@ -174,7 +174,7 @@ public function testVerifyInvalid()
         try {
             $address = self::$client->address->create(['street1' => 'invalid']);
             self::$client->address->verify($address->id);
-        } catch (EasyPostException $error) {
+        } catch (ApiException $error) {
             $this->assertEquals('Unable to verify address.', $error->getMessage());
         }
     }
diff --git a/test/EasyPost/BatchTest.php b/test/EasyPost/BatchTest.php
@@ -3,7 +3,6 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Shipment;
 
 class BatchTest extends \PHPUnit\Framework\TestCase
 {
diff --git a/test/EasyPost/CarrierAccountTest.php b/test/EasyPost/CarrierAccountTest.php
@@ -3,8 +3,8 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
-use EasyPost\Exception\MissingParameterError;
+use EasyPost\Exception\Api\ApiException;
+use EasyPost\Exception\General\MissingParameterException;
 
 class CarrierAccountTest extends \PHPUnit\Framework\TestCase
 {
@@ -56,8 +56,11 @@ public function testCreateWithoutType()
         unset($params['type']);
 
         try {
-            self::$client->carrierAccount->create($params);
-        } catch (MissingParameterError $error) {
+            $carrierAccount = self::$client->carrierAccount->create($params);
+
+            // Delete the carrier account once it's done being tested (should not be reached).
+            self::$client->carrierAccount->delete($carrierAccount->id);
+        } catch (MissingParameterException $error) {
             $this->assertEquals('type is required.', $error->getMessage());
         }
     }
@@ -83,7 +86,7 @@ public function testCreateWithCustomWorkflow()
             $carrierAccount = self::$client->carrierAccount->create($data);
             // Delete the carrier account once it's done being tested (should not be reached).
             self::$client->carrierAccount->delete($carrierAccount->id);
-        } catch (EasyPostException $error) {
+        } catch (ApiException $error) {
             $this->assertEquals(422, $error->getHttpStatus());
             $errorFound = false;
             $errors = $error->errors;
@@ -93,8 +96,9 @@ public function testCreateWithCustomWorkflow()
                     break;
                 }
             }
-            $this->assertTrue($errorFound);
         }
+
+        $this->assertTrue($errorFound);
     }
 
     /**
diff --git a/test/EasyPost/EasyPostClientTest.php b/test/EasyPost/EasyPostClientTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\MissingParameterError;
+use EasyPost\Exception\General\MissingParameterException;
 
 class EasyPostClientTest extends \PHPUnit\Framework\TestCase
 {
@@ -57,7 +57,7 @@ public function testNoApiKey()
     {
         try {
             new EasyPostClient(null);
-        } catch (MissingParameterError $error) {
+        } catch (MissingParameterException $error) {
             $this->assertEquals('No API key provided. See https://www.easypost.com/docs for details, or contact support@easypost.com for assistance.', $error->getMessage());
         }
     }
diff --git a/test/EasyPost/ErrorTest.php b/test/EasyPost/ErrorTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\Api\ApiException;
 
 class ErrorTest extends \PHPUnit\Framework\TestCase
 {
@@ -36,7 +36,7 @@ public function testError()
         // Create a bad shipment so we can work with errors
         try {
             self::$client->shipment->create();
-        } catch (EasyPostException $error) {
+        } catch (ApiException $error) {
             $this->assertEquals(422, $error->getHttpStatus());
             $this->assertEquals('PARAMETER.REQUIRED', $error->code);
             $this->assertEquals('Missing required parameter.', $error->getMessage());
diff --git a/test/EasyPost/EventTest.php b/test/EasyPost/EventTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\General\EasyPostException;
 use EasyPost\Util\Util;
 
 class EventTest extends \PHPUnit\Framework\TestCase
diff --git a/test/EasyPost/InsuranceTest.php b/test/EasyPost/InsuranceTest.php
@@ -3,7 +3,6 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Shipment;
 
 class InsuranceTest extends \PHPUnit\Framework\TestCase
 {
diff --git a/test/EasyPost/OrderTest.php b/test/EasyPost/OrderTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\General\FilteringException;
 
 class OrderTest extends \PHPUnit\Framework\TestCase
 {
@@ -138,7 +138,7 @@ public function testLowestRate()
         // Test lowest rate with carrier filter (should error due to bad carrier)
         try {
             $lowestRate = $order->lowestRate(['BAD CARRIER'], []);
-        } catch (EasyPostException $error) {
+        } catch (FilteringException $error) {
             $this->assertEquals('No rates found.', $error->getMessage());
         }
     }
diff --git a/test/EasyPost/PickupTest.php b/test/EasyPost/PickupTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\General\FilteringException;
 
 class PickupTest extends \PHPUnit\Framework\TestCase
 {
@@ -144,14 +144,14 @@ public function testLowestRate()
         // Test lowest rate with service filter (should error due to bad service)
         try {
             $lowestRate = $pickup->lowestRate([], ['BAD SERVICE']);
-        } catch (EasyPostException $error) {
+        } catch (FilteringException $error) {
             $this->assertEquals('No rates found.', $error->getMessage());
         }
 
         // Test lowest rate with carrier filter (should error due to bad carrier)
         try {
             $lowestRate = $pickup->lowestRate(['BAD CARRIER'], []);
-        } catch (EasyPostException $error) {
+        } catch (FilteringException $error) {
             $this->assertEquals('No rates found.', $error->getMessage());
         }
     }
diff --git a/test/EasyPost/ReportTest.php b/test/EasyPost/ReportTest.php
@@ -3,6 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
+use EasyPost\Exception\General\EasyPostException;
 
 class ReportTest extends \PHPUnit\Framework\TestCase
 {
@@ -126,7 +127,7 @@ public function testAll()
      */
     public function testCreateNoType()
     {
-        $this->expectException(\EasyPost\Exception\EasyPostException::class);
+        $this->expectException(EasyPostException::class);
 
         self::$client->report->create();
     }
@@ -136,7 +137,7 @@ public function testCreateNoType()
      */
     public function testAllNoType()
     {
-        $this->expectException(\EasyPost\Exception\EasyPostException::class);
+        $this->expectException(EasyPostException::class);
 
         self::$client->report->all();
     }
diff --git a/test/EasyPost/ShipmentTest.php b/test/EasyPost/ShipmentTest.php
@@ -3,7 +3,8 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\General\FilteringException;
+use EasyPost\Exception\General\InvalidParameterException;
 use EasyPost\Util\Util;
 
 class ShipmentTest extends \PHPUnit\Framework\TestCase
@@ -331,7 +332,7 @@ public function testLowestRate()
         // Test lowestRate with carrier filter (should error due to bad carrier)
         try {
             $lowestRate = $shipment->lowestRate(['BAD CARRIER'], []);
-        } catch (EasyPostException $error) {
+        } catch (FilteringException $error) {
             $this->assertEquals('No rates found.', $error->getMessage());
         }
     }
@@ -378,14 +379,14 @@ public function testLowestSmartRate()
         // Test lowestSmartRate with invalid filters (should error due to strict delivery_days)
         try {
             self::$client->shipment->lowestSmartRate($shipment->id, 0, 'percentile_85');
-        } catch (EasyPostException $error) {
+        } catch (FilteringException $error) {
             $this->assertEquals('No rates found.', $error->getMessage());
         }
 
         // Test lowestSmartRate with invalid filters (should error due to invalid delivery_accuracy)
         try {
             self::$client->shipment->lowestSmartRate($shipment->id, 3, 'BAD_ACCURACY');
-        } catch (EasyPostException $error) {
+        } catch (InvalidParameterException $error) {
             $this->assertEquals(
                 'Invalid delivery_accuracy value, must be one of: ["percentile_50","percentile_75","percentile_85","percentile_90","percentile_95","percentile_97","percentile_99"]',
                 $error->getMessage()
@@ -414,14 +415,14 @@ public function testGetLowestSmartRate()
         // Test lowestSmartRate with invalid filters (should error due to strict delivery_days)
         try {
             Util::getLowestSmartRate($smartRates, 0, 'percentile_90');
-        } catch (EasyPostException $error) {
+        } catch (FilteringException $error) {
             $this->assertEquals('No rates found.', $error->getMessage());
         }
 
         // Test lowestSmartRate with invalid filters (should error due to invalid delivery_accuracy)
         try {
             Util::getLowestSmartRate($smartRates, 3, 'BAD_ACCURACY');
-        } catch (EasyPostException $error) {
+        } catch (InvalidParameterException $error) {
             $this->assertEquals('Invalid delivery_accuracy value, must be one of: ["percentile_50","percentile_75","percentile_85","percentile_90","percentile_95","percentile_97","percentile_99"]', $error->getMessage());
         }
     }
diff --git a/test/EasyPost/WebhookTest.php b/test/EasyPost/WebhookTest.php
@@ -3,7 +3,7 @@
 namespace EasyPost\Test;
 
 use EasyPost\EasyPostClient;
-use EasyPost\Exception\EasyPostException;
+use EasyPost\Exception\General\SignatureVerificationException;
 use EasyPost\Util\Util;
 
 class WebhookTest extends \PHPUnit\Framework\TestCase
@@ -148,7 +148,7 @@ public function testValidateWebhookInvalidSecret()
 
         try {
             Util::validateWebhook(Fixture::eventBytes(), $headers, $webhookSecret);
-        } catch (EasyPostException $error) {
+        } catch (SignatureVerificationException $error) {
             $this->assertEquals('Webhook received did not originate from EasyPost or had a webhook secret mismatch.', $error->getMessage());
         }
     }
@@ -165,7 +165,7 @@ public function testValidateWebhookMissingSecret()
 
         try {
             Util::validateWebhook(Fixture::eventBytes(), $headers, $webhookSecret);
-        } catch (EasyPostException $error) {
+        } catch (SignatureVerificationException $error) {
             $this->assertEquals('Webhook received does not contain an HMAC signature.', $error->getMessage());
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,6 @@ abstract class Constants`
`33`	`33`	`const NO_ID_URL_ERROR = "Could not determine which URL to request: %s instance has invalid ID: %s";`
`34`	`34`	`const NO_RATES_ERROR = 'No rates found.';`
`35`	`35`	`const NO_RESPONSE_ERROR = 'Did not receive a response from %s.';`
`36`		`- const SEND_STIPE_DETAILS_ERROR = 'Could not send card details to Stripe, please try again later.';`
	`36`	`+ const SEND_STRIPE_DETAILS_ERROR = 'Could not send card details to Stripe, please try again later.';`
`37`	`37`	`const UNDEFINED_PROPERTY_ERROR = "EasyPost Notice: Undefined property of %s instance: %s";`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public function getHttpBody()`
`83`	`83`	`*/`
`84`	`84`	`public function prettyPrint()`
`85`	`85`	`{`
`86`		`- print($this->ecode . ' (' . $this->getHttpStatus() . '): ' .`
	`86`	`+ print($this->code . ' (' . $this->getHttpStatus() . '): ' .`
`87`	`87`	`$this->getMessage() . "\n");`
`88`	`88`	`if (!empty($this->errors)) {`
`89`	`89`	`print("Field errors:\n");`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function create($params = null)`
`78`	`78`	`throw new MissingParameterException(sprintf(Constants::MISSING_PARAMETER_ERROR, 'type'));`
`79`	`79`	`}`
`80`	`80`
`81`		`- $url = self::selectCarrierAccountCreationEndpoint(!isset($params['carrier_account']['type']));`
	`81`	`+ $url = self::selectCarrierAccountCreationEndpoint($params['carrier_account']['type']);`
`82`	`82`	`$response = Requestor::request($this->client, 'post', $url, $params);`
`83`	`83`
`84`	`84`	`return InternalUtil::convertToEasyPostObject($this->client, $response);`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public function addCreditCard($referralApiKey, $number, $expirationMonth, $expir`
`84`	`84`	`try {`
`85`	`85`	`$stripeToken = self::createStripeToken($number, $expirationMonth, $expirationYear, $cvc, $easypostStripeApiKey);`
`86`	`86`	`} catch (\Exception $error) {`
`87`		`- throw new ExternalApiException(Constants::SEND_STIPE_DETAILS_ERROR);`
	`87`	`+ throw new ExternalApiException(Constants::SEND_STRIPE_DETAILS_ERROR);`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`$stripeToken = $stripeToken['id'] ?? '';`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`namespace EasyPost\Test;`
`4`	`4`
`5`	`5`	`use EasyPost\EasyPostClient;`
`6`		`-use EasyPost\Exception\EasyPostException;`
	`6`	`+use EasyPost\Exception\Api\ApiException;`
`7`	`7`
`8`	`8`	`class AddressTest extends \PHPUnit\Framework\TestCase`
`9`	`9`	`{`
`@@ -174,7 +174,7 @@ public function testVerifyInvalid()`
`174`	`174`	`try {`
`175`	`175`	`$address = self::$client->address->create(['street1' => 'invalid']);`
`176`	`176`	`self::$client->address->verify($address->id);`
`177`		`- } catch (EasyPostException $error) {`
	`177`	`+ } catch (ApiException $error) {`
`178`	`178`	`$this->assertEquals('Unable to verify address.', $error->getMessage());`
`179`	`179`	`}`
`180`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`namespace EasyPost\Test;`
`4`	`4`
`5`	`5`	`use EasyPost\EasyPostClient;`
`6`		`-use EasyPost\Shipment;`
`7`	`6`
`8`	`7`	`class BatchTest extends \PHPUnit\Framework\TestCase`
`9`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@`
`3`	`3`	`namespace EasyPost\Test;`
`4`	`4`
`5`	`5`	`use EasyPost\EasyPostClient;`
`6`		`-use EasyPost\Exception\EasyPostException;`
`7`		`-use EasyPost\Exception\MissingParameterError;`
	`6`	`+use EasyPost\Exception\Api\ApiException;`
	`7`	`+use EasyPost\Exception\General\MissingParameterException;`
`8`	`8`
`9`	`9`	`class CarrierAccountTest extends \PHPUnit\Framework\TestCase`
`10`	`10`	`{`
`@@ -56,8 +56,11 @@ public function testCreateWithoutType()`
`56`	`56`	`unset($params['type']);`
`57`	`57`
`58`	`58`	`try {`
`59`		`- self::$client->carrierAccount->create($params);`
`60`		`- } catch (MissingParameterError $error) {`
	`59`	`+ $carrierAccount = self::$client->carrierAccount->create($params);`
	`60`	`+`
	`61`	`+ // Delete the carrier account once it's done being tested (should not be reached).`
	`62`	`+ self::$client->carrierAccount->delete($carrierAccount->id);`
	`63`	`+ } catch (MissingParameterException $error) {`
`61`	`64`	`$this->assertEquals('type is required.', $error->getMessage());`
`62`	`65`	`}`
`63`	`66`	`}`
`@@ -83,7 +86,7 @@ public function testCreateWithCustomWorkflow()`
`83`	`86`	`$carrierAccount = self::$client->carrierAccount->create($data);`
`84`	`87`	`// Delete the carrier account once it's done being tested (should not be reached).`
`85`	`88`	`self::$client->carrierAccount->delete($carrierAccount->id);`
`86`		`- } catch (EasyPostException $error) {`
	`89`	`+ } catch (ApiException $error) {`
`87`	`90`	`$this->assertEquals(422, $error->getHttpStatus());`
`88`	`91`	`$errorFound = false;`
`89`	`92`	`$errors = $error->errors;`
`@@ -93,8 +96,9 @@ public function testCreateWithCustomWorkflow()`
`93`	`96`	`break;`
`94`	`97`	`}`
`95`	`98`	`}`
`96`		`- $this->assertTrue($errorFound);`
`97`	`99`	`}`
	`100`	`+`
	`101`	`+ $this->assertTrue($errorFound);`
`98`	`102`	`}`
`99`	`103`
`100`	`104`	`/**`