CF example app: ping-pong matching server

This is an app to match ping-pong players with each other. It's currently an API only, so you have to use curl to interact with it.

It has an acceptance test suite you might like to look at.

Note: We highly recommend that you use the latest versions of any software required by this sample application.

Running on Pivotal Web Services

Log in.

cf login -a https://api.run.pivotal.io

Target your org / space. An empty space is recommended, to avoid naming collisions.

cf target -o myorg -s myspace

Sign up for a cleardb instance.

cf create-service cleardb spark mysql

Push the app. Its manifest assumes you called your ClearDB instance 'mysql'.

cf push -n mysubdomain

Export the test host

export HOST=http://mysubdomain.cfapps.io

Now follow the interaction instructions.

Running locally

The following assumes you have a working, recent version of nodejs installed.

Install and start MySQL:

brew install mysql
mysql.server start
mysql -u root

Create a database user and table in the MySQL REPL you just opened:

CREATE USER 'sailspong'@'localhost' IDENTIFIED BY 'sailspong';
CREATE DATABASE pong_matcher_sails_development;
GRANT ALL ON pong_matcher_sails_development.* TO 'sailspong'@'localhost';
exit

Install dependencies:

npm install

Migrate the database:

DATABASE_URL=mysql://sailspong:sailspong@/pong_matcher_sails_development ./node_modules/.bin/db-migrate up

Install the sails command line:

npm install -g sails

Start the application server:

sails lift

Export the test host

export HOST=http://localhost:1337

Now follow the interaction instructions.

Interaction instructions

Start by clearing the database from any previous tests. You should get a 200.

curl -v -X DELETE $HOST/all

Then request a match, providing both a request ID and player ID. Again, you should get a 200.

curl -v -H "Content-Type: application/json" -X PUT $HOST/match_requests/firstrequest -d '{"player": "andrew"}'

Now pretend to be someone else requesting a match:

curl -v -H "Content-Type: application/json" -X PUT $HOST/match_requests/secondrequest -d '{"player": "navratilova"}'

Let's check on the status of our first match request:

curl -v -X GET $HOST/match_requests/firstrequest

The bottom of the output should show you the match_id. You'll need this in the next step.

Now pretend that you've got back to your desk and need to enter the result:

curl -v -H "Content-Type: application/json" -X POST $HOST/results -d '
{
    "match_id":"thematchidyoureceived",
    "winner":"andrew",
    "loser":"navratilova"
}'

You should get a 201 Created response.

Future requests with different player IDs should not cause a match with someone who has already played. The program is not yet useful enough to allow pairs who've already played to play again.