Creating the TIMEBANK game mode API

README.md

@@ -41,7 +41,8 @@ PUT /game
         "timer": number,
         "rounds": number,
         "onlyAmerica": boolean (default: false),
-        "generationMethod": string (default: "MAPCRUNCH")
+        "generationMethod": string (default: "MAPCRUNCH"),
+        "ruleSet": string (default: "NORMAL")
     }
     Returns 200 and {
         "gameId": string
@@ -51,7 +52,8 @@ GET /game/{ID}/config
         "timer": number,
         "rounds": number,
         "onlyAmerica": boolean,
-        "generationMethod": string
+        "generationMethod": string,
+        "ruleSet": string
     }
 GET /game/{ID}/coords
     Returns 404 vs 200 and {

client/README.md

@@ -1,68 +0,0 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.<br>
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.<br>
-You will also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.<br>
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.<br>
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

server/app.py

@@ -32,7 +32,7 @@ def version():
     """
     Return the version of the API and a status message, "healthy"
     """
-    return jsonify({"version": "4", "status": "healthy"})
+    return jsonify({"version": "5", "status": "healthy"})
 
 
 if __name__ == "__main__":

server/db.py

@@ -13,11 +13,12 @@ class Game(db.Model):
     linked_game = db.Column(db.String)
     only_america = db.Column(db.Boolean)
     gen_method = db.Column(db.String)
+    rule_set = db.Column(db.String)
     coordinates = db.relationship("Coordinate", lazy=True, order_by="Coordinate.round_number")
     players = db.relationship("Player", lazy=True, backref="game")
 
     @staticmethod
-    def create(timer, rounds, only_america, gen_method, coords):
+    def create(timer, rounds, only_america, gen_method, rule_set, coords):
         game_id = str(uuid.uuid4())
         while Game.query.get(game_id) is not None:
             # basically impossible collision, but let's be safe
@@ -29,6 +30,7 @@ class Game(db.Model):
             rounds=rounds,
             only_america=only_america,
             gen_method=gen_method,
+            rule_set=rule_set,
         )
         db.session.add(new_game)
 
@@ -92,6 +94,17 @@ class Player(db.Model):
     def add_timeout(self, round_num):
         self.add_guess(round_num, -200, -200, None, 0)
 
+    def get_last_round_time_remaining(self):
+        if len(self.guesses) == 0:
+            return None
+        return self.guesses[-1].time_remaining
+
+    def timeout_remaining_rounds(self):
+        round_num = self.get_current_round()
+        if round_num is not None:
+            for r in range(round_num, self.game.rounds + 1):
+                self.add_timeout(r)
+
 
 class Coordinate(db.Model):
     game_id = db.Column(db.String, db.ForeignKey("game.game_id"), primary_key=True)

server/game_api.py

@@ -52,12 +52,16 @@ def create_game():
     if not isinstance(gen_method, str):
         abort(400)
 
+    rule_set = js.get("ruleSet", "NORMAL")
+    if not isinstance(rule_set, str):
+        abort(400)
+
     src = sources.get((gen_method, only_america), None)
     if src is None:
         abort(400)
     
     coords = src.get_points(n=rounds)
-    new_game = db.Game.create(timer, rounds, only_america, gen_method, coords)
+    new_game = db.Game.create(timer, rounds, only_america, gen_method, rule_set, coords)
 
     return jsonify({"gameId": new_game.game_id})
 
@@ -70,6 +74,7 @@ def game_config(game_id):
         "rounds": g.rounds,
         "onlyAmerica": g.only_america,
         "generationMethod": g.gen_method,
+        "ruleSet": g.rule_set,
     })
 
 
@@ -160,15 +165,22 @@ def current_round(game_id):
                 "lat": lookup.latitude,
                 "lng": lookup.longitude,
             }
+    if g.rule_set == "TIMEBANK":
+        timer = player.get_last_round_time_remaining()
+        if timer is None:
+            timer = g.timer * g.rounds
+    else:
+        timer = g.timer
     return jsonify({
         "currentRound": cur_rnd,
         "coord": coord,
-        "timer": g.timer,
+        "timer": int(timer),
     })
 
 
 @game.route("/<game_id>/guesses/<int:round_num>", methods=["POST"])
 def make_guess(game_id, round_num):
+    g = require_game(game_id)
     player = require_player(game_id)
     if round_num != player.get_current_round():
         abort(409)
@@ -180,6 +192,8 @@ def make_guess(game_id, round_num):
     timed_out = js.get("timeout", False)
     if timed_out:
         player.add_timeout(round_num)
+        if g.rule_set == "TIMEBANK":
+            player.timeout_remaining_rounds()
         db.session.commit()
         return jsonify({
             "score": 0,
@@ -200,6 +214,10 @@ def make_guess(game_id, round_num):
 
     guess_score, distance = lib.score((target.latitude, target.longitude), (lat, lng))
     player.add_guess(round_num, lat, lng, guess_score, remaining)
+
+    if remaining <= 0 and g.rule_set == "TIMEBANK":
+        player.timeout_remaining_rounds()
+
     return jsonify({
         "score": guess_score,
         "totalScore": player.get_total_score(),