models.py 12.9 KB
Newer Older
David Haynes's avatar
David Haynes committed
1
2
3
4
5
6
7
8
"""
api/models.py

Define the objects that will be stored in the database and later served through
the API.

https://docs.djangoproject.com/en/1.11/topics/db/models/
"""
9
10
11
12
13
14
15
16
# Future Imports
from __future__ import (absolute_import, division, print_function,
                        unicode_literals)

# Python stdlib Imports
import datetime

# Django Imports
17
from django.db import models
David Haynes's avatar
David Haynes committed
18
from django.contrib.gis.db.models import PointField
19
from django.contrib.auth.models import User
20
from django.core.validators import RegexValidator
David Haynes's avatar
David Haynes committed
21
22

# Other Imports
Ben Waters's avatar
Ben Waters committed
23
from model_utils.models import TimeStampedModel
24
from autoslug import AutoSlugField
25
from taggit.managers import TaggableManager
Tyler Hallada's avatar
Tyler Hallada committed
26

Ben Waters's avatar
Ben Waters committed
27
class Category(TimeStampedModel):
28
    """
David Haynes's avatar
David Haynes committed
29
30
31
32
33
34
35
    Represents the "category" that a Facility falls under. A Category is a
    grouping of Facilities that serve a common/similar purpose.

    ex.
    - Dining
    - Gyms
    - Study areas (Libraries, The Ridge, JC, etc)
36
    """
David Haynes's avatar
David Haynes committed
37
    # The name of the category
38
39
40
41
42
    name = models.CharField(max_length=100)

    class Meta:
        verbose_name = "category"
        verbose_name_plural = "categories"
43
        # Sort by name in admin view.
44
45
        ordering = ['name']

46
    def __str__(self):
David Haynes's avatar
David Haynes committed
47
48
49
50
        """
        String representation of a Category object.
        """
        return self.name
51

David Haynes's avatar
David Haynes committed
52
53
class Location(TimeStampedModel):
    """
54
    Represents a specific location that a Facility can be found.
David Haynes's avatar
David Haynes committed
55
    """
56
57
58
59
60
    # The building that the facility is located in (on campus).
    building = models.CharField(max_length=100)
    # The physical address of the facility.
    address = models.CharField(max_length=100)
    # Boolean for whether or not the location is "on campus" or not.
David Haynes's avatar
David Haynes committed
61
    on_campus = models.BooleanField(default=True)
David Haynes's avatar
David Haynes committed
62
63
    # A GeoJson coordinate pair that represents the physical location
    coordinate_location = PointField()
David Haynes's avatar
David Haynes committed
64

65
66
67
68
69
70
71
72
73
74
75
76
    class Meta:
        verbose_name = "location"
        verbose_name_plural = "locations"

    def __str__(self):
        """
        String representation of a Location object.
        """
        return 'Found in %s at %s | On Campus: %s' % (self.building,
                                                      self.address,
                                                      self.on_campus)

Ben Waters's avatar
Ben Waters committed
77
class Facility(TimeStampedModel):
David Haynes's avatar
David Haynes committed
78
    """
David Haynes's avatar
David Haynes committed
79
80
81
    Represents a specific facility location. 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
82
83
    """
    # The name of the Facility
David Haynes's avatar
David Haynes committed
84
    facility_name = models.CharField(max_length=100)
David Haynes's avatar
David Haynes committed
85
    # Instead of id
86
    slug = AutoSlugField(populate_from='facility_name', unique=True)
87

David Haynes's avatar
David Haynes committed
88
    # The category that this facility can be grouped with
89
    facility_category = models.ForeignKey('Category',
David Haynes's avatar
David Haynes committed
90
                                          related_name="categories")
David Haynes's avatar
David Haynes committed
91
    # The location object that relates to this facility
92
93
    facility_location = models.ForeignKey('Location',
                                          related_name="facilities")
94

David Haynes's avatar
David Haynes committed
95
    # The User(s) that claim ownership over this facility
96
    owners = models.ManyToManyField(User)
