added DNS "clone" function

Author: gecampbell

lib/OpenCloud/DNS/AsyncResponse.php

@@ -19,17 +19,18 @@
  * The AsyncResponse class encapsulates the data returned by a Cloud DNS
  * asynchronous response.
  */
-class AsyncResponse extends PersistentObject 
+class AsyncResponse extends PersistentObject
 {
 
     public $jobId;
-    public $callbackUrl;    
+    public $callbackUrl;
     public $status;
     public $requestUrl;
     public $verb;
     public $request;
     public $response;
     public $error;
+    public $domains;
 
     protected static $json_name = false;
 
@@ -40,7 +41,7 @@ class AsyncResponse extends PersistentObject
      * @param \OpenCloud\Service $service the calling service
      * @param string $json the json response from the initial request
      */
-    public function __construct(AbstractService $service, $json = null) 
+    public function __construct(AbstractService $service, $json = null)
     {
         if (!$json) {
             return;
@@ -61,7 +62,7 @@ public function __construct(AbstractService $service, $json = null)
      *
      * @return string
      */
-    public function Url($subresource = null, $qstr = array()) 
+    public function Url($subresource = null, $qstr = array())
     {
         return $this->callbackUrl . '?showDetails=True';
     }
@@ -71,32 +72,32 @@ public function Url($subresource = null, $qstr = array())
      *
      * @return string
      */
-    public function Name() 
+    public function Name()
     {
         return $this->jobId;
     }
 
     /**
      * overrides for methods
      */
-    public function Create($parm = array()) 
-    { 
-        return $this->NoCreate(); 
+    public function Create($parm = array())
+    {
+        return $this->NoCreate();
     }
 
-    public function Update($parm = array()) 
-    { 
-        return $this->NoUpdate(); 
+    public function Update($parm = array())
+    {
+        return $this->NoUpdate();
     }
 
-    public function Delete() 
-    { 
-        return $this->NoDelete(); 
+    public function Delete()
+    {
+        return $this->NoDelete();
     }
 
-    public function PrimaryKeyField() 
-    { 
-        return 'jobId'; 
+    public function PrimaryKeyField()
+    {
+        return 'jobId';
     }
 
-}
+}

lib/OpenCloud/DNS/Domain.php

@@ -21,7 +21,7 @@
  * @api
  * @author Glen Campbell <[email protected]>
  */
-class Domain extends Object 
+class Domain extends Object
 {
 
     public $id;
@@ -38,9 +38,9 @@ class Domain extends Object
     protected static $url_resource = 'domains';
 
     protected $_create_keys = array(
-        'name', 
-        'emailAddress', 
-        'ttl', 
+        'name',
+        'emailAddress',
+        'ttl',
         'comment'
     );
 
@@ -61,7 +61,7 @@ class Domain extends Object
      *
      * @return Record
      */
-    public function Record($info = null) 
+    public function Record($info = null)
     {
         return new Record($this, $info);
     }
@@ -72,7 +72,7 @@ public function Record($info = null)
      * @param array $filter query-string parameters
      * @return \OpenCloud\Collection
      */
-    public function RecordList($filter = array()) 
+    public function RecordList($filter = array())
     {
         return $this->Parent()->Collection('\OpenCloud\DNS\Record', null, $this, $filter);
     }
@@ -81,7 +81,7 @@ public function RecordList($filter = array())
      * returns a Subdomain object (child of current domain)
      *
      */
-    public function Subdomain($info = array()) 
+    public function Subdomain($info = array())
     {
         return new Subdomain($this, $info);
     }
@@ -95,7 +95,7 @@ public function Subdomain($info = array())
      * @param array $filter key/value pairs for query string parameters
      * return \OpenCloud\Collection
      */
-    public function SubdomainList($filter = array()) 
+    public function SubdomainList($filter = array())
     {
         return $this->Parent()->Collection('\OpenCloud\DNS\Subdomain', null, $this);
     }
@@ -107,7 +107,7 @@ public function SubdomainList($filter = array())
      * @param Record $rec the record to add
      * @return integer the number of records
      */
-    public function AddRecord(Record $record) 
+    public function AddRecord(Record $record)
     {
         $this->records[] = $record;
         return count($this->records);
@@ -120,7 +120,7 @@ public function AddRecord(Record $record)
      * @param Subdomain $subd the subdomain to add
      * @return integer the number of subdomains
      */
-    public function AddSubdomain(Subdomain $subdomain) 
+    public function AddSubdomain(Subdomain $subdomain)
     {
         $this->subdomains[] = $subdomain;
         return count($this->subdomains);
@@ -132,7 +132,7 @@ public function AddSubdomain(Subdomain $subdomain)
      * @param string $since the date or time
      * @return DNS\Changes
      */
-    public function Changes($since = null) 
+    public function Changes($since = null)
     {
         if (isset($since)) {
             $url = $this->Url('changes', array('since' => $since));
@@ -149,19 +149,52 @@ public function Changes($since = null)
      *
      * @return AsyncResponse
      */
-    public function Export() 
+    public function Export()
     {
         $url = $this->Url('export');
         return $this->Service()->AsyncRequest($url);
     }
 
+    /**
+     * clones the domain to the specified target domain
+     *
+     * @param string $newdomain the new domain to create from this domain
+     * @param boolean $sub to clone subdomains as well
+     * @param boolean $comments Replace occurrences of the reference domain
+     *  name with the new domain name in comments
+     * @param boolean $email Replace occurrences of the reference domain
+     *  name with the new domain name in email addresses on the cloned
+     *  (new) domain.
+     * @param boolean $records Replace occurrences of the reference domain
+     *  name with the new domain name in data fields (of records) on the
+     *  cloned (new) domain. Does not affect NS records.
+     * @return AsyncResponse
+     */
+    public function CloneDomain(
+            $newdomain,
+            $sub=TRUE,
+            $comments=TRUE,
+            $email=TRUE,
+            $records=TRUE)
+    {
+        $param = array(
+            'cloneName' => $newdomain,
+            'cloneSubdomains' => $sub,
+            'modifyComment' => $comments,
+            'modifyEmailAddress' => $email,
+            'modifyRecordData' => $records
+        );
+        $url = $this->Url('clone', $param);
+        return $this->Service()->AsyncRequest($url);
+    }
+
     /**
      * handles creation of multiple records at Create()
      *
      * @api
      * @return \stdClass
      */
-    protected function CreateJson() 
+    protected function CreateJson()
     {
         $object = parent::CreateJson();
 
@@ -200,4 +233,4 @@ protected function CreateJson()
         return $object;
     }
 
-}
+}

tests/OpenCloud/Tests/DomainTest.php

@@ -110,4 +110,11 @@ public function testExport() {
 			'OpenCloud\DNS\AsyncResponse',
 			get_class($this->domain->Export()));
 	}
+	public function testCloneDomain() {
+	    $asr = $this->domain->CloneDomain('newdomain.io');
+	    //print_r($asr);
+	    $this->assertEquals(
+	        'OpenCloud\DNS\AsyncResponse',
+	        get_class($asr));
+	}
 }