Merge pull request #16 from ShipEngine/coverage

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);
 

docs/addressValidateExample.md

@@ -1,6 +1,6 @@
 Address Validation Documentation
 ================================
-ShipEngine allows you to validate an address before using it to create a shipment to ensure accurate delivery
+[ShipEngine](www.shipengine.com) allows you to validate an address before using it to create a shipment to ensure accurate delivery
 of your packages.
 
 Address validation can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine
@@ -24,8 +24,9 @@ There are two ways to validate an address using this SDK.
   requires a `countryCode` which should be the 2 character capitalized abbreviation for a given countryCode.
 
 - **Behavior**: The `validateAddress` method will always return
-  an [AddressValidateResult](../src/Model/Address/AddressValidateResult.php) object, even in the even that the
-  address passed in was not *valid*.
+  an [AddressValidateResult](../src/Model/Address/AddressValidateResult.php) object, and it allows you to determine
+  whether an address is valid before using it for your shipments. It accepts an address object containing typical
+  address properties, described below, and will return a normalized address object if the address is valid.
 
 - **Method level configuration** - You can optionally pass in an array that contains `configuration` values to be used
   for the current method call. The options are `apiKey`, `baseUrl`, `pageSize`,
@@ -88,7 +89,7 @@ $validated_address = $shipengine->validateAddress($address, ['retries' => 2]);
 print_r($validated_address);
 ```
 
-**Successful Address Validation Output:**: As a raw `AddressValidateResult` object.
+**Successful Address Validation Output:** As a raw `AddressValidateResult` object.
 
 ```php
 ShipEngine\Model\Address\AddressValidateResult Object
@@ -138,7 +139,7 @@ $validated_address = $shipengine->validateAddress($address, ['retries' => 2]);
 print_r(json_encode($validated_address, JSON_PRETTY_PRINT));  // Return the AddressValidateResult Type as a JSON string.
 ```
 
-**Successful Address Validation Output:**: This is the `AddressValidateResult` Type serialized as JSON.
+**Successful Address Validation Output:** This is the `AddressValidateResult` Type serialized as JSON.
 ```json5
 {
   "valid": true,

src/Message/Events/ShipEngineEvent.php

@@ -4,7 +4,6 @@
 
 use DateTime;
 use ShipEngine\Message\InvalidFieldValueException;
-use ShipEngine\Message\ShipEngineException;
 use ShipEngine\ShipEngineConfig;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Contracts\EventDispatcher\Event;

src/Message/TimeoutException.php

@@ -13,7 +13,7 @@
 final class TimeoutException extends ShipEngineException
 {
     /**
-     * TimeoutException constructor - Instantiates a server-side error.
+     * TimeoutException constructor - Instantiates a timeout exception.
      *
      * @param int $retryAfter The amount of time (in SECONDS) to wait before retrying the request.
      * @param string|null $source

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/ShipEngineClient.php

@@ -123,7 +123,7 @@ private function sendRequest(
         $baseUri = !getenv('CLIENT_BASE_URI') ? $config->baseUrl : getenv('CLIENT_BASE_URI');
         $requestHeaders = array(
             'Api-Key' => $config->apiKey,
-            'User-Agent' => $this->deriveUserAgent(ShipEngine::VERSION),
+            'User-Agent' => $this->deriveUserAgent(),
             'Content-Type' => 'application/json',
             'Accept' => 'application/json'
         );
@@ -279,9 +279,9 @@ private function handleResponse(array $response): array
      *
      * @returns string
      */
-    private function deriveUserAgent(string $version): string
+    private function deriveUserAgent(): string
     {
-        $sdk_version = 'shipengine-php/' . $version;
+        $sdk_version = 'shipengine-php/' . ShipEngine::VERSION;
 
         $os = explode(' ', php_uname());
         $os_kernel = $os[0] . '/' . $os[2];

src/ShipEngineConfig.php

@@ -10,7 +10,7 @@
 
 /**
  * Class ShipEngineConfig - This is the configuration object for the ShipEngine object and it's properties are
- * used throughout this SDK>
+ * used throughout this SDK.
  *
  * @package ShipEngine
  */
@@ -163,10 +163,6 @@ public function merge(?array $newConfig = null): ShipEngineConfig
             ($config['timeout'] = $newConfig['timeout']) :
             ($config['timeout'] = $this->timeout);
 
-        isset($newConfig['timeout']) ?
-            ($config['timeout'] = $newConfig['timeout']) :
-            ($config['timeout'] = $this->timeout);
-
         isset($newConfig['$this->eventListener']) ?
             ($config['$this->eventListener'] = $newConfig['$this->eventListener']) :
             ($config['$this->eventListener'] = $this->eventListener);

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
         ) {