Run Application

Requirements

1. Eclipse (latest version download link: https://www.eclipse.org/downloads/)
2. MySQL v8.0.22 (download link: https://dev.mysql.com/downloads/mysql/)
   • If prompted please set root password 12345678 during installation or if already installed change root password to 12345678
   • create a database named "wave" in root user
3. Postman (API Client to test the API, download link:https://www.postman.com/downloads/)
4. macOS (my version is Big Sur)

Steps to run the project

• Download the bundle file named API_PayRoll.bundle
• Open terminal to directory where API_PayRoll.bundle has been downloaded
• Run this command: git clone -b master API_PayRoll.bundle
  • A folder named "API_PayRoll" should be generated containing a folder named "se-challenge-payroll"
• Launch Eclipse then select file > import > maven > Existing Maven Projects
• Set root directory to "API" from the "se-challenge-payroll" directory of "API_PayRoll" directory and press finish
  • The project should be imported
• In Eclipse project explorer expand API > src/main/java > com.rest.api and open ApiApplication.java
• Run it (API will start)

If any issue occurs during set up, please email to mofaruk@uwaterloo.ca

Steps to Integrate with API client (Postman)

• Launch Postman
• Select create new > collection > any_name (e. g. wave)

CSV Upload endpoint (POST)

• Add a new request in "wave" and give it a name (e.g. csv upload)
• Go to the request and set enter request url to http://localhost:8080/add
• Select body > form-data
• Type "file" in key field and select "file" from the adjacent dropdown menu. A "select file" option will appear on the value field.
• Upload the csv and send request (the csv file name and data should exactly be in same format as in sample csv file)
• Upon Successful request the response will be success. (CSV data will be inserted into database)

JSON endpoint (GET)

• Add a new request in "wave" and give it a name (e.g. get report)
• Go to the request and set enter request url to http://localhost:8080/report
• Send request
• Upon Successful request the response will be JSON

Project Description

Imagine that this is the early days of Wave's history, and that we are prototyping a new payroll system API. A front end (that hasn't been developed yet, but will likely be a single page application) is going to use our API to achieve two goals:

1. Upload a CSV file containing data on the number of hours worked per day per employee
2. Retrieve a report detailing how much each employee should be paid in each pay period

All employees are paid by the hour (there are no salaried employees.) Employees belong to one of two job groups which determine their wages; job group A is paid $20/hr, and job group B is paid $30/hr. Each employee is identified by a string called an "employee id" that is globally unique in our system.

Hours are tracked per employee, per day in comma-separated value files (CSV). Each individual CSV file is known as a "time report", and will contain:

1. A header, denoting the columns in the sheet (date, hours worked, employee id, job group)
2. 0 or more data rows

In addition, the file name should be of the format time-report-x.csv, where x is the ID of the time report represented as an integer. For example, time-report-42.csv would represent a report with an ID of 42.

You can assume that:

1. Columns will always be in that order.
2. There will always be data in each column and the number of hours worked will always be greater than 0.
3. There will always be a well-formed header line.
4. There will always be a well-formed file name.

A sample input file named time-report-42.csv is included in this repo.

What your API must do:

We've agreed to build an API with the following endpoints to serve HTTP requests:

1. An endpoint for uploading a file.

   • This file will conform to the CSV specifications outlined in the previous section.
   • Upon upload, the timekeeping information within the file must be stored to a database for archival purposes.
   • If an attempt is made to upload a file with the same report ID as a previously uploaded file, this upload should fail with an error message indicating that this is not allowed.

2. An endpoint for retrieving a payroll report structured in the following way:

   NOTE: It is not the responsibility of the API to return HTML, as we will delegate the visual layout and redering to the front end. The expectation is that this API will only return JSON data.

   • Return a JSON object payrollReport.
   • payrollReport will have a single field, employeeReports, containing a list of objects with fields employeeId, payPeriod, and amountPaid.
   • The payPeriod field is an object containing a date interval that is roughly biweekly. Each month has two pay periods; the first half is from the 1st to the 15th inclusive, and the second half is from the 16th to the end of the month, inclusive. payPeriod will have two fields to represent this interval: startDate and endDate.
   • Each employee should have a single object in employeeReports for each pay period that they have recorded hours worked. The amountPaid field should contain the sum of the hours worked in that pay period multiplied by the hourly rate for their job group.
   • If an employee was not paid in a specific pay period, there should not be an object in employeeReports for that employee + pay period combination.
   • The report should be sorted in some sensical order (e.g. sorted by employee id and then pay period start.)
   • The report should be based on all of the data across all of the uploaded time reports, for all time.

   As an example, given the upload of a sample file with the following data:

   date	hours worked	employee id	job group
   2020-01-04	10	1	A
   2020-01-14	5	1	A
   2020-01-20	3	2	B
   2020-01-20	4	1	A

   A request to the report endpoint should return the following JSON response:

   {
     payrollReport: {
       employeeReports: [
         {
           employeeId: 1,
           payPeriod: {
             startDate: "2020-01-01",
             endDate: "2020-01-15"
           },
           amountPaid: "$300.00"
         },
         {
           employeeId: 1,
           payPeriod: {
             startDate: "2020-01-16",
             endDate: "2020-01-31"
           },
           amountPaid: "$80.00"
         },
         {
           employeeId: 2,
           payPeriod: {
             startDate: "2020-01-16",
             endDate: "2020-01-31"
           },
           amountPaid: "$90.00"
         }
       ];
     }
   }