Save the last API response to StripeObjects.

Calling `getLastResponse` will return the last API response made by that object. The API response contains the headers, status code, response body and JSON.
stripe · Oct 20, 2015 · 1439e5b · 1439e5b
1 parent 3cb2ac9
commit 1439e5b
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 8 deletions.
diff --git a/init.php b/init.php
@@ -22,6 +22,7 @@
 require(dirname(__FILE__) . '/lib/Error/RateLimit.php');
 
 // Plumbing
+require(dirname(__FILE__) . '/lib/ApiResponse.php');
 require(dirname(__FILE__) . '/lib/JsonSerializable.php');
 require(dirname(__FILE__) . '/lib/StripeObject.php');
 require(dirname(__FILE__) . '/lib/ApiRequestor.php');

diff --git a/lib/ApiRequestor.php b/lib/ApiRequestor.php
@@ -44,7 +44,7 @@ private static function _encodeObjects($d)
      * @param array|null $params
      * @param array|null $headers
      *
-     * @return array An array whose first element is the response and second
+     * @return array An array whose first element is an API response and second
      *    element is the API key used to make the request.
      */
     public function request($method, $url, $params = null, $headers = null)
@@ -57,7 +57,8 @@ public function request($method, $url, $params = null, $headers = null)
         }
         list($rbody, $rcode, $rheaders, $myApiKey) =
         $this->_requestRaw($method, $url, $params, $headers);
-        $resp = $this->_interpretResponse($rbody, $rcode, $rheaders);
+        $json = $this->_interpretResponse($rbody, $rcode, $rheaders);
+        $resp = new ApiResponse($rbody, $rcode, $rheaders, $json);
         return array($resp, $myApiKey);
     }
 

diff --git a/lib/ApiResource.php b/lib/ApiResource.php
@@ -25,7 +25,8 @@ public function refresh()
             $this->_retrieveOptions,
             $this->_opts->headers
         );
-        $this->refreshFrom($response, $this->_opts);
+        $this->setLastResponse($response);
+        $this->refreshFrom($response->json, $this->_opts);
         return $this;
     }
 
@@ -95,7 +96,9 @@ private static function _validateParams($params = null)
     protected function _request($method, $url, $params = array(), $options = null)
     {
         $opts = $this->_opts->merge($options);
-        return static::_staticRequest($method, $url, $params, $opts);
+        list($resp, $options) = static::_staticRequest($method, $url, $params, $opts);
+        $this->setLastResponse($resp);
+        return array($resp->json, $options);
     }
 
     protected static function _staticRequest($method, $url, $params, $options)
@@ -125,7 +128,9 @@ protected static function _all($params = null, $options = null)
         $url = static::classUrl();
 
         list($response, $opts) = static::_staticRequest('get', $url, $params, $options);
-        return Util\Util::convertToStripeObject($response, $opts);
+        $obj = Util\Util::convertToStripeObject($response->json, $opts);
+        $obj->setLastResponse($response);
+        return $obj;
     }
 
     protected static function _create($params = null, $options = null)
@@ -135,7 +140,9 @@ protected static function _create($params = null, $options = null)
         $url = static::classUrl();
 
         list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
-        return Util\Util::convertToStripeObject($response, $opts);
+        $obj = Util\Util::convertToStripeObject($response->json, $opts);
+        $obj->setLastResponse($response);
+        return $obj;
     }
 
     protected function _save($options = null)

diff --git a/lib/ApiResponse.php b/lib/ApiResponse.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Stripe;
+
+class ApiResponse
+{
+    public $headers;
+    public $body;
+    public $json;
+    public $code;
+
+    /**
+     * @param string $body
+     * @param integer $body
+     * @param array|null $headers
+     * @param array|null $json
+     *
+     * @return obj An APIResponse
+     */
+    public function __construct($body, $code, $headers, $json)
+    {
+        $this->body = $body;
+        $this->code = $code;
+        $this->headers = $headers;
+        $this->json = $json;
+    }
+}
diff --git a/lib/Invoice.php b/lib/Invoice.php
@@ -47,7 +47,9 @@ public static function upcoming($params = null, $opts = null)
     {
         $url = static::classUrl() . '/upcoming';
         list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
-        return Util\Util::convertToStripeObject($response, $opts);
+        $obj = Util\Util::convertToStripeObject($response->json, $opts);
+        $obj->setLastResponse($response);
+        return $obj;
     }
 
     /**

diff --git a/lib/StripeObject.php b/lib/StripeObject.php
@@ -29,11 +29,30 @@ public static function init()
         ));
     }
 
+    /**
+     * @return object The last response from the Stripe API
+     */
+    public function getLastResponse()
+    {
+        return $this->_lastResponse;
+    }
+
+    /**
+     * @param ApiResponse
+     *
+     * @return void Set the last response from the Stripe API
+     */
+    public function setLastResponse($resp)
+    {
+        $this->_lastResponse = $resp;
+    }
+
     protected $_opts;
     protected $_values;
     protected $_unsavedValues;
     protected $_transientValues;
     protected $_retrieveOptions;
+    protected $_lastResponse;
 
     public function __construct($id = null, $opts = null)
     {

diff --git a/tests/ChargeTest.php b/tests/ChargeTest.php
@@ -54,7 +54,7 @@ public function testIdempotentCreate()
         );
 
         $this->assertTrue($c->paid);
-        $this->assertFalse($c->refunded);
+        $this->assertSame(200, $c->getLastResponse()->code);
     }
 
     public function testRetrieve()