David Haynes's avatar
David Haynes committed
97
98

    # The schedule that is defaulted to if no special schedule is in effect
99
    main_schedule = models.ForeignKey('Schedule',
David Haynes's avatar
David Haynes committed
100
101
                                      related_name='facility_main')
    # A schedule that has a specific start and end date
102
    special_schedules = models.ManyToManyField('Schedule',
David Haynes's avatar
David Haynes committed
103
104
                                               related_name='facility_special',
                                               blank=True,
105
106
107
108
109
                                               help_text="""This schedule will
                                                            come into effect
                                                            only for its
                                                            specified duration.
                                                            """)
110
111
112
    # URL, if it exists, to the Tapingo page that is associated with this
    # facility
    tapingo_url = models.URLField(blank=True, validators=[RegexValidator(regex='^https:\/\/www.tapingo.com\/',
David Haynes's avatar
David Haynes committed
113
                                                                         message='The link is not a valid tapingo link. Example: https://www.tapingo.com/order/restaurant/starbucks-gmu-johnson/',
114
                                                                         code='invalid_tapingo_url')])
115
116
117
    # A comma seperate list of words that neatly an aptly describe the product
    # that this facility produces. (ex. for Taco Bell: mexican, taco, cheap)
    facility_product_tags = TaggableManager()
David Haynes's avatar
David Haynes committed
118

David Haynes's avatar
David Haynes committed
119
    def is_open(self):
120
        """
121
        Return true if this facility is currently open.
122

David Haynes's avatar
David Haynes committed
123
124
        First checks any valid special schedules and then checks the main,
        default, schedule.
125
        """
David Haynes's avatar
David Haynes committed
126
        # Get the current date
127
        today = datetime.datetime.today().date()
David Haynes's avatar
David Haynes committed
128
        # Check special schedules first, loop through all of them
129
130
131
        for schedule in self.special_schedules.all():
            # Special schedules must have valid_start and valid_end set
            if schedule.valid_start and schedule.valid_end:
David Haynes's avatar
David Haynes committed
132
                # If a special schedule in in effect
133
                if schedule.valid_start <= today <= schedule.valid_end:
David Haynes's avatar
David Haynes committed
134
135
136
137
                    # Check if the facility is open or not based on that 
                    # special schedule
                    if schedule.is_open_now():
                        # Open
138
                        return True
139
                    else:
David Haynes's avatar
David Haynes committed
140
                        # Closed
141
                        return False
David Haynes's avatar
David Haynes committed
142
143
144
145
        # If no special schedule is in effect then check if the facility is
        # open using the main_schedule
        if self.main_schedule.is_open_now():
            # Open
146
            return True
David Haynes's avatar
David Haynes committed
147
148
149
150
        else:
            # Closed
            return False

151
152
153
154
155
156
157
158
159
160
    def clean_special_schedules(self):
        """
        Loop through every special_schedule and remove entries that have
        expired.
        """
        for special_schedule in self.special_schedules.all():
            # If it ends before today
            if special_schedule.valid_end < datetime.date.today():
                self.special_schedules.remove(special_schedule)

David Haynes's avatar
David Haynes committed
161
162
163
164
    class Meta:
        verbose_name = "facility"
        verbose_name_plural = "facilities"
        # Sort by name in admin view
David Haynes's avatar
David Haynes committed
165
        ordering = ['facility_name']
166

167
    def __str__(self):
David Haynes's avatar
David Haynes committed
168
169
170
        """
        String representation of a Facility object.
        """
David Haynes's avatar
David Haynes committed
171
        return self.facility_name
172

Ben Waters's avatar
Ben Waters committed
173
class Schedule(TimeStampedModel):
174
    """
David Haynes's avatar
David Haynes committed
175
176
    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.
177
    """
David Haynes's avatar
David Haynes committed
178
    # The name of the schedule
Tyler Hallada's avatar
Tyler Hallada committed
179
    name = models.CharField(max_length=100)
