api.py

# -*- coding: utf-8 -*-`
"""api.py - Create and configure the Game API exposing the resources.
Concerned primarily with communication to/from the API's users."""

import logging
import endpoints
import json, random
from protorpc import remote, messages
from google.appengine.api import memcache
from google.appengine.api import taskqueue

from models import User, Game, Score, Language
from models import StringMessage, GameForm,\
    ScoreForms, LanguageForm, LanguageForms, GameForms, UserForm,\
    UserForms, StringMessage, RequestByGoogleID, UserRequest, NewGameRequest,\
    RequestByGameKey, MakeMoveRequest, RequestByUserKey,\
    GamesByUserIDRequest, ScoreRequest
from utils import get_by_urlsafe


NEW_GAME_REQUEST = endpoints.ResourceContainer(NewGameRequest)
REQUEST_BY_GAME_KEY = endpoints.ResourceContainer(RequestByGameKey)
MAKE_MOVE_REQUEST = endpoints.ResourceContainer(MakeMoveRequest)
USER_REQUEST = endpoints.ResourceContainer(UserRequest)
REQUEST_BY_GOOGLE_ID = endpoints.ResourceContainer(RequestByGoogleID)
REQUEST_BY_USER_KEY = endpoints.ResourceContainer(RequestByUserKey)
GAMES_BY_USER_ID_REQUEST = endpoints.ResourceContainer(GamesByUserIDRequest)
SCORE_REQUEST = endpoints.ResourceContainer(ScoreRequest)

MEMCACHE_MATCH_ATTEMPTS = 'MATCH_ATTEMPTS'

@endpoints.api(name='word_match', version='v1', 
    allowed_client_ids=['510381281726-4dbug0nd52nj5eq6q1mopccr6ggs542u.apps.googleusercontent.com'],
    auth_level=endpoints.AUTH_LEVEL.OPTIONAL_CONTINUE)
