Merge pull request #49 from grayloon/api-logging

Add API Debug Logging

Author: ahinkle

config/magento.php

@@ -61,4 +61,15 @@
     |
     */
     'version' => env('MAGENTO_API_VERSION', 'V1'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Magento API Log Failed Requests
+    |--------------------------------------------------------------------------
+    |
+    |  Logs all non-successful Useful for debugging request parameters,
+    |  endpoints, or responses from the Magento API. Logs to the
+    |  Laravel Log file.
+    */
+    'log_failed_requests' => env('MAGENTO_API_LOG_FAILED_REQUESTS', false),
 ];

src/Api/AbstractApi.php

@@ -5,6 +5,7 @@
 use Exception;
 use Grayloon\Magento\Magento;
 use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Log;
 
 abstract class AbstractApi
 {
@@ -57,7 +58,7 @@ protected function constructRequest()
     protected function get($path, $parameters = [])
     {
         return $this->checkExceptions(Http::withToken($this->magento->token)
-            ->get($this->apiRequest.$path, $parameters));
+            ->get($this->apiRequest.$path, $parameters), $this->apiRequest.$path, $parameters);
     }
 
     /**
@@ -71,7 +72,7 @@ protected function get($path, $parameters = [])
     protected function post($path, $parameters = [])
     {
         return $this->checkExceptions(Http::withToken($this->magento->token)
-            ->post($this->apiRequest.$path, $parameters));
+            ->post($this->apiRequest.$path, $parameters), $this->apiRequest.$path, $parameters);
     }
 
     /**
@@ -85,7 +86,7 @@ protected function post($path, $parameters = [])
     protected function put($path, $parameters = [])
     {
         return $this->checkExceptions(Http::withToken($this->magento->token)
-            ->put($this->apiRequest.$path, $parameters));
+            ->put($this->apiRequest.$path, $parameters), $this->apiRequest.$path, $parameters);
     }
 
     /**
@@ -99,7 +100,7 @@ protected function put($path, $parameters = [])
     protected function delete($path, $parameters = [])
     {
         return $this->checkExceptions(Http::withToken($this->magento->token)
-            ->delete($this->apiRequest.$path, $parameters));
+            ->delete($this->apiRequest.$path, $parameters), $this->apiRequest.$path, $parameters);
     }
 
     /**
@@ -109,12 +110,18 @@ protected function delete($path, $parameters = [])
      * @return void
      * @throws \Exception
      */
-    protected function checkExceptions($response)
+    protected function checkExceptions($response, $endpoint, $parameters)
     {
         if ($response->serverError()) {
             throw new Exception($response['message'] ?? $response);
         }
 
+        if (! $response->successful()) {
+            if (config('magento.log_failed_requests')) {
+                Log::info('[MAGENTO API][STATUS] '.$response->status().' [ENDPOINT] '.$endpoint.' [PARAMETERS]  '.json_encode($parameters).' [RESPONSE] '.json_encode($response->json()));
+            }
+        }
+
         return $response;
     }