#!/usr/bin/env python

"""
conference.py -- Udacity conference server-side Python App Engine API;
    uses Google Cloud Endpoints

$Id: conference.py,v 1.25 2014/05/24 23:42:19 wesc Exp wesc $

created by wesc on 2014 apr 21

"""
from datetime import datetime

import endpoints
from protorpc import messages
from protorpc import message_types
from protorpc import remote

from google.appengine.api import memcache
from google.appengine.api import taskqueue
from google.appengine.ext import ndb

from models import ConflictException
from models import Profile
from models import ProfileMiniForm
from models import ProfileForm
from models import StringMessage
from models import BooleanMessage
from models import Conference
from models import ConferenceForm
from models import ConferenceForms
from models import ConferenceQueryForm
from models import ConferenceQueryForms
from models import Session
from models import SessionForm
from models import SessionForms
from models import TeeShirtSize

from settings import WEB_CLIENT_ID
from settings import ANDROID_CLIENT_ID
from settings import IOS_CLIENT_ID
from settings import ANDROID_AUDIENCE

from utils import getUserId


__author__ = '<EMAIL> (<NAME>)'

EMAIL_SCOPE = endpoints.EMAIL_SCOPE
API_EXPLORER_CLIENT_ID = endpoints.API_EXPLORER_CLIENT_ID
MEMCACHE_ANNOUNCEMENTS_KEY = "RECENT_ANNOUNCEMENTS"
MEMCACHE_SPEAKER_KEY = "FEATURED_SPEAKER"
ANNOUNCEMENT_TPL = ('Last chance to attend! The following conferences '
                    'are nearly sold out: %s')
SPEAKER_TPL = ('Featured Speaker: %s in sessions:\n\n%s')


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

DEFAULTS = {
    "city": "Default City",
    "maxAttendees": 0,
    "seatsAvailable": 0,
    "topics": ["Default", "Topic"],
}

OPERATORS = {
    'EQ':   '=',
    'GT':   '>',
    'GTEQ': '>=',
    'LT':   '<',
    'LTEQ': '<=',
    'NE':   '!='
}

FIELDS = {
    'CITY': 'city',
    'TOPIC': 'topics',
    'MONTH': 'month',
    'MAX_ATTENDEES': 'maxAttendees',
}

CONF_GET_REQUEST = endpoints.ResourceContainer(
    message_types.VoidMessage,
    websafeConferenceKey=messages.StringField(1),
)

CONF_POST_REQUEST = endpoints.ResourceContainer(
    ConferenceForm,
    websafeConferenceKey=messages.StringField(1),
)

SESSION_GET_REQUEST = endpoints.ResourceContainer(
    message_types.VoidMessage,
    websafeConferenceKey=messages.StringField(1),
    typeOfSession=messages.StringField(2),
    speaker=messages.StringField(3),
    date=messages.StringField(4),
    highlight=messages.StringField(5)
)

SESSION_POST_REQUEST = endpoints.ResourceContainer(
    SessionForm,
    websafeConferenceKey=messages.StringField(1),
)

WISHLIST_POST_REQUEST = endpoints.ResourceContainer(
    message_types.VoidMessage,
    websafeSessionKey=messages.StringField(1),
)

CONFERENCE = "Conference"
SESSION = "Session"

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


