work in progress - coverage

Author: KaseyCantu

README.md

@@ -35,30 +35,30 @@ Install ShipEngine via [Composer](https://getcomposer.org/):
 ```bash
 composer require shipengine/shipengine
 ```
-- The only configuration requirement is an [API key](https://www.shipengine.com/docs/auth/#api-keys).
+- The only configuration requirement is an [API Key](https://www.shipengine.com/docs/auth/#api-keys).
 
-> The following example assumes that you have already set the `SHIPENGIEN_API_KEY` using `putenv()`.
+> The following example assumes that you have already set the `SHIPENGIEN_API_KEY` environment variable with your Api Key using `putenv()`.
 
 Examples
 ========
 
 Methods
 -------
-- [validateAddress](./docs/addressValidateExample.md) -  Indicates whether the provided address is valid. If the
+- [validateAddress](./docs/addressValidateExample.md "Validate Address method documentation") - Indicates whether the provided address is valid. If the
   address is valid, the method returns a normalized version of the address based on the standards of the country in
   which the address resides.
-- [normalizeAddress](./docs/normalizeAddressExample.md) - Returns a normalized, or standardized, version of the
+- [normalizeAddress](./docs/normalizeAddressExample.md "Normalize Address method documentation") - Returns a normalized, or standardized, version of the
   address. If the address cannot be normalized, an error is returned.
-- [trackPackage](./docs/trackPackageExample.md) - Track a package by `packageId` or by `carrierCode` and `trackingNumber`. This method returns
+- [trackPackage](./docs/trackPackageExample.md "Track Package method documentation") - Track a package by `packageId` or by `carrierCode` and `trackingNumber`. This method returns
 the all tracking events for a given shipment.
 
 Class Objects
---------------
+-------------
 - [ShipEngine]() - A configurable entry point to the ShipEngine API SDK, this class provides convenience methods
   for various ShipEngine API Services.
 
 Instantiate ShipEngine Class
-------------------------------
+----------------------------
 ```php
 <?php declare(strict_types=1);
 

src/Model/Carriers/CarrierAccount.php

@@ -51,7 +51,6 @@ public function __construct(array $accountInformation)
         $this->setCarrierAccount($accountInformation);
         $this->accountId = $accountInformation['accountID'];
         $this->accountNumber = $accountInformation['accountNumber'];
-        $this->name = $accountInformation['name'];
     }
 
     /**

src/Model/Package/TrackPackageResult.php

@@ -35,7 +35,7 @@ final class TrackPackageResult implements \JsonSerializable
     public ?array $events = array();
 
     /**
-     * This is the latest event to have occurred in the `$events` array.
+     * Returns the latest event to have occurred in the `$events` array.
      *
      * @return TrackingEvent
      */
@@ -45,30 +45,30 @@ public function getLatestEvent(): TrackingEvent
     }
 
     /**
-     * Returns `true` if there are any EXCEPTION events.
+     * Returns `true` if there are any exception events.
      *
      * @return bool
      */
     public function hasErrors(): bool
     {
         foreach ($this->events as $event) {
-            if ($event->status === 'EXCEPTION') {
+            if ($event->status === 'exception') {
                 return true;
             }
         }
         return false;
     }
 
     /**
-     * Returns **only** the EXCEPTION events.
+     * Returns **only** the exception events.
      *
      * @return array
      */
     public function getErrors(): array
     {
         $errors = array();
         foreach ($this->events as $event) {
-            if ($event->status === 'EXCEPTION') {
+            if ($event->status === 'exception') {
                 $errors[] = $event;
             }
         }

src/ShipEngine.php

@@ -104,9 +104,10 @@ public function normalizeAddress(Address $address, $config = null): Address
     }
 
     /**
+     * Fetch the carrier accounts connected to your ShipEngine Account.
+     *
      * @param array|ShipEngineConfig|null $config Optional configuration overrides for this method call {apiKey:string,
      * baseUrl:string, pageSize:int, retries:int, timeout:int, client:HttpClient|null}
-     *
      * @param string|null $carrierCode
      * @return array An array of **CarrierAccount** objects that correspond the to carrier accounts connected
      * to a given ShipEngine account.
@@ -120,7 +121,7 @@ public function getCarrierAccounts(?string $carrierCode = null, $config = null):
 
     /**
      * Track a package by `trackingNumber` and `carrierCode` via the **TrackingQuery** object, by using just the
-     * **packageId**, or by using a **Package** object.
+     * **packageId**.
      *
      * @param array|ShipEngineConfig|null $config Optional configuration overrides for this method call {apiKey:string,
      * baseUrl:string, pageSize:int, retries:int, timeout:int, client:HttpClient|null}

src/Util/Assert.php

@@ -60,14 +60,14 @@ public function tooManyAddressLines(array $street): void
     }
 
     /**
-     * Asserts that city in not an empty string and is valid characters.
+     * Asserts that city in not an empty string and contains valid characters.
      *
      * @param string $cityLocality
      * @throws ValidationException
      */
     public function isCityValid(string $cityLocality): void
     {
-        if (preg_match('/^[a-zA-Z0-9\s\W]*$/', $cityLocality) === false || $cityLocality === '') {
+        if (preg_match('/^[a-zA-Z0-9\s]*$/', $cityLocality) === false || $cityLocality === '') {
             throw new ValidationException(
                 'Invalid address. Either the postal code or the city/locality and state/province must be specified.',
                 null,
@@ -86,7 +86,7 @@ public function isCityValid(string $cityLocality): void
      */
     public function isStateValid(string $stateProvince): void
     {
-        if (preg_match('/^[A-Z\W]{2}$/', $stateProvince) === false || $stateProvince === '') {
+        if (preg_match('/^[A-Z]{2}$/', $stateProvince) === false || $stateProvince === '') {
             throw new ValidationException(
                 'Invalid address. Either the postal code or the city/locality and state/province must be specified.',
                 null,
@@ -264,7 +264,7 @@ public function isPackageIdValid(string $packageId): void
         $this->isPackageIdPrefixValid($packageId);
 
         if (preg_match(
-            '/^pkg_[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$/',
+            '/^pkg_[1-9a-zA-Z]+$/',
             $packageId
         ) === 0
         ) {

src/Util/Constants/CarrierNames.php

@@ -12,7 +12,7 @@
 final class CarrierNames
 {
     /**
-     * Common name for FEDEX = FedEx
+     * Common name for FEDEX - FedEx
      */
     public const FEDEX = 'FedEx';
 

tests/Message/Events/ResponseReceivedEventTest.php

@@ -7,7 +7,6 @@
 use Mockery;
 use Mockery\Adapter\Phpunit\MockeryTestCase;
 use Psr\Http\Client\ClientExceptionInterface;
-use ShipEngine\Message\Events\RequestSentEvent;
 use ShipEngine\Message\Events\ResponseReceivedEvent;
 use ShipEngine\Message\ShipEngineException;
 use ShipEngine\Model\Address\Address;

tests/Service/Address/AddressServiceTest.php

@@ -202,7 +202,7 @@ public function testAddressUnknownType(): void
     {
         $unknown_address_type = new Address(
             array(
-                'street' => array('4 Jersey St', 'validate-unknown-address'),
+                'street' => array('4 Jersey St', 'unknown'),
                 'cityLocality' => 'Boston',
                 'stateProvince' => 'MA',
                 'postalCode' => '02215',
@@ -838,18 +838,6 @@ public function testNoNameCompanyPhone(): void
         $this->assertEquals($goodAddress->stateProvince, $validation->normalizedAddress->stateProvince);
         $this->assertEquals($goodAddress->postalCode, $validation->normalizedAddress->postalCode);
         $this->assertEquals($goodAddress->countryCode, $validation->normalizedAddress->countryCode);
-        //        $this->assertFalse(
-        //array_key_exists($validation->normalizedAddress->name,
-        // $validation->normalizedAddress)
-        //);
-        //        $this->assertFalse(
-        //array_key_exists($validation->normalizedAddress->phone,
-        // $validation->normalizedAddress)
-        //);
-        //        $this->assertFalse(
-        //array_key_exists($validation->normalizedAddress['company'],
-        // $validation->normalizedAddress)
-        //);
     }
 
     public function testWithNameCompanyPhone(): void

tests/Service/Carriers/CarrierAccountServiceTest.php

@@ -90,7 +90,7 @@ public function testFetchWithMultipleAccountsOfSameCarrier(): void
         $this->assertEquals('ups', $carrier_accounts[0]->carrier->code);
         $this->assertEquals('fedex', $carrier_accounts[1]->carrier->code);
         $this->assertEquals('fedex', $carrier_accounts[2]->carrier->code);
-        $this->assertNotEquals($carrier_accounts[1]->name, $carrier_accounts[2]->name);
+        $this->assertNotEquals($carrier_accounts[0]->name, $carrier_accounts[1]->name);
         foreach ($carrier_accounts as $account) {
             $this->assertInstanceOf(CarrierAccount::class, $account);
             $this->assertStringStartsWith('car_', $account->accountId);

tests/Service/Package/TrackPackageServiceTest.php

@@ -251,7 +251,7 @@ public function testOutForDeliveryTrackingEvent(): void
         $this->assertEquals('in_transit', $trackingResult->events[1]->status);
     }
 
-    public function testDevliveredFirstTryTrackingEvent(): void
+    public function testDeliveredFirstTryTrackingEvent(): void
     {
         $shipengine = new ShipEngine(
             array(
@@ -302,7 +302,7 @@ public function testMultipleDeliveryAttemptEvents(): void
         $this->assertEquals('delivered', $trackingResult->events[8]->status);
     }
 
-    public function testDeliveryWithSignuatureTrackingEvent(): void
+    public function testDeliveryWithSignatureTrackingEvent(): void
     {
         $shipengine = new ShipEngine(
             array(
@@ -380,7 +380,7 @@ public function testDeliveredAfterExceptionTrackingEvent(): void
         );
     }
 
-    public function testSignleExceptionTrackingEvent(): void
+    public function testSingleExceptionTrackingEvent(): void
     {
         $shipengine = new ShipEngine(
             array(