[WIP] Implement GET /activities

Controller/ActivityGetController.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Controller;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Xabbuh\XApi\Common\Exception\NotFoundException;
+use Xabbuh\XApi\Model\IRI;
+use Xabbuh\XApi\Serializer\ActivitySerializerInterface;
+use XApi\Repository\Api\ActivityRepositoryInterface;
+
+/**
+ * @author Jérôme Parmentier <[email protected]>
+ */
+final class ActivityGetController
+{
+    private $repository;
+    private $serializer;
+
+    public function __construct(ActivityRepositoryInterface $repository, ActivitySerializerInterface $serializer)
+    {
+        $this->repository = $repository;
+        $this->serializer = $serializer;
+    }
+
+    public function getActivity(Request $request)
+    {
+        if (null === $activityId = $request->query->get('activityId')) {
+            throw new BadRequestHttpException('Required activityId parameter is missing.');
+        }
+
+        try {
+            $activity = $this->repository->findActivityById(IRI::fromString($activityId));
+        } catch (NotFoundException $e) {
+            throw new NotFoundHttpException(sprintf('No activity matching the following id "%s" has been found.', $activityId), $e);
+        }
+
+        return new JsonResponse($this->serializer->serializeActivity($activity), 200, array(), true);
+    }
+}

DependencyInjection/XApiLrsExtension.php

@@ -41,13 +41,15 @@ public function load(array $configs, ContainerBuilder $container)
                 $loader->load('mongodb.xml');
 
                 $container->setAlias('xapi_lrs.doctrine.object_manager', $config['object_manager_service']);
+                $container->setAlias('xapi_lrs.repository.activity', 'xapi_lrs.repository.activity.doctrine');
                 $container->setAlias('xapi_lrs.repository.statement', 'xapi_lrs.repository.statement.doctrine');
                 break;
             case 'orm':
                 $loader->load('doctrine.xml');
                 $loader->load('orm.xml');
 
                 $container->setAlias('xapi_lrs.doctrine.object_manager', $config['object_manager_service']);
+                $container->setAlias('xapi_lrs.repository.activity', 'xapi_lrs.repository.activity.doctrine');
                 $container->setAlias('xapi_lrs.repository.statement', 'xapi_lrs.repository.statement.doctrine');
                 break;
         }

Resources/config/controller.xml

@@ -5,15 +5,20 @@
         http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
+        <service id="xapi_lrs.controller.activity.get" class="XApi\LrsBundle\Controller\ActivityGetController">
+            <argument type="service" id="xapi_lrs.repository.activity" />
+            <argument type="service" id="xapi_lrs.serializer.activity" />
+        </service>
+
         <service id="xapi_lrs.controller.statement.get" class="XApi\LrsBundle\Controller\StatementGetController">
             <argument type="service" id="xapi_lrs.repository.statement"/>
             <argument type="service" id="xapi_lrs.statement.serializer"/>
             <argument type="service" id="xapi_lrs.statement_result.serializer"/>
             <argument type="service" id="xapi_lrs.factory.statements_filter"/>
         </service>
-        
+
         <service id="xapi_lrs.controller.statement.post" class="XApi\LrsBundle\Controller\StatementPostController"/>
-        
+
         <service id="xapi_lrs.controller.statement.put" class="XApi\LrsBundle\Controller\StatementPutController">
             <argument type="service" id="xapi_lrs.repository.statement"/>
         </service>

Resources/config/doctrine.xml

@@ -5,6 +5,8 @@
         http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
+        <service id="xapi_lrs.repository.activity.doctrine" class="XApi\Repository\Doctrine\Repository\ActivityRepository" public="false"/>
+
         <service id="xapi_lrs.repository.statement.doctrine" class="XApi\Repository\Doctrine\Repository\StatementRepository" public="false">
             <argument type="service" id="xapi_lrs.repository.mapped_statement" />
         </service>

Resources/config/routing.xml

@@ -4,6 +4,13 @@
     xsi:schemaLocation="http://symfony.com/schema/routing
         http://symfony.com/schema/routing/routing-1.0.xsd">
 
+    <route id="xapi_lrs.activity.get" path="/activities" methods="GET">
+        <default key="_controller">xapi_lrs.controller.activity.get:getActivity</default>
+        <default key="xapi_lrs.route">
+            <bool>true</bool>
+        </default>
+    </route>
+
     <route id="xapi_lrs.statement.put" path="/statements" methods="PUT">
         <default key="_controller">xapi_lrs.controller.statement.put:putStatement</default>
         <default key="xapi_serializer">statement</default>

