views.py 14.6 KB
Newer Older
David Haynes's avatar
David Haynes committed
1 2
#!/usr/bin/env python
# -*- coding: utf-8 -*-
3
"""
4 5
api/views.py

6
Rest Framework Class Views
David Haynes's avatar
David Haynes committed
7 8 9

Each ViewSet determines what data is returned when an API endpoint is hit. In
addition, we define filtering and documentation for each of these endpoints. 
10
"""
11 12 13
# Python std. lib. imports
import datetime

14
# App Imports
David Haynes's avatar
David Haynes committed
15
from .models import Facility, OpenTime, Category, Schedule, Location, Alert
16 17 18 19 20 21 22 23
from .serializers import (
    CategorySerializer,
    FacilitySerializer,
    ScheduleSerializer,
    OpenTimeSerializer,
    LocationSerializer,
    AlertSerializer,
)
24

25
# Other Imports
David Haynes's avatar
David Haynes committed
26 27
from rest_framework import viewsets, filters
from django_filters.rest_framework import DjangoFilterBackend
28

29

David Haynes's avatar
David Haynes committed
30 31
class AlertViewSet(viewsets.ReadOnlyModelViewSet):
    """
32 33 34
    Some type of notification that is displayed to clients that conveys a message.

    Past examples include:
David Haynes's avatar
David Haynes committed
35 36 37 38 39

    - Random closings
    - Modified schedules being in effect
    - Election reminder
    - Advertising for other SRCT projects
40 41 42

    Alerts last for a period of time until the information is no longer dank.

David Haynes's avatar
David Haynes committed
43 44 45 46 47 48
    ---

    ## Default behavior

    [GET /api/alerts/](/api/alerts/?format=json)

David Haynes's avatar
David Haynes committed
49
    Return all active Alert objects.
50

David Haynes's avatar
David Haynes committed
51 52 53 54 55
    ## Built-in query parameters

    ### **Search**

    [GET /api/alerts/?search=](/api/alerts/?search=&format=json)
56 57 58

    Query parameter that returns objects that match a keyword provided in the search.

David Haynes's avatar
David Haynes committed
59 60 61 62 63 64 65 66 67 68
    **Example Usage**

    [GET /api/alerts/?search=srct](/api/alerts/?search=srct&format=json)

    Return any Alert objects that have the string "srct" located in one of its fields.

    ### **Ordering**

    [GET /api/alerts/?ordering=](/api/alerts/?ordering=&format=json)

69 70
    Query parameter that orders the returned objects based on the provided field to order by.

David Haynes's avatar
David Haynes committed
71 72 73
    **Example Usage**

    [GET /api/alerts/?ordering=urgency_tag](/api/alerts/?ordering=urgency_tag&format=json)
74

David Haynes's avatar
David Haynes committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
    Return all Alert objects ordered by urgency_tag ascending.

    [GET /api/alerts/?ordering=-urgency_tag](/api/alerts/?ordering=-urgency_tag&format=json)

    Return all Alert objects ordered by urgency_tag descending.

    ### **Field filtering**

    You can query directly against any field.

    **Example Usage**

    [GET /api/alerts/?urgency_tag=major](/api/alerts/?urgency_tag=major&format=json)

    Return all Alert objects that are tagged as "major" urgency.
David Haynes's avatar
David Haynes committed
90 91 92 93 94 95 96 97

    ## Custom query parameters

    ### **all_alerts**

    [GET /api/alerts/?all_alerts](/api/alerts/?all_alerts&format=json)

    Return all Alert objects.
David Haynes's avatar
David Haynes committed
98
    """
99

100 101 102
    # All model fields that are available for filtering
    FILTER_FIELDS = (
        # Alert fields
103
        "urgency_tag",
David Haynes's avatar
David Haynes committed
104 105 106
        "subject",
        "body",
        "url",
107 108
        "start_datetime",
        "end_datetime",
109 110 111
    )

    # Associate a serializer with the ViewSet
David Haynes's avatar
David Haynes committed
112 113
    serializer_class = AlertSerializer

114 115 116 117
    search_fields = FILTER_FIELDS
    ordering_fields = FILTER_FIELDS
    filter_fields = FILTER_FIELDS

David Haynes's avatar
David Haynes committed
118
    def get_queryset(self):
119 120 121 122
        """
        Handle incoming GET requests and enumerate objects that get returned by
        the API.
        """
David Haynes's avatar
David Haynes committed
123
        # Define ?all_alerts
124
        all_alerts = self.request.query_params.get("all_alerts", None)
David Haynes's avatar
David Haynes committed
125 126 127 128 129 130 131

        # Return all Alert objects if requested
        if all_alerts is not None:
            return Alert.objects.all()
        # Default behavior
        else:
            # Enumerate all Alert objects that are active