David Haynes's avatar
David Haynes committed
180
181

    # The start date of the schedule
182
    # (inclusive)
183
    valid_start = models.DateField('Start Date', null=True, blank=True,
184
185
                                   help_text="""Date that this schedule goes
                                                into effect""")
David Haynes's avatar
David Haynes committed
186
187
    # The end date of the schedule
    # (inclusive)
188
    valid_end = models.DateField('End Date', null=True, blank=True,
189
190
191
                                 help_text="""Last day that this schedule is
                                              in effect""")

David Haynes's avatar
David Haynes committed
192
    def is_open_now(self):
193
194
195
        """
        Return true if this schedule is open right now.
        """
David Haynes's avatar
David Haynes committed
196
197
198
199
200
201
        # Loop through all the open times that correspond to this schedule
        for open_time in OpenTime.objects.filter(schedule=self):
            # If the current time we are looking at is open, then the schedule 
            # will say that the facility is open
            if open_time.is_open_now():
                # Open
202
                return True
David Haynes's avatar
David Haynes committed
203
        # Closed (all open times are not open)
204
205
        return False

David Haynes's avatar
David Haynes committed
206
207
208
209
    class Meta:
        # Sort by name in admin view
        ordering = ['name']

210
    def __str__(self):
David Haynes's avatar
David Haynes committed
211
212
213
        """
        String representation of a Schedule object.
        """
214
215
216
        return self.name


Ben Waters's avatar
Ben Waters committed
217
class OpenTime(TimeStampedModel):
218
    """
David Haynes's avatar
David Haynes committed
219
220
221
    Represents a time period when a Facility is open.

    Monday = 0, Sunday = 6.
222
    """
David Haynes's avatar
David Haynes committed
223
    # Define integer constants to represent days of the week
224
225
226
227
228
229
230
231
    MONDAY = 0
    TUESDAY = 1
    WEDNESDAY = 2
    THURSDAY = 3
    FRIDAY = 4
    SATURDAY = 5
    SUNDAY = 6

David Haynes's avatar
David Haynes committed
232
    # Tuple that ties a day of the week with an integer representation
233
234
235
236
237
238
239
240
241
242
    DAY_CHOICES = (
        (MONDAY, 'Monday'),
        (TUESDAY, 'Tuesday'),
        (WEDNESDAY, 'Wednesday'),
        (THURSDAY, 'Thursday'),
        (FRIDAY, 'Friday'),
        (SATURDAY, 'Saturday'),
        (SUNDAY, 'Sunday'),
    )

David Haynes's avatar
David Haynes committed
243
    # The schedule that this period of open time is a part of
244
    schedule = models.ForeignKey('Schedule', related_name='open_times')
David Haynes's avatar
David Haynes committed
245
246

    # The day that the open time begins on
247
    start_day = models.IntegerField(default=0, choices=DAY_CHOICES)
David Haynes's avatar
David Haynes committed
248
    # The day that the open time ends on
249
    end_day = models.IntegerField(default=0, choices=DAY_CHOICES)
David Haynes's avatar
David Haynes committed
250
251
252
253

    # The time of day that the open time begins at
    start_time = models.TimeField()
    # The time of day that the open time ends
254
255
    end_time = models.TimeField()

David Haynes's avatar
David Haynes committed
256
    def is_open_now(self):
257
        """
David Haynes's avatar
David Haynes committed
258
        Return true if the current time is this OpenTime's range.
259
        """
David Haynes's avatar
David Haynes committed
260
        # Get the current datetime
261
        today = datetime.datetime.today()
David Haynes's avatar
David Haynes committed
262
        # Check that the start occurs before the end
263
        if self.start_day <= self.end_day:
David Haynes's avatar
David Haynes committed
264
            # If today is the start_day
265
            if self.start_day == today.weekday():
David Haynes's avatar
David Haynes committed
266
                # If the start_time has not occurred
267
                if self.start_time > today.time():
David Haynes's avatar
David Haynes committed
268
                    # Closed
269
                    return False
