"city": "Default City",

"maxAttendees": 0,

"seatsAvailable": 0,

"topics": [ "Default", "Topic" ],

"name": "Faux Con",

"highlights": "scintillating talk",

"speaker": "John Dough",

"typeOfSession": "Lecture",

"duration": 30,

"date": "2015-12-01",

"startTime": "10:00"

'EQ': '=',

'GT': '>',

'GTEQ': '>=',

'LT': '<',

'LTEQ': '<=',

'NE': '!='

'CITY': 'city',

'TOPIC': 'topics',

'MONTH': 'month',

'MAX_ATTENDEES': 'maxAttendees',

name = messages.StringField(1),

highlights = messages.StringField(2),

websafeConferenceKey = messages.StringField(3),

speaker = messages.StringField(4),

typeOfSession = messages.StringField(5),

date = messages.StringField(6),

startTime = messages.StringField(7),

duration = messages.IntegerField(8),

"""Conference API v0.1"""

# - - - Conference objects - - - - - - - - - - - - - - - - -

def _copyConferenceToForm(self, conf, displayName="User"):

"""Copy relevant fields from Conference to ConferenceForm."""

cf = ConferenceForm()

for field in cf.all_fields():

if hasattr(conf, field.name):

# convert Date to date string; just copy others

if field.name.endswith('Date'):

setattr(cf, field.name, str(getattr(conf, field.name)))

else:

setattr(cf, field.name, getattr(conf, field.name))

elif field.name == "websafeKey":

setattr(cf, field.name, conf.key.urlsafe())

if displayName:

setattr(cf, 'organizerDisplayName', displayName)

cf.check_initialized()

return cf

def _createConferenceObject(self, request):

"""Create or update Conference object, returning ConferenceForm/request."""

# preload necessary data items

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

user_id = getUserId(user)

if not request.name:

raise endpoints.BadRequestException("Conference 'name' field required")

# copy ConferenceForm/ProtoRPC Message into dict

data = {field.name: getattr(request, field.name) for field in request.all_fields()}

del data['websafeKey']

del data['organizerDisplayName']

# add default values for those missing (both data model & outbound Message)

for df in DEFAULTS:

if data[df] in (None, []):

data[df] = DEFAULTS[df]

setattr(request, df, DEFAULTS[df])

# convert dates from strings to Date objects; set month based on start_date

if data['startDate']:

data['startDate'] = datetime.strptime(data['startDate'][:10], "%Y-%m-%d").date()

data['month'] = data['startDate'].month

else:

data['month'] = 0

if data['endDate']:

data['endDate'] = datetime.strptime(data['endDate'][:10], "%Y-%m-%d").date()

# set seatsAvailable to be same as maxAttendees on creation

if data["maxAttendees"] > 0:

data["seatsAvailable"] = data["maxAttendees"]

# generate Profile Key based on user ID and Conference

# ID based on Profile key get Conference key from ID

p_key = ndb.Key(Profile, user_id)

c_id = Conference.allocate_ids(size=1, parent=p_key)[0]

c_key = ndb.Key(Conference, c_id, parent=p_key)

data['key'] = c_key

data['organizerUserId'] = request.organizerUserId = user_id

# create Conference, send email to organizer confirming

# creation of Conference & return (modified) ConferenceForm

Conference(**data).put()

taskqueue.add(params={'email': user.email(),

'conferenceInfo': repr(request)},

url='/tasks/send_confirmation_email'

)

return request

@ndb.transactional()

def _updateConferenceObject(self, request):

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

user_id = getUserId(user)

# copy ConferenceForm/ProtoRPC Message into dict

data = {field.name: getattr(request, field.name) for field in request.all_fields()}

# update existing conference

conf = ndb.Key(urlsafe=request.websafeConferenceKey).get()

# check that conference exists

if not conf:

raise endpoints.NotFoundException(

'No conference found with key: %s' % request.websafeConferenceKey)

# check that user is owner

if user_id != conf.organizerUserId:

raise endpoints.ForbiddenException(

'Only the owner can update the conference.')

# Not getting all the fields, so don't create a new object; just

