https://github.com/rbkgh/billablehoursapi

docker docker-compose gradle hibernate integration-testing java k8s kotlin kubernetes spring-boot unit-testing

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/rbkgh/billablehoursapi
Owner: RbkGh
Created: 2020-06-06T03:26:38.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2020-06-09T06:01:35.000Z (almost 6 years ago)
Last Synced: 2025-03-05T03:41:34.743Z (about 1 year ago)
Topics: docker, docker-compose, gradle, hibernate, integration-testing, java, k8s, kotlin, kubernetes, spring-boot, unit-testing
Language: Kotlin
Size: 1.37 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# billableHours API - compute billable hours that lawyers have worked on projects
### Shot For 100% Code Coverage
![alt text](https://github.com/RbkGh/billableHoursAPI/blob/master/demo_test.png)
### Requirements
> Kotlin V1.3.72+

> docker V18.09.2+

> docker-compose v1.23.2+
### For a quick introduction to the project design decisions,architecture,trade-offs and others, listen to this audio
:point_down: :point_down: :point_down:
> [Right Here](https://bit.ly/BillableAPI) :point_left: :point_left:

:point_up: :point_up: :point_up:

### Run All Tests
> just type code below in your root directory,no need to have gradle installed on your machine as we are using the wrapper
```$xslt
./gradlew test
```
### Quick Run(Gradle)
```$xslt
./gradlew bootRun
```
### Quick Start - Run With Docker [If you are running with docker instead,then change the active profile property in application.properties to "prod"]
```$xslt

1. docker-compose build
2. docker-compose up [Make sure nothing is running on port 8080]

```
> Once you use the docker ,You can now access API on http://localhost:8080/billablehours-api , not http://localhost:8080/

> Note, you should be able to run all the sample responses below and get the same result.
### View Documentation About All Endpoints
[http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html)

### Default Credentials
```$xslt
username = lawyer1@gmail.com
password = pass1234
Role => Lawyer

username = finance1@gmail.com
password = pass1234
Role => Finance Administrator

```

### Sample Requests And Responses
#### Authentication or signin
> Request
```$xslt
POST http://localhost:8080/api/v1/auth/signin
Accept: */*
Cache-Control: no-cache
Content-Type: application/json

{
"username": "lawyer1@gmail.com",
"password": "pass1234"
}

```

> Response
```$xslt
{
"token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJsYXd5ZXIxQGdtYWlsLmNvbSIsImlhdCI6MTU5MTU5MDg5NCwiZXhwIjoxNTkyMTk1Njk0fQ.pavyfoIoZW-f-R07UG2aJjszP2ttycQZuFQiJeSJ-N1YMjK18M2_ciS2-sFaA_4OAK-UkySni_gTvAG77wtgJg",
"id": 1,
"firstName": "rodney",
"roleName": "ROLE_LAWYER",
"surName": "boachie"
}
```

### Create Lawyer Billable Work Log
>Request
```$xslt
POST http://localhost:8080/api/v1/lawyer/1/bill
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJsYXd5ZXIxQGdtYWlsLmNvbSIsImlhdCI6MTU5MTU1ODg4MywiZXhwIjoxNTkyMTYzNjgzfQ.OKY-SJjgzmKAfKd0HbJyMIxWnJqsgnUayo2M2CDVWdSNzSzldOG8x3rGrrVBBl9K6Rjp_hGQWYFXLNOd2tqtpg

{
"billableRate": 300,
"companyID": 1,
"dateOfDay": "2020-06-07T19:39:52.193+00:00",
"startTime": "2023-03-07T07:39:52.000+00:00",
"endTime": "2023-03-07T09:39:52.000+00:00",
"userID": 1
}

```
>Response
```$xslt
HTTP/1.1 201
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Transfer-Encoding: chunked
Date: Mon, 08 Jun 2020 04:41:02 GMT

Response code: 201; Time: 229ms; Content length: 0 bytes
```

### Get Lawyer Billable Work Period Within Time Range (Week,Month or Whatever)
> Request
```$xslt
GET http://localhost:8080/api/v1/lawyer/1/timesheet?startDate=2023-03-07&endDate=2023-03-07
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJsYXd5ZXIxQGdtYWlsLmNvbSIsImlhdCI6MTU5MTU1ODg4MywiZXhwIjoxNTkyMTYzNjgzfQ.OKY-SJjgzmKAfKd0HbJyMIxWnJqsgnUayo2M2CDVWdSNzSzldOG8x3rGrrVBBl9K6Rjp_hGQWYFXLNOd2tqtpg

```
> Response
```$xslt
GET http://localhost:8080/api/v1/lawyer/1/timesheet?startDate=2023-03-07&endDate=2023-03-07

HTTP/1.1 200
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 08 Jun 2020 16:56:40 GMT
Keep-Alive: timeout=60
Connection: keep-alive

### Get All Lawyer Billable Work Period - Implemented Role Authorization Security such that Only Accessible By Finance Administrator Users

> Request
```$xslt
GET http://localhost:8080/api/v1/lawyer/timesheet
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJmaW5hbmNlMUBnbWFpbC5jb20iLCJpYXQiOjE1OTE2Mzg1MzEsImV4cCI6MTU5MjI0MzMzMX0.FolHgdDGWDD3nYsbRhYBffpHcHfLegefBEZSMhQWgqElKwRV4M2bENZhmqQvkNU7qdhkW4MmGSz6jMx2hOqp8w

```
> Response
```$xslt
GET http://localhost:8080/api/v1/lawyer/timesheet

[
{
"id": 1,
"user": {
"id": 1,
"email": "lawyer1@gmail.com",
"dateCreated": 1591592050000,
"firstName": "rodney",
"surName": "boachie",
"dateOfBirth": 1591574400000,
"accountActive": true,
"roleList": [
{
"id": 1,
"roleName": {
"roleDescription": "ROLE_LAWYER"
},
"privilegeList": []
}
]
},
"billableRate": 300.00,
"company": {
"id": 1,
"companyName": "MTN"
},
"dateOfDay": 1591558792193,
"startTime": 1678174792000,
"endTime": 1678181992000,
"noOfHours": 2,
"durationCost": 600.00
},
{
"id": 2,
"user": {
"id": 1,
"email": "lawyer1@gmail.com",
"dateCreated": 1591592050000,
"firstName": "rodney",
"surName": "boachie",
"dateOfBirth": 1591574400000,
"accountActive": true,
"roleList": [
{
"id": 1,
"roleName": {
"roleDescription": "ROLE_LAWYER"
},
"privilegeList": []
}
]
},
"billableRate": 300.00,
"company": {
"id": 1,
"companyName": "MTN"
},
"dateOfDay": 1591558792193,
"startTime": 1678174792000,
"endTime": 1678181992000,
"noOfHours": 2,
"durationCost": 600.00
}
]
```

###
> Request :
```$xslt
GET http://localhost:8080/api/v1/finance/company/1/invoice?startDate=2020-06-07&endDate=2020-06-07
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJmaW5hbmNlMUBnbWFpbC5jb20iLCJpYXQiOjE1OTE2Mzg1MzEsImV4cCI6MTU5MjI0MzMzMX0.FolHgdDGWDD3nYsbRhYBffpHcHfLegefBEZSMhQWgqElKwRV4M2bENZhmqQvkNU7qdhkW4MmGSz6jMx2hOqp8w

```

> Response Sample:
```$xslt

HTTP/1.1 200
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 09 Jun 2020 05:39:47 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
"company": {
"id": 1,
"companyName": "MTN"
},
"employeeBillRecords": [
{
"employeeID": 1,
"totalNoOfHours": 2,
"unitPrice": 300.00,
"totalCostOfWork": 600.00
}
],
"totalCompanyBillCost": 600.0
}

Response code: 200; Time: 237ms; Content length: 173 bytes

```

> As you can see, everything has already been logically calculated on the backend.
> meaning that any frontend engineer can pick the API and implement in a shortwhile

# Kubernetes(k8s) deployment
```
// first, set active profile to prod for google kubernetes or prod for amazon eks in application.properties
docker build -t dockerrodneykb2/bha-api-server-backend:latest -t dockerrodneykb2/bha-api-server-backend:latest . --file=Dockerfile
docker push dockerrodneykb2/bha-api-server-backend:latest
kubect rollout restart deploy bha-api-server-backend-deployment

// if a different id is logged in you can do
docker logout // this will log the account out
// then you can do
docker login // this will request new username and password to authenticate,that's all.
```

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/rbkgh/billablehoursapi

Awesome Lists containing this project

README