Merge pull request #7 from byjg/bump

Bump Version

Author: byjg

.github/workflows/phpunit.yml

@@ -0,0 +1,39 @@
+name: PHPUnit
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - "*.*.*"
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  Build:
+    runs-on: 'ubuntu-latest'
+    container: 'byjg/php:${{ matrix.php-version }}-cli'
+    strategy:
+      matrix:
+        php-version:
+          - "8.1"
+          - "8.0"
+          - "7.4"
+          - "7.3"
+          - "7.2"
+          - "7.1"
+
+    steps:
+      - uses: actions/checkout@v2
+      - run: composer install
+      - run: ./vendor/bin/phpunit --stderr
+
+  Documentation:
+    runs-on: 'ubuntu-latest'
+    needs: Build
+    if: github.ref == 'refs/heads/master'
+    env:
+      DOC_GITHUB_TOKEN: '${{ secrets.DOC_TOKEN }}'
+    steps:
+      - uses: actions/checkout@v2
+      - run: curl https://opensource.byjg.com/add-doc.sh | bash /dev/stdin php authuser

.gitignore

@@ -4,3 +4,4 @@ composer.lock
 vendor
 .idea/*
 !.idea/runConfigurations
+.phpunit.result.cache

.travis.yml

@@ -0,0 +1,38 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug current Script in Console",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 9003,
+            "runtimeArgs": [
+                "-dxdebug.start_with_request=yes"
+            ],
+            "env": {
+                "XDEBUG_MODE": "debug,develop",
+                "XDEBUG_CONFIG": "client_port=${port}"
+            }
+        },
+        {
+            "name": "PHPUnit Debug",
+            "type": "php",
+            "request": "launch",
+            "program": "${workspaceFolder}/vendor/bin/phpunit",
+            "cwd": "${workspaceFolder}",
+            "port": 9003,
+            "runtimeArgs": [
+                "-dxdebug.start_with_request=yes"
+            ],
+            "env": {
+                "XDEBUG_MODE": "debug,develop",
+                "XDEBUG_CONFIG": "client_port=${port}"
+            }
+        }
+    ]
+}

.vscode/launch.json

@@ -1,12 +1,11 @@
 # Auth User PHP
 
+
+[![Build Status](https://github.com/byjg/authuser/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/authuser/actions/workflows/phpunit.yml)
 [![Opensource ByJG](https://img.shields.io/badge/opensource-byjg-success.svg)](http://opensource.byjg.com)
 [![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/authuser/)
 [![GitHub license](https://img.shields.io/github/license/byjg/authuser.svg)](https://opensource.byjg.com/opensource/licensing.html)
 [![GitHub release](https://img.shields.io/github/release/byjg/authuser.svg)](https://github.com/byjg/authuser/releases/)
-[![SensioLabsInsight](https://insight.sensiolabs.com/projects/69f04d22-055d-40b5-8c8d-90598a5367b5/mini.png)](https://insight.sensiolabs.com/projects/69f04d22-055d-40b5-8c8d-90598a5367b5)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/byjg/authuser/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/byjg/authuser/?branch=master)
-[![Build Status](https://travis-ci.com/byjg/authuser.svg?branch=master)](https://travis-ci.com/byjg/authuser)
 
 
 A simple and customizable class for enable user authentication inside your application. It is available on XML files, Relational Databases and Moodle.
@@ -139,23 +138,35 @@ If you do not know to create/manage that unique prefix **prefer to use the regul
 
 ## Architecture
 
+```text
+                                   ┌───────────────────┐                                   
+                                   │  SessionContext   │                                   
+                                   └───────────────────┘                                   
+                                             │                                             
+┌────────────────────────┐                                       ┌────────────────────────┐
+│     UserDefinition     │─ ─ ┐              │               ─ ─ ┤       UserModel        │
+└────────────────────────┘         ┌───────────────────┐    │    └────────────────────────┘
+┌────────────────────────┐    └────│  UsersInterface   │────┐    ┌────────────────────────┐
+│ UserPropertyDefinition │─ ─ ┘    └───────────────────┘     ─ ─ ┤   UserPropertyModel    │
+└────────────────────────┘                   ▲                   └────────────────────────┘
+                                             │                                             
+                    ┌────────────────────────┼─────────────────────────┐                   
+                    │                        │                         │                   
+                    │                        │                         │                   
+                    │                        │                         │                   
+          ┌───────────────────┐    ┌───────────────────┐    ┌────────────────────┐         
+          │  UsersAnyDataset  │    │  UsersDBDataset   │    │ UsersMoodleDataset │         
+          └───────────────────┘    └───────────────────┘    └────────────────────┘         
 ```
-                            +----------------+            +----------------+
-                            |                |            |                |
-                            | UsersInterface |------------| SessionContext |
-                            |                |            |                |
-                            +----------------+            +----------------+
-                                    ^
-                                    |
-                                    |
-            +-----------------------+--------------------------+
-            |                       |                          |
-   +-----------------+      +----------------+       +--------------------+
-   |                 |      |                |       |                    |
-   | UsersAnyDataset |      | UsersDBDataset |       | UsersMoodleDataset |
-   |                 |      |                |       |                    |
-   +-----------------+      +----------------+       +--------------------+
-```
+
+- UserInterface contain the basic interface for the concrete implementation
+- UsersDBDataset is a concrete implementation to retrieve/save user in a Database
+- UserAnyDataset is a concrete implementation to retrieve/save user in a Xml file
+- UsersMoodleDatabase is a concrete implementation to retrieve users in a Moodle database structure. 
+- UserModel is the basic model get/set for the user
+- UserPropertyModel is the basic model get/set for extra user property
+- UserDefinition will map the model to the database
+
 
 ### Database
 
@@ -213,13 +224,13 @@ $userDefinition = new \ByJG\Authenticate\Definition\UserDefinition(
     \ByJG\Authenticate\Model\UserModel::class, // Model class
     \ByJG\Authenticate\Definition\UserDefinition::LOGIN_IS_EMAIL,
     [
-        'userid'   => 'fieldname of userid',
-        'name'     => 'fieldname of name',
-        'email'    => 'fieldname of email',
-        'username' => 'fieldname of username',
-        'password' => 'fieldname of password',
-        'created'  => 'fieldname of created',
-        'admin'    => 'fieldname of admin'
+        UserDefinition::FIELD_USERID   => 'fieldname of userid',
+        UserDefinition::FIELD_NAME     => 'fieldname of name',
+        UserDefinition::FIELD_EMAIL    => 'fieldname of email',
+        UserDefinition::FIELD_USERNAME => 'fieldname of username',
+        UserDefinition::FIELD_PASSWORD => 'fieldname of password',
+        UserDefinition::FIELD_CREATED  => 'fieldname of created',
+        UserDefinition::FIELD_ADMIN    => 'fieldname of admin'
     ]
 );
 ```
@@ -234,23 +245,23 @@ $userDefinition = new \ByJG\Authenticate\Definition\UserDefinition(
     \ByJG\Authenticate\Definition\UserDefinition::LOGIN_IS_EMAIL
 );
 
-// Defines a custom function to be applied BEFORE update/insert the field 'password'
+// Defines a custom function to be applied BEFORE update/insert the field UserDefinition::FIELD_PASSWORD
 // $value --> the current value to be updated
 // $instance -> The array with all other fields;
-$userDefinition->defineClosureForUpdate('password', function ($value, $instance) {
+$userDefinition->defineClosureForUpdate(UserDefinition::FIELD_PASSWORD, function ($value, $instance) {
     return strtoupper(sha1($value));
 });
 
-// Defines a custom function to be applied After the field 'created' is read but before
+// Defines a custom function to be applied After the field UserDefinition::FIELD_CREATED is read but before
 // the user get the result
 // $value --> the current value retrieved from database
 // $instance -> The array with all other fields;
-$userDefinition->defineClosureForSelect('created', function ($value, $instance) {
+$userDefinition->defineClosureForSelect(UserDefinition::FIELD_CREATED, function ($value, $instance) {
     return date('Y', $value);
 });
 
 // If you want make the field READONLY just do it:
-$userDefinition->markPropertyAsReadOnly('created');
+$userDefinition->markPropertyAsReadOnly(UserDefinition::FIELD_CREATED);
 ```
 
 

README.md

@@ -10,12 +10,12 @@
   "prefer-stable": true,
   "require": {
     "php": ">=5.6.0",
-    "byjg/micro-orm": "4.1.*",
-    "byjg/cache-engine": "4.0.*",
-    "byjg/jwt-wrapper": "2.0.*"
+    "byjg/micro-orm": "4.9.*",
+    "byjg/cache-engine": "4.9.*",
+    "byjg/jwt-wrapper": "4.9.*"
   },
   "require-dev": {
-    "phpunit/phpunit": "5.7.*|7.4.*"
+    "phpunit/phpunit": "5.7.*|7.4.*|^9.5"
   },
   "license": "MIT"
 }

composer.json

@@ -7,12 +7,20 @@ and open the template in the editor.
 
 <!-- see http://www.phpunit.de/wiki/Documentation -->
 <phpunit bootstrap="./vendor/autoload.php"
-         colors="false"
+         colors="true"
+         testdox="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
+         convertDeprecationsToExceptions="true"
          stopOnFailure="false">
 
+    <php>
+        <ini name="display_errors" value="On" />
+        <ini name="display_startup_errors" value="On" />
+        <ini name="error_reporting" value="E_ALL" />
+    </php>
+
     <filter>
         <whitelist>
             <directory>./src</directory>

phpunit.xml.dist

@@ -0,0 +1,103 @@
+<?php
+
+namespace ByJG\Authenticate\Definition;
+
+class PasswordDefinition
+{
+    const MINIMUM_CHARS = "minimum_chars";
+    const REQUIRE_UPPERCASE = "require_uppercase";
+    const REQUIRE_LOWERCASE = "require_lowercase";
+    const REQUIRE_SYMBOLS = "require_symbols";
+    const REQUIRE_NUMBERS = "require_numbers";
+    const ALLOW_WHITESPACE = "allow_whitespace";
+    const ALLOW_SEQUENTIAL = "allow_sequential";
+    const ALLOW_REPEATED = "allow_repeated";
+
+    protected $rules = [];
+
+    public function __construct($rules = null)
+    {
+        $this->rules = [
+            self::MINIMUM_CHARS => 8,
+            self::REQUIRE_UPPERCASE => 0,  // Number of uppercase characters
+            self::REQUIRE_LOWERCASE => 1,  // Number of lowercase characters
+            self::REQUIRE_SYMBOLS => 0,    // Number of symbols
+            self::REQUIRE_NUMBERS => 1,    // Number of numbers
+            self::ALLOW_WHITESPACE => 0,   // Allow whitespace
+            self::ALLOW_SEQUENTIAL => 0,   // Allow sequential characters
+            self::ALLOW_REPEATED => 0      // Allow repeated characters
+        ];
+        foreach ((array)$rules as $rule => $value) {
+            $this->setRule($rule, $value);
+        }
+    }
+
+    public function setRule($rule, $value)
+    {
+        if (!array_key_exists($rule, $this->rules)) {
+            throw new \InvalidArgumentException("Invalid rule");
+        }
+        $this->rules[$rule] = $value;
+    }
+
+    public function getRules()
+    {
+        return $this->rules;
+    }
+
+    public function getRule($rule)
+    {
+        if (!array_key_exists($rule, $this->rules)) {
+            throw new \InvalidArgumentException("Invalid rule");
+        }
+        return $this->rules[$rule];
+    }
+
+    public function matchPassword($password)
+    {
+        // match password against the rules
+        if (strlen($password) < $this->rules[self::MINIMUM_CHARS]) {
+            return false;
+        }
+        if ($this->rules[self::REQUIRE_UPPERCASE] > 0) {
+            if (preg_match_all('/[A-Z]/', $password, $matches) < $this->rules[self::REQUIRE_UPPERCASE]) {
+                return false;
+            }
+        }
+        if ($this->rules[self::REQUIRE_LOWERCASE] > 0) {
+            if (preg_match_all('/[a-z]/', $password, $matches) < $this->rules[self::REQUIRE_LOWERCASE]) {
+                return false;
+            }
+        }
+        if ($this->rules[self::REQUIRE_SYMBOLS] > 0) {
+            if (preg_match_all('/[!@#$%^&*()\-_=+{};:,<.>]/', $password, $matches) < $this->rules[self::REQUIRE_SYMBOLS]) {
+                return false;
+            }
+        }
+        if ($this->rules[self::REQUIRE_NUMBERS] > 0) {
+            if (preg_match_all('/[0-9]/', $password, $matches) < $this->rules[self::REQUIRE_NUMBERS]) {
+                return false;
+            }
+        }
+        if ($this->rules[self::ALLOW_WHITESPACE] == 0) {
+            if (preg_match_all('/\s/', $password, $matches) > 0) {
+                return false;
+            }
+        }
+        if ($this->rules[self::ALLOW_SEQUENTIAL] == 0) {
+            if (preg_match_all('/([aA][bB][cC]|[bB][cC][dD]|[cC][dD][eE]|[dD][eE][fF]|[eE][fF][gG]|[fF][gG][hH]|[gG][hH][iI]|[hH][iI][jJ]|[iI][jJ][kK]|[jJ][kK][lL]|[kK][lL][mM]|[lL][mM][nN]|[mM][nN][oO]|[nN][oO][pP]|[oO][pP][qQ]|[pP][qQ][rR]|[qQ][rR][sS]|[rR][sS][tT]|[sS][tT][uU]|[tT][uU][vV]|[uU][vV][wW]|[vV][wW][xX]|[wW][xX][yY]|[xX][yY][zZ]|012|123|234|345|456|567|678|789|890|987|876|765|654|543|432|321)/', $password, $matches) > 0) {
+                return false;
+            }
+
+        }
+        if ($this->rules[self::ALLOW_REPEATED] == 0) {
+            if (preg_match_all('/(..?)\1{2,}/', $password, $matches) > 0) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+
+
+}