Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use helper method to safeguard against empty path parameters #498

Merged
merged 6 commits into from
Jun 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Tests/Recurly/Base_Test.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,18 @@ public function testCheckIfResponseContainGetHeadersFunction() {
$this->assertTrue(method_exists($adjustment, 'getHeaders'),'Adjustments Class does not have method getHeaders');
$this->assertInternalType('array', $adjustment->getHeaders());
}

public function testPassingEmptyResourceCode() {
$this->expectException(Recurly_Error::class);
$uri = Recurly_Base::_safeUri(
Recurly_Client::PATH_SUBSCRIPTIONS, "",
Recurly_Client::PATH_ADDONS, "marketing_emails",
Recurly_Client::PATH_USAGE, 123456
);
}

public function testUrlEncodingReplacement() {
$uri = Recurly_Base::_safeUri(Recurly_Client::PATH_ACCOUNTS, "/abcdef1234567890");
$this->assertEquals("/accounts/%2Fabcdef1234567890", $uri);
}
}
2 changes: 1 addition & 1 deletion lib/recurly/account.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ protected function uri() {
return Recurly_Account::uriForAccount($this->account_code);
}
protected static function uriForAccount($accountCode) {
return Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode);
return self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/account_acquisition.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public static function deleteForAccount($accountCode, $client = null) {
}

protected static function uriForAccountAcquisition($accountCode) {
return '/accounts/' . rawurlencode($accountCode) . '/acquisition';
return self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, 'acquisition');
}

public function create() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/account_balance.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
class Recurly_AccountBalance extends Recurly_Resource
{
public static function get($accountCode, $client = null) {
return Recurly_Base::_get(Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_BALANCE, $client);
return Recurly_Base::_get(self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_BALANCE), $client);
}