@endpoints.api(
    name='conference',
    version='v1',
    audiences=[ANDROID_AUDIENCE],
    allowed_client_ids=[
        WEB_CLIENT_ID, API_EXPLORER_CLIENT_ID, ANDROID_CLIENT_ID, IOS_CLIENT_ID
    ],
    scopes=[EMAIL_SCOPE]
)
class ConferenceApi(remote.Service):
    """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
        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

    @staticmethod
    def _checkEntityKey(wskey, kind):

        #  Try to get the entity using the provided key
        try:
            entity = ndb.Key(urlsafe=wskey).get()

            #  Make sure entity is not None
            if not entity:
                raise endpoints.NotFoundException(
                    'A %s with provided key was not found' % kind)

            #  Check if entity with the provided key is the kind expected
            if entity.key.kind() != kind:
                raise endpoints.BadRequestException(
                    'Provided key was for kind: %s' % entity.key.kind())

            return entity

        except Exception as e:
            raise endpoints.BadRequestException(
                'Problem with provided key %s. %s' % (wskey, e))

    @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()
        }

        wsck = request.websafeConferenceKey
        # update existing conference
        conf = self._checkEntityKey(wsck, CONFERENCE)

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

        wsck = request.websafeConferenceKey
        # get Conference object from request
        conf = self._checkEntityKey(wsck, CONFERENCE)

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

# - - - 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 to date string and startTime to startTime string
                # just copy others
                if field.name == 'date' or field.name == 'startTime':
                    setattr(sf, field.name, str(getattr(session, field.name)))
                else:
                    setattr(sf, field.name, getattr(session, field.name))
        sf.websafeKey = session.key.urlsafe()
        sf.check_initialized()
        return sf

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

        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        if conf.organizerUserId != user_id:
            raise endpoints.UnauthorizedException(
                "Not authorized. Only conference owner can add sessions"
            )

        # copy SessionForm/ProtoRPC Message into dict
        data = {
            field.name: getattr(
                request, field.name
            ) for field in request.all_fields()
        }
        websafeConferenceKey = data['websafeConferenceKey']
        del data['websafeConferenceKey']
        del data['websafeKey']

        # convert dates from strings to Date objects;
        # set month based on start_date
        if data['date']:
            data['date'] = datetime.strptime(
                data['date'][:10], "%Y-%m-%d"
            ).date()

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

        # generate Session Key based on Conference
        s_id = Session.allocate_ids(size=1, parent=conf.key)[0]
        s_key = ndb.Key(Session, s_id, parent=conf.key)
        data['key'] = s_key

        # create Session, add the set speaker task to the queue
        # creation of Session & return (modified) SessionForm
        session = Session(**data)
        session.put()

        taskqueue.add(params={'speaker': data["speaker"],
                              'websafeConferenceKey': websafeConferenceKey},
                      url='/tasks/set_speaker')

        return self._copySessionToForm(session)

    @endpoints.method(
        SessionForm,
        SessionForm,
        path='session',
        http_method='POST',
        name='createSession'
    )
    def createSession(self, request):
        """Create new session."""
        return self._createSessionObject(request)

    @endpoints.method(
        SESSION_GET_REQUEST,
        SessionForms,
        path='conference/{websafeConferenceKey}/sessions',
        http_method='GET',
        name='getConferenceSessions'
    )
    def getConferenceSessions(self, request):
        """Return conference sessions (by websafeConferenceKey)."""
        # get Conference object from request
        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)
        # get all Session objects with the conf ancestor
        sessions = Session.query(ancestor=conf.key)
        # return list of SessionForm objects
        return SessionForms(
            items=[self._copySessionToForm(session) for session in sessions]
        )

    @endpoints.method(
        SESSION_GET_REQUEST,
        SessionForms,
        path='conference/{websafeConferenceKey}/sessions/type/{typeOfSession}',
        http_method='GET', name='getConferenceSessionsByType'
    )
    def getConferenceSessionsByType(self, request):
        """Given a conference, return all sessions of a specified type"""

        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        # get all sessions of specified type for a specified conference
        sessions = Session.query(
            Session.typeOfSession == request.typeOfSession, ancestor=conf.key
        )

        # return set of SessionForm objects per Session
        return SessionForms(
            items=[self._copySessionToForm(session) for session in sessions]
        )

    @endpoints.method(
        SESSION_GET_REQUEST,
        SessionForms,
        path='speaker/{speaker}/sessions',
        http_method='GET',
        name='getSessionsBySpeaker'
    )
    def getSessionsBySpeaker(self, request):
        """Return all sessions of a specified type"""

        # get all sessions with the provided speaker
        sessions = Session.query(Session.speaker == request.speaker)

        # 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/date/{date}',
        http_method='GET',
        name='getConferenceSessionsByDate'
    )
    def getConferenceSessionsByDate(self, request):
        """Given a conference, return all sessions of a specified date"""

        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        # get all sessions on a specified date for a specified conference
        sessions = Session.query(
            Session.date == datetime.strptime(
                request.date[:10], "%Y-%m-%d"
            ).date(), ancestor=conf.key
        )

        # 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/highlight/{highlight}',
        http_method='GET',
        name='getConferenceSessionsByHighlight'
    )
    def getConferenceSessionsByHighlight(self, request):
        """Given a conference, return all sessions with specified highlight"""

        # fetch existing conference
        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        # get all sessions with specified highlight for a specified conference
        sessions = Session.query(
            Session.highlights == request.highlight,
            ancestor=conf.key
        )

        # return set of SessionForm objects per Session
        return SessionForms(
            items=[self._copySessionToForm(session) for session in sessions]
        )

# - - - Wishlist objects - - - - - - - - - - - - - - - - - -

    @endpoints.method(
        WISHLIST_POST_REQUEST, StringMessage,
        path='profile/wishlist/add/{websafeSessionKey}',
        http_method='POST', name='addSessionToWishList')
    def addSessionToWishlist(self, request):
        """Given a session, add it to the users wishlist"""

        # Get the current user
        user = endpoints.get_current_user()
        user_id = getUserId(user)
        # Get the profile for the current user
        profile_key = ndb.Key(Profile, user_id)
        profile = profile_key.get()
        # Check if the session is already in the wishlist
        # if it's not add it

        session = self._checkEntityKey(request.websafeSessionKey, SESSION)

        if session.key in profile.wishlist:
            return StringMessage(data="Session already in wishlist!")
        else:
            profile.wishlist.append(session.key)
            profile.put()
            return StringMessage(data="Session added to wishlist!")

    @endpoints.method(
        WISHLIST_POST_REQUEST, StringMessage,
        path='profile/wishlist/delete/{websafeSessionKey}',
        http_method='DELETE', name='deleteSessionInWishlist')
    def deleteSessionInWishlist(self, request):
        """Given a session, delete it from the users wishlist"""

        # Get the current user
        user = endpoints.get_current_user()
        user_id = getUserId(user)
        # Get the profile for the current user
        profile_key = ndb.Key(Profile, user_id)
        profile = profile_key.get()

        session = self._checkEntityKey(request.websafeSessionKey, SESSION)

        # Check if the session is already in the wishlist
        # if it is, remove it
        if session.key in profile.wishlist:
            profile.wishlist.remove(session.key)
            profile.put()
            return StringMessage(data="Session deleted from wishlist!")
        else:
            return StringMessage(data="Session not in wishlist!")

    @endpoints.method(
        message_types.VoidMessage, SessionForms,
        path='profile/wishlist',
        http_method='GET', name='getSessionsInWishlist')
    def getSessionsInWishlist(self, request):
        """Return all sessions in logged-in user's wishlist."""
        profile = self._getProfileFromUser()
        sessions = ndb.get_multi(profile.wishlist)
        return SessionForms(
            items=[self._copySessionToForm(s) for s 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))
                        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."""
        announcement = memcache.get(MEMCACHE_ANNOUNCEMENTS_KEY)
        if not announcement:
            announcement = ""
        return StringMessage(data=announcement)

# - - - Featured Speaker - - - - - - - - - - - - - - - - - - - -

    @endpoints.method(
        message_types.VoidMessage,
        StringMessage,
        path='conference/featured_speaker/get',
        http_method='GET',
        name='getFeaturedSpeaker'
    )
    def getFeaturedSpeaker(self, request):
        """Return Featured Speaker from memcache."""
        speaker = memcache.get(MEMCACHE_SPEAKER_KEY)

        return StringMessage(data=speaker or "")

    @staticmethod
    def _cacheSpeaker(speaker, wsck):
        """
        Create Featured Speaker and assign to memcache via task queue
        """

        speaker_message = memcache.get(MEMCACHE_SPEAKER_KEY) or ""

        conf = ConferenceApi._checkEntityKey(wsck, CONFERENCE)

        sessions = Session.query(ancestor=conf.key)
        sessions = sessions.filter(Session.speaker == speaker)
        if sessions.count() > 1:
            # If the sessions with the speaker is more than one
            # format speaker_message and set it in memcache
            speaker_message = SPEAKER_TPL % (
                speaker, ', '.join(session.name for session in sessions)
            )
            memcache.set(MEMCACHE_SPEAKER_KEY, speaker_message)

# - - - 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 = self._checkEntityKey(wsck, CONFERENCE)

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

api = endpoints.api_server([ConferenceApi])  # register API

#!/usr/bin/env python

"""
conference.py -- Udacity conference server-side Python App Engine API;
    uses Google Cloud Endpoints