Resources/config/serializer.xml

@@ -21,6 +21,10 @@
             <factory service="xapi_lrs.serializer.factory" method="createDocumentDataSerializer"/>
         </service>
 
+        <service id="xapi_lrs.activity.serializer" class="Xabbuh\XApi\Serializer\ActivitySerializerInterface" public="false">
+            <factory service="xapi_lrs.serializer.factory" method="createActivitySerializer"/>
+        </service>
+
         <service id="xapi_lrs.serializer_factory" class="Xabbuh\XApi\Serializer\Symfony\SerializerFactory" public="false">
             <argument type="service" id="xapi_lrs.serializer"/>
         </service>

Spec/Controller/ActivityGetControllerSpec.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Spec\XApi\LrsBundle\Controller;
+
+use PhpSpec\ObjectBehavior;
+use Symfony\Component\HttpFoundation\Request;
+use Xabbuh\XApi\Common\Exception\NotFoundException;
+use Xabbuh\XApi\DataFixtures\ActivityFixtures;
+use Xabbuh\XApi\Model\IRI;
+use Xabbuh\XApi\Serializer\ActivitySerializerInterface;
+use XApi\Fixtures\Json\ActivityJsonFixtures;
+use XApi\Repository\Api\ActivityRepositoryInterface;
+
+class ActivityGetControllerSpec extends ObjectBehavior
+{
+    function let(ActivityRepositoryInterface $repository, ActivitySerializerInterface $serializer)
+    {
+        $this->beConstructedWith($repository, $serializer);
+    }
+
+    function it_should_throws_a_badrequesthttpexception_if_an_activityid_is_not_part_of_a_get_request()
+    {
+        $request = new Request();
+
+        $this
+            ->shouldThrow('\Symfony\Component\HttpKernel\Exception\BadRequestHttpException')
+            ->during('getActivity', array($request));
+    }
+
+    function it_should_throws_a_notfoundhttpexception_if_no_activity_matches_activityid(ActivityRepositoryInterface $repository)
+    {
+        $activityId = 'http://tincanapi.com/conformancetest/activityid';
+
+        $request = new Request();
+        $request->query->set('activityId', $activityId);
+
+        $repository->findActivityById(IRI::fromString($activityId))->shouldBeCalled()->willThrow(new NotFoundException(''));
+
+        $this
+            ->shouldThrow('\Symfony\Component\HttpKernel\Exception\NotFoundHttpException')
+            ->during('getActivity', array($request));
+    }
+
+    function it_should_returns_a_jsonresponse(ActivityRepositoryInterface $repository, ActivitySerializerInterface $serializer)
+    {
+        $activityId = 'http://tincanapi.com/conformancetest/activityid';
+        $activity = ActivityFixtures::getTypicalActivity();
+
+        $request = new Request();
+        $request->query->set('activityId', $activityId);
+
+        $repository->findActivityById(IRI::fromString($activityId))->shouldBeCalled()->willReturn($activity);
+        $serializer->serializeActivity($activity)->shouldBeCalled()->willReturn(ActivityJsonFixtures::getTypicalActivity());
+
+        $this->getActivity($request)->shouldReturnAnInstanceOf('\Symfony\Component\HttpFoundation\JsonResponse');
+    }
+}

composer.json

@@ -15,11 +15,21 @@
             "homepage": "https://github.com/Lctrs"
         }
     ],
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/Lctrs/serializer"
+        },
+        {
+            "type": "vcs",
+            "url": "https://github.com/Lctrs/repository-api"
+        }
+    ],
     "require": {
         "php-xapi/exception": "^0.1",
         "php-xapi/model": "^1.1 || ^2.0",
-        "php-xapi/repository-api": "^0.3@dev || ^0.4@dev",
-        "php-xapi/serializer": "^1.0 || ^2.0",
+        "php-xapi/repository-api": "dev-feature/activity-repository",
+        "php-xapi/serializer": "dev-feature/activity-serializer as 2.1.x-dev",
         "php-xapi/symfony-serializer": "^1.0 || ^2.0",
         "symfony/dependency-injection": "^2.7 || ^3.1",
         "symfony/http-kernel": "^2.7 || ^3.1"