HUland Casino Project

This project is part of an assignment for the course Backend Programming 2 (BEP2) at the Hogeschool Utrecht, University of Applied Sciences.

Starter project

This starter project contains the following:

• A Maven-based setup with several third-party libraries and frameworks (see: pom.xml)
• A preconfigured Spring project
• A component for JWT-based user authentication and authorisation (nl.hu.bep2.casino.security)
• A component for basic chip functionality (nl.hu.bep2.casino.chips)
• A container-based development environment for PostgreSQL (see: development/db/Dockerfile and docker-compose.yml)

Note that the two supporting components are data-driven rather than domain-driven; they lack a domain layer. For your assignment, you should create a new package for your game and create layers within that package. It's recommended to add a domain layer for proper object orientation.

Prerequisites

Although it is recommended to always use the latest stable version of Java, this project requires a version of Java 11 or higher. You can customize this in your compilation settings and pom.xml.

For Maven, you can use your IDE, install it globally, or use the supplied mvnw or mvnw.cmd.

Project setup without Docker

If you are not using Docker for your database, you need PostgreSQL 12 or higher to be installed. For the application to work, we need the correct user and database to be created. In PostgreSQL, create the user bep2-huland-casino with the password bep2-huland-casino and the database bep2-huland-casino.

This can be done with the following SQL-queries (mind the quotation marks):

CREATE USER "bep2-huland-casino" WITH CREATEDB PASSWORD 'bep2-huland-casino';
CREATE DATABASE "bep2-huland-casino" OWNER "bep2-huland-casino";

You can change these names if you like, but keep in mind that you need to also change them in our application configuration in src/resources/application.properties.

The database interaction is handled by Spring Data. Database-specific implementation details are part of another course.

Project setup with Docker

Although not supported on every system, Development is easiest with Docker. If Docker is installed, you can start the database by executing docker-compose up from the commandline (or docker-compose start to run it in the background), while the current directory is the root of this project. Docker will then start a PostgreSQL image with the configuration stated in the docker-compose.yml and in development/db.

This creates an admin user with the username and password admin and admin and a user, password and database for the application, all called bep2-huland-casino.

Troubleshooting Docker

If you already have PostgreSQL running in the background and you don't want to stop that process, you will have to change the port-binding from 5432:5432 to something else, for instance 15432:5432 in docker-compose.yml and in src/resources/application.properties.

If data does not seem to be persisted when restarting the database, make sure Docker has a volume assigned to it. Add the project's directory or parent directory under Settings > Resources > File Sharing.

If you cannot seem to connect to the database, make sure Docker is allowed to use the host's network.

Booting

First, make sure the database is set up, started and reachable.

Start the application via your IDE by running the CasinoApplication class. Alternatively, run mvn spring-boot:start.

Using Postman

Postman can be used as an HTTP client for doing requests to backend APIs like the one we are building. Use and extend the collection in this repository found in hu-land-casino.postman_collection.json.

Automatic authentication and authorisation

In this collection, Postman has been configured to automatically process the Authorization header from the login response and add it as a collection variable.

The collection has been setup to authenticate any request using this token.

How do authentication and authorisation work?

The security component allows users to register and login. Its general configuration is found in nl.hu.bep2.casino.SecurityConfig. Authentication is configured in ...presentation.filter.JwtAuthenticationFilter, while Authorization is handled ...presentation.filter.JwtAuthorizationFilter.

Registration

Users can be registered via the API. Passwords are hashed using a password encoder (bcrypt), so that passwords are not stored in plain-text.

Registration can be done via a POST request to /register. A body should be supplied with the following JSON (replace values to your liking):

{
    "username": "admin",
    "password": "admin",
    "firstName": "Ad",
    "lastName": "Min"
}

Login

The login is based on JSON Web Tokens, offering session-less authorisation.

Login by sending a POST request to /login, with the following body (replace values to your liking):

{
    "username": "admin",
    "password": "admin"
}

A 200 OK is returned upon a successful login. The JWT token is found as a Bearer token in the Authorization header of the response.

Copy this exact header in subsequent requests in order to remain logged in! Note that the supplied Postman collection does this automatically.