$Id: conference.py,v 1.25 2014/05/24 23:42:19 wesc Exp wesc $

created by wesc on 2014 apr 21

"""
from datetime import datetime

import endpoints
from protorpc import messages
from protorpc import message_types
from protorpc import remote

from google.appengine.api import memcache
from google.appengine.api import taskqueue
from google.appengine.ext import ndb

from models import ConflictException
from models import Profile
from models import ProfileMiniForm
from models import ProfileForm
from models import StringMessage
from models import BooleanMessage
from models import Conference
from models import ConferenceForm
from models import ConferenceForms
from models import ConferenceQueryForm
from models import ConferenceQueryForms
from models import Session
from models import SessionForm
from models import SessionForms
from models import TeeShirtSize

from settings import WEB_CLIENT_ID
from settings import ANDROID_CLIENT_ID
from settings import IOS_CLIENT_ID
from settings import ANDROID_AUDIENCE

from utils import getUserId


__author__ = '<EMAIL> (<NAME>)'

EMAIL_SCOPE = endpoints.EMAIL_SCOPE
API_EXPLORER_CLIENT_ID = endpoints.API_EXPLORER_CLIENT_ID
MEMCACHE_ANNOUNCEMENTS_KEY = "RECENT_ANNOUNCEMENTS"
MEMCACHE_SPEAKER_KEY = "FEATURED_SPEAKER"
ANNOUNCEMENT_TPL = ('Last chance to attend! The following conferences '
                    'are nearly sold out: %s')
SPEAKER_TPL = ('Featured Speaker: %s in sessions:\n\n%s')


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

DEFAULTS = {
    "city": "Default City",
    "maxAttendees": 0,
    "seatsAvailable": 0,
    "topics": ["Default", "Topic"],
}

OPERATORS = {
    'EQ':   '=',
    'GT':   '>',
    'GTEQ': '>=',
    'LT':   '<',
    'LTEQ': '<=',
    'NE':   '!='
}

FIELDS = {
    'CITY': 'city',
    'TOPIC': 'topics',
    'MONTH': 'month',
    'MAX_ATTENDEES': 'maxAttendees',
}

CONF_GET_REQUEST = endpoints.ResourceContainer(
    message_types.VoidMessage,
    websafeConferenceKey=messages.StringField(1),
)

CONF_POST_REQUEST = endpoints.ResourceContainer(
    ConferenceForm,
    websafeConferenceKey=messages.StringField(1),
)

SESSION_GET_REQUEST = endpoints.ResourceContainer(
    message_types.VoidMessage,
    websafeConferenceKey=messages.StringField(1),
    typeOfSession=messages.StringField(2),
    speaker=messages.StringField(3),
    date=messages.StringField(4),
    highlight=messages.StringField(5)
)

SESSION_POST_REQUEST = endpoints.ResourceContainer(
    SessionForm,
    websafeConferenceKey=messages.StringField(1),
)

WISHLIST_POST_REQUEST = endpoints.ResourceContainer(
    message_types.VoidMessage,
    websafeSessionKey=messages.StringField(1),
)

CONFERENCE = "Conference"
SESSION = "Session"

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


@endpoints.api(
    name='conference',
    version='v1',
    audiences=[ANDROID_AUDIENCE],
    allowed_client_ids=[
        WEB_CLIENT_ID, API_EXPLORER_CLIENT_ID, ANDROID_CLIENT_ID, IOS_CLIENT_ID
    ],
    scopes=[EMAIL_SCOPE]
)
class ConferenceApi(remote.Service):
    """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
        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

    @staticmethod
    def _checkEntityKey(wskey, kind):

        #  Try to get the entity using the provided key
        try:
            entity = ndb.Key(urlsafe=wskey).get()

            #  Make sure entity is not None
            if not entity:
                raise endpoints.NotFoundException(
                    'A %s with provided key was not found' % kind)

            #  Check if entity with the provided key is the kind expected
            if entity.key.kind() != kind:
                raise endpoints.BadRequestException(
                    'Provided key was for kind: %s' % entity.key.kind())

            return entity

        except Exception as e:
            raise endpoints.BadRequestException(
                'Problem with provided key %s. %s' % (wskey, e))

    @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()
        }

        wsck = request.websafeConferenceKey
        # update existing conference
        conf = self._checkEntityKey(wsck, CONFERENCE)

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

        wsck = request.websafeConferenceKey
        # get Conference object from request
        conf = self._checkEntityKey(wsck, CONFERENCE)

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