132
            alertable = [alert.pk for alert in Alert.objects.all() if alert.is_active()]
David Haynes's avatar
David Haynes committed
133 134
            # Return active Alerts
            return Alert.objects.filter(pk__in=alertable)
David Haynes's avatar
David Haynes committed
135

136

137
class CategoryViewSet(viewsets.ReadOnlyModelViewSet):
138
    """
139 140
    A Category is a grouping of Facilities that serve a common/similar purpose.

David Haynes's avatar
David Haynes committed
141 142 143 144 145 146 147 148 149 150 151
    Examples:

    - Dining
    - Gyms
    - Study areas (Libraries, The Ridge, JC, etc)

    ---

    ## Default behavior

    [GET /api/categories/](/api/categories/)
152

David Haynes's avatar
David Haynes committed
153
    Return all Category objects.
154

David Haynes's avatar
David Haynes committed
155 156 157 158 159
    ## Built-in query parameters

    ### **Search**

    [GET /api/categories/?search=](/api/categories/?search=&format=json)
160 161 162

    Query parameter that returns objects that match a keyword provided in the search.

David Haynes's avatar
David Haynes committed
163 164 165 166 167 168 169 170 171 172
    **Example Usage**

    [GET /api/categories/?search=din](/api/categories/?search=din&format=json)

    Return all Category objects that have a field that matches the string "din".

    ### **Ordering**

    [GET /api/categories/?ordering=](/api/categories/?ordering=&format=json)

173 174
    Query parameter that orders the returned objects based on the provided field to order by.

David Haynes's avatar
David Haynes committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
    **Example Usage**

    [GET /api/categories/?ordering=name](/api/categories/?ordering=name&format=json)

    Return all Category objects filtered by name ascending.

    [GET /api/categories/?ordering=-name](/api/categories/?ordering=-name&format=json)

    Return all Category objects filtered by name descending.

    ### **Field filtering**

    You can query directly against any field.

    **Example Usage**
190

David Haynes's avatar
David Haynes committed
191 192 193
    [GET /api/categories/?name=dining](/api/categories/?name=dining&format=json)

    Return the Category object that is named "dining".
194
    """
195

196 197 198
    # All model fields that are available for filtering
    FILTER_FIELDS = (
        # Category fields
199
        "name",
200 201 202
    )

    # Associate a serializer with the ViewSet
203 204
    serializer_class = CategorySerializer

205
    
206 207 208 209
    search_fields = FILTER_FIELDS
    ordering_fields = FILTER_FIELDS
    filter_fields = FILTER_FIELDS

David Haynes's avatar
David Haynes committed
210
    def get_queryset(self):
211 212 213 214
        """
        Handle incoming GET requests and enumerate objects that get returned by
        the API.
        """
David Haynes's avatar
David Haynes committed
215 216
        return Category.objects.all()

217

David Haynes's avatar
David Haynes committed
218 219
class LocationViewSet(viewsets.ReadOnlyModelViewSet):
    """
220 221
    Represents a specific location that a Facility can be found.

David Haynes's avatar
David Haynes committed
222 223 224 225 226 227
    ---

    ## Default behavior

    [GET /api/locations/](/api/locations/?format=json)

David Haynes's avatar
David Haynes committed
228
    Return all Location objects.
229

David Haynes's avatar
David Haynes committed
230 231 232 233 234
    ## Built-in query parameters

    ### **Search**

    [GET /api/locations/?search=](/api/locations/?search=&format=json)
235 236 237

    Query parameter that returns objects that match a keyword provided in the search.

David Haynes's avatar
David Haynes committed
238 239 240 241 242 243 244 245 246 247 248
    **Example Usage**

    [GET /api/locations/?search=johnson](/api/locations/?search=johnson&format=json)

    Return all Location objects that have a field that matches the "johnson" string.

    ### **Ordering**

    Order the returned objects based on the provided field.

    [GET /api/locations/?ordering=](/api/locations/?ordering=&format=json)
249

David Haynes's avatar
David Haynes committed
250
    **Example Usage**
251

David Haynes's avatar
David Haynes committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    [GET /api/locations/?ordering=building](/api/locations/?ordering=building&format=json)

    Return all Location objects ordered by building name ascending.

    [GET /api/locations/?ordering=-building](/api/locations/?ordering=-building&format=json)

    Return all Location objects ordered by building name descending.

    ### **Field filtering**

    You can query directly against any field.

    **Example Usage**

    [GET /api/locations/?building=Johnson+Center](/api/locations/?building=Johnson+Center&format=json)

    Return all Location objects located in the "Johnson Center" building.
David Haynes's avatar
David Haynes committed
269
    """
270

271 272 273
    # All model fields that are available for filtering
    FILTER_FIELDS = (
        # Location fields
274 275 276 277 278
        "building",
        "friendly_building",
        "address",
        "on_campus",
        "campus_region",
279 280 281
    )

    # Associate a serializer with the ViewSet
