Add static update method (stripe#266)

* Add a static `update` method * Add a test for the update method * Rename resource URL function and add docs * Add update method to all necessary resources
kanasite · Jun 27, 2016 · 51d4ece · 51d4ece
1 parent ad16ae7
commit 51d4ece
Show file tree

Hide file tree

Showing 19 changed files with 251 additions and 4 deletions.
diff --git a/lib/Account.php b/lib/Account.php
@@ -39,6 +39,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the account to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Account The updated account.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/ApiResource.php b/lib/ApiResource.php
@@ -64,11 +64,10 @@ public static function classUrl()
     }
 
     /**
-     * @return string The full API URL for this API resource.
+     * @return string The instance endpoint URL for the given class.
      */
-    public function instanceUrl()
+    public static function resourceUrl($id)
     {
-        $id = $this['id'];
         if ($id === null) {
             $class = get_called_class();
             $message = "Could not determine which URL to request: "
@@ -81,6 +80,14 @@ public function instanceUrl()
         return "$base/$extn";
     }
 
+    /**
+     * @return string The full API URL for this API resource.
+     */
+    public function instanceUrl()
+    {
+        return static::resourceUrl($this['id']);
+    }
+
     private static function _validateParams($params = null)
     {
         if ($params && !is_array($params)) {
@@ -151,6 +158,25 @@ protected static function _create($params = null, $options = null)
         return $obj;
     }
 
+    /**
+     * @param string $id The ID of the API resource to update.
+     * @param array|null $params
+     * @param array|string|null $opts
+     *
+     * @return ApiResource the updated API resource
+     */
+    protected static function _update($id, $params = null, $options = null)
+    {
+        self::_validateParams($params);
+        $base = static::baseUrl();
+        $url = static::resourceUrl($id);
+
+        list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
+        $obj = Util\Util::convertToStripeObject($response->json, $opts);
+        $obj->setLastResponse($response);
+        return $obj;
+    }
+
     protected function _save($options = null)
     {
         $params = $this->serializeParameters();

diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php
@@ -26,6 +26,18 @@ public static function retrieve($id, $opts = null)
         return self::_retrieve($id, $opts);
     }
 
+    /**
+     * @param string $id The ID of the application fee to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return ApplicationFee The updated application fee.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|null $params
      * @param array|string|null $opts

diff --git a/lib/Charge.php b/lib/Charge.php
@@ -37,6 +37,18 @@ public static function create($params = null, $options = null)
         return self::_create($params, $options);
     }
 
+    /**
+     * @param string $id The ID of the charge to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Charge The updated charge.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $options
      *

diff --git a/lib/Coupon.php b/lib/Coupon.php
@@ -26,6 +26,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the coupon to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Coupon The updated coupon.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|null $params
      * @param array|string|null $opts

diff --git a/lib/Customer.php b/lib/Customer.php
@@ -37,6 +37,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the customer to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Customer The updated customer.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/Dispute.php b/lib/Dispute.php
@@ -26,6 +26,18 @@ public static function all($params = null, $options = null)
         return self::_all($params, $options);
     }
 
+    /**
+     * @param string $id The ID of the dispute to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Dispute The updated dispute.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $options
      *

diff --git a/lib/Invoice.php b/lib/Invoice.php
@@ -37,6 +37,18 @@ public static function all($params = null, $opts = null)
         return self::_all($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the invoice to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Invoice The updated invoice.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|null $params
      * @param array|string|null $opts

diff --git a/lib/InvoiceItem.php b/lib/InvoiceItem.php
@@ -37,6 +37,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the invoice item to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return InvoiceItem The updated invoice item.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/Order.php b/lib/Order.php
@@ -26,6 +26,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the order to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Order The updated order.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/Plan.php b/lib/Plan.php
@@ -26,6 +26,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the plan to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Plan The updated plan.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|null $params
      * @param array|string|null $opts

diff --git a/lib/Product.php b/lib/Product.php
@@ -26,6 +26,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the product to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Product The updated product.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/Recipient.php b/lib/Recipient.php
@@ -37,6 +37,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the recipient to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Recipient The updated recipient.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/Refund.php b/lib/Refund.php
@@ -16,6 +16,18 @@ public static function retrieve($id, $options = null)
         return self::_retrieve($id, $options);
     }
 
+    /**
+     * @param string $id The ID of the refund to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Refund The updated refund.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|null $params
      * @param array|string|null $options

diff --git a/lib/SKU.php b/lib/SKU.php
@@ -26,6 +26,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the SKU to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return SKU The updated SKU.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|string|null $opts
      *

diff --git a/lib/Subscription.php b/lib/Subscription.php
@@ -37,6 +37,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the subscription to retrieve.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Subscription The updated subscription.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @param array|null $params
      *

diff --git a/lib/Transfer.php b/lib/Transfer.php
@@ -37,6 +37,18 @@ public static function create($params = null, $opts = null)
         return self::_create($params, $opts);
     }
 
+    /**
+     * @param string $id The ID of the transfer to update.
+     * @param array|null $params
+     * @param array|string|null $options
+     *
+     * @return Transfer The updated transfer.
+     */
+    public static function update($id, $params = null, $options = null)
+    {
+        return self::_update($id, $params, $options);
+    }
+
     /**
      * @return TransferReversal The created transfer reversal.
      */

diff --git a/tests/AccountTest.php b/tests/AccountTest.php
@@ -123,7 +123,7 @@ public function testReject()
         $this->assertSame($rejected->id, $account->id);
     }
 
-    public function testUpdateLegalEntity()
+    public function testSaveLegalEntity()
     {
         $response = $this->managedAccountResponse('acct_ABC');
         $this->mockRequest('POST', '/v1/accounts', array('managed' => 'true'), $response);
@@ -143,6 +143,29 @@ public function testUpdateLegalEntity()
         $this->assertSame('Bob', $account->legal_entity->first_name);
     }
 
+    public function testUpdateLegalEntity()
+    {
+        $response = $this->managedAccountResponse('acct_ABC');
+        $this->mockRequest('POST', '/v1/accounts', array('managed' => 'true'), $response);
+
+        $response['legal_entity']['first_name'] = 'Bob';
+        $this->mockRequest(
+            'POST',
+            '/v1/accounts/acct_ABC',
+            array('legal_entity' => array('first_name' => 'Bob')),
+            $response
+        );
+
+        $account = Account::create(array('managed' => true));
+        $account = Account::update($account['id'], array(
+          'legal_entity' => array(
+            'first_name' => 'Bob'
+          )
+        ));
+
+        $this->assertSame('Bob', $account->legal_entity->first_name);
+    }
+
     public function testCreateAdditionalOwners()
     {
         $request = array(