function __construct($href = null, $client = null) {
Expand Down
6 changes: 3 additions & 3 deletions lib/recurly/addon.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public static function get($planCode, $addonCode, $client = null) {
}

public function create() {
$this->_save(Recurly_Client::POST, Recurly_Client::PATH_PLANS . '/' . rawurlencode($this->plan_code) . Recurly_Client::PATH_ADDONS);
$this->_save(Recurly_Client::POST, self::_safeUri(Recurly_Client::PATH_PLANS, $this->plan_code, Recurly_Client::PATH_ADDONS));
}

public function update() {
Expand All @@ -54,9 +54,9 @@ protected function uri() {
else
return Recurly_Addon::uriForAddOn($this->plan_code, $this->add_on_code);
}

protected static function uriForAddOn($planCode, $addonCode) {
return (Recurly_Client::PATH_PLANS . '/' . rawurlencode($planCode) .
Recurly_Client::PATH_ADDONS . '/' . rawurlencode($addonCode));
return self::_safeUri(Recurly_Client::PATH_PLANS, $planCode, Recurly_Client::PATH_ADDONS, $addonCode);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/addon_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ class Recurly_AddonList extends Recurly_Pager
{
public static function get($planCode, $params = null, $client = null)
{
$uri = self::_uriWithParams(Recurly_Client::PATH_PLANS . '/' . rawurlencode($planCode) . Recurly_Client::PATH_ADDONS, $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_PLANS, $planCode, Recurly_Client::PATH_ADDONS), $params);
return new self($uri, $client);
}

Expand Down
8 changes: 2 additions & 6 deletions lib/recurly/adjustment.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
class Recurly_Adjustment extends Recurly_Resource
{
public static function get($adjustment_uuid, $client = null) {
return Recurly_Base::_get(Recurly_Client::PATH_ADJUSTMENTS . '/' . rawurlencode($adjustment_uuid), $client);
return Recurly_Base::_get(self::_safeUri(Recurly_Client::PATH_ADJUSTMENTS, $adjustment_uuid), $client);
}

public function create() {
Expand Down Expand Up @@ -82,11 +82,7 @@ public function toRefundAttributes($quantity = null, $prorate = false) {
}

protected function createUriForAccount() {
if (empty($this->account_code))
throw new Recurly_Error("'account_code' is not specified");

return (Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($this->account_code) .
Recurly_Client::PATH_ADJUSTMENTS);
return self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $this->account_code, Recurly_Client::PATH_ADJUSTMENTS);
}

protected function populateXmlDoc(&$doc, &$node, &$obj, $nested = false) {
Expand Down
5 changes: 4 additions & 1 deletion lib/recurly/adjustment_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
class Recurly_AdjustmentList extends Recurly_Pager
{
public static function get($accountCode, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_ADJUSTMENTS, $params);
$uri = self::_uriWithParams(
self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_ADJUSTMENTS),
$params
);
return new self($uri, $client);
}

Expand Down
23 changes: 22 additions & 1 deletion lib/recurly/base.php
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,29 @@ protected static function _delete($uri, $client = null)
return null;
}

/**
* Returns URI for resource, throwing error if resource code is an empty string
* @param string Resource codes and paths
* @return string URI
* @throws Recurly_Error
*/
public static function _safeUri(...$params) {
$uri = '';
foreach($params as $param) {
// throws error if param is an empty string
if (empty(trim($param))) {
throw new Recurly_Error("Resource code cannot be an empty value");
}
$path = '/' . rawurlencode($param);
$uri .= $path;
}
return $uri;
}

protected static function _uriWithParams($uri, $params = null) {
if ($uri[0] !== '/' && strpos($uri, "https") === false){
bhelx marked this conversation as resolved.
Show resolved Hide resolved
$uri = '/' . $uri;
}
if (is_null($params) || !is_array($params)) {
return $uri;
}
Expand All @@ -121,7 +143,6 @@ protected static function _uriWithParams($uri, $params = null) {
foreach ($params as $k => $v) {
$vals[] = $k . '=' . urlencode($v);
}

return $uri . '?' . implode('&', $vals);
}

Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/billing_info.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ protected function uri() {
throw new Recurly_Error("'account_code' not specified.");
}
protected static function uriForBillingInfo($accountCode) {
return Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_BILLING_INFO;
return self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_BILLING_INFO);
}

protected function getNodeName() {
Expand Down
42 changes: 21 additions & 21 deletions lib/recurly/client.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,27 @@ class Recurly_Client
const DELETE = 'DELETE';
const HEAD = 'HEAD';

const PATH_ACCOUNTS = '/accounts';
const PATH_ADDONS = '/add_ons';
const PATH_ADJUSTMENTS = '/adjustments';
const PATH_BALANCE = '/balance';
const PATH_BILLING_INFO = '/billing_info';
const PATH_COUPON = '/coupon';
const PATH_COUPON_REDEMPTION = '/redemption';
const PATH_COUPON_REDEMPTIONS = '/redemptions';
const PATH_COUPONS = '/coupons';
const PATH_CREDIT_PAYMENTS = '/credit_payments';
const PATH_GIFT_CARDS = '/gift_cards';
const PATH_UNIQUE_COUPONS = '/unique_coupon_codes';
const PATH_INVOICES = '/invoices';
const PATH_ITEMS = '/items';
const PATH_NOTES = '/notes';
const PATH_PLANS = '/plans';
const PATH_SHIPPING_METHOD = '/shipping_methods';
const PATH_SUBSCRIPTIONS = '/subscriptions';
const PATH_TRANSACTIONS = '/transactions';
const PATH_MEASURED_UNITS = '/measured_units';
const PATH_USAGE = '/usage';
const PATH_ACCOUNTS = 'accounts';
const PATH_ADDONS = 'add_ons';
const PATH_ADJUSTMENTS = 'adjustments';
const PATH_BALANCE = 'balance';
const PATH_BILLING_INFO = 'billing_info';
const PATH_COUPON = 'coupon';
const PATH_COUPON_REDEMPTION = 'redemption';
const PATH_COUPON_REDEMPTIONS = 'redemptions';
const PATH_COUPONS = 'coupons';
const PATH_CREDIT_PAYMENTS = 'credit_payments';
const PATH_GIFT_CARDS = 'gift_cards';
const PATH_UNIQUE_COUPONS = 'unique_coupon_codes';
const PATH_INVOICES = 'invoices';
const PATH_ITEMS = 'items';
const PATH_NOTES = 'notes';
const PATH_PLANS = 'plans';
const PATH_SHIPPING_METHOD = 'shipping_methods';
const PATH_SUBSCRIPTIONS = 'subscriptions';
const PATH_TRANSACTIONS = 'transactions';
const PATH_MEASURED_UNITS = 'measured_units';
const PATH_USAGE = 'usage';

/**
* Create a new Recurly Client
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/coupon.php
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ protected function uri() {
return Recurly_Coupon::uriForCoupon($this->coupon_code);
}
protected static function uriForCoupon($couponCode) {
return Recurly_Client::PATH_COUPONS . '/' . rawurlencode($couponCode);
return self::_safeUri(Recurly_Client::PATH_COUPONS, $couponCode);
}

protected function getNodeName() {
Expand Down
5 changes: 4 additions & 1 deletion lib/recurly/credit_payment_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ public static function get($params = null, $client = null) {
}

public static function getForAccount($accountCode, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_CREDIT_PAYMENTS, $params);
$uri = self::_uriWithParams(
self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_CREDIT_PAYMENTS),
$params
);
return new self($uri, $client);
}

Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/export_file.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class Recurly_ExportFile extends Recurly_Resource
* @throws Recurly_Error
*/
public static function get($date, $name, $client = null) {
return self::_get('/export_dates/' . rawurlencode($date) . '/export_files/' . rawurlencode($name), $client);
return self::_get(self::_safeUri("export_dates", $date, "export_files", $name), $client);
}

public function getDownloadUrl() {
Expand Down
4 changes: 3 additions & 1 deletion lib/recurly/export_file_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ class Recurly_ExportFileList extends Recurly_Pager
* @return Recurly_ExportFileList
*/
public static function get($date, $params = null, $client = null) {
return new self(self::_uriWithParams('/export_dates/' . rawurlencode($date) . '/export_files', $params), $client);
return new self(self::_uriWithParams(
self::_safeUri('export_dates', $date, 'export_files'), $params
), $client);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/gift_card.php
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ protected function uri() {
}

protected static function uriForGiftCard($giftCardIdentifier) {
return Recurly_Client::PATH_GIFT_CARDS. '/' . rawurlencode($giftCardIdentifier);
return self::_safeUri(Recurly_Client::PATH_GIFT_CARDS, $giftCardIdentifier);
}

protected function getNodeName() {
Expand Down
6 changes: 3 additions & 3 deletions lib/recurly/invoice.php
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public static function getInvoicePdf($invoiceNumber, $locale = null, $client = n
* @throws Recurly_Error
*/
public static function invoicePendingCharges($accountCode, $attributes = array(), $client = null) {
$uri = Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_INVOICES;
$uri = self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_INVOICES);
$invoice = new self();
return Recurly_InvoiceCollection::_post($uri, $invoice->setValues($attributes)->xml(), $client);
}
Expand All @@ -111,7 +111,7 @@ public static function invoicePendingCharges($accountCode, $attributes = array()
* @throws Recurly_Error
*/
public static function previewPendingCharges($accountCode, $attributes = array(), $client = null) {
$uri = Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_INVOICES . '/preview';
$uri = self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_INVOICES, 'preview');
$invoice = new self();
return Recurly_InvoiceCollection::_post($uri, $invoice->setValues($attributes)->xml(), $client);
}
Expand Down Expand Up @@ -254,6 +254,6 @@ protected function uri() {
throw new Recurly_Error("Invoice number not specified");
}
protected static function uriForInvoice($invoiceNumber) {
return Recurly_Client::PATH_INVOICES . '/' . rawurlencode($invoiceNumber);
return self::_safeUri(Recurly_Client::PATH_INVOICES, $invoiceNumber);
}
}
2 changes: 1 addition & 1 deletion lib/recurly/invoice_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public static function get($params = null, $client = null) {
}

public static function getForAccount($accountCode, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_INVOICES, $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_INVOICES), $params);
return new self($uri, $client);
}

Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/item.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ protected function uri() {
}

protected static function uriForItem($itemCode) {
return Recurly_Client::PATH_ITEMS . '/' . rawurlencode($itemCode);
return self::_safeUri(Recurly_Client::PATH_ITEMS, $itemCode);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/measured_unit.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ protected function uri() {
return Recurly_MeasuredUnit::uriForMeasuredUnit($this->id);
}
protected static function uriForMeasuredUnit($id) {
return Recurly_Client::PATH_MEASURED_UNITS . '/' . rawurlencode($id);
return self::_safeUri(Recurly_Client::PATH_MEASURED_UNITS, $id);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/note_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
class Recurly_NoteList extends Recurly_Pager
{
public static function get($accountCode, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_NOTES, $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_NOTES), $params);
return new self($uri, $client);
}

Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/plan.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ protected function uri() {
return Recurly_Plan::uriForPlan($this->plan_code);
}
protected static function uriForPlan($planCode) {
return Recurly_Client::PATH_PLANS . '/' . rawurlencode($planCode);
return self::_safeUri(Recurly_Client::PATH_PLANS, $planCode);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/redemption.php
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ protected function uri($accountCode = null) {
}

protected static function uriForAccount($accountCode) {
return Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_COUPON_REDEMPTION;
return self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_COUPON_REDEMPTION);
}

protected function getNodeName() {
Expand Down
6 changes: 3 additions & 3 deletions lib/recurly/redemption_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
class Recurly_CouponRedemptionList extends Recurly_Pager
{
public static function getForAccount($accountCode, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_ACCOUNTS . '/' . rawurlencode($accountCode) . Recurly_Client::PATH_COUPON_REDEMPTIONS, $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, Recurly_Client::PATH_COUPON_REDEMPTIONS), $params);
return new self($uri, $client);
}

public static function getForInvoice($invoiceNumber, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_INVOICES . '/' . rawurlencode($invoiceNumber) . Recurly_Client::PATH_COUPON_REDEMPTIONS, $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_INVOICES, $invoiceNumber, Recurly_Client::PATH_COUPON_REDEMPTIONS), $params);
return new self($uri, $client);
}

public static function getForSubscription($subscriptionUuid, $params = null, $client = null) {
$uri = self::_uriWithParams(Recurly_Client::PATH_SUBSCRIPTIONS . '/' . rawurlencode($subscriptionUuid) . Recurly_Client::PATH_COUPON_REDEMPTIONS, $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_SUBSCRIPTIONS, $subscriptionUuid, Recurly_Client::PATH_COUPON_REDEMPTIONS), $params);
return new self($uri, $client);
}

Expand Down
3 changes: 3 additions & 0 deletions lib/recurly/resource.php
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ public function setValues($values) {
*/
protected function _save($method, $uri, $data = null)
{
if ($uri[0] !== '/' and strpos($uri, "https") === false){
$uri = '/' . $uri;
}
$this->_errors = array(); // reset errors

if (is_null($data)) {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/shipping_address_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
class Recurly_ShippingAddressList extends Recurly_Pager
{
public static function get($accountCode, $params = null, $client = null) {
$uri = self::_uriWithParams('/accounts/' . rawurlencode($accountCode) . '/shipping_addresses', $params);
$uri = self::_uriWithParams(self::_safeUri(Recurly_Client::PATH_ACCOUNTS, $accountCode, 'shipping_addresses'), $params);
return new self($uri, $client);
}

Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/shipping_method.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ protected function uri() {
}

protected static function uriForShippingMethod($code) {
return Recurly_Client::PATH_SHIPPING_METHOD . '/' . rawurlencode($code);
return self::_safeUri(Recurly_Client::PATH_SHIPPING_METHOD, $code);
}

protected function getNodeName() {
Expand Down
2 changes: 1 addition & 1 deletion lib/recurly/subscription.php
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ protected function uri() {
throw new Recurly_Error("Subscription UUID not specified");
}
protected static function uriForSubscription($uuid) {
return Recurly_Client::PATH_SUBSCRIPTIONS . '/' . rawurlencode($uuid);
return self::_safeUri(Recurly_Client::PATH_SUBSCRIPTIONS, $uuid);
}

protected function populateXmlDoc(&$doc, &$node, &$obj, $nested = false) {
Expand Down
Loading