Merge pull request #4 from pdbreen/master

trackConfirm support + a bit more

README.md

@@ -14,16 +14,18 @@ composer require johnpaulmedina/laravel-usps:dev-master
 ```
 ## Laravel integration
 
-To wire this up in your Laravel project you need to add the service provider.
+For Laravel 5.5 and later, this package will be auto discovered and registered.
+
+To wire this up in your Laravel 5.4 project you need to add the service provider.
 Open `config/app.php`, and add a new item to the providers array.
 
 ```php
-'Usps\UspsServiceProvider',
+Johnpaulmedina\Usps\UspsServiceProvider::class,
 ```
 Then you must also specify the alias in `config/app.php`. Add a new item to the Aliases array.
 
 ```php
-'Usps' => 'Usps\Facades\Usps',
+'Usps' => Johnpaulmedina\Usps\Facades\Usps::class,
 ```
 This will allow integration by adding the Facade `Use Usps;` 
 
@@ -32,8 +34,9 @@ Add your USPS username config in `config/services.php`.
 
 ```php
 'usps' => [
-		'username' => "XXXXXXXXXXXX"
-	]
+		'username' => "XXXXXXXXXXXX",
+		'testmode' => false,
+	],
 ```
 
 ## Example Controller Usage
@@ -60,6 +63,23 @@ class USPSController extends Controller
             )
         );
     }
+
+    public function trackConfirm() {
+        return response()->json(
+            Usps::trackConfirm( 
+                Request::input('id')
+            )
+        );
+    }
+
+    public function trackConfirmRevision1() {
+        return response()->json(
+            Usps::trackConfirm( 
+                Request::input('id'),
+                'Acme, Inc'
+            )
+        );
+    }
 }
 ```
 

composer.json

@@ -17,11 +17,21 @@
     "license": "MIT",
     "require": {
         "php": ">=7.1.0",
-        "illuminate/support": "~5.4"
+        "illuminate/support": "~5.4|~5.5|~5.6"
     },
     "autoload": {
-        "psr-0": {
-            "Usps": "src/"
+        "psr-4": {
+            "Johnpaulmedina\\Usps\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Johnpaulmedina\\Usps\\UspsServiceProvider"
+            ],
+            "aliases": {
+                "Usps": "Johnpaulmedina\\Usps\\Facades\\Usps"
+            }
         }
     },
     "minimum-stability": "dev"

src/Usps/Address.php

