Initial setup

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.env.example

@@ -0,0 +1,51 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost
+
+LOG_CHANNEL=stack
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=laravel
+DB_USERNAME=root
+DB_PASSWORD=
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DRIVER=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS=null
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_APP_CLUSTER=mt1
+
+MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.gitattributes

@@ -0,0 +1,5 @@
+* text=auto
+*.css linguist-vendored
+*.scss linguist-vendored
+*.js linguist-vendored
+CHANGELOG.md export-ignore

.gitignore

@@ -0,0 +1,27 @@
+/node_modules
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+**/.idea/
+.env
+.env.backup
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+npm-debug.log
+yarn-error.log
+/storage/file
+composer.lock
+yarn.lock
+.DS_Store
+public/.DS_Store
+public/images/.DS_Store
+gox.iml
+rebuild_docker.sh
+docker/*
+db/*
+docker-compose.yml
+package-lock.json
+public/*
+/public/*

.styleci.yml

@@ -0,0 +1,13 @@
+php:
+  preset: laravel
+  disabled:
+    - no_unused_imports
+  finder:
+    not-name:
+      - index.php
+      - server.php
+js:
+  finder:
+    not-name:
+      - webpack.mix.js
+css: true

README.md

@@ -0,0 +1,62 @@
+<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400"></a></p>
+
+<p align="center">
+<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
+<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
+</p>
+
+## About Laravel
+
+Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+
+- [Simple, fast routing engine](https://laravel.com/docs/routing).
+- [Powerful dependency injection container](https://laravel.com/docs/container).
+- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
+- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
+- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
+- [Robust background job processing](https://laravel.com/docs/queues).
+- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+
+Laravel is accessible, powerful, and provides tools required for large, robust applications.
+
+## Learning Laravel
+
+Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+
+If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+
+## Laravel Sponsors
+
+We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell).
+
+### Premium Partners
+
+- **[Vehikl](https://vehikl.com/)**
+- **[Tighten Co.](https://tighten.co)**
+- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
+- **[64 Robots](https://64robots.com)**
+- **[Cubet Techno Labs](https://cubettech.com)**
+- **[Cyber-Duck](https://cyber-duck.co.uk)**
+- **[Many](https://www.many.co.uk)**
+- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
+- **[DevSquad](https://devsquad.com)**
+- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
+- **[OP.GG](https://op.gg)**
+
+## Contributing
+
+Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+
+## Code of Conduct
+
+In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+
+## Security Vulnerabilities
+
+If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+
+## License
+
+The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

app/Classes/Exceptions/AccessForbiddenException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class AccessForbiddenException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'A forbidden attempt to access protected resources was detected',
+            HttpStatus::ACCESS_FORBIDDEN);
+    }
+}

app/Classes/Exceptions/AccessUnauthorisedException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class AccessUnauthorisedException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'An unauthorised attempt to access protected resources was detected',
+            HttpStatus::ACCESS_UNAUTHORISED);
+    }
+}

app/Classes/Exceptions/ErrorException.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use Exception;
+
+
+class ErrorException extends Exception {
+
+    /**
+     * ErrorException constructor.
+     *
+     * @param string $message
+     * @param int $code
+     */
+    public function __construct(string $message, int $code = 0) {
+        parent::__construct($message, $code);
+    }
+}

app/Classes/Exceptions/InternalServerErrorException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class InternalServerErrorException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'An internal server error has occurred. Please check application logs for more information.',
+            HttpStatus::SERVER_ERROR);
+    }
+}

app/Classes/Exceptions/MalformedRequestException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class MalformedRequestException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'Unable to process the request as it is malformed', HttpStatus::BAD_REQUEST);
+    }
+}

app/Classes/Exceptions/RequestValidationException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class RequestValidationException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'Unable to process the request due to validation failure', HttpStatus::VALIDATION_FAILED);
+    }
+}

app/Classes/Exceptions/ResourceConflictException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class ResourceConflictException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'Unable to create the requested resource as it already exists',
+            HttpStatus::RESOURCE_ALREADY_EXISTS);
+    }
+}

app/Classes/Exceptions/ResourceNotFoundException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+
+final class ResourceNotFoundException extends ServiceApiException {
+    public function __construct(?string $message = null) {
+        parent::__construct($message ?? 'Unable to find the requested resource', HttpStatus::RESOURCE_NOT_FOUND);
+    }
+}

app/Classes/Exceptions/ServiceApiException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Classes\Exceptions;
+
+abstract class ServiceApiException extends ErrorException {
+
+    public function __construct(string $message, int $httpStatusCode = 500) {
+        parent::__construct($message, $httpStatusCode);
+        $this->httpStatusCode = $httpStatusCode;
+    }
+}

