BroadbandTV Hackaton Tic-Tac-Toe's Challenge

BroadbandTV back-end challenge for Vanhackaton Weekend.

Comment

This project has been made for the 2016 Vanhackaton weekend.

It consists in a API for the game Tic-Tac-Toe. It also use the BizLay bundles for the back-end abstraction.

About the Bizlay bundles.

The Bizlay bundles are currently maintained by Pablo "Phackwer" Sanchez, who I had the pleasure to work here in Brasília (Brazil).

Tools used to build the project.

  • IntelliJ IDEA 2016.
  • Git.
  • MySQL Database.
  • Symfony2.8 PHP Framework.
  • OS X El Capitan.
  • OS X Built-in curl library (for tests/debug).

Installation.

  • Create an database (name it as you like) and an user, then grant all privileges on the new database to the new user.
  • Clone the project repo in the folder you prefer.
  • Edit app/config/parameters.yml with the database information you used in the step above.

After cloning the repo, navigate to the repo's "api" folder and execute the following commands:

  • php bin/composer.phar install
  • php app/console doctrine:schema:update --force
  • php app/console server:start

You can now use the api to play the game!

Game logic.

  • User must hit player creation API first before creating a grid (internally the grid is a game). It will create the session cookies.
  • the api must be security protected against not logged in users.
  • Players can create grids.
    • As many grids he wants.
    • When creating a grid, the player automatically joins on it.
  • Players can join grids.
    • Only grids that have less than 2 players joined.
    • Player can't join in a grid that he is already joined.
  • Players can check (mark) on a grid.
    • Only on grids that is not already finished.
    • Player can't check on a position that is already checked.
    • Players can't check twice in a row.
    • Players can't check in a invalid position (the grid is a 3x3 array, so he can't check on 4xN position, for example).
  • Determining if a grid has a winner or it's a tie:
    • The logic used to determine if the game has a winner uses Magic Square logic. It consists in 3x3 grid where each position has a value, the sum of the positions of each row, column or diagonal must be 15.
    • I used permutation to determine all possibilities of 3 positions checked by the player in the grid, then I iterate all arrays determining if the sum of the items is equal to 15.
    • A tie is set on a grid that doesn't have a winner after 7 marks.

All Api's

  • /api/player/{id}.{_format}
  • /api/player/delete/{id}.{_format}
  • /api/player/excels/export.{_format}
  • /api/player/pdfs/export.{_format}
  • /api/player/htmls/export.{_format}
  • /api/player/search.{_format}
  • /api/player/saves.{_format}
  • /api/player/autocomplete.{_format}
  • /api/grid/{id}.{_format}
  • /api/grid/delete/{id}.{_format}
  • /api/grid/excels/export.{_format}
  • /api/grid/pdfs/export.{_format}
  • /api/grid/htmls/export.{_format}
  • /api/grid/creates.{_format}
  • /api/grid/joins.{_format}
  • /api/grid/search.{_format}
  • /api/grid/saves.{_format}
  • /api/grid/autocomplete.{_format}
  • /api/gridcheck/{id}.{_format}
  • /api/gridcheck/delete/{id}.{_format}
  • /api/gridcheck/excels/export.{_format}
  • /api/gridcheck/pdfs/export.{_format}
  • /api/gridcheck/htmls/export.{_format}
  • /api/gridcheck/saves.{_format}
  • /api/gridcheck/search.{_format}
  • /api/gridcheck/autocomplete.{_format}
  • /api/playergrid/{id}.{_format}
  • /api/playergrid/delete/{id}.{_format}
  • /api/playergrid/excels/export.{_format}
  • /api/playergrid/pdfs/export.{_format}
  • /api/playergrid/htmls/export.{_format}
  • /api/playergrid/search.{_format}
  • /api/playergrid/saves.{_format}
  • /api/playergrid/autocomplete.{_format}

How to use it.

First of all, you need to get an session ID: curl -c ~/cookies.txt -H "Content-Type: application/json" -X POST -d '{"dsName": "Pedro"}' http://localhost:8000/app_dev.php/api/player/saves Response: Player's ID

Then you can play around!

Create a grid:

curl -b ~/cookies.txt -H "Content-Type: application/json" -X POST http://localhost:8000/app_dev.php/api/grid/creates

Join a grid:

curl -b ~/cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {id: 10}}' http://localhost:8000/app_dev.php/api/grid/joins

Check a position on a grid:

curl -b ~/cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 18}, "colPos": 2, "rowPos": 1}' http://localhost:8000/app_dev.php/api/gridcheck/saves

