"city": "Default City",

"maxAttendees": 0,

"seatsAvailable": 0,

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

'EQ': '=',

'GT': '>',

'GTEQ': '>=',

'LT': '<',

'LTEQ': '<=',

'NE': '!='

'CITY': 'city',

'TOPIC': 'topics',

'MONTH': 'month',

'MAX_ATTENDEES': 'maxAttendees',

message_types.VoidMessage,

websafeConferenceKey=messages.StringField(1, required=True),

sessionType=messages.StringField(2),

speaker=messages.StringField(3)

"""Conference API v0.1"""

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

def _copyConferenceToForm(self, conf, displayName):

"""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

# both for data model & outbound Message

if data["maxAttendees"] > 0:

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

setattr(request, "seatsAvailable", data["maxAttendees"])

# make Profile Key from user ID

p_key = ndb.Key(Profile, user_id)

# allocate new Conference ID with Profile key as parent

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

# make Conference key from ID

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

data['key'] = c_key

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

# create Conference & return (modified) ConferenceForm

# send confirmation email to organizer

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 conf 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'))

# --Conference related endpoints --------------------------------------------

@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 conf 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]

)

@endpoints.method(CONF_GET_REQUEST, SessionForms,

path='conference/{websafeConferenceKey}/sessions',

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

def getConferenceSessions(self, request):

"""Given a conference, returns all sessions."""

# copy ConferenceForm/ProtoRPC Message into dict

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

# fetch 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)

# create ancestor query for all key matches for this conference

sessions = Session.query(ancestor=conf.key).fetch()

# return set of SessionForm objects per Session

return SessionForms(

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

)

@endpoints.method(SESSION_GET_REQUEST, SessionForms,

path='conference/{websafeConferenceKey}/sessions/by_type/{sessionType}',

http_method='GET', name='getConferenceSessionsByType')

def getConferenceSessionsByType(self, request):

"""For a conference ,Return all sessions of

a specified type(eg of types: lecture, workshop)"""

# copy ConferenceForm/ProtoRPC Message into dict

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

sessionType = data['sessionType']

# fetch 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)

# create ancestor query for all key matches for this conference

sessions = Session.query(ancestor=conf.key).filter(Session.sessionType == sessionType)

# return set of SessionForm objects per session

return SessionForms(

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

)

@endpoints.method(SESSION_GET_REQUEST, SessionForms,

path='conference/{websafeConferenceKey}/sessions/by_speaker/{speaker}',

http_method='GET', name='getConferenceSessionsBySpeaker')

def getConferenceSessionsBySpeaker(self, request):

"""For a conference ,Return all sessions of

by a specified speaker """

# copy ConferenceForm/ProtoRPC Message into dict

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

sessionSpeaker = data['speaker']

# fetch 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)

# create ancestor query for all key matches for this conference

sessions = Session.query(ancestor=conf.key).filter(Session.speaker == sessionSpeaker)

# return set of SessionForm objects per session

return SessionForms(

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

)

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

def _createSessionObject(self, request):

"""Create or update Session object, returning SessionForm/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("Session'name' field required")

# fetch and check conference

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

# check that conference exists

if not conf:

raise endpoints.NotFoundException(

'Conference not found for key: %s' % request.websafeConferenceKey)

# check that user is owner

if user_id != conf.organizerUserId:

raise endpoints.ForbiddenException(

'You need to be the owner to add sessions.')

# copy SessionForm/ProtoRPC Message into dict

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

# convert dates from strings to Date objects

if data['date']:

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

# convert time from strings to Time object (date-independent)

if data['startTime']:

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

# make session key from conf key

p_key = conf.key

# allocate new session id with conf

s_id = Session.allocate_ids(size=1, parent=p_key)[0]

s_key = ndb.Key(Session, s_id, parent=p_key)

data['key'] = s_key

data['organizerUserId'] = user_id

del data['websafeConferenceKey']

del data['websafeKey']

Session(**data).put()

# Add to the task queue a task for setting cache

# Task will check if speaker is in more than one session

# If yes, will cache results

taskqueue.add(

params={

'confKey': p_key,

'speaker': data['speaker']

},

url='/tasks/set_featured_speaker'

)

return request

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 and Time to date string; just copy others

if field.name in ['startTime', 'date']:

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

else:

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