@@ -11,7 +11,7 @@
 
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class Address
 {

src/Usps/AddressVerify.php

@@ -9,7 +9,7 @@
 
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class AddressVerify extends USPSBase
 {

src/Usps/CityStateLookup.php

@@ -11,7 +11,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class CityStateLookup extends USPSBase
 {

src/Usps/Exceptions/UspsException.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Patrick Breen
+ * Date: 2/14/2018
+ * Time: 2:54 PM
+ */
+
+namespace Johnpaulmedina\Usps\Exceptions;
+
+use Throwable;
+
+class UspsException extends \Exception
+{
+    public function __construct(string $message, int $code)
+    {
+        parent::__construct($message, $code, null);
+    }
+}

src/Usps/Exceptions/UspsTrackConfirmException.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Patrick Breen
+ * Date: 2/14/2018
+ * Time: 2:54 PM
+ */
+
+namespace Johnpaulmedina\Usps\Exceptions;
+
+use Throwable;
+
+class UspsTrackConfirmException extends UspsException
+{
+    public function __construct(string $message, int $code)
+    {
+        parent::__construct($message, $code);
+    }
+}

src/Usps/Facades/Usps.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Usps\Facades;
+namespace Johnpaulmedina\Usps\Facades;
 
 use Illuminate\Support\Facades\Facade;
 

src/Usps/FirstClassServiceStandards.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class FirstClassServiceStandards extends USPSBase
 {

src/Usps/InternationalLabel.php

@@ -9,7 +9,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class InternationalLabel extends USPSBase
 {

src/Usps/OpenDistributeLabel.php

@@ -9,7 +9,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class OpenDistributeLabel extends USPSBase
 {

src/Usps/PriorityLabel.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class PriorityLabel extends USPSBase
 {

src/Usps/PriorityMailServiceStandards.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class PriorityMailServiceStandards extends USPSBase
 {

src/Usps/Rate.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class Rate extends USPSBase
 {

src/Usps/RatePackage.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class RatePackage extends Rate
 {

src/Usps/ServiceDeliveryCalculator.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class ServiceDeliveryCalculator extends USPSBase
 {

src/Usps/TrackConfirm.php

@@ -8,14 +8,18 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 class TrackConfirm extends USPSBase
 {
     /**
      * @var string - the api version used for this type of call
      */
     protected $apiVersion = 'TrackV2';
+    /**
+     * @var array - additional request parameters for Revision 1
+     */
+    protected $requestData = [];
     /**
      * @var array - list of all packages added so far
      */
@@ -43,7 +47,7 @@ public function getTracking()
      */
     public function getPostFields()
     {
-        return $this->packages;
+        return array_merge($this->requestData, $this->packages);
     }
 
     /**
@@ -56,4 +60,19 @@ public function addPackage($id)
     {
         $this->packages['TrackID'][] = ['@attributes' => ['ID' => $id]];
     }
+
+    /**
+     * Set revision ID and additional required fields
+     *
+     * @param string $clientIp
+     * @param string $sourceId
+     * @param int $revisionId
+     * @return void
+     */
+    public function setRevision($clientIp, $sourceId, $revisionId = 1)
+    {
+        $this->requestData['Revision'] = $revisionId;
+        $this->requestData['ClientIp'] = $clientIp;
+        $this->requestData['SourceId'] = $sourceId;
+    }
 }

src/Usps/USPSBase.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 abstract class USPSBase
 {

src/Usps/Usps.php

@@ -10,11 +10,9 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
-function __autoload($class_name) {
-    include $class_name . '.php';
-}
+use Johnpaulmedina\Usps\Exceptions\UspsTrackConfirmException;
 
 class Usps {
 
@@ -54,4 +52,33 @@ public function validate($request) {
 
 
     }
+
+    /**
+     * @param $ids array|string
+     * @param $sourceId null|string
+     *
+     * @return array
+     * @throws UspsTrackConfirmException
+     */
+    public function trackConfirm($ids, $sourceId = null)
+    {
+        $trackConfirm = new TrackConfirm($this->config['username']);
+        $trackConfirm->setTestMode(empty($this->config['testmode']) ? false : true);
+
+        if ($sourceId) {
+            // Assume revision 1 tracking is desired when sourceId supplied
+            $trackConfirm->setRevision(request()->getClientIp(), $sourceId);
+        }
+
+        collect(is_array($ids)? $ids : [ $ids ])->each(function ($id) use ($trackConfirm) {
+            $trackConfirm->addPackage($id);
+        });
+
+        $trackConfirm->getTracking();
+        if ($trackConfirm->isError()) {
+            throw new UspsTrackConfirmException($trackConfirm->getErrorMessage(), $trackConfirm->getErrorCode());
+        }
+
+        return $trackConfirm->getArrayResponse();
+    }
 }

src/Usps/UspsServiceProvider.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 use Illuminate\Support\ServiceProvider;
 
@@ -49,4 +49,4 @@ public function provides()
         return array('usps');
     }
 
-}
+}

src/Usps/XML2Array.php

@@ -10,7 +10,7 @@
  */
 
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 /**
  * XML2Array: A class to convert XML to array in PHP

src/Usps/XMLParser.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 /**
  * Array2XML: A class to convert array in PHP to XML

src/Usps/ZipCodeLookup.php

@@ -8,7 +8,7 @@
  * @author Vincent Gabriel
  */
 
-namespace Usps;
+namespace Johnpaulmedina\Usps;
 
 /**
  * USPS Zip code lookup by city/state