app/Classes/General/Abstracts/AbstractControllerLogic.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace App\Classes\General\Abstracts;
+
+
+use App\Classes\Exceptions\ErrorException;
+use App\Classes\Exceptions\InternalServerErrorException;
+use App\Classes\ValueObjects\Constants\Notifications;
+use App\Classes\ValueObjects\Constants\HttpStatus;
+use App\Classes\ValueObjects\Response\ApiResponseObject;
+use ErrorException as GeneralExceptions;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+use Illuminate\Support\Facades\DB;
+
+abstract class AbstractControllerLogic
+{
+
+    /**
+     * @return array
+     */
+    abstract protected function notification(): array;
+
+    /**
+     * @return string
+     */
+    private function getNotificationTitle():string {
+        return $this->notification()['title'] ? $this->notification()['title']: Notifications::UNDEFINED['title'];
+    }
+
+    /**
+     * @return string
+     */
+    private function getNotificationMessage():string {
+        return $this->notification()['message'] ? $this->notification()['message']: Notifications::UNDEFINED['message'];
+    }
+
+    /**
+     * @param Request $request
+     * @return JsonResponse
+     * @throws ErrorException
+     */
+    abstract protected function logic(Request $request) : JsonResponse;
+
+    /**
+     * @param Request $request
+     * @return JsonResponse
+     */
+    public function execute(Request $request) : JsonResponse  {
+
+        try {
+
+            DB::beginTransaction();
+
+            $response = $this->logic($request);
+
+            DB::commit();
+
+            return $response;
+
+        } catch (ErrorException|GeneralExceptions $exception){
+            return (new ApiResponseObject($this->getNotificationTitle().' failed', $exception->getMessage(),
+                $exception->getCode() ? $exception->getCode() : HttpStatus::SERVER_ERROR))->handler();
+
+        }
+    }
+
+    /**
+     * @param array|null $data
+     * @return JsonResponse
+     */
+    public function response(?array $data = []) : JsonResponse {
+
+        return (new ApiResponseObject($this->getNotificationTitle().' Successful',
+            $this->getNotificationMessage(),
+            HttpStatus::OK_WITH_MESSAGE, $data))->handler();
+    }
+
+    /**
+     * @param JsonResource $resource
+     * @return JsonResponse
+     */
+    public function resourceResponse(JsonResource $resource){
+        return $this->response(['data' => $resource]);
+    }
+
+    /**
+     * @param ResourceCollection $collection
+     * @return JsonResponse
+     */
+    public function collectionResponse(ResourceCollection $collection){
+        return $this->response(json_decode($collection->response()->getContent(), true));
+    }
+
+}

app/Classes/General/Abstracts/AbstractRule.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Classes\General\Abstracts;
+
+
+use App\Classes\Exceptions\AccessForbiddenException;
+use App\Classes\Exceptions\RequestValidationException;
+use App\Classes\General\Interfaces\DataTransferObject;
+
+abstract class AbstractRule
+{
+
+    abstract protected function authorized(): bool;
+
+    abstract protected function validators($object): bool;
+
+
+    abstract protected function criteria($object): bool;
+
+
+    /**
+     * @param DataTransferObject|null $object
+     * @return bool
+     * @throws AccessForbiddenException
+     * @throws RequestValidationException
+     */
+    public function passes(?DataTransferObject $object = null): bool {
+        try {
+            if(!$this->authorized()){
+                throw new AccessForbiddenException('You don\'t have permission to preform this action');
+            }
+
+            $this->validators($object);
+            $this->criteria($object);
+
+            return true;
+
+        } catch(AccessForbiddenException $exception){
+            throw new AccessForbiddenException('You don\'t have permission to preform this action');
+        } catch(\Exception $exception){
+            throw new RequestValidationException($exception->getMessage());
+        }
+
+    }
+
+}

app/Classes/General/Abstracts/AbstractService.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Classes\General\Abstracts;
+
+use App\Classes\Exceptions\MalformedRequestException;
+use App\Classes\General\Interfaces\DataTransferObject;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractService
+{
+
+    /**
+     * @param Model $model
+     * @param DataTransferObject $object
+     * @return mixed
+     * @throws MalformedRequestException
+     */
+    public function execute(Model $model){
+
+        try{
+
+            /** @var Model $model */
+            $model = $this->handler($model);
+
+            if($model->save()){
+                return $model;
+            }
+
+
+
+        } catch (QueryException $exception){
+            throw new MalformedRequestException('Unable to update the record due to unexpected error');
+        }
+
+    }
+
+    abstract function getModel(Model $model);
+    abstract function handler(Model $model);
+
+
+}

app/Classes/General/Abstracts/AbstractValidation.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Classes\General\Abstracts;
+
+
+use App\Classes\Exceptions\RequestValidationException;
+use App\Classes\General\Interfaces\DataTransferObject;
+use Illuminate\Support\Facades\Validator;
+
+abstract class AbstractValidation
+{
+
+    /** @var Validator */
+    private $validator;
+
+    /**
+     * AbstractValidation constructor.
+     * @param Validator $validator
+     */
+    public function __construct(Validator $validator)
+    {
+        $this->validator = $validator;
+    }
+
+
+    abstract protected function data($object): array;
+
+    abstract protected function rules(): array;
+
+    abstract protected function messages(): array;
+
+    /**
+     * @param DataTransferObject $object
+     * @param null|string $type
+     * @return bool
+     * @throws RequestValidationException
+     */
+    public function validate(DataTransferObject $object, ?string $type = 'POST')
+    {
+        $validator = $this->validator::make($this->data($object), $this->rules($type), $this->messages());
+
+        if($validator->fails()) {
+            throw new RequestValidationException($validator->messages()->first());
+        }
+
+        return true;
+    }
+
+}

app/Classes/General/DummyDataTransferObject.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Classes\General;
+
+use App\Classes\General\Interfaces\DataTransferObject;
+
+class DummyDataTransferObject implements DataTransferObject
+{
+
+}