David Haynes's avatar
David Haynes committed
270
            # If the start_day has not occurred
271
            elif self.start_day > today.weekday():
David Haynes's avatar
David Haynes committed
272
                # Closed
273
                return False
David Haynes's avatar
David Haynes committed
274
            # If the end_day is today
275
            if self.end_day == today.weekday():
David Haynes's avatar
David Haynes committed
276
                # If the end_time has already occurred
277
                if self.end_time < today.time():
David Haynes's avatar
David Haynes committed
278
                    # Closed
279
                    return False
David Haynes's avatar
David Haynes committed
280
            # If the end_day has already occurred
281
            elif self.end_day < today.weekday():
David Haynes's avatar
David Haynes committed
282
                # Closed
283
                return False
David Haynes's avatar
David Haynes committed
284
        # The end_day > start_day
285
        else:
David Haynes's avatar
David Haynes committed
286
            # If today is the start_day
287
            if self.start_day == today.weekday():
David Haynes's avatar
David Haynes committed
288
                # If the start_time has not occurred
289
                if self.start_time > today.time():
David Haynes's avatar
David Haynes committed
290
                    # Closed
291
                    return False
David Haynes's avatar
David Haynes committed
292
            # If the end_day is today
293
            if self.end_day == today.weekday():
David Haynes's avatar
David Haynes committed
294
                # If the end_time has already occurred
295
                if self.end_time < today.time():
David Haynes's avatar
David Haynes committed
296
                    # Closed
297
                    return False
David Haynes's avatar
David Haynes committed
298
299
            # If the current date takes place after the end_date but before
            # start_day
300
            if self.end_day < today.weekday() < self.start_day:
David Haynes's avatar
David Haynes committed
301
                # Closed
302
                return False
David Haynes's avatar
David Haynes committed
303
        # All checks passed, it's Open
304
        return True
305

306
    def __str__(self):
David Haynes's avatar
David Haynes committed
307
308
309
        """
        String representation of a OpenTime object.
        """
310
        weekdays = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday',
311
                    'Saturday', 'Sunday']
312
        return '%s %s to %s %s' % (weekdays[self.start_day],
313
314
315
316
                                   self.start_time.strftime("%H:%M:%S"),
                                   # to
                                   weekdays[self.end_day],
                                   self.end_time.strftime("%H:%M:%S"))
David Haynes's avatar
David Haynes committed
317
318
319
320
321
322
323
324
325
326

class Alert(TimeStampedModel):
    """
    Some type of notification that is displayed to clients that conveys a
    message. Past examples include: random closings, modified schedules being
    in effect, election reminder, advertising for other SRCT projects.

    Alerts last for a period of time until the information is no longer dank.
    """
    # Define string constants to represent urgency tag levels
327
328
329
330
    INFO = 'info'  # SRCT announcements
    MINOR = 'minor'  # Holiday hours are in effect
    MAJOR = 'major'  # The hungry patriot is closed today
    EMERGENCY = 'emergency'  # Extreme weather
David Haynes's avatar
David Haynes committed
331

David Haynes's avatar
David Haynes committed
332
    # Tuple that ties a urgency tag with a string representation
David Haynes's avatar
David Haynes committed
333
334
    URGENCY_CHOICES = (
        (INFO, 'Info'),
335
        (MINOR, 'Minor'),
David Haynes's avatar
David Haynes committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
        (MAJOR, 'Major'),
        (EMERGENCY, 'Emergency'),
    )

    # The urgency tag for this Alert
    urgency_tag = models.CharField(max_length=10, default='Info',
                                   choices=URGENCY_CHOICES)

    # The text that is displayed that describes the Alert
    message = models.CharField(max_length=140)

    # The date + time that the alert will be start being served
    start_datetime = models.DateTimeField()

    # The date + time that the alert will stop being served
    end_datetime = models.DateTimeField()

    def __str__(self):
        """
        String representation of an Alert object.
        """
David Haynes's avatar
David Haynes committed
357
        return "%s" % (self.message)