Added basic API endpoints (#258)

src/API/ActivityController.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\API;
+
+use App\Entity\Activity;
+use App\Repository\ActivityRepository;
+use FOS\RestBundle\Controller\Annotations\RouteResource;
+use FOS\RestBundle\View\View;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use Nelmio\ApiDocBundle\Annotation as API;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Swagger\Annotations as SWG;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @RouteResource("Activity")
+ *
+ * @Security("is_granted('ROLE_USER')")
+ */
+class ActivityController extends Controller
+{
+    /**
+     * @var ActivityRepository
+     */
+    protected $repository;
+
+    /**
+     * @var ViewHandlerInterface
+     */
+    protected $viewHandler;
+
+    /**
+     * @param ViewHandlerInterface $viewHandler
+     * @param ActivityRepository $repository
+     */
+    public function __construct(ViewHandlerInterface $viewHandler, ActivityRepository $repository)
+    {
+        $this->viewHandler = $viewHandler;
+        $this->repository = $repository;
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns the collection of all existing activities",
+     *     @SWG\Schema(ref=@API\Model(type=Activity::class)),
+     * )
+     *
+     * @return Response
+     */
+    public function cgetAction()
+    {
+        $data = $this->repository->findAll();
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns one activity entity",
+     *     @SWG\Schema(ref=@API\Model(type=Activity::class)),
+     * )
+     *
+     * @param int $id
+     * @return Response
+     */
+    public function getAction($id)
+    {
+        $data = $this->repository->find($id);
+        if (null === $data) {
+            throw new NotFoundException();
+        }
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+}

src/API/CustomerController.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\API;
+
+use App\Entity\Customer;
+use App\Repository\CustomerRepository;
+use FOS\RestBundle\Controller\Annotations\RouteResource;
+use FOS\RestBundle\View\View;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use Nelmio\ApiDocBundle\Annotation\Model;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Swagger\Annotations as SWG;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @RouteResource("Customer")
+ *
+ * @Security("is_granted('ROLE_USER')")
+ */
+class CustomerController extends Controller
+{
+    /**
+     * @var CustomerRepository
+     */
+    protected $repository;
+
+    /**
+     * @var ViewHandlerInterface
+     */
+    protected $viewHandler;
+
+    /**
+     * @param ViewHandlerInterface $viewHandler
+     * @param CustomerRepository $repository
+     */
+    public function __construct(ViewHandlerInterface $viewHandler, CustomerRepository $repository)
+    {
+        $this->viewHandler = $viewHandler;
+        $this->repository = $repository;
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns the collection of all existing customer",
+     *     @SWG\Schema(ref=@Model(type=Customer::class)),
+     * )
+     *
+     * @return Response
+     */
+    public function cgetAction()
+    {
+        $data = $this->repository->findAll();
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns one customer entity",
+     *     @SWG\Schema(ref=@Model(type=Customer::class)),
+     * )
+     *
+     * @param int $id
+     * @return Response
+     */
+    public function getAction($id)
+    {
+        $data = $this->repository->find($id);
+        if (null === $data) {
+            throw new NotFoundException();
+        }
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+}

src/API/HealthcheckController.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\API;
+
+use FOS\RestBundle\Controller\Annotations as Rest;
+use FOS\RestBundle\View\View;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use Swagger\Annotations as SWG;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+class HealthcheckController extends Controller
+{
+    /**
+     * @var ViewHandlerInterface
+     */
+    protected $viewHandler;
+
+    /**
+     * @param ViewHandlerInterface $viewHandler
+     */
+    public function __construct(ViewHandlerInterface $viewHandler)
+    {
+        $this->viewHandler = $viewHandler;
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="A simple route that returns a 'pong', which you can use for testing the API",
+     * )
+     *
+     * @Rest\Get(path="/ping")
+     */
+    public function pingAction()
+    {
+        $view = new View(['message' => 'pong'], 200);
+
+        return $this->viewHandler->handle($view);
+    }
+}

src/API/NotFoundException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\API;
+
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+class NotFoundException extends NotFoundHttpException
+{
+    public function __construct(string $message = 'Not found', \Exception $previous = null, int $code = 0, array $headers = [])
+    {
+        parent::__construct($message, $previous, $code, $headers);
+    }
+}

src/API/ProjectController.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\API;
+
+use App\Entity\Project;
+use App\Repository\ProjectRepository;
+use FOS\RestBundle\Controller\Annotations\RouteResource;
+use FOS\RestBundle\View\View;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use Nelmio\ApiDocBundle\Annotation\Model;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Swagger\Annotations as SWG;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @RouteResource("Project")
+ *
+ * @Security("is_granted('ROLE_USER')")
+ */
+class ProjectController extends Controller
+{
+    /**
+     * @var ProjectRepository
+     */
+    protected $repository;
+
+    /**
+     * @var ViewHandlerInterface
+     */
+    protected $viewHandler;
+
+    /**
+     * @param ViewHandlerInterface $viewHandler
+     * @param ProjectRepository $repository
+     */
+    public function __construct(ViewHandlerInterface $viewHandler, ProjectRepository $repository)
+    {
+        $this->viewHandler = $viewHandler;
+        $this->repository = $repository;
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns the collection of all existing projects",
+     *     @SWG\Schema(ref=@Model(type=Project::class)),
+     * )
+     *
+     * @return Response
+     */
+    public function cgetAction()
+    {
+        $data = $this->repository->findAll();
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns one project entity",
+     *     @SWG\Schema(ref=@Model(type=Project::class)),
+     * )
+     *
+     * @param int $id
+     * @return Response
+     */
+    public function getAction($id)
+    {
+        $data = $this->repository->find($id);
+        if (null === $data) {
+            throw new NotFoundException();
+        }
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+}

src/API/UserController.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\API;
+
+use App\Entity\User;
+use App\Repository\UserRepository;
+use FOS\RestBundle\Controller\Annotations\RouteResource;
+use FOS\RestBundle\View\View;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use Nelmio\ApiDocBundle\Annotation\Model;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Swagger\Annotations as SWG;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @RouteResource("User")
+ *
+ * @Security("is_granted('ROLE_SUPER_ADMIN')")
+ * @Security("is_granted('IS_AUTHENTICATED_FULLY')")
+ */
+class UserController extends Controller
+{
+    /**
+     * @var UserRepository
+     */
+    protected $repository;
+
+    /**
+     * @var ViewHandlerInterface
+     */
+    protected $viewHandler;
+
+    /**
+     * @param ViewHandlerInterface $viewHandler
+     * @param UserRepository $repository
+     */
+    public function __construct(ViewHandlerInterface $viewHandler, UserRepository $repository)
+    {
+        $this->viewHandler = $viewHandler;
+        $this->repository = $repository;
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns the collection of all registered users",
+     *     @SWG\Schema(ref=@Model(type=User::class)),
+     * )
+     *
+     * @return Response
+     */
+    public function cgetAction()
+    {
+        $data = $this->repository->findAll();
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Return one user entity",
+     *     @SWG\Schema(ref=@Model(type=User::class)),
+     * )
+     *
+     * @param int $id
+     * @return Response
+     */
+    public function getAction($id)
+    {
+        $data = $this->repository->find($id);
+        if (null === $data) {
+            throw new NotFoundException();
+        }
+        $view = new View($data, 200);
+
+        return $this->viewHandler->handle($view);
+    }
+}