app/Classes/General/Eloquent/AbstractDeleteMultipleRecord.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+use App\Classes\Exceptions\MalformedRequestException;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractDeleteMultipleRecord
+{
+
+    /**
+     * @param Builder $query
+     * @param array $ids
+     * @return mixed
+     * @throws MalformedRequestException
+     */
+    public function handler(Builder $query, array $ids){
+        try{
+
+            $record_deleted = $query->whereIn('id',$ids)->delete();
+
+            return ($record_deleted == count($ids)) ? true : false;
+
+        } catch (QueryException|\Exception $exception){
+            throw new MalformedRequestException('Unable to delete the record due to unexpected error');
+        }
+    }
+
+
+
+}

app/Classes/General/Eloquent/AbstractDeleteRecord.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+use App\Classes\Exceptions\MalformedRequestException;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractDeleteRecord
+{
+
+    /**
+     * @param Model $model
+     * @return mixed
+     * @throws MalformedRequestException
+     */
+    public function handler(Model $model){
+        try{
+
+            if($model->delete()){
+                return [];
+            }
+
+        } catch (QueryException|\Exception $exception){
+            throw new MalformedRequestException('Unable to update the record due to unexpected error');
+        }
+    }
+
+
+
+}

app/Classes/General/Eloquent/AbstractFetchRecord.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+
+use App\Classes\Exceptions\ResourceNotFoundException;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+abstract class AbstractFetchRecord extends AbstractGetRecord
+{
+
+    /**
+     * @param array|null $filters
+     * @return mixed
+     */
+    public function execute(array $filters = []){
+
+        return $this->handler($filters);
+
+    }
+
+
+    /**
+     * @param Builder $query
+     * @return Model
+     * @throws ResourceNotFoundException
+     */
+    public function getResults(Builder $query): Model {
+        if(!$query->exists()){
+            throw new ResourceNotFoundException('Unable to find any record based on the criteria provided');
+        }
+
+        return $query->first();
+    }
+
+}

app/Classes/General/Eloquent/AbstractGetRecord.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Collection;
+
+abstract class AbstractGetRecord
+{
+
+    /** @var array  */
+    private const DECORATION_FILTERS = ['per_page', 'order_by'];
+
+    /** @var Collection */
+    private $filters;
+
+
+    /**
+     * @return Collection
+     */
+    private function getQueryFilters(){
+        return $this->filters->except(self::DECORATION_FILTERS);
+    }
+
+    /**
+     * @return Collection
+     */
+    public function getDecorationFilters(){
+        return $this->filters->only(self::DECORATION_FILTERS);
+    }
+
+    /**
+     * @param null|string $json
+     * @return array
+     */
+    public function deserializeFilters(?string $json): array {
+        return $json !== null ? collect(json_decode($json))->toArray() : [];
+    }
+
+    /**
+     * @return Builder
+     */
+    private function applyFiltersToQuery(): Builder
+    {
+        return (new ApplyFiltersToQuery())->execute($this->getRepository(), $this->getQueryFilters()->toArray());
+    }
+
+    /**
+     * @param array $filters
+     * @return mixed
+     */
+    public function handler(array $filters){
+        $this->filters = collect($filters);
+        return $this->getResults($this->applyFiltersToQuery());
+    }
+
+
+    /**
+     * @return Builder
+     */
+    abstract function getRepository(): Builder;
+
+    /**
+     * @param Builder $query
+     * @return mixed
+     */
+    abstract function getResults(Builder $query);
+
+}

app/Classes/General/Eloquent/AbstractListRecord.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+
+use App\Classes\Exceptions\MalformedRequestException;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractListRecord extends AbstractGetRecord
+{
+
+
+    /**
+     * @param array $filters
+     * @return mixed
+     * @throws MalformedRequestException
+     */
+    public function execute(array $filters = []){
+
+        try{
+
+            return $this->handler($filters);
+
+        } catch (QueryException $exception){
+            throw new MalformedRequestException('Unable to fetch the list of records due to unexpected error');
+        }
+
+    }
+
+    /**
+     * @param Builder $query
+     * @return mixed
+     */
+    public function getResults(Builder $query) {
+        $filters = $this->getDecorationFilters();
+
+        if($filters->has('order_by')){
+            $query = $query->orderBy($filters->get('order_by')->column, $filters->get('order_by')->DESC ? 'DESC': 'ASC');
+        }
+
+        return $filters->has('per_page') ? $query->paginate($filters->get('per_page')) : $query->get();
+
+    }
+
+}

app/Classes/General/Eloquent/AbstractUpdateMultipleRecord.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+use App\Classes\Exceptions\MalformedRequestException;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractUpdateMultipleRecord
+{
+
+    /**
+     * @param Builder $query
+     * @param array $ids
+     * @param array $values
+     * @return mixed
+     * @throws MalformedRequestException
+     */
+    public function handler(Builder $query, array $ids, array $values){
+        try{
+
+            $record_updated = $query->whereIn('id',$ids)->update($values);
+
+            return ($record_updated == count($ids)) ? true : false;
+
+        } catch (QueryException|\Exception $exception){
+            throw new MalformedRequestException('Unable to update the record due to unexpected error');
+        }
+    }
+
+
+
+}

