Initial commit

Author: liagkos

README.md

@@ -0,0 +1,75 @@
+# Greek VAT ID Validator for Laravel
+
+The Greek VAT ID validator checks if a number is POTENTIALLY valid in Greek VAT ID Registry.
+
+Validator does NOT check if VAT ID does actually belong to a person or a company, it checks only if it obeys the algorithm of a valid Greek VAT ID:
+
+```
+1. VAT ID = 090000045
+2. Calculate sum of 0*2^8+9*2^7+0*2^6+0*2^5+0*2^4+0*2^3+0*2^2+4*2^1 = 1160
+3. Calculate mod11 = 1160 % 11 = 5
+4. Calculate mod10 = 5 % 10 = 5
+5. mod10 (5) is not equal to 5 (last digit), so VAT ID is VALID
+```
+
+```
+1. VAT ID = 123456789
+2. Calculate sum of 1*2^8+2*2^7+3*2^6+4*2^5+5*2^4+6*2^3+7*2^2+8*2^1 = 1004
+3. Calculate mod11 = 1004 % 11 = 3
+4. Calculate mod10 = 3 % 10 = 3
+5. mod10 (3) is not equal to 9 (last digit), so VAT ID is INVALID
+```
+
+## Installation
+
+Install the package using Composer:
+
+```
+composer require liagkos/laravel-grvatid-validator
+```
+
+Laravel's service provider discovery will automatically configure the Grvatval service provider for you.
+
+## Using the `grvatval` validator
+
+After installation, the `grvatval` validator will be available for use directly in your validation rules.
+```php
+'vatid' => 'grvatval',
+```
+
+Within the context of a registration form, it would look like this:
+```php
+return Validator::make($data, [
+    'name' => 'required',
+    'email' => 'required|string|email',
+    'password' => 'required',
+    'vatid' => 'required|grvatval'
+]);
+```
+
+## Using the Rule Object
+
+Alternatively, you can use the `Liagkos\Grvatval\Grvatval` [Validation Rule Object](https://laravel.com/docs/5.5/validation#using-rule-objects)
+instead of the `grvatval` alias if you prefer:
+
+```php
+return Validator::make($data, [
+    'name' => 'required',
+    'email' => 'required|string|email',
+    'password' => 'required',
+    'vatid' => ['required', new \Liagkos\Grvatval\Grvatval],
+]);
+```
+
+## Validation message
+
+You will need to assign your own validation message within the `resources/lang/*/validation.php` file(s).
+Both the Rule object and the `grvatval` validator alias refer to the validation string `validation.grvatval`.
+
+## Testing
+
+Just run the the test in `tests` directory. I use the [orchestra/testbench](https://github.com/orchestral/testbench) along with PHPUnit.
+
+## Credits
+
+Since I'm quite new in all Laravel stuff, I got the idea from [Stephen Rees-Carten](https://github.com/valorin) and his own [valorin/pwned-validator](https://github.com/valorin/pwned-validator) validator, from whom I used some code and README.md stuff, modified accordingly to make this validator. Thank you Stephen, live long and propsper!

composer.json

@@ -0,0 +1,31 @@
+{
+  "name": "liagkos/laravel-grvatid-validator",
+  "description": "Validator for Laravel in order to check if a number is POTENTIALLY valid in Greek VAT ID Registry",
+  "version": "v1.0.0",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Athanasios (Nasos) Liagkos",
+      "email": "[email protected]"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "Liagkos\\Grvatval\\": "src/"
+    }
+  },
+  "require": {
+    "php": ">=7.1.3",
+    "illuminate/support": "~5.5"
+  },
+  "require-dev": {
+    "orchestra/testbench": "~3.0"
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Liagkos\\Grvatval\\ServiceProvider"
+      ]
+    }
+  }
+}

phpunit.xml.dist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="../../autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Laravel Greek VAT ID Validator Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Grvatval.php

