/
api.py
195 lines (164 loc) · 7.34 KB
/
api.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# -*- coding: utf-8 -*-`
"""api.py - Create and configure the Game API exposing the resources.
This can also contain game logic. For more complex games it would be wise to
move game logic to another file. Ideally the API will be simple, concerned
primarily with communication to/from the API's users."""
import endpoints
from protorpc import remote, messages
from models import User, Game, StringMessage, GameForms, GameForm, ScoreForms, Score, UserForm, MoveForms
from utils import get_by_urlsafe
USER_REQUEST = endpoints.ResourceContainer(user_name=messages.StringField(1),
email=messages.StringField(2))
MAKE_MOVE = endpoints.ResourceContainer(
user_name=messages.StringField(1),
email=messages.StringField(2),
letter=messages.StringField(3, required=True),
urlsafe_game_key=messages.StringField(4, required=True)
)
USER_SCORES = endpoints.ResourceContainer(
user_name=messages.StringField(1),
email=messages.StringField(2),
number_of_results=messages.IntegerField(3)
)
USER_RANKING = endpoints.ResourceContainer(
user_name=messages.StringField(1),
email=messages.StringField(2),
won=messages.IntegerField(3),
lost=messages.IntegerField(4),
score=messages.IntegerField(5),
rank=messages.IntegerField(6)
)
URL_SAFE_REQUEST = endpoints.ResourceContainer(
urlsafe_game_key=messages.StringField(1, required=True),
)
@endpoints.api(name='hangman', version='v1')
class HangmanApi(remote.Service):
"""Game API"""
def _get_user(self, request):
""" Helper method to get the user object """
email, user_name = self._get_user_info(request)
user = User.query(User.email == email and User.name == user_name).get()
if user == None:
raise endpoints.NotFoundException('User does not exist')
else:
return user
def _get_user_info(self, request):
"""" Helper method to get user info """
if request.email != None and request.user_name != None:
user_name = request.user_name
email = request.email
else:
user_name = endpoints.get_current_user().nickname()
email = endpoints.get_current_user().email()
return email, user_name
def _get_last_game_played(self, user):
""" Get all the last game played """
return Game.query(Game.user == user.key and Game.game_over == False).get()
@endpoints.method(request_message=USER_REQUEST,
response_message=StringMessage,
path='user',
name='create_user',
http_method='POST')
def create_user(self, request):
"""Create a User. Requires a unique username and email"""
email, user_name = self._get_user_info(request)
# check if it's a valid email
if not '@' in email:
raise endpoints.UnauthorizedException('This is not a valid email')
if User.query(User.name == user_name and User.email == email).get():
raise endpoints.ConflictException('A User with that name or email already exists!')
user = User(name=user_name, email=email)
user.put()
return StringMessage(message='User {} created!'.format(user_name))
@endpoints.method(request_message=USER_REQUEST,
response_message=StringMessage,
path='game',
name='create_game',
http_method='POST')
def create_game(self, request):
""" Create a new Game, Requires a unique username and email """
user = self._get_user(request)
games = Game.query(Game.user == user.key and Game.game_over == False).fetch()
if len(games) == 0:
Game.new_game(user.key)
message = 'Game Created'
else:
message = 'You have already a running game'
return StringMessage(message=message)
@endpoints.method(request_message=USER_REQUEST,
response_message=GameForms,
path='user',
name='get_user_games',
http_method='GET')
def get_user_games(self, request):
""" Get the user games. Requires the user info's """
user = self._get_user(request)
if not user:
raise endpoints.NotFoundException('A User with that name does not exist!')
games = Game.query(Game.user == user.key)
return GameForms(items=[game.to_form() for game in games])
@endpoints.method(request_message=MAKE_MOVE,
response_message=GameForm,
path='game/{urlsafe_game_key}',
name='make_move',
http_method='PUT')
def make_move(self, request):
""" Make a move. Requires the user info and the character played. Returns the game state"""
game = get_by_urlsafe(request.urlsafe_game_key, Game)
# if there are no running game
if game == None:
return GameForm(message="There are no runnig game for this account")
# if the game it's not over
if not game.game_over:
game.make_move(request.letter)
else:
return GameForm(message="This game is over")
return game.to_form()
@endpoints.method(request_message=USER_REQUEST,
response_message=StringMessage,
path='game/cancel',
name='cancel_game',
http_method='POST')
def cancel_game(self, request):
""" Cancel a game """
user = self._get_user(request)
game = self._get_last_game_played(user)
if game == None:
message = 'There no running game for this account'
else:
game.end_game(won=False)
message = 'Game canceled'
return StringMessage(message=message)
@endpoints.method(request_message=USER_SCORES,
response_message=ScoreForms,
path='scores',
name='get_high_scores',
http_method='GET')
def get_high_scores(self, request):
""" Get the user scores, Requires the user info's"""
user = self._get_user(request)
if request.number_of_results:
scores = Score.query(Score.user == user.key).order(Score.score).fetch(limit=request.number_of_results)
else:
scores = Score.query(Score.user == user.key).order(Score.score)
return ScoreForms(items=[score.to_form() for score in scores])
@endpoints.method(request_message=USER_REQUEST,
response_message=UserForm,
path='user/rank',
name='get_user_rankings',
http_method='GET')
def get_user_rankings(self, request):
""" Get the user rank """
user = self._get_user(request)
user.get_user_rank()
return user.to_form()
@endpoints.method(request_message=URL_SAFE_REQUEST,
response_message=MoveForms,
path='game/history',
name='get_game_history',
http_method='GET')
def get_game_history(self, request):
""" Get the moves history for a game """
game = get_by_urlsafe(request.urlsafe_game_key, Game)
return game.get_move_forms()
api = endpoints.api_server([HangmanApi])