pipe1098 / valee-challenge Goto Github PK

🌟This API was built using MySQL as the database, Springboot framework, JPA and kotlin. It provides functionality to create suppliers, load invitations from a CSV file, and retrieve a list of existing invitations 🗄️.

• Springboot
• Kotlin
• MySQL

• JDK 11 https://jdk.java.net/java-se-ri/11
• Gradle https://gradle.org/install/
• MySQL https://dev.mysql.com/downloads/installer/

• IntelliJ Community https://www.jetbrains.com/idea/download/
• Postman https://www.postman.com/downloads/

• To get a local copy up and running follow these steps.

• Clone the repository:
• git clone https://github.com/Pipe1098/Valee-challenge.git

Before running the server, you need to set up the database connection. Open the application.properties file in the resources folder and modify the following lines to connect to your MySQL database:

## Spring DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
spring.datasource.url = jdbc:mysql://spring.datasource.url?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true&useSSL=false
spring.datasource.username = your_username
spring.datasource.password = your_password
});

Replace "spring.datasource.url", "your_username" and "your_password" with your actual MySQL database credentials.

Create the supplier table:

 CREATE TABLE supplier (
  id bigint(20) NOT NULL AUTO_INCREMENT,
  name varchar(256) NOT NULL,
  code varchar(45) DEFAULT NULL,
  is_active bit(1) DEFAULT b'1',
  entry_date datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (id)
);

Create the supplier_invitation table along with the foreign key reference to the supplier table:

CREATE TABLE supplier_invitation (
  id bigint(20) NOT NULL AUTO_INCREMENT,
  supplier_id bigint(20) DEFAULT NULL,
  commerce_cell_phone varchar(256) DEFAULT NULL,
  entry_date datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (id),
  FOREIGN KEY (supplier_id) REFERENCES supplier (id)
);

go to class VaalersApplication.kt an click on the run button

• you can use postman to test the following enpoints:

Request Type: POST

Endpoint: /invitation/csv

Request Headers:

Content-Type: multipart/form-data

Accept: application/json

• Request Body: File CSV: Upload a CSV file containing the invitations (prueba.csv).

• Response: Status Code: 200 (OK)

• Example Response:

{
  "code": 0,
  "message": "Invitations loaded successfully"
}

Method: POST

Request Header:

Summary: Create a new supplier.

Description: This endpoint allows you to create a new supplier and store it in the database.

Parameters: JSON object containing supplier details (name, code).

Request Body:

{
  "name": "company2",
  "code": "PROV147"
}

• Example Response: Status: 201 Created Body:

{
  "id": 1,
  "name": "company2",
  "code": "PROV147",
  "isActive": true,
  "entryDate": "2023-07-27T12:34:56.000Z"
}

Request Type: GET

Request Headers:

Accept: application/json

Status: 200 OK

Example Response:

{
  "apiResponse": {
    "code": 0,
    "message": "OK"
  },
  "list": [
    {
      "supplierId": 1,
      "supplierName": "company2",
      "commerceCellPhone": "+123456789012"
    }
    
  ]
}

./gradlew test

Contributions are welcome! Please feel free to open a pull request.