User_Management

STORIES

• As an admin I can add users — a user has a name.

• As an admin I can delete users.

• As an admin I can assign users to a group they aren’t already part of.

• As an admin I can remove users from a group.

• As an admin I can create groups.

• As an admin I can delete groups when they no longer have members.

REQUIREMENTS

• Symfony 4.2. (https://symfony.com/download)

• Apache WEB server, version 2.0 or higher. ( http://httpd.apache.org/download.cgi )

• PHP 7.2. ( http://www.php.net/ )

• MySQL 5.6 or higher. ( http://dev.mysql.com/downloads/ )

• IDE (like PhpStorm). (https://www.jetbrains.com/phpstorm/download/)

INSTALLATION

1- Download and Extract the Source Code.

2- Create DataBase:

• in the terminal of the IDE type the following commands:

  a. composer update

  b. according to env file of the root of the project DATABASE_URL=mysql://mohammad:[email protected]:3306/usersmanegement

  create a user with password which has access to the database: DATABASE_URL=mysql://user_db:[email protected]:3306/dbName

  c. php bin/console doctrin:database:create

3- Create Table: -in the terminal of the IDE type these commands to create tables for the entities of the project:

    a. php bin/console doctrine:migrations:diff
    
    b. php bin/console doctrine:migrations:migrate

User Guides

1- The project consists of two parts:

1-1- Web part

1-2- REST API part

1-1 Web part:

  a. users can register 
  
  b. THE FIRST USER WHO REGISTER WILL GIVEN ADMIN_ROLE. (column roles is implemented inside the user table)
  
  c. PLEASE NOTE THAT ONLY ADMIN CAN DO THE FOLLOWING ACTIONS:
  
       I)   CREATE GROUP 

       II)  DELETE GROUP
       
             a. only groups with no members can be deleted.

       III) ADD USER TO A GROUP

       IV)  REMOVE USER FROM A GROUP

       V)   DELETE USER

1-2 REST API part:

    a.  In the registration process a unique token is created for each user in order to identify the senders of the REST requests.
    
        I)   token is stored in token column of the user table 
        
        II)  Each user can see only his/her own token in the user list of web version
        
        // TODO  separte table with the userId column, user token column, and also expiration time column must be implemented, etc.
        
        // TODO  After each Login Token must be created
    
    b.  URLs of the REST REQUESTS MUST START WITH /api/. Such as the followign sample url:
    
        `HOMEURL/api/RESTREQUEST`
        
    c.  admin token must be send as a token parameter for each REST request. 
    
        `example: HOMEURL/api/deleteUser?token=sadff&userId=2`
        
    d.  the following shows the list of valid REST API Requests:
    
        I)    create user: `HOMEURL/api/createUser?token=****&name=***&email=****&password=****`
        
        II)   delete user:  `HOMEURL/api/deleteUser?token=****&userId=***`
        
        III)  view user list:  `HOMEURL/api/viewUsers?token=****`
        
        IV)   create group:  `HOMEURL/api/createGroup?token=****&title=`
        
        V)    delete group:  `HOMEURL/api/deleteGroup?token=****&groupId=`
        
        VI)   view group members:  `HOMEURL/api/viewGroupUsers?token=****&groupId=` 
        
        VII)  add user to a group: `HOMEURL/api/viewGroupUsers?token=****&groupId=` 
        
        VIII) view group list `HOMEURL/api/groupList?token=****` 
        
        IX)   delete a user from a group  `HOMEURL/api/deleteUserFromGroup?token=****&userId=***&groupId=****` 

//TODO Invalid URL Requests must be handled.

//TODO Role Management must be handled via a seperate tables. (like role table and user_role table)