app/Classes/General/Eloquent/AbstractUpdateRecord.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+use App\Classes\Exceptions\MalformedRequestException;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractUpdateRecord
+{
+
+
+    /**
+     * @param Model $model
+     * @return Model
+     * @throws MalformedRequestException
+     */
+    public function handler(Model $model){
+        try{
+
+            if($model->save()){ return $model; }
+
+        } catch (QueryException $exception){
+            throw new MalformedRequestException($exception);
+        }
+    }
+
+
+
+}

app/Classes/General/Eloquent/AbstractUpdateRelationshipRecord.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+use App\Classes\Exceptions\MalformedRequestException;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasOneOrMany;
+use Illuminate\Database\QueryException;
+
+abstract class AbstractUpdateRelationshipRecord
+{
+
+
+    /**
+     * @param HasOneOrMany $relation
+     * @param Model $model
+     * @return Model
+     * @throws MalformedRequestException
+     */
+    public function handler(HasOneOrMany $relation, Model $model){
+        try{
+            if($relation->save($model)){
+                return $model;
+            }
+
+        } catch (QueryException $exception){
+            throw new MalformedRequestException($exception->getMessage());
+        }
+    }
+
+
+
+}

app/Classes/General/Eloquent/ApplyFiltersToQuery.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Classes\General\Eloquent;
+
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Str;
+
+class ApplyFiltersToQuery
+{
+
+    /**
+     * @param Builder $query
+     * @param array $filters
+     * @return Builder
+     */
+    public function execute(Builder $query, array $filters) : Builder{
+        foreach($filters as $filterName => $value){
+            $decorator = static::createFilterDecorator($filterName);
+
+            if (static::isValidDecorator($decorator)) {
+                $query = $decorator::apply($query, $value);
+            }
+        }
+
+        return $query;
+    }
+
+    private static function createFilterDecorator($name)
+    {
+        return __NAMESPACE__ . '\Filters\\' . Str::studly($name);
+    }
+
+    private static function isValidDecorator($decorator)
+    {
+        return class_exists($decorator);
+    }
+
+
+}

app/Classes/General/Eloquent/Filters/Active.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Active implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('active', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/BusinessType.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class BusinessType implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('business_type', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/CompanyId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class CompanyId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('company_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/ConvertibleCurrencyId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class ConvertibleCurrencyId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('convertible_currency_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/CountryId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class CountryId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('country_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/CurrencyId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class CurrencyId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('currency_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/CustomServiceType.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use App\Classes\ValueObjects\Constants\SegmentConstants;
+use Illuminate\Database\Eloquent\Builder;
+
+class CustomServiceType implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('reference', SegmentConstants::CUSTOM_SERVICE_TYPE)->where('detail->id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/DocumentTypeIn.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class DocumentTypeIn implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereIn('document_type', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Email.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Email implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('email',  '=', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Filter.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+interface Filter
+{
+
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value);
+
+
+}

app/Classes/General/Eloquent/Filters/FixedCurrencyId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class FixedCurrencyId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('fix_currency_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Id.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Id implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/IdIn.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class IdIn implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereIn('id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/IdNot.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class IdNot implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('id', '!=', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/IdNotIn.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class IdNotIn implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereNotIn('id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/IssuerIn.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class IssuerIn implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereIn('issuer', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Marking.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Marking implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('marking', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Name.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Name implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('name', 'LIKE', '%' . $value . '%');
+    }
+
+}

app/Classes/General/Eloquent/Filters/NotExpired.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
+
+class NotExpired implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereDate('expires_on', '>=', Carbon::now());
+    }
+
+}

app/Classes/General/Eloquent/Filters/OriginalCurrencyIdIn.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class OriginalCurrencyIdIn implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereIn('original_currency_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/PaymentApprovals.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class PaymentApprovals implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->payments()->inComplete()->has('documents');
+    }
+
+}

app/Classes/General/Eloquent/Filters/PaymentMethodType.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class PaymentMethodType implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('payment_method_type', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/PendingPayment.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+use App\Classes\ValueObjects\Constants\SegmentConstants;
+use App\Classes\ValueObjects\Constants\TransactionType;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Facades\DB;
+
+class PendingPayment implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder;
+    }
+
+}

app/Classes/General/Eloquent/Filters/PendingPurchaseOrder.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+use App\Classes\ValueObjects\Constants\SegmentConstants;
+use App\Classes\ValueObjects\Constants\TransactionType;
+use Illuminate\Database\Eloquent\Builder;
+
+class PendingPurchaseOrder implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereHas('service', function($service){
+            $service->whereHas('constants', function($query) {
+                $query->where('reference', SegmentConstants::SERVICE_TYPE)->where('detail->is_billable', true);
+            });
+        })->whereDoesntHave('transactions', function($transaction){
+            return $transaction->where('type', TransactionType::PURCHASE_ORDER)->whereIn('status', [ApprovalStatus::PENDING_VERIFICATION, ApprovalStatus::APPROVED, ApprovalStatus::COMPLETED]);
+        });
+    }
+
+}

app/Classes/General/Eloquent/Filters/PurchaseOrderApproval.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+use App\Classes\ValueObjects\Constants\SegmentConstants;
+use App\Classes\ValueObjects\Constants\TransactionType;
+use Illuminate\Database\Eloquent\Builder;
+
+class PurchaseOrderApproval implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereHas('service', function($service){
+            $service->whereHas('constants', function($query) {
+                $query->where('reference', SegmentConstants::SERVICE_TYPE)->where('detail->is_billable', true);
+            });
+        })->whereHas('transactions', function($transaction){
+            return $transaction->where('type', TransactionType::PURCHASE_ORDER)->whereIn('status', [ApprovalStatus::PENDING_VERIFICATION]);
+        });
+    }
+
+}

