Matchi Web Server

This is the web server for the Matchi app. Below is a description of the use cases required for testing.

Use Case Tests

ServerIP: http://52.16.78.184/

This is a RESTful api. Requests are made with standard HTTP request methods GET, POST, PUT and DELETE.

You may find it helpful to use resty to make HTTP requests - this can be found at https://github.com/micha/resty

If not, curl (https://curl.haxx.se/) may be helpful.

Create user

HTTP POST request to the resource /api/users containing json content body with the keys 'firstname', 'lastname', 'facebookid', and optionally 'email'. The server shall return json with the keys 'user_id' and 'AuthToken'.

Get user

HTTP GET request to the resource /api/users/{userid} with the custom header 'AuthToken' the 'AuthToken' being the same as is returned when creating a user, as seen above. Without the 'AuthToken' header, the server shall return 'Unauthorised'. The server shall return a JSON object on success, or user not found.

Delete user

HTTP DELETE request to the resource /api/users/{userid} with the custom header 'AuthToken' the 'AuthToken' the same as is returned when creating a user. Without the 'AuthToken' header, the server shall return 'Unauthorised'. Subsequent get requests for this user shall fail with 'Unauthorised'.

Update user location

HTTP PUT request to the resource /api/users/{userid}/location with the custom header 'AuthToken' the 'AuthToken' the same as is returned when creating a user. Without the 'AuthToken' header, the server shall return 'Unauthorised'. The server shall return 'Location saved' on success.

Get user matches

HTTP GET request to the resource /api/users/{userid}/matches with the custom header 'AuthToken' the 'AuthToken' the same as is returned when creating a user. Without the 'AuthToken' header, the server shall return 'Unauthorised'. The server shall return a JSON object on success, or empty array if no matches exist.

Block user

HTTP POST request to the resource /api/users/{userid}/blocked/{blockuserid} with the custom header 'AuthToken' the 'AuthToken' the same as is returned when creating a user. Without the 'AuthToken' header, the server shall return 'Unauthorised'. The server shall return 'Blocked succesfully' on success.

Unblock user

HTTP DELETE request to the resource /api/users/{userid}/blocked/{unblockuserid} with the custom header 'AuthToken' the 'AuthToken' the same as is returned when creating a user. Without the 'AuthToken' header, the server shall return 'Unauthorised'. The server shall return 'Unblocked succesfully' on success.

Get blocked users

HTTP GET request to the resource /api/users/{userid}/blocked with the custom header 'AuthToken' the 'AuthToken' the same as is returned when creating a user. Without the 'AuthToken' header, the server shall return 'Unauthorised'. The server shall return a JSON object on success, or empty array if no matches exist.

Built on the Lumen PHP Framework

Laravel Lumen is a stunningly fast PHP micro-framework for building web applications with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Lumen attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as routing, database abstraction, queueing, and caching.

Official Documentation

Documentation for the framework can be found on the Lumen website.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at [email protected]. All security vulnerabilities will be promptly addressed.

License

The Lumen framework is open-sourced software licensed under the MIT license