README.md

@@ -0,0 +1 @@
+# payroll_manager

README.rst

@@ -1,71 +0,0 @@
-=================
- Payroll manager
-=================
-
-|codebuild|
-
-This is a simple system to keep a record of employees where they will perform different tasks within the company and will be paid accordingly in a monthly bases.
-
-.. contents::
-
-Getting started
------------------
-
-The system requires the following:
- - Ubuntu 16.04
- - php 7.0
- - composer
- - docker
- - docker-compose
- - mysql 5.7
- 
-Installation
------------------
- 
-Alternatively to installing all the packages and configuring the server it's possible to start up an instance of the system with docker-compose
-
-To install docker
-.. code-block:: bash
-
-    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
-
-    sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
-
-    sudo apt-get update
-
-    apt-cache policy docker-ce
-
-    sudo apt-get install -y docker-ce
-
-To install docker compose
-.. code-block:: bash
-    sudo curl -L https://github.com/docker/compose/releases/download/1.19.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
-
-    sudo chmod +x /usr/local/bin/docker-compose
-
-And finally the containers can be initialized by running
-.. code-block:: bash
-   sudo docker-compose up --build -d
-    
-Sign in
------------------
-
-The login page can be accessed at **http://localhost:8085/public/html/login.php**
-
-To access the platform the user is **sloth** and the pasword **slothness**
-
-Further reading
------------------
-To further read about the api and it's front-end
-`api-payroll <https://github.com/PootisPenserHere/payroll_manager/blob/master/api-payroll/README.rst>`_
-
-More about the database `database <https://github.com/PootisPenserHere/payroll_manager/blob/master/database/README.rst>`_
-
- 
-Data volumes
------------------
-Since the application is designed to run within containers a number of volumes has been created to persist the data, they can be found in the volumes directory on the root of the project
-
-.. |codebuild| image:: https://s3.amazonaws.com/codefactory-us-east-1-prod-default-build-badges/passing.svg
-    :target: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiWm42eW80VzA2OXRTc2xIMXErZ1hlS1RpNnFCaDVMWENqSSsyU2x3dUpReEpCRUtaZGRmbklYaFN0anVEWW9NaGYvQ21PNk9tR25rZGtZMjNvR1ArbGdVPSIsIml2UGFyYW1ldGVyU3BlYyI6IjVXYjl3TWZnUVQ1MFZDQ0kiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master
-    :alt: Build status of the master branch on amazon codebuild

api-payroll/README.md

@@ -0,0 +1,27 @@
+# Slim Framework 3 Skeleton Application
+
+Use this skeleton application to quickly setup and start working on a new Slim Framework 3 application. This application uses the latest Slim 3 with the PHP-View template renderer. It also uses the Monolog logger.
+
+This skeleton application was built for Composer. This makes setting up a new Slim Framework application quick and easy.
+
+## Install the Application
+
+Run this command from the directory in which you want to install your new Slim Framework application.
+
+    php composer.phar create-project slim/slim-skeleton [my-app-name]
+
+Replace `[my-app-name]` with the desired directory name for your new application. You'll want to:
+
+* Point your virtual host document root to your new application's `public/` directory.
+* Ensure `logs/` is web writeable.
+
+To run the application in development, you can run these commands 
+
+	cd [my-app-name]
+	php composer.phar start
+
+Run this command in the application directory to run the test suite
+
+	php composer.phar test
+
+That's it! Now go build something cool.

api-payroll/README.rst

@@ -1,34 +0,0 @@
-=======
-The api
-=======
-
-.. contents::
-
-About
--------
-The project has been built with slim in the backed and jquery with bootstrap for the front, both of them share the public folder from which they can be accessed by the general public.
-
-Auth
-------
-The system uses cookie based sessions which are handled by a midleware, have a time to live of 10 minutes and are refreshed each time a new request is made to the api, further more the contents of the session itself has been secured with openssl.
-
-Database
----------
-To connect to the database pdo is used, its configuration can be found at **src/settings.php** under the mysql section. The following settings are set as default:
-     - **PDO::ATTR_EMULATE_PREPARES** Has been set to true in order to lower the strain on the database by processing the prepare statements on the server side, if cache performance is desired this option should be changed to false
-    - **PDO::ATTR_ERRMODE** Uses **PDO::ERRMODE_EXCEPTION** which will return all mysql errors as exceptions to prevent further execution of the software
-    - **PDO::ATTR_DEFAULT_FETCH_MODE** uses **PDO::FETCH_ASSOC** and as such the query ouput system wide is expected as an associative array
-
-Data protection
-----------------
-|  Encryption has been applied to sensitive data, passwords are protected with with bcrypt and it's configuration can be found in the settings.php file, by default a cost of 12 is used for the hashing as well as a 16 characters randomly generated string (128 bits) as an iv.
-
-|  For data that needs to be both read and written such as names AES in mode cbc with 256 block size has been used.
-
-|  The reason to have choosen AES is the desire to make the process of securing the data both secure and affordable since many hardware manufacturers already have architectures designed to improce the speed of AES.
-
-| **Important note**: While in this project the encryption password has been saved into the settings.php file it's adviced that in a real use case it's stored more securely or else where entirely such as a key management service.
-
-Error handling
----------------
-Should an exception be encountered it'll be caught by a middleware that will form a new response body, returning it with a 500 http code and a json object containing the keys status set to error as well as a message key that will contain the exception that was raised.

