Compare commits
37 Commits
e3393c8834
...
openapi_in
Author | SHA1 | Date | |
---|---|---|---|
d60cb8b48d | |||
50d35beb63 | |||
20bca79472 | |||
095f34581d | |||
6da9d762df | |||
81ce4fdb4c | |||
ebd76a30ee | |||
6ff6ce5052 | |||
60ec920cff | |||
900a4c5bdc | |||
d0b615c59d | |||
eccf116f49 | |||
8491c9b3cf | |||
137bc84c21 | |||
3c61fdca93 | |||
5ee3755548 | |||
52511dd4c4 | |||
84b70f8f38 | |||
834d68949c | |||
fea8687664 | |||
c94d3654ce | |||
d5c89bf8f4 | |||
78c72bdd72 | |||
307c7e700b | |||
8d486dce89 | |||
653f923693 | |||
64da3c9ab0 | |||
419ceec1bc | |||
e011a5534e | |||
ef964c4d35 | |||
5608b12f84 | |||
467babab79 | |||
a2e2395cc2 | |||
067eeb9494 | |||
b355463dd9 | |||
79e949bdd4 | |||
ef8c8e896d |
@ -9,6 +9,14 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout sources
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Load .env file
|
||||
uses: xom9ikk/dotenv@v2.3.0
|
||||
with:
|
||||
path: ./config/
|
||||
mode: dev
|
||||
load-mode: strict
|
||||
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
@ -18,8 +26,8 @@ jobs:
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v4
|
||||
with:
|
||||
cache-disabled: true
|
||||
cache-disabled: true # Once the code has been pushed once in main, this should be reenabled.
|
||||
|
||||
- name: init gradle
|
||||
working-directory: ./MyINPulse-back/
|
||||
run: ./gradlew build -x test # todo: run test, currently fail because no database is present
|
||||
run: ./gradlew build # todo: run test, currently fail because no database is present
|
||||
|
4
.gitignore
vendored
4
.gitignore
vendored
@ -2,4 +2,6 @@
|
||||
.idea
|
||||
keycloak/CAS/target
|
||||
docker-compose.yaml
|
||||
postgres/data
|
||||
node_modules
|
||||
.vscode
|
||||
postgres/data
|
||||
|
24
Makefile
24
Makefile
@ -19,8 +19,14 @@ front/MyINPulse-front/.installed:
|
||||
|
||||
vite: ./front/MyINPulse-front/.installed
|
||||
|
||||
keycloak: ./keycloak/.installed
|
||||
|
||||
dev-front: clean vite
|
||||
keycloak/.installed:
|
||||
@echo "running one time install"
|
||||
@cd keycloak/CAS && sudo sh build.sh
|
||||
@touch ./keycloak/.installed
|
||||
|
||||
dev-front: clean vite keycloak
|
||||
@cp config/frontdev.env front/MyINPulse-front/.env
|
||||
@cp config/frontdev.env .env
|
||||
@cp config/frontdev.env MyINPulse-back/.env
|
||||
@ -28,7 +34,7 @@ dev-front: clean vite
|
||||
@docker compose up -d --build
|
||||
@cd ./front/MyINPulse-front/ && npm run dev
|
||||
|
||||
prod: clean
|
||||
prod: clean keycloak
|
||||
@cp config/prod.env front/MyINPulse-front/.env
|
||||
@cp config/prod.env .env
|
||||
@cp config/prod.env .env
|
||||
@ -37,7 +43,7 @@ prod: clean
|
||||
|
||||
|
||||
|
||||
dev-back:
|
||||
dev-back: keycloak
|
||||
@cp config/backdev.env front/MyINPulse-front/.env
|
||||
@cp config/backdev.env .env
|
||||
@cp config/backdev.env MyINPulse-back/.env
|
||||
@ -46,7 +52,7 @@ dev-back:
|
||||
@echo "cd MyINPulse-back" && echo 'export $$(cat .env | xargs)'
|
||||
@echo "./gradlew bootRun --args='--server.port=8081'"
|
||||
|
||||
dev: clean vite
|
||||
dev: clean vite keycloak
|
||||
@cp config/dev.env front/MyINPulse-front/.env
|
||||
@cp config/dev.env .env
|
||||
@cp config/dev.env MyINPulse-back/.env
|
||||
@ -55,3 +61,13 @@ dev: clean vite
|
||||
@echo "cd MyINPulse-back" && echo 'export $$(cat .env | xargs)'
|
||||
@echo "./gradlew bootRun --args='--server.port=8081'"
|
||||
@cd ./front/MyINPulse-front/ && npm run dev &
|
||||
|
||||
test-back: clean keycloak
|
||||
@cp config/dev.env front/MyINPulse-front/.env
|
||||
@cp config/dev.env .env
|
||||
@cp config/dev.env MyINPulse-back/.env
|
||||
@cp config/dev.docker-compose.yaml docker-compose.yaml
|
||||
@docker compose up -d --build
|
||||
@echo "cd MyINPulse-back" && echo 'export $$(cat .env | xargs)'
|
||||
@cd ./MyINPulse-back/ && ./gradlew test && ./gradlew jacocoTestReport
|
||||
@firefox ./MyINPulse-back/build/jacocoHtml/index.html
|
||||
|
@ -2,6 +2,7 @@ plugins {
|
||||
id 'java'
|
||||
id 'org.springframework.boot' version '3.4.2'
|
||||
id 'io.spring.dependency-management' version '1.1.7'
|
||||
id 'jacoco'
|
||||
}
|
||||
|
||||
group = 'enseirb'
|
||||
@ -26,6 +27,7 @@ dependencies {
|
||||
implementation group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.+'
|
||||
implementation group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.+'
|
||||
implementation 'org.postgresql:postgresql'
|
||||
implementation group: 'com.itextpdf', name: 'itextpdf', version: '5.5.13.3'
|
||||
|
||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||
testImplementation 'com.h2database:h2'
|
||||
@ -36,3 +38,22 @@ dependencies {
|
||||
tasks.named('test') {
|
||||
useJUnitPlatform()
|
||||
}
|
||||
|
||||
|
||||
test {
|
||||
finalizedBy jacocoTestReport // report is always generated after tests run
|
||||
}
|
||||
jacocoTestReport {
|
||||
dependsOn test // tests are required to run before generating the report
|
||||
reports {
|
||||
xml.required = false
|
||||
csv.required = false
|
||||
html.outputLocation = layout.buildDirectory.dir('jacocoHtml')
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
jacoco {
|
||||
toolVersion = "0.8.12"
|
||||
reportsDirectory = layout.buildDirectory.dir('customJacocoReportDir')
|
||||
}
|
||||
|
@ -81,7 +81,7 @@ public class AdminApi {
|
||||
*/
|
||||
@PostMapping("/admin/appoitements/report/{appointmentId}")
|
||||
public void createAppointmentReport(
|
||||
@PathVariable String appointmentId,
|
||||
@PathVariable long appointmentId,
|
||||
@RequestBody Report report,
|
||||
@AuthenticationPrincipal Jwt principal) {
|
||||
adminApiService.createAppointmentReport(
|
||||
|
@ -1,5 +1,7 @@
|
||||
package enseirb.myinpulse.controller;
|
||||
|
||||
import com.itextpdf.text.DocumentException;
|
||||
|
||||
import enseirb.myinpulse.model.*;
|
||||
import enseirb.myinpulse.service.SharedApiService;
|
||||
|
||||
@ -9,6 +11,9 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal;
|
||||
import org.springframework.security.oauth2.jwt.Jwt;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URISyntaxException;
|
||||
|
||||
@SpringBootApplication
|
||||
@RestController
|
||||
public class SharedApi {
|
||||
@ -78,7 +83,15 @@ public class SharedApi {
|
||||
@GetMapping("/shared/projects/appointments/report/{appointmentId}")
|
||||
public void getPDFReport(
|
||||
@PathVariable int appointmentId, @AuthenticationPrincipal Jwt principal) {
|
||||
sharedApiService.getPDFReport(appointmentId, principal.getClaimAsString("email"));
|
||||
try {
|
||||
sharedApiService.getPDFReport(appointmentId, principal.getClaimAsString("email"));
|
||||
} catch (DocumentException e) {
|
||||
System.out.println(e + "Document exception");
|
||||
} catch (URISyntaxException e) {
|
||||
System.out.println(e + "Error with URI");
|
||||
} catch (IOException e) {
|
||||
System.out.println(e + "Failed to access file");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -34,9 +34,33 @@ public class Administrator extends User {
|
||||
public Administrator(
|
||||
String userSurname,
|
||||
String username,
|
||||
String mainMail,
|
||||
String primaryMail,
|
||||
String secondaryMail,
|
||||
String phoneNumber) {
|
||||
super(null, userSurname, username, mainMail, secondaryMail, phoneNumber);
|
||||
super(null, userSurname, username, primaryMail, secondaryMail, phoneNumber);
|
||||
}
|
||||
|
||||
public List<Project> getListProject() {
|
||||
return listProject;
|
||||
}
|
||||
|
||||
public void updateListProject(Project project) {
|
||||
listProject.add(project);
|
||||
}
|
||||
|
||||
public List<Annotation> getListAnnotation() {
|
||||
return listAnnotation;
|
||||
}
|
||||
|
||||
public void updateListAnnotation(Annotation annotation) {
|
||||
listAnnotation.add(annotation);
|
||||
}
|
||||
|
||||
public MakeAppointment getMakeAppointment() {
|
||||
return makeAppointment;
|
||||
}
|
||||
|
||||
public void setMakeAppointment(MakeAppointment makeAppointment) {
|
||||
this.makeAppointment = makeAppointment;
|
||||
}
|
||||
}
|
||||
|
@ -34,4 +34,28 @@ public class Annotation {
|
||||
public void setComment(String comment) {
|
||||
this.comment = comment;
|
||||
}
|
||||
|
||||
public Long getIdAnnotation() {
|
||||
return idAnnotation;
|
||||
}
|
||||
|
||||
public void setIdAnnotation(Long idAnnotation) {
|
||||
this.idAnnotation = idAnnotation;
|
||||
}
|
||||
|
||||
public SectionCell getSectionCellAnnotation() {
|
||||
return sectionCellAnnotation;
|
||||
}
|
||||
|
||||
public void setSectionCellAnnotation(SectionCell sectionCellAnnotation) {
|
||||
this.sectionCellAnnotation = sectionCellAnnotation;
|
||||
}
|
||||
|
||||
public Administrator getAdministratorAnnotation() {
|
||||
return administratorAnnotation;
|
||||
}
|
||||
|
||||
public void setAdministratorAnnotation(Administrator administratorAnnotation) {
|
||||
this.administratorAnnotation = administratorAnnotation;
|
||||
}
|
||||
}
|
||||
|
@ -112,7 +112,15 @@ public class Appointment {
|
||||
return listSectionCell;
|
||||
}
|
||||
|
||||
public void updateListSectionCell(SectionCell sectionCell) {
|
||||
listSectionCell.add(sectionCell);
|
||||
}
|
||||
|
||||
public Report getAppointmentReport() {
|
||||
return report;
|
||||
}
|
||||
|
||||
public void setAppointmentReport(Report report) {
|
||||
this.report = report;
|
||||
}
|
||||
}
|
||||
|
@ -37,21 +37,42 @@ public class Entrepreneur extends User {
|
||||
public Entrepreneur() {}
|
||||
|
||||
public Entrepreneur(
|
||||
Long idUser,
|
||||
String userSurname,
|
||||
String username,
|
||||
String mainMail,
|
||||
String primaryMail,
|
||||
String secondaryMail,
|
||||
String phoneNumber,
|
||||
String school,
|
||||
String course,
|
||||
boolean sneeStatus) {
|
||||
super(idUser, userSurname, username, mainMail, secondaryMail, phoneNumber);
|
||||
super(userSurname, username, primaryMail, secondaryMail, phoneNumber);
|
||||
this.school = school;
|
||||
this.course = course;
|
||||
this.sneeStatus = sneeStatus;
|
||||
}
|
||||
|
||||
public Entrepreneur(
|
||||
Long idUser,
|
||||
String userSurname,
|
||||
String userName,
|
||||
String primaryMail,
|
||||
String secondaryMail,
|
||||
String phoneNumber,
|
||||
String school,
|
||||
String course,
|
||||
boolean sneeStatus,
|
||||
Project projectParticipation,
|
||||
Project projectProposed,
|
||||
MakeAppointment makeAppointment) {
|
||||
super(idUser, userSurname, userName, primaryMail, secondaryMail, phoneNumber);
|
||||
this.school = school;
|
||||
this.course = course;
|
||||
this.sneeStatus = sneeStatus;
|
||||
this.projectParticipation = projectParticipation;
|
||||
this.projectProposed = projectProposed;
|
||||
this.makeAppointment = makeAppointment;
|
||||
}
|
||||
|
||||
public String getSchool() {
|
||||
return school;
|
||||
}
|
||||
@ -79,4 +100,24 @@ public class Entrepreneur extends User {
|
||||
public Project getProjectParticipation() {
|
||||
return projectParticipation;
|
||||
}
|
||||
|
||||
public void setProjectParticipation(Project projectParticipation) {
|
||||
this.projectParticipation = projectParticipation;
|
||||
}
|
||||
|
||||
public Project getProjectProposed() {
|
||||
return projectProposed;
|
||||
}
|
||||
|
||||
public void setProjectProposed(Project projectProposed) {
|
||||
this.projectProposed = projectProposed;
|
||||
}
|
||||
|
||||
public MakeAppointment getMakeAppointment() {
|
||||
return makeAppointment;
|
||||
}
|
||||
|
||||
public void setMakeAppointment(MakeAppointment makeAppointment) {
|
||||
this.makeAppointment = makeAppointment;
|
||||
}
|
||||
}
|
||||
|
@ -26,8 +26,7 @@ public class Project {
|
||||
private byte[] logo;
|
||||
private LocalDate creationDate;
|
||||
|
||||
@Column(length = 255)
|
||||
private String projectStatus;
|
||||
@Column private ProjectDecisionValue projectStatus;
|
||||
|
||||
@ManyToOne(fetch = FetchType.LAZY)
|
||||
@JoinColumn(name = "idAdministrator")
|
||||
@ -39,16 +38,32 @@ public class Project {
|
||||
public Project() {}
|
||||
|
||||
public Project(
|
||||
Long idProject,
|
||||
String projectName,
|
||||
byte[] logo,
|
||||
LocalDate creationDate,
|
||||
String projectStatus) {
|
||||
this.idProject = idProject;
|
||||
ProjectDecisionValue projectStatus,
|
||||
Administrator projectAdministrator) {
|
||||
this.projectName = projectName;
|
||||
this.logo = logo;
|
||||
this.creationDate = creationDate;
|
||||
// this.projectStatus = (long) projectStatus.ordinal();
|
||||
this.projectStatus = projectStatus;
|
||||
this.projectAdministrator = projectAdministrator;
|
||||
}
|
||||
|
||||
public Project(
|
||||
String projectName,
|
||||
byte[] logo,
|
||||
LocalDate creationDate,
|
||||
ProjectDecisionValue projectStatus,
|
||||
Administrator projectAdministrator,
|
||||
Entrepreneur entrepreneurProposed) {
|
||||
this.projectName = projectName;
|
||||
this.logo = logo;
|
||||
this.creationDate = creationDate;
|
||||
this.projectStatus = projectStatus;
|
||||
this.projectAdministrator = projectAdministrator;
|
||||
this.entrepreneurProposed = entrepreneurProposed;
|
||||
}
|
||||
|
||||
public Long getIdProject() {
|
||||
@ -83,19 +98,43 @@ public class Project {
|
||||
this.creationDate = creationDate;
|
||||
}
|
||||
|
||||
public String getProjectStatus() {
|
||||
public ProjectDecisionValue getProjectStatus() {
|
||||
return projectStatus;
|
||||
}
|
||||
|
||||
public void setProjectStatus(String projectStatus) {
|
||||
public void setProjectStatus(ProjectDecisionValue projectStatus) {
|
||||
this.projectStatus = projectStatus;
|
||||
}
|
||||
|
||||
public Administrator getAdministrator() {
|
||||
return this.projectAdministrator;
|
||||
public List<Entrepreneur> getListEntrepreneurParticipation() {
|
||||
return listEntrepreneurParticipation;
|
||||
}
|
||||
|
||||
public void setAdministrator(Administrator administrator) {
|
||||
this.projectAdministrator = administrator;
|
||||
public void updateListEntrepreneurParticipation(Entrepreneur projectParticipant) {
|
||||
listEntrepreneurParticipation.add(projectParticipant);
|
||||
}
|
||||
|
||||
public List<SectionCell> getListSectionCell() {
|
||||
return listSectionCell;
|
||||
}
|
||||
|
||||
public void updateListSectionCell(SectionCell projectSectionCell) {
|
||||
listSectionCell.add(projectSectionCell);
|
||||
}
|
||||
|
||||
public Administrator getProjectAdministrator() {
|
||||
return projectAdministrator;
|
||||
}
|
||||
|
||||
public void setProjectAdministrator(Administrator projectAdministrator) {
|
||||
this.projectAdministrator = projectAdministrator;
|
||||
}
|
||||
|
||||
public Entrepreneur getEntrepreneurProposed() {
|
||||
return entrepreneurProposed;
|
||||
}
|
||||
|
||||
public void setEntrepreneurProposed(Entrepreneur entrepreneurProposed) {
|
||||
this.entrepreneurProposed = entrepreneurProposed;
|
||||
}
|
||||
}
|
||||
|
@ -4,4 +4,22 @@ public class ProjectDecision {
|
||||
public long projectId;
|
||||
public long adminId;
|
||||
public long isAccepted;
|
||||
|
||||
public ProjectDecision(long projectId, long adminId, long isAccepted) {
|
||||
this.projectId = projectId;
|
||||
this.adminId = adminId;
|
||||
this.isAccepted = isAccepted;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "ProjectDecision{"
|
||||
+ "projectId="
|
||||
+ projectId
|
||||
+ ", adminId="
|
||||
+ adminId
|
||||
+ ", isAccepted="
|
||||
+ isAccepted
|
||||
+ '}';
|
||||
}
|
||||
}
|
||||
|
@ -0,0 +1,9 @@
|
||||
package enseirb.myinpulse.model;
|
||||
|
||||
public enum ProjectDecisionValue {
|
||||
PENDING,
|
||||
ACTIVE,
|
||||
ENDED,
|
||||
ABORTED,
|
||||
REJECTED,
|
||||
}
|
@ -37,4 +37,12 @@ public class Report {
|
||||
public void setReportContent(String reportContent) {
|
||||
this.reportContent = reportContent;
|
||||
}
|
||||
|
||||
public Appointment getAppointmentReport() {
|
||||
return appointmentReport;
|
||||
}
|
||||
|
||||
public void setAppointmentReport(Appointment appointmentReport) {
|
||||
this.appointmentReport = appointmentReport;
|
||||
}
|
||||
}
|
||||
|
@ -11,7 +11,7 @@ import java.util.List;
|
||||
public class SectionCell {
|
||||
|
||||
@ManyToMany(mappedBy = "listSectionCell")
|
||||
private final List<Appointment> appointment = new ArrayList<>();
|
||||
private final List<Appointment> listAppointment = new ArrayList<>();
|
||||
|
||||
@OneToMany(mappedBy = "sectionCellAnnotation", fetch = FetchType.LAZY, orphanRemoval = true)
|
||||
private final List<Annotation> listAnnotation = new ArrayList<>();
|
||||
@ -39,11 +39,13 @@ public class SectionCell {
|
||||
Long idSectionCell,
|
||||
Long sectionId,
|
||||
String contentSectionCell,
|
||||
LocalDateTime modificationDate) {
|
||||
LocalDateTime modificationDate,
|
||||
Project projectSectionCell) {
|
||||
this.idSectionCell = idSectionCell;
|
||||
this.sectionId = sectionId;
|
||||
this.contentSectionCell = contentSectionCell;
|
||||
this.modificationDate = modificationDate;
|
||||
this.projectSectionCell = projectSectionCell;
|
||||
}
|
||||
|
||||
public Long getIdSectionCell() {
|
||||
@ -83,6 +85,26 @@ public class SectionCell {
|
||||
}
|
||||
|
||||
public List<Appointment> getAppointmentSectionCell() {
|
||||
return appointment;
|
||||
return listAppointment;
|
||||
}
|
||||
|
||||
public void updateAppointmentSectionCell(Appointment appointment) {
|
||||
listAppointment.add(appointment);
|
||||
}
|
||||
|
||||
public List<Annotation> getListAnnotation() {
|
||||
return listAnnotation;
|
||||
}
|
||||
|
||||
public void updateListAnnotation(Annotation annotation) {
|
||||
listAnnotation.add(annotation);
|
||||
}
|
||||
|
||||
public void setSectionId(long sectionId) {
|
||||
this.sectionId = sectionId;
|
||||
}
|
||||
|
||||
public void setProjectSectionCell(Project projectSectionCell) {
|
||||
this.projectSectionCell = projectSectionCell;
|
||||
}
|
||||
}
|
||||
|
@ -28,6 +28,8 @@ public class User {
|
||||
|
||||
public User() {}
|
||||
|
||||
// TODO: this should be removed as we shouldn't be able to chose the ID. Leaving it for
|
||||
// compatibility purposes, as soon as it's not used anymore, delete it
|
||||
public User(
|
||||
Long idUser,
|
||||
String userSurname,
|
||||
@ -43,6 +45,19 @@ public class User {
|
||||
this.phoneNumber = phoneNumber;
|
||||
}
|
||||
|
||||
public User(
|
||||
String userSurname,
|
||||
String userName,
|
||||
String primaryMail,
|
||||
String secondaryMail,
|
||||
String phoneNumber) {
|
||||
this.userSurname = userSurname;
|
||||
this.userName = userName;
|
||||
this.primaryMail = primaryMail;
|
||||
this.secondaryMail = secondaryMail;
|
||||
this.phoneNumber = phoneNumber;
|
||||
}
|
||||
|
||||
public Long getIdUser() {
|
||||
return idUser;
|
||||
}
|
||||
@ -71,8 +86,8 @@ public class User {
|
||||
return primaryMail;
|
||||
}
|
||||
|
||||
public void setPrimaryMail(String mainMail) {
|
||||
this.primaryMail = mainMail;
|
||||
public void setPrimaryMail(String primaryMail) {
|
||||
this.primaryMail = primaryMail;
|
||||
}
|
||||
|
||||
public String getSecondaryMail() {
|
||||
|
@ -5,10 +5,13 @@ import enseirb.myinpulse.model.Administrator;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
@RepositoryRestResource
|
||||
public interface AdministratorRepository extends JpaRepository<Administrator, Long> {
|
||||
|
||||
/* @Query("SELECT a from Administrators a")
|
||||
Administrator findAllAdministrator(); */
|
||||
|
||||
Optional<Administrator> findByPrimaryMail(String PrimaryMail);
|
||||
}
|
||||
|
@ -2,13 +2,18 @@ package enseirb.myinpulse.repository;
|
||||
|
||||
import enseirb.myinpulse.model.Administrator;
|
||||
import enseirb.myinpulse.model.Project;
|
||||
import enseirb.myinpulse.model.ProjectDecisionValue;
|
||||
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
@RepositoryRestResource
|
||||
public interface ProjectRepository extends JpaRepository<Project, Long> {
|
||||
Iterable<Project> findByProjectAdministrator(Administrator administrator);
|
||||
|
||||
Iterable<Project> findByProjectStatus(String status);
|
||||
Iterable<Project> findByProjectStatus(ProjectDecisionValue status);
|
||||
|
||||
Optional<Project> findByProjectName(String projectName);
|
||||
}
|
||||
|
@ -1,68 +1,162 @@
|
||||
package enseirb.myinpulse.service;
|
||||
|
||||
import enseirb.myinpulse.model.*;
|
||||
import enseirb.myinpulse.service.database.AdministratorService;
|
||||
import enseirb.myinpulse.service.database.ProjectService;
|
||||
import enseirb.myinpulse.service.database.UserService;
|
||||
import static enseirb.myinpulse.model.ProjectDecisionValue.ACTIVE;
|
||||
import static enseirb.myinpulse.model.ProjectDecisionValue.REJECTED;
|
||||
|
||||
import enseirb.myinpulse.model.*;
|
||||
import enseirb.myinpulse.service.database.*;
|
||||
|
||||
import org.apache.logging.log4j.LogManager;
|
||||
import org.apache.logging.log4j.Logger;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.web.server.ResponseStatusException;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@Service
|
||||
public class AdminApiService {
|
||||
|
||||
protected static final Logger logger = LogManager.getLogger();
|
||||
|
||||
private final ProjectService projectService;
|
||||
private final UserService userService;
|
||||
private final AdministratorService administratorService;
|
||||
private final UtilsService utilsService;
|
||||
private final AppointmentService appointmentService;
|
||||
private final ReportService reportService;
|
||||
private final SectionCellService sectionCellService;
|
||||
|
||||
@Autowired
|
||||
AdminApiService(
|
||||
ProjectService projectService,
|
||||
UserService userService,
|
||||
AdministratorService administratorService) {
|
||||
AdministratorService administratorService,
|
||||
UtilsService utilsService,
|
||||
AppointmentService appointmentService,
|
||||
ReportService reportService,
|
||||
SectionCellService sectionCellService) {
|
||||
this.projectService = projectService;
|
||||
this.userService = userService;
|
||||
this.administratorService = administratorService;
|
||||
this.utilsService = utilsService;
|
||||
this.appointmentService = appointmentService;
|
||||
this.reportService = reportService;
|
||||
this.sectionCellService = sectionCellService;
|
||||
}
|
||||
|
||||
// TODO: test
|
||||
public Iterable<Project> getProjectsOfAdmin(String email) {
|
||||
// TODO: check if tests are sufficient - peer verification required
|
||||
public Iterable<Project> getProjectsOfAdmin(String mail) {
|
||||
return projectService.getProjectsByAdminId(
|
||||
administratorService.getAdministratorById(
|
||||
this.userService.getUserByEmail(email).getIdUser()));
|
||||
this.userService.getUserByEmail(mail).getIdUser()));
|
||||
}
|
||||
|
||||
// TODO
|
||||
public Iterable<Appointment> getUpcomingAppointments(String email) {
|
||||
throw new ResponseStatusException(HttpStatus.NOT_IMPLEMENTED, "Not implemented yet");
|
||||
public Iterable<Appointment> getUpcomingAppointments(String mail) {
|
||||
logger.info("User {} check their upcoming appointments", mail);
|
||||
User user = this.userService.getUserByEmail(mail);
|
||||
List<Appointment> appointments = new ArrayList<>();
|
||||
if (user instanceof Administrator) {
|
||||
List<Project> projects = new ArrayList<>(((Administrator) user).getListProject());
|
||||
projects.forEach(
|
||||
project -> {
|
||||
project.getListSectionCell()
|
||||
.forEach(
|
||||
sectionCell -> {
|
||||
appointments.addAll(
|
||||
this.sectionCellService
|
||||
.getAppointmentsBySectionCellId(
|
||||
sectionCell
|
||||
.getIdSectionCell()));
|
||||
});
|
||||
});
|
||||
}
|
||||
if (user instanceof Entrepreneur) {
|
||||
Project project = ((Entrepreneur) user).getProjectParticipation();
|
||||
project.getListSectionCell()
|
||||
.forEach(
|
||||
sectionCell -> {
|
||||
appointments.addAll(
|
||||
this.sectionCellService.getAppointmentsBySectionCellId(
|
||||
sectionCell.getIdSectionCell()));
|
||||
});
|
||||
}
|
||||
return appointments;
|
||||
}
|
||||
|
||||
// TODO: test
|
||||
// TODO: check if tests are sufficient - peer verification required
|
||||
public Iterable<Project> getPendingProjects() {
|
||||
return this.projectService.getPendingProjects();
|
||||
}
|
||||
|
||||
// TODO: test
|
||||
// TODO: check if tests are sufficient - peer verification required
|
||||
public void validateProject(ProjectDecision decision) {
|
||||
projectService.updateProject(
|
||||
decision.projectId,
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
"ACTIVE",
|
||||
this.administratorService.getAdministratorById(decision.projectId));
|
||||
(decision.isAccepted == 1) ? ACTIVE : REJECTED,
|
||||
this.administratorService.getAdministratorById(decision.adminId));
|
||||
}
|
||||
|
||||
// TODO: solve todo + test
|
||||
// TODO: check if tests are sufficient - peer verification required
|
||||
public void addNewProject(Project project) {
|
||||
projectService.addNewProject(project); // TODO: how can the front know the ID ?
|
||||
project.setIdProject(null);
|
||||
// We remove the ID from the request to be sure that it will be auto generated
|
||||
try {
|
||||
this.projectService.getProjectByName(project.getProjectName(), true);
|
||||
throw new ResponseStatusException(HttpStatus.CONFLICT, "Project already exists");
|
||||
} catch (ResponseStatusException e) {
|
||||
if (e.getStatusCode() == HttpStatus.CONFLICT) {
|
||||
throw new ResponseStatusException(HttpStatus.CONFLICT, "Project already exists");
|
||||
}
|
||||
}
|
||||
Project newProject = projectService.addNewProject(project);
|
||||
if (project.getProjectAdministrator() != null) {
|
||||
newProject.getProjectAdministrator().updateListProject(newProject);
|
||||
}
|
||||
if (newProject.getEntrepreneurProposed() != null) {
|
||||
Entrepreneur proposed = newProject.getEntrepreneurProposed();
|
||||
proposed.setProjectProposed(newProject);
|
||||
proposed.setProjectParticipation(newProject);
|
||||
}
|
||||
newProject
|
||||
.getListEntrepreneurParticipation()
|
||||
.forEach(
|
||||
participation -> {
|
||||
participation.setProjectParticipation(newProject);
|
||||
});
|
||||
newProject
|
||||
.getListSectionCell()
|
||||
.forEach(
|
||||
sectionCell -> {
|
||||
sectionCell.setProjectSectionCell(newProject);
|
||||
});
|
||||
}
|
||||
|
||||
// TODO
|
||||
public void createAppointmentReport(String appointmentId, Report report, String email) {
|
||||
throw new ResponseStatusException(HttpStatus.NOT_IMPLEMENTED, "Not implemented yet");
|
||||
public void createAppointmentReport(long appointmentId, Report report, String mail) {
|
||||
long projectId =
|
||||
this.appointmentService
|
||||
.getAppointmentById(appointmentId)
|
||||
.getAppointmentListSectionCell()
|
||||
.getFirst()
|
||||
.getProjectSectionCell()
|
||||
.getIdProject();
|
||||
if (!utilsService.isAllowedToCheckProject(mail, projectId)) {
|
||||
logger.warn(
|
||||
"User {} tried to add an report for appointment {} but is not allowed to.",
|
||||
mail,
|
||||
projectId);
|
||||
throw new ResponseStatusException(
|
||||
HttpStatus.UNAUTHORIZED, "You're not allowed to check this project");
|
||||
}
|
||||
logger.info("User {} added a report for appointment {}", mail, projectId);
|
||||
Report addedReport = this.reportService.addNewReport(report);
|
||||
addedReport.setAppointmentReport(this.appointmentService.getAppointmentById(appointmentId));
|
||||
this.appointmentService.getAppointmentById(appointmentId).setAppointmentReport(addedReport);
|
||||
}
|
||||
|
||||
// TODO: test
|
||||
|
@ -1,5 +1,7 @@
|
||||
package enseirb.myinpulse.service;
|
||||
|
||||
import static enseirb.myinpulse.model.ProjectDecisionValue.PENDING;
|
||||
|
||||
import enseirb.myinpulse.model.Project;
|
||||
import enseirb.myinpulse.model.SectionCell;
|
||||
import enseirb.myinpulse.service.database.ProjectService;
|
||||
@ -105,7 +107,20 @@ public class EntrepreneurApiService {
|
||||
mail,
|
||||
sectionCell.getIdSectionCell(),
|
||||
this.sectionCellService.getProjectId(sectionCell.getIdSectionCell()));
|
||||
sectionCellService.addNewSectionCell(sectionCell);
|
||||
SectionCell newSectionCell = sectionCellService.addNewSectionCell(sectionCell);
|
||||
newSectionCell.getProjectSectionCell().updateListSectionCell(newSectionCell);
|
||||
newSectionCell
|
||||
.getAppointmentSectionCell()
|
||||
.forEach(
|
||||
appointment -> {
|
||||
appointment.updateListSectionCell(newSectionCell);
|
||||
});
|
||||
newSectionCell
|
||||
.getListAnnotation()
|
||||
.forEach(
|
||||
annotation -> {
|
||||
annotation.setSectionCellAnnotation(newSectionCell);
|
||||
});
|
||||
}
|
||||
|
||||
public void requestNewProject(Project project, String mail) {
|
||||
@ -114,7 +129,7 @@ public class EntrepreneurApiService {
|
||||
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Le projet fourni est vide");
|
||||
}
|
||||
logger.info("User {} created a new project with id {}", mail, project.getIdProject());
|
||||
project.setProjectStatus("PENDING");
|
||||
project.setProjectStatus(PENDING);
|
||||
projectService.addNewProject(project);
|
||||
}
|
||||
}
|
||||
|
@ -1,5 +1,8 @@
|
||||
package enseirb.myinpulse.service;
|
||||
|
||||
import com.itextpdf.text.*;
|
||||
import com.itextpdf.text.pdf.PdfWriter;
|
||||
|
||||
import enseirb.myinpulse.model.*;
|
||||
import enseirb.myinpulse.service.database.*;
|
||||
|
||||
@ -10,6 +13,14 @@ import org.springframework.http.HttpStatus;
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.web.server.ResponseStatusException;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.FileOutputStream;
|
||||
import java.io.IOException;
|
||||
import java.net.URI;
|
||||
import java.net.URISyntaxException;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
import java.nio.file.StandardCopyOption;
|
||||
import java.time.LocalDateTime;
|
||||
import java.time.format.DateTimeFormatter;
|
||||
import java.util.ArrayList;
|
||||
@ -87,10 +98,9 @@ public class SharedApiService {
|
||||
HttpStatus.UNAUTHORIZED, "You're not allowed to check this project");
|
||||
}
|
||||
Project project = this.projectService.getProjectById(projectId);
|
||||
return project.getAdministrator();
|
||||
return project.getProjectAdministrator();
|
||||
}
|
||||
|
||||
// TODO
|
||||
public Iterable<Appointment> getAppointmentsByProjectId(long projectId, String mail) {
|
||||
if (!utilsService.isAllowedToCheckProject(mail, projectId)) {
|
||||
logger.warn(
|
||||
@ -118,8 +128,8 @@ public class SharedApiService {
|
||||
return appointments;
|
||||
}
|
||||
|
||||
// TODO
|
||||
public void getPDFReport(long appointmentId, String mail) {
|
||||
public void getPDFReport(long appointmentId, String mail)
|
||||
throws DocumentException, URISyntaxException, IOException {
|
||||
long projectId =
|
||||
this.appointmentService
|
||||
.getAppointmentById(appointmentId)
|
||||
@ -139,15 +149,104 @@ public class SharedApiService {
|
||||
throw new ResponseStatusException(
|
||||
HttpStatus.UNAUTHORIZED, "You're not allowed to check this project");
|
||||
}
|
||||
/* return this.appointmentService
|
||||
.getAppointmentById(appointmentId)
|
||||
.getAppointmentReport().getReportContent(); */
|
||||
// generate pdf from this string, and format it to be decent looking
|
||||
throw new ResponseStatusException(HttpStatus.NOT_IMPLEMENTED, "Not implemented yet");
|
||||
logger.info(
|
||||
"User {} generated the PDF report related to appointment {}", mail, appointmentId);
|
||||
|
||||
String reportContent =
|
||||
this.appointmentService
|
||||
.getAppointmentById(appointmentId)
|
||||
.getAppointmentReport()
|
||||
.getReportContent();
|
||||
|
||||
// PDF generation
|
||||
Document document = new Document();
|
||||
PdfWriter.getInstance(document, new FileOutputStream("Report" + appointmentId + ".pdf"));
|
||||
document.open();
|
||||
|
||||
Paragraph title =
|
||||
new Paragraph(
|
||||
new Phrase(
|
||||
"Compte Rendu - Réunion du "
|
||||
+ this.appointmentService
|
||||
.getAppointmentById(appointmentId)
|
||||
.getAppointmentDate()
|
||||
.toString(),
|
||||
FontFactory.getFont(
|
||||
FontFactory.HELVETICA,
|
||||
20,
|
||||
Font.BOLDITALIC,
|
||||
BaseColor.BLACK)));
|
||||
title.setAlignment(Element.ALIGN_CENTER);
|
||||
document.add(title);
|
||||
|
||||
Font subsection =
|
||||
FontFactory.getFont(FontFactory.HELVETICA, 14, Font.UNDERLINE, BaseColor.DARK_GRAY);
|
||||
Font body = FontFactory.getFont(FontFactory.COURIER, 12, BaseColor.BLACK);
|
||||
|
||||
String[] split = reportContent.split(" ");
|
||||
|
||||
String tmp = "";
|
||||
int counter = 1;
|
||||
for (String s : split) {
|
||||
if (s.equals("//")) {
|
||||
Chunk chunk = new Chunk(tmp, body);
|
||||
document.add(chunk);
|
||||
document.add(new Paragraph("\n"));
|
||||
tmp = "";
|
||||
Paragraph paragraph = new Paragraph("Point n°" + counter + " : ", subsection);
|
||||
document.add(paragraph);
|
||||
document.add(new Paragraph("\n"));
|
||||
counter++;
|
||||
} else {
|
||||
tmp = tmp.concat(s + " ");
|
||||
}
|
||||
}
|
||||
Chunk chunk = new Chunk(tmp, body);
|
||||
document.add(chunk);
|
||||
document.add(new Paragraph("\n"));
|
||||
|
||||
document.close();
|
||||
|
||||
// Replace uri with website address
|
||||
Files.copy(
|
||||
new URI(
|
||||
"http://localhost:8080/shared/projects/appointments/report/"
|
||||
+ appointmentId)
|
||||
.toURL()
|
||||
.openStream(),
|
||||
Paths.get("Report" + appointmentId + ".pdf"),
|
||||
StandardCopyOption.REPLACE_EXISTING);
|
||||
|
||||
// delete file, we don't want to stock all reports on the server
|
||||
File file = new File("Report" + appointmentId + ".pdf");
|
||||
if (!file.delete()) {
|
||||
logger.warn("Failed to delete report {}", file.getAbsolutePath());
|
||||
}
|
||||
}
|
||||
|
||||
// TODO
|
||||
public void createAppointmentRequest(Appointment appointment, String mail) {
|
||||
throw new ResponseStatusException(HttpStatus.NOT_IMPLEMENTED, "Not implemented yet");
|
||||
long projectId =
|
||||
appointment
|
||||
.getAppointmentListSectionCell()
|
||||
.getFirst()
|
||||
.getProjectSectionCell()
|
||||
.getIdProject();
|
||||
if (!utilsService.isAllowedToCheckProject(mail, projectId)) {
|
||||
logger.warn(
|
||||
"User {} tried to create for the project {} but is not allowed to.",
|
||||
mail,
|
||||
projectId);
|
||||
throw new ResponseStatusException(
|
||||
HttpStatus.UNAUTHORIZED, "You're not allowed to check this project");
|
||||
}
|
||||
logger.info("User {} tried to create an appointment for project {}", mail, projectId);
|
||||
Appointment newAppointment = this.appointmentService.addNewAppointment(appointment);
|
||||
newAppointment
|
||||
.getAppointmentListSectionCell()
|
||||
.forEach(
|
||||
sectionCell -> {
|
||||
sectionCell.updateAppointmentSectionCell(newAppointment);
|
||||
});
|
||||
newAppointment.getAppointmentReport().setAppointmentReport(newAppointment);
|
||||
}
|
||||
}
|
||||
|
@ -37,6 +37,17 @@ public class AdministratorService {
|
||||
return administrator.get();
|
||||
}
|
||||
|
||||
public Administrator getAdministratorByPrimaryMain(String primaryMail) {
|
||||
Optional<Administrator> administrator =
|
||||
this.administratorRepository.findByPrimaryMail(primaryMail);
|
||||
if (administrator.isEmpty()) {
|
||||
logger.error("No administrator found with the mail {}", primaryMail);
|
||||
throw new ResponseStatusException(
|
||||
HttpStatus.NOT_FOUND, "Cet administrateur n'existe pas");
|
||||
}
|
||||
return administrator.get();
|
||||
}
|
||||
|
||||
public Administrator addAdministrator(Administrator administrator) {
|
||||
return this.administratorRepository.save(administrator);
|
||||
}
|
||||
|
@ -1,7 +1,10 @@
|
||||
package enseirb.myinpulse.service.database;
|
||||
|
||||
import static enseirb.myinpulse.model.ProjectDecisionValue.PENDING;
|
||||
|
||||
import enseirb.myinpulse.model.Administrator;
|
||||
import enseirb.myinpulse.model.Project;
|
||||
import enseirb.myinpulse.model.ProjectDecisionValue;
|
||||
import enseirb.myinpulse.repository.ProjectRepository;
|
||||
|
||||
import org.apache.logging.log4j.LogManager;
|
||||
@ -54,7 +57,7 @@ public class ProjectService {
|
||||
String projectName,
|
||||
byte[] logo,
|
||||
LocalDate creationDate,
|
||||
String projectStatus,
|
||||
ProjectDecisionValue projectStatus,
|
||||
Administrator administrator) {
|
||||
Optional<Project> project = this.projectRepository.findById(id);
|
||||
|
||||
@ -76,16 +79,19 @@ public class ProjectService {
|
||||
}
|
||||
|
||||
if (projectStatus != null) {
|
||||
// TODO: check if this is really useful
|
||||
/*
|
||||
if (!validateStatus(projectStatus)) {
|
||||
logger.error("updateProjectStatus: Invalid status {}", projectStatus);
|
||||
throw new ResponseStatusException(
|
||||
HttpStatus.NOT_ACCEPTABLE, "Ce status n'est pas accepté");
|
||||
}
|
||||
*/
|
||||
project.get().setProjectStatus(projectStatus);
|
||||
}
|
||||
|
||||
if (administrator != null) {
|
||||
project.get().setAdministrator(administrator);
|
||||
project.get().setProjectAdministrator(administrator);
|
||||
}
|
||||
|
||||
return this.projectRepository.save(project.get());
|
||||
@ -96,10 +102,23 @@ public class ProjectService {
|
||||
}
|
||||
|
||||
public Iterable<Project> getPendingProjects() {
|
||||
return this.projectRepository.findByProjectStatus("PENDING");
|
||||
return this.projectRepository.findByProjectStatus(PENDING);
|
||||
}
|
||||
|
||||
public void deleteProjectById(Long id) {
|
||||
this.projectRepository.deleteById(id);
|
||||
}
|
||||
|
||||
public Project getProjectByName(String name, boolean noerror) {
|
||||
Optional<Project> project = this.projectRepository.findByProjectName(name);
|
||||
if (project.isEmpty()) {
|
||||
if (noerror) logger.error("No project found with name {}", name);
|
||||
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Ce projet n'existe pas");
|
||||
}
|
||||
return project.get();
|
||||
}
|
||||
|
||||
public Project getProjectByName(String name) {
|
||||
return getProjectByName(name, false);
|
||||
}
|
||||
}
|
||||
|
@ -53,7 +53,7 @@ public class UserService {
|
||||
@PathVariable Long id,
|
||||
String userSurname,
|
||||
String userName,
|
||||
String mainMail,
|
||||
String primaryMail,
|
||||
String secondaryMail,
|
||||
String phoneNumber) {
|
||||
Optional<User> user = userRepository.findById(id);
|
||||
@ -67,8 +67,8 @@ public class UserService {
|
||||
if (userSurname != null) {
|
||||
user.get().setUserSurname(userSurname);
|
||||
}
|
||||
if (mainMail != null) {
|
||||
user.get().setPrimaryMail(mainMail);
|
||||
if (primaryMail != null) {
|
||||
user.get().setPrimaryMail(primaryMail);
|
||||
}
|
||||
if (secondaryMail != null) {
|
||||
user.get().setSecondaryMail(secondaryMail);
|
||||
|
@ -1,12 +1,17 @@
|
||||
package enseirb.myinpulse;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static enseirb.myinpulse.model.ProjectDecisionValue.*;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import enseirb.myinpulse.model.Administrator;
|
||||
import enseirb.myinpulse.model.Entrepreneur;
|
||||
import enseirb.myinpulse.model.Project;
|
||||
import enseirb.myinpulse.model.ProjectDecision;
|
||||
import enseirb.myinpulse.service.AdminApiService;
|
||||
import enseirb.myinpulse.service.database.AdministratorService;
|
||||
import enseirb.myinpulse.service.database.EntrepreneurService;
|
||||
import enseirb.myinpulse.service.database.ProjectService;
|
||||
|
||||
import org.junit.jupiter.api.BeforeAll;
|
||||
import org.junit.jupiter.api.Test;
|
||||
@ -15,31 +20,76 @@ import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.transaction.annotation.Transactional;
|
||||
import org.springframework.web.server.ResponseStatusException;
|
||||
|
||||
import java.time.LocalDate;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@SpringBootTest
|
||||
@Transactional
|
||||
public class AdminApiServiceTest {
|
||||
private static long administratorid;
|
||||
private static Administrator administrator;
|
||||
private static Entrepreneur entrepreneur;
|
||||
@Autowired private AdminApiService adminApiService;
|
||||
@Autowired private ProjectService projectService;
|
||||
|
||||
@BeforeAll
|
||||
static void setup(@Autowired AdministratorService administratorService) {
|
||||
static void setup(
|
||||
@Autowired AdministratorService administratorService,
|
||||
@Autowired ProjectService projectService,
|
||||
@Autowired EntrepreneurService entrepreneurService) {
|
||||
administratorService.addAdministrator(
|
||||
new Administrator(
|
||||
"admin", "admin", "testAdmin@example.com", "testAdmin@example.com", ""));
|
||||
"admin",
|
||||
"admin",
|
||||
"testAdminEmpty@example.com",
|
||||
"testAdmin@example.com",
|
||||
""));
|
||||
administrator =
|
||||
administratorService.addAdministrator(
|
||||
new Administrator(
|
||||
"admin2",
|
||||
"admin2",
|
||||
"testAdminFull@example.com",
|
||||
"testAdmin@example.com",
|
||||
""));
|
||||
administratorid = administrator.getIdUser();
|
||||
entrepreneur =
|
||||
new Entrepreneur(
|
||||
"JeSuisUnEntrepreneurDeCompet",
|
||||
"EtUé",
|
||||
"Entrepreneur@inpulse.com",
|
||||
"mail2",
|
||||
"phone",
|
||||
"Ensimag nan jdeconne ENSEIRB (-matmeca mais on s'en fout)",
|
||||
"info ofc",
|
||||
false);
|
||||
entrepreneurService.addEntrepreneur(entrepreneur);
|
||||
projectService.addNewProject(
|
||||
new Project(
|
||||
"sampleProjectAdminApiService",
|
||||
null,
|
||||
LocalDate.now(),
|
||||
ACTIVE,
|
||||
administratorService.getAdministratorByPrimaryMain(
|
||||
"testAdminFull@example.com")));
|
||||
}
|
||||
|
||||
private <T> List<T> IterableToList(Iterable<T> iterable) {
|
||||
List<T> l = new ArrayList<>();
|
||||
iterable.forEach(l::add);
|
||||
return l;
|
||||
}
|
||||
|
||||
@Test
|
||||
void getProjectOfAdminIsEmpty() throws Exception {
|
||||
Iterable<Project> projects = adminApiService.getProjectsOfAdmin("testAdmin@example.com");
|
||||
List<Project> l = new ArrayList<>();
|
||||
projects.forEach(l::add);
|
||||
assertEquals(0, l.size());
|
||||
void getProjectOfAdminIsEmpty() {
|
||||
Iterable<Project> projects =
|
||||
adminApiService.getProjectsOfAdmin("testAdminEmpty@example.com");
|
||||
assertEquals(0, IterableToList(projects).size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void getProjectOfInexistantAdminFails() throws Exception {
|
||||
void getProjectOfInexistantAdminFails() {
|
||||
String nonExistentAdminEmail = "testInexistantAdmin@example.com";
|
||||
|
||||
assertThrows(
|
||||
@ -48,4 +98,127 @@ public class AdminApiServiceTest {
|
||||
adminApiService.getProjectsOfAdmin(nonExistentAdminEmail);
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void getProjectOfAdminNotEmpty() {
|
||||
Iterable<Project> projects =
|
||||
adminApiService.getProjectsOfAdmin("testAdminFull@example.com");
|
||||
List<Project> l = IterableToList(projects);
|
||||
assertEquals(1, l.size());
|
||||
Project p = l.getFirst();
|
||||
assertEquals(p.getProjectName(), "sampleProjectAdminApiService");
|
||||
}
|
||||
|
||||
@Test
|
||||
void getPendingProjectsEmpty() {
|
||||
assertEquals(0, IterableToList(this.adminApiService.getPendingProjects()).size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void getPendingProjectsNotEmpty() {
|
||||
this.projectService.addNewProject(
|
||||
new Project(
|
||||
"PendingProjectAdminApiService1", null, LocalDate.now(), PENDING, null));
|
||||
this.projectService.addNewProject(
|
||||
new Project(
|
||||
"PendingProjectAdminApiService2", null, LocalDate.now(), PENDING, null));
|
||||
Iterable<Project> pendingProjects = this.adminApiService.getPendingProjects();
|
||||
List<Project> pendingProjectsList = IterableToList(pendingProjects);
|
||||
assertEquals(2, pendingProjectsList.size());
|
||||
assertTrue(
|
||||
List.of("PendingProjectAdminApiService1", "PendingProjectAdminApiService2")
|
||||
.contains(pendingProjectsList.getFirst().getProjectName()));
|
||||
assertTrue(
|
||||
List.of("PendingProjectAdminApiService1", "PendingProjectAdminApiService2")
|
||||
.contains(pendingProjectsList.getLast().getProjectName()));
|
||||
}
|
||||
|
||||
@Test
|
||||
void validateInexistantProject() {
|
||||
ProjectDecision d = new ProjectDecision(-1, 0, 1);
|
||||
assertThrows(ResponseStatusException.class, () -> this.adminApiService.validateProject(d));
|
||||
}
|
||||
|
||||
@Test
|
||||
void validateExistantProject() {
|
||||
Project p =
|
||||
new Project("PendingProjectAdminApiService2", null, LocalDate.now(), PENDING, null);
|
||||
this.projectService.addNewProject(p);
|
||||
assertEquals(PENDING, p.getProjectStatus());
|
||||
ProjectDecision d = new ProjectDecision(p.getIdProject(), administratorid, 1);
|
||||
this.adminApiService.validateProject(d);
|
||||
assertEquals(ACTIVE, p.getProjectStatus());
|
||||
|
||||
// Check if the project was really updated in the database
|
||||
assertEquals(0, IterableToList(this.adminApiService.getPendingProjects()).size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void refuseExistantProject() {
|
||||
Project p =
|
||||
new Project("PendingProjectAdminApiService2", null, LocalDate.now(), PENDING, null);
|
||||
this.projectService.addNewProject(p);
|
||||
assertEquals(PENDING, p.getProjectStatus());
|
||||
ProjectDecision d = new ProjectDecision(p.getIdProject(), administratorid, 0);
|
||||
this.adminApiService.validateProject(d);
|
||||
assertEquals(REJECTED, p.getProjectStatus());
|
||||
|
||||
// Check if the project was really updated in the database
|
||||
assertEquals(0, IterableToList(this.adminApiService.getPendingProjects()).size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void addProject() {
|
||||
assertEquals(0, IterableToList(this.adminApiService.getPendingProjects()).size());
|
||||
Project p1 =
|
||||
new Project("PendingProjectAdminApiService2", null, LocalDate.now(), PENDING, null);
|
||||
this.adminApiService.addNewProject(p1);
|
||||
|
||||
assertEquals(1, IterableToList(this.adminApiService.getPendingProjects()).size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void addProjectToAdmin() {
|
||||
assertEquals(0, administrator.getListProject().size());
|
||||
Project p1 = new Project("assProjectToAdmin", null, LocalDate.now(), ACTIVE, administrator);
|
||||
this.adminApiService.addNewProject(p1);
|
||||
assertEquals(1, administrator.getListProject().size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void addProjectToUser() {
|
||||
assertNull(entrepreneur.getProjectParticipation());
|
||||
Project p1 =
|
||||
new Project("assProjectToAdmin", null, LocalDate.now(), ACTIVE, null, entrepreneur);
|
||||
this.adminApiService.addNewProject(p1);
|
||||
assertEquals(p1, entrepreneur.getProjectParticipation());
|
||||
}
|
||||
|
||||
@Test
|
||||
void addProjectWithManyUsers() {
|
||||
Entrepreneur e1 = new Entrepreneur();
|
||||
Entrepreneur e2 = new Entrepreneur();
|
||||
Entrepreneur e3 = new Entrepreneur();
|
||||
assertNull(e1.getProjectParticipation());
|
||||
assertNull(e2.getProjectParticipation());
|
||||
assertNull(e3.getProjectParticipation());
|
||||
Project p1 = new Project("assProjectToAdmin", null, LocalDate.now(), ACTIVE, null, null);
|
||||
p1.updateListEntrepreneurParticipation(e1);
|
||||
p1.updateListEntrepreneurParticipation(e2);
|
||||
p1.updateListEntrepreneurParticipation(e3);
|
||||
this.adminApiService.addNewProject(p1);
|
||||
assertEquals(p1, e1.getProjectParticipation());
|
||||
assertEquals(p1, e2.getProjectParticipation());
|
||||
assertEquals(p1, e3.getProjectParticipation());
|
||||
}
|
||||
|
||||
@Test
|
||||
void addDuplicateProject() {
|
||||
Project p1 =
|
||||
new Project("PendingProjectAdminApiService2", null, LocalDate.now(), PENDING, null);
|
||||
Project p2 =
|
||||
new Project("PendingProjectAdminApiService2", null, LocalDate.now(), PENDING, null);
|
||||
this.adminApiService.addNewProject(p1);
|
||||
assertThrows(ResponseStatusException.class, () -> this.adminApiService.addNewProject(p2));
|
||||
}
|
||||
}
|
||||
|
22
config/.env.dev
Normal file
22
config/.env.dev
Normal file
@ -0,0 +1,22 @@
|
||||
POSTGRES_DB=postgres_db
|
||||
POSTGRES_USER=postgres
|
||||
POSTGRES_PASSWORD=postgres_db_user_password
|
||||
|
||||
KEYCLOAK_ADMIN=admin
|
||||
KEYCLOAK_ADMIN_PASSWORD=admin
|
||||
KEYCLOAK_HOSTNAME=localhost
|
||||
KEYCLOAK_DB=keycloak_db
|
||||
KEYCLOAK_USER=keycloak_db_user
|
||||
KEYCLOAK_PASSWORD=keycloak_db_user_password
|
||||
|
||||
BACKEND_DB=backend_db
|
||||
BACKEND_USER=backend_db_user
|
||||
BACKEND_PASSWORD=backend_db_user_password
|
||||
|
||||
DATABASE_URL=localhost:5433
|
||||
|
||||
VITE_KEYCLOAK_URL=http://localhost:7080
|
||||
VITE_KEYCLOAK_CLIENT_ID=myinpulse-dev
|
||||
VITE_KEYCLOAK_REALM=test
|
||||
VITE_APP_URL=http://localhost:5173
|
||||
VITE_BACKEND_URL=http://localhost:8081/
|
@ -48,4 +48,4 @@ services:
|
||||
# container_name: MyINPulse-back
|
||||
# ports:
|
||||
# - "8081:8080"
|
||||
|
||||
#
|
@ -42,11 +42,11 @@ services:
|
||||
# ports:
|
||||
# - "8080:80"
|
||||
|
||||
back:
|
||||
build:
|
||||
context: ./MyINPulse-back/
|
||||
dockerfile: Dockerfile
|
||||
container_name: MyINPulse-back
|
||||
ports:
|
||||
- "8081:8080"
|
||||
#back:
|
||||
# build:
|
||||
# context: ./MyINPulse-back/
|
||||
# dockerfile: Dockerfile
|
||||
# container_name: MyINPulse-back
|
||||
# ports:
|
||||
# - "8081:8080"
|
||||
|
@ -45,11 +45,11 @@ services:
|
||||
ports:
|
||||
- "8080:80"
|
||||
|
||||
back:
|
||||
build:
|
||||
context: ./MyINPulse-back/
|
||||
dockerfile: Dockerfile
|
||||
container_name: MyINPulse-back
|
||||
#ports:
|
||||
# - "8081:8080"
|
||||
#back:
|
||||
# build:
|
||||
# context: ./MyINPulse-back/
|
||||
# dockerfile: Dockerfile
|
||||
# container_name: MyINPulse-back
|
||||
# #ports:
|
||||
# # - "8081:8080"
|
||||
|
12
documentation/Doc.txt
Normal file
12
documentation/Doc.txt
Normal file
@ -0,0 +1,12 @@
|
||||
Format des comptes rendus de réunion :
|
||||
Texte organisé par bullet point, chaque bullet point est séparé par "//" pour pouvoir être correctement généré.
|
||||
|
||||
Exemple :
|
||||
Le texte "// blablabla // oui bonjour"
|
||||
donne le résultat
|
||||
|
||||
Point n°1 :
|
||||
blablabla
|
||||
|
||||
Point n°2 :
|
||||
oui bonjour
|
13
documentation/openapi/notes.md
Normal file
13
documentation/openapi/notes.md
Normal file
@ -0,0 +1,13 @@
|
||||
## API Endpoints notes
|
||||
|
||||
### EntrepreneurApi and SharedApi
|
||||
#### Endpoint Name Changes
|
||||
- `/entrepreneur/lcsection/modify/{sectionId}` → `/entrepreneur/sectionCell/modify/{sectionId}`
|
||||
|
||||
### Admin api
|
||||
- `/admin/appointments/report/{appointmentId}` has no PUT and DELETE
|
||||
- `/admin/request-join` and `/admin/request-join/decision/{joinRequestId}` have not yet been implemented
|
||||
|
||||
### Unauth api
|
||||
- `/unauth/request-join/{projectId}` has not yet been implemented
|
||||
|
11
documentation/openapi/run_doc.sh
Executable file
11
documentation/openapi/run_doc.sh
Executable file
@ -0,0 +1,11 @@
|
||||
#!/bin/bash
|
||||
|
||||
cd ./swagger-ui
|
||||
|
||||
if [ ! -d "./node_modules/" ]
|
||||
then
|
||||
npm install
|
||||
npm install swagger-cli
|
||||
fi
|
||||
|
||||
npm start
|
353
documentation/openapi/src/adminApi.yaml
Normal file
353
documentation/openapi/src/adminApi.yaml
Normal file
@ -0,0 +1,353 @@
|
||||
# Admin API Endpoints
|
||||
paths:
|
||||
/admin/projects:
|
||||
get:
|
||||
operationId: getAdminProjects
|
||||
summary: Get projects associated with the admin
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
description: Retrieves a list of projects managed by the requesting admin, including details for overview.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of projects returned successfully.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/project"
|
||||
"400":
|
||||
description: Bad Request - Invalid project data provided (e.g., missing required fields).
|
||||
"401":
|
||||
description: Unauthorized - Authentication required or invalid token.
|
||||
|
||||
post:
|
||||
operationId: addProjectManually
|
||||
summary: Manually add a new project
|
||||
description: Creates a new project with the provided details. (NOTE that this meant for manually inserting projects, for example importing already existing projects).
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
requestBody:
|
||||
required: true
|
||||
description: Project details to create. `idProject` and `creationDate` will be ignored if sent and set by the server.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/project"
|
||||
responses:
|
||||
"201": # Use 201 Created for successful creation
|
||||
description: Created - Project added successfully. Returns the created project.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/project"
|
||||
"409":
|
||||
description: Bad Request - Project already exists.
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/admin/projects/pending:
|
||||
get:
|
||||
operationId: getPendingProjects
|
||||
summary: Get projects awaiting validation
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
description: Retrieves a list of projects submitted by entrepreneurs that are pending admin approval.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of pending projects returned.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/project" # Assuming pending projects use the same schema
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/admin/request-join:
|
||||
get:
|
||||
operationId: getPendingProjects
|
||||
summary: Get entrepreneurs project join requests
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
description: Retrieves a list of pending requests from entrepreneurs to join an existing project.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of pending project join requests.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/joinRequest"
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/admin/request-join/decision/{joinRequestId}:
|
||||
post:
|
||||
summary: Approve or reject a pending project join request
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
parameters:
|
||||
- in: path
|
||||
name: joinRequestId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the pending join request to decide upon.
|
||||
|
||||
description: |-
|
||||
Allows an admin to make a decision on an ebtrepreneur's request to join an existing project awaiting validation.
|
||||
If approved (isAccepted=true), the entrepreneur is linked to the project with ID joinRequestId.
|
||||
If rejected (isAccepted=false), the pending request data might be archived or deleted based on business logic.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - No Content, decision processed successfully..
|
||||
content:
|
||||
application/json:
|
||||
$ref: "./main.yaml#/components/schemas/joinRequestDecision"
|
||||
"400":
|
||||
description: Bad Request - Invalid input (e.g., missing decision).
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/admin/projects/pending/decision:
|
||||
post:
|
||||
operationId: decidePendingProject
|
||||
summary: Approve or reject a pending project
|
||||
tags:
|
||||
- Admin API
|
||||
description: |-
|
||||
Allows an admin to make a decision on a project awaiting validation.
|
||||
If approved (isAccepted=true), the project status changes, and it's linked to the involved users.
|
||||
If rejected (isAccepted=false), the pending project data might be archived or deleted based on business logic.
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
parameters:
|
||||
- in: path
|
||||
name: pendingProjectId # Corrected typo and name change
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the pending project to decide upon.
|
||||
example: 7
|
||||
requestBody:
|
||||
required: true
|
||||
description: Decision payload.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: './main.yaml#/components/schemas/projectDecision'
|
||||
responses:
|
||||
"204": # Use 204 No Content for successful action with no body
|
||||
description: No Content - Decision processed successfully.
|
||||
"400":
|
||||
description: Bad Request - Invalid input (e.g., missing decision).
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/admin/pending-accounts: # Path updated
|
||||
get:
|
||||
operationId: getPendingAccounts
|
||||
summary: Get accounts awaiting validation
|
||||
description: Retrieves a list of entrepreneur user accounts that are pending admin validation.
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of pending accounts returned.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/user-entrepreneur"
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/admin/accounts/validate/{userId}:
|
||||
post: # Changed to POST as it changes state
|
||||
operationId: validateUserAccount
|
||||
summary: Validate a pending user account
|
||||
description: Marks the user account specified by userId as validated/active.
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
parameters:
|
||||
- in: path
|
||||
name: userId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the user account to validate.
|
||||
example: 102
|
||||
responses:
|
||||
"204":
|
||||
description: No Content - Account validated successfully.
|
||||
"400":
|
||||
description: Bad Request - Invalid user ID format.
|
||||
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/admin/appointments/upcoming:
|
||||
get:
|
||||
operationId: getUpcomingAppointments
|
||||
summary: Get upcoming appointments for an admin
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
description: Retrieves a list of appointments scheduled for an admin in the future.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of upcoming appointments.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/appointment"
|
||||
"404":
|
||||
description: no appointments found.
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/admin/appointments/report/{appointmentId}:
|
||||
post:
|
||||
operationId: createAppointmentReport
|
||||
summary: Create a report for an appointment
|
||||
description: Creates and links a new report (e.g., meeting minutes) to the specified appointment using the provided content.
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
parameters:
|
||||
- in: path
|
||||
name: appointmentId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: ID of the appointment to add a report to.
|
||||
example: 303
|
||||
requestBody:
|
||||
required: true
|
||||
description: Report content. `idReport` will be ignored if sent.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/report"
|
||||
responses:
|
||||
"201":
|
||||
description: Created - Report created and linked successfully. Returns the created report.
|
||||
content:
|
||||
application/json:
|
||||
schema: { $ref: "./main.yaml#/components/schemas/report" }
|
||||
"400":
|
||||
description: Bad Request - Invalid input (e.g., missing content, invalid appointment ID format).
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
put: # Changed to PUT for update/replacement
|
||||
operationId: updateAppointmentReport
|
||||
summary: Update an existing appointment report
|
||||
description: Updates the content of an existing report linked to the specified appointment. Replaces the entire report content.
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
parameters:
|
||||
- in: path
|
||||
name: appointmentId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: ID of the appointment whose report needs updating.
|
||||
example: 303
|
||||
requestBody:
|
||||
required: true
|
||||
description: New report content. `idReport` in the body should match the existing report's ID or will be ignored.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/report"
|
||||
responses:
|
||||
"200":
|
||||
description: OK - Report updated successfully. Returns the updated report.
|
||||
content:
|
||||
application/json:
|
||||
schema: { $ref: "./main.yaml#/components/schemas/report" }
|
||||
"400":
|
||||
description: Bad Request - Invalid input (e.g., missing content).
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/admin/projects/{projectId}:
|
||||
delete:
|
||||
operationId: removeProject
|
||||
summary: Remove a project
|
||||
description: Permanently removes the project specified by projectId and potentially related data (use with caution).
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the project to remove.
|
||||
example: 12
|
||||
responses:
|
||||
"204":
|
||||
description: No Content - Project removed successfully.
|
||||
"400":
|
||||
description: Bad Request - Invalid project ID format.
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
|
||||
/admin/make-admin/{userId}:
|
||||
post:
|
||||
operationId: grantAdminRights
|
||||
summary: Grant admin rights to a user
|
||||
tags:
|
||||
- Admin API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-admin]
|
||||
description: Elevates the specified user to also have administrator privileges. Assumes the user already exists.
|
||||
parameters:
|
||||
- in: path
|
||||
name: userId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the user to grant admin rights.
|
||||
example: 103
|
||||
responses:
|
||||
"204": # Use 204 No Content
|
||||
description: No Content - Admin rights granted successfully.
|
||||
"400":
|
||||
description: Bad Request - Invalid user ID format or user is already an admin.
|
||||
"401":
|
||||
description: Unauthorized.
|
112
documentation/openapi/src/entrepreneurApi.yaml
Normal file
112
documentation/openapi/src/entrepreneurApi.yaml
Normal file
@ -0,0 +1,112 @@
|
||||
# Entrepreneur API Endpoints
|
||||
paths:
|
||||
/entrepreneur/projects/request:
|
||||
post:
|
||||
operationId: requestProjectCreation
|
||||
summary: Request creation and validation of a new project
|
||||
tags:
|
||||
- Entrepreneurs API
|
||||
description: |-
|
||||
Submits a request for a new project. The project details are provided in the request body.
|
||||
The requesting entrepreneur (identified by the token) will be associated to it.
|
||||
The project is created with a 'pending' status, awaiting admin approval.
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur]
|
||||
requestBody:
|
||||
required: true
|
||||
description: Project details for the request. `status`, `creationDate` are required by the model when being sent but is ignored by the server;
|
||||
primarily expects a valid `projectId`, `name`, `logo`.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/project"
|
||||
responses:
|
||||
"202":
|
||||
description: Accepted - Project creation request received and is pending validation.
|
||||
"400":
|
||||
description: Bad Request - Invalid input (e.g., missing name).
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/entrepreneur/sectionCells: # Base path
|
||||
post:
|
||||
operationId: addSectionCell
|
||||
summary: Add a cell to a Lean Canvas section
|
||||
description: Adds a new cell (like a sticky note) with the provided content to a specific section of the entrepreneur's project's Lean Canvas. Assumes project context is known based on user's token.
|
||||
`idSectionCell` and `modificationDate` are server-generated so they're values in the request are ignored by the server.
|
||||
tags:
|
||||
- Entrepreneurs API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur]
|
||||
requestBody:
|
||||
required: true
|
||||
description: Section cell details. `idSectionCell` and `modificationDate` will be ignored if sent.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/sectionCell"
|
||||
responses:
|
||||
"201":
|
||||
description: Created - Section cell added successfully. Returns the created cell.
|
||||
"400":
|
||||
description: Bad Request - Invalid input (e.g., missing content or sectionId).
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
/entrepreneur/sectionCells/{sectionCellId}:
|
||||
put:
|
||||
operationId: modifySectionCell
|
||||
summary: Modify data in a Lean Canvas section cell
|
||||
description: Updates the content of an existing Lean Canvas section cell specified by `sectionCellId`. The server "updates" (it keeps a record of the previous version to keep a history of all the sectionCells and creates a new ones with the specified modifications) the `modificationDate`.
|
||||
tags:
|
||||
- Entrepreneurs API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur]
|
||||
parameters:
|
||||
- in: path
|
||||
name: sectionCellId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the section cell to modify.
|
||||
example: 508
|
||||
requestBody:
|
||||
required: true
|
||||
description: Updated section cell details. `sectionCellId` "the path parameter" is the only id that's consideredn the `sectionCellId` id in the request body is ignored. `modificationDate` should be updated by the server.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/sectionCell"
|
||||
responses:
|
||||
"200":
|
||||
description: OK - Section cell updated successfully. Returns the updated cell.
|
||||
"404":
|
||||
description: Bad Request - Invalid input or ID mismatch.
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
delete:
|
||||
operationId: removeSectionCell
|
||||
summary: Remove a Lean Canvas section cell
|
||||
description: Deletes the Lean Canvas section cell specified by `sectionCellId`.
|
||||
tags:
|
||||
- Entrepreneurs API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur]
|
||||
parameters:
|
||||
- in: path
|
||||
name: sectionCellId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the section cell to remove.
|
||||
example: 509
|
||||
responses:
|
||||
"204":
|
||||
description: No Content - Section cell removed successfully.
|
||||
"400":
|
||||
description: Bad Request - Invalid ID format.
|
||||
"404":
|
||||
description: Bad Request - sectionCell not found.
|
||||
"401":
|
||||
description: Unauthorized.
|
146
documentation/openapi/src/main.yaml
Normal file
146
documentation/openapi/src/main.yaml
Normal file
@ -0,0 +1,146 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: MyInpulse Backend API
|
||||
description: This serves as an OpenAPI documentation for the MyInpulse backend service, covering operations for Entrepreneurs, Admins, and shared functionalities.
|
||||
version: 0.2.1
|
||||
|
||||
tags:
|
||||
- name: Entrepreneurs API
|
||||
description: API endpoints primarily for Entrepreneur users.
|
||||
- name: Admin API
|
||||
description: API endpoints restricted to Admin users for management tasks.
|
||||
- name: Shared API
|
||||
description: API endpoints accessible by both Entrepreneurs and Admins.
|
||||
- name: Unauth API
|
||||
description: API endpoints related to user account management.
|
||||
|
||||
components:
|
||||
schemas:
|
||||
user:
|
||||
$ref: "models.yaml#/user"
|
||||
user-entrepreneur:
|
||||
$ref: "models.yaml#/user-entrepreneur"
|
||||
user-admin:
|
||||
$ref: "models.yaml#/user-admin"
|
||||
sectionCell:
|
||||
$ref: "models.yaml#/sectionCell"
|
||||
project:
|
||||
$ref: "models.yaml#/project"
|
||||
report:
|
||||
$ref: "models.yaml#/report"
|
||||
appointment:
|
||||
$ref: "models.yaml#/appointment"
|
||||
joinRequest:
|
||||
$ref: "models.yaml#/joinRequest"
|
||||
projectDecision:
|
||||
$ref: "models.yaml#/projectDecision"
|
||||
joinRequestDecision:
|
||||
$ref: "models.yaml#/joinRequestDecision"
|
||||
|
||||
securitySchemes:
|
||||
MyINPulse:
|
||||
type: oauth2
|
||||
description: OAuth2 authentication using Keycloak.
|
||||
flows:
|
||||
implicit:
|
||||
authorizationUrl: '{keycloakBaseUrl}/realms/{keycloakRealm}/protocol/openid-connect/auth'
|
||||
scopes:
|
||||
MyINPulse-admin: Grants administrator access.
|
||||
MyINPulse-entrepreneur: Grants standard entrepreneur user access.
|
||||
|
||||
servers:
|
||||
- url: '{serverProtocol}://{serverHost}:{serverPort}'
|
||||
description: API Server
|
||||
variables:
|
||||
serverProtocol:
|
||||
enum: [http, https]
|
||||
default: http
|
||||
serverHost:
|
||||
default: localhost
|
||||
serverPort:
|
||||
enum: ['8081']
|
||||
default: '8081'
|
||||
keycloakBaseUrl:
|
||||
default: http://localhost:7080
|
||||
description: Base URL for the Keycloak server.
|
||||
keycloakRealm:
|
||||
default: MyInpulseRealm
|
||||
description: Keycloak realm name.
|
||||
|
||||
paths:
|
||||
# _ _ _ _ _ _
|
||||
# | | | |_ __ __ _ _ _| |_| |__ / \ _ __ (_)
|
||||
# | | | | '_ \ / _` | | | | __| '_ \ / _ \ | '_ \| |
|
||||
# | |_| | | | | (_| | |_| | |_| | | |/ ___ \| |_) | |
|
||||
# \___/|_| |_|\__,_|\__,_|\__|_| |_/_/ \_\ .__/|_|
|
||||
# |_|
|
||||
|
||||
/unauth/finalize:
|
||||
$ref: "./unauthApi.yaml#/paths/~1unauth~1finalize"
|
||||
/unauth/request-join/{projectId}:
|
||||
$ref: "./unauthApi.yaml#/paths/~1unauth~1request-join~1{projectId}"
|
||||
|
||||
# _ ____ __ __ ___ _ _ _ ____ ___
|
||||
# / \ | _ \| \/ |_ _| \ | | / \ | _ \_ _|
|
||||
# / _ \ | | | | |\/| || || \| | / _ \ | |_) | |
|
||||
# / ___ \| |_| | | | || || |\ | / ___ \| __/| |
|
||||
# /_/ \_\____/|_| |_|___|_| \_| /_/ \_\_| |___|
|
||||
#
|
||||
/admin/pending-accounts:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1pending-accounts"
|
||||
/admin/accounts/validate/{userId}:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1accounts~1validate~1{userId}"
|
||||
/admin/request-join:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1request-join"
|
||||
/admin/request-join/decision/{joinRequestId}:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1request-join~1decision~1{joinRequestId}"
|
||||
/admin/projects:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1projects"
|
||||
/admin/projects/pending:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1projects~1pending"
|
||||
/admin/projects/pending/decision:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1projects~1pending~1decision"
|
||||
/admin/appointments/report/{appointmentId}:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1appointments~1report~1{appointmentId}"
|
||||
/admin/appointments/upcoming:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1appointments~1upcoming"
|
||||
/admin/projects/{projectId}:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1projects~1{projectId}"
|
||||
/admin/make-admin/{userId}:
|
||||
$ref: "./adminApi.yaml#/paths/~1admin~1make-admin~1{userId}"
|
||||
|
||||
# ____ _ _ _ ____ ___
|
||||
# / ___|| |__ __ _ _ __ ___ __| | / \ | _ \_ _|
|
||||
# \___ \| '_ \ / _` | '__/ _ \/ _` | / _ \ | |_) | |
|
||||
# ___) | | | | (_| | | | __/ (_| | / ___ \| __/| |
|
||||
# |____/|_| |_|\__,_|_| \___|\__,_| /_/ \_\_| |___|
|
||||
#
|
||||
/shared/projects/sectionCells/{projectId}/{sectionId}/{date}:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1projects~1sectionCells~1{projectId}~1{sectionId}~1{date}"
|
||||
/shared/projects/entrepreneurs/{projectId}:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1projects~1entrepreneurs~1{projectId}"
|
||||
/shared/projects/admin/{projectId}:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1projects~1admin~1{projectId}"
|
||||
/shared/projects/appointments/{projectId}:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1projects~1appointments~1{projectId}"
|
||||
/shared/appointments/report/{appointmentId}:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1appointments~1report~1{appointmentId}"
|
||||
/shared/appointments/request:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1appointments~1request"
|
||||
|
||||
# _____ _ _ _____ ____ _____ ____ ____ _____ _ _ _____ _ _ ____
|
||||
# | ____| \ | |_ _| _ \| ____| _ \| _ \| ____| \ | | ____| | | | _ \
|
||||
# | _| | \| | | | | |_) | _| | |_) | |_) | _| | \| | _| | | | | |_) |
|
||||
# | |___| |\ | | | | _ <| |___| __/| _ <| |___| |\ | |___| |_| | _ <
|
||||
# |_____|_|_\_| |_| |_| \_\_____|_| |_| \_\_____|_| \_|_____|\___/|_| \_\
|
||||
# / \ | _ \_ _|
|
||||
# / _ \ | |_) | |
|
||||
# / ___ \| __/| |
|
||||
# /_/ \_\_| |___|
|
||||
#
|
||||
/entrepreneur/projects/request:
|
||||
$ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1projects~1request"
|
||||
/entrepreneur/sectionCells:
|
||||
$ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1sectionCells"
|
||||
/entrepreneur/sectionCells/{sectionCellId}:
|
||||
$ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1sectionCells~1{sectionCellId}"
|
210
documentation/openapi/src/models.yaml
Normal file
210
documentation/openapi/src/models.yaml
Normal file
@ -0,0 +1,210 @@
|
||||
# models.yaml
|
||||
user:
|
||||
type: object
|
||||
properties:
|
||||
idUser:
|
||||
type: integer
|
||||
description: Unique identifier for the user.
|
||||
#readOnly: true # Typically generated by the server
|
||||
example: 101
|
||||
userSurname:
|
||||
type: string
|
||||
description: User's surname (last name).
|
||||
example: "Doe"
|
||||
userName:
|
||||
type: string
|
||||
description: User's given name (first name).
|
||||
example: "John"
|
||||
primaryMail:
|
||||
type: string
|
||||
format: email
|
||||
description: User's primary email address.
|
||||
example: "john.doe@example.com"
|
||||
secondaryMail:
|
||||
type: string
|
||||
format: email
|
||||
description: User's secondary email address (optional).
|
||||
example: "j.doe@personal.com"
|
||||
phoneNumber:
|
||||
type: string
|
||||
description: User's phone number.
|
||||
example: "+33612345678" # Example using international format
|
||||
|
||||
user-entrepreneur:
|
||||
allOf:
|
||||
- $ref: "#/user"
|
||||
- type: object
|
||||
properties:
|
||||
school:
|
||||
type: string
|
||||
description: The school the entrepreneur attends/attended.
|
||||
example: "ENSEIRB-MATMECA"
|
||||
course:
|
||||
type: string
|
||||
description: The specific course or program of study.
|
||||
example: "Electronics"
|
||||
sneeStatus:
|
||||
type: boolean
|
||||
description: Indicates if the user has SNEE status (Statut National d'Étudiant-Entrepreneur).
|
||||
example: true
|
||||
example: # Added full object example
|
||||
idUser: 101
|
||||
userSurname: "Doe"
|
||||
userName: "John"
|
||||
primaryMail: "john.doe@example.com"
|
||||
secondaryMail: "j.doe@personal.com"
|
||||
phoneNumber: "+33612345678"
|
||||
school: "ENSEIRB-MATMECA"
|
||||
course: "Electronics"
|
||||
sneeStatus: true
|
||||
|
||||
user-admin:
|
||||
allOf:
|
||||
- $ref: "#/user"
|
||||
# No additional properties needed for this example
|
||||
example: # Added full object example
|
||||
idUser: 55
|
||||
userSurname: "Admin"
|
||||
userName: "Super"
|
||||
primaryMail: "admin@myinpulse.com"
|
||||
phoneNumber: "+33512345678"
|
||||
|
||||
sectionCell:
|
||||
type: object
|
||||
description: Represents a cell (like a sticky note) within a specific section of a project's Lean Canvas.
|
||||
properties:
|
||||
idSectionCell:
|
||||
type: integer
|
||||
description: Unique identifier for the section cell.
|
||||
#readOnly: true # Generated by server
|
||||
example: 508
|
||||
sectionId:
|
||||
type: integer
|
||||
description: Identifier of the Lean Canvas section this cell belongs to (e.g., 1 for Problem, 2 for Solution).
|
||||
example: 1
|
||||
contentSectionCell:
|
||||
type: string
|
||||
description: The text content of the section cell.
|
||||
example: "Users find it hard to track project progress."
|
||||
modificationDate:
|
||||
type: string
|
||||
format: date # Using Java LocalDate -> YYYY-MM-DD
|
||||
description: The date when this cell was last modified.
|
||||
#readOnly: true # Typically updated by the server on modification
|
||||
example: "yyyy-MM-dd HH:mm"
|
||||
|
||||
project:
|
||||
type: object
|
||||
description: Represents a project being managed or developed.
|
||||
properties:
|
||||
idProject:
|
||||
type: integer
|
||||
description: Unique identifier for the project.
|
||||
#readOnly: true # Generated by server
|
||||
example: 12
|
||||
projectName:
|
||||
type: string
|
||||
description: The name of the project.
|
||||
example: "MyInpulse Mobile App"
|
||||
creationDate:
|
||||
type: string
|
||||
format: date # Using Java LocalDate -> YYYY-MM-DD
|
||||
description: The date when the project was created in the system.
|
||||
#readOnly: true # Set by server
|
||||
example: "yyyy-MM-dd HH:mm"
|
||||
logo:
|
||||
type: string
|
||||
format: byte
|
||||
description: Base64 encoded string representing the project logo image.
|
||||
example: "/*Base64 encoded string representing the project logo image*/"
|
||||
status:
|
||||
type: string
|
||||
enum: [PENDING, ACTIVE, ENDED, ABORTED, REJECTED]
|
||||
description: Corresponds to a status enum internal to the backend, it's value in in requests
|
||||
incoming to the server should be ignored as the client shouldn't be specifying them.
|
||||
example: "NaN"
|
||||
|
||||
joinRequest:
|
||||
type: object
|
||||
description: Represents a request from an entrepreneur to join an already existing project.
|
||||
properties:
|
||||
idProject:
|
||||
type: integer
|
||||
description: the ID of the project the entrepreneur wants to join.
|
||||
example: 42
|
||||
entrepreneur:
|
||||
$ref: "#/user-entrepreneur"
|
||||
|
||||
|
||||
report:
|
||||
type: object
|
||||
description: Represents a report associated with an appointment.
|
||||
properties:
|
||||
idReport:
|
||||
type: integer
|
||||
description: Unique identifier for the report.
|
||||
#readOnly: true # Generated by server
|
||||
example: 987
|
||||
reportContent:
|
||||
type: string
|
||||
description: The textual content of the report. Could be plain text or Markdown (specify if known).
|
||||
example: "Discussed roadmap milestones for Q3. Agreed on preliminary UI mockups."
|
||||
|
||||
appointment: # Corrected typo
|
||||
type: object
|
||||
description: Represents a scheduled meeting or appointment.
|
||||
properties:
|
||||
idAppointment: # Assuming there's an ID
|
||||
type: integer
|
||||
description: Unique identifier for the appointment.
|
||||
#readOnly: true
|
||||
example: 303
|
||||
appointmentDate:
|
||||
type: string
|
||||
format: date # Using Java LocalDate -> YYYY-MM-DD
|
||||
description: The date of the appointment.
|
||||
example: "2025-05-10"
|
||||
appointmentTime:
|
||||
type: string
|
||||
format: time # Using Java LocalTime -> HH:mm:ss
|
||||
description: The time of the appointment (local time).
|
||||
example: "14:30:00"
|
||||
appointmentDuration:
|
||||
type: string
|
||||
description: Duration of the appointment in ISO 8601 duration format (e.g., PT1H30M for 1 hour 30 minutes).
|
||||
example: "PT1H" # Example for 1 hour
|
||||
appointmentPlace:
|
||||
type: string
|
||||
description: Location or meeting link for the appointment.
|
||||
example: "Meeting Room 3 / https://meet.example.com/abc-def-ghi"
|
||||
appointmentSubject:
|
||||
type: string
|
||||
description: The main topic or subject of the appointment.
|
||||
example: "Q3 Roadmap Planning"
|
||||
# Consider adding project ID or user IDs if relevant association exists
|
||||
|
||||
projectDecision:
|
||||
type: object
|
||||
description: Represents a decision from an admin to accept a pending project.
|
||||
properties:
|
||||
projectId:
|
||||
type: integer
|
||||
description: The ID of the project the entrepreneur wants to join.
|
||||
example: 12
|
||||
adminId:
|
||||
type: integer
|
||||
description: The ID of the project the admin who will supervise the project in case of admission.
|
||||
example: 2
|
||||
isAccepted:
|
||||
type: boolean
|
||||
description: The boolean value of the decision.
|
||||
example: "true"
|
||||
|
||||
joinRequestDecision:
|
||||
type: object
|
||||
description: Represents a decision from an admin to accept a pending project join request.
|
||||
properties:
|
||||
isAccepted:
|
||||
type: boolean
|
||||
description: The boolean value of the decision.
|
||||
example: "true"
|
197
documentation/openapi/src/sharedApi.yaml
Normal file
197
documentation/openapi/src/sharedApi.yaml
Normal file
@ -0,0 +1,197 @@
|
||||
# Shared API Endpoints
|
||||
paths:
|
||||
|
||||
/shared/projects/sectionCells/{projectId}/{sectionId}/{date}:
|
||||
get:
|
||||
operationId: getSectionCellsByDate
|
||||
summary: Get project section cells modified on a specific date
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
|
||||
description: Retrieves section cells belonging to a specific section of a project, filtered by the last modification date. Requires user to have access to the project.
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
required: true
|
||||
schema: { type: integer }
|
||||
description: ID of the project.
|
||||
- in: path
|
||||
name: sectionId
|
||||
required: true
|
||||
schema: { type: integer }
|
||||
description: ID of the Lean Canvas section.
|
||||
- in: path
|
||||
name: date
|
||||
required: true
|
||||
schema: { type: string, format: date } # Expect YYYY-MM-DD
|
||||
description: The modification date to filter by (YYYY-MM-DD HH:mm).
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of section cells matching the criteria.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/sectionCell"
|
||||
"400":
|
||||
description: Bad Request - Invalid parameter format.
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/shared/projects/entrepreneurs/{projectId}:
|
||||
get:
|
||||
operationId: getProjectEntrepreneurs
|
||||
summary: Get entrepreneurs associated with a project
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
|
||||
description: Retrieves a list of entrepreneur users associated with the specified project. Requires access to the project.
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
required: true
|
||||
schema: { type: integer }
|
||||
description: ID of the project.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of entrepreneurs.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/user-entrepreneur"
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
"403":
|
||||
description: Forbidden - User does not have access to this project.
|
||||
"404":
|
||||
description: Not Found - Project not found.
|
||||
|
||||
/shared/projects/admin/{projectId}: # Path updated
|
||||
get:
|
||||
operationId: getProjectAdmin
|
||||
summary: Get admin associated with a project
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
|
||||
description: Retrieves a list of admin users associated with the specified project. Requires access to the project.
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
required: true
|
||||
schema: { type: integer }
|
||||
description: ID of the project.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - admin.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/user-admin"
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
"403":
|
||||
description: Forbidden - User does not have access to this project.
|
||||
"404":
|
||||
description: Not Found - Project not found.
|
||||
|
||||
|
||||
/shared/projects/appointments/{projectId}:
|
||||
get:
|
||||
operationId: getProjectAppointments
|
||||
summary: Get appointments related to a project
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
|
||||
description: Retrieves a list of appointments associated with the specified project. Requires access to the project.
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
required: true
|
||||
schema: { type: integer }
|
||||
description: ID of the project.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - List of appointments.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "./main.yaml#/components/schemas/appointment"
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/shared/appointments/report/{appointmentId}: # Path updated
|
||||
get:
|
||||
operationId: getAppointmentReport # Shared endpoint implies read-only access might be possible
|
||||
summary: Get the report for an appointment
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
|
||||
description: Retrieves the report associated with a specific appointment. Requires user to have access to the appointment/project.
|
||||
parameters:
|
||||
- in: path
|
||||
name: appointmentId
|
||||
required: true
|
||||
schema: { type: integer }
|
||||
description: ID of the appointment.
|
||||
responses:
|
||||
"200":
|
||||
description: OK - Report PDF returned.
|
||||
content:
|
||||
application/pdf:
|
||||
schema:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/shared/appointments/request:
|
||||
post:
|
||||
operationId: requestAppointment
|
||||
summary: Request a new appointment
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
|
||||
description: Allows a user (entrepreneur or admin) to request a new appointment, potentially with another user or regarding a project. Details in the body. The request might need confirmation or create a pending appointment.
|
||||
requestBody:
|
||||
required: true
|
||||
description: Details of the appointment request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/appointment" # Assuming request uses same model structure
|
||||
example:
|
||||
value:
|
||||
appointmentDate: "2025-06-01"
|
||||
appointmentTime: "10:00:00"
|
||||
appointmentDuration: "PT1H"
|
||||
appointmentPlace: "Online"
|
||||
appointmentSubject: "Follow-up on prototype"
|
||||
# Potentially add projectId or targetUserId here
|
||||
responses:
|
||||
"202": # Accepted seems appropriate for a request
|
||||
description: Accepted - Appointment request submitted.
|
||||
content:
|
||||
application/json: # Optionally return the pending appointment data
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/appointment"
|
||||
"400":
|
||||
description: Bad Request - Invalid appointment details.
|
||||
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
62
documentation/openapi/src/unauthApi.yaml
Normal file
62
documentation/openapi/src/unauthApi.yaml
Normal file
@ -0,0 +1,62 @@
|
||||
|
||||
# _ _ _ _ _ _
|
||||
# | | | |_ __ __ _ _ _| |_| |__ / \ _ __ (_)
|
||||
# | | | | '_ \ / _` | | | | __| '_ \ / _ \ | '_ \| |
|
||||
# | |_| | | | | (_| | |_| | |_| | | |/ ___ \| |_) | |
|
||||
# \___/|_| |_|\__,_|\__,_|\__|_| |_/_/ \_\ .__/|_|
|
||||
# |_|
|
||||
|
||||
paths:
|
||||
/unauth/finalize:
|
||||
post:
|
||||
summary: Finalize account setup using authentication token
|
||||
description: |-
|
||||
Completes the user account creation/setup process in the MyInpulse system.
|
||||
This endpoint requires the user to be authenticated via Keycloak (e.g., after initial login).
|
||||
User details (name, email, etc.) are extracted from the authenticated user's token (e.g., Keycloak JWT).
|
||||
No request body is needed. The account is marked as pending admin validation upon successful finalization.
|
||||
tags:
|
||||
- Unauth API
|
||||
responses:
|
||||
"201":
|
||||
description: Created - Account finalized and pending admin validation. Returns the user profile.
|
||||
"400":
|
||||
description: Bad Request - Problem processing the token or user data derived from it.
|
||||
"401":
|
||||
description: Unauthorized - Valid authentication token required.
|
||||
/unauth/request-join/{projectId}:
|
||||
post:
|
||||
summary: Request to join an existing project
|
||||
description: Submits a request for the authenticated user (keycloack authenticated) to join the project specified by projectId. Their role is then changed to entrepreneur in server and Keycloak. This requires approval from a project admin.
|
||||
tags:
|
||||
- Unauth API
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The ID of the project to request joining.
|
||||
example: 15
|
||||
responses: # Moved responses block to correct level
|
||||
"202":
|
||||
description: Accepted - Join request submitted and pending approval.
|
||||
"400":
|
||||
description: Bad Request - Invalid project ID format
|
||||
"409":
|
||||
description: Already member/request pending.
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
/unauth/request-admin-role:
|
||||
post:
|
||||
summary: Request to join an existing project
|
||||
description: Submits a request for the authenticated user (keycloack authenticated) to become an admin. Their role is then changed to admin in server and Keycloak. This requires approval from a project admin.
|
||||
tags:
|
||||
- Unauth API
|
||||
responses:
|
||||
"202":
|
||||
description: Accepted - Become admin request submitted and pending approval.
|
||||
"400":
|
||||
description: Bad Request - Invalid project ID format or already member/request pending.
|
||||
"401":
|
||||
description: Unauthorized.
|
14
documentation/openapi/swagger-ui/main.js
Normal file
14
documentation/openapi/swagger-ui/main.js
Normal file
@ -0,0 +1,14 @@
|
||||
const express = require("express");
|
||||
const swaggerUi = require("swagger-ui-express");
|
||||
const yaml = require("js-yaml");
|
||||
const fs = require("fs");
|
||||
|
||||
const app = express();
|
||||
|
||||
const swaggerDocument = yaml.load(fs.readFileSync("../src/bundled.yaml", "utf8"));
|
||||
|
||||
app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
|
||||
|
||||
app.listen(3000, () => {
|
||||
console.log("Swagger UI running at http://localhost:3000/api-docs");
|
||||
});
|
2179
documentation/openapi/swagger-ui/package-lock.json
generated
Normal file
2179
documentation/openapi/swagger-ui/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
21
documentation/openapi/swagger-ui/package.json
Normal file
21
documentation/openapi/swagger-ui/package.json
Normal file
@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "swagger-ui",
|
||||
"version": "1.0.0",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1",
|
||||
"bundle": "swagger-cli bundle -o ../src/bundled.yaml -t yaml ../src/main.yaml",
|
||||
"start": "npm run bundle; node main.js"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"description": "",
|
||||
"dependencies": {
|
||||
"express": "^4.21.2",
|
||||
"js-yaml": "^4.1.0",
|
||||
"package.json": "^2.0.1",
|
||||
"swagger-cli": "^4.0.4",
|
||||
"swagger-ui-express": "^5.0.1"
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user