chore: upgrade easypost-php and adjust client initialization

Justintime50 · Jul 19, 2024 · 28d9580 · 28d9580
1 parent be677c2
commit 28d9580
Show file tree

Hide file tree

Showing 14 changed files with 616 additions and 543 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,11 @@
 # CHANGELOG
 
-## Next Release
+## v0.12.0 (2024-07-18)
 
+- Upgrades `easypost-php` from v6 to v7
+  - Moves the EasyPostClient initialization from middleware to each function call and passes down the user's API key from the session instead
 - Switches from Font Awesome to Bootstrap Icons
+- Bumps deps
 
 ## v0.11.0 (2024-06-10)
 

diff --git a/src/app/Http/Controllers/AddressController.php b/src/app/Http/Controllers/AddressController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -30,7 +31,7 @@ public function createAddress(Request $request): RedirectResponse
             'email'    => 'nullable|string',
         ]);
 
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $address = $client->address->create(
@@ -62,7 +63,7 @@ public function createAddress(Request $request): RedirectResponse
      */
     public function retrieveAddress(Request $request, string $id): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $json = $client->address->retrieve($id);
@@ -81,7 +82,7 @@ public function retrieveAddress(Request $request, string $id): View|RedirectResp
      */
     public function retrieveAddresses(Request $request): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $json = $client->address->all();

diff --git a/src/app/Http/Controllers/CarrierController.php b/src/app/Http/Controllers/CarrierController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -18,7 +19,7 @@ class CarrierController extends Controller
      */
     public function retrieveCarrier(Request $request, string $id): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $carrier = $client->carrierAccount->retrieve($id);
@@ -37,7 +38,7 @@ public function retrieveCarrier(Request $request, string $id): View|RedirectResp
      */
     public function retrieveCarriers(Request $request): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $carriers = $client->carrierAccount->all();

diff --git a/src/app/Http/Controllers/InsuranceController.php b/src/app/Http/Controllers/InsuranceController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -63,7 +64,7 @@ public function createInsurance(Request $request): RedirectResponse
             'amount'            => 'required|string|max:5000',
         ]);
 
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             if ($request->input('to_address') != null) {
@@ -125,7 +126,7 @@ public function createInsurance(Request $request): RedirectResponse
      */
     public function retrieveInsurance(Request $request, string $id)
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $insurance = $client->insurance->retrieve($id);
@@ -144,7 +145,7 @@ public function retrieveInsurance(Request $request, string $id)
      */
     public function retrieveInsurances(Request $request)
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $insurances = $client->insurance->all();

diff --git a/src/app/Http/Controllers/ParcelController.php b/src/app/Http/Controllers/ParcelController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -31,7 +32,7 @@ public function createParcel(Request $request): RedirectResponse
             ]);
         }
 
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             if ($request->input('predefined_package') != null) {
@@ -65,7 +66,7 @@ public function createParcel(Request $request): RedirectResponse
      */
     public function retrieveParcel(Request $request, string $id): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $parcel = $client->parcel->retrieve($id);

diff --git a/src/app/Http/Controllers/RefundController.php b/src/app/Http/Controllers/RefundController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -18,7 +19,7 @@ class RefundController extends Controller
      */
     public function retrieveRefund(Request $request, string $id)
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $refund = $client->refund->retrieve($id);
@@ -40,7 +41,7 @@ public function retrieveRefund(Request $request, string $id)
      */
     public function retrieveRefunds(Request $request): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $refunds = $client->refund->all();

diff --git a/src/app/Http/Controllers/SearchController.php b/src/app/Http/Controllers/SearchController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -49,7 +50,7 @@ public function searchRecord(Request $request): View|RedirectResponse
     {
         $id = $request->input('id');
         $idPrefix = substr($id, 0, strpos($id, '_'));
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $class = OBJECT_ID_PREFIXES[$idPrefix] ?? null;

diff --git a/src/app/Http/Controllers/ShipmentController.php b/src/app/Http/Controllers/ShipmentController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -77,7 +78,7 @@ public function createShipment(Request $request): View|RedirectResponse
             ]);
         }
 
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         if ($request->input('to_address') != null) {
             try {
@@ -178,7 +179,7 @@ function ($a, $b) {
      */
     public function retrieveShipment(Request $request, string $id): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $shipment = $client->shipment->retrieve($id);
@@ -197,7 +198,7 @@ public function retrieveShipment(Request $request, string $id): View|RedirectRes
      */
     public function retrieveShipments(Request $request): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $shipments = $client->shipment->all([
@@ -219,7 +220,7 @@ public function retrieveShipments(Request $request): View|RedirectResponse
      */
     public function createRefund(Request $request, string $id): RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $client->shipment->refund($id);
@@ -240,7 +241,7 @@ public function createRefund(Request $request, string $id): RedirectResponse
      */
     public function buyShipment(Request $request, string $id): RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $shipment = $client->shipment->buy(
@@ -295,7 +296,7 @@ public function buyStamp(Request $request): RedirectResponse
             ]);
         }
 
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         if ($request->input('to_address') != null) {
             try {
@@ -382,7 +383,7 @@ public function buyStamp(Request $request): RedirectResponse
      */
     public function generateQrCodes(Request $request, string $id): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $shipment = $client->shipment->generateForm($id, 'label_qr_code');

diff --git a/src/app/Http/Controllers/TrackerController.php b/src/app/Http/Controllers/TrackerController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use EasyPost\EasyPostClient;
 use EasyPost\Exception\Api\ApiException;
 use Illuminate\Contracts\View\View;
 use Illuminate\Http\RedirectResponse;
@@ -22,7 +23,7 @@ public function createTracker(Request $request): View|RedirectResponse
             'carrier'       => 'nullable|string',
         ]);
 
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $response = $client->tracker->create(
@@ -47,7 +48,7 @@ public function createTracker(Request $request): View|RedirectResponse
      */
     public function retrieveTracker(Request $request, string $id): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $tracker = $client->tracker->retrieve($id);
@@ -66,7 +67,7 @@ public function retrieveTracker(Request $request, string $id): View|RedirectResp
      */
     public function retrieveTrackers(Request $request): View|RedirectResponse
     {
-        $client = $request->session()->get('client');
+        $client = new EasyPostClient($request->session()->get('apiKey'));
 
         try {
             $response = $client->tracker->all();

diff --git a/src/app/Http/Middleware/ApiKey.php b/src/app/Http/Middleware/ApiKey.php
@@ -23,12 +23,11 @@ public function handle($request, Closure $next)
         try {
             $apiKey = Crypt::decryptString(Auth::user()->api_key);
         } catch (DecryptException $e) {
-            session()->flash('error', 'API Key could not be decrypted. Please update your key and try again.');
+            session()->flash('error', 'API key could not be decrypted. Please update your API key and try again.');
             return back();
         }
 
-        $client = new EasyPostClient($apiKey);
-        $request->session()->put(['client' => $client]);
+        $request->session()->put(['apiKey' => $apiKey]);
 
         return $next($request);
     }

diff --git a/src/composer.json b/src/composer.json
@@ -10,7 +10,7 @@
     "require": {
         "php": "^8.2",
         "anhskohbo/no-captcha": "^3.6",
-        "easypost/easypost-php": "^6.0",
+        "easypost/easypost-php": "^7.0",
         "laravel/framework": "^11.0",
         "laravel/tinker": "^2.9",
         "laravel/ui": "^4.5",