Merge pull request #208 from EasyPost/fix_quotes

Justintime50 · web-flow · commit c105d52c299e · 2022-08-15T13:07:34.000-06:00
fix: double to single quotes and lint rule
diff --git a/lib/EasyPost/Address.php b/lib/EasyPost/Address.php
@@ -72,7 +72,7 @@ public static function create($params = null, $apiKey = null)
             $wrappedParams['verify_strict'] = $verifyStrict;
         }
 
-        $wrappedParams["address"] = $params;
+        $wrappedParams['address'] = $params;
 
         return self::createResource(get_class(), $wrappedParams, $apiKey);
     }
diff --git a/lib/EasyPost/Batch.php b/lib/EasyPost/Batch.php
@@ -88,7 +88,7 @@ public static function create_and_buy($params = null, $apiKey = null)
             ];
         }
 
-        $encodedParams = str_replace("\\", '', json_encode($params));
+        $encodedParams = str_replace('\\', '', json_encode($params));
 
         $requestor = new Requestor($apiKey);
         $url = self::classUrl(get_class());
diff --git a/lib/EasyPost/Beta/EndShipper.php b/lib/EasyPost/Beta/EndShipper.php
@@ -30,7 +30,7 @@ class EndShipper extends EasypostResource
     public static function create($params = null, $apiKey = null)
     {
         $wrappedParams = [];
-        $wrappedParams["address"] = $params;
+        $wrappedParams['address'] = $params;
 
         return self::createResource(get_class(), $wrappedParams, $apiKey, null, true);
     }