class WordMatchApi(remote.Service):
    """Game API
    """
    @endpoints.method(request_message=USER_REQUEST,
                      response_message=UserForm,
                      path='user',
                      name='create_user_from_google',
                      http_method='POST')
    def create_user_from_google(self, request):
        """Create a User from Google account info. 
        Requires a unique Google account id.
        """

        if User.query(User.google_id == request.user_google_id).get():
            raise endpoints.ConflictException(
                    'A User with that google id already exists!')

        user = User(name=request.user_name, email=request.email,
                    google_id=request.user_google_id)
        user.put()

        return user.to_form()

    @endpoints.method(request_message=REQUEST_BY_GOOGLE_ID,
                      response_message=UserForm,
                      path='getuser',
                      name='get_user_from_google_id',
                      http_method='POST')
    def get_user_from_google_id(self, request):
        """Get a user by the user's google account ID
        """

        logging.info(request)
        logging.info(request.user_google_id)
        user = User.query(User.google_id == request.user_google_id).get()
        
        logging.info(user)

        if not user:
            message = 'No user with the id "%s" exists.' % request.user_google_id
            raise endpoints.NotFoundException(message)

        to_form = user.to_form()
        logging.info(to_form)
        return to_form

    @endpoints.method(request_message=GAMES_BY_USER_ID_REQUEST,
                      response_message=GameForms,
                      path='getusergames',
                      name='get_user_games',
                      http_method='POST')
    def get_user_games(self, request):
        """Get a user's scores by user key
        """
        user = get_by_urlsafe(request.urlsafe_user_key, User)
        
        if not user:
            message = 'No user with the id "%s" exists.' % request.user_google_id
            raise endpoints.NotFoundException(message)

        if request.active:
            games = Game.query(Game.user == user.key, Game.game_over == False)
        else:
            games = Game.query(Game.user == user.key)

        return GameForms(items=[game.to_form() for game in games])

    @endpoints.method(request_message=NEW_GAME_REQUEST,
                      response_message=GameForm,
                      path='game',
                      name='create_game',
                      http_method='POST')
    def create_game(self, request):
        """Creates new game
        """
        user = get_by_urlsafe(request.urlsafe_user_key, User)

        if not user:
            raise endpoints.ForbiddenException(
                    'No (or invalid) user selected!')

        language = Language.query(Language.name == request.language).get()

        if not language:
            raise endpoints.NotFoundException(
                    'The requested language does not exist in the server.')

        logging.info(request.possible_matches)

        if request.possible_matches > 20 or request.possible_matches < 1:
            raise endpoints.ForbiddenException('Possible matches must be at least '\
                             '1 and at most 20')

        logging.info(request.max_attempts)
        if not request.max_attempts >= request.possible_matches:
            raise endpoints.ForbiddenException('Max attempts must be greater '\
                             'than or equal to possible matches')

        cards = language.cards

        card_ids = {}

        # generate random card ids to pick for the game
        for x in range(0, request.possible_matches):

            idToUse = random.randint(0, len(cards)/2)

            while idToUse in card_ids:

                idToUse = random.randint(0, len(cards)/2)

            card_ids[str(idToUse)] = True

        logging.info(card_ids)
        game_cards = []

        # get the cards
        logging.info(cards)
        for x in range(0, len(cards)):

            if str(cards[x]["id"]) in card_ids:

                logging.info(cards[x])
                game_cards.append(cards[x])

        random.shuffle(game_cards)

        logging.info(game_cards)

        # assign the position for board layout
        for x in range(0, len(game_cards)):

            game_cards[x]["position"] = x
            game_cards[x]["isFlipped"] = False

        game = Game(user=user.key,
                    possible_matches=request.possible_matches,
                    language=language.key,
                    cards=game_cards,
                    successful_matches=0,
                    selected_card={},
                    num_match_attempts=0,
                    match_attempts=[],
                    match_in_progress=False,
                    max_attempts=request.max_attempts,
                    game_over=False)
        game.put()

        # Use a task queue to update the average words typed.
        # This operation is not needed to complete the creation of a new game
        # so it is performed out of sequence.
        taskqueue.add(url='/tasks/cache_average_attempts')
        return game.to_form()

    @endpoints.method(request_message=REQUEST_BY_GAME_KEY,
                      response_message=GameForm,
                      path='getgame',
                      name='get_game',
                      http_method='POST')
    def get_game(self, request):
        """Return the current game state.
        """
        game = get_by_urlsafe(request.urlsafe_game_key, Game)
        if game:
            return game.to_form()
        else:
            raise endpoints.NotFoundException('Game not found!')

    @endpoints.method(request_message=REQUEST_BY_GAME_KEY,
                      response_message=GameForm,
                      path='getgamehistory',
                      name='get_game_history',
                      http_method='POST')
    def get_game_history(self, request):
        """Return the current game state.
        NOTE: Just calls 'get_game'.  This is because a game object
        already contains all moves in order, so there is currently no reason
        to use this method and it is only here because Udacity required it by name.
        """
        return get_game(self, request)

    @endpoints.method(request_message=REQUEST_BY_GAME_KEY,
                      response_message=StringMessage,
                      path='cancelgame',
                      name='cancel_game',
                      http_method='POST')
    def cancel_game(self, request):
        """Cancel (delete) the given game.
        """
        game = get_by_urlsafe(request.urlsafe_game_key, Game)

        if not game:
            raise endpoints.NotFoundException('Game not found!')

        if game.game_over:
            raise endpoints.ForbiddenException(
                'Cannot cancel a completed game.')

        game.key.delete()
        return StringMessage(message="Game cancelled.")

    @endpoints.method(request_message=MAKE_MOVE_REQUEST,
                      response_message=GameForm,
                      path='makemove',
                      name='make_move',
                      http_method='PUT')
    def make_move(self, request):
        """Handler for attempted match. Returns updated game state.
        """
        game = get_by_urlsafe(request.urlsafe_game_key, Game)

        if not game:
            raise endpoints.NotFoundException("Game not found!")

        if game.game_over:
            return endpoints.ForbiddenException(
                    'Game already over!')

        if game.cards[request.flipped_card_position]["isFlipped"]:
            return endpoints.ForbiddenException(
                'That card is already face up!')

        # get the selected and previously selected card positions
        # [whole method ripe for refactoring]
        # remember, x = a card's position, just renaming some variables
        thisSelectedCardIndex = request.flipped_card_position

        if "position" in game.selected_card:

            previouslySelectedCardIndex = game.selected_card["position"]

        # flip the selected card
        game.cards[thisSelectedCardIndex]["isFlipped"] = True

        # evaluate a match attempt if appropriate
        if game.match_in_progress:

            # record the match attempt
            game.num_match_attempts += 1
            game.match_attempts.append([previouslySelectedCardIndex, 
                                        thisSelectedCardIndex])

            # determine if match
            if game.selected_card["id"] == game.cards[thisSelectedCardIndex]["id"]:
                # keep them flipped
                game.successful_matches += 1
            else:
                # flip them back over
                game.cards[thisSelectedCardIndex]["isFlipped"] = False
                game.cards[previouslySelectedCardIndex]["isFlipped"] = False

            game.match_in_progress = False
            game.selected_card = {}
        else:

            game.match_in_progress = True
            game.selected_card = game.cards[thisSelectedCardIndex]

        if game.successful_matches >= game.possible_matches:

            game.end_game(True)
        elif game.num_match_attempts >= game.max_attempts:

            game.end_game(False)

        game.put()
        return game.to_form()

    @endpoints.method(request_message=SCORE_REQUEST,
                      response_message=ScoreForms,
                      path='highscores',
                      name='get_high_scores',
                      http_method='POST')
    def get_high_scores(self, request):
        """Return high scores
        """
        scores = Score.query().order(-Score.percentage_matched, -Score.difficulty)

        if not scores:
            raise endpoints.NotFoundException("No scores yet!")

        if request.limit:

            scores = scores.fetch(request.limit)

        return ScoreForms(items=[score.to_form() for score in scores])

    @endpoints.method(request_message=REQUEST_BY_USER_KEY,
                      response_message=ScoreForms,
                      path='getuserscores',
                      name='get_user_scores',
                      http_method='POST')
    def get_user_scores(self, request):
        """Returns all of an individual User's scores
        """
        user = get_by_urlsafe(request.urlsafe_user_key, User)
        if not user:
            raise endpoints.NotFoundException(
                    'A User with that name does not exist!')
        scores = Score.query(Score.user == user.key)

        if not scores:
            raise endpoints.NotFoundException("No scores for this user yet!")

        return ScoreForms(items=[score.to_form() for score in scores])

    @endpoints.method(response_message=UserForms,
                      path='getrankings',
                      name='get_user_rankings',
                      http_method='GET')
    def get_user_rankings(self, request):
        """Returns users ordered by ranking
        """
        users = User.query().order(-User.win_percentage, -User.average_difficulty)

        if not users:
            raise endpoints.NotFoundException("No users yet!")

        return UserForms(items=[user.to_form() for user in users])

    @endpoints.method(response_message=LanguageForms,
                      path='languages',
                      name='get_languages',
                      http_method='GET')
    def get_languages(self, request):
        """Returns all available languages
        """
        return LanguageForms(items=[language.to_form() for language in Language.query()])

    # average attempts is probably a not-great metric to cache but at least the code is here
    @endpoints.method(response_message=StringMessage,
                      path='games/average_attempts',
                      name='get_average_attempts_remaining',
                      http_method='GET')
    def get_average_attempts(self, request):
        """Get the cached average attempts for every game
        """
        return StringMessage(message=memcache.\
            get(MEMCACHE_MATCH_ATTEMPTS) or '')

    @staticmethod
    def _cache_average_attempts():
        """Populates memcache with the average match attempts of each completed Game
        """
        games = Game.query(Game.game_over == True).fetch()

        if games:
            count = len(games)
            total_match_attempts = sum([game.num_match_attempts
                                        for game in games])
            average = float(total_match_attempts)/count
            memcache.set(MEMCACHE_MATCH_ATTEMPTS,
                         'The average match attempts is {:.2f}'.format(average))

api = endpoints.api_server([WordMatchApi])