Shipping Address Support

CHANGELOG.md

@@ -7,6 +7,7 @@
 * Allow credit adjustments (`Recurly_Adjustment`) to specify an `origin` of `external_gift_card` [#263](https://github.com/recurly/recurly-client-php/pull/263)
 * Added `Recurly_AccountAcquisition` [#259](https://github.com/recurly/recurly-client-php/pull/259)
 * Added support for automated exports [#260](https://github.com/recurly/recurly-client-php/pull/260)
+* Added support for shipping addresses [#269](https://github.com/recurly/recurly-client-php/pull/269)
 
 ## Version 2.6.0 (August 9th, 2016)
 

Tests/Recurly/Account_Test.php

@@ -91,8 +91,37 @@ public function testXml() {
     $account->tax_exempt = false;
     $account->entity_use_code = 'I';
 
+    // work shipping address
+    $shad1 = new Recurly_ShippingAddress();
+    $shad1->nickname = "Work";
+    $shad1->first_name = "Verena";
+    $shad1->last_name = "Example";
+    $shad1->company = "Recurly Inc.";
+    $shad1->phone = "555-555-5555";
+    $shad1->email = "verena@example.com";
+    $shad1->address1 = "123 Main St.";
+    $shad1->city = "San Francisco";
+    $shad1->state = "CA";
+    $shad1->zip = "94110";
+    $shad1->country = "US";
+
+    // home shipping address
+    $shad2 = new Recurly_ShippingAddress();
+    $shad2->nickname = "Home";
+    $shad2->first_name = "Verena";
+    $shad2->last_name = "Example";
+    $shad2->phone = "555-555-5555";
+    $shad2->email = "verena@example.com";
+    $shad2->address1 = "123 Dolores St.";
+    $shad2->city = "San Francisco";
+    $shad2->state = "CA";
+    $shad2->zip = "94110";
+    $shad2->country = "US";
+
+    $account->shipping_addresses = array($shad1, $shad2);
+
     $this->assertEquals(
-      "<?xml version=\"1.0\"?>\n<account><account_code>act123</account_code><first_name>Verena</first_name><address><address1>123 Main St.</address1></address><tax_exempt>false</tax_exempt><entity_use_code>I</entity_use_code></account>\n",
+      "<?xml version=\"1.0\"?>\n<account><account_code>act123</account_code><first_name>Verena</first_name><address><address1>123 Main St.</address1></address><tax_exempt>false</tax_exempt><entity_use_code>I</entity_use_code><shipping_addresses><shipping_address><address1>123 Main St.</address1><city>San Francisco</city><state>CA</state><zip>94110</zip><country>US</country><phone>555-555-5555</phone><email>verena@example.com</email><nickname>Work</nickname><first_name>Verena</first_name><last_name>Example</last_name><company>Recurly Inc.</company></shipping_address><shipping_address><address1>123 Dolores St.</address1><city>San Francisco</city><state>CA</state><zip>94110</zip><country>US</country><phone>555-555-5555</phone><email>verena@example.com</email><nickname>Home</nickname><first_name>Verena</first_name><last_name>Example</last_name></shipping_address></shipping_addresses></account>\n",
       $account->xml()
     );
   }

Tests/Recurly/Subscription_Test.php

@@ -78,11 +78,37 @@ public function testCreateSubscriptionXml() {
     $billing_info->year = 2015;
     $billing_info->ip_address = '192.168.0.1';
 
+    $shad = new Recurly_ShippingAddress();
+    $shad->nickname = "Work";
+    $shad->first_name = "Verena";
+    $shad->last_name = "Example";
+    $shad->company = "Recurly Inc.";
+    $shad->phone = "555-555-5555";
+    $shad->email = "verena@example.com";
+    $shad->address1 = "123 Main St.";
+    $shad->city = "San Francisco";
+    $shad->state = "CA";
+    $shad->zip = "94110";
+    $shad->country = "US";
+
+    $subscription->shipping_address = $shad;
     $subscription->account = $account;
     $account->billing_info = $billing_info;
 
     $this->assertEquals(
-      "<?xml version=\"1.0\"?>\n<subscription><account><account_code>account_code</account_code><username>username</username><first_name>Verena</first_name><last_name>Example</last_name><email>verena@example.com</email><accept_language>en-US</accept_language><billing_info><first_name>Verena</first_name><last_name>Example</last_name><ip_address>192.168.0.1</ip_address><number>4111-1111-1111-1111</number><month>11</month><year>2015</year><verification_value>123</verification_value></billing_info><address></address></account><plan_code>gold</plan_code><quantity>1</quantity><currency>USD</currency><subscription_add_ons></subscription_add_ons><bulk>true</bulk><terms_and_conditions>Some Terms and Conditions</terms_and_conditions><customer_notes>Some Customer Notes</customer_notes></subscription>\n",
+      "<?xml version=\"1.0\"?>\n<subscription><account><account_code>account_code</account_code><username>username</username><first_name>Verena</first_name><last_name>Example</last_name><email>verena@example.com</email><accept_language>en-US</accept_language><billing_info><first_name>Verena</first_name><last_name>Example</last_name><ip_address>192.168.0.1</ip_address><number>4111-1111-1111-1111</number><month>11</month><year>2015</year><verification_value>123</verification_value></billing_info><address></address></account><plan_code>gold</plan_code><quantity>1</quantity><currency>USD</currency><subscription_add_ons></subscription_add_ons><bulk>true</bulk><terms_and_conditions>Some Terms and Conditions</terms_and_conditions><customer_notes>Some Customer Notes</customer_notes><shipping_address><address1>123 Main St.</address1><city>San Francisco</city><state>CA</state><zip>94110</zip><country>US</country><phone>555-555-5555</phone><email>verena@example.com</email><nickname>Work</nickname><first_name>Verena</first_name><last_name>Example</last_name><company>Recurly Inc.</company></shipping_address></subscription>\n",
+      $subscription->xml()
+    );
+  }
+
+  public function testUpdateShippingAddressXml() {
+    $this->client->addResponse('GET', '/subscriptions/012345678901234567890123456789ab', 'subscriptions/show-200.xml');
+    $subscription = Recurly_Subscription::get('012345678901234567890123456789ab', $this->client);
+
+    $subscription->shipping_address_id = 1234567890;
+
+    $this->assertEquals(
+      "<?xml version=\"1.0\"?>\n<subscription><subscription_add_ons><subscription_add_on><add_on_code>marketing_emails</add_on_code><unit_amount_in_cents>5</unit_amount_in_cents><quantity>1</quantity></subscription_add_on></subscription_add_ons><shipping_address_id>1234567890</shipping_address_id></subscription>\n",
       $subscription->xml()
     );
   }

Tests/fixtures/accounts/create-201.xml

@@ -7,6 +7,7 @@ Location: https://api.recurly.com/v2/accounts/abcdef1234567890.xml
   <adjustments href="https://api.recurly.com/v2/accounts/abcdef1234567890/adjustments"/>
   <billing_info href="https://api.recurly.com/v2/accounts/abcdef1234567890/billing_info"/>
   <invoices href="https://api.recurly.com/v2/accounts/abcdef1234567890/invoices"/>
+  <shipping_addresses href="https://api.recurly.com/v2/accounts/abcdef1234567890/shipping_addresses"/>
   <subscriptions href="https://api.recurly.com/v2/accounts/abcdef1234567890/subscriptions"/>
   <transactions href="https://api.recurly.com/v2/accounts/abcdef1234567890/transactions"/>
   <account_code>abcdef1234567890</account_code>

lib/recurly.php

@@ -37,6 +37,8 @@
 require_once(dirname(__FILE__) . '/recurly/plan_list.php');
 require_once(dirname(__FILE__) . '/recurly/redemption.php');
 require_once(dirname(__FILE__) . '/recurly/redemption_list.php');
+require_once(dirname(__FILE__) . '/recurly/shipping_address.php');
+require_once(dirname(__FILE__) . '/recurly/shipping_address_list.php');
 require_once(dirname(__FILE__) . '/recurly/subscription.php');
 require_once(dirname(__FILE__) . '/recurly/subscription_list.php');
 require_once(dirname(__FILE__) . '/recurly/subscription_addon.php');

lib/recurly/account.php

@@ -62,7 +62,7 @@ protected function getWriteableAttributes() {
     return array(
       'account_code', 'username', 'first_name', 'last_name', 'vat_number',
       'email', 'company_name', 'accept_language', 'billing_info', 'address',
-      'tax_exempt', 'entity_use_code', 'cc_emails'
+      'tax_exempt', 'entity_use_code', 'cc_emails', 'shipping_addresses'
     );
   }
   protected function getRequiredAttributes() {

lib/recurly/base.php

@@ -206,6 +206,8 @@ public function getLinks() {
     'redemption' => 'Recurly_CouponRedemption',
     'redemptions' => 'Recurly_CouponRedemptionList',
     'setup_fee_in_cents' => 'Recurly_CurrencyList',
+    'shipping_address' => 'Recurly_ShippingAddress',
+    'shipping_addresses' => 'Recurly_ShippingAddressList',
     'subscription' => 'Recurly_Subscription',
     'subscriptions' => 'Recurly_SubscriptionList',
     'subscription_add_ons' => 'array',

lib/recurly/resource.php

@@ -93,7 +93,6 @@ protected function _save($method, $uri, $data = null)
     $response->assertSuccessResponse($this);
   }
 
-
   public function xml()
   {
     $doc = $this->createDocument();

lib/recurly/shipping_address.php

@@ -0,0 +1,19 @@
+<?php
+
+class Recurly_ShippingAddress extends Recurly_Resource
+{
+  protected function getNodeName() {
+    return 'shipping_address';
+  }
+  protected function getWriteableAttributes() {
+    return array(
+      'address1', 'address2', 'city', 'state',
+      'zip', 'country', 'phone', 'email', 'nickname',
+      'first_name', 'last_name', 'company'
+    );
+  }
+  protected function populateXmlDoc(&$doc, &$node, &$obj, $nested = false) {
+    $shippingAddressNode= $node->appendChild($doc->createElement($this->getNodeName()));
+    parent::populateXmlDoc($doc, $shippingAddressNode, $obj);
+  }
+}

lib/recurly/shipping_address_list.php

@@ -0,0 +1,13 @@
+<?php
+
+class Recurly_ShippingAddressList extends Recurly_Pager
+{
+  public static function get($accountCode, $params = null, $client = null) {
+    $uri = self::_uriWithParams('/accounts/' . rawurlencode($accountCode) . '/shipping_addresses', $params);
+    return new self($uri, $client);
+  }
+
+  protected function getNodeName() {
+    return 'shipping_addresses';
+  }
+}

lib/recurly/subscription.php

@@ -132,7 +132,8 @@ protected function getWriteableAttributes() {
       'timeframe', 'subscription_add_ons', 'net_terms', 'po_number',
       'collection_method', 'cost_in_cents', 'remaining_billing_cycles', 'bulk',
       'terms_and_conditions', 'customer_notes', 'vat_reverse_charge_notes',
-      'bank_account_authorized_at', 'revenue_schedule_type','gift_card'
+      'bank_account_authorized_at', 'revenue_schedule_type', 'gift_card',
+      'shipping_address', 'shipping_address_id'
     );
   }
 }