elif field.name == "websafeKey":

setattr(sf, field.name, session.key.urlsafe())

sf.check_initialized()

return sf

# Session end points

@endpoints.method(SessionForm, SessionForm,

path='sessions',

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

def createSession(self, request):

"""create new session"""

return self._createSessionObject(request)

@endpoints.method(SPEAKER_GET_REQUEST, SessionForms,

path='sessions/{speaker}',

http_method='GET', name='getSessionsBySpeaker')

def getSessionsBySpeaker(self, request):

"""Return all sessions for a speaker across all conferences"""

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

speaker = data['speaker']

# filter query sessions for a speaker

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

# return session forms

return SessionForms(

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

)

@endpoints.method(CONF_GET_REQUEST, SessionForms,

http_method='GET', name='getConferenceSessionsToDate')

def getConferenceSessionsToDate(self, request):

"""Returns a conference's sessions to date sorted by date & time."""

# copy ConferenceForm/ProtoRPC Message into dict

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

# fetch 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)

sessions = Session.query(ancestor=conf.key)\

.filter(Session.date <= datetime.now())\

.order(Session.date, Session.startTime)

# 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."""

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

user_id = getUserId(user)

p_key = ndb.Key(Profile, user_id)

profile = p_key.get()

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))

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)

@endpoints.method(WISHLIST_POST_REQUEST, SessionForm,

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

def addSessionToWishlist(self, request):

"""Adds a session to a user's wishlist"""

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

# fetch and check session

session = ndb.Key(urlsafe=request.websafeSessionKey).get()

# check that session exists

if not session:

raise endpoints.NotFoundException(

'No session found with key: %s' % request.websafeSessionKey)

# fetch profile

prof = self._getProfileFromUser()

# check if session already added to wishlist

if session.key in prof.sessionWishlist:

raise endpoints.BadRequestException(

'Session already saved to wishlist: %s' % request.websafeSessionKey)

# append to user profile's wishlist

prof.sessionWishlist.append(session.key)

prof.put()

return self._copySessionToForm(session)

@endpoints.method(message_types.VoidMessage, SessionForms,

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

def getSessionsInWishlist(self, request):

"""Returns a user's wishlist of sessions to attend"""

user = endpoints.get_current_user()

if not user:

raise endpoints.UnauthorizedException('Authorization required')

# fetch profile and wishlist

prof = self._getProfileFromUser()

session_keys = prof.sessionWishlist

sessions = [session_key.get() for session_key in session_keys]

# return sessions set

return SessionForms(

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

)

@endpoints.method(message_types.VoidMessage, SpeakerForm,

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

def getFeaturedSpeaker(self, request):

"""Returns the sessions of the featured speaker"""

# attempt to get data from memcache

data = memcache.get(MEMCACHE_FEAT_SPKR_KEY)

speaker = None

sessionNames = []

if data and data.has_key('speaker') and data.has_key('sessionNames'):

speaker = data['speaker']

sessionNames = data['sessionNames']

# populate speaker form

sf = SpeakerForm()

for field in sf.all_fields():

if field.name == 'sessionNames':

setattr(sf, field.name, sessionNames)

elif field.name == 'speaker':

setattr(sf, field.name, speaker)

sf.check_initialized()

return sf

@endpoints.method(message_types.VoidMessage, SessionForms,

http_method='GET', name='getNonWorkshopDaySessions')

def getNonWorkshopDaySessions(self, request):

"""Returns non-workshop sessions scheduled before 7pm"""

day_sessions = Session.query(ndb.AND(

Session.startTime <= time(hour=19),

Session.startTime != None)

)

# loop thru to filter out workshop type sessions

qualified_sessions = []

for session in day_sessions:

if 'workshop' in session.typeOfSession:

continue

else:

qualified_sessions.append(session)

return SessionForms(

items=[self._copySessionToForm(session) for session in qualified_sessions]

)

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

@ndb.transactional(xg=True)

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

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

retval = None

# get user Profile

prof = self._getProfileFromUser()

# 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)

# - - - 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 = '%s %s' % (

'Last chance to attend! The following conferences '

'are nearly sold out:',

', '.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 an existing announcement from Memcache or an empty string.

announcement = (memcache.get(MEMCACHE_ANNOUNCEMENTS_KEY) or "")