Support bulk coupons and generate codes

Author: bhelx

Tests/Recurly/Coupon_Test.php

@@ -145,4 +145,15 @@ public function testCreateUpdateXML() {
       $coupon->createUpdateXML()
     );
   }
+
+  public function testGenerate() {
+    $this->client->addResponse('POST', '/coupons/fifteen-off/generate', 'unique_coupons/generate-201.xml');
+    $this->client->addResponse('GET', 'https://api.recurly.com/v2/coupons/fifteen-off/unique_coupon_codes?cursor=1234566890&per_page=20', 'unique_coupons/index-200.xml');
+
+    $coupon = new Recurly_Coupon(null, $this->client);
+    $coupon->coupon_code = 'fifteen-off';
+
+    $coupons = $coupon->generate(10);
+    $this->assertEquals(count($coupons), 10);
+  }
 }

Tests/fixtures/unique_coupons/generate-201.xml

@@ -0,0 +1,5 @@
+HTTP/1.1 200 OK
+Content-Type: application/xml; charset=utf-8
+X-Records: 2
+Link: <https://api.recurly.com/v2/coupons/fifteen-off/unique_coupon_codes?cursor=1234566890&per_page=20>; rel="start", <https://api.recurly.com/v2/coupons/fifteen-off/unique_coupon_codes?cursor=1234566890&per_page=20>; rel="next"
+Location: https://api.recurly.com/v2/coupons/fifteen-off/unique_coupon_codes?cursor=1234566890&per_page=20

Tests/fixtures/unique_coupons/index-200.xml

@@ -0,0 +1,16 @@
+HTTP/1.1 200 OK
+Content-Type: application/xml; charset=utf-8
+X-Records: 2
+Link: <https://api.recurly.com/v2/coupons/fifteen-off/unique_coupon_codes?cursor=1234566890&per_page=20>; rel="start", <https://api.recurly.com/v2/coupons/fifteen-off/unique_coupon_codes?cursor=1234566890&per_page=20>; rel="next"
+
+<?xml version="1.0" encoding="UTF-8"?>
+<unique_coupon_codes>
+  <coupon href="https://api.recurly.com/v2/coupons/fifteen-off-aaaaaa">
+    <coupon_code>fifteen-off-aaaaaa</coupon_code>
+    <a name="redeem" href="https://api.recurly.com/v2/coupons//fifteen-off-aaaaaa/redeem" method="post"/>
+  </coupon>
+  <coupon href="https://api.recurly.com/v2/coupons/fifteen-off-bbbbbb">
+    <coupon_code>fifteen-off-bbbbbb</coupon_code>
+    <a name="redeem" href="https://api.recurly.com/v2/coupons//fifteen-off-bbbbbb/redeem" method="post"/>
+  </coupon>
+</unique_coupon_codes>

lib/recurly.php

@@ -23,6 +23,7 @@
 require_once(dirname(__FILE__) . '/recurly/billing_info.php');
 require_once(dirname(__FILE__) . '/recurly/coupon.php');
 require_once(dirname(__FILE__) . '/recurly/coupon_list.php');
+require_once(dirname(__FILE__) . '/recurly/unique_coupon_code_list.php');
 require_once(dirname(__FILE__) . '/recurly/invoice.php');
 require_once(dirname(__FILE__) . '/recurly/invoice_list.php');
 require_once(dirname(__FILE__) . '/recurly/note.php');

lib/recurly/base.php

@@ -173,6 +173,7 @@ public function getLinks() {
     'adjustment' => 'Recurly_Adjustment',
     'adjustments' => 'Recurly_AdjustmentList',
     'coupon' => 'Recurly_Coupon',
+    'unique_coupon_codes' => 'Recurly_UniqueCouponCodeList',
     'currency' => 'Recurly_Currency',
     'details' => 'array',
     'discount_in_cents' => 'Recurly_CurrencyList',

lib/recurly/client.php

@@ -61,6 +61,7 @@ class Recurly_Client
   const PATH_COUPON_REDEMPTION = '/redemption';
   const PATH_COUPON_REDEMPTIONS = '/redemptions';
   const PATH_COUPONS = '/coupons';
+  const PATH_UNIQUE_COUPONS = '/unique_coupon_codes';
   const PATH_INVOICES = '/invoices';
   const PATH_NOTES = '/notes';
   const PATH_PLANS = '/plans';

lib/recurly/coupon.php

@@ -6,8 +6,8 @@ class Recurly_Coupon extends Recurly_Resource
   protected static $_updatableAttributes;
   protected $_redeemUrl;
 
-  function __construct() {
-    parent::__construct();
+  function __construct($href = null, $client = null) {
+    parent::__construct($href, $client);
     $this->discount_in_cents = new Recurly_CurrencyList('discount_in_cents');
   }
 
@@ -18,7 +18,7 @@ public static function init()
       'duration', 'temporal_unit', 'temporal_amount',
       'max_redemptions','applies_to_all_plans','discount_percent','discount_in_cents','plan_codes',
       'hosted_description','invoice_description', 'applies_to_non_plan_charges', 'redemption_resource',
-      'max_redemptions_per_account'
+      'max_redemptions_per_account', 'coupon_type', 'unique_code_template', 'unique_coupon_codes'
     );
     Recurly_Coupon::$_updatableAttributes = array('name', 'max_redemptions',
       'max_redemptions_per_account', 'hosted_description', 'invoice_description', 'redeem_by_date'
@@ -86,6 +86,24 @@ public function createUpdateXML() {
     return $this->renderXML($doc);
   }
 
+  public function generate($number) {
+    $doc = $this->createDocument();
+
+    $root = $doc->appendChild($doc->createElement($this->getNodeName()));
+    $root->appendChild($doc->createElement('number_of_unique_codes', $number));
+
+    $response = $this->_client->request(Recurly_Client::POST, $this->uri() . '/generate', $this->renderXML($doc));
+    $response->assertValidResponse();
+
+    $coupons = array();
+    foreach (new Recurly_UniqueCouponCodeList($response->headers['Location'], $this->_client) as $coupon) {
+      $coupons[] = $coupon;
+      if (count($coupons) == $number) break;
+    }
+
+    return $coupons;
+  }
+
   protected function uri() {
     if (!empty($this->_href))
       return $this->getHref();

lib/recurly/unique_coupon_code_list.php

@@ -0,0 +1,14 @@
+<?php
+
+class Recurly_UniqueCouponCodeList extends Recurly_Pager
+{
+
+  public static function get($params = null, $client = null) {
+    $uri = self::_uriWithParams(Recurly_Client::PATH_UNIQUE_COUPONS, $params);
+    return new self($uri, $client);
+  }
+
+  protected function getNodeName() {
+    return 'unique_coupon_codes';
+  }
+}