app/Classes/General/Eloquent/Filters/Reference.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Reference implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('Reference', '=', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/SegmentId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class SegmentId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('segment_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/ServiceId.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class ServiceId implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('service_id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/ServiceType.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use App\Classes\ValueObjects\Constants\SegmentConstants;
+use Illuminate\Database\Eloquent\Builder;
+
+class ServiceType implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('reference', SegmentConstants::SERVICE_TYPE)->where('detail->id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/ShortCode.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class ShortCode implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('short_code', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Status.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Status implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('status', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/StatusIn.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class StatusIn implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->whereIn('status', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/SupplierCurrencies.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use App\Classes\ValueObjects\Constants\SegmentConstants;
+use Illuminate\Database\Eloquent\Builder;
+
+class SupplierCurrencies implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('reference', SegmentConstants::SUPPLIER_CURRENCIES)->where('detail->id', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Token.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Token implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('token', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/Type.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class Type implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('type', $value);
+    }
+
+}

app/Classes/General/Eloquent/Filters/WithBookings.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+
+use Illuminate\Database\Eloquent\Builder;
+
+class WithBookings implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->with('bookings');
+    }
+}

app/Classes/General/Eloquent/Filters/WithCompany.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+
+use Illuminate\Database\Eloquent\Builder;
+
+class WithCompany implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->with('owner');
+    }
+}

app/Classes/General/Eloquent/Filters/WithTransactions.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+
+use Illuminate\Database\Eloquent\Builder;
+
+class WithTransactions implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->with('transactions');
+    }
+}

app/Classes/General/Eloquent/Filters/WithUser.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+
+use Illuminate\Database\Eloquent\Builder;
+
+class WithUser implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->with('user');
+    }
+}

app/Classes/General/Eloquent/Filters/isDefault.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class isDefault implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('default', $value);
+    }
+
+}

app/Classes/General/Helper.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Classes\General;
+
+
+use Illuminate\Support\Str;
+
+class Helper
+{
+
+    /**
+     * @param string $methodName
+     * @return string
+     */
+    static function getPropertyName(string $methodName){
+        return Str::snake(str_replace('get', '', $methodName));
+    }
+
+    /**
+     * @param string $className
+     * @return array
+     */
+    static function getClassMethodsArray(string $className){
+        return array_slice(get_class_methods($className), 1);
+    }
+
+}

app/Classes/General/Interfaces/DataTransferObject.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Classes\General\Interfaces;
+
+
+Interface DataTransferObject
+{
+
+}

app/Classes/General/Interfaces/Documentable.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Classes\General\Interfaces;
+
+
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
+interface Documentable
+{
+
+    public function documents(): morphMany;
+
+}

app/Classes/General/Services/GeneratesInitials.php

@@ -0,0 +1,152 @@
+<?php
+
+namespace App\Classes\General\Services;
+
+
+class GeneratesInitials
+{
+    protected $length = 3;
+    protected $initials = 'CWW';
+    protected $keepCase = false;
+    protected $name = 'CIEF Worldwide';
+
+    /**
+     * Set the name used for generating initials.
+     *
+     * @param string $nameOrInitials
+     *
+     * @return GeneratesInitials
+     */
+    public function name($nameOrInitials)
+    {
+        $this->generate($nameOrInitials);
+
+        return $this;
+    }
+
+    /**
+     * Set if should keep lettercase on name.
+     * Setting this to false (default) will uppercase the name.
+     *
+     * @param boolean $keepCase
+     *
+     * @return GeneratesInitials
+     */
+    public function keepCase($keepCase = true)
+    {
+        $this->keepCase = $keepCase;
+
+        return $this;
+    }
+
+    /**
+     * Set the length of the generated initials.
+     *
+     * @param int $length
+     *
+     * @return GeneratesInitials
+     */
+    public function length($length = 2)
+    {
+        $this->length = (int) $length;
+        $this->initials = $this->generateInitials();
+
+        return $this;
+    }
+
+    /**
+     * Generate the initials.
+     *
+     * @param null|string $name
+     *
+     * @return string
+     */
+    public function generate($name = null)
+    {
+        if ($name !== null) {
+            $this->name = $name;
+            $this->initials = $this->generateInitials();
+        }
+
+        return (string) $this;
+    }
+
+    /**
+     * Will return the generated initials.
+     *
+     * @return string
+     */
+    public function getInitials()
+    {
+        return $this->initials;
+    }
+
+    /**
+     * Return the initials.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->getInitials();
+    }
+
+    /**
+     * Generate a two-letter initial from a name,
+     * and if no name, assume its already initials.
+     * For safety, we limit it to two characters,
+     * in case its a single, but long, name.
+     *
+     * @return string
+     */
+    protected function generateInitials()
+    {
+        $nameOrInitials = trim($this->name);
+
+        if( !$this->keepCase ) {
+            $nameOrInitials = mb_strtoupper($nameOrInitials);
+        }
+
+        $nameOrInitials = trim( trim( $nameOrInitials, '-' ) );
+
+        $names = explode(' ', $nameOrInitials);
+
+        // Get names with dash (-) between into separate names
+        $names = array_map( static function ($namePart) { return explode('-', $namePart); }, $names );
+        $realNames = [];
+
+        foreach( new \RecursiveIteratorIterator( new \RecursiveArrayIterator($names) ) as $namePart ) {
+            $realNames[] = $namePart;
+        }
+
+        $names = $realNames;
+
+        $initials = $nameOrInitials;
+        $assignedNames = 0;
+
+        if (count($names) > 1) {
+            $initials = '';
+            $start = 0;
+
+            for ($i = 0; $i < $this->length; $i++) {
+                $index = $i;
+
+                if (($index === ($this->length - 1) && $index > 0) || ($index > (count($names) - 1))) {
+                    $index = count($names) - 1;
+                }
+
+                if ($assignedNames >= count($names)) {
+                    $start++;
+                }
+
+                $initials .= mb_substr($names[$index], $start, 1);
+                $assignedNames++;
+            }
+        }
+
+        $initials = mb_substr($initials, 0, $this->length);
+
+        return $initials;
+    }
+
+}

