compatibility with php-xapi/serializer 0.4.0

Author: xabbuh

CHANGELOG.md

@@ -1,6 +1,19 @@
 CHANGELOG
 =========
 
+0.4.0
+-----
+
+* The `XApiClientBuilder` class now makes use of the `SerializerFactoryInterface`
+  introduced in release `0.4.0` of the `php-xapi/serializer` package. By
+  default, it will fall back to the `SerializerFactory` implemented provided
+  by the `php-xapi/symfony-serializer` to maintain backwards-compatibility
+  with the previous release. However, you are now able to inject arbitrary
+  implementations of the `SerializerFactoryInterface` into the constructor
+  of the `XApiClientBuilder` to use whatever alternative implementation
+  (packages providing such an implementation should provide the virtual
+  `php-xapi/serializer-implementation` package).
+
 0.3.0
 -----
 

composer.json

@@ -16,7 +16,9 @@
         "guzzle/guzzle": "~3.7",
         "php-xapi/exception": "^0.1.0",
         "php-xapi/model": "^0.5.1",
-        "php-xapi/serializer": "^0.3.0"
+        "php-xapi/serializer": "^0.4",
+        "php-xapi/serializer-implementation": "^1.0",
+        "php-xapi/symfony-serializer": "^0.1"
     },
     "require-dev": {
         "phpspec/phpspec": "^2.3",

src/XApiClientBuilder.php

@@ -14,12 +14,9 @@
 use Guzzle\Http\Client;
 use Guzzle\Plugin\Oauth\OauthPlugin;
 use Xabbuh\XApi\Client\Request\Handler;
-use Xabbuh\XApi\Serializer\ActorSerializer;
-use Xabbuh\XApi\Serializer\DocumentDataSerializer;
-use Xabbuh\XApi\Serializer\Serializer;
+use Xabbuh\XApi\Serializer\SerializerFactoryInterface;
 use Xabbuh\XApi\Serializer\SerializerRegistry;
-use Xabbuh\XApi\Serializer\StatementResultSerializer;
-use Xabbuh\XApi\Serializer\StatementSerializer;
+use Xabbuh\XApi\Serializer\Symfony\SerializerFactory;
 
 /**
  * xAPI client builder.
@@ -28,16 +25,18 @@
  */
 final class XApiClientBuilder implements XApiClientBuilderInterface
 {
+    private $serializerFactory;
     private $baseUrl;
-
     private $version;
-
     private $username;
-
     private $password;
-
     private $oAuthCredentials;
 
+    public function __construct(SerializerFactoryInterface $serializerFactory = null)
+    {
+        $this->serializerFactory = $serializerFactory ?: new SerializerFactory();
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -99,12 +98,11 @@ public function build()
             $httpClient->addSubscriber(new OauthPlugin($this->oAuthCredentials));
         }
 
-        $serializer = Serializer::createSerializer();
         $serializerRegistry = new SerializerRegistry();
-        $serializerRegistry->setStatementSerializer(new StatementSerializer($serializer));
-        $serializerRegistry->setStatementResultSerializer(new StatementResultSerializer($serializer));
-        $serializerRegistry->setActorSerializer(new ActorSerializer($serializer));
-        $serializerRegistry->setDocumentDataSerializer(new DocumentDataSerializer($serializer));
+        $serializerRegistry->setStatementSerializer($this->serializerFactory->createStatementSerializer());
+        $serializerRegistry->setStatementResultSerializer($this->serializerFactory->createStatementResultSerializer());
+        $serializerRegistry->setActorSerializer($this->serializerFactory->createActorSerializer());
+        $serializerRegistry->setDocumentDataSerializer($this->serializerFactory->createDocumentDataSerializer());
 
         $version = null === $this->version ? '1.0.1' : $this->version;
         $requestHandler = new Handler($httpClient, $version, $this->username, $this->password);

tests/Api/ActivityProfileApiClientTest.php

@@ -16,7 +16,7 @@
 use Xabbuh\XApi\Model\Activity;
 use Xabbuh\XApi\Model\ActivityProfile;
 use Xabbuh\XApi\Model\IRI;
-use Xabbuh\XApi\Serializer\DocumentDataSerializer;
+use Xabbuh\XApi\Serializer\Symfony\DocumentDataSerializer;
 
 /**
  * @author Christian Flothmann <[email protected]>

tests/Api/AgentProfileApiClientTest.php

@@ -17,8 +17,8 @@
 use Xabbuh\XApi\Model\AgentProfile;
 use Xabbuh\XApi\Model\InverseFunctionalIdentifier;
 use Xabbuh\XApi\Model\IRI;
-use Xabbuh\XApi\Serializer\ActorSerializer;
-use Xabbuh\XApi\Serializer\DocumentDataSerializer;
+use Xabbuh\XApi\Serializer\Symfony\ActorSerializer;
+use Xabbuh\XApi\Serializer\Symfony\DocumentDataSerializer;
 
 /**
  * @author Christian Flothmann <[email protected]>

tests/Api/ApiClientTest.php

@@ -14,11 +14,11 @@
 use Symfony\Component\Serializer\SerializerInterface;
 use Xabbuh\XApi\Client\Request\HandlerInterface;
 use Xabbuh\XApi\Common\Exception\NotFoundException;
-use Xabbuh\XApi\Serializer\ActorSerializer;
-use Xabbuh\XApi\Serializer\DocumentDataSerializer;
 use Xabbuh\XApi\Serializer\SerializerRegistry;
-use Xabbuh\XApi\Serializer\StatementResultSerializer;
-use Xabbuh\XApi\Serializer\StatementSerializer;
+use Xabbuh\XApi\Serializer\Symfony\ActorSerializer;
+use Xabbuh\XApi\Serializer\Symfony\DocumentDataSerializer;
+use Xabbuh\XApi\Serializer\Symfony\StatementResultSerializer;
+use Xabbuh\XApi\Serializer\Symfony\StatementSerializer;
 
 /**
  * @author Christian Flothmann <[email protected]>

tests/Api/StateApiClientTest.php

@@ -18,8 +18,8 @@
 use Xabbuh\XApi\Model\InverseFunctionalIdentifier;
 use Xabbuh\XApi\Model\IRI;
 use Xabbuh\XApi\Model\State;
-use Xabbuh\XApi\Serializer\ActorSerializer;
-use Xabbuh\XApi\Serializer\DocumentDataSerializer;
+use Xabbuh\XApi\Serializer\Symfony\ActorSerializer;
+use Xabbuh\XApi\Serializer\Symfony\DocumentDataSerializer;
 
 /**
  * @author Christian Flothmann <[email protected]>

tests/Api/StatementsApiClientTest.php

@@ -23,9 +23,9 @@
 use Xabbuh\XApi\Model\StatementResult;
 use Xabbuh\XApi\Model\StatementsFilter;
 use Xabbuh\XApi\Model\Verb;
-use Xabbuh\XApi\Serializer\ActorSerializer;
-use Xabbuh\XApi\Serializer\StatementResultSerializer;
-use Xabbuh\XApi\Serializer\StatementSerializer;
+use Xabbuh\XApi\Serializer\Symfony\ActorSerializer;
+use Xabbuh\XApi\Serializer\Symfony\StatementResultSerializer;
+use Xabbuh\XApi\Serializer\Symfony\StatementSerializer;
 
 /**
  * @author Christian Flothmann <[email protected]>