broke building request values into their own func and added debug option

Author: avigoldman

lib/SparkPost/SparkPost.php

@@ -40,6 +40,7 @@ class SparkPost
         'key' => '',
         'version' => 'v1',
         'async' => true,
+        'debug' => false
     ];
 
     /**
@@ -93,11 +94,13 @@ public function request($method = 'GET', $uri = '', $payload = [], $headers = []
      */
     public function syncRequest($method = 'GET', $uri = '', $payload = [], $headers = [])
     {
-        $request = $this->buildRequest($method, $uri, $payload, $headers);
+        $requestValues = $this->buildRequestValues($method, $uri, $payload, $headers);
+        $request = $this->buildRequest($requestValues);
+
         try {
-            return new SparkPostResponse($this->httpClient->sendRequest($request));
+            return new SparkPostResponse($this->httpClient->sendRequest($request), $this->ifDebug($requestValues));
         } catch (\Exception $exception) {
-            throw new SparkPostException($exception);
+            throw new SparkPostException($exception, $this->ifDebug($requestValues));
         }
     }
 
@@ -114,25 +117,26 @@ public function syncRequest($method = 'GET', $uri = '', $payload = [], $headers
     public function asyncRequest($method = 'GET', $uri = '', $payload = [], $headers = [])
     {
         if ($this->httpClient instanceof HttpAsyncClient) {
-            $request = $this->buildRequest($method, $uri, $payload, $headers);
+            $requestValues = $this->buildRequestValues($method, $uri, $payload, $headers);
+            $request = call_user_func_array(array($this, 'buildRequest'), $requestValues);
 
-            return new SparkPostPromise($this->httpClient->sendAsyncRequest($request));
+            return new SparkPostPromise($this->httpClient->sendAsyncRequest($request), $this->ifDebug($requestValues));
         } else {
             throw new \Exception('Your http client does not support asynchronous requests. Please use a different client or use synchronous requests.');
         }
     }
 
     /**
-     * Builds request from given params.
+     * Builds request values from given params.
      *
      * @param string $method
      * @param string $uri
      * @param array  $payload
      * @param array  $headers
      *
-     * @return RequestInterface
+     * @return array $requestValues
      */
-    public function buildRequest($method, $uri, $payload, $headers)
+    public function buildRequestValues($method, $uri, $payload, $headers)
     {
         $method = trim(strtoupper($method));
 
@@ -153,7 +157,23 @@ public function buildRequest($method, $uri, $payload, $headers)
         ];
         $body = strtr(json_encode($body), $jsonReplace);
 
-        return $this->getMessageFactory()->createRequest($method, $url, $headers, $body);
+        return [
+            'method' => $method,
+            'url' => $url,
+            'headers' => $headers,
+            'body' => $body
+        ];
+    }
+
+    /**
+     * Build RequestInterface from given params
+     *
+     * @param array $requestValues
+     * @return RequestInterface
+     */
+    public function buildRequest($method, $uri, $headers, $body)
+    {
+        return $this->getMessageFactory()->createRequest($method, $uri, $headers, $body);
     }
 
     /**
@@ -245,6 +265,17 @@ public function setOptions($options)
         }
     }
 
+    /**
+     * Returns the given value if debugging, an empty instance otherwise
+     *
+     * @param any $param
+     * @return any $param
+     */
+    private function ifDebug($param)
+    {
+        return $this->options['debug'] ? $param : null;
+    }
+
     /**
      * Sets up any endpoints to custom classes e.g. $this->transmissions.
      */