@@ -0,0 +1,70 @@
+<?php
+namespace Liagkos\Grvatval;
+
+use Illuminate\Contracts\Validation\Rule;
+use Illuminate\Support\Facades\Lang;
+
+/**
+ * Class Grvatval
+ * @package Liagkos\Grvatval
+ */
+class Grvatval implements Rule
+{
+    /**
+     * @param      $attribute   string Form attribute
+     * @param      $value       string VAT ID
+     * @param null $params
+     *
+     * @return bool
+     */
+    public function validate($attribute, $value, $params = null)
+    {
+        return $this->passes($attribute, $value);
+    }
+
+    /**
+     * @param $attribute    string Form attribute
+     * @param $value        string VAT ID
+     *
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        // No need for 'numeric' validation rule
+        if (strlen($value) != 9 || !is_numeric($value)) {
+            return false;
+        }
+
+        return $this->checkMod($value);
+    }
+
+    /**
+     * Make the actual check
+     *
+     * a. Get the first 8 digits
+     * b. Calculate sum of product digit * 2^(8-digit index[0..8])
+     * c. Calculate sum mod11 mod10
+     * d. Result must be the same as last (9th) digit
+     *
+     * @param $value    string VAT ID
+     *
+     * @return bool
+     */
+    private function checkMod($value)
+    {
+        $digits = str_split(substr($value, 0, -1));
+        $sum    = 0;
+        foreach ($digits as $index => $digit) {
+            $sum += $digit * pow(2, 8 - $index);
+        }
+        return $sum % 11 % 10 == (int) $value[8];
+    }
+
+    /**
+     * @return mixed
+     */
+    public function message()
+    {
+        return Lang::get('validation.grvatval');
+    }
+}

src/ServiceProvider.php

@@ -0,0 +1,28 @@
+<?php
+namespace Liagkos\Grvatval;
+
+Use Illuminate\Support\Facades\Validator;
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+
+class ServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        Validator::extend('grvatval', Grvatval::class);
+    }
+
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+}

tests/GrvatvalTests.php

@@ -0,0 +1,92 @@
+<?php
+namespace Liagkos\Grvatval\Tests;
+
+use Liagkos\Grvatval\Grvatval;
+use Orchestra\Testbench\TestCase;
+
+/**
+ * Class GrvatvalTests
+ * @package Liagkos\Grvatval\Tests
+ */
+class GrvatvalTests extends TestCase
+{
+    /**
+     * @var \Validator Laravel validator instance
+     */
+    protected $validator;
+
+    /**
+     * @var string Form attribute
+     */
+    protected $attribute;
+
+    /**
+     * @var string Valid numeric VAT ID
+     */
+    protected $validVatId;
+
+    /**
+     * @var string Invalid numeric VAT ID with correct length
+     */
+    protected $invalidVatId;
+
+    /**
+     * @var string Invalid numeric VAT ID length
+     */
+    protected $invalidVatIdShortNumber;
+
+    /**
+     * @var string Invalid VAT ID combination with characters
+     */
+    protected $invalidVatIdString;
+
+    /**
+     * Prepare the test case and assign values
+     */
+    public function setUp()
+    {
+        parent::setUp();
+        $this->attribute               = 'vatid';       // Form attribute, just for testing
+        $this->validVatId              = '090000045';   // Public Energy Corporation
+        $this->invalidVatId            = '090000044';   // Wrong VAT ID
+        $this->invalidVatIdShortNumber = '09000004';    // Missing last number
+        $this->invalidVatId            = '09000004A';   // Characters instead of numbers
+    }
+
+    /**
+     * Test validate method of validator
+     */
+    public function testValidate()
+    {
+        $this->assertTrue($this->validate($this->validVatId)->passes());
+        $this->assertTrue($this->validate($this->invalidVatId)->fails());
+        $this->assertTrue($this->validate($this->invalidVatIdShortNumber)->fails());
+        $this->assertTrue($this->validate($this->invalidVatIdString)->fails());
+    }
+
+    /**
+     * Test message method of validator depending on value of VAT ID
+     */
+    public function testMessage()
+    {
+        $this->assertEquals(0, $this->validate($this->validVatId)->messages()->count());
+        $this->assertEquals(1, $this->validate($this->invalidVatId)->messages()->count());
+        $this->assertEquals(1, $this->validate($this->invalidVatIdShortNumber)->messages()->count());
+        $this->assertEquals(1, $this->validate($this->invalidVatIdString)->messages()->count());
+    }
+
+    /**
+     * Create and call the validator
+     *
+     * @param $vatId string VAT ID to check
+     *
+     * @return mixed
+     */
+    protected function validate($vatId)
+    {
+        return \Validator::make(
+            [$this->attribute => $vatId],
+            [$this->attribute => new Grvatval($this->attribute, $vatId)]
+        );
+    }
+}