Simulating a real game where Foo is the winner:

  • Creating players

  • Foo creates a Grid and waits for Bar to join in.

    • curl -b ~/foo-cookies.txt -H "Content-Type: application/json" -X POST http://localhost:8000/app_dev.php/api/grid/creates
      • Response: {"success":true,"playerGrid":{"id":22,"isActive":true,"dtCreate":"2016-05-21T13:36:49-03:00","grid":{"id":19,"isActive":true,"dtCreate":"2016-05-21T13:36:49-03:00"},"player":{"id":13,"dtCreate":"2016-05-21T13:36:17-03:00","isActive":true,"dsName":"Foo","dsKey":"1f3b7f1e658a314e2b6f8c589ce1f037","playerGrids":[],"password":"1f3b7f1e658a314e2b6f8c589ce1f037","username":"Foo","wins":[]}}}

  • Bar joins in Foo's Grid:

    • curl -b ~/bar-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}}' http://localhost:8000/app_dev.php/api/grid/joins
      • Response: {"success":true,"playerGrid":{"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[]}}

  • Foo checks position 1x1:

    • curl -b ~/foo-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}, "colPos": 1, "rowPos": 1}' http://localhost:8000/app_dev.php/api/gridcheck/saves
      • Response: {"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[{"id":8,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":1,"dt_create":"2016-05-21T13:39:06-0300"}]}

  • Bar checks position 2x2:

    • curl -b ~/bar-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}, "colPos": 2, "rowPos": 2}' http://localhost:8000/app_dev.php/api/gridcheck/saves
      • Response: {"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[{"id":8,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":1,"dt_create":"2016-05-21T13:39:06-0300"},{"id":9,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":2,"row_pos":2,"dt_create":"2016-05-21T13:40:34-0300"}]}

  • Foo checks position 3x3:

    • curl -b ~/foo-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}, "colPos": 3, "rowPos": 3}' http://localhost:8000/app_dev.php/api/gridcheck/saves
      • Response: {"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[{"id":8,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":1,"dt_create":"2016-05-21T13:39:06-0300"},{"id":9,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":2,"row_pos":2,"dt_create":"2016-05-21T13:40:34-0300"},{"id":10,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":3,"row_pos":3,"dt_create":"2016-05-21T13:41:34-0300"}]}

  • Bar checks position 3x1:

    • curl -b ~/bar-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}, "colPos": 1, "rowPos": 3}' http://localhost:8000/app_dev.php/api/gridcheck/saves
      • Response: {"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[{"id":8,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":1,"dt_create":"2016-05-21T13:39:06-0300"},{"id":9,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":2,"row_pos":2,"dt_create":"2016-05-21T13:40:34-0300"},{"id":10,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":3,"row_pos":3,"dt_create":"2016-05-21T13:41:34-0300"},{"id":11,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":3,"dt_create":"2016-05-21T13:41:57-0300"}]}

  • Foo checks position 1x3:

    • curl -b ~/foo-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}, "colPos": 3, "rowPos": 1}' http://localhost:8000/app_dev.php/api/gridcheck/saves
      • Response: {"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[{"id":8,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":1,"dt_create":"2016-05-21T13:39:06-0300"},{"id":9,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":2,"row_pos":2,"dt_create":"2016-05-21T13:40:34-0300"},{"id":10,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":3,"row_pos":3,"dt_create":"2016-05-21T13:41:34-0300"},{"id":11,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":3,"dt_create":"2016-05-21T13:41:57-0300"},{"id":12,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":3,"row_pos":1,"dt_create":"2016-05-21T13:42:22-0300"}]}

  • Bar checks position 1x2:

    • curl -b ~/bar-cookies.txt -H "Content-Type: application/json" -X POST -d '{"grid": {"id": 1}, "colPos": 2, "rowPos": 1}' http://localhost:8000/app_dev.php/api/gridcheck/saves
      • Response: {"id":19,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300","grid_players":[{"id":22,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"},{"id":23,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[],"wins":[]},"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"grid_checks":[{"id":8,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":1,"dt_create":"2016-05-21T13:39:06-0300"},{"id":9,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":2,"row_pos":2,"dt_create":"2016-05-21T13:40:34-0300"},{"id":10,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":3,"row_pos":3,"dt_create":"2016-05-21T13:41:34-0300"},{"id":11,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":1,"row_pos":3,"dt_create":"2016-05-21T13:41:57-0300"},{"id":12,"player":{"id":13,"dt_create":"2016-05-21T13:36:17-0300","is_active":true,"ds_name":"Foo","player_grids":[{"id":22,"is_active":true,"dt_create":"2016-05-21T13:36:49-0300"}],"wins":[]},"is_active":true,"col_pos":3,"row_pos":1,"dt_create":"2016-05-21T13:42:22-0300"},{"id":13,"player":{"id":14,"dt_create":"2016-05-21T13:36:22-0300","is_active":true,"ds_name":"Bar","player_grids":[{"id":23,"is_active":true,"dt_create":"2016-05-21T13:38:23-0300"}],"wins":[]},"is_active":true,"col_pos":2,"row_pos":1,"dt_create":"2016-05-21T13:42:50-0300"}]}

  • Foo checks position 2x3 and wins the game marking all positions on the third column!

Get the list of all active grids:

Get the list of all active players:

Built With

Share this project:

Updates