app/Classes/General/Wrapper/Hasher.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Classes\General\Wrapper;
+
+
+use Hashids\Hashids;
+
+class Hasher
+{
+
+    public static function encode(...$args)
+    {
+        return app(Hashids::class)->encode(...$args);
+    }
+    public static function decode($enc)
+    {
+        if (is_int($enc)) {
+            return $enc;
+        }
+        return app(Hashids::class)->decode($enc)[0];
+    }
+
+}

app/Classes/Notifications/AbstractEmail.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Classes\Notifications;
+
+use Illuminate\Notifications\Notification;
+
+class AbstractEmail extends Notification
+{
+
+    public function via()
+    {
+        return 'mail';
+    }
+
+}

app/Classes/ValueObjects/Constants/HttpStatus.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Classes\ValueObjects\Constants;
+
+final class HttpStatus {
+
+    public const OK_WITH_MESSAGE = 200;
+
+    public const RESOURCE_CREATED = 201;
+
+    public const REQUEST_ACCEPTED = 202;
+
+    public const OK = 204;
+
+    public const BAD_REQUEST = 400;
+
+    public const ACCESS_UNAUTHORISED = 401;
+
+    public const ACCESS_FORBIDDEN = 403;
+
+    public const RESOURCE_NOT_FOUND = 404;
+
+    public const METHOD_NOT_FOUND = 405;
+
+    public const RESOURCE_ALREADY_EXISTS = 409;
+
+    public const VALIDATION_FAILED = 422;
+
+    public const SERVER_ERROR = 500;
+
+}

app/Classes/ValueObjects/Constants/Notifications.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Classes\ValueObjects\Constants;
+
+
+class Notifications
+{
+
+    public const UNDEFINED = [
+        'title' => 'Unknown Action',
+        'message' => 'unknown message..'
+    ];
+
+}

