feature/expand-response-storage (#15)

* Added unique message when internal rate limit vs external rate limit; Added storing of response and code

* Added observer to ensure body is json not string

Author: Quentin Schmick

src/Message/RateLimitExceededException.php

@@ -25,14 +25,16 @@ final class RateLimitExceededException extends ShipEngineException
      * @param DateInterval $retryAfter
      * @param string|null $source
      * @param string|null $requestId
+     * @param string      $message
      */
     public function __construct(
         DateInterval $retryAfter,
         string|null $source = null,
-        string|null $requestId = null
+        string|null $requestId = null,
+        string $message = 'You have exceeded the rate limit.',
     ) {
         parent::__construct(
-            'You have exceeded the rate limit.',
+            $message,
             $requestId,
             $source,
             'System',

src/Models/RequestLog.php

@@ -3,6 +3,7 @@
 namespace BluefynInternational\ShipEngine\Models;
 
 use AlwaysOpen\RequestLogger\Models\RequestLogBaseModel;
+use BluefynInternational\ShipEngine\Observers\RequestLogObserver;
 
 /**
  * BluefynInternational\ShipEngine\Models\RequestLog
@@ -18,6 +19,12 @@
  */
 class RequestLog extends RequestLogBaseModel
 {
+    protected static function boot()
+    {
+        parent::boot();
+        parent::observe(RequestLogObserver::class);
+    }
+
     public function getTable()
     {
         return config('shipengine.request_log_table_name');

src/Observers/RequestLogObserver.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace BluefynInternational\ShipEngine\Observers;
+
+use AlwaysOpen\RequestLogger\Models\RequestLogBaseModel;
+
+class RequestLogObserver
+{
+    public function saving(RequestLogBaseModel $model)
+    {
+        if (is_string($model->body)) {
+            try {
+                $model->body = json_decode($model->body, true);
+            } catch (\Exception $e) {
+                // no op
+            }
+        }
+    }
+}

src/ShipEngineClient.php

@@ -186,6 +186,7 @@ private static function sendRequest(
         }
 
         try {
+            $response = null;
             self::incrementRequestCount($config);
 
             $response = $client->send(
@@ -200,6 +201,8 @@ private static function sendRequest(
             }
         } catch (Exception|Throwable  $err) {
             if (config('shipengine.track_requests')) {
+                $requestLog->response_code = $response?->getStatusCode();
+                $requestLog->response = $requestLogResponse ?? null;
                 $requestLog->exception = substr($err->getMessage(), 0, config('shipengine.request_log_table_exception_length'));
                 $requestLog->save();
             }
@@ -294,7 +297,7 @@ private static function incrementRequestCount(ShipEngineConfig $config) : void
             $nextExpire = now()->seconds(0)->addMinute();
 
             if ($count > $config->requestLimitPerMinute) {
-                throw new RateLimitExceededException(retryAfter: new DateInterval('PT1S'));
+                throw new RateLimitExceededException(retryAfter: new DateInterval('PT1S'), message: 'Internal conifg API rate limit exceeded.');
             }
 
             Cache::put('shipengine.api-request.count', $count + 1, $nextExpire);