Revature Swagg Shop

This repository holds the account microservice which handles:

• user creation
• user information updates
• user authentication
• retrieving user information
• user account creation
• user account updates
• user account retrieval
• account type creation
• account type updates
• account type retrieval

These requests are handled by three controllers: UserController, AccountController, and AccountTypeController

Endpoints and methods are mapped out below.

UserController

Endpoints

VERB	URL	USE
GET	/user/all	get all registered users
POST	/user/new	add new user
POST	/user/login	authentication service
POST	/user/user	find user by id
PUT	/user/info	update user information
PUT	/user/cred	update user password only
PUT	/user/pic	update a user's profile picture
PUT	/user/master	update user to admin

Methods

public List<Users> getAllUsers()

Retrieves all users in the database.

public User addNewUser(@RequestBody User user)

Adds a new user to the database upon registration

public User loginUser(@RequestBody User user)

Compares login credentials with what is in the database, will return null is invalid.

public User findUserById(@RequestBody User user)

Will pull a user from database by their ID or email.

public void updateInformation(@RequestBody User user)
public void updatePassword(@RequestBody User user)
public void updateProfilePic(@RequestBody User user)
public void updateIsAdmin(@RequestBody User user)

Will take in new user info and update the user in the database

AccountController

Endpoints

VERB	URL	USE
PUT	/account/points	save new point total to db
PUT	/account/points/a	add to account's points
POST	/account/new	saves the new account
POST	/account/account	find account by id
POST	/account/accounts	find accounts by user id

Methods

public void updatePoints(@RequestBody Account acc)

Takes in the new account point total and saves it to database

public void addPoints(@RequestBody Account acc)

Will take the new points and add them to the account point total

public Account addAccount(@RequestBody Account acc)

Takes in the new account and adds it to the database

public Account getAccountById(@RequestBody Account acc)

Will return the account, from the database, by the id

public List<Account> findAccountByUserId(@RequestBody User acc)

Will return accounts related to the user id and return a list

AccountTypeController

Endpoints

VERB	URL	USE
POST	/acctype/type	admins can add account types to the database
GET	/acctype/all	returns all account types
PUT	/acctype/type/u	updates a current account type

Methods

public AccountType addAccountType(@RequestBody AccountType accType)

As an admin can add account types to the database

public List<AccountType> getAllAccountType()

Will pull all of the account types and return a list

public void updateAccountType(@RequestBody AccountType accType)

Will update a current account type(for spelling errors, ect)

Getting started

• If you already have Docker Desktop with Kubernetes running on your machine with the nginx-ingress service skip to the setup files portion of this walkthrough
• You need to have Docker installed on your computer. Install Docker here.
• If you are running windows Docker Desktop is your quickest option.
• Enable Kubernetes on Docker Desktop in settings.
• Install Helm on your machine if you are using Windows. This will allow for the quick installation of the nginx-ingress. Helm nginx-ingress.
• Once you have the nginx-ingress in your Kubernetes services use kubctl apply -f rss-account-setup.yaml to deploy this service

Viewing Changes Locally for Testing

• You must have a Dockerhub account. Use docker build -t yourdockerhub/rss-account-service . to build the Docker image and push that image to your Dockerhub.
• Change the image target in the rss-account-setup.yaml in the deployment section to use the image from your Dockerhub that you just pushed.
• Use kubctl apply -f rss-account-setup.yaml to redeploy your new image.