compatibility with php-xapi/model 0.5.0

Author: xabbuh

CHANGELOG.md

@@ -4,7 +4,9 @@ CHANGELOG
 0.2.0
 -----
 
-* made the client compatible with version 0.2 of the `php-xapi/model` package
+* made the client compatible with version 0.5 of the `php-xapi/model` package
+
+* made the client compatible with version 0.3 of the `php-xapi/serializer` package
 
 0.1.0
 -----

UPGRADE.md

@@ -0,0 +1,8 @@
+UPGRADE
+=======
+
+Upgrading from 0.1 to 0.2
+-------------------------
+
+* Statement identifiers must be passed as `StatementId` objects instead of
+  strings.

composer.json

@@ -15,11 +15,11 @@
         "php": ">=5.3.0",
         "guzzle/guzzle": "~3.7",
         "php-xapi/exception": "^0.1.0",
-        "php-xapi/model": "^0.2.0",
-        "php-xapi/serializer": "^0.2.0"
+        "php-xapi/model": "^0.5.0@dev",
+        "php-xapi/serializer": "^0.3.0@dev"
     },
     "require-dev": {
-        "php-xapi/test-fixtures": "^0.2.0"
+        "php-xapi/test-fixtures": "^0.5.0@dev"
     },
     "conflict": {
         "xabbuh/xapi-client": "*"
@@ -36,7 +36,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "0.1.x-dev"
+            "dev-master": "0.2.x-dev"
         }
     }
 }

src/Api/StatementsApiClient.php

@@ -12,6 +12,7 @@
 namespace Xabbuh\XApi\Client\Api;
 
 use Xabbuh\XApi\Client\Request\HandlerInterface;
+use Xabbuh\XApi\Model\StatementId;
 use Xabbuh\XApi\Serializer\ActorSerializerInterface;
 use Xabbuh\XApi\Serializer\StatementResultSerializerInterface;
 use Xabbuh\XApi\Serializer\StatementSerializerInterface;
@@ -71,7 +72,7 @@ public function storeStatement(Statement $statement)
             return $this->doStoreStatements(
                 $statement,
                 'put',
-                array('statementId' => $statement->getId()),
+                array('statementId' => $statement->getId()->getValue()),
                 204
             );
         } else {
@@ -109,17 +110,17 @@ public function voidStatement(Statement $statement, Actor $actor)
     /**
      * {@inheritDoc}
      */
-    public function getStatement($statementId)
+    public function getStatement(StatementId $statementId)
     {
-        return $this->doGetStatements('statements', array('statementId' => $statementId));
+        return $this->doGetStatements('statements', array('statementId' => $statementId->getValue()));
     }
 
     /**
      * {@inheritDoc}
      */
-    public function getVoidedStatement($statementId)
+    public function getVoidedStatement(StatementId $statementId)
     {
-        return $this->doGetStatements('statements', array('voidedStatementId' => $statementId));
+        return $this->doGetStatements('statements', array('voidedStatementId' => $statementId->getValue()));
     }
 
     /**
@@ -179,35 +180,17 @@ private function doStoreStatements($statements, $method = 'post', $parameters =
             $createdStatements = array();
 
             foreach ($statements as $index => $statement) {
-                $createdStatements[] = new Statement(
-                    $statementIds[$index],
-                    $statement->getActor(),
-                    $statement->getVerb(),
-                    $statement->getObject(),
-                    $statement->getResult()
-                );
+                $createdStatements[] = $statement->withId(StatementId::fromString($statementIds[$index]));
             }
 
             return $createdStatements;
         } else {
             /** @var Statement $statements */
 
             if (200 === $validStatusCode) {
-                return new Statement(
-                    $statementIds[0],
-                    $statements->getActor(),
-                    $statements->getVerb(),
-                    $statements->getObject(),
-                    $statements->getResult()
-                );
+                return $statements->withId(StatementId::fromString($statementIds[0]));
             } else {
-                return new Statement(
-                    $statements->getId(),
-                    $statements->getActor(),
-                    $statements->getVerb(),
-                    $statements->getObject(),
-                    $statements->getResult()
-                );
+                return $statements;
             }
         }
     }

src/Api/StatementsApiClientInterface.php

@@ -16,6 +16,7 @@
 use Xabbuh\XApi\Common\Exception\XApiException;
 use Xabbuh\XApi\Model\Actor;
 use Xabbuh\XApi\Model\Statement;
+use Xabbuh\XApi\Model\StatementId;
 use Xabbuh\XApi\Model\StatementResult;
 use Xabbuh\XApi\Model\StatementsFilter;
 
@@ -78,26 +79,26 @@ public function voidStatement(Statement $statement, Actor $actor);
     /**
      * Retrieves a single {@link Statement Statement}.
      *
-     * @param string $statementId The Statement id
+     * @param StatementId $statementId The Statement id
      *
      * @return Statement The Statement
      *
      * @throws NotFoundException if no statement with the given id could be found
      * @throws XApiException     for all other xAPI related problems
      */
