aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Courseware/PeerReview/ProcessesCreate.php
blob: 4f8099b707012fb54bed67fb0e81ac7fb0f3c037 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php

namespace JsonApi\Routes\Courseware\PeerReview;

use Courseware\PeerReviewProcess;
use Courseware\TaskGroup;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\JsonApiController;
use JsonApi\Routes\Courseware\Authority;
use JsonApi\Routes\TimestampTrait;
use JsonApi\Routes\ValidationTrait;
use JsonApi\Schemas\Courseware\PeerReviewProcess as PeerReviewProcessSchema;
use JsonApi\Schemas\Courseware\TaskGroup as TaskGroupSchema;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

/**
 * Create a PeerReviewProcess.
 *
 * @SuppressWarnings(PHPMD.StaticAccess)
 */
class ProcessesCreate extends JsonApiController
{
    use TimestampTrait;
    use ValidationTrait;

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     *
     * @param array $args
     *
     * @return Response
     */
    public function __invoke(Request $request, Response $response, $args)
    {
        $json = $this->validate($request);
        $taskGroup = $this->getTaskGroupFromJson($json);
        $user = $this->getUser($request);

        if (!Authority::canCreatePeerReviewProcesses($user, $taskGroup)) {
            throw new AuthorizationFailedException();
        }

        $process = $this->create($user, $json);

        return $this->getCreatedResponse($process);
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameters)
     *
     * @param array $json
     * @param mixed $data
     *
     * @return string|void
     */
    protected function validateResourceDocument($json, $data)
    {
        if (!self::arrayHas($json, 'data')) {
            return 'Missing `data` member at document“s top level.';
        }
        if (PeerReviewProcessSchema::TYPE !== self::arrayGet($json, 'data.type')) {
            return 'Invalid `type` of document“s `data`.';
        }
        if (self::arrayHas($json, 'data.id')) {
            return 'New document must not have an `id`.';
        }

        if (!self::arrayHas($json, 'data.attributes.configuration')) {
            return 'Missing `configuration` attribute.';
        }

        if (!self::arrayHas($json, 'data.attributes.review-start')) {
            return 'Missing `review-start` attribute.';
        }
        $startDate = self::arrayGet($json, 'data.attributes.review-start');
        if (!self::isValidTimestamp($startDate)) {
            return '`review-start` is not an ISO 8601 timestamp.';
        }

        if (!self::arrayHas($json, 'data.attributes.review-end')) {
            return 'Missing `review-end` attribute.';
        }
        $endDate = self::arrayGet($json, 'data.attributes.review-end');
        if (!self::isValidTimestamp($endDate)) {
            return '`review-end` is not an ISO 8601 timestamp.';
        }

        if (!self::arrayHas($json, 'data.relationships.task-group')) {
            return 'Missing `task-group` relationship.';
        }
        if (!$this->getTaskGroupFromJson($json)) {
            return 'Invalid `task-group` relationship.';
        }
    }

    private function getTaskGroupFromJson(array $json): ?TaskGroup
    {
        if (!$this->validateResourceObject($json, 'data.relationships.task-group', TaskGroupSchema::TYPE)) {
            return null;
        }
        $resourceId = self::arrayGet($json, 'data.relationships.task-group.data.id');

        return TaskGroup::find($resourceId);
    }

    private function create(\User $user, array $json): PeerReviewProcess
    {
        $taskGroup = $this->getTaskGroupFromJson($json);
        $startDate = self::fromISO8601(self::arrayGet($json, 'data.attributes.review-start'));
        $endDate = self::fromISO8601(self::arrayGet($json, 'data.attributes.review-end'));
        $configuration = self::arrayGet($json, 'data.attributes.configuration');

        $process = PeerReviewProcess::create([
            'task_group_id' => $taskGroup->getId(),
            'owner_id' => $user->getId(),
            'configuration' => $configuration,
            'review_start' => $startDate->getTimestamp(),
            'review_end' => $endDate->getTimestamp(),
        ]);

        return $process;
    }
}