# copy relevant fields from ConferenceForm to Conference object

for field in request.all_fields():

data = getattr(request, field.name)

# only copy fields where we get data

if data not in (None, []):

# special handling for dates (convert string to Date)

if field.name in ('startDate', 'endDate'):

data = datetime.strptime(data, "%Y-%m-%d").date()

if field.name == 'startDate':

conf.month = data.month

# write to Conference object

setattr(conf, field.name, data)

conf.put()

prof = ndb.Key(Profile, user_id).get()

return self._copyConferenceToForm(conf, getattr(prof, 'displayName'))

@endpoints.method(ConferenceForm, ConferenceForm, path='conference',

http_method='POST', name='createConference')

def createConference(self, request):

"""Create new conference."""

return self._createConferenceObject(request)

@endpoints.method(CONF_POST_REQUEST, ConferenceForm,

path='conference/{websafeConferenceKey}',

http_method='PUT', name='updateConference')

def updateConference(self, request):

"""Update conference w/provided fields & return w/updated info."""

return self._updateConferenceObject(request)

@endpoints.method(CONF_GET_REQUEST, ConferenceForm,

path='conference/{websafeConferenceKey}',

http_method='GET', name='getConference')

def getConference(self, request):

"""Return requested conference (by websafeConferenceKey)."""

# get Conference object from request; bail if not found

conf = ndb.Key(urlsafe=request.websafeConferenceKey).get()

if not conf:

raise endpoints.NotFoundException(

'No conference found with key: %s' % request.websafeConferenceKey)

prof = conf.key.parent().get()

# return ConferenceForm

return self._copyConferenceToForm(conf, getattr(prof, 'displayName'))

@endpoints.method(message_types.VoidMessage, ConferenceForms,

path='getConferencesCreated',

http_method='POST', name='getConferencesCreated')

def getConferencesCreated(self, request):

"""Return conferences created by user."""

# make sure user is authed

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

user_id = getUserId(user)

# create ancestor query for all key matches for this user

confs = Conference.query(ancestor=ndb.Key(Profile, user_id))

prof = ndb.Key(Profile, user_id).get()

# return set of ConferenceForm objects per Conference

return ConferenceForms(

items=[self._copyConferenceToForm(conf, getattr(prof, 'displayName')) for conf in confs]

)

def _getQuery(self, request):

"""Return formatted query from the submitted filters."""

q = Conference.query()

inequality_filter, filters = self._formatFilters(request.filters)

# If exists, sort on inequality filter first

if not inequality_filter:

q = q.order(Conference.name)

else:

q = q.order(ndb.GenericProperty(inequality_filter))

q = q.order(Conference.name)

for filtr in filters:

if filtr["field"] in ["month", "maxAttendees"]:

filtr["value"] = int(filtr["value"])

formatted_query = ndb.query.FilterNode(filtr["field"], filtr["operator"], filtr["value"])

q = q.filter(formatted_query)

return q

def _formatFilters(self, filters):

"""Parse, check validity and format user supplied filters."""

formatted_filters = []

inequality_field = None

for f in filters:

filtr = {field.name: getattr(f, field.name) for field in f.all_fields()}

try:

filtr["field"] = FIELDS[filtr["field"]]

filtr["operator"] = OPERATORS[filtr["operator"]]

except KeyError:

raise endpoints.BadRequestException("Filter contains invalid field or operator.")

# Every operation except "=" is an inequality

if filtr["operator"] != "=":

# check if inequality operation has been used in previous filters

# disallow the filter if inequality was performed on a different field before

# track the field on which the inequality operation is performed

if inequality_field and inequality_field != filtr["field"]:

raise endpoints.BadRequestException("Inequality filter is allowed on only one field.")

else:

inequality_field = filtr["field"]

formatted_filters.append(filtr)

return (inequality_field, formatted_filters)

@endpoints.method(ConferenceQueryForms, ConferenceForms,

path='queryConferences',

http_method='POST',

name='queryConferences')

def queryConferences(self, request):

"""Query for conferences."""

conferences = self._getQuery(request)

# need to fetch organiser displayName from profiles

# get all keys and use get_multi for speed

