mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-07-02 23:16:13 +00:00
Add SetCallerApiController with tests and API endpoint to manage ticket caller changes
This commit is contained in:
parent
de18f4e3aa
commit
7c17d4f2cb
@ -288,3 +288,57 @@ paths:
|
|||||||
description: "OK"
|
description: "OK"
|
||||||
401:
|
401:
|
||||||
description: "UNAUTHORIZED"
|
description: "UNAUTHORIZED"
|
||||||
|
|
||||||
|
/1.0/ticket/ticket/{id}/set-caller:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- ticket
|
||||||
|
summary: Set a caller for this ticket
|
||||||
|
description: |
|
||||||
|
Set a caller to the ticket.
|
||||||
|
|
||||||
|
To remove the caller, set the caller field to null
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
description: The ticket id
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
format: integer
|
||||||
|
minimum: 1
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
caller:
|
||||||
|
nullable: true
|
||||||
|
oneOf:
|
||||||
|
- $ref: '#/components/schemas/PersonById'
|
||||||
|
- $ref: '#/components/schemas/ThirdPartyById'
|
||||||
|
examples:
|
||||||
|
add_user:
|
||||||
|
value:
|
||||||
|
caller:
|
||||||
|
type: person
|
||||||
|
id: 8
|
||||||
|
summary: Set the person with id 8
|
||||||
|
add_third_party:
|
||||||
|
value:
|
||||||
|
caller:
|
||||||
|
type: thirdparty
|
||||||
|
id: 10
|
||||||
|
summary: Set the third party with id 10
|
||||||
|
remove:
|
||||||
|
value:
|
||||||
|
caller: null
|
||||||
|
summary: Remove the caller (set the caller to null)
|
||||||
|
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: "OK"
|
||||||
|
401:
|
||||||
|
description: "UNAUTHORIZED"
|
||||||
|
@ -0,0 +1,66 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\TicketBundle\Controller;
|
||||||
|
|
||||||
|
use Chill\TicketBundle\Action\Ticket\SetCallerCommand;
|
||||||
|
use Chill\TicketBundle\Action\Ticket\Handler\SetCallerCommandHandler;
|
||||||
|
use Chill\TicketBundle\Entity\Ticket;
|
||||||
|
use Doctrine\ORM\EntityManagerInterface;
|
||||||
|
use Symfony\Component\HttpFoundation\JsonResponse;
|
||||||
|
use Symfony\Component\HttpFoundation\Request;
|
||||||
|
use Symfony\Component\HttpFoundation\Response;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||||
|
use Symfony\Component\Routing\Annotation\Route;
|
||||||
|
use Symfony\Component\Security\Core\Security;
|
||||||
|
use Symfony\Component\Serializer\SerializerInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Controller for setting the caller of a ticket.
|
||||||
|
*/
|
||||||
|
final readonly class SetCallerApiController
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private SetCallerCommandHandler $setCallerCommandHandler,
|
||||||
|
private Security $security,
|
||||||
|
private EntityManagerInterface $entityManager,
|
||||||
|
private SerializerInterface $serializer,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
#[Route('/api/1.0/ticket/ticket/{id}/set-caller', name: 'chill_ticket_ticket_set_caller_api', requirements: ['id' => '\d+'], methods: ['POST'])]
|
||||||
|
public function setCaller(Ticket $ticket, Request $request): Response
|
||||||
|
{
|
||||||
|
if (!$this->security->isGranted('ROLE_USER')) {
|
||||||
|
throw new AccessDeniedHttpException('Only users are allowed to set ticket callers.');
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
/** @var SetCallerCommand $command */
|
||||||
|
$command = $this->serializer->deserialize(
|
||||||
|
$request->getContent(),
|
||||||
|
SetCallerCommand::class,
|
||||||
|
'json'
|
||||||
|
);
|
||||||
|
} catch (\Throwable $e) {
|
||||||
|
throw new BadRequestHttpException('Invalid request body: '.$e->getMessage(), $e);
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->setCallerCommandHandler->__invoke($ticket, $command);
|
||||||
|
|
||||||
|
$this->entityManager->flush();
|
||||||
|
|
||||||
|
return new JsonResponse(
|
||||||
|
$this->serializer->serialize($ticket, 'json', ['groups' => ['read']]),
|
||||||
|
json: true
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
@ -0,0 +1,200 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\TicketBundle\Tests\Controller;
|
||||||
|
|
||||||
|
use Chill\PersonBundle\Entity\Person;
|
||||||
|
use Chill\ThirdPartyBundle\Entity\ThirdParty;
|
||||||
|
use Chill\TicketBundle\Action\Ticket\Handler\SetCallerCommandHandler;
|
||||||
|
use Chill\TicketBundle\Action\Ticket\SetCallerCommand;
|
||||||
|
use Chill\TicketBundle\Controller\SetCallerApiController;
|
||||||
|
use Chill\TicketBundle\Entity\Ticket;
|
||||||
|
use Doctrine\ORM\EntityManagerInterface;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
|
use Symfony\Component\HttpFoundation\JsonResponse;
|
||||||
|
use Symfony\Component\HttpFoundation\Request;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
||||||
|
use Symfony\Component\Security\Core\Security;
|
||||||
|
use Symfony\Component\Serializer\SerializerInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*
|
||||||
|
* @coversNothing
|
||||||
|
*/
|
||||||
|
final class SetCallerApiControllerTest extends TestCase
|
||||||
|
{
|
||||||
|
use ProphecyTrait;
|
||||||
|
|
||||||
|
public function testSetCallerWithoutPermission(): void
|
||||||
|
{
|
||||||
|
$ticket = new Ticket();
|
||||||
|
$request = new Request();
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('ROLE_USER')->willReturn(false);
|
||||||
|
|
||||||
|
$setCallerCommandHandler = $this->prophesize(SetCallerCommandHandler::class);
|
||||||
|
$entityManager = $this->prophesize(EntityManagerInterface::class);
|
||||||
|
$serializer = $this->prophesize(SerializerInterface::class);
|
||||||
|
|
||||||
|
$controller = new SetCallerApiController(
|
||||||
|
$setCallerCommandHandler->reveal(),
|
||||||
|
$security->reveal(),
|
||||||
|
$entityManager->reveal(),
|
||||||
|
$serializer->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->expectException(AccessDeniedHttpException::class);
|
||||||
|
$controller->setCaller($ticket, $request);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testSetCallerWithInvalidRequestBody(): void
|
||||||
|
{
|
||||||
|
$ticket = new Ticket();
|
||||||
|
$request = new Request([], [], [], [], [], [], 'invalid json');
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('ROLE_USER')->willReturn(true);
|
||||||
|
|
||||||
|
$setCallerCommandHandler = $this->prophesize(SetCallerCommandHandler::class);
|
||||||
|
$entityManager = $this->prophesize(EntityManagerInterface::class);
|
||||||
|
|
||||||
|
$serializer = $this->prophesize(SerializerInterface::class);
|
||||||
|
$serializer->deserialize('invalid json', SetCallerCommand::class, 'json')
|
||||||
|
->willThrow(new \Exception('Invalid JSON'));
|
||||||
|
|
||||||
|
$controller = new SetCallerApiController(
|
||||||
|
$setCallerCommandHandler->reveal(),
|
||||||
|
$security->reveal(),
|
||||||
|
$entityManager->reveal(),
|
||||||
|
$serializer->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->expectException(BadRequestHttpException::class);
|
||||||
|
$controller->setCaller($ticket, $request);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testSetCallerWithValidRequest(): void
|
||||||
|
{
|
||||||
|
$ticket = new Ticket();
|
||||||
|
$request = new Request([], [], [], [], [], [], '{"caller": {"id": 123, "type": "person"}}');
|
||||||
|
|
||||||
|
$person = new Person();
|
||||||
|
$command = new SetCallerCommand($person);
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('ROLE_USER')->willReturn(true);
|
||||||
|
|
||||||
|
$serializer = $this->prophesize(SerializerInterface::class);
|
||||||
|
$serializer->deserialize('{"caller": {"id": 123, "type": "person"}}', SetCallerCommand::class, 'json')
|
||||||
|
->willReturn($command);
|
||||||
|
$serializer->serialize($ticket, 'json', ['groups' => ['read']])
|
||||||
|
->willReturn('{}')
|
||||||
|
->shouldBeCalled();
|
||||||
|
|
||||||
|
$setCallerCommandHandler = $this->prophesize(SetCallerCommandHandler::class);
|
||||||
|
$setCallerCommandHandler->__invoke($ticket, $command)
|
||||||
|
->willReturn($ticket)
|
||||||
|
->shouldBeCalled();
|
||||||
|
|
||||||
|
$entityManager = $this->prophesize(EntityManagerInterface::class);
|
||||||
|
$entityManager->flush()->shouldBeCalled();
|
||||||
|
|
||||||
|
$controller = new SetCallerApiController(
|
||||||
|
$setCallerCommandHandler->reveal(),
|
||||||
|
$security->reveal(),
|
||||||
|
$entityManager->reveal(),
|
||||||
|
$serializer->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
|
$response = $controller->setCaller($ticket, $request);
|
||||||
|
|
||||||
|
$this->assertInstanceOf(JsonResponse::class, $response);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testSetCallerWithThirdParty(): void
|
||||||
|
{
|
||||||
|
$ticket = new Ticket();
|
||||||
|
$request = new Request([], [], [], [], [], [], '{"caller": {"id": 456, "type": "thirdParty"}}');
|
||||||
|
|
||||||
|
$thirdParty = $this->prophesize(ThirdParty::class)->reveal();
|
||||||
|
$command = new SetCallerCommand($thirdParty);
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('ROLE_USER')->willReturn(true);
|
||||||
|
|
||||||
|
$serializer = $this->prophesize(SerializerInterface::class);
|
||||||
|
$serializer->deserialize('{"caller": {"id": 456, "type": "thirdParty"}}', SetCallerCommand::class, 'json')
|
||||||
|
->willReturn($command);
|
||||||
|
$serializer->serialize($ticket, 'json', ['groups' => ['read']])
|
||||||
|
->willReturn('{}')
|
||||||
|
->shouldBeCalled();
|
||||||
|
|
||||||
|
$setCallerCommandHandler = $this->prophesize(SetCallerCommandHandler::class);
|
||||||
|
$setCallerCommandHandler->__invoke($ticket, $command)
|
||||||
|
->willReturn($ticket)
|
||||||
|
->shouldBeCalled();
|
||||||
|
|
||||||
|
$entityManager = $this->prophesize(EntityManagerInterface::class);
|
||||||
|
$entityManager->flush()->shouldBeCalled();
|
||||||
|
|
||||||
|
$controller = new SetCallerApiController(
|
||||||
|
$setCallerCommandHandler->reveal(),
|
||||||
|
$security->reveal(),
|
||||||
|
$entityManager->reveal(),
|
||||||
|
$serializer->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
|
$response = $controller->setCaller($ticket, $request);
|
||||||
|
|
||||||
|
$this->assertInstanceOf(JsonResponse::class, $response);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testSetCallerToNull(): void
|
||||||
|
{
|
||||||
|
$ticket = new Ticket();
|
||||||
|
$request = new Request([], [], [], [], [], [], '{"caller": null}');
|
||||||
|
|
||||||
|
$command = new SetCallerCommand(null);
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('ROLE_USER')->willReturn(true);
|
||||||
|
|
||||||
|
$serializer = $this->prophesize(SerializerInterface::class);
|
||||||
|
$serializer->deserialize('{"caller": null}', SetCallerCommand::class, 'json')
|
||||||
|
->willReturn($command);
|
||||||
|
$serializer->serialize($ticket, 'json', ['groups' => ['read']])
|
||||||
|
->willReturn('{}')
|
||||||
|
->shouldBeCalled();
|
||||||
|
|
||||||
|
$setCallerCommandHandler = $this->prophesize(SetCallerCommandHandler::class);
|
||||||
|
$setCallerCommandHandler->__invoke($ticket, $command)
|
||||||
|
->willReturn($ticket)
|
||||||
|
->shouldBeCalled();
|
||||||
|
|
||||||
|
$entityManager = $this->prophesize(EntityManagerInterface::class);
|
||||||
|
$entityManager->flush()->shouldBeCalled();
|
||||||
|
|
||||||
|
$controller = new SetCallerApiController(
|
||||||
|
$setCallerCommandHandler->reveal(),
|
||||||
|
$security->reveal(),
|
||||||
|
$entityManager->reveal(),
|
||||||
|
$serializer->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
|
$response = $controller->setCaller($ticket, $request);
|
||||||
|
|
||||||
|
$this->assertInstanceOf(JsonResponse::class, $response);
|
||||||
|
}
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user