David Haynes's avatar
David Haynes committed
282 283
    serializer_class = LocationSerializer

284 285 286 287
    search_fields = FILTER_FIELDS
    ordering_fields = FILTER_FIELDS
    filter_fields = FILTER_FIELDS

David Haynes's avatar
David Haynes committed
288
    def get_queryset(self):
289 290 291 292
        """
        Handle incoming GET requests and enumerate objects that get returned by
        the API.
        """
David Haynes's avatar
David Haynes committed
293 294
        return Location.objects.all()

295

296
class FacilityViewSet(viewsets.ReadOnlyModelViewSet):
297
    """
298 299
    A Facility is some type of establishment that has a schedule of open hours and a location that serves a specific purpose that can be categorized.

David Haynes's avatar
David Haynes committed
300 301 302 303 304 305 306 307 308 309 310
    ---

    ## Default behavior

    [GET /api/facilities/](/api/facilities/?format=json)

    Return all Facility objects. Additionally, we filter out stale special_schedules to reduce client side calculations.

    ## Built-in query parameters

    ### **Search**
311

David Haynes's avatar
David Haynes committed
312
    [GET /api/facilities/?search=](/api/facilities/?search=&format=json)
David Haynes's avatar
David Haynes committed
313 314 315

    Query parameter that returns objects that match a keyword provided in the search.

David Haynes's avatar
David Haynes committed
316 317 318 319 320 321 322 323 324 325
    **Example Usage**

    [GET /api/facilities/?search=south](/api/facilities/?search=south&format=json)

    Return all Facility objects that have a field that matches the string "south".

    ### **Ordering**

    [GET /api/facilities/?ordering=](/api/facilities/?ordering=&format=json)

David Haynes's avatar
David Haynes committed
326 327
    Query parameter that orders the returned objects based on the provided field to order by.

David Haynes's avatar
David Haynes committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    **Example Usage**

    [GET /api/facilities/?ordering=facility_name](/api/facilities/?ordering=facility_name&format=json)

    Return all Facility objects ordered by facility_name ascending.

    [GET /api/facilities/?ordering=-facility_name](/api/facilities/?ordering=-facility_name&format=json)

    Return all Facility objects ordered by facility_name descending.

    ### **Field filtering**

    You can query directly against any field.

    **Example Usage**
David Haynes's avatar
David Haynes committed
343

David Haynes's avatar
David Haynes committed
344
    [GET /api/facilities/?facility_name=Southside](/api/facilities/?facility_name=Southside&format=json)
David Haynes's avatar
David Haynes committed
345

David Haynes's avatar
David Haynes committed
346
    Return the Facility object that has "Southside" as its name.
David Haynes's avatar
David Haynes committed
347

David Haynes's avatar
David Haynes committed
348
    ## Custom query parameters
David Haynes's avatar
David Haynes committed
349

David Haynes's avatar
David Haynes committed
350 351 352 353 354 355 356 357 358 359 360
    ### **open_now**

    [GET /api/facilities/?open_now](/api/facilities/?open_now&format=json)

    Only return open Facility objects.

    ### **closed_now**

    [GET /api/facilities/?closed_now](/api/facilities/?closed_now&format=json)

    Only return closed Facility objects.
361
    """
362

363
    # All model fields that are available for filtering
364 365
    FILTER_FIELDS = (
        # Facility fields
366 367 368 369 370 371
        "facility_name",
        "facility_classifier",
        "logo",
        "tapingo_url",
        "note",
        "facility_product_tags__name",
372
        # Category fields
373
        "facility_category__name",
374
        # Location fields
375 376 377 378 379
        "facility_location__building",
        "facility_location__friendly_building",
        "facility_location__address",
        "facility_location__on_campus",
        "facility_location__campus_region",
380
        # Schedule fields
381 382 383 384 385 386 387 388
        "main_schedule__name",
        "main_schedule__valid_start",
        "main_schedule__valid_end",
        "main_schedule__twenty_four_hours",
        "special_schedules__name",
        "special_schedules__valid_start",
        "special_schedules__valid_end",
        "special_schedules__twenty_four_hours",
389 390
    )

David Haynes's avatar
David Haynes committed
391
    # Associate a serializer with the ViewSet
392
    serializer_class = FacilitySerializer
393

394 395 396
    search_fields = FILTER_FIELDS
    ordering_fields = FILTER_FIELDS
    filter_fields = FILTER_FIELDS
397
    lookup_field = "slug"
398

399
    def get_queryset(self):
400
        """
401 402
        Handle incoming GET requests and enumerate objects that get returned by
        the API.
403
        """
David Haynes's avatar
David Haynes committed
404
        # Define ?open_now