organisers = [(ndb.Key(Profile, conf.organizerUserId)) for conf in conferences]

profiles = ndb.get_multi(organisers)

# put display names in a dict for easier fetching

names = {}

for profile in profiles:

names[profile.key.id()] = profile.displayName

# return individual ConferenceForm object per Conference

return ConferenceForms(

items=[self._copyConferenceToForm(conf, names[conf.organizerUserId]) for conf in \

conferences]

)

# Task 3 filter Conferences for available seats

@endpoints.method(message_types.VoidMessage, ConferenceForms,

path='getConferencesWithSeats',

http_method='POST', name='getConferencesWithSeats')

def getConferencesWithSeats(self, request):

"""Return conferences that have available seats."""

# we want conferences with registered attendees < max# attendees

confs = Conference.query().filter(Conference.seatsAvailable > 0)

# return set of ConferenceForm objects per Conference

return ConferenceForms(

items=[self._copyConferenceToForm(conf) for conf in confs]

)

# - - - Session objects - - - - - - - - - - - - - - - - - - -

def _copySessionToForm(self, session):

"""Copy relevant fields from Session to SessionForm."""

sf = SessionForm()

for field in sf.all_fields():

if hasattr(session, field.name):

# convert Date/time to date string; just copy others

if field.name.endswith(('date', 'Time')):

setattr(sf, field.name, str(getattr(session, field.name)))

else:

setattr(sf, field.name, getattr(session, field.name))

sf.check_initialized()

return sf

def _verifyConfCreator(self, websafeKey):

"""helper function to check if conf was created by current user"""

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

user_id = getUserId(user)

# check that conference exists

conf = ndb.Key(urlsafe=websafeKey).get()

if not conf:

raise endpoints.NotFoundException(

'No conference found with key: %s' % request.websafeKey)

# check that user is conference creator

if user_id != conf.organizerUserId:

raise endpoints.ForbiddenException(

'Only the owner can update the conference.')

# Given a conference, return all sessions

@endpoints.method(CONF_GET_REQUEST, SessionForms,

path='sessions/{websafeConferenceKey}',

http_method='GET', name='getConferenceSessions')

def getConferenceSessions(self, request):

"""returns all sessions created under a specified conference key"""

# convert the websafekey to query for linked Sessions

conf_key = ndb.Key(urlsafe=request.websafeConferenceKey)

# query db for all sessions with conference key and return

sessions = Session.query(ancestor=conf_key)

# return set of SessionForm objects per Session

return SessionForms(items=

[self._copySessionToForm(session) for session in sessions])

# Given a conference, return all sessions of specified type

@endpoints.method(SessionTypeQueryForm, SessionForms,

path='getConferenceSessionsByType',

http_method='POST',

name='getConferenceSessionsByType')

def getConferenceSessionsByType(self, request):

"""returns sessions given a specified type"""

conf_key = ndb.Key(urlsafe=request.websafeConferenceKey)

conf_sessions = Session.query(ancestor=conf_key)

# filter by typeOfSession

sessions = conf_sessions.filter(Session.typeOfSession == request.typeOfSession)

return SessionForms(items=

[self._copySessionToForm(session) for session in sessions])

# Given a speaker, return all sessions given by this speaker regardless of conference

@endpoints.method(SessionSpeakerQueryForm, SessionForms,

path='getSessionsBySpeaker',

http_method='POST',

name='getSessionsBySpeaker')

def getSessionsBySpeaker(self, request):

"""returns sessions given a speaker name"""

# speaker field is a String

sessions = Session.query().filter(Session.speaker == request.speaker)

return SessionForms(items=

[self._copySessionToForm(session) for session in sessions])

# returns all sessions less than 60 mins

@endpoints.method(message_types.VoidMessage, SessionForms,

path='getShortSessions',

http_method='POST',

name='getShortSessions')

def getShortSessions(self, request):

"""returns all sessions less than 60 min in duration"""

sessions = Session.query(Session.duration < 60)

return SessionForms(items=

[self._copySessionToForm(session) for session in sessions])