api-payroll/public/html/editEmployee.php

@@ -103,11 +103,9 @@
                 <div class="row col-md-offset-6">
                     <div class="form-group">
                         <a href="#" class="btn btn-lg btn-success " onclick="updateEmployee();">Update</a>
-                        <a href="#" class="btn btn-lg btn-primary " onclick="loadView(currentView);">Clear</a>
-                        <a href="#" class="btn btn-lg btn-danger " onclick="deleteEmployee();">Delete</a>
                     </div>
                 </div>
             </div>
         </div>
     </div>
-</form>
+</form>

api-payroll/public/html/newEmployee.php

@@ -85,10 +85,9 @@
                 <div class="row col-md-offset-6">
                     <div class="form-group">
                         <a href="#" class="btn btn-lg btn-success " onclick="saveNewEmployee();">Create</a>
-                        <a href="#" class="btn btn-lg btn-primary " onclick="loadView(currentView);">Clear</a>
                     </div>
                 </div>
             </div>
         </div>
     </div>
-</form>
+</form>

api-payroll/public/html/registerWorkDays.php

@@ -134,7 +134,6 @@
             <div class="row col-md-offset-6">
                 <div class="form-group">
                     <a href="#" class="btn btn-lg btn-success " onclick="processSaveActionWorkDay();">Save</a>
-                    <a href="#" class="btn btn-lg btn-primary " onclick="loadView(currentView);">Clear</a>
                 </div>
             </div>
         </div>

api-payroll/public/js/editEmployee.js

@@ -134,43 +134,6 @@ function loadEmployeeData(code){
     });
 }
 