405
        open_now = self.request.query_params.get("open_now", None)
David Haynes's avatar
David Haynes committed
406
        # Define ?closed_now
407
        closed_now = self.request.query_params.get("closed_now", None)
408

David Haynes's avatar
David Haynes committed
409 410
        if open_now is not None:
            open_now = [
411
                facility.pk for facility in Facility.objects.all() if facility.is_open()
David Haynes's avatar
David Haynes committed
412
            ]
David Haynes's avatar
David Haynes committed
413 414 415 416 417 418 419 420
            return Facility.objects.filter(pk__in=open_now)
        elif closed_now is not None:
            closed_now = [
                facility.pk
                for facility in Facility.objects.all()
                if not facility.is_open()
            ]
            return Facility.objects.filter(pk__in=closed_now)
421
        else:
David Haynes's avatar
David Haynes committed
422
            return Facility.objects.all()
423

424

425
class ScheduleViewSet(viewsets.ModelViewSet):
426
    """
427 428
    A period of time between two dates that represents the beginning and end of a "schedule" or rather, a collection of open times for a facility.

David Haynes's avatar
David Haynes committed
429 430 431 432 433 434
    ---

    ## Default behavior

    [GET /api/schedules/](/api/schedules/?format=json)

435
    Return all Schedule objects that have not expired. (ie. end_date is before today)
436

David Haynes's avatar
David Haynes committed
437 438 439 440 441
    ## Built-in query parameters

    ### **Search**

    [GET /api/schedules/?search=](/api/schedules/?search=&format=json)
442 443 444

    Query parameter that returns objects that match a keyword provided in the search.

David Haynes's avatar
David Haynes committed
445 446 447 448 449 450 451 452 453 454
    **Example Usage**

    [GET /api/schedules/?search=south](/api/schedules/?search=south&format=json)

    Return all Schedule objects that have a field matching the string "south".

    ### **Ordering**

    [GET /api/schedules/?ordering=](/api/schedules/?ordering=&format=json)

455 456
    Query parameter that orders the returned objects based on the provided field to order by.

David Haynes's avatar
David Haynes committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
    **Example Usage**

    [GET /api/schedules/?ordering=name](/api/schedules/?ordering=name&format=json)

    Return all Schedule objects ordered by name ascending.

    [GET /api/schedules/?ordering=-name](/api/schedules/?ordering=-name&format=json)

    [GET /api/schedules/?ordering=name](/api/schedules/?ordering=name&format=json)

    Return all Schedule objects ordered by name ascending.
    Return all Schedule objects ordered by name descending.

    ### **Field filtering**

    You can query directly against any field.

    **Example Usage**

    [GET /api/schedules/?name=southside_main](/api/schedules/?name=southside_main&format=json)
477

David Haynes's avatar
David Haynes committed
478
    Return the Schedule object that has "southside_main" as its name.
479
    """
480

481 482 483
    # All model fields that are available for filtering
    FILTER_FIELDS = (
        # Schedule fields
484 485 486 487
        "name",
        "valid_start",
        "valid_end",
        "twenty_four_hours",
488 489 490
    )

    # Associate a serializer with the ViewSet
491 492
    serializer_class = ScheduleSerializer

493 494 495 496
    search_fields = FILTER_FIELDS
    ordering_fields = FILTER_FIELDS
    filter_fields = FILTER_FIELDS

David Haynes's avatar
David Haynes committed
497
    def get_queryset(self):
498 499 500 501 502
        """
        Handle incoming GET requests and enumerate objects that get returned by
        the API.
        """
        # List of all schedules that are outdated
David Haynes's avatar
David Haynes committed
503 504 505 506 507
        filter_old_schedules = [
            schedule.pk
            for schedule in Schedule.objects.all()
            # If the schedule ended before today
            if schedule.valid_end and schedule.valid_start
508
            if schedule.valid_end < datetime.datetime.now(schedule.valid_end.tzinfo)
David Haynes's avatar
David Haynes committed
509
        ]
510 511
        # Return all Schedule objects that have not expired
        return Schedule.objects.exclude(pk__in=filter_old_schedules)
David Haynes's avatar
David Haynes committed
512

513

514
class OpenTimeViewSet(viewsets.ModelViewSet):
515
    """
516 517 518 519 520 521
    Represents a time period when a Facility is open.

    Monday = 0, Sunday = 6.

    These objects are returned within a larger Schedule object and thus are not
    an endpoint that is query-able, so just return everything when requested.
522
    """
523

524
    # Associate a serializer with the ViewSet
525
    serializer_class = OpenTimeSerializer
David Haynes's avatar
David Haynes committed
526 527

    def get_queryset(self):
528 529 530 531
        """
        Handle incoming GET requests and enumerate objects that get returned by
        the API.
        """
532
        return OpenTime.objects.all()