Adding helper methods to generate JSON Patch representation for resource.

Author: ycombinator

composer.json

@@ -20,10 +20,17 @@
             "OpenCloud": ["lib/", "tests/"]
         }
     },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/ycombinator/json-patch-php"
+        }
+    ],
     "require": {
         "php" : ">=5.3.3",
         "guzzle/http" : "~3.8",
-        "psr/log": "~1.0"
+        "psr/log": "~1.0",
+        "mikemccabe/json-patch-php": "dev-master"
     },
     "require-dev" : {
         "phpunit/phpunit": "4.3.*",

lib/OpenCloud/Common/Resource/PersistentResource.php

@@ -25,6 +25,7 @@
 use OpenCloud\Common\Exceptions\NameError;
 use OpenCloud\Common\Exceptions\UnsupportedExtensionError;
 use OpenCloud\Common\Exceptions\UpdateError;
+use mikemccabe\JsonPatch\JsonPatch;
 
 abstract class PersistentResource extends BaseResource
 {
@@ -345,6 +346,48 @@ public function checkExtension($alias)
         return true;
     }
 
+    /**
+     * Returns the object's properties as an array
+     */
+    protected function getPropertiesAsArray()
+    {
+        $properties = get_object_vars($this);
+
+        $propertiesToRemove = array('aliases', 'service', 'parent', 'metadata');
+        foreach ($propertiesToRemove as $property) {
+            unset($properties[$property]);
+        }
+
+        return $properties;
+    }
+
+    /**
+     * Generates a JSON Patch representation and return its
+     *
+     * @param mixed $updatedProperties Properties of the resource to update
+     * @return String JSON Patch representation for updates
+     */
+    protected function generateJsonPatch($updatedProperties)
+    {
+        // Normalize current and updated properties into nested arrays
+        $currentProperties = json_decode(json_encode($this->getPropertiesAsArray()), true);
+        $updatedProperties = json_decode(json_encode($updatedProperties), true);
+
+        // Add any properties that haven't changed to generate the correct patch
+        // (otherwise unchanging properties are marked as removed in the patch)
+        foreach ($currentProperties as $key => $value) {
+            if (!array_key_exists($key, $updatedProperties)) {
+                $updatedProperties[$key] = $value;
+            }
+        }
+
+        // Generate JSON Patch representation
+        $json = json_encode(JsonPatch::diff($currentProperties, $updatedProperties));
+        $this->checkJsonError();
+
+        return $json;
+    }
+
     /********  DEPRECATED METHODS ********/
 
     /**

tests/OpenCloud/Tests/Common/Resource/PersistentResourceTest.php

@@ -31,6 +31,16 @@ public function recursivelyAliasPropertyValue($propertyValue)
     {
         return parent::recursivelyAliasPropertyValue($propertyValue);
     }
+
+    public function getPropertiesAsArray()
+    {
+        return parent::getPropertiesAsArray();
+    }
+
+    public function generateJsonPatch($updateParams)
+    {
+        return parent::generateJsonPatch($updateParams);
+    }
 }
 
 class PersistentResourceTest extends OpenCloudTestCase
@@ -106,4 +116,68 @@ public function testRecursivelyAliasPropertyValueWithObjects()
         $this->assertEquals($obj3Expected,
             $this->persistentResource->recursivelyAliasPropertyValue($obj3));
     }
+
+    public function testGetPropertiesAsArray()
+    {
+        $this->persistentResource->id = 17;
+        $this->persistentResource->tags = array('foo', 'bar');
+        $this->persistentResource->domains = array(
+            (object) array('domain' => 'foo.phpopencloud.com'),
+            array('domain' => 'bar.phpopencloud.com')
+        );
+        $this->persistentResource->origins = array(
+            array('origin' => 'origin1.phpopencloud.com')
+        );
+        $this->persistentResource->status = (object) array('message' => 'Creation in progress');
+
+        $expectedArray = array(
+            'id' => 17,
+            'tags' => array('foo', 'bar'),
+            'domains' => array(
+                (object) array('domain' => 'foo.phpopencloud.com'),
+                array('domain' => 'bar.phpopencloud.com')
+            ),
+            'origins' => array(
+                array('origin' => 'origin1.phpopencloud.com'),
+            ),
+            'status' => (object) array('message' => 'Creation in progress'),
+        );
+
+        $this->assertEquals($expectedArray, $this->persistentResource->getPropertiesAsArray());
+    }
+
+    public function testGenerateJsonPatch()
+    {
+        $this->persistentResource->id = 17;
+        $this->persistentResource->tags = array('foo', 'bar');
+        $this->persistentResource->domains = array(
+            array('domain' => 'foo.phpopencloud.com'),
+            array('domain' => 'bar.phpopencloud.com')
+        );
+        $this->persistentResource->origins = array(
+            array('origin' => 'origin1.phpopencloud.com')
+        );
+        $this->persistentResource->status = array('message' => 'Creation in progress');
+
+        $updateParams = array(
+            'tags'    => array('foo', 'qux', 'baz'),
+            'domains' => array(
+                array('domain' => 'foo.phpopencloud.com')
+            ),
+            'origins' => array(
+                array('origin' => 'origin1.phpopencloud.com'),
+                array('origin' => 'origin2.phpopencloud.com')
+            )
+        );
+
+        $expectedJsonPatch = json_encode(array(
+            array('op' => 'add', 'path' => '/tags/2', 'value' => 'baz'),
+            array('op' => 'replace', 'path' => '/tags/1', 'value' => 'qux'),
+            array('op' => 'remove', 'path' => '/domains/1'),
+            array('op' => 'add', 'path' => '/origins/1', 'value' => array("origin" => "origin2.phpopencloud.com"))
+        ));
+
+        $actualJsonPatch = $this->persistentResource->generateJsonPatch($updateParams);
+        $this->assertEquals($expectedJsonPatch, $actualJsonPatch);
+    }
 }