-    public function getStatement($statementId);
+    public function getStatement(StatementId $statementId);
 
     /**
      * Retrieves a voided {@link Statement Statement}.
      *
-     * @param string $statementId The id of the voided Statement
+     * @param StatementId $statementId The id of the voided Statement
      *
      * @return Statement The voided Statement
      *
      * @throws NotFoundException if no statement with the given id could be found
      * @throws XApiException     for all other xAPI related problems
      */
-    public function getVoidedStatement($statementId);
+    public function getVoidedStatement(StatementId $statementId);
 
     /**
      * Retrieves a collection of {@link Statement Statements}.

tests/Api/StatementsApiClientTest.php

@@ -16,6 +16,7 @@
 use Xabbuh\XApi\Model\Agent;
 use Xabbuh\XApi\Model\InverseFunctionalIdentifier;
 use Xabbuh\XApi\Model\Statement;
+use Xabbuh\XApi\Model\StatementId;
 use Xabbuh\XApi\Model\StatementReference;
 use Xabbuh\XApi\Model\StatementResult;
 use Xabbuh\XApi\Model\StatementsFilter;
@@ -94,7 +95,7 @@ public function testStoreStatementWithIdEnsureThatTheIdIsNotOverwritten()
         );
         $storedStatement = $this->client->storeStatement($statement);
 
-        $this->assertEquals($statementId, $storedStatement->getId());
+        $this->assertEquals($statementId, $storedStatement->getId()->getValue());
     }
 
     public function testStoreStatements()
@@ -119,8 +120,8 @@ public function testStoreStatements()
         $this->assertNotContains($statements[0], array($statement1, $statement2));
         $this->assertNotContains($statements[1], array($statement1, $statement2));
         $this->assertEquals($expectedStatements, $statements);
-        $this->assertEquals($statementId1, $statements[0]->getId());
-        $this->assertEquals($statementId2, $statements[1]->getId());
+        $this->assertEquals($statementId1, $statements[0]->getId()->getValue());
+        $this->assertEquals($statementId2, $statements[1]->getId()->getValue());
     }
 
     /**
@@ -161,7 +162,7 @@ public function testVoidStatement()
         $voidedStatementId = '12345678-1234-5678-1234-567812345679';
         $voidingStatementId = '12345678-1234-5678-1234-567812345678';
         $agent = new Agent(InverseFunctionalIdentifier::withMbox('mailto:[email protected]'));
-        $statementReference = new StatementReference($voidedStatementId);
+        $statementReference = new StatementReference(StatementId::fromString($voidedStatementId));
         $voidingStatement = new Statement(null, $agent, Verb::createVoidVerb(), $statementReference);
         $voidedStatement = $this->createStatement($voidedStatementId);
         $this->validateStoreApiCall(
@@ -174,7 +175,7 @@ public function testVoidStatement()
         );
         $returnedVoidingStatement = $this->client->voidStatement($voidedStatement, $agent);
         $expectedVoidingStatement = new Statement(
-            $voidingStatementId,
+            StatementId::fromString($voidingStatementId),
             $agent,
             Verb::createVoidVerb(),
             $statementReference
@@ -196,7 +197,7 @@ public function testGetStatement()
             $statement
         );
 
-        $this->client->getStatement($statementId);
+        $this->client->getStatement(StatementId::fromString($statementId));
     }
 
     /**
@@ -214,7 +215,7 @@ public function testGetStatementWithNotExistingStatement()
             'There is no statement associated with this id'
         );
 
-        $this->client->getStatement($statementId);
+        $this->client->getStatement(StatementId::fromString($statementId));
     }
 
     public function testGetVoidedStatement()
@@ -230,7 +231,7 @@ public function testGetVoidedStatement()
             $statement
         );
 
-        $this->client->getVoidedStatement($statementId);
+        $this->client->getVoidedStatement(StatementId::fromString($statementId));
     }
 
     /**
@@ -248,7 +249,7 @@ public function testGetVoidedStatementWithNotExistingStatement()
             'There is no statement associated with this id'
         );
 
-        $this->client->getVoidedStatement($statementId);
+        $this->client->getVoidedStatement(StatementId::fromString($statementId));
     }
 
     public function testGetStatements()
@@ -274,7 +275,7 @@ public function testGetStatementsWithStatementsFilter()
         $this->validateRetrieveApiCall(
             'get',
             'statements',
-            array('limit' => 10, 'ascending' => 'True'),
+            array('limit' => 10, 'ascending' => 'true'),
             200,
             'StatementResult',
             $statementResult
@@ -351,7 +352,13 @@ public function testGetNextStatements()
      */
     private function createStatement($id = null)
     {
-        return StatementFixtures::getMinimalStatement($id);
+        $statement = StatementFixtures::getMinimalStatement($id);
+
+        if (null === $id) {
+            $statement = $statement->withId(null);
+        }
+
+        return $statement;
     }
 
     /**