-/**
- * Will change the status of an employee to remove them from the
- * active employee list
- */
-function deleteEmployee(){
-    let baseUrl = getbaseUrl();
-    let code = $('#editEmployeeCode').val();
-
-    $.ajax({
-        url: baseUrl + '/api/employee/' + code,
-        type: 'DELETE',
-        dataType: 'json',
-        success:function(data){
-            $('#modalServerResponseSuccess').modal('show');
-            document.getElementById('serverResponseSuccess').innerHTML = 'The employee ' + data['firstName'] + ' ' + data['middleName'] + ' ' + data['lastName'] + ' has been deleted.';
-        },
-        error:function(x,e) {
-            let responseText = $.parseJSON(x["responseText"]);
-
-            if (x.status==0) {
-                $('#modalErrorInternetConnection').modal('show');
-            } else if(x.status==404) {
-                $('#modalError404').modal('show');
-            } else if(x.status==500) {
-                $('#modalServerResponseError').modal('show');
-                document.getElementById('modalResponseError').innerHTML = responseText['message'];
-            } else if(e=='parsererror') {
-                $('#modalErrorParsererror').modal('show');
-            } else if(e=='timeout'){
-                $('#modalErrorTimeout').modal('show');
-            } else {
-                $('#modalErrorOther').modal('show');
-            }
-        },
-    });
-}
-
 function updateEmployee(){
     let baseUrl = getbaseUrl();
 

api-payroll/public/js/landing.js

@@ -1,6 +1,3 @@
-// will contain the current loaded view
-let currentView;
-
 /**
  * Destorys the session for the current user and redirects
  * back to the login form
@@ -62,8 +59,6 @@ function loadView(requestedView){
         url: baseUrl + '/html/' + requestedView,
         type: 'get',
         success:function(data){
-	    currentView = requestedView;
-
             $("#newViewBody").hide().html(data).show('slow');
         },
         error:function(x,e) {
@@ -85,12 +80,4 @@ function loadView(requestedView){
             }
         },
     });
-}
+}
-
-/**
-* Reloads the last view that was accessed as a way of fully clearing and
-* resetting the values of the form
-*/
-function clearView(view){
-    loadView(view);
-}

api-payroll/src/application/EmployeeApplication.php

@@ -518,19 +518,9 @@ class EmployeeApplication{
         return $response;
     }
 
-    /**
+    function disableEmployeeRecord($idEmployee){
-     * @param $code string
-     * @return array
-     * @throws Exception
-     */
-    function disableEmployeeRecord($code){
-        $this->asserts->isNotEmpty($code, "The code can't be empty.");
-
-        $idEmployee = $this->getIdEmployeeByCode($code);
         $this->asserts->higherThanZero($idEmployee, "idEmployee must be higher than 0");
 
-        $employeeData = $this->proxyGetEmployeeDataById($idEmployee);
-
         try {
             $stmt = $this->pdo->prepare("UPDATE employees
                                         SET
@@ -542,12 +532,8 @@ class EmployeeApplication{
             $this->pdo->commit();
 
             $stmt = null;
-
-            return $employeeData;
-
         } catch( PDOExecption $e ) {
             $this->pdo->rollback();
-            throw new Exception("The employee you tried to delete could not be found.");
         }
     }
 

api-payroll/src/routes.php

@@ -65,12 +65,12 @@ $app->put('/api/employee', function ($request, $response) {
         ->write(json_encode($this->employeeApplication->updateEmployeeData($requestData)));
 });
 
-$app->DELETE('/api/employee/{code}', function (Request $request, Response $response, array $args) {
+$app->DELETE('/api/employee/{idEmployee}', function (Request $request, Response $response, array $args) {
-    $code = $args['code'];
+    $idEmployee = $args['idEmployee'];
 
     return $response->withStatus(200)
         ->withHeader('Content-Type', 'application/json')
-        ->write(json_encode($this->employeeApplication->disableEmployeeRecord($code)));
+        ->write(json_encode($this->employeeApplication->disableEmployeeRecord($idEmployee)));
 });
 
 $app->get('/api/employee/type/{code}', function (Request $request, Response $response, array $args) {

database/README.rst

@@ -1,22 +0,0 @@
-================
-``The database``
-================
-
-.. contents::
-
-About the container
---------------------
-
-The database container is created in two stages to bypass some limitations with docker, firstly a new image will be created based on the Dockerfile which will be based on mysql 5.7 and it'll be passed the .sql scripts to initialize the database as well as a config file to configure the port that will be exposed.
-
-Initializing
--------------
-When the database is being created as an image it'll take all the scripts in the **/docker-entrypoint-initdb.d** directory and execute them in alphabetical order which will result in the database with its tables and initial data being created.
-
-Accession
-----------
-The newly created container will have two users *root** and **sloth** both of which will have the password **12345678** and it'll be accessible in the port 3307
-
-Persistence
------------
-A volume containing the data from **/var/lib/mysql** will be created to persist the information, once its created running the container build again will execute the starting scripts

documentation/README.rst

@@ -1,99 +0,0 @@
-================
-Documentation
-================
-
-.. contents::
-
-Requirements
-----------------------------------
-Funtional:
-    - A user name and password auth
-    - Encrypted sensitive data
-    - The employee need to have their full name captured
-        - The last name must tolerate being null
-    - An email will be needed for the employee
-        - The email format must be formated
-    - Employees will need a phone number
-    - Searching employees despite the encryption
-    - Employees must have a unique code to reference them 
-    - Being able to modify the name, email and phone values of already existing employees
-    - Having the values for the different payments parametrized
-    - Allowing for employees to perform other roles during their work day
-          - Only for the auxiliary personnel
-    - Taking into account only the current month for the salary
-    - Reducing the taxes for the salary
-          - If it goes beyond the threshold a different percentage is paid in taxes
-          - The way the extra tax is handled should be parametrized
-  
-
-Funtional: 
-    - Session management
-    - Data integrity
-    - Data security
-    - Accessible through web
-    - Containerized
-
-Software behaivor
------------------
-In:
-    - Employee details
-        - First name
-        - Middle name
-        - Last name
-        - Birth date
-        - Email
-        - Phone number
-    - Work per day
-        - Number of deliveries
-        - Rol performed
-Process:
-    - Register a new employee
-    - Modify employee
-    - Search employee
-    - Add new work day for employee
-    - Calculate monthly payment for employee
-
-Out:
-    - Upon registering
-        - Employee code
-    - In the work days registry
-        - Raw salary for the the month
-        - Taxes discounted
-        - Real salary for the month
-        - Vouchers (if applicable)
-        
-Calculating the monthly salary
---------------------------------
-.. image:: https://raw.githubusercontent.com/PootisPenserHere/payroll_manager/master/documentation/calculatingSalary.bmp
- 
-Tests cases
------------------
-+----+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
-| Id | Description                                                                                  | Input                                                               | Expected output                                                                                       |
-+----+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
-| 1  | Displaying current salary for the outgoing month                                             | Selecting an employee from the search field                         | On the right side of the window a break down of the employee's salary for the month will be displayed |
-+----+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
-| 2  | Submitting incomplete form                                                                   | All of the input but one of the fields                              | An error shown in a red modal describing the missing field                                            |
-+----+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
-| 3  | Altering the sent data to change the performed rol to one that can't be done by the employee | A employee other than aux performing a different rol than their own | An error displaying that the employee can't perform that task                                         |
-+----+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
-
-Executed tests
----------------
-+----+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
-| Id | Description                                                                                  | Result                                                                   | What went wrong? |
-+----+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
-| 1  | Displaying current salary for the outgoing month                                             | When the employee was selected the current salary was loaded succesfully |                  |
-+----+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
-| 2  | Submitting incomplete form                                                                   | Got the error "The number of deliveries cannot be empty or 0"            |                  |
-+----+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
-| 3  | Altering the sent data to change the performed rol to one that can't be done by the employee | Got the error "The selected rol can't be done by this type of employee"  |                  |
-+----+----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
-
-Tools
-----------------------------------
-The following tools and software were used:
-- phpstorm
-- git
-- docker && docker-compose
-- Ubuntu 16