Adden user data completion and docs correction

buisnesslogic/src/main/java/com/plannaplan/services/GroupService.java

@@ -67,9 +67,9 @@ public class GroupService {
 
     /**
      * 
-     * @param assingemnts list of assingemnts you want to get taken places ammount
-     * @return HashMap<Long, Integer> where Long is group id and Integer is how many
-     *         places in gorup is already taken
+     * @param assignments list of assignments you want to get taken places ammount
+     * @return HashMap of Long to Integer where Long is group id and Integer is how
+     *         many places in gorup is already taken
      */
     public HashMap<Long, Integer> getTakenPlacesOfAssignments(List<Assignment> assignments) {
         return getTakenPlaces(assignments.stream().map(Assignment::getGroup).collect(Collectors.toList()));
@@ -78,8 +78,8 @@ public class GroupService {
     /**
      * 
      * @param groups list of groups you want to get taken places ammount
-     * @return HashMap<Long, Integer> where Long is group id and Integer is how many
-     *         places in gorup is already taken
+     * @return HashMap of Long to Integer where Long is group id and Integer is how
+     *         many places in gorup is already taken
      */
     public HashMap<Long, Integer> getTakenPlaces(List<Groups> groups) {
         HashMap<Long, Integer> response = new HashMap<>();

buisnesslogic/src/main/java/com/plannaplan/services/UserService.java

@@ -6,6 +6,7 @@ import java.util.UUID;
 
 import com.plannaplan.entities.User;
 import com.plannaplan.exceptions.UserNotFoundException;
+import com.plannaplan.models.UserApiResponse;
 import com.plannaplan.repositories.UserRepository;
 import com.plannaplan.types.UserRoles;
 
@@ -20,14 +21,33 @@ public class UserService {
     @Autowired
     private UserRepository repo;
 
+    @Autowired
+    private UsosApiService service;
+
     public UserService() {
         super();
     }
 
+    /**
+     * checks if user exist and return him or creates new one with student role
+     * otherwise
+     * 
+     * @param email  user email in usos
+     * @param usosId user id in usos
+     * @return user entity instace containing changes saved in database
+     */
     public User checkForUser(String email, String usosId) {
         return this.checkForUser(email, usosId, UserRoles.STUDENT);
     }
 
+    /**
+     * checks if user exist and creates new one if doesn't
+     * 
+     * @param email          user email in usos
+     * @param usosId         user id in usos
+     * @param roleIfNotExist role to be set in case user is not in database yet
+     * @return user entity instace containing changes saved in database
+     */
     public User checkForUser(String email, String usosId, UserRoles roleIfNotExist) {
         if (usosId == null) {
             Optional<User> user = this.repo.getByEmail(email.replace("\n", "").trim());
@@ -48,8 +68,20 @@ public class UserService {
         }
     }
 
+    /**
+     * generates token for user and if user don't have name in database it will
+     * attemp to obtain these from usos api and saves changes in database
+     * 
+     * @param authority user we want to login
+     * @return user with changed values after save in db
+     * @throws UserNotFoundException throwed if user doesn't exist
+     */
     public User login(User authority) throws UserNotFoundException {
         final String token = UUID.randomUUID().toString();
+        if ((authority.getName() == null || authority.getSurname() == null) && authority.getUsosId() != null) {
+            final UserApiResponse resp = this.service.getUserData(authority.getUsosId());
+            authority.updateWithUsosData(resp);
+        }
         try {
             authority.setToken(token);
             this.repo.save(authority);
@@ -59,16 +91,34 @@ public class UserService {
         return authority;
     }
 
+    /**
+     * sacves user to databse and return instatnce with id
+     * 
+     * @param user to be saved
+     * @return instatnce with bd id
+     */
     public User save(User user) {
         return this.repo.save(user);
     }
 
+    /**
+     * 
+     * @param email of user to be find
+     * @return user with given mail
+     * @throws UserNotFoundException throwed if user doesn't exist
+     */
     public User getUserByEmail(String email) throws UserNotFoundException {
         return this.repo.getByEmail(email.replace("\n", "").trim())
                 .orElseThrow(() -> new UserNotFoundException("Cannot find user with given authority"));
 
     }
 
+    /**
+     * return user by given authority
+     * 
+     * @param authority user usosId or email
+     * @return optional with user if found
+     */
     public Optional<User> getByAuthority(String authority) {
         return this.repo.getByAuthority(authority);
     }
@@ -77,6 +127,12 @@ public class UserService {
         return this.repo.getByToken(token);
     }
 
+    /**
+     * search for user with given query
+     * 
+     * @param query string that will be matched to users name and surname
+     * @return list opf results
+     */
     public List<User> searchForStudents(String query) {
         return this.repo.searchForUsers(query, UserRoles.STUDENT);
     }
@@ -93,8 +149,8 @@ public class UserService {
         return this.repo.getByRefreshToken(refreshToken);
     }
 
-    public boolean adminExists(){
+    public boolean adminExists() {
         return this.repo.getAllByRole(UserRoles.ADMIN).size() > 0;
-    } 
+    }
 
 }

buisnesslogic/src/main/java/com/plannaplan/services/UsosApiService.java

@@ -19,10 +19,10 @@ import com.plannaplan.models.UserApiResponse;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 
-@Service
 /**
  * service to call usos api endpoints
  */
+@Service
 public class UsosApiService {
 
     private static final String NAME_FIELD = "first_name";