# - - - 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 to date string and startTime to startTime string
                # just copy others
                if field.name == 'date' or field.name == 'startTime':
                    setattr(sf, field.name, str(getattr(session, field.name)))
                else:
                    setattr(sf, field.name, getattr(session, field.name))
        sf.websafeKey = session.key.urlsafe()
        sf.check_initialized()
        return sf

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

        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        if conf.organizerUserId != user_id:
            raise endpoints.UnauthorizedException(
                "Not authorized. Only conference owner can add sessions"
            )

        # copy SessionForm/ProtoRPC Message into dict
        data = {
            field.name: getattr(
                request, field.name
            ) for field in request.all_fields()
        }
        websafeConferenceKey = data['websafeConferenceKey']
        del data['websafeConferenceKey']
        del data['websafeKey']

        # convert dates from strings to Date objects;
        # set month based on start_date
        if data['date']:
            data['date'] = datetime.strptime(
                data['date'][:10], "%Y-%m-%d"
            ).date()

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

        # generate Session Key based on Conference
        s_id = Session.allocate_ids(size=1, parent=conf.key)[0]
        s_key = ndb.Key(Session, s_id, parent=conf.key)
        data['key'] = s_key

        # create Session, add the set speaker task to the queue
        # creation of Session & return (modified) SessionForm
        session = Session(**data)
        session.put()

        taskqueue.add(params={'speaker': data["speaker"],
                              'websafeConferenceKey': websafeConferenceKey},
                      url='/tasks/set_speaker')

        return self._copySessionToForm(session)

    @endpoints.method(
        SessionForm,
        SessionForm,
        path='session',
        http_method='POST',
        name='createSession'
    )
    def createSession(self, request):
        """Create new session."""
        return self._createSessionObject(request)

    @endpoints.method(
        SESSION_GET_REQUEST,
        SessionForms,
        path='conference/{websafeConferenceKey}/sessions',
        http_method='GET',
        name='getConferenceSessions'
    )
    def getConferenceSessions(self, request):
        """Return conference sessions (by websafeConferenceKey)."""
        # get Conference object from request
        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)
        # get all Session objects with the conf ancestor
        sessions = Session.query(ancestor=conf.key)
        # return list of SessionForm objects
        return SessionForms(
            items=[self._copySessionToForm(session) for session in sessions]
        )

    @endpoints.method(
        SESSION_GET_REQUEST,
        SessionForms,
        path='conference/{websafeConferenceKey}/sessions/type/{typeOfSession}',
        http_method='GET', name='getConferenceSessionsByType'
    )
    def getConferenceSessionsByType(self, request):
        """Given a conference, return all sessions of a specified type"""

        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        # get all sessions of specified type for a specified conference
        sessions = Session.query(
            Session.typeOfSession == request.typeOfSession, ancestor=conf.key
        )

        # return set of SessionForm objects per Session
        return SessionForms(
            items=[self._copySessionToForm(session) for session in sessions]
        )

    @endpoints.method(
        SESSION_GET_REQUEST,
        SessionForms,
        path='speaker/{speaker}/sessions',
        http_method='GET',
        name='getSessionsBySpeaker'
    )
    def getSessionsBySpeaker(self, request):
        """Return all sessions of a specified type"""

        # get all sessions with the provided speaker
        sessions = Session.query(Session.speaker == request.speaker)

        # 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/date/{date}',
        http_method='GET',
        name='getConferenceSessionsByDate'
    )
    def getConferenceSessionsByDate(self, request):
        """Given a conference, return all sessions of a specified date"""

        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        # get all sessions on a specified date for a specified conference
        sessions = Session.query(
            Session.date == datetime.strptime(
                request.date[:10], "%Y-%m-%d"
            ).date(), ancestor=conf.key
        )

        # 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/highlight/{highlight}',
        http_method='GET',
        name='getConferenceSessionsByHighlight'
    )
    def getConferenceSessionsByHighlight(self, request):
        """Given a conference, return all sessions with specified highlight"""

        # fetch existing conference
        wsck = request.websafeConferenceKey
        conf = self._checkEntityKey(wsck, CONFERENCE)

        # get all sessions with specified highlight for a specified conference
        sessions = Session.query(
            Session.highlights == request.highlight,
            ancestor=conf.key
        )

        # return set of SessionForm objects per Session
        return SessionForms(
            items=[self._copySessionToForm(session) for session in sessions]
        )