@endpoints.method(SessionForm, SessionForm,

path='session/{websafeConferenceKey}',

http_method='POST', name='createSession')

def createSession(self, request):

"""Creating new sessions."""

# # first check that user is conference creator

wsck = request.websafeConferenceKey

self._verifyConfCreator(wsck)

# copy SessionForm/ProtoRPC Message into dict, omitting websafe key

data = {field.name: getattr(request, field.name) for field in request.all_fields()}

del data['websafeConferenceKey']

# add default values for those missing (both data model & outbound Message)

for df in SESSION_DEFAULTS:

if data[df] in (None, []):

data[df] = SESSION_DEFAULTS[df]

setattr(request, df, SESSION_DEFAULTS[df])

# convert date/time from strings to Datetime objects;

if data['date']:

data['date'] = datetime.strptime(data['date'][:10], "%Y-%m-%d").date()

if data['startTime']:

data['startTime'] = datetime.strptime(data['startTime'][:5], "%H:%M").time()

conf_key = ndb.Key(urlsafe=wsck)

session_id = Session.allocate_ids(size=1, parent=conf_key)[0]

session_key = ndb.Key(Session, session_id,

parent=conf_key)

data['key'] = session_key

# check if session speaker has another session in this conference

speaker_sesh = Session.query(Session.speaker == request.speaker,

ancestor=conf_key).get()

if speaker_sesh:

# Yup, FEATURED SPEAKER! trigger task and end loop

taskqueue.add(

url='/tasks/set_featured_speaker',

params={'websafeKey': wsck, 'speaker': request.speaker}

)

# create Session in datastore, passing in kwargs

Session(**data).put()

return request

# Add session key to Profile sessionKey list

@endpoints.method(SESSION_GET_REQUEST, BooleanMessage,

path='addSessionToWishlist',

http_method='POST', name='addSessionToWishlist')

def addSessionToWishlist(self, request):

"""add session to User's profile wishlist."""

return self._addToWishlist(request)

# NOTE this can be modified easily to enable removing session from list

# by adding an 'add' param and uncommenting code in function body

def _addToWishlist(self, request):

"""add session key to User wishlist."""

retval = None

prof = self._getProfileFromUser() # get user Profile

# check if session exists given websafeSessionKey

# get session to check that it exists

wsck = request.websafeSessionKey

session = ndb.Key(urlsafe=wsck).get()

if not session:

raise endpoints.NotFoundException(

'No session found with key: %s' % wsck)

# add to wishlist

# if add:

# check if user already added otherwise add

if wsck in prof.sessionKeysOnWishlist:

raise ConflictException("You have already added this session.")

prof.sessionKeysOnWishlist.append(wsck)

retval = True

# unadd to wishlist

# else:

# # check if session is in wishlist

# if wsck in prof.sessionKeysOnWishlist:

# # remove from list

# prof.sessionKeysOnWishlist.remove(wsck)

# retval = True

# else:

# retval = False

# write things back to the datastore & return

prof.put()

return BooleanMessage(data=retval)

# should only be accessible when User is logged in

@endpoints.method(message_types.VoidMessage, SessionForms,

path='sessions/favorites',

http_method='GET', name='getSessionsInWishlist')

def getSessionsInWishlist(self, request):

"""Get list of sessions that user has favorited."""

prof = self._getProfileFromUser() # get user Profile

session_keys = [ndb.Key(urlsafe=wsck)\

for wsck in prof.sessionKeysOnWishlist]

sessions = ndb.get_multi(session_keys)

# return set of SessionForm objects per Session

return SessionForms(items=[self._copySessionToForm(session)\

for session in sessions]

)

# - - - Profile objects - - - - - - - - - - - - - - - - - - -

def _copyProfileToForm(self, prof):

"""Copy relevant fields from Profile to ProfileForm."""

# copy relevant fields from Profile to ProfileForm

pf = ProfileForm()

for field in pf.all_fields():

if hasattr(prof, field.name):

# convert t-shirt string to Enum; just copy others

if field.name == 'teeShirtSize':

setattr(pf, field.name, getattr(TeeShirtSize, getattr(prof, field.name)))

else:

setattr(pf, field.name, getattr(prof, field.name))

pf.check_initialized()

return pf

def _getProfileFromUser(self):

"""Return user Profile from datastore, creating new one if non-existent."""

# make sure user is authed

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

# get Profile from datastore

user_id = getUserId(user)

p_key = ndb.Key(Profile, user_id)

profile = p_key.get()

# create new Profile if not there

if not profile:

profile = Profile(

key = p_key,

displayName = user.nickname(),

mainEmail= user.email(),

teeShirtSize = str(TeeShirtSize.NOT_SPECIFIED),

)

profile.put()

return profile # return Profile

def _doProfile(self, save_request=None):

"""Get user Profile and return to user, possibly updating it first."""

# get user Profile

prof = self._getProfileFromUser()

# if saveProfile(), process user-modifyable fields

if save_request:

for field in ('displayName', 'teeShirtSize'):

if hasattr(save_request, field):

val = getattr(save_request, field)

if val:

setattr(prof, field, str(val))

#if field == 'teeShirtSize':

# setattr(prof, field, str(val).upper())

#else:

# setattr(prof, field, val)

prof.put()

# return ProfileForm

return self._copyProfileToForm(prof)

@endpoints.method(message_types.VoidMessage, ProfileForm,

path='profile', http_method='GET', name='getProfile')

def getProfile(self, request):

"""Return user profile."""

return self._doProfile()

@endpoints.method(ProfileMiniForm, ProfileForm,

path='profile', http_method='POST', name='saveProfile')

def saveProfile(self, request):

"""Update & return user profile."""

return self._doProfile(request)

# - - - Announcements - - - - - - - - - - - - - - - - - - - -

@staticmethod

def _cacheAnnouncement():

"""Create Announcement & assign to memcache; used by

memcache cron job & putAnnouncement().

"""

confs = Conference.query(ndb.AND(

Conference.seatsAvailable <= 5,

Conference.seatsAvailable > 0)

).fetch(projection=[Conference.name])

if confs:

# If there are almost sold out conferences,

# format announcement and set it in memcache

announcement = ANNOUNCEMENT_TPL % (

', '.join(conf.name for conf in confs))

memcache.set(MEMCACHE_ANNOUNCEMENTS_KEY, announcement)

else:

# If there are no sold out conferences,

# delete the memcache announcements entry

announcement = ""

memcache.delete(MEMCACHE_ANNOUNCEMENTS_KEY)

return announcement

@endpoints.method(message_types.VoidMessage, StringMessage,

path='conference/announcement/get',

http_method='GET', name='getAnnouncement')

def getAnnouncement(self, request):

"""Return Announcement from memcache."""

return StringMessage(data=memcache.get(MEMCACHE_ANNOUNCEMENTS_KEY) or

"Nothing to report.")

# - - - Featured speaker - - - - - - - - - - - - - - - - - - - -

@staticmethod

# def _cacheFeatured(request):

def _cacheFeatured(websafeKey, speaker):

"""Designate featured speaker & assign to memcache"""

# get sessions in the conference with that speaker name

q = Session.query(ancestor=ndb.Key(urlsafe=websafeKey))

sessions = q.filter(Session.speaker == speaker)

# construct message string

feature_msg = MSG_TPL % (

speaker,

' and '.join(session.name for session in sessions))

memcache.set(MEMCACHE_SPEAKERS_KEY, feature_msg)

return feature_msg

# getFeaturedSpeaker() doesn't take a conference, and will basically return the

# speaker of the last session added that meets the condition that the Session

# Speaker speaks at more then one session at that same conference.

@endpoints.method(message_types.VoidMessage, StringMessage,

path='conference/featured/get',

http_method='GET', name='getFeaturedSpeaker')

def getFeaturedSpeaker(self, request):

"""Return featured speaker and related session titles from memcache."""

return StringMessage(data=memcache.get(MEMCACHE_SPEAKERS_KEY) or

"Nothing to report.")

# - - - Registration - - - - - - - - - - - - - - - - - - - -

@ndb.transactional(xg=True)

def _conferenceRegistration(self, request, reg=True):

