-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmodels.py
707 lines (591 loc) · 25.4 KB
/
models.py
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
from datetime import datetime
import json
from google.appengine.api.datastore_errors import BadValueError
from google.appengine.ext.ndb.key import Key
from gaebasepy.gc_models import GCModel, GCModelMtoMNoRep, GCUser
from gaebasepy.gc_utils import date_to_js_timestamp, date_from_js_timestamp
from gaebasepy.exceptions import AuthenticationError, BadParameters
__author__ = 'fab,stefano.tranquillini'
from google.appengine.ext import ndb
from google.appengine.api import search
# TODO create a GCMOdel for the support table that automatically has the get/build id
class Version(ndb.Model):
# to keep the version of the current app. Iman idea.
type = ndb.StringProperty(choices=['production', 'demo', 'test'])
current = ndb.StringProperty(required=True)
class Log(ndb.Model):
# Log of the app. Iman idea.
data = ndb.JsonProperty()
recorded = ndb.DateTimeProperty(auto_now=True)
class User(GCUser):
# the user object, it's an expando class.
# this to save writing ops. only email can be used.
_default_indexed = False
email = ndb.StringProperty(indexed=True, required=True, default="[email protected]")
# some handy queries already implemented.
@property
def member_of(self):
return ClubMembership.query(ndb.AND(ClubMembership.member == self.key,
ClubMembership.membership_type == "MEMBER",
ClubMembership.is_active == True))
@property
def trainer_of(self):
return ClubMembership.query(ndb.AND(ClubMembership.member == self.key,
ClubMembership.membership_type == "TRAINER",
ClubMembership.is_active == True))
@property
def owner_of(self):
return ClubMembership.query(ndb.AND(ClubMembership.member == self.key,
ClubMembership.membership_type == "OWNER",
ClubMembership.is_active == True))
@property
def owner_or_trainer_of(self):
return ClubMembership.query(ClubMembership.member == self.key,
ndb.OR(ClubMembership.membership_type == "OWNER",
ClubMembership.membership_type == "TRAINER"),
ClubMembership.is_active == True)
def member_of_type(self, membership_types=None):
if not membership_types: membership_types = []
return ClubMembership.query(ndb.AND(ClubMembership.member == self.key,
ClubMembership.membership_type.IN(membership_types),
ClubMembership.is_active == True))
def membership_type(self, club):
membership = ndb.Key(ClubMembership, ClubMembership.build_id(self, club)).get()
if membership and membership.is_active:
return membership.membership_type
raise AuthenticationError("User is not connected to the Club")
# to save time in rendering the user.
def to_dict(self):
d = super(User, self).to_dict()
del d['updated']
del d['created']
del d['auth_ids']
del d['password']
return d
def _post_put_hook(self, future):
# create the search doc
user_doc = search.Document(
doc_id=self.id,
fields=[
search.TextField(name='name', value=self.name),
search.TextField(name='email', value=self.email),
search.TextField(name='nickname', value=self.nickname)
])
index = search.Index(name="users")
index.put(user_doc)
# this is needed for the realtime API, now is inside the model calls
# deferred.defer(sync_user, self)
class Course(GCModel):
name = ndb.StringProperty(required=True)
description = ndb.StringProperty(required=True)
course_type = ndb.StringProperty(choices=['SCHEDULED', 'PROGRAM', 'FREE'], required=True, default="SCHEDULED")
start_date = ndb.DateTimeProperty()
end_date = ndb.DateTimeProperty()
duration = ndb.IntegerProperty()
club = ndb.KeyProperty('Club', required=True)
is_deleted = ndb.BooleanProperty(default=False)
profile = ndb.JsonProperty()
max_level = ndb.IntegerProperty()
def _pre_put_hook(self):
if isinstance(self.profile, str):
try:
self.profile = json.loads(self.profile)
except Exception:
raise BadValueError("Profile must be a valid json")
# @property
# def max_level(self):
# if not self.profile:
# # if there's no profile, then get the levels of the first activity
# if not self.list_exercises:
# return 0
# else:
# return len(self.list_exercises[0].get().levels)
# else:
# return len(self.profile)
@property
def active(self):
return not self.is_deleted
# levels or profile to be added
def safe_delete(self):
# NOTE: this requires to use .is_deleted == False in the queries. (update the index)
self.is_deleted = True
self.put()
@property
def subscribers(self):
return CourseSubscription.query(ndb.AND(CourseSubscription.course == self.key,
CourseSubscription.is_active == True,
CourseSubscription.status == "ACCEPTED"))
@property
def trainers(self):
return CourseTrainers.query(ndb.AND(CourseTrainers.course == self.key,
CourseTrainers.is_active == True))
def to_dict(self):
# for the output
result = super(Course, self).to_dict()
if self.course_type != "SCHEDULED":
del result['end_date']
del result['start_date']
if self.course_type != "PROGRAM":
del result['duration']
return result
def is_valid(self):
# check for the update/creation.
if self.course_type == "SCHEDULED":
if not self.start_date:
return False, "Entity has uninitialized properties: start_date"
if not self.end_date:
return False, "Entity has uninitialized properties: end_date"
if not self.start_date <= self.end_date:
return False, "Start date should be before end date"
if self.course_type == "PROGRAM":
if not self.duration:
return False, "Entity has uninitialized properties: duration"
if not self.max_level:
if not self.profile:
return False, "Either 'maxLevel' or 'profile' must be set"
return True
def populate(self, **kwds):
# convert date to python date
if 'start_date' in kwds:
kwds['start_date'] = date_from_js_timestamp(kwds['start_date'])
if 'end_date' in kwds:
kwds['end_date'] = date_from_js_timestamp(kwds['end_date'])
super(Course, self).populate(**kwds)
class CourseTrainers(GCModelMtoMNoRep):
# Probably can be put as a repeated property, the number of trainers should be limited in a club..
# http://docs.gymcentralapi.apiary.io/#reference/training-subscription
# probably is worth switching to this structure http://stackoverflow.com/a/27837999/1257185
member = ndb.KeyProperty(kind='User', required=True)
course = ndb.KeyProperty(kind='Course', required=True)
is_active = ndb.BooleanProperty(default=True)
creation_date = ndb.DateTimeProperty(auto_now=True)
@property
def active(self):
return self.is_active
class Observation(GCModel):
created_by = ndb.KeyProperty(kind='User', required=False)
text = ndb.StringProperty()
when = ndb.DateTimeProperty(auto_now=True)
class CourseSubscription(GCModelMtoMNoRep):
# http://docs.gymcentralapi.apiary.io/#reference/training-subscription
member = ndb.KeyProperty(kind='User', required=True)
course = ndb.KeyProperty(kind='Course', required=True)
is_active = ndb.BooleanProperty(default=True)
status = ndb.StringProperty(choices=["ACCEPTED", "DECLINED", "PENDING"], default="PENDING",
required=True)
profile_level = ndb.IntegerProperty(default=1, required=True)
# list of exercise i can't do.
disabled_exercises = ndb.KeyProperty(kind='Exercise', repeated=True)
increase_level = ndb.BooleanProperty(default=False, required=True)
feedback = ndb.StringProperty(choices=["ACCEPTED", "DECLINED", "PENDING"], default="PENDING",
required=True)
observations = ndb.StructuredProperty(Observation, repeated=True)
start_date = ndb.DateTimeProperty(auto_now_add=True)
end_date = ndb.DateTimeProperty()
def to_dict(self):
result = super(CourseSubscription, self).to_dict()
course = self.course.get()
result['max_level']=course.max_level
result['profile']=course.profile
return result
class ClubMembership(GCModelMtoMNoRep):
# probably is worth switching to this structure http://stackoverflow.com/a/27837999/1257185
member = ndb.KeyProperty(kind='User', required=True)
club = ndb.KeyProperty(kind='Club', required=True)
is_active = ndb.BooleanProperty(default=True)
membership_type = ndb.StringProperty(choices=["MEMBER", "TRAINER", "OWNER"], default="MEMBER",
required=True)
status = ndb.StringProperty(choices=["ACCEPTED", "DECLINED", "PENDING"], default="PENDING",
required=True)
creation_date = ndb.DateTimeProperty(auto_now=True)
end_date = ndb.DateTimeProperty()
"""
TODO: do we need an end date here? how does this affect the queries?
it can be used with a cron job that sets active=false if today>end_date
"""
@property
def active(self):
return self.is_active
@property
def get_member(self):
return self.member.get()
@property
def get_club(self):
return self.club.get()
class Club(GCModel):
# GCModel has id and safe_key
creation_date = ndb.DateTimeProperty(auto_now_add=True)
update_date = ndb.DateTimeProperty(auto_now=True)
name = ndb.StringProperty(required=True)
email = ndb.StringProperty(required=False)
description = ndb.StringProperty()
url = ndb.StringProperty(required=True)
is_deleted = ndb.BooleanProperty(default=False)
language = ndb.StringProperty(default="en", required=True)
training_type = ndb.StringProperty(repeated=True, indexed=True)
is_open = ndb.BooleanProperty(default=True)
tags = ndb.StringProperty(repeated=True)
def is_valid(self):
# this has to be implemented, used by the put
return True
def safe_delete(self):
self.is_deleted = True
self.is_open = False
self.put()
@property
def active(self):
return not self.is_deleted
@property
def all_memberships(self):
return ClubMembership.query(ndb.AND(ClubMembership.club == self.key,
ClubMembership.is_active == True))
@property
def members(self):
return self.all_memberships.filter(ClubMembership.membership_type == "MEMBER")
@property
def trainers(self):
return self.all_memberships.filter(ClubMembership.membership_type == "TRAINER")
@property
def owners(self):
return self.all_memberships.filter(ClubMembership.membership_type == "OWNER")
def _post_put_hook(self, future):
# create the search doc
club_doc = search.Document(
doc_id=self.id,
fields=[
search.TextField(name='name', value=self.name),
search.TextField(name='email', value=self.email),
search.TextField(name='description', value=self.description),
search.TextField(name='tags', value=" ".join(self.tags))
])
index = search.Index(name="clubs")
index.put(club_doc)
# these methods are not used anymore, there's the query()
# @classmethod
# def get_by_email(cls, email, **kwargs):
# return cls.query(cls.email == email), kwargs
#
# @classmethod
# def get_by_language(cls, language, **kwargs):
# return cls.query().filter(cls.language == language), kwargs
#
# @classmethod
# def get_by_training(cls, training, **kwargs):
# return cls.query(cls.training_type.IN(training)), kwargs
class Session(GCModel):
name = ndb.StringProperty(required=True)
url = ndb.StringProperty(required=False, default="")
session_type = ndb.StringProperty(choices=["LIVE", "JOINT", "SINGLE"], required=True)
# only if schedule
start_date = ndb.DateTimeProperty(auto_now_add=False)
end_date = ndb.DateTimeProperty(auto_now_add=False)
# only if program
week_no = ndb.IntegerProperty()
day_no = ndb.IntegerProperty()
canceled = ndb.BooleanProperty(default=False, required=True)
course = ndb.KeyProperty(kind="Course", required=True)
# TODO: maybe needs order. it's a list, they can just send a new list
list_exercises = ndb.KeyProperty(kind="Exercise", repeated=True)
meta_data = ndb.JsonProperty()
on_before = ndb.KeyProperty(kind='Indicator', repeated=True)
on_after = ndb.KeyProperty(kind='Indicator', repeated=True)
status = ndb.ComputedProperty(lambda self: self._compute_status())
@property
def active(self):
return not self.canceled
@property
def get_on_before(self):
return ndb.get_multi(self.on_before)
@property
def get_on_after(self):
return ndb.get_multi(self.on_after)
@property
def get_exercises(self):
return ndb.get_multi(self.list_exercises)
def is_valid(self):
# check for the update/creation.
course = self.course.get()
course_type = course.course_type
if self.session_type == "SINGLE":
if not self.url:
return False, "Entity has uninitialized properties: url"
if course_type == "SCHEDULED":
if not self.start_date:
return False, "Entity has uninitialized properties: start_date"
if not self.end_date:
return False, "Entity has uninitialized properties: end_date"
if not self.start_date <= self.end_date:
return False, "Start date should be before end date"
if self.start_date < course.start_date or self.start_date > course.end_date:
return False, "Start date should be after the course start date and before the end"
if self.end_date < course.start_date or self.end_date > course.end_date:
return False, "End date should be after the course start date and before the end"
if course_type == "PROGRAM":
if not self.week_no:
return False, "Entity has uninitialized properties: week_no"
if not self.day_no:
return False, "Entity has uninitialized properties: day_no"
return True
@property
def max_level(self):
return self.course.get().max_level
@property
def profile(self):
return self.course.get().profile
def to_dict(self):
result = super(Session, self).to_dict()
course = self.course.get().course_type
del result['course']
del result['list_exercises']
result['activities'] = self.get_exercises
result['on_before'] = self.get_on_before
result['on_after'] = self.get_on_after
result['max_level'] = self.max_level
result['profile'] = self.course.get().profile
del result['canceled']
if self.session_type != "SINGLE":
del result['url']
if course != "SCHEDULED":
del result['start_date']
del result['end_date']
if course != "PROGRAM":
del result['week_no']
del result['day_no']
return result
def _compute_status(self):
if self.canceled:
return "CANCELED"
course = self.course.get().course_type
if course == "SCHEDULED":
now = datetime.now()
if now < self.start_date:
return "UPCOMING"
elif now > self.end_date:
return "FINISHED"
return "ONGOING"
def _post_put_hook(self, future):
# check if startdate or and enddate are outside course time, then update course.
course = self.course.get()
if course.course_type == "SCHEDULED":
if self.start_date < course.start_date:
course.start_date = self.start_date
if self.end_date > course.end_date:
course.end_date = self.end_date
course.put()
def safe_delete(self):
self.canceled = True
self.put()
@property
def activity_count(self):
# noinspection PyTypeChecker
return len(self.list_exercises)
class Source(GCModel):
source_type = ndb.StringProperty(choices=["VIDEO", "AUDIO", "IMAGE", "TEXT"], required=True)
hd_link = ndb.StringProperty()
sd_link = ndb.StringProperty()
mobile_link = ndb.StringProperty()
download_link = ndb.StringProperty()
instruction_link = ndb.StringProperty()
http_live_streaming = ndb.StringProperty()
media_length = ndb.FloatProperty()
class Detail(GCModel):
created_for = ndb.KeyProperty(kind='Club', required=True)
name = ndb.StringProperty(required=True)
detail_type = ndb.StringProperty(choices=["INTEGER", "FLOAT", "STRING", "BOOLEAN"], required=True)
description = ndb.StringProperty(required=True)
def to_dict(self):
result = super(Detail, self).to_dict()
del result['created_for']
return result
class Level(GCModel):
level_number = ndb.IntegerProperty(required=True)
description = ndb.StringProperty()
source = ndb.StructuredProperty(Source)
name = ndb.StringProperty()
# here we store the Details and value in a list of objects.
# it's not as possible answers where the value is set
# here the details can be reused and value changes from time to time
# [{"indicator":Key,value:"value"},..]
# we do like this to enable updates of the indicators.
details_list = ndb.JsonProperty(default=[])
def __init__(self, *args, **kwds):
if 'details' in kwds:
details = kwds.pop('details')
l = [(detail['id'], detail['value']) for detail in details]
kwds['details_list'] = l
super(Level, self).__init__(*args, **kwds)
@property
def details(self):
ret = []
# noinspection PyTypeChecker
for detail in self.details_list:
indicator = Key(urlsafe=detail['detail']).get()
# we make a copy, it's direct access to it..
d_indicator = indicator.to_dict()
d_indicator['value'] = detail['value']
ret.append(d_indicator)
return ret
def add_detail(self, detail, value):
# noinspection PyTypeChecker
for i_detail in self.details_list:
if i_detail['detail'] == detail.id:
raise BadParameters("%s is already present in the object" % detail.name)
self.details_list.append(dict(detail=detail, value=value))
# self.put()
def to_dict(self):
result = super(Level, self).to_dict()
del result['details_list']
result['details'] = self.details
return result
class TimeData(GCModel):
join = ndb.DateTimeProperty()
leave = ndb.DateTimeProperty()
def set_js(self, prop, value):
try:
setattr(self, prop, datetime.fromtimestamp(long(value) / 1000))
except:
setattr(self,prop, datetime.now())
def to_dict(self):
return dict(join=date_to_js_timestamp(self.join), leave=date_to_js_timestamp(self.leave))
class Participation(GCModel):
session = ndb.KeyProperty(kind="Session", required=True)
user = ndb.KeyProperty(kind="User", required=True)
level = ndb.IntegerProperty()
time = ndb.StructuredProperty(TimeData, repeated=True)
completeness = ndb.IntegerProperty(repeated=True)
# when = ndb.DateTimeProperty(repeated=True)
# this is a list of list, as for completeness it is updated everytime
indicator_list = ndb.PickleProperty(default=[])
@classmethod
def get_by_data(cls, user, session, level=None):
# gets the participation by its data
query = cls.query(
ndb.AND(cls.session == session.key,
cls.user == user.key))
if level:
query = query.filter(cls.level == level)
res = query.get()
# if there's more then return the last one.
if isinstance(res, list):
if res:
return res[-1]
return res
@property
def participation_count(self):
# noinspection PyTypeChecker
return len(self.time)
@property
def indicators(self):
ret = []
# noinspection PyTypeChecker
for inds in self.indicator_list:
ret_i = []
for ind in inds:
indicator = Key(urlsafe=ind['id']).get()
# we make a copy, it's direct access to it..
d_indicator = indicator.to_dict()
d_indicator['value'] = ind['value']
ret_i.append(d_indicator)
ret.append(ret_i)
return ret
def add_indicators(self, indicators):
self.indicator_list.append(indicators)
self.put()
@property
def max_completeness(self):
return max(self.completeness)
class Performance(GCModelMtoMNoRep):
activity = ndb.KeyProperty(kind="Exercise", required=True)
participation = ndb.KeyProperty(kind="Participation", required=True)
level = ndb.IntegerProperty()
record_date = ndb.DateTimeProperty(repeated=True)
completeness = ndb.IntegerProperty(repeated=True)
indicator_list = ndb.PickleProperty(default=[])
@property
def indicators(self):
ret = []
# noinspection PyTypeChecker
for inds in self.indicator_list:
ret_i = []
for ind in inds:
indicator = Key(urlsafe=ind['id']).get()
# we make a copy, it's direct access to it..
d_indicator = indicator.to_dict()
d_indicator['value'] = ind['value']
ret_i.append(d_indicator)
ret.append(ret_i)
return ret
def add_indicators(self, indicators):
self.indicator_list.append(indicators)
self.put()
@property
def max_completeness(self):
return max(self.completeness)
def to_dict(self):
d = super(Performance, self).to_dict()
d['record_date'] = [date_to_js_timestamp(data) for data in self.record_date]
d['indicators'] = self.indicators
d['max_completeness']=self.max_completeness
del d['indicator_list']
return d
class PossibleAnswer(GCModel):
# this is fixed
name = ndb.StringProperty()
text = ndb.StringProperty()
img = ndb.StringProperty()
value = ndb.StringProperty()
class Indicator(GCModel):
name = ndb.StringProperty(required=True)
indicator_type = ndb.StringProperty(choices=["INTEGER", "FLOAT", "STRING","BOOLEAN"], default="INTEGER")
description = ndb.StringProperty(required=True)
possible_answers = ndb.StructuredProperty(PossibleAnswer, repeated=True)
required = ndb.BooleanProperty(default=True)
created_for = ndb.KeyProperty(kind='Club', required=True)
answer_type = ndb.StringProperty(choices=["TEXT", "MULTIPLECHOICE", "CHECKBOXES"], default="TEXT")
class Exercise(GCModel):
name = ndb.StringProperty()
levels = ndb.StructuredProperty(Level, repeated=True)
# TODO: exericse belongs to trainers or to a club or what?
created_for = ndb.KeyProperty(kind='Club', required=True)
# can't be a strucutred property since possible_answers is already a repated structured property
indicator_list = ndb.KeyProperty(kind='Indicator', repeated=True)
@property
def indicators(self):
return ndb.get_multi(self.indicator_list)
@property
def level_count(self):
# noinspection PyTypeChecker
return len(self.levels)
@property
def indicator_count(self):
# noinspection PyTypeChecker
# noinspection PyTypeChecker
return len(self.indicator_list)
def to_dict(self):
result = super(Exercise, self).to_dict()
levels = []
for level in self.levels:
levels.append(level.to_dict())
result['levels'] = levels
result['level_count'] = self.level_count
result['indicator_count'] = self.indicator_count
del result['indicator_list']
# del result['created_for']
return result
# in case we need the key of a structured property
# def to_dict(self):
# result = super(Exercise, self).to_dict()
# result['list_levels'] = [l.to_dict() for l in self.list_levels]
# return result
class Room(GCModel):
name = ndb.StringProperty(required=True)
room_type = ndb.StringProperty(required=True)
config = ndb.JsonProperty()
club = ndb.KeyProperty(kind='Club', required=True)
class Event(GCModel):
name = ndb.StringProperty(required=True)
event_type = ndb.StringProperty(required=True)
config = ndb.JsonProperty()
start_date = ndb.DateTimeProperty(auto_now_add=False)
end_date = ndb.DateTimeProperty(auto_now_add=False)
room = ndb.KeyProperty(kind='Room', required=True)