summaryrefslogtreecommitdiff
path: root/opendc/api/v1/experiments/experimentId/room-states/endpoint.py
blob: 9e283d349fdec8fd80cf9a5325b4720e588c60b2 (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
from opendc.models.experiment import Experiment
from opendc.models.room_state import RoomState
from opendc.util import database, exceptions
from opendc.util.rest import Response

def GET(request):
    """Get this Experiment's Room States."""

    # Make sure required parameters are there

    try:
        request.check_required_parameters(
            path = {
                'experimentId': 'int'
            }
        )

    except exceptions.ParameterError as e:
        return Response(400, e.message)

    # Instantiate an Experiment from the database

    experiment = Experiment.from_primary_key((request.params_path['experimentId'],))

    # Make sure this Experiment exisits

    if not experiment.exists():
        return Response(404, '{} not found.'.format(experiment))

    # Make sure this user is authorized to view this Experiment's Room States

    if not experiment.google_id_has_at_least(request.google_id, 'VIEW'):
        return Response(403, 'Forbidden from viewing Room States for {}.'.format(experiment))

    # Get and return the Room States

    if 'tick' in request.params_query:
        room_states = RoomState.from_experiment_id_and_tick(
            request.params_path['experimentId'],
            request.params_query['tick']
        )

    else:
        room_states = RoomState.from_experiment_id(request.params_path['experimentId'])

    return Response(
        200,
        'Successfully retrieved Room States for {}.'.format(experiment),
        [x.to_JSON() for x in room_states]
    )