diff --git a/lib/EasyPost/Billing.php b/lib/EasyPost/Billing.php
@@ -20,7 +20,7 @@ class Billing extends EasypostResource
      */
     public static function retrieve_payment_methods($params = null, $apiKey = null)
     {
-        $paymentMethods = self::allResources("paymentMethod", $params, $apiKey);
+        $paymentMethods = self::allResources('paymentMethod', $params, $apiKey);
 
         if ($paymentMethods->id == null) {
             throw new Error('Billing has not been setup for this user. Please add a payment method.');
diff --git a/lib/EasyPost/EasypostResource.php b/lib/EasyPost/EasypostResource.php
@@ -20,7 +20,7 @@ public static function className($class)
             $class = substr($class, strlen('EasyPost'));
         }
         $class = str_replace('_', '', $class);
-        $class = substr($class, 0, 1) . preg_replace("/([A-Z])/", "_$1", substr($class, 1)); // Camel -> snake
+        $class = substr($class, 0, 1) . preg_replace('/([A-Z])/', '_$1', substr($class, 1)); // Camel -> snake
         $name = urlencode($class);
         $name = strtolower($name);
 
@@ -36,7 +36,7 @@ public static function className($class)
     public static function classUrl($class)
     {
         $className = self::className($class);
-        if (substr($className, -1) !== "s" && substr($className, -1) !== "h") {
+        if (substr($className, -1) !== 's' && substr($className, -1) !== 'h') {
             return "/{$className}s";
         }
 
@@ -90,7 +90,7 @@ public function refresh(bool $beta = false)
     protected static function validate($params = null, $apiKey = null)
     {
         if ($params && !is_array($params)) {
-            throw new Error("You must pass an array as the first argument to EasyPost API method calls.");
+            throw new Error('You must pass an array as the first argument to EasyPost API method calls.');
         }
         if ($apiKey && !is_string($apiKey)) {
             throw new Error('The second argument to EasyPost API method calls is an optional per-request apiKey, which must be a string.');
diff --git a/lib/EasyPost/Error.php b/lib/EasyPost/Error.php
@@ -74,13 +74,13 @@ public function getHttpBody()
      */
     public function prettyPrint()
     {
-        print($this->ecode . " (" . $this->getHttpStatus() . "): " .
+        print($this->ecode . ' (' . $this->getHttpStatus() . '): ' .
             $this->getMessage() . "\n");
         if (!empty($this->errors)) {
             print("Field errors:\n");
             foreach ($this->errors as $fieldError) {
                 foreach ($fieldError as $k => $v) {
-                    print("  " . $k . ": " . $v . "\n");
+                    print('  ' . $k . ': ' . $v . "\n");
                 }
                 print("\n");
             }
diff --git a/lib/EasyPost/Requestor.php b/lib/EasyPost/Requestor.php
@@ -49,7 +49,7 @@ public static function apiUrl($url = '', $beta = false)
      */
     public static function utf8($value)
     {
-        if (is_string($value) && mb_detect_encoding($value, "UTF-8", true) != "UTF-8") {
+        if (is_string($value) && mb_detect_encoding($value, 'UTF-8', true) != 'UTF-8') {
             return utf8_encode($value);
         }
 
@@ -67,15 +67,15 @@ private static function encodeObjects($data)
         if (is_null($data)) {
             return [];
         } elseif ($data instanceof EasypostResource) {
-            return ["id" => self::utf8($data->id)];
+            return ['id' => self::utf8($data->id)];
         } elseif ($data === true) {
             return 'true';
         } elseif ($data === false) {
             return 'false';
         } elseif (is_array($data)) {
             $resource = [];
             foreach ($data as $k => $v) {
-                if (!is_null($v) and ($v !== "") and (!is_array($v) or !empty($v))) {
+                if (!is_null($v) and ($v !== '') and (!is_array($v) or !empty($v))) {
                     $resource[$k] = self::encodeObjects($v);
                 }
             }
@@ -106,19 +106,19 @@ public static function urlEncode($arr, $prefix = null)
             }
 
             if ($prefix && isset($k)) {
-                $k = $prefix . "[" . $k . "]";
+                $k = $prefix . '[' . $k . ']';
             } elseif ($prefix) {
-                $k = $prefix . "[]";
+                $k = $prefix . '[]';
             }
 
             if (is_array($v)) {
                 $r[] = self::urlEncode($v, $k, true);
             } else {
-                $r[] = urlencode($k) . "=" . urlencode($v);
+                $r[] = urlencode($k) . '=' . urlencode($v);
             }
         }
 
-        return implode("&", $r);
+        return implode('&', $r);
     }
 
     /**
diff --git a/lib/EasyPost/Shipment.php b/lib/EasyPost/Shipment.php
@@ -297,7 +297,7 @@ public static function get_lowest_smartrate($smartrates, $delivery_days, $delive
         }
 
         if ($lowestSmartrate == false) {
-            throw new Error("No rates found.");
+            throw new Error('No rates found.');
         }
 
         return $lowestSmartrate;
diff --git a/lib/EasyPost/Tracker.php b/lib/EasyPost/Tracker.php
@@ -84,7 +84,7 @@ public static function create_list($params = null, $apiKey = null)
             $params['trackers'] = (object)$clone;
         }
 
-        $encodedParams = str_replace("\\", '', json_encode($params));
+        $encodedParams = str_replace('\\', '', json_encode($params));
 
         $requestor = new Requestor($apiKey);
         $url = self::classUrl(get_class());
diff --git a/lib/EasyPost/Util.php b/lib/EasyPost/Util.php
@@ -138,8 +138,8 @@ public static function convertToEasyPostObject($response, $apiKey, $parent = nul
         } elseif (is_array($response)) {
             if (isset($response['object']) && is_string($response['object']) && isset($types[$response['object']])) {
                 $class = $types[$response['object']];
-            } elseif (isset($response['id']) && isset($prefixes[substr($response['id'], 0, strpos($response['id'], "_"))])) {
-                $class = $prefixes[substr($response['id'], 0, strpos($response['id'], "_"))];
+            } elseif (isset($response['id']) && isset($prefixes[substr($response['id'], 0, strpos($response['id'], '_'))])) {
+                $class = $prefixes[substr($response['id'], 0, strpos($response['id'], '_'))];
             } else {
                 $class = '\EasyPost\EasyPostObject';
             }
diff --git a/lib/EasyPost/Webhook.php b/lib/EasyPost/Webhook.php
@@ -97,22 +97,22 @@ public static function create($params = null, $apiKey = null)
      */
     public static function validateWebhook($eventBody, $headers, $webhookSecret)
     {
-        $easypostHmacSignature = $headers["X-Hmac-Signature"] ?? null;
+        $easypostHmacSignature = $headers['X-Hmac-Signature'] ?? null;
 
         if ($easypostHmacSignature != null) {
             $normalizedSecret = Normalizer::normalize($webhookSecret, Normalizer::FORM_KD);
-            $encodedSecret = mb_convert_encoding($normalizedSecret, "UTF-8");
+            $encodedSecret = mb_convert_encoding($normalizedSecret, 'UTF-8');
 
-            $expectedSignature = hash_hmac("sha256", $eventBody, $encodedSecret);
+            $expectedSignature = hash_hmac('sha256', $eventBody, $encodedSecret);
             $digest = "hmac-sha256-hex=$expectedSignature";
 
             if (hash_equals($digest, $easypostHmacSignature)) {
                 $webhookBody = json_decode($eventBody);
             } else {
-                throw new Error("Webhook received did not originate from EasyPost or had a webhook secret mismatch.");
+                throw new Error('Webhook received did not originate from EasyPost or had a webhook secret mismatch.');
             }
         } else {
-            throw new Error("Webhook received does not contain an HMAC signature.");
+            throw new Error('Webhook received does not contain an HMAC signature.');
         }
 
         return $webhookBody;
diff --git a/phpcs.xml b/phpcs.xml
@@ -31,4 +31,5 @@
         <!-- TODO: Change $delivery_days and $delivery_accuracy to camel caps on the next major release -->
         <exclude-pattern>/lib/EasyPost/Shipment\.php</exclude-pattern>
     </rule>
+    <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired" />
 </ruleset>
diff --git a/test/EasyPost/ErrorTest.php b/test/EasyPost/ErrorTest.php
@@ -42,8 +42,8 @@ public function testError()
             $this->assertEquals(422, $error->getHttpStatus());
             $this->assertEquals('SHIPMENT.INVALID_PARAMS', $error->ecode);
             $this->assertEquals('Unable to create shipment, one or more parameters were invalid.', $error->getMessage());
-            $this->assertEquals(["to_address" => "Required and missing."], $error->errors[0]);
-            $this->assertEquals(["from_address" => "Required and missing."], $error->errors[1]);
+            $this->assertEquals(['to_address' => 'Required and missing.'], $error->errors[0]);
+            $this->assertEquals(['from_address' => 'Required and missing.'], $error->errors[1]);
             $this->assertEquals('{"error":{"code":"SHIPMENT.INVALID_PARAMS","message":"Unable to create shipment, one or more parameters were invalid.","errors":[{"to_address":"Required and missing."},{"from_address":"Required and missing."}]}}', $error->getHttpBody());
 
             // We check that the pretty printed output is the same here, leave the odd formatting as it is here and do not auto-format the next few lines
diff --git a/test/EasyPost/ShipmentTest.php b/test/EasyPost/ShipmentTest.php
@@ -364,7 +364,7 @@ public function testGenerateForm()
 
         $shipment = Shipment::create(Fixture::one_call_buy_shipment());
 
-        $formType = "return_packing_slip";
+        $formType = 'return_packing_slip';
         $shipment->generate_form(
             $formType,
             Fixture::rma_form_options()
diff --git a/test/EasyPost/TrackerTest.php b/test/EasyPost/TrackerTest.php
@@ -36,7 +36,7 @@ public function testCreate()
         VCR::insertCassette('trackers/create.yml');
 
         $tracker = Tracker::create([
-            "tracking_code" => "EZ1000000001",
+            'tracking_code' => 'EZ1000000001',
         ]);
 
         $this->assertInstanceOf('\EasyPost\Tracker', $tracker);
@@ -52,7 +52,7 @@ public function testRetrieve()
         VCR::insertCassette('trackers/retrieve.yml');
 
         $tracker = Tracker::create([
-            "tracking_code" => "EZ1000000001",
+            'tracking_code' => 'EZ1000000001',
         ]);
 
         // Test trackers cycle through their "dummy" statuses automatically, the created and retrieved objects may differ
@@ -88,9 +88,9 @@ public function testCreateList()
         VCR::insertCassette('trackers/createList.yml');
 
         $response = Tracker::create_list([
-            '0' => ["tracking_code" => "EZ1000000001"],
-            '1' => ["tracking_code" => "EZ1000000002"],
-            '2' => ["tracking_code" => "EZ1000000003"],
+            '0' => ['tracking_code' => 'EZ1000000001'],
+            '1' => ['tracking_code' => 'EZ1000000002'],
+            '2' => ['tracking_code' => 'EZ1000000003'],
         ]);
 
         // This endpoint returns nothing so we assert the function returns true
diff --git a/test/EasyPost/WebhookTest.php b/test/EasyPost/WebhookTest.php
@@ -37,7 +37,7 @@ public function testCreate()
         VCR::insertCassette('webhooks/create.yml');
 
         $webhook = Webhook::create([
-            "url" => Fixture::webhook_url(),
+            'url' => Fixture::webhook_url(),
         ]);
 
         $this->assertInstanceOf('\EasyPost\Webhook', $webhook);
@@ -55,7 +55,7 @@ public function testRetrieve()
         VCR::insertCassette('webhooks/retrieve.yml');
 
         $webhook = Webhook::create([
-            "url" => Fixture::webhook_url(),
+            'url' => Fixture::webhook_url(),
         ]);
 
         $retrievedWebhook = Webhook::retrieve($webhook->id);
@@ -91,7 +91,7 @@ public function testUpdate()
         VCR::insertCassette('webhooks/update.yml');
 
         $webhook = Webhook::create([
-            "url" => Fixture::webhook_url(),
+            'url' => Fixture::webhook_url(),
         ]);
 
         $response = $webhook->update();
@@ -110,7 +110,7 @@ public function testDelete()
         VCR::insertCassette('webhooks/delete.yml');
 
         $webhook = Webhook::create([
-            "url" => Fixture::webhook_url(),
+            'url' => Fixture::webhook_url(),
         ]);
 
         $response = $webhook->delete();
@@ -125,25 +125,25 @@ public function testDelete()
      */
     public function testValidateWebhook()
     {
-        $webhookSecret = "sécret";
-        $expectedHmacSignature = "hmac-sha256-hex=e93977c8ccb20363d51a62b3fe1fc402b7829be1152da9e88cf9e8d07115a46b";
+        $webhookSecret = 'sécret';
+        $expectedHmacSignature = 'hmac-sha256-hex=e93977c8ccb20363d51a62b3fe1fc402b7829be1152da9e88cf9e8d07115a46b';
         $headers = [
-            "X-Hmac-Signature" => $expectedHmacSignature
+            'X-Hmac-Signature' => $expectedHmacSignature
         ];
 
         $webhookBody = Webhook::validateWebhook(Fixture::webhookBody(), $headers, $webhookSecret);
 
-        $this->assertEquals("batch.created", $webhookBody->description);
+        $this->assertEquals('batch.created', $webhookBody->description);
     }
 
     /**
      * Test a webhook signature that has invalid secret.
      */
     public function testValidateWebhookInvalidSecret()
     {
-        $webhookSecret = "invalid_secret";
+        $webhookSecret = 'invalid_secret';
         $headers = [
-            "X-Hmac-Signature" => "some-signature"
+            'X-Hmac-Signature' => 'some-signature'
         ];
 
         try {
@@ -158,9 +158,9 @@ public function testValidateWebhookInvalidSecret()
      */
     public function testValidateWebhookMissingSecret()
     {
-        $webhookSecret = "123";
+        $webhookSecret = '123';
         $headers = [
-            "some-header" => "some-signature"
+            'some-header' => 'some-signature'
         ];
 
         try {

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public static function create($params = null, $apiKey = null)`
`72`	`72`	`$wrappedParams['verify_strict'] = $verifyStrict;`
`73`	`73`	`}`
`74`	`74`
`75`		`- $wrappedParams["address"] = $params;`
	`75`	`+ $wrappedParams['address'] = $params;`
`76`	`76`
`77`	`77`	`return self::createResource(get_class(), $wrappedParams, $apiKey);`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public static function create_and_buy($params = null, $apiKey = null)`
`88`	`88`	`];`
`89`	`89`	`}`
`90`	`90`
`91`		`- $encodedParams = str_replace("\\", '', json_encode($params));`
	`91`	`+ $encodedParams = str_replace('\\', '', json_encode($params));`
`92`	`92`
`93`	`93`	`$requestor = new Requestor($apiKey);`
`94`	`94`	`$url = self::classUrl(get_class());`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class EndShipper extends EasypostResource`
`30`	`30`	`public static function create($params = null, $apiKey = null)`
`31`	`31`	`{`
`32`	`32`	`$wrappedParams = [];`
`33`		`- $wrappedParams["address"] = $params;`
	`33`	`+ $wrappedParams['address'] = $params;`
`34`	`34`
`35`	`35`	`return self::createResource(get_class(), $wrappedParams, $apiKey, null, true);`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class Billing extends EasypostResource`
`20`	`20`	`*/`
`21`	`21`	`public static function retrieve_payment_methods($params = null, $apiKey = null)`
`22`	`22`	`{`
`23`		`- $paymentMethods = self::allResources("paymentMethod", $params, $apiKey);`
	`23`	`+ $paymentMethods = self::allResources('paymentMethod', $params, $apiKey);`
`24`	`24`
`25`	`25`	`if ($paymentMethods->id == null) {`
`26`	`26`	`throw new Error('Billing has not been setup for this user. Please add a payment method.');`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public static function className($class)`
`20`	`20`	`$class = substr($class, strlen('EasyPost'));`
`21`	`21`	`}`
`22`	`22`	`$class = str_replace('_', '', $class);`
`23`		`- $class = substr($class, 0, 1) . preg_replace("/([A-Z])/", "_$1", substr($class, 1)); // Camel -> snake`
	`23`	`+ $class = substr($class, 0, 1) . preg_replace('/([A-Z])/', '_$1', substr($class, 1)); // Camel -> snake`
`24`	`24`	`$name = urlencode($class);`
`25`	`25`	`$name = strtolower($name);`
`26`	`26`
`@@ -36,7 +36,7 @@ public static function className($class)`
`36`	`36`	`public static function classUrl($class)`
`37`	`37`	`{`
`38`	`38`	`$className = self::className($class);`
`39`		`- if (substr($className, -1) !== "s" && substr($className, -1) !== "h") {`
	`39`	`+ if (substr($className, -1) !== 's' && substr($className, -1) !== 'h') {`
`40`	`40`	`return "/{$className}s";`
`41`	`41`	`}`
`42`	`42`
`@@ -90,7 +90,7 @@ public function refresh(bool $beta = false)`
`90`	`90`	`protected static function validate($params = null, $apiKey = null)`
`91`	`91`	`{`
`92`	`92`	`if ($params && !is_array($params)) {`
`93`		`- throw new Error("You must pass an array as the first argument to EasyPost API method calls.");`
	`93`	`+ throw new Error('You must pass an array as the first argument to EasyPost API method calls.');`
`94`	`94`	`}`
`95`	`95`	`if ($apiKey && !is_string($apiKey)) {`
`96`	`96`	`throw new Error('The second argument to EasyPost API method calls is an optional per-request apiKey, which must be a string.');`
Original file line number	Diff line number	Diff line change
`@@ -74,13 +74,13 @@ public function getHttpBody()`
`74`	`74`	`*/`
`75`	`75`	`public function prettyPrint()`
`76`	`76`	`{`
`77`		`- print($this->ecode . " (" . $this->getHttpStatus() . "): " .`
	`77`	`+ print($this->ecode . ' (' . $this->getHttpStatus() . '): ' .`
`78`	`78`	`$this->getMessage() . "\n");`
`79`	`79`	`if (!empty($this->errors)) {`
`80`	`80`	`print("Field errors:\n");`
`81`	`81`	`foreach ($this->errors as $fieldError) {`
`82`	`82`	`foreach ($fieldError as $k => $v) {`
`83`		`- print(" " . $k . ": " . $v . "\n");`
	`83`	`+ print(' ' . $k . ': ' . $v . "\n");`
`84`	`84`	`}`
`85`	`85`	`print("\n");`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public static function apiUrl($url = '', $beta = false)`
`49`	`49`	`*/`
`50`	`50`	`public static function utf8($value)`
`51`	`51`	`{`
`52`		`- if (is_string($value) && mb_detect_encoding($value, "UTF-8", true) != "UTF-8") {`
	`52`	`+ if (is_string($value) && mb_detect_encoding($value, 'UTF-8', true) != 'UTF-8') {`
`53`	`53`	`return utf8_encode($value);`
`54`	`54`	`}`
`55`	`55`
`@@ -67,15 +67,15 @@ private static function encodeObjects($data)`
`67`	`67`	`if (is_null($data)) {`
`68`	`68`	`return [];`
`69`	`69`	`} elseif ($data instanceof EasypostResource) {`
`70`		`- return ["id" => self::utf8($data->id)];`
	`70`	`+ return ['id' => self::utf8($data->id)];`
`71`	`71`	`} elseif ($data === true) {`
`72`	`72`	`return 'true';`
`73`	`73`	`} elseif ($data === false) {`
`74`	`74`	`return 'false';`
`75`	`75`	`} elseif (is_array($data)) {`
`76`	`76`	`$resource = [];`
`77`	`77`	`foreach ($data as $k => $v) {`
`78`		`- if (!is_null($v) and ($v !== "") and (!is_array($v) or !empty($v))) {`
	`78`	`+ if (!is_null($v) and ($v !== '') and (!is_array($v) or !empty($v))) {`
`79`	`79`	`$resource[$k] = self::encodeObjects($v);`
`80`	`80`	`}`
`81`	`81`	`}`
`@@ -106,19 +106,19 @@ public static function urlEncode($arr, $prefix = null)`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`if ($prefix && isset($k)) {`
`109`		`- $k = $prefix . "[" . $k . "]";`
	`109`	`+ $k = $prefix . '[' . $k . ']';`
`110`	`110`	`} elseif ($prefix) {`
`111`		`- $k = $prefix . "[]";`
	`111`	`+ $k = $prefix . '[]';`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`if (is_array($v)) {`
`115`	`115`	`$r[] = self::urlEncode($v, $k, true);`
`116`	`116`	`} else {`
`117`		`- $r[] = urlencode($k) . "=" . urlencode($v);`
	`117`	`+ $r[] = urlencode($k) . '=' . urlencode($v);`
`118`	`118`	`}`
`119`	`119`	`}`
`120`	`120`
`121`		`- return implode("&", $r);`
	`121`	`+ return implode('&', $r);`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ public static function get_lowest_smartrate($smartrates, $delivery_days, $delive`
`297`	`297`	`}`
`298`	`298`
`299`	`299`	`if ($lowestSmartrate == false) {`
`300`		`- throw new Error("No rates found.");`
	`300`	`+ throw new Error('No rates found.');`
`301`	`301`	`}`
`302`	`302`
`303`	`303`	`return $lowestSmartrate;`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public static function create_list($params = null, $apiKey = null)`
`84`	`84`	`$params['trackers'] = (object)$clone;`
`85`	`85`	`}`
`86`	`86`
`87`		`- $encodedParams = str_replace("\\", '', json_encode($params));`
	`87`	`+ $encodedParams = str_replace('\\', '', json_encode($params));`
`88`	`88`
`89`	`89`	`$requestor = new Requestor($apiKey);`
`90`	`90`	`$url = self::classUrl(get_class());`