app/Classes/ValueObjects/Response/ApiResponseObject.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace App\Classes\ValueObjects\Response;
+
+
+use Illuminate\Http\JsonResponse;
+
+class ApiResponseObject
+{
+
+    /** @var string */
+    private $title;
+
+    /** @var string */
+    private $message;
+
+    /** @var int */
+    private $statusCode;
+
+    /** @var array */
+    private $data;
+
+
+    /**
+     * ApiResponseObject constructor.
+     * @param string $title
+     * @param string $message
+     * @param int $statusCode
+     * @param array $data
+     */
+    public function __construct(string $title, string $message, int $statusCode, array $data = [])
+    {
+        $this->title = $title;
+        $this->message = $message;
+        $this->statusCode = $statusCode;
+        $this->data = $data;
+
+    }
+
+    /**
+     * @return JsonResponse
+     */
+    public function handler(){
+        return new JsonResponse(['title' => $this->getTitle(), 'message' => $this->getMessage(), 'payload' => $this->getData()], $this->getStatusCode());
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return int
+     */
+    public function getStatusCode(): int
+    {
+        return $this->statusCode;
+    }
+
+    /**
+     * @return array
+     */
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}

app/Console/Kernel.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Console;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+class Kernel extends ConsoleKernel
+{
+    /**
+     * The Artisan commands provided by your application.
+     *
+     * @var array
+     */
+    protected $commands = [
+        //
+    ];
+
+    /**
+     * Define the application's command schedule.
+     *
+     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
+     * @return void
+     */
+    protected function schedule(Schedule $schedule)
+    {
+        // $schedule->command('inspire')->hourly();
+    }
+
+    /**
+     * Register the commands for the application.
+     *
+     * @return void
+     */
+    protected function commands()
+    {
+        $this->load(__DIR__.'/Commands');
+
+        require base_path('routes/console.php');
+    }
+}

app/Exceptions/Handler.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Exceptions;
+
+use App\Classes\ValueObjects\Constants\HttpStatus;
+use App\Classes\ValueObjects\Response\ApiResponseObject;
+use Illuminate\Auth\AuthenticationException;
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;
+use Throwable;
+
+class Handler extends ExceptionHandler
+{
+    /**
+     * A list of the exception types that are not reported.
+     *
+     * @var array
+     */
+    protected $dontReport = [
+        //
+    ];
+
+    /**
+     * A list of the inputs that are never flashed for validation exceptions.
+     *
+     * @var array
+     */
+    protected $dontFlash = [
+        'password',
+        'password_confirmation',
+    ];
+
+    /**
+     * @param Throwable $exception
+     * @throws Throwable
+     */
+    public function report(Throwable $exception)
+    {
+        parent::report($exception);
+    }
+
+    /**
+     * Render an exception into an HTTP response.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Throwable  $exception
+     * @return \Symfony\Component\HttpFoundation\Response
+     *
+     * @throws \Throwable
+     */
+    public function render($request, Throwable $exception)
+    {
+        if ($exception instanceof MaintenanceModeException) {
+            return response()
+                ->view('pages.errors.maintenance');
+        }
+
+        if ($exception instanceof AuthenticationException) {
+            return (new ApiResponseObject('Authentication', 'To keep your account secure we need to re-validate your account', HttpStatus::ACCESS_UNAUTHORISED))->handler();
+        }
+
+        return parent::render($request, $exception);
+    }
+}

app/Http/Controllers/Controller.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Bus\DispatchesJobs;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Routing\Controller as BaseController;
+
+class Controller extends BaseController
+{
+    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+}

app/Http/Controllers/TestSetup.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Http\Request;
+
+class TestSetup extends Controller
+{
+    //
+}

app/Http/Kernel.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace App\Http;
+
+use Illuminate\Foundation\Http\Kernel as HttpKernel;
+
+class Kernel extends HttpKernel
+{
+    /**
+     * The application's global HTTP middleware stack.
+     *
+     * These middleware are run during every request to your application.
+     *
+     * @var array
+     */
+    protected $middleware = [
+        // \App\Http\Middleware\TrustHosts::class,
+        \App\Http\Middleware\TrustProxies::class,
+        \Fruitcake\Cors\HandleCors::class,
+        \App\Http\Middleware\PreventRequestsDuringMaintenance::class,
+        \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
+        \App\Http\Middleware\TrimStrings::class,
+        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
+    ];
+
+    /**
+     * The application's route middleware groups.
+     *
+     * @var array
+     */
+    protected $middlewareGroups = [
+        'web' => [
+            \App\Http\Middleware\EncryptCookies::class,
+            \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
+            \Illuminate\Session\Middleware\StartSession::class,
+            // \Illuminate\Session\Middleware\AuthenticateSession::class,
+            \Illuminate\View\Middleware\ShareErrorsFromSession::class,
+            \App\Http\Middleware\VerifyCsrfToken::class,
+            \Illuminate\Routing\Middleware\SubstituteBindings::class,
+        ],
+
+        'api' => [
+            'throttle:api',
+            \Illuminate\Routing\Middleware\SubstituteBindings::class,
+        ],
+    ];
+
+    /**
+     * The application's route middleware.
+     *
+     * These middleware may be assigned to groups or used individually.
+     *
+     * @var array
+     */
+    protected $routeMiddleware = [
+        'auth' => \App\Http\Middleware\Authenticate::class,
+        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
+        'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
+        'can' => \Illuminate\Auth\Middleware\Authorize::class,
+        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
+        'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,
+        'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
+        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
+        'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
+        'valid.token' => ValidateToken::class
+    ];
+}

app/Http/Middleware/Authenticate.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Auth\Middleware\Authenticate as Middleware;
+
+class Authenticate extends Middleware
+{
+    /**
+     * Get the path the user should be redirected to when they are not authenticated.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return string|null
+     */
+    protected function redirectTo($request)
+    {
+        if (! $request->expectsJson()) {
+            return route('login');
+        }
+    }
+}

app/Http/Middleware/EncryptCookies.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;
+
+class EncryptCookies extends Middleware
+{
+    /**
+     * The names of the cookies that should not be encrypted.
+     *
+     * @var array
+     */
+    protected $except = [
+        //
+    ];
+}

app/Http/Middleware/PreventRequestsDuringMaintenance.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance as Middleware;
+
+class PreventRequestsDuringMaintenance extends Middleware
+{
+    /**
+     * The URIs that should be reachable while maintenance mode is enabled.
+     *
+     * @var array
+     */
+    protected $except = [
+        //
+    ];
+}

app/Http/Middleware/RedirectIfAuthenticated.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use App\Providers\RouteServiceProvider;
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+
+class RedirectIfAuthenticated
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @param  string|null  ...$guards
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next, ...$guards)
+    {
+        $guards = empty($guards) ? [null] : $guards;
+
+        foreach ($guards as $guard) {
+            if (Auth::guard($guard)->check()) {
+                return redirect(RouteServiceProvider::HOME);
+            }
+        }
+
+        return $next($request);
+    }
+}

app/Http/Middleware/TrimStrings.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware;
+
+class TrimStrings extends Middleware
+{
+    /**
+     * The names of the attributes that should not be trimmed.
+     *
+     * @var array
+     */
+    protected $except = [
+        'current_password',
+        'password',
+        'password_confirmation',
+    ];
+}

app/Http/Middleware/TrustHosts.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Http\Middleware\TrustHosts as Middleware;
+
+class TrustHosts extends Middleware
+{
+    /**
+     * Get the host patterns that should be trusted.
+     *
+     * @return array
+     */
+    public function hosts()
+    {
+        return [
+            $this->allSubdomainsOfApplicationUrl(),
+        ];
+    }
+}