"""Register or unregister user for selected conference."""

retval = None

prof = self._getProfileFromUser() # get user Profile

# check if conf exists given websafeConfKey

# get conference; check that it exists

wsck = request.websafeConferenceKey

conf = ndb.Key(urlsafe=wsck).get()

if not conf:

raise endpoints.NotFoundException(

'No conference found with key: %s' % wsck)

# register

if reg:

# check if user already registered otherwise add

if wsck in prof.conferenceKeysToAttend:

raise ConflictException(

"You have already registered for this conference")

# check if seats avail

if conf.seatsAvailable <= 0:

raise ConflictException(

"There are no seats available.")

# register user, take away one seat

prof.conferenceKeysToAttend.append(wsck)

conf.seatsAvailable -= 1

retval = True

# unregister

else:

# check if user already registered

if wsck in prof.conferenceKeysToAttend:

# unregister user, add back one seat

prof.conferenceKeysToAttend.remove(wsck)

conf.seatsAvailable += 1

retval = True

else:

retval = False

# write things back to the datastore & return

prof.put()

conf.put()

return BooleanMessage(data=retval)

@endpoints.method(message_types.VoidMessage, ConferenceForms,

path='conferences/attending',

http_method='GET', name='getConferencesToAttend')

def getConferencesToAttend(self, request):

"""Get list of conferences that user has registered for."""

prof = self._getProfileFromUser() # get user Profile

conf_keys = [ndb.Key(urlsafe=wsck) for wsck in prof.conferenceKeysToAttend]

conferences = ndb.get_multi(conf_keys)

# get organizers

organisers = [ndb.Key(Profile, conf.organizerUserId) for conf in conferences]

profiles = ndb.get_multi(organisers)

# put display names in a dict for easier fetching

names = {}

for profile in profiles:

names[profile.key.id()] = profile.displayName

# return set of ConferenceForm objects per Conference

return ConferenceForms(items=[self._copyConferenceToForm(conf, names[conf.organizerUserId])\

for conf in conferences]

)

@endpoints.method(CONF_GET_REQUEST, BooleanMessage,

path='conference/{websafeConferenceKey}',

http_method='POST', name='registerForConference')

def registerForConference(self, request):

"""Register user for selected conference."""

return self._conferenceRegistration(request)

@endpoints.method(CONF_GET_REQUEST, BooleanMessage,

path='conference/{websafeConferenceKey}',

http_method='DELETE', name='unregisterFromConference')

def unregisterFromConference(self, request):

"""Unregister user for selected conference."""

return self._conferenceRegistration(request, reg=False)

@endpoints.method(message_types.VoidMessage, ConferenceForms,

path='filterPlayground',

http_method='GET', name='filterPlayground')

def filterPlayground(self, request):

"""Filter Playground"""

q = Conference.query()

# field = "city"

# operator = "="

# value = "London"

# f = ndb.query.FilterNode(field, operator, value)

# q = q.filter(f)

q = q.filter(Conference.city=="London")

q = q.filter(Conference.topics=="Medical Innovations")

q = q.filter(Conference.month==6)

return ConferenceForms(

items=[self._copyConferenceToForm(conf, "") for conf in q]

)

# What if User wanted to avoid workshop (type) sessions as well as sessions

# after 7pm? What are the issues here and how could this be implemented?

@endpoints.method(message_types.VoidMessage, SessionForms,

path='task3go',

http_method='GET', name='task3Test')

def task3Test(self, request):

"""an endpoint just to test solutions for project's Task 3"""

# first query is a simple property filter

# second query more problematic...how to compare TimeProperties?

# this solution did not work; datastore not correctly comparing time obj

# good_sessions = Session.query(Session.typeOfSession != 'Workshop')

# cutoff = time(19)

# print 'HEY cutoff time is %s', cutoff

# good_sessions.filter(Session.startTime < cutoff)

# this solution works but may be problematic performance-wise

good_sessions = Session.query(Session.typeOfSession != 'Workshop').fetch()

if good_sessions:

cutoff = time(19)

good_sessions = [session for session in good_sessions if session.startTime < cutoff]

return SessionForms(items=