take attachment contents into account

Author: xabbuh

CHANGELOG.md

@@ -1,6 +1,17 @@
 CHANGELOG
 =========
 
+2.0.0
+-----
+
+Added support for deserializing raw attachment contents. In order to achieve this
+an optional `$attachments` argument has been added to the `deserializeStatement()`
+and `deserializeStatements()` methods of the `StatementSerializer` class.
+
+When being passed, this argument must be an array mapping SHA-2 hashes to an
+array which in turn maps the `type` and `content` keys to the attachment's
+content type and raw content data respectively.
+
 1.0.0
 -----
 

UPGRADE.md

@@ -0,0 +1,14 @@
+UPGRADE
+=======
+
+Upgrading from 1.x to 2.0
+-------------------------
+
+Added support for deserializing raw attachment contents. In order to achieve this
+an optional `$attachments` argument has been added to the `deserializeStatement()`
+and `deserializeStatements()` methods of the `StatementSerializer` class as well
+as to the `StatementResultSerializer::deserializeStatementResult()`.
+
+When being passed, this argument must be an array mapping SHA-2 hashes to an
+array which in turn maps the `type` and `content` keys to the attachment's
+content type and raw content data respectively.

composer.json

@@ -14,16 +14,17 @@
     "require": {
         "php": ">=5.3.0",
         "php-xapi/model": "^1.0",
-        "php-xapi/serializer": "^1.0",
+        "php-xapi/serializer": "^2.0",
         "symfony/serializer": "~2.8|~3.0"
     },
     "require-dev": {
-        "php-xapi/json-test-fixtures": "^1.0",
+        "php-xapi/json-test-fixtures": "^2.0",
         "php-xapi/test-fixtures": "^1.0",
         "phpspec/phpspec": "~2.3"
     },
+    "minimum-stability": "dev",
     "provide": {
-        "php-xapi/serializer-implementation": "1.0"
+        "php-xapi/serializer-implementation": "2.0"
     },
     "autoload": {
         "psr-4": {
@@ -38,7 +39,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0.x-dev"
+            "dev-master": "2.0.x-dev"
         }
     }
 }

spec/Normalizer/AttachmentNormalizerSpec.php

@@ -21,7 +21,10 @@ function it_supports_normalizing_attachment_objects()
             'text/plain',
             18,
             'bd1a58265d96a3d1981710dab8b1e1ed04a8d7557ea53ab0cf7b44c04fd01545',
-            LanguageMap::create(array('en-US' => 'Text attachment'))
+            LanguageMap::create(array('en-US' => 'Text attachment')),
+            null,
+            null,
+            'some text content'
         );
 
         $this->supportsNormalization($attachment)->shouldReturn(true);

src/Normalizer/AttachmentNormalizer.php