app/Http/Middleware/TrustProxies.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Fideloper\Proxy\TrustProxies as Middleware;
+use Illuminate\Http\Request;
+
+class TrustProxies extends Middleware
+{
+    /**
+     * The trusted proxies for this application.
+     *
+     * @var array|string|null
+     */
+    protected $proxies;
+
+    /**
+     * The headers that should be used to detect proxies.
+     *
+     * @var int
+     */
+    protected $headers = Request::HEADER_X_FORWARDED_FOR | Request::HEADER_X_FORWARDED_HOST | Request::HEADER_X_FORWARDED_PORT | Request::HEADER_X_FORWARDED_PROTO | Request::HEADER_X_FORWARDED_AWS_ELB;
+}

app/Http/Middleware/ValidateToken.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use App\Classes\Exceptions\AccessUnauthorisedException;
+use App\Classes\ValueObjects\Constants\HttpStatus;
+use App\Classes\ValueObjects\Response\ApiResponseObject;
+use Closure;
+use Exception;
+use Tymon\JWTAuth\JWT;
+
+class ValidateToken
+{
+    /** @var JWT */
+    private $manager;
+
+    /**
+     * ValidateToken constructor.
+     * @param JWT $manager
+     */
+    public function __construct(JWT $manager)
+    {
+        $this->manager = $manager;
+    }
+
+
+    /**
+     * Checks if jwt token is valid.
+     *
+     * @param  \Illuminate\Http\Request $request
+     * @param  \Closure $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        try {
+
+            if(!$this->manager->check()){ throw new AccessUnauthorisedException(); }
+
+        } catch (Exception $exception) {
+
+            return (new ApiResponseObject('Authentication', 'To keep your account secure we need to re-validate your account', HttpStatus::ACCESS_UNAUTHORISED))->handler();
+
+        }
+
+        return $next($request);
+    }
+}

app/Http/Middleware/VerifyCsrfToken.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;
+
+class VerifyCsrfToken extends Middleware
+{
+    /**
+     * The URIs that should be excluded from CSRF verification.
+     *
+     * @var array
+     */
+    protected $except = [
+        //
+    ];
+}

app/Models/AbstractModel.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Models;
+
+
+use Illuminate\Database\Eloquent\Model;
+use Spatie\Activitylog\Traits\LogsActivity;
+
+class AbstractModel extends Model
+{
+    use LogsActivity;
+    protected static $logFillable  = true;
+}

app/Models/Permission.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Models;
+
+class Permission extends AbstractModel
+{
+	protected $table = 'permissions';
+
+}

app/Models/Role.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Models;
+
+class Role extends AbstractModel
+{
+	protected $table = 'roles';
+}

app/Models/User.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+
+use Spatie\Permission\Traits\HasRoles;
+
+use Tymon\JWTAuth\Contracts\JWTSubject;
+use Illuminate\Notifications\Notifiable;
+use Illuminate\Auth\Authenticatable;
+use Illuminate\Auth\MustVerifyEmail;
+use Illuminate\Auth\Passwords\CanResetPassword;
+use Illuminate\Foundation\Auth\Access\Authorizable;
+use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
+use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
+use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
+
+class User extends AbstractModel implements
+    JWTSubject,
+    AuthenticatableContract,
+    AuthorizableContract,
+    CanResetPasswordContract
+{
+    use HasRoles, Notifiable, Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;
+
+
+    /**
+     * Get the identifier that will be stored in the subject claim of the JWT.
+     *
+     * @return mixed
+     */
+    public function getJWTIdentifier()
+    {
+        return $this->getKey();
+    }
+
+    /**
+     * Return a key value array, containing any custom claims to be added to the JWT.
+     *
+     * @return array
+     */
+    public function getJWTCustomClaims()
+    {
+        return [];
+    }
+
+    public function emailVerification(): HasMany {
+        return $this->hasMany(UserEmailVerification::class, 'email', 'email');
+    }
+
+    /**
+     * @return HasMany
+     */
+    public function passwordReset(): HasMany {
+        return $this->hasMany(PasswordReset::class, 'user_id', 'id');
+    }
+
+    /**
+     * @return belongsToMany
+     */
+    public function company(): belongsToMany
+    {
+        return $this->belongsToMany(Company::class, (new Employee())->getTable(), 'user_id', 'company_id');
+    }
+}

app/Providers/AppServiceProvider.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class AppServiceProvider extends ServiceProvider
+{
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+}

app/Providers/AuthServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
+use Illuminate\Support\Facades\Gate;
+
+class AuthServiceProvider extends ServiceProvider
+{
+    /**
+     * The policy mappings for the application.
+     *
+     * @var array
+     */
+    protected $policies = [
+        // 'App\Models\Model' => 'App\Policies\ModelPolicy',
+    ];
+
+    /**
+     * Register any authentication / authorization services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->registerPolicies();
+
+        //
+    }
+}

app/Providers/BroadcastServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\Facades\Broadcast;
+use Illuminate\Support\ServiceProvider;
+
+class BroadcastServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        Broadcast::routes();
+
+        require base_path('routes/channels.php');
+    }
+}

app/Providers/EventServiceProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Auth\Events\Registered;
+use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+use Illuminate\Support\Facades\Event;
+
+class EventServiceProvider extends ServiceProvider
+{
+    /**
+     * The event listener mappings for the application.
+     *
+     * @var array
+     */
+    protected $listen = [
+        Registered::class => [
+            SendEmailVerificationNotification::class,
+        ],
+    ];
+
+    /**
+     * Register any events for your application.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+}