# - - - Wishlist objects - - - - - - - - - - - - - - - - - -

    @endpoints.method(
        WISHLIST_POST_REQUEST, StringMessage,
        path='profile/wishlist/add/{websafeSessionKey}',
        http_method='POST', name='addSessionToWishList')
    def addSessionToWishlist(self, request):
        """Given a session, add it to the users wishlist"""

        # Get the current user
        user = endpoints.get_current_user()
        user_id = getUserId(user)
        # Get the profile for the current user
        profile_key = ndb.Key(Profile, user_id)
        profile = profile_key.get()
        # Check if the session is already in the wishlist
        # if it's not add it

        session = self._checkEntityKey(request.websafeSessionKey, SESSION)

        if session.key in profile.wishlist:
            return StringMessage(data="Session already in wishlist!")
        else:
            profile.wishlist.append(session.key)
            profile.put()
            return StringMessage(data="Session added to wishlist!")

    @endpoints.method(
        WISHLIST_POST_REQUEST, StringMessage,
        path='profile/wishlist/delete/{websafeSessionKey}',
        http_method='DELETE', name='deleteSessionInWishlist')
    def deleteSessionInWishlist(self, request):
        """Given a session, delete it from the users wishlist"""

        # Get the current user
        user = endpoints.get_current_user()
        user_id = getUserId(user)
        # Get the profile for the current user
        profile_key = ndb.Key(Profile, user_id)
        profile = profile_key.get()

        session = self._checkEntityKey(request.websafeSessionKey, SESSION)

        # Check if the session is already in the wishlist
        # if it is, remove it
        if session.key in profile.wishlist:
            profile.wishlist.remove(session.key)
            profile.put()
            return StringMessage(data="Session deleted from wishlist!")
        else:
            return StringMessage(data="Session not in wishlist!")

    @endpoints.method(
        message_types.VoidMessage, SessionForms,
        path='profile/wishlist',
        http_method='GET', name='getSessionsInWishlist')
    def getSessionsInWishlist(self, request):
        """Return all sessions in logged-in user's wishlist."""
        profile = self._getProfileFromUser()
        sessions = ndb.get_multi(profile.wishlist)
        return SessionForms(
            items=[self._copySessionToForm(s) for s 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))
                        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."""
        announcement = memcache.get(MEMCACHE_ANNOUNCEMENTS_KEY)
        if not announcement:
            announcement = ""
        return StringMessage(data=announcement)

# - - - Featured Speaker - - - - - - - - - - - - - - - - - - - -

    @endpoints.method(
        message_types.VoidMessage,
        StringMessage,
        path='conference/featured_speaker/get',
        http_method='GET',
        name='getFeaturedSpeaker'
    )
    def getFeaturedSpeaker(self, request):
        """Return Featured Speaker from memcache."""
        speaker = memcache.get(MEMCACHE_SPEAKER_KEY)

        return StringMessage(data=speaker or "")

    @staticmethod
    def _cacheSpeaker(speaker, wsck):
        """
        Create Featured Speaker and assign to memcache via task queue
        """

        speaker_message = memcache.get(MEMCACHE_SPEAKER_KEY) or ""

        conf = ConferenceApi._checkEntityKey(wsck, CONFERENCE)

        sessions = Session.query(ancestor=conf.key)
        sessions = sessions.filter(Session.speaker == speaker)
        if sessions.count() > 1:
            # If the sessions with the speaker is more than one
            # format speaker_message and set it in memcache
            speaker_message = SPEAKER_TPL % (
                speaker, ', '.join(session.name for session in sessions)
            )
            memcache.set(MEMCACHE_SPEAKER_KEY, speaker_message)

# - - - 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 = self._checkEntityKey(wsck, CONFERENCE)

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

api = endpoints.api_server([ConferenceApi])  # register API

#!/usr/bin/env python conference.py -- Udacity conference server-side Python App Engine API;     uses Google Cloud Endpoints  $Id: conference.py,v 1.25 2014/05/24 23:42:19 wesc Exp wesc $  created by wesc on 2014 apr 21 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Conference API v0.1 # - - - Conference objects - - - - - - - - - - - - - - - - - Copy relevant fields from Conference to ConferenceForm. # convert Date to date string; just copy others Create or update Conference object, returning ConferenceForm/request. # preload necessary data items # copy ConferenceForm/ProtoRPC Message into dict # add default values for those missing # (both data model & outbound Message) # convert dates from strings to Date objects; # set month based on start_date # set seatsAvailable to be same as maxAttendees on creation # generate Profile Key based on user ID and Conference # ID based on Profile key get Conference key from ID # create Conference, send email to organizer confirming # creation of Conference & return (modified) ConferenceForm #  Try to get the entity using the provided key #  Make sure entity is not None #  Check if entity with the provided key is the kind expected # copy ConferenceForm/ProtoRPC Message into dict # update existing conference # check that user is owner # Not getting all the fields, so don't create a new object; just # copy relevant fields from ConferenceForm to Conference object # only copy fields where we get data # special handling for dates (convert string to Date) # write to Conference object Create new conference. Update conference w/provided fields & return w/updated info. Return requested conference (by websafeConferenceKey). # get Conference object from request # return ConferenceForm Return conferences created by user. # make sure user is authed # create ancestor query for all key matches for this user # return set of ConferenceForm objects per Conference Return formatted query from the submitted filters. # If exists, sort on inequality filter first Parse, check validity and format user supplied filters. # Every operation except "=" is an inequality # 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 Query for conferences. # need to fetch organiser displayName from profiles # get all keys and use get_multi for speed # put display names in a dict for easier fetching # return individual ConferenceForm object per Conference # - - - Session objects - - - - - - - - - - - - - - - - - - - Copy relevant fields from Session to SessionForm. # convert date to date string and startTime to startTime string # just copy others Create or update Session object, returning SessionForm/request. # preload necessary data items # copy SessionForm/ProtoRPC Message into dict # convert dates from strings to Date objects; # set month based on start_date # generate Session Key based on Conference # create Session, add the set speaker task to the queue # creation of Session & return (modified) SessionForm Create new session. Return conference sessions (by websafeConferenceKey). # get Conference object from request # get all Session objects with the conf ancestor # return list of SessionForm objects Given a conference, return all sessions of a specified type # get all sessions of specified type for a specified conference # return set of SessionForm objects per Session Return all sessions of a specified type # get all sessions with the provided speaker # return set of SessionForm objects per Session Given a conference, return all sessions of a specified date # get all sessions on a specified date for a specified conference # return set of SessionForm objects per Session Given a conference, return all sessions with specified highlight # fetch existing conference # get all sessions with specified highlight for a specified conference # return set of SessionForm objects per Session # - - - Wishlist objects - - - - - - - - - - - - - - - - - - Given a session, add it to the users wishlist # Get the current user # Get the profile for the current user # Check if the session is already in the wishlist # if it's not add it Given a session, delete it from the users wishlist # Get the current user # Get the profile for the current user # Check if the session is already in the wishlist # if it is, remove it Return all sessions in logged-in user's wishlist. # - - - Profile objects - - - - - - - - - - - - - - - - - - - Copy relevant fields from Profile to ProfileForm. # copy relevant fields from Profile to ProfileForm # convert t-shirt string to Enum; just copy others Return user Profile from datastore, creating new one if non-existent. # make sure user is authed # get Profile from datastore # create new Profile if not there # return Profile Get user Profile and return to user, possibly updating it first. # get user Profile # if saveProfile(), process user-modifyable fields # return ProfileForm Return user profile. Update & return user profile. # - - - Announcements - - - - - - - - - - - - - - - - - - - - Create Announcement & assign to memcache; used by         memcache cron job & putAnnouncement(). # If there are almost sold out conferences, # format announcement and set it in memcache # If there are no sold out conferences, # delete the memcache announcements entry Return Announcement from memcache. # - - - Featured Speaker - - - - - - - - - - - - - - - - - - - - Return Featured Speaker from memcache. Create Featured Speaker and assign to memcache via task queue # If the sessions with the speaker is more than one # format speaker_message and set it in memcache # - - - Registration - - - - - - - - - - - - - - - - - - - - Register or unregister user for selected conference. # get user Profile # check if conf exists given websafeConfKey # get conference; check that it exists # register # check if user already registered otherwise add # check if seats avail # register user, take away one seat # unregister # check if user already registered # unregister user, add back one seat # write things back to the datastore & return Get list of conferences that user has registered for. # get user Profile # get organizers # put display names in a dict for easier fetching # return set of ConferenceForm objects per Conference Register user for selected conference. Unregister user for selected conference. Filter Playground # field = "city" # operator = "=" # value = "London" # f = ndb.query.FilterNode(field, operator, value) # q = q.filter(f) # register API