@@ -63,6 +63,7 @@ public function denormalize($data, $class, $format = null, array $context = arra
         $display = $this->denormalizeData($data['display'], 'Xabbuh\XApi\Model\LanguageMap', $format, $context);
         $description = null;
         $fileUrl = null;
+        $content = null;
 
         if (isset($data['description'])) {
             $description = $this->denormalizeData($data['description'], 'Xabbuh\XApi\Model\LanguageMap', $format, $context);
@@ -72,7 +73,11 @@ public function denormalize($data, $class, $format = null, array $context = arra
             $fileUrl = IRL::fromString($data['fileUrl']);
         }
 
-        return new Attachment(IRI::fromString($data['usageType']), $data['contentType'], $data['length'], $data['sha2'], $display, $description, $fileUrl);
+        if (isset($context['xapi_attachments'][$data['sha2']])) {
+            $content = $context['xapi_attachments'][$data['sha2']]['content'];
+        }
+
+        return new Attachment(IRI::fromString($data['usageType']), $data['contentType'], $data['length'], $data['sha2'], $display, $description, $fileUrl, $content);
     }
 
     public function supportsDenormalization($data, $type, $format = null)

src/Normalizer/StatementResultNormalizer.php

@@ -58,7 +58,7 @@ public function supportsNormalization($data, $format = null)
      */
     public function denormalize($data, $class, $format = null, array $context = array())
     {
-        $statements = $this->denormalizeData($data['statements'], 'Xabbuh\XApi\Model\Statement[]');
+        $statements = $this->denormalizeData($data['statements'], 'Xabbuh\XApi\Model\Statement[]', $format, $context);
         $moreUrlPath = null;
 
         if (isset($data['more'])) {

src/StatementResultSerializer.php

@@ -43,12 +43,15 @@ public function serializeStatementResult(StatementResult $statementResult)
     /**
      * {@inheritDoc}
      */
-    public function deserializeStatementResult($data)
+    public function deserializeStatementResult($data, array $attachments = array())
     {
         return $this->serializer->deserialize(
             $data,
             'Xabbuh\XApi\Model\StatementResult',
-            'json'
+            'json',
+            array(
+                'xapi_attachments' => $attachments,
+            )
         );
     }
 }

src/StatementSerializer.php

@@ -51,24 +51,30 @@ public function serializeStatements(array $statements)
     /**
      * {@inheritDoc}
      */
-    public function deserializeStatement($data)
+    public function deserializeStatement($data, array $attachments = array())
     {
         return $this->serializer->deserialize(
             $data,
             'Xabbuh\XApi\Model\Statement',
-            'json'
+            'json',
+            array(
+                'xapi_attachments' => $attachments,
+            )
         );
     }
 
     /**
      * {@inheritDoc}
      */
-    public function deserializeStatements($data)
+    public function deserializeStatements($data, array $attachments = array())
     {
         return $this->serializer->deserialize(
             $data,
             'Xabbuh\XApi\Model\Statement[]',
-            'json'
+            'json',
+            array(
+                'xapi_attachments' => $attachments,
+            )
         );
     }
 }

tests/SerializerTest.php

@@ -134,23 +134,59 @@ public function testSerializeAttachment(Attachment $attachment, $expectedJson)
 
     public function serializeAttachmentData()
     {
-        return $this->buildSerializeTestCases('Attachment');
+        $tests = array();
+
+        foreach (get_class_methods('Xabbuh\XApi\DataFixtures\AttachmentFixtures') as $method) {
+            if (false !== strpos($method, 'ForQuery')) {
+                continue;
+            }
+
+            $jsonFixture = json_decode(call_user_func(array('XApi\Fixtures\Json\AttachmentJsonFixtures', $method)));
+
+            $tests[$method] = array(
+                call_user_func(array('Xabbuh\XApi\DataFixtures\AttachmentFixtures', $method)),
+                json_encode($jsonFixture->metadata),
+            );
+        }
+
+        return $tests;
     }
 
     /**
      * @dataProvider deserializeAttachmentData
      */
-    public function testDeserializeAttachment($json, Attachment $expectedAttachment)
+    public function testDeserializeAttachment($json, $content, Attachment $expectedAttachment)
     {
-        $attachment = $this->serializer->deserialize($json, 'Xabbuh\XApi\Model\Attachment', 'json');
+        $context = array();
+
+        if (null !== $content) {
+            $context['xapi_attachments'] = array(
+                hash('sha256', $content) => array(
+                    'content' => $content,
+                )
+            );
+        }
+
+        $attachment = $this->serializer->deserialize($json, 'Xabbuh\XApi\Model\Attachment', 'json', $context);
 
         $this->assertInstanceOf('Xabbuh\XApi\Model\Attachment', $attachment);
         $this->assertTrue($expectedAttachment->equals($attachment), 'Deserialized attachment has the expected properties');
     }
 
     public function deserializeAttachmentData()
     {
-        return $this->buildDeserializeTestCases('Attachment');
+        $tests = array();
+
+        foreach (get_class_methods('XApi\Fixtures\Json\AttachmentJsonFixtures') as $method) {
+            $jsonFixture = json_decode(call_user_func(array('XApi\Fixtures\Json\AttachmentJsonFixtures', $method)));
+            $tests[$method] = array(
+                json_encode($jsonFixture->metadata),
+                isset($jsonFixture->content) ? $jsonFixture->content : null,
+                call_user_func(array('Xabbuh\XApi\DataFixtures\AttachmentFixtures', $method)),
+            );
+        